Datatid 1999 #6

home *** CD-ROM | disk | FTP | other *** search

/ Datatid 1999 #6 / Datatid_1999-06.iso / internet / Tango352Promo / P.SQL / PTKPKG.1 / OS2MAINT.HLP (.txt) < prev next >

Wrap

OS/2 Help File | 1998-09-30 | 20.9 KB | 766 lines

ΓòÉΓòÉΓòÉ 1. Information Editor Dialog ΓòÉΓòÉΓòÉ The Information Editor Window allows the user to easily enter, edit, and view MicroKernel file and key information. Once complete, the information can be used to create MicroKernel-compatible files, indexes, and description files. The information in the window is grouped into three sets of controls. File Specification Attributes of a MicroKernel-compatible file related to file and record structure, number of keys, data compression, etc... Key Specification Attributes of a MicroKernel-compatible file related to a specific key or a segment within a key. Miscellaneous File Information Information about the MicroKernel or description file not part of the file or key specifications. Much of the information in the editor is interrelated. These relationships are often indicated by enabling or disabling controls. This approach not only helps the user understand the relationships between the various MicroKernel file and key attributes; it also helps to prevent the user from entering inconsistent information. Here are a few examples: All key and segment controls (except the create key button) are disabled if no key or key segment is selected. The Blank Truncation control is disabled unless the Variable Records control is checked. The ACS information button is disabled unless the current segment's Use ACS control is checked. Related Topics o Description Comments Dialog o Alternate Collating Sequence Information Dialog o Create File Dialog Panel ΓòÉΓòÉΓòÉ 2. Description Comments Dialog ΓòÉΓòÉΓòÉ This dialog is accessed from the Information Editor Dialog. It allows you to enter, edit, or view description file comments. Description Edit Control A multiline edit control. Enter the comment you wish to save in the description file. OK Button Closes dialog and saves any changes. Cancel Button Closes the dialog and does not save any changes. ΓòÉΓòÉΓòÉ 3. Create Stat Report Dialog ΓòÉΓòÉΓòÉ This dialog is a file browse dialog which allows you to specify the name of the report file to create. You can also choose to view the report file after it has been created. Below is a description of each of the dialog's controls. Data File Specifies the name of the MicroKernel-compatible file for which you want to create a report. File Name Specifies the name of the report file to create. View Report When this control is checked, the report file will be displayed in a window after it has been created. OK Button Creates the report file. Cancel Button Closes the dialog without creating a report file. ΓòÉΓòÉΓòÉ 4. Create Index Dialog ΓòÉΓòÉΓòÉ This dialog allows the user to create Btrieve indexes. The type of index that can be created depends on the current state of the MicroKernel-compatible file's log key. If the log key is the system-defined key, and the system-defined key is present, you can not create a system-defined key. If the log key is the system-defined key and it has been dropped, you can create the system-defined key. In this case, `SYSKEY' will appear in the Key Number to Use for Create list and you do not have to specify a Key Specification Number from the Information Editor. If the log key is one of the user defined keys, or the file does not have system data, `SYSKEY' will not appear in any of the key number lists. Below is a description of each of the dialog's controls. Index Type This operation allows you to create either an internal or external index. The Internal Index option creates a new index within the specified MicroKernel-compatible file. The External Index option creates an external index file based upon the specified MicroKernel-compatible file. To create an internal index, you must specify an existing MicroKernel Data File, a Key Specification Number from the Information Editor, and the Key Number you want the new index to have in the MicroKernel-compatible file. To create an external index, you must specify an existing MicroKernel Data File, the name of the external index file to be created, and a Key Specification Number from the Information Editor. Data File Specifies the name of the existing MicroKernel-compatible file to which you wish to add indexes. External Index File Specifies the name of the external index file to create if you select the Create External Index File option. Key Specification Number in Information Editor To Use This list contains all key numbers currently specified in the Key Selection Controls of the Information Editor. The key specification number selected will be used when creating either an internal or an external index. Goto Editor Button Displays the File Information Editor dialog box. Before you can create an index, you must select a key specification in the Information Editor. If you have not already done so, you can use this button to quickly switch to the Information Editor. You can then create the desired key specification, switch back to the Create Index Dialog, and perform the create index operation. Existing Key This list contains all existing key numbers in the specified MicroKernel file. This is for information only. You do not need to select a key from this list. If the file has a system-defined key and the system-defined key is present, `SYSKEY' will appear in this list. Key Number to Use For Create Lists the key numbers available (not defined for the MicroKernel-compatible file). Highlight the key number you want to use when creating the index. If the file has a system-defined key and the system-defined key is dropped, `SYSKEY' will appear in this list. Refresh / Execute Once the user has specified the name of an existing MicroKernel-compatible file, this button updates the Btrieve Existing Keys and Key Number to Use lists. You can then select the execute option to create the index. The execute option will not be enabled unless you first specify all necessary information for the desired operation. Cancel / Close Select this button to close the dialog. After you have created an index, the cancel button changes to a close button, signifying that you cannot undo any completed operations. ΓòÉΓòÉΓòÉ 5. Drop Index Dialog ΓòÉΓòÉΓòÉ This dialog allows you to drop existing internal indexes in a MicroKernel-compatible file. If the log key is the system-defined key, and the system-defined key is present, you can drop the system-defined key. In this case, `SYSKEY' will appear in the Existing Key list. If the file's system-defined key has already been dropped or the file does not have system data, you can not drop the system-defined key. In this case, `SYSKEY' will not appear in the Existing Key list. Below is a description of each of the dialog's controls. MicroKernel File Specifies the name of the existing MicroKernel-compatible file for which you wish to drop indexes. Existing Key Lists the key number defined for the file. Highlight the number of the key whose index you want to drop. If the log key is the system-defined key, and the system-defined key is present, `SYSKEY' will appear in this list. If the file's system-defined key has already been dropped or the file does not have system data, `SYSKEY' will not appear in this list. Renumber Keys When dropping an index, you can instruct the Microkernel to maintain the current numbers of any remaining keys. If you check this control, the Microkernel will decrement by 1 the number of any remaining keys with a value greater than the dropped index. For example, if you have 3 keys numbered 2, 3, and 5 and delete key number 3 the following will occur. If you DO NOT renumber, the remaining keys will be numbered 2 and 5. If you DO renumber, the remaining keys will be numbered 2 and 4. Refresh / Execute You can use the Refresh List button to update the information in the Drop Index dialog box based on the changes you may have made in the File Information Editor dialog. The execute option will not be enabled unless you first specify all necessary information. Cancel / Close Closes the dialog. After you have dropped an index, the cancel button changes to a close button, signifying that you cannot undo any completed operations. ΓòÉΓòÉΓòÉ 6. Copy Data Dialog ΓòÉΓòÉΓòÉ This dialog allows the user to copy data from one MicroKernel-compatible file to another MicroKernel-compatible file. Below is a description of each of the dialog's controls. From MicroKernel File Specifies the name of the MicroKernel-compatible file from which the data is to be copied. To MicroKernel File Specifies the name of the MicroKernel-compatible file to which the data is to be copied. Browse Buttons Displays a Browse File Dialog. The selected file name will be placed in the corresponding file name edit control. Execute Button Closes the dialog and initiates the copy operation. Cancel Button Closes the dialog and aborts the copy operation. ΓòÉΓòÉΓòÉ 7. Load Data Dialog ΓòÉΓòÉΓòÉ This dialog allows the user to load data from an unformatted sequential file to a MicroKernel-compatible file. Below is a description of each of the dialog's controls. From Sequential File Specifies the name of the unformatted sequential file from which the data is to be copied. Refer to the Btrieve for OS/2 Installation and Operation Manual for instructions on how to properly format a sequential file. To MicroKernel File Specifies the name of the MicroKernel-compatible file to which the data is to be copied. Browse Buttons Displays a Browse File Dialog. The selected file name will be placed in the corresponding file name edit control. Execute Button Closes the dialog and initiates the load operation. Cancel Button Closes the dialog without performing the load operation. ΓòÉΓòÉΓòÉ 8. Save Data Dialog ΓòÉΓòÉΓòÉ This dialog allows the user to save data from a MicroKernel-compatible file to an unformatted sequential file. Below is a description of each of the dialog's controls. From MicroKernel File Specifies the name of the existing MicroKernel-compatible file whose data you want to save. To Sequential File Specifies the name of the sequential file to create. Use An Index When this control is checked, the Btrieve Maintenance Utility will save the data sorted by either an internal index or an external index file. By default, the Maintenance Utility does not use an index, meaning that records are exported according to their physical position in the data file. Internal When selected, a list of all keys currently defined in the specified MicroKernel-compatible file will be displayed. Use the Refresh Button to update this list if you change the name of the MicroKernel-compatible file. Select the key number to use when saving the records from this list. External File When selected, an edit control for specifying the name of the existing external index file will be displayed. Refresh / Execute Refresh will refresh the available indexes if the file name is changed in the From MicroKernel File edit control. The execute option will not be enabled unless you first specify all necessary information for the desired operation. Cancel Closes the dialog without performing the save operation. ΓòÉΓòÉΓòÉ 9. Owner Name Dialog ΓòÉΓòÉΓòÉ This dialog is shown whenever the Btrieve Maintenance Utility attempts to open a MicroKernel-compatible file which as an owner name. You should specify the owner name for the file and press enter. If the owner name is valid, the operation will continue. If it is not valid, this dialog will be shown again. Pressing cancel will abort the operation. ΓòÉΓòÉΓòÉ 10. ACS Information Dialog ΓòÉΓòÉΓòÉ This dialog is accessed from the Information Editor Dialog. It allows you to enter alternate collating sequence (ACS) information for a particular key specification. Below is a description of each of the dialog's controls. ACS / Country Code When selected, Btrieve will use the specified country ID and code page when sorting this key. Country ID The country ID. A value of -1 indicates the system default. Code Page The code page. A value of -1 indicates the system default. ACS File When selected, Btrieve will use the ACS defined in the specified file when sorting this key. ACS File Name Specifies the ACS file name. The ACS file must be formatted in accordance with the specification defined in the Btrieve Programmer's Manual. Browse Button Displays a Browse File Dialog. The selected file name will be placed in the ACS File Name control. OK Button Closes the dialog and saves any changes to the ACS information. Cancel Button Closes the dialog and does not save any changes. ΓòÉΓòÉΓòÉ 11. Create File Dialog ΓòÉΓòÉΓòÉ This dialog allows you to create a new MicroKernel or description file using the file and key information currently in the Information Editor. MicroKernel Compatible File When selected, a MicroKernel-compatible file will be created. Description File When selected, a description file will be created. Index Only When selected, a description file with the specification for just the currently specified index (in the Information Editor) will be created. This is a convenient way to save individual index specifications. ΓòÉΓòÉΓòÉ 12. Process Data Dialog ΓòÉΓòÉΓòÉ This dialog shows you the status of the data manipulation process. For more information on any non-successful status messages, please refer to the Btrieve Programmer's Manual. ΓòÉΓòÉΓòÉ 13. Getting Help ΓòÉΓòÉΓòÉ For context-sensitive help at any time while you are running the Btrieve Maintenance Utility, you can use one of two methods: Help Menu Select the Help option from the menu bar at the top of the Maintenance Utility window. Help Key Press the F1 function key. This key produces help information about the highlighted menu command or current window or dialog box. ΓòÉΓòÉΓòÉ 14. Help on Help ΓòÉΓòÉΓòÉ For information on how to use the OS/2 help system, press F1 from within this help system. ΓòÉΓòÉΓòÉ 15. Miscellaneous File Information ΓòÉΓòÉΓòÉ Below is a description of each of the miscellaneous controls. For more information about these controls and their associated Btrieve attributes, refer to the Btrieve for OS/2 Installation and Operations Manual or the Programmer's Manual. Load Information... This button brings up a file selection dialog which allows you to load Btrieve information into the editor from either a MicroKernel-compatible file or a description file. Create File... This button brings up a file selection dialog which allows you to save the current editor information to either a MicroKernel-compatible file or a description file. Help This button brings up context sensitive help for the information editor dialog. Set to Defaults This button resets all of the controls to their default values. If you have made changes, you will first be asked if you want to create a file with the current information before continuing. Description Comments... This button displays the Description Comments dialog This dialog is used to edit comments stored in description files. Owner Name You can enter up to 8 characters in this edit control. After creating a new MicroKernel-compatible file using the current information in the editor, the Btrieve Maintenance Utility will set the owner of the file to this value. Version If the last file opened or created was a MicroKernel-compatible file, this read-only control displays the file's version. The version does NOT always indicate the version of the Microkernel used to create the file. Rather, it indicates the earliest version of the Microkernel which supports all of the attributes of this file, including any format changes. For example, a file created by the Microkernel version 6.1 which doesn't have any version 6.1 specific attributes will have a file version of 6.0. As a second example, a version 6.x formatted file can never have a version less than 6.0. If the last file accessed was not a MicroKernel-compatible file, NA is displayed. Total Records If the last file opened or created was a MicroKernel-compatible file, this read-only control displays the number of records in the file. If the last file accessed was not a MicroKernel-compatible file, NA is displayed. Show 6.x Info This button is only displayed after a pre-version 6.x MicroKernel file has been loaded or created. In this case, all controls specific to version 6.0 and above are hidden. Pressing this button will re- display all of these controls. ΓòÉΓòÉΓòÉ 16. Set - Clear Owner Dialog ΓòÉΓòÉΓòÉ This dialog allows the user to set or clear an owner name from an existing MicroKernel-compatible file. Below is a description of each of the dialog's controls. MicroKernel File Name Specify the name of the MicroKernel-compatible file here for which to set or clear the owner name Clear Owner Select this option to clear an owner name from the MicroKernel-compatible file. Current Owner Used with the Clear Owner operation to specify the current owner name in the MicroKernel-compatible file. Set Owner Select this option to set a new owner name for the MicroKernel-compatible file. New Owner Used with the Set Owner operation to specify the new owner name for the MicroKernel-compatible file. Permit RO Access When this control is checked for the Set Owner operation, Btrieve will allow users to access the file in read-only mode without specifying the owner name. Encrypt Data When this control is checked for the Set Owner operation, Btrieve will encrypt all data in the file. Cancel / Close Closes the dialog. After you have set or cleared an owner name, the cancel button changes to a close button, signifying that you cannot undo any completed operations. ΓòÉΓòÉΓòÉ 17. File Specification Controls ΓòÉΓòÉΓòÉ Below is a description of each of the controls used to define the file specification of a MicroKernel file. These controls correspond to the various file attributes Btrieve supports when creating a MicroKernel-compatible file. For more information about these controls and their associated Btrieve attributes, refer to the Btrieve for OS/2 Installation and Operation Manual or the Btrieve Programmer's Manual. Record Length This control specifies the logical length of the fixed portion of the data record. Page Size This control specifies the page size Btrieve will use when creating a file. # Keys This control indicates how many different key specifications are currently defined in the Information Editor. # Segments This control indicates how many different key segment specifications are currently defined in the Information Editor. Available Linked Keys This specifies how many unused 8-byte key placeholders will be available at the end of each record for supplemental linked- duplicatable keys. These placeholders enable you to add new keys to a file that uses the linked-duplicatable method of storing duplicatable keys. Key-Only When this control is checked, the Microkernel creates a key-only file. This type of file contains no data and includes only one key. Balanced Indexing When this control is checked, the Microkernel will look for available space in sibling index pages each time an index page becomes full. The Microkernel then rotates values from the full page onto the pages with space available. Pre-allocation The Microkernel typically creates a new file with the minimum number of pages needed to support the various file and key attributes specified. When this control is checked, the user may specify up to 65,535 pages in the # Pages control. After loading file information from an existing MicroKernel-compatible file, this control specifies the number of unused pages remaining in the file. # Pages This control specifies how many pages Btrieve should preallocate when creating a new file. Data Compression When this control is checked, Btrieve compresses the file's records before inserting or updating them, and uncompresses the records when it retrieves them. Variable Records When this control is checked, Btrieve creates a file which allows variable records (records longer than the fixed length). Blank Truncation When this control is checked, the Microkernel will perform the blank truncation method of compressing variable-length records. Include VATs When this control is checked, the Microkernel includes Variable-tail Allocation Tables (VATs) in the file. VATs are used by the Microkernel to accelerate random access to the variable-length portions of records, but also to limit the size of the compression buffer used during data compression. % Free Space This control specifies the percentage of space you want the Microkernel to reserve on each variable page to allow for future expansion variable records. This allows the user to reduce the amount of fragmentation of variable records across several pages. ΓòÉΓòÉΓòÉ 18. Key Specification Controls ΓòÉΓòÉΓòÉ The controls used to specify the key attributes supported by Btrieve are located at the bottom of the Information Editor Window. The controls have been divided into three groups. For more information about these controls and their associated Btrieve attributes, refer to the Btrieve for OS/2 Installation and Operation Manual or the Btrieve Programmer's Manual. Key Selection Lists These lists are located at the center of the key specification area. They allow the user to add or delete key specifications from the Information Editor as well as change the current specification being viewed. Key Information Group Box This group box is located at the left of the key specification area. The group box's controls specify information common to ALL segments of the current key. Key-Segment Information Group Box This group box is located at the right of the key specification area. The group box's controls specify information about a particular segment of the current key. ΓòÉΓòÉΓòÉ 19. Key Lists ΓòÉΓòÉΓòÉ These lists and associated buttons allow the user to add or delete key specifications from the Information Editor as well as change the current specification being viewed. Key Selection List This list contains all key numbers currently defined in the Information Editor. As the user scrolls through this list, the key information corresponding to the key number is displayed in the editor. The three buttons beneath the control allow the user to manipulate the key numbers in the list. Insert Key Button This button inserts a new key number after the one currently selected. If there is key at this position already, that key (and all subsequent consecutive keys) will be incremented by one. Delete Key Button This button deletes the currently selected key. Subsequent keys are not renumbered. This button is shown only when a key is currently selected in the key selection list. Compress Key Button This button renumbers all key numbers in the list consecutively starting with 0. This button is shown only when there are holes in the list of key numbers. Key Segment Selection List This list contains all key segment numbers defined for the currently selected key. As the user scrolls through this list, the key segment information corresponding to the segment number is displayed in the editor. The two buttons beneath the control allow the user to manipulate the key segment numbers in the list. Insert Segment Button This button inserts a new key segment number after the one currently selected. If there is segment at this position already, that segment (and all subsequent segments) will be incremented by one. Delete Segment Button This button deletes the currently selected segment. If this is the last segment for the current key, the entire key is deleted. Subsequent keys are renumbered. This button is shown only when a segment is currently selected in the key segment selection list. ΓòÉΓòÉΓòÉ 20. Key Information Group Box ΓòÉΓòÉΓòÉ The controls in this group box specify information common to ALL segments of the current key. Duplicates When this control is checked, Btrieve allows more than one record in the file to contain the same value for this key field. Modifiable When this control is checked, Btrieve allows a key value for this key field to be updated. Repeating Duplicates Btrieve supports two methods of storing duplicate values for a key, repeating duplicates and linked duplicates. When this control is checked, Btrieve uses the repeating duplicates method. Null Key This control specifies whether the key has a null value. You can use a null value in a key when the data for the key is unavailable or when you do not want the Microkernel to include a record for that key in the index. Btrieve supports two methods for determining whether a particular key value is a null value: Any Segment and All Segments. These methods differ only for multi-segment keys. Any Segment When selected, Btrieve treats a key value as null if ANY segment of the key contains a null value. All Segments When selected, Btrieve treats a key value as null only if ALL segments of the key contain a null value. ACS Information This button displays the ACS Information Dialog. This dialog allows the user to specify an alternate collating sequence used in sorting the current key. Any segment of this key which uses an ACS will use the ACS specified here. This button is only enabled if the Use ACS control in the Segment Group Box is checked. Unique Values This is a read-only control specifying the number of unique key values contained by this key in a recently-opened MicroKernel-compatible file. NA is displayed if the current editor information was not loaded from an existing MicroKernel-compatible file. ΓòÉΓòÉΓòÉ 21. Key-Segment Information Groupbox ΓòÉΓòÉΓòÉ The controls in this group box specify information about a particular segment of the current key. Data Type This control specifies the Btrieve data type for the key. The data type determines how Btrieve will sort the bytes specified for this key segment. Position This control specifies the starting offset (1 relative) of the current key segment. Length This control specifies the length of the key segment field. Null Value (Hex) This control specifies the null value Btrieve should use when determining whether a key value should be treated as null. This control is enabled only if the Null Key control was checked for this key. Case Insensitive When this control is checked, Btrieve sorts this segment without regard to case. For example, the characters 'a' and 'A' will be given the same ordinal values. This control is only enabled if the data type of the segment is string, zstring, or lstring. Descending When this control is checked, Btrieve will collate the key segment in descending sort order. Use ACS When this control is checked, Btrieve expects an ACS to be specified for this segment. Use the ACS Information Dialog to specify the ACS for this key. All segments of a particular key do not need to use an ACS. However, all that do use an ACS must use the same one.