In this section: |
When the server invokes a transaction or procedure, it needs to know how to build the request, what parameters to pass, and how to format an answer set from the response. For each transaction the server will execute, you must create a synonym that describes the layout of the request/response area.
How to: Reference: |
Synonyms define unique names (or aliases) for each transaction or procedure that is accessible from the server. Synonyms are useful because they hide the underlying transaction or procedure from client applications. They also provide support for extended metadata features of the server, such as virtual fields and additional security mechanisms.
Using synonyms allows the input parameters and the response layout to be moved while allowing client applications to continue functioning without modification. For example, moving a transaction or procedure from a test region to production. The result of creating a synonym is a Master File and an Access File, which represent the server metadata.
To create a synonym, you must have previously configured the adapter. You can create a synonym from the Web Console or the Data Management Console.
or
From the Data Management Console, right-click an application directory, then select New, and then Synonym.
The Select adapter to configure or Select connection to create synonym pane opens.
The first of a series of synonym creation panes opens.
The Status pane indicates that the synonym was created successfully.
The synonym is created and added under the specified application directory.
Note: When creating a synonym, if you choose the Validate check box, the server adjusts special characters and checks for reserved words. For more information, see Validation for Special Characters and Reserved Words.
The following list describes the parameters for which you will need to supply values, and related tasks you will need to complete in order to create a synonym for the adapter. These options may appear on multiple panes. To advance from pane to pane, click the buttons provided, ending with the Create Synonym button, which generates the synonym based on your entries.
Select Collection of COBOL definitions and type the location of a collection of Cobol Copybooks. If you select this option you can choose all COBOL definitions in the collection (%) or filter by name and extension.
If you wish to limit retrieval, you can enter a file name and/or file extension:
Type the name of the synonym in the Synonym name box.
Type the name of the CICS Transactions program or APPC transaction in the Program name box.
Enter a COMMAREA value: type CALC in the input box to indicate maximal segment size or enter a value that represents the physical length of the data. The default value is 32500.
Select the Validate check box if you wish to convert all special characters to underscores and perform a name check to prevent the use of reserved names. (This is accomplished by adding numbers to the names.) This parameter ensures that names adhere to specifications. See Validation for Special Characters and Reserved Words for more information.
When the Validate option is unchecked, only the following characters are converted to underscores: '-'; ' '; ' \'; '/'; ','; '$'. No checking is performed for names.
Select the Make unique check box if you wish to set the scope for field and group names to the entire synonym. This ensures that no duplicate names are used, even in different segments of the synonym. When this option is unchecked, the scope is the segment.
Optionally, select Customize COBOL FD conversion options to customize how the COBOL FD is translated. If you do not select the check box, default translation settings are applied.
For more information, see Customization Options for COBOL File Descriptions.
Select an application directory. The default value is baseapp.
If you have tables with identical table names, assign a prefix or a suffix to distinguish them. For example, if you have identically named human resources and payroll tables, assign the prefix HR to distinguish the synonyms for the human resources tables. Note that the resulting synonym name cannot exceed 64 characters.
If all tables and views have unique names, leave the prefix and suffix fields blank.
To specify that this synonym should overwrite any earlier synonym with the same fully qualified name, select the Overwrite existing synonyms check box.
Note: The connected user must have operating system write privileges in order to recreate a synonym.
This column displays the name that will be assigned to each synonym. To assign a different name, replace the displayed value.
The Cobol Copybook(s) appear on the screen. You can choose the same Copybook or different Copybooks for input and output parameters.
Note: There can be no more than one set of input/output Copybooks per synonym.
The following list describes the parameters for which you will need to supply values, and related tasks you will need to complete in order to create a synonym for the adapter. These options may appear on multiple panes. To advance from pane to pane, click the buttons provided, ending with the Create Synonym button, which generates the synonym based on your entries.
Choose one of the following options from the drop-down list:
In the input boxes provided, type a PDS name preceded by // and a Member name containing the location of the COBOL FD source. If you wish, you can filter the member name using a wildcard character (%).
or
In the input boxes provided, type a Directory name to specify the HFS location that contains the COBOL FD and a File name and File extension. If you wish, you can filter the file and extension using a wildcard character (%).
Choose an option from the drop-down list:
Note: The last two options support older style program types (TPG/SPG/ASS) for which migration may be necessary. For details about migration, see the Server Release Notes.
Check this box if you want to use COBOL file descriptions for your Master Files.
Type the name of the synonym in the Synonym name box.
Type the name of the CICS Transactions program or APPC transaction in the Program name box.
Enter a COMMAREA value: type CALC in the input box to indicate maximal segment size or enter a value that represents the physical length of the data. The default value is 32500.
Select the Validate check box if you wish to convert all special characters to underscores and perform a name check to prevent the use of reserved names. (This is accomplished by adding numbers to the names.) This parameter ensures that names adhere to specifications. See Validation for Special Characters and Reserved Words for more information.
When the Validate option is unchecked, only the following characters are converted to underscores: '-'; ' '; ' \'; '/'; ','; '$'. No checking is performed for names.
Select the Make unique check box if you wish to set the scope for field and group names to the entire synonym. This ensures that no duplicate names are used, even in different segments of the synonym. When this option is unchecked, the scope is the segment.
Optionally, select Customize COBOL FD conversion options to customize how the COBOL FD is translated. If you do not select the check box, default translation settings are applied.
For more information, see Customization Options for COBOL File Descriptions.
Select an application directory. The default value is baseapp.
If you have tables with identical table names, assign a prefix or a suffix to distinguish them. For example, if you have identically named human resources and payroll tables, assign the prefix HR to distinguish the synonyms for the human resources tables. Note that the resulting synonym name cannot exceed 64 characters.
If all tables and views have unique names, leave the prefix and suffix fields blank.
To specify that this synonym should overwrite any earlier synonym with the same fully qualified name, select the Overwrite existing synonyms check box.
Note: The connected user must have operating system write privileges in order to recreate a synonym.
This column displays the name that will be assigned to each synonym. To assign a different name, replace the displayed value.
Is the name of the COBOL FD file that contains information about input parameters.
There can be no more than one set of input COBOL Copybooks per synonym. You can choose the same Copybook or different Copybooks for input and output parameters.
Is the name of the COBOL FD file that contains information about output parameters.
There can be no more than one set of output Copybooks per synonym. You can choose the same Copybook or different Copybooks for input and output parameters.
Once you have created a synonym, you can right-click the synonym name in the Adapter navigation pane of either the Web Console or the Data Management Console to access the following options.
Option |
Description |
---|---|
Open |
Opens the Master File for viewing and editing using a graphical interface. If an Access file is used it will be also available. |
Edit as Text |
Enables you to view and manually edit the Master File synonym. Note: To update the synonym, it is strongly recommended that you use the graphical interface provided by the Open option, rather than manually editing the Master File. |
Edit Access File as Text |
Enables you to view and manually edit the Access File synonym. Note: This option is available only when an Access File is created as part of the synonym. |
Sample Data |
Retrieves up to 20 rows from the associated data source. |
Data Profiling |
Data Profiling provides the data characteristics for synonym columns. Alphanumeric columns provide the count of distinct values, total count, maximum, minimum, average length, and number of nulls. Numeric columns provide the count of distinct values, total count, maximum, minimum, average value, and number of nulls. |
Refresh Synonym (if applicable) |
Regenerates the synonym. Use this option if the underlying object has been altered. |
Data Management |
Followed by these options, if applicable: Recreate DBMS Table. Recreates the data source table. You are asked to confirm this selection before the table is regenerated. (Note that the table will be dropped and recreated. During the process, data may be lost.) Delete All Data. Deletes all existing data. You are asked to confirm this selection before the data is deleted. Insert Sample Data. Inserts specified number of sample records, populating all fields with counter values. Reorganize. Recreates the data source table preserving original data. Note: This option is not available in the Web Console. |
Impact Analysis |
Generates reports on procedures, synonyms, and columns that provide information on the flows/stored procedures available on a particular server, and the synonyms and columns they use. These reports enable you to evaluate changes before they are made by showing which components will be affected. See the Server Administration for UNIX, Windows, OpenVMS, IBMÂ i, and z/OS manual for details about Impact Analysis reports. |
Copy |
Copies the synonym to the clipboard. |
Delete |
Deletes the synonym. You are asked to confirm this selection before the synonym is deleted. |
Cut |
Deletes the synonym and places it on the clipboard. |
Properties |
Displays the properties of the synonym, including physical location, last modified date, description, and privileges. |
Master Files contain definitions for input and output parameters used in the transaction. These parameters are described as separate segments.
02 FILEREC. 03 STAT PIC X. 03 NUMB PIC X(6). 03 NAME PIC X(20). 03 ADDRX PIC X(20). 03 PHONE PIC X(8). 03 DATEX PIC X(8). 03 AMOUNT PIC X(8). 03 COMMENT PIC X(9).
FILENAME=ETPBRW8, SUFFIX=CICSTRAN, CODEPAGE=37, $ SEGMENT=SEG1, SEGTYPE=S0, $ GROUP=FILEREC, USAGE=A80, ACTUAL=A80, $ FIELDNAME=STAT, USAGE=A1, ACTUAL=A1, $ FIELDNAME=NUMB, USAGE=A6, ACTUAL=A6, $ FIELDNAME=NAME, USAGE=A20, ACTUAL=A20, $ FIELDNAME=ADDRX, USAGE=A20, ACTUAL=A20, $ FIELDNAME=PHONE, USAGE=A8, ACTUAL=A8, $ FIELDNAME=DATEX, USAGE=A8, ACTUAL=A8, $ FIELDNAME=AMOUNT, USAGE=A8, ACTUAL=A8, $ FIELDNAME=COMMENT, USAGE=A9, ACTUAL=A9, $ SEGMENT=SEG11, SEGTYPE=S0, PARENT=SEG1, $ GROUP=FILEREC, USAGE=A80, ACTUAL=A80, $ FIELDNAME=STAT, USAGE=A1, ACTUAL=A1, $ FIELDNAME=NUMB, USAGE=A6, ACTUAL=A6, $ FIELDNAME=NAME, USAGE=A20, ACTUAL=A20, $ FIELDNAME=ADDRX, USAGE=A20, ACTUAL=A20, $ FIELDNAME=PHONE, USAGE=A8, ACTUAL=A8, $ FIELDNAME=DATEX, USAGE=A8, ACTUAL=A8, $ FIELDNAME=AMOUNT, USAGE=A8, ACTUAL=A8, $ FIELDNAME=COMMENT, USAGE=A9, ACTUAL=A9, $
Keyword |
Description |
---|---|
SEGNAME |
Is the name of the input segment in the Master File. |
CONNECTION |
Indicates the connection_name as previously specified in a SET CONNECTION_ATTRIBUTES command. Defaults to the default connection. |
TRANSACTION |
Is the name of the program to be executed. |
COMMAREA |
Is the maximal size of COMMAREA for the Adapter for CICS Transactions. The options are: CALC means that the maximal segment length will be used. value defaults to 32500. You can enter a value that represents the physical length of the data. |
SEGNAME=SEG1,CONNECTION=CICST1,TRANSACTION=etpbrw8,COMMAREA=32500, FLOAT=IBM,INTEGER=BigEndian,$
Note: Do not change the FLOAT or INTEGER parameter values.
001700 IDENTIFICATION DIVISION. 001800 PROGRAM-ID. ETPBRW8. 001900 ENVIRONMENT DIVISION. 002000 DATA DIVISION. 002100 WORKING-STORAGE SECTION. 002200 01 . 002300 02 WS-RESPONSE PIC 9(8) BINARY. 002500 02 WS-RECORD-SUB PIC 9 VALUE 1. 002510 02 WS-ACC-NUM PIC X(6). 002600 01 COMMAREA. 002601 05 MESSAGES-OUT PIC X(1000). 002602*---------------------------------------------------------------*
002700 LINKAGE SECTION. 002800 01 DFHCOMMAREA. 003000 05 WS-OUTPUT-RECORD OCCURS 4 TIMES. 003100 10 STAT PIC X. 003110 10 ACC-NUM PIC X(6). 003300 10 NAME PIC X(20). 003400 10 ADDRX PIC X(20). 003500 10 PHONE PIC X(8). 003600 10 DATEX PIC X(8). 003700 10 AMOUNT PIC X(8). 003800 10 COMMENTS PIC X(9). 003900*---------------------------------------------------------------*
004000 PROCEDURE DIVISION. 004100 PROCESS-INPUT. 004110 MOVE ACC-NUM(1) TO WS-ACC-NUM 004200 EXEC CICS STARTBR FILE('FILEA') 004300 RIDFLD(WS-ACC-NUM) 004400 GTEQ 004500 END-EXEC 004600 . 004700 004800 MOVE 1 TO WS-RECORD-SUB 004900 005000 PERFORM 4 TIMES 005100 005200 EXEC CICS READNEXT FILE('FILEA') 005300 RIDFLD(WS-ACC-NUM) 005400 INTO(WS-OUTPUT-RECORD(WS-RECORD-SUB)) 005500 RESP(WS-RESPONSE) 005600 END-EXEC 005700 005800 ADD 1 TO WS-RECORD-SUB 005900 006000 END-PERFORM. 006100*---------------------------------------------------------------*
006200 EXEC CICS RETURN 006300 END-EXEC. 006400 GOBACK 006500 .
iWay Software |