Configurations

The following configurations are only displayed for existing external systems or after creating a new one.

General Configurations

General configurations are configurations defining the methods in fetching services from your server for creating Services.

When an external system is created, the following general configurations are automatically created:

• Load Services — used to fetch REST Catalog services.
• ORMB API SPEC — used to fetch services specific to ORMB API requests.

Create a general configuration

You can also create a new general configuration by following these steps:

1. Navigate to Administration > External Systems.
2. Select an existing external system from the list.
3. Click General Configurations > Create.
4. Fill in the required fields.

5. Click Save.

Modify a general configuration

To modify a general configuration, select the desired configuration, then click the Edit icon.

Batch Configurations

When an external system is created, the following batch configurations are automatically created:

• Job Submission URL
• Job Status URL
• Job Error URL
• Job Statistics URL
• Load Batch Names
• Load Batch Parameters

Job Submission URL

Defines the configuration used to submit a batch. The Data Set is used as the request body for the POST request, and in response, a batchJobId is retrieved after a successful batch job submission. This batchJobId is used for further test execution.

See below for an example of the request body, response body, and extra details.

• Request Body
• Response Body
• Extra Details

{
  "TA-BatchJobSubmission": {
    "batchControl": "BILLING",
    "processDate": "2020-05-01",
    "batchJobParameter": [
      {
        "sequence": "10",
        "isRequired": "false",
        "description": "Override Maximum Number of Errors",
        "batchParameterName": "MAX-ERRORS",
        "required": false
      },
      {
        "sequence": "20",
        "isRequired": "false",
        "description": "Division",
        "batchParameterName": "CIS-DIVISION",
        "required": false
      },
      {
        "sequence": "30",
        "isRequired": "false",
        "description": "Thread Pool Name",
        "batchParameterName": "DIST-THD-POOL",
        "required": false
      },
      {
        "sequence": "40",
        "isRequired": "false",
        "description": "Bill Cycle",
        "batchParameterName": "BILL-CYC-CD",
        "required": false
      },
      {
        "sequence": "50",
        "isRequired": "false",
        "batchParameterValue": "2228313882",
        "description": "Account ID",
        "batchParameterName": "ACCT-ID",
        "required": false
      }
    ]
  }
}

{
  "TA-BatchJobSubmission": {
    "batchJobId": "99494498539339",
    "batchControl": "BILLING",
    "user": "SYSUSER",
    "language": "ENG",
    "batchStartDateTime": "2023-02-27T10:13:36Z",
    "batchRunNumber": "49",
    "batchRerunNumber": "0",
    "threadCount": "0",
    "batchThreadNumber": "0",
    "processDate": "2020-05-01",
    "maximumCommitRecords": "0",
    "maximumTimeoutMinutes": "0",
    "isTracingProgramStart": "false",
    "isTracingProgramEnd": "false",
    "isTracingSQL": "false",
    "isTracingStandardOut": "false",
    "description": "Billing",
    "programName": "CIPBBILB",
    "userInfo": "System, English",
    "batchJobParameter": [
      {
        "sequence": "10",
        "batchParameterName": "MAX-ERRORS",
        "isRequired": "false",
        "description": "Override Maximum Number of Errors"
      },
      {
        "sequence": "20",
        "batchParameterName": "CIS-DIVISION",
        "isRequired": "false",
        "description": "Division"
      },
      {
        "sequence": "30",
        "batchParameterName": "DIST-THD-POOL",
        "isRequired": "false",
        "description": "Thread Pool Name"
      },
      {
        "sequence": "40",
        "batchParameterName": "BILL-CYC-CD",
        "isRequired": "false",
        "description": "Bill Cycle"
      },
      {
        "sequence": "50",
        "batchParameterName": "ACCT-ID",
        "batchParameterValue": "2228313882",
        "isRequired": "false",
        "description": "Account ID"
      }
    ]
  }
}

Job Status URL

Defines the configuration used to get the status of a submitted batch. The batchJobId from Job Submission URL configuration is used to retrieve a response on whether the batch job status ran successfully.

The nodes in this configuration are used to store the following batch run information:

• batchJobStatus — status of the batch run. The possible values are ST, IP, PD, or ED.
• throttleTime — number of minutes the batch run is in a PD or IP state before it automatically stops.
• batchJobId
• batchRunNumber

See below for an example of the request body, response body, and extra details.

• Request Body
• Response Body
• Extra Details

{
  "CM-CheckBatchJobStatus": {
    "batchJobId": "99494498539339"
  }
}

{
  "CM-CheckBatchJobStatus": {
    "batchJobId": "99494498539339",
    "batchJobStatus": "PD",
    "batchRunNumber": "49"
  }
}

