This action plugin enables the submission of a file correction request (by providing the
necessary inputs) to an Interra Baton Server.
Saved Parameters Description
- Name: The name used to identify a saved Baton File Correction configured
instance.
- Comments: The comments of the Baton File Correction template
- Baton Server Node: The remote node name of the server which hosts the Baton File
Correction server
- Baton Server address: The remote host name or remote IP of the server which hosts
the Baton server
- Baton RPC port: The port number of remote server which hosts the Baton server
- Baton user: A user configured on Baton server to make API calls
- Baton password: Password of a user configured on Baton server to make API
calls
- Is Correction Server address different?: Check if the IP address for correction
server is different than QC server. If checked 'Correction server IP' becomes a mandatory
field.'
- Correction server IP: IP address of the correction server.
- Baton Correction port: The port number of the REST API of Baton server
- baton_task_id:
- Baton QC Report as XML:
- Test Plan XML exported from Baton:
- destination_folder:
- output_format:
- Polling Frequency:
Inputs Description
The list of inputs depends on the configuration of the BatonFileCorrection action
template.
All parameters are available as inputs at runtime if not specified by the
template. This plugin does not support value overwrites: if a value is specified in the
template it will not be available as input of the step at runtime.
Mandatory Inputs:
- Baton Server Node or Baton IP Address: Either a remote node must be selected or a
remote IP address must be provided.
- baton_task_id: .
Optional Inputs:
- Name: It is advisable that a name is entered to identify the template.
- Comments: Information about the template which will help identify the
template.
- Baton API Port: The port is optional as a default value (8080) is used if not
specified.
- Priority: A low priority is assigned to the job if nothing is provided.
- Status Polling frequency: Specify if progress needs to be reported within a time
other than default.
- Checkers: Restricts the QC job to a particular checker in Baton.
- Folder Correction?: Check the flag if the input file path is a folder. Default is
false
- Verify growing file?: Check the flag if the input file path is a growing file.
Default is false
- Return xml report as an output?: Check the flag if XML report needs to be fetch
post Correction. Default is false
- Stop Correction on first error?: Check the flag if Orchestrator to should fail the
step and quit QC after first error is noticed. Default is false
- Pass if no errors are found?: Check the flag if warnings are OK and the step can
complete. Default is false
- Non Windows install?: Check the flag if Baton is installed on a Non Windows server.
Default is false
Outputs Description
- Result: Description of the JSON result that was returned from the correction
server.
- Job_ID: Job Id of request that was sent to the baton correction server.
- Start_time: The time when the correction server receives the correction
request.
- Completion_time: The time when the correction server completes the correction
task.
- Output_file: The destination path of the file where the file is placed after
correction.
Operating Instructions for a File Correction Job):
- Provide a remote node or a remote server IP and port; for example, 10.0.103.85
or test.lala.com).
- Provide a the Baton Task ID (from the Baton UI for a Baton QC task).
- The File Correction job is polled until complete. Currently the output file path is not
exposed by the plugin
Troubleshooting
Confirm the following criteria:
- Make sure the port 8080, or the port configured for Baton, is open from
Orchestrator to Baton.
- Make sure the login credentials are valid by logging into Baton UI directly with the
same credentials.
- The Baton Task ID or the Baton Test Plan should not be archived in Baton.