N INTOUCH works with data in any record management system. SETUP tells INTOUCH J where data files are located and what record management systems are used. H Once you have defined your structures with SETUP, you can use INTOUCH's - structure statements to manipulate the data.
3 SETUP now supports the following database engines:
1 The following procedures are available in SETUP:
L Each of the SETUP procedures is described in detail on the following pages.
> To enter SETUP, type CALL SETUP at the INTOUCH prompt.
INTOUCH CALL SETUP
4 SETUP will ask you a number of questions including:
W SETUP V4.2 Set Up INTOUCH 4GL Data Structures Structure name : Database engine: Dataset : Data dictionary: P Structure name? _______________________________________________________________ W EXIT = Exit \ = Back HELP = Help
E You can create a new structure by entering new file names or you can = modify existing structures by selecting them at the prompts.
A Once you have specified the structure you want to work with, you A can define fields in the structure or display field definitions. 6 16.2 SETUP Prompts
N This section describes the SETUP prompts and your options for answering them.
F When you are using SETUP and are at any of the prompts, you can enter F HELP or press the Help key to get information about the prompt.
M Default answers are provided for many of the prompts. If you want to accept O the answer provided, press the Return key at the prompt. If you do @ not want to use the default, type your answer over the default.
I If you want to go back to a previous prompt, use the "\" (backslash key) to back up.
K Enter a structure name. This can be a new name or the name of an existing J structure. If you are creating a new structure, this will be the name of A the structure file. The default extension for the file is .STR. The structure file contains:
I Your structure name can be any VMS file specification. (See the chapter = INTOUCH Running Under VMS for information on VMS file specifications.)
L Use the arrow keys to select the database engine (record management system) 9 used by this structure. INTOUCH supports these systems:
(You can refer to the L INTOUCH Interfaces to Database Engines manual for more information.)
F If you are creating a new structure, the default will be RMS. If you B are modifying an existing data structure, the default will be the L database engine (record management system) specified in the structure file. E FASTFILE is an INTOUCH record management system designed for speed.
F Enter the name of the data file (dataset) you will be using with this K structure. If this is a new structure, the default data file name will be @ the same as the structure name. The default extension is .DAT.
@ You can use the same data file for a number of structures. For E instance, you might use the CUSTOMER data file for both the CUSTOMER and the SALES structures:
) structure files data file $ CUSTOMER.STR | $ \ | $ \ v \) CUSTOMER.DAT / / / ' SALES.STR
G Your dataset name can be any VMS file specification. (See the chapter = INTOUCH Running Under VMS for information on VMS file specifications.)
? If the database engine is Rdb, the input format will be L different. An Rdb database consists of tables. Each structure corresponds P to one table. For Rdb, the dataset is the name of a table in the Rdb database.
3 FORMAT: table_name IN rdb_database 7 EXAMPLE: employee in rdb_data:personnel
? For a DBMS dataset, you need to specify the DBMS record K name and the name of the DBMS root file. Optionally, you can add the name of the subschema.
A If the subschema is not given, the DEFAULT_SUBSCHEMA is assumed.
G FORMAT: record_name IN [subschema_name FOR ] root_file 9 EXAMPLES: part in datadisk:[parts]dbmparts D part in ss0001 for datadisk:[parts]dbmparts
= For an INGRES dataset, you need to specify the INGRES C table name. The INGRES database to use is specified by the symbol INT_INGRES_DBNAME.
# FORMAT: table_name ! EXAMPLE: employee
; For an ADABAS dataset, you need to specify the file number and the database number.
7 FORMAT: file_number IN database_number EXAMPLE: 6 IN 1
= For an ORACLE dataset, you need to specify the ORACLE table name.
# FORMAT: table_name EXAMPLE: emp
M Enter the name of the definition file you will be using with this structure. K If you are creating a new structure, the default definition file name will D be the same as the structure name. The default extension is .DEF.
L As with the data file, you can use the same definition file for a number of I structures. In fact, you can create any combination of definition, data and structure files:
= structure files data file definition files 5 CUSTOMER.STR CUSTOMER.DEF ) \ / ( \ / ' \ / ( \ / & \CUSTOMER.DAT/ $ / \% / \ & / \( / \ 1 SALES.STR SALES.DEF
H Your definition file name can be any VMS file specifications. (See the E chapter INTOUCH Running Under VMS for information on VMS file specifications.)
H There are three special definition file names allowed. If the database H engine for this structure can supply the field information and you want : to use these native definitions, enter NONE as the J definition file name and INTOUCH will use the definitions embedded in the ! database engine with the fields.
9 These database engines can supply the field definitions:
J If you are using a database engine that supports native field definitions M (Rdb, for example) and you would like to augment the native definitions with K additional definitions, you can enter a definition file name prefixed with E AUG>. This will create an augmented definition file. The J native field names will be available along with any fields defined in the I augmented definition file. Typically, augmented definitions are used to 5 supply report headings, prompt text and print masks.
M For example, if you have an Rdb table which contains of the following native fields:
7 Name Start Length 7 ----- ----- ------ 5 fielda 1 10 5 fieldb 11 5 5 fieldc 16 10
O and you want to define a field (an index) consisting of "fielda" and "fieldb", K you can create an augmented data dictionary and define the index you want.
9 If you are using CDD, you can enter CDD> 3 and a name of a CDD/Plus Directory and recordname:
? CDD>DEVDISK:[DEVINT.CDDTEST]CUSTOMER < ^ ^^ ^ < | || | < +----------------------++------+ ; Directory name record 9 name
+ CDD/Plus access is read only at this time.
F After the structure information has been entered, the SETUP Procedure G Menu will be displayed and you can select the SETUP procedure you want to perform.
W SETUP V4.2 Set Up INTOUCH 4GL Data Structures Structure name : CUSTOMER.STR Database engine: RMS Dataset : CUSTOMER.DAT Data dictionary: CUSTOMER.DEF 7 +---Setup Procedure---+ 0 | Define fields | 3 | Show [>| 3 | Modify structure [>| 0 |---------------------| 0 | Create data file | 0 | EXIT | 0 +---------------------+ W EXIT = Exit \ = Back HELP = Help
1 The following procedures are available in SETUP:
Note
J Depending on the database engine chosen and the definition file selected, ) you might not have all of these options.
I To select the SETUP procedure you want to perform, use the arrow keys to O highlight your selection and then press Return. You can also enter 9 in the first few characters and press Return.
K You can use the DEFINE procedure to define the fields in a structure. The F DEFINE procedure is also used to modify and delete field definitions.
A When the Define fields menu option is selected, the field & definition input screen is displayed.
+ Example 16-4 Field Definition Input Screen
W SETUP V4.2 Definitions for CUSTOMER.STR Fieldname : Classification : Description : Data type : 4 First position : length: Occurs: Semantics : Prompt text : Report heading : Print mask : Screen mask : Help text : Access rules : Validation rules: . Field name? _________________________________ : Enter -fieldname to delete a field W EXIT = Exit \ = Back HELP = Help
J You will be asked first for the name of the field you wish to add, modify G or delete. You will then be prompted for information about the field.
K Enter the field name you wish to add, modify or delete. If you are adding K a new field, the field name will be used to identify this field. If there @ are existing fields, you can use one of the SHOW options * to get a list of the current field names.
= If you wish to delete a field, enter a minus sign (-) * followed by the field name. For example:
) Field name? -phone
The field name:
F If you are modifying a field, the defaults for the rest of the DEFINE I prompts will be your original responses. You can keep these defaults by O pressing the Return key at the prompt. You can change the defaults by typing over the responses.
J Enter the field class or press Return to accept the default of none.
The classification is optional.
N Classification refers to a field class in the CLASSIFICATION data dictionary. 9 Field classes are pre-defined commonly used data fields.
K There are cases when you use the same field type in a record or in several H datasets. When this occurs, setting up a field class will save time in 3 defining fields and help to ensure data integrity.
L If, for example, you had a home phone field, work phone field and alternate L phone field in your record, you would need to define the three phone fields L using different field names but the same characteristics. The phone fields J would all be 10 numeric characters in length and be printed in the format (123) 456-7890.
M To ensure that all the phone numbers are defined exactly the same, you could C define a phone class in the CLASSIFICATION data dictionary. M The class name could be PHONE and be defined with the length (10), semantics N (num), print mask ((###~)~ ###~-####) and validations (digits; minlength 10).
M Then, whenever you want to define a phone number type field, you would enter I the field name, HOME_PHONE for example, with PHONE as the classification K and the classification data would automatically become the default answers J to the remaining DEFINE prompts. If you did not want to use a particular B default, you can simply type in a different answer at the prompt.
K You would also be able to use the PHONE classification when defining phone ! fields in other dataset records.
J Before you can use field classifications, you must first define the field / classes in the CLASSIFICATION data dictionary.
J Field classes are defined the same way as any other data field. However, P these fields are located in a specific data file called TTI_RUN:CLASSIFICATION. 6 To create a field class, perform the following steps:
5 Structure name : TTI_RUN:CLASSIFICATION.STR Database engine: RMS Dataset : NONE 5 Data dictionary: TTI_RUN:CLASSIFICATION.DEF2
2 You can set up as many field classes as you wish.
/
I If you do not want to use the provided TTI_RUN:CLASSIFICATION data file, K you can create one of your own. For example, you could create a structure J such as CLASS_NAMES for your field classes. However, if you choose to do 2 this, you MUST define the file as follows:
I SETUP will then retrieve classification data from CLASS_NAMES instead of TTI_RUN:CLASSIFICATION.
G After the classification prompt is answered, SETUP displays either the H class defaults or defaults generated by SETUP to assist you in defining the field.
B Example 16-5 DEFINE Screen showing field class generated defaults
W SETUP V4.2 Definitions for CUSTOMER.STR Fieldname : HOME_PHONE Classification : PHONE Description : Home phone Data type : CH 7 First position : 14 length: 10 Occurs: 1 Semantics : NUM, RJ Prompt text : Home phone Report heading : Home Phone % Print mask : (###~)~ ###~-#### Screen mask : none Help text : none Access rules : NORMAL ( Validation rules: digits; minlength 10 , Description? Home phone____________________ W EXIT = Exit \ = Back HELP = Help
< Example 16-6 DEFINE Screen showing SETUP generated defaults
W SETUP V4.2 Definitions for CUSTOMER.STR Fieldname : HOME_PHONE Classification : none Description : Home phone Data type : CH 7 First position : 14 length: Occurs: 1 Semantics : UC Prompt text : Home phone Report heading : Home Phone Print mask : none Screen mask : none Help text : none Access rules : NORMAL Validation rules: none , Description? Home phone____________________ W EXIT = Exit \ = Back HELP = Help
F Enter a description of the field. The description can consist of any < characters on the keyboard and be up to 30 characters long.
H If you are adding this field, the default description is the field name 5 with any "$", "%", "_" characters changed to spaces.
9 The description will be used as the default prompt text.
C Enter the data type for this field. The data type is the internal > representation of the data. The most common type is CHO (character) which is the default. The data type will be one of the following:
| AC | !ASCII counted string | |
| AP | %Pointer to ASCII counted | |
| C3 | qCOBOL comp-3, also known as packed decimal; the C3 data type also supports the VAX DECIMAL data type | |
| CH | Character | |
| DS | "Date stamp (length=8) | |
| EB | EBCDIC | |
| FL | Floating point | |
| GF | G-Float | |
| IN | Integer (signed) | |
| IU | Integer (unsigned) | |
| PF | Packed floating | |
| PZ | Packed zipcode | |
| QS | Quadword (signed) | |
| RO | Right overpunch | |
| RS | Right sign separate | |
| UN | Undefined | |
| ZE | Zoned EBCDIC | |
| ZN | )Zoned numeric; used by DIBOL |
J The DATE (DS) attribute is currently only used by applications and has no effect within INTOUCH.
L Enter the position at which this field will start. Character positions are % numbered sequentially. For example: Figure 16-1 Character Positions
% ID CONTACT C ----------------------------------------------- C | | | | | | | | | | | | | | | | | | | | | | | | @ | | | | | @ positions 1 5 10 15 20
M In the above diagram, the ID field starts at position 1 and ends at position 1 5. The CONTACT field starts at position 6, etc.
L Fields generally follow each other directly. Therefore, the first position M of a new field is usually one more than the last position used. If the last F position used was ten, the next field would start at eleven. INTOUCH ; automatically defaults to the correct sequential position.
( Defining existing RMS file fields
K If you are defining fields for an existing RMS file, you must keep in mind J that the starting position of an RMS file record is 0 and in INTOUCH, the M starting position is 1. (RMS is 0 oriented, whereas INTOUCH is 1 oriented.) I For example, if the RMS file field starts in position 0, when you define L this field in INTOUCH, you must define the field as starting in position 1. I If the RMS field starts in position 20, you would use 21 as the starting position, etc.
4