Job Error URL

Defines the configuration used to get the error details of a submitted batch. The batchRunNumber from Job Status URL is used to get the error details.

See below for an example of the request body, response body, and extra details.

• Request Body
• Response Body
• Extra Details

{
  "TA_BATCH_ERR": {
    "zoneCd": "TA_BATCH_ERR",
    "batchCd": "POSTPROC",
    "batchNbr": "3328",
    "results": [
      {
        "ErrorDetails": "string"
      }
    ]
  }
}

{
  "TA_BATCH_ERR": {
    "zoneCd": "TA_BATCH_ERR",
    "batchCd": "POSTPROC",
    "batchNbr": "3328",
    "results": [
      {
        "ErrorDetails": "string"
      }
    ]
  }
}

Job Statistics URL;

Defines the configuration used to get the overall statistics of the submitted batch. The statistics can either be completed or error. If it is error, the TotalError node will have a value that will be used in the next service to get the error details. The batchRunNumber from Job Status URL and the batchNbr from Job Error URL are used in the POST request to get the following nodes in the Response Body.

See below for an example of the request body, response body, and extra details.

• Request Body
• Response Body
• Extra Details

{
  "TA-CheckBatchJobStatus": {
    "batchJobId": "99494498539339",
    "batchJobStatus": "PD",
    "batchRunNumber": "49"
  }
}

{
  "TA_BTCH_STAT": {
    "zoneCd": "TA_BTCH_STAT",
    "batchCd": "F1-FLUSH",
    "batchNbr": "3328",
    "results": [
      {
        "BatchCode": "string",
        "Description": "string",
        "BatchNbr": "string",
        "Status": "string",
        "BatchRunDate": "string",
        "Threads": "string",
        "TotalProcess": "string",
        "TotalError": "string",
        "TimeHrs": "string",
        "StartTime": "string",
        "EndTime": "string"
      }
    ]
  }
}

Load Batch Names;

Defines the configuration used to load the batch names to your server.

See below for an example of the request body.

• Request Body

{
  "CM-GetServiceName": {}
}

Load Batch Parameters

Defines the configuration used to load the batch parameters to your server.

See below for an example of the request body.

• Request Body

{
  "getBatchControlParams": {
    "batchControl": "batchName"
  }
}

Create a batch configuration

1. Navigate to Administration > External Systems.
2. Select an existing external system from the list.
3. Click Batch Configurations > Create.
4. Fill in the required fields.

Modify a batch configuration

To modify a batch configuration, select the desired configuration, then click the Edit icon.

Error Configurations

Error configurations show customized error messages after test executions on the Run Results screen.

Create an error configuration

1. Navigate to Administration > External Systems.
2. Select an existing external system from the list.
3. Click Error Configurations > Create.

            
{
  "problemDetailDocument": {
    "problemType": "https://ec2-54-225-50-201.compute-1.amazonaws.com:7002/ouaf/rest/ouaf/message/3/253",
    "title": "Person ID field missing",
    "httpStatus": 400,
    "detail": "A mandatory field has been left blank. Please enter a value and retry your request.",
    "problemInstance": "https://ec2-54-225-50-201.compute-1.amazonaws.com:7002/ouaf/rest/ouaf/errorMessageInstance/20230612064333021/SYSUSER/3/253?request=%2Fouaf%2Frest%2Fouaf%2Fapi%2Fiws%2FTA-CreateAccount%2FaddAccount&method=POST",
    "serverMessage": {
      "messageCategory": 3,
      "messageNbr": 253,
      "callSequence": ";CIPCACPR;CIPCACPL;CIPCACCP",
      "programName": "CIPCACPR",
      "messageText": "Person ID field missing",
      "longDescription": "A mandatory field has been left blank. Please enter a value and retry your request.",
      "tableName": "CI_ACCT_PER",
      "fieldName": "PER_ID"
    }
  }
}

          

6. Click Save.

Modify an error configuration

To modify an error configuration, select the desired configuration, then click the Edit icon.

Global Variable Configurations

The variable configured in the Global Variable Configurations module can be used across the external systems. Global variables are used to hide actual values. A global variable will be displayed instead of its table actual parameter value. For example, you can set a global variable for your username and password so that their actual values will not be displayed on test execution and results.

You can use global variables in the Steps and Data Sets modules.

Create a global variable configuration

1. Navigate to Administration > External Systems.
2. Select an existing external system from the list.
3. Click Global Variable Configurations > Create.

Modify a global variable configuration

To modify a global variable configuration, select the desired configuration, then click the Edit icon.