NTTData: UniKix
Disclaimer
Your use of this download is governed by Stonebranch’s Terms of Use, available at Stonebranch Integration Hub - Terms of Use.
Overview
This Universal Task provides the capabilities for submitting JCL Requests to UniKix Batch Processing Environment by using BPESUB CLI Command with additional capabilities like fetching the logs and output files, validating successful execution and running a profile environment script before running the command.
The BPESUB command is an operating system utility used to submit JCL requests in UniKix Batch Processing Environment.
Version Information
Template Name | Extension Name | Extension Version |
---|---|---|
UniKix | ue-cs-unikix | 1.0.0 |
Refer to Changelog for version history information.
Requirements
Software Requirements for Universal Template and Universal Task
This integration requires BPESUB command and optionally an environment script to set the config parameters of the BPESUB command.
Software Requirements Universal Agent
Only Linux agents are supported:
Universal Agent for Linux Version 7.2.0.0 and later with python options installed.
Software Requirements Universal Controller
Universal Controller Version 7.2.0.0 and later.
Key Features
The Universal Task provides the following key features:
- Submit Request
- Fetch Logs
- Process output to identify step exit codes
- Execute Environment Script
Import Universal Template
To use the Universal Template, you first must perform the following steps.
This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
To import the Universal Template into your Controller, follow the instructions here.
When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.
Configure Universal Task
For a new Universal Task, create a new task, and enter the required input fields.
The following lists the input fields required for a selected Action.
Supported Actions
The following Actions are supported:
Action | Use Case | Required Parameters |
---|---|---|
Submit | Submitting JCL |
|
Action: Submit
Input Fields
The input fields for this Universal Task are described in the following table.
Field | Input Type | Default Value | Type | Description |
---|---|---|---|---|
action | Required | Choice | Select an action | |
jobname | Optional | Text | Enter value for Job Name | |
debug | Optional | false | Boolean | Select to enable Debug Mode |
step_name | Optional | Text | Enter value for Restart or Re-Run Step | |
restart | Optional | false | Boolean | Select to enable restart mode otherwise it will be re-run |
override | Optional | false | Boolean | Select to enable Override option |
other_options | Optional | Text | Enter other options to be passed to binary. | |
bpe_install_dir | Required | Text | Enter value for BPE Installation Folder. Don't add public/bin to the path | |
profile | Optional | Text | Enter value for profile. This profile will be executed before running the program. | |
process_output | Optional | true | Boolean | Select to enable output processing. When enabled out will be parsed to get the status of each step and overridden return codes for each step. |
step_status | Optional | Large Text | This field will display the status of the steps. Output Only. | |
last_step | Optional | Text | This field will display the last executed step. Output Only. |
Task Examples
Configuration example - Running a request with Environment Script
Configuration example - Running a request and Process Output
Task Output
Exit Codes
The exit codes for this Universal Extension are described below.
Exit Code | Status Classification Code | Status Classification Description | Description |
---|---|---|---|
0 | SUCCESS | Successful Execution | Successful Task execution |
10 | FAILED | Folder not found | BPE Install Directory not found. |
11 | FAILED | Binary Path not found | BPESUB command not found under <BPE_INSTALL_DIRECTORY>/public/bin/BPESUB path. |
X | FAILED | BPESUB command failed with exit code X | The BPESUB program exited with a status other than 0. Exit code will be same as the status code. Check the outputs. |
STDOUT and STDERR
STDOUT and STDERR provide additional information to the User. The populated content can be changed in future versions of this extension without notice. Backward compatibility is not guaranteed.
STDOUT will have the output from BPESUB command and the log file content.
EXTENSION is not used.
Document References
This document references the following documents:
Document Link | Description |
---|---|
User documentation for creating, working with, and understanding Universal Templates and Integrations. | |
User documentation for creating Universal Tasks in the Universal Controller user interface. |
Changelog
ue-cs-unikix-1.0.0 (2024-03-04)
Enhancements
- Initial Version