Manage mainframe editor - Precisely Data Integrity Suite

Icon functionality overview

The following table describes the icons in the mainframe editor and their functions for managing files and folders in the tree structure.

Edit mainframe replication file

To modify a mainframe replication file, follow these steps to access the file in the Monaco Editor and make updates.

1. Navigate to Integration > Mainframe Replication.
2. Click ellipsis next to the pipeline and select Edit from the dropdown.
3. Select the desired file in the tree structure.
4. Right-click the file to display the context menu, then choose Edit. This action will open the file in the Monaco Editor.
5. Make the necessary modifications to the file.
6. Click Save in the top right corner to apply your changes.

Rename mainframe replication file

To rename a mainframe replication file, follow these steps to keep your files organized and easily identifiable.

1. Navigate to Integration > Mainframe Replication.
2. Click ellipsis next to the pipeline and select Edit from the dropdown.
3. Select the desired file in the tree structure.
4. Right-click the file to open the context menu, then choose Rename.
5. Enter the new name for the file. The updated name will appear in the tree structure.

Duplicate mainframe replication file

Duplicating a mainframe replication file creates a copy for purposes such as modifications or backups. Original files remain intact.

1. Navigate to Integration > Mainframe Replication.
2. Click ellipsis next to the pipeline and select Edit from the dropdown.
3. Select the desired file in the tree structure.
4. Right-click the file to open the context menu, then choose Duplicate. A duplicate of the file will appear in the tree structure and on the Mainframe Pipeline page, indicated with an underscore followed by a number (for example, testfile_1).

Move mainframe replication file

Moving a mainframe replication file helps maintain a structured file system. Reorganize files according to your workflow to keep related files grouped for easier access and management.

1. Navigate to Integration > Mainframe Replication.
2. Click ellipsis next to the pipeline and select Edit from the dropdown.
3. Select the file you wish to move in the tree structure.
4. Right-click the file to open the context menu, then select Move. This will open the Move dialog, allowing you to choose the new location for the file.
5. Select the desired location and click Move to relocate the file to the selected destination.

Delete mainframe replication file

Deleting a mainframe replication file is a critical action that requires careful consideration. This process is necessary when you want to remove files that are no longer needed or to clean up your workspace. However, it’s important to note that deleting files included in the main script may impact the validation of your pipeline and prevent the application of configuration changes. Follow the steps below to safely delete a file while being aware of the associated warnings and implications.

Set as main script

To set a file as the main script for your mainframe replication pipeline, follow these steps. The Set as Main Script option is available only for files with the .sqd extension. The main.sqd file cannot be deleted and always appears at the top of the tree structure as the primary script.

1. Navigate to Integration > Mainframe Replication.
2. Click ellipsis next to the pipeline and select Edit from the dropdown.
3. Select the desired file in the tree structure.
4. Right-click the file to open the context menu, then select Set As Main Script.

Substitution variables

Substitution variables play an important role in configuring your mainframe replication pipeline. Follow the steps below to create and define variables for use in your scripts.

1. Navigate to Integration > Mainframe Replication.
2. Click ellipsis next to the pipeline and select Edit from the dropdown.
3. Click Substitution Variable button at the top of the editor to open the Substitution Variable window.
4. Click +Create Variable to open the create variable window.
5. Enter the name and description of the variable. Ensure that the variable syntax follows this format %(<parm_name>). Variable names cannot contain spaces or special characters (except for underscores) and must not exceed 32 characters.
6. Select a data type as either String or Encrypted String.
   1. If you choose String, enter the corresponding value in the Value textbox.
   2. If you select Encrypted String, you can enter a value, but it will not be visible in the Value textbox. You cannot edit the value of an encrypted string.
7. Click Create to add the new variable to the substitution variable list.
8. Click Close to exit the management page.

Save and validate mainframe pipeline

After modifying the file, save and validate your mainframe pipeline to confirm that your changes are correctly applied and that the configuration script is functioning as intended.

1. From the mainframe editor, double-click the file or right-click it and select Edit.
2. Once the file opens in the editor, modify the main script as needed.
3. Click Save and Validate button at the top of the editor. The configuration script will be saved, and the validation results will appear in the Validation Results console at the bottom of the editor.

