Managing IMS Transactions Metadata
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.
Creating Synonyms
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.
Create a Synonym
- Procedure
- From the WebFOCUS Reporting Server browser interface Application page, click Get Data.
- On the
Configured Adapters section of the page, in Simple Mode, right-click an adapter
and click
Show
Connections. Right-click a connection.
Depending on the type of adapter you choose, one of the following options appears on the context menu.
- Show DBMS objects. This option opens the page for selecting synonym objects and properties.
- Create metadata objects. This option opens the page for selecting synonym objects and properties.
- Show files. This option opens a file picker. After you choose a file of the correct type, the page for selecting synonym objects and properties opens.
- Show local files. This option opens a file picker. After you choose a file of the correct type, the page for selecting synonym objects and properties opens.
- Show topics. This option opens the page for selecting synonym objects and properties for topics within the environment.
- Enter values for the parameters required by the adapter as described in the chapter for your adapter.
- After
entering the parameter values, click
Add.
This button may be labeled Next, Create Synonym, Create Base Synonyms, Create Cluster Synonym, or Update Base Synonyms.
The synonym creation process for most adapters has been consolidated so that you can enter all necessary parameters on one page. However, for some adapters such as LDAP, continue clicking Next until you get to a page that has a Create Synonym button.
The synonym is created and added under the specified application directory.
Synonym Creation Parameters for IMS Transactions on Windows and UNIX
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.
Collection of Cobol definitions
Enter a directory name to display all members in the directory path.
If you wish to limit retrieval, you can enter a file name and/or file extension:
- In the File name box, enter a full name or a partial name with a wildcard symbol %. A full name returns just that entry. A name with a wildcard symbol may return many entries.
- In the File extension box, enter an extension with or without the wildcard symbol %.
Type the name of the synonym.
Type the name of the IMS Transactions program or APPC transaction.
Select the Validate checkbox 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 checkbox 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 checkbox, 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 checkbox.
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.
Synonym Creation Parameters for IMS Transactions on z/OS
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:
- Fully qualified PDS name to indicate
a partitioned data set on MVS.
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
- Absolute HFS directory pathname to indicate
a hierarchical file structure on USS.
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 (%).
- Applications to indicate a pre-configured HFS directory.
Type the name of the synonym.
Type the name of the IMS Transactions program or APPC transaction.
Select the Validate checkbox 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 checkbox 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 checkbox, 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 checkbox.
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.
Master File for IMS TRAN Adapter
FILENAME=IMSTPART, SUFFIX=IMSTRAN , $
SEGMENT=SEG1, SEGTYPE=S0, $
$ GROUP=PARTKEY_INPUT, USAGE=A50, ACTUAL=A50, $
FIELDNAME=PARTKEY, USAGE=A50, ACTUAL=A50, $
SEGMENT=SEG11, SEGTYPE=S0, PARENT=SEG1, $
$ GROUP=PARTROOT_OUTPUT, USAGE=A268, ACTUAL=A268, $
FIELDNAME=FILLER, USAGE=A3, ACTUAL=A3, $
FIELDNAME=RECTYPE, USAGE=A1, ACTUAL=A1, $
FIELDNAME=FILLER, USAGE=A22, ACTUAL=A22, $
FIELDNAME=PARTNUM, USAGE=A12, ACTUAL=A12, $
FIELDNAME=FILLER, USAGE=A18, ACTUAL=A18, $
FIELDNAME=DESCRIPTION, USAGE=A20, ACTUAL=A20, $
FIELDNAME=FILLER, USAGE=A26, ACTUAL=A26, $
FIELDNAME=PROCCODE, USAGE=A12, ACTUAL=A12, $
FIELDNAME=FILLER, USAGE=A18, ACTUAL=A18, $
FIELDNAME=INVCODE, USAGE=A8, ACTUAL=A8, $
FIELDNAME=FILLER, USAGE=A26, ACTUAL=A26, $
FIELDNAME=MAKEDEPT, USAGE=A12, ACTUAL=A12, $
FIELDNAME=FILLER, USAGE=A18, ACTUAL=A18, $
FIELDNAME=PREVNO, USAGE=A8, ACTUAL=A8, $
FIELDNAME=FILLER, USAGE=A26, ACTUAL=A26, $
FIELDNAME=MAKETIME, USAGE=A12, ACTUAL=A12, $
FIELDNAME=FILLER, USAGE=A18, ACTUAL=A18, $
FIELDNAME=COMMCODE, USAGE=A8, ACTUAL=A8, $
SEG1, the input segment, was generated from the following COBOL FD:
01 PARTKEY-INPUT.
05 PARTKEY PIC X(50).
SEG11, the output segment, was generated from the following COBOLFD:
01 PARTROOT-OUTPUT.
05 FILLER PIC X(3).
05 RECTYPE PIC X(1).
05 FILLER PIC X(22).
05 PARTNUM PIC X(12).
05 FILLER PIC X(18).
05 DESCRIPTION PIC X(20).
05 FILLER PIC X(26).
05 PROCCODE PIC X(12).
05 FILLER PIC X(18).
05 INVCODE PIC X(8).
05 FILLER PIC X(26).
05 MAKEDEPT PIC X(12).
05 FILLER PIC X(18).
05 PREVNO PIC X(8).
05 FILLER PIC X(26).
05 MAKETIME PIC X(12).
05 FILLER PIC X(18).
05 COMMCODE PIC X(8).
Managing Synonyms
Once you have created a synonym, you can right-click the synonym name in the navigation pane of either the WebFOCUS Reporting Server browser interface or ibi Data Migrator desktop interface to access the available options.
For a list of options, see Synonym Management Options.
Access File Attributes
|
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 transaction to be executed. |
Access File for Transaction/Program
SEGNAME=SEG1, CONNECTION=IMS8C, TRANSACTION=part, $