Validation Results tab

You can adjust the validation debug logging level to control the amount of detail displayed during the validation process.

1. Navigate to Integration > Mainframe Replication.
2. Click ellipsis next to the pipeline and select Edit from the dropdown.
3. In the Validation Results console, click the Set Debug Level icon located on the right side of the console to open the Set Validation Debug Logging Level dialog.
4. Select a debug logging level: None, Low, Medium, or High. This setting will determine the level of detail displayed during validation.
5. Click Save to apply the selected debug logging level.

Save

When you want to keep the changes made to a configuration script, saving those modifications is important. Follow the steps below to save your updates.

1. Navigate to Integration > Mainframe Replication.
2. Click ellipsis next to the pipeline and select Edit from the dropdown.
3. From the mainframe editor, double-click the file or right-click it and select Edit.
4. Once the file opens in the editor, modify the main script as needed.
5. Click Save and Validate at the top of the editor and select Save from the drop-down. The configuration script will be saved.

Discard changes

When working on a configuration script, if you decide that the changes you've made are unnecessary, you can easily revert to the previous version by following these steps.

1. Navigate to Integration > Mainframe Replication.
2. Click ellipsis next to the pipeline and select Edit from the dropdown.
3. From the mainframe editor, double-click the file or right-click it and select Edit.
4. Once the file opens in the editor, modify the main script as needed.
5. Click Save and Validate at the top of the editor and select Discard Changes from the drop-down. The changes made to the configuration script will be discarded.

Apply configuration changes

Follow the steps below to manage and implement these changes and keep your pipeline aligned with your objectives.

Other options

Editing the pipeline options lets you modify details such as the pipeline name and description. You can also manage settings related to the automatic start of the pipeline when the runtime engine begins. Follow the steps below to update these pipeline options.

1. Navigate to Integration > Mainframe Replication.
2. Click ellipsis next to the pipeline and select Edit from the dropdown.
3. Click the Options to open the options window.
4. In the window, you can edit the Pipeline Name and Description.
5. By default, the option Automatically Start Pipeline When Runtime Engine Starts is toggled On.
6. You will also be able to view the details such as:
   • Replication Engine: Displays replication engine associated with the pipeline that was selected at the time of pipeline creation.
   • Type of replication: Displays the type of replication that was chosen at the time of creating the pipeline.
   • Pipeline internal name: Displays the pipeline internal name that gets generated after the pipeline is created.
7. Click Save to apply your changes.

Add a configuration script

Adding a configuration script defines the behavior and settings of your mainframe replication pipeline. This process lets you specify parameters, establish workflows, and manage task execution within the pipeline. Follow the steps in this section to create and integrate a configuration script.

Description section

• The DESCRIPTION command defines the structures/layouts of source and target datastores and is used in conjunction with the DATASTORE command to associate a data structure/layout with a physical datastore.
• DESCRIPTION commands must be specified prior to any DATASTORE commands that reference fields within a DESCRIPTION structure/layout.
• It is common for a DESCRIPTION to be used by more than one DATASTORE (such as when the source and target record layouts are the same).
• Record or segment layouts are normally defined by metadata in files which are external to the script.

Syntax

DESCRIPTION <description_type> |COBOL|CSTRUCT|IMSDBD|DB2SQL|ORASQL|MSSQL|SQLDDL|XMLDTD|PL1
                                        <file_name> | /+in line syntactically correct description on as many lines as required+/
                                        AS <description_alias
                                        [KEY IS <key1> [,<key2>...,<keyn>]]
                                        [FOR SEGMENT <segment_name> IN DATABASE <dbname>]
                                        [TOPIC <topic>]
                                        [SUBJECT <subject>]

Datastore section

Syntax

DATASTORE <file_name>
                            | file://[<relative_path.> | <full_path.>] <file_name>
                            | <DD:ddname>[* | (<member_name>)]
                            | <table_name>
                            | RDBMS
                            | cdc://[<host_name_or_address>[:<port_number>]]/<agent_name>/<engine_name>
                            | cdcs://[<host_name_or_address>[:<port_number>]]/<agent_name>/<engine_name>
                            | tcp://<hostname>/<tcpip_port>
                            | mqs://[<qmgr_name>]/<queue_name> [:<correl_id>]
                            | kafka://[<hostname>[:<port_number>]] / [<kafka_topic_id>][/<partition> | key | root_key]
                            | hdfs://<hostname>[:<port_number>]/<hdfs_file_name>
                            OF <DATASTORE_TYPE> AVRO | BINARY | DB2LOAD | DELIMITED | HSSUNLOAD | IMSCDC | IMSDB | JSON | ORACLECDC | RELATIONAL | UTSCDC | VSAM | VSAMCDC | XMLCDC
                            [CHRDEL(‘<delchr>’)]
                            [COLDEL(‘<delchr>’)]
                            [RECDEL(‘<delchr>’)]
                            [CCSID <code> | ASCII | EBCDIC ]
                            [STAGING SIZE <nG>]                   -- file size in Gigabytes
                            [STAGING DELAY <mm>]                 -- rotate every mm minutes
                            AS <datastore_alias>
                            DESCRIBED BY <description_alias1> [,<description_alias2>,…, <description_aliasn>] |  DUMMY
                            DESCRIBED BY GROUP <group_name>
                            [ACCEPT ALL]
                            [BYPASS CHGCHECK]
                            [CHECK FULL BEFORE IMAGE]
                            [COMPENSATE]
                            [COMPENSATE WITH WARNING]
                            [NO COMPENSATION]
                            [EXCEPTION <exception_datastore>]
                            [FOR CHANGE|INSERT]
                            [FORCE QUALIFIER <high_level>
                            [FORMAT [CONFLUENT | CONTAINER | PLAIN]
                            [IMSPATHDATA]
                            [KEEP NULL FIELDS]
                            [KEY IS <key1> [,<key2>...,<keyn>]]
                            [OPERATION IS <change_op_field>]
                            [PROCESS COMMIT]
                            [QUERY </+ <SQL Select and Where clause> +/>]
                            [RECONNECT]
                            [RRS]
                            [SINGLE IMAGE]
                            [STRIP TRAILING SPACES]
                            [WTO ON COMPENSATION EVERY <n> MINUTES]
                            [WTO ON EXCEPTION ONCE]

Main processing section

• The Main body of the processing portion of the script.
• Initiates a processing loop beginning with the first record of the source datastore until the last record has been processed.
• The main processing section has three (3) commands:
  • PROCESS INTO - The PROCESS INTO Command is used only once in the Apply Engine script. It initiates a processing loop beginning with the first record of the source datastore that continues until the last record from the source datastore has been processed.
  • SELECT … FROM- Pair of commands (always used together) that defines the processing loop. Contains source-to-target mapping and transformation logic (if any), often implemented by calling named procedures (CALLPROC).
  • UNION- Allows for “chaining” of multiple SELECT-FROM pairs [optional]

PROCESS INTO

PROCESS INTO identifies the target datastore(s) that will be acted upon by the script and is used in conjunction with the FOR <action> parameter specified in the DATASTORE command for the target datastore which explicitly states how the data will be applied to the target.

PROCESS INTO <target_datastore(s)> 
                        SELECT 
                        { 
                        Mapping logic and/or procedure calls go here 
                        } 
                        FROM <source_datastore> 

where <target_datastore(s)> is the name of a single target datastore or a comma-separated list of target datastores.

PROCESS INTO <target_datastore> [, <target_datastore>]
                            SELECT [UNION];

SELECT

SELECT  
                            SELECT  *
                            SELECT  <source_field>  [,  <source_field>]
                            SELECT  <source_field>  [,  <source_field>]	       <target_field>  [,  <target_field>]
                            SELECT  <source_field>  [,  <source_field>]	       <field_alias>  [,  <field_alias>]
                            SELECT  <function_set>  [,  <function_set>]	       <target_field>  [,  <target_field>]
                            SELECT  <function_set>  [,  <function_set>]	       <field_alias>  [,  <field_alias>]
                            FROM  source_datastore  |  NOTHING
                            ;

UNION

The UNION sub-command chains multiple SELECT sub commands together within a the main Process Command to perform ‘multi-step’ processing within an Apply Engine script. When the UNION sub-command is used, the second SELECT sub-command is executed after the first SELECT sub-command has completed.

UNION
                            SELECT [UNION];