IBM Sterling Connect:Direct jobs
An IBM Sterling Connect:Direct job runs IBM Sterling Connect:Direct programs to transfer one or more files from a primary node to a secondary node.
Prerequisites
IBM Sterling Connect:Direct job definition
A description of the job properties and valid values are detailed in the context-sensitive help in the Dynamic Workload Console by clicking the question mark (?) icon in the top-right corner of the properties pane.For information about creating jobs using the various supported product interfaces, see Defining a job.
For more information about IBM Sterling Connect:Direct , see IBM Sterling Connect:Direct
Attribute | Description and value | Required |
---|---|---|
Address | The host name or IP address of the workstation that is considered as the primary node where IBM Sterling Connect:Direct is installed. | ✓ |
Port | The port number of the primary node workstation where IBM Sterling Connect:Direct is listening. | ✓ |
User ID | The name of the user authorized to access the IBM Sterling Connect:Direct on the primary node workstation. | ✓ |
Password | The password that is associated with the user that is authorized to access the IBM Sterling Connect:Direct on the primary node workstation. | ✓ |
Node Name | The name of the workstation that is considered as the secondary node where IBM Sterling Connect:Direct is installed. | ✓ (Only for Submit Process action) |
User ID | The name of the user authorized to access the IBM Sterling Connect:Direct on the secondary node workstation. | ✓ (Only for Submit Process action) |
Password | The password that is associated with the user that is authorized to access the IBM Sterling Connect:Direct on the secondary node workstation. | ✓ (Only for Submit Process action) |
Platform | The secondary node workstation operating system:
|
✓ (Only for Submit Process action) |
Submit file | The submit file action. | |
Process File Name | On the primary node is the fully qualified path and name of the file that
contains the IBM Sterling Connect:Direct process
definition. The file extension is .cdp . |
✓ |
Process File Location | The IBM Sterling Connect:Direct node where the Process File is located. If you do not specify this value, the default Process File Location is the Primary Node. | |
New Name | The new name of the IBM Sterling Connect:Direct process associated to the file transfer action. | |
Submit Process | The submit process action. | |
Action type |
|
✓ |
Local Filename Path (pNode) |
|
✓ |
Remote Filename Path (sNode) |
|
✓ |
Destination Disposition | The action to perform: if the file exists in the destination location:
|
✓ |
Compression Type | The compression type:
|
|
Check Point Restart |
|
✓ |
At Every | The file check point interval in KBs | ✓ (Only if Check Point Restart value is Check ) |
Scheduling and stopping the job in HCL Workload Automation
You schedule HCL Workload Automation IBM Sterling Connect:Direct jobs by defining them in job streams. Add the job to a job stream with all the necessary scheduling arguments and submit the job stream.
You can submit jobs by using the Dynamic Workload Console, Application Lab or the conman command line. See Scheduling and submitting jobs and job streams for information about how to schedule and submit jobs and job streams using the various interfaces.
After submitting the job, when the job is running and is reported in EXEC status in HCL Workload Automation, you can stop it if necessary, by using the kill command. This action is effective on both HCL Workload Automation job and IBM Sterling Connect:Direct jobs. The IBM Sterling Connect:Direct job is deleted. HCL Workload Automation assigns the Error or ABEND status with return code 0 to the HCL Workload Automation job.
Monitoring the job
If the HCL Workload Automation agent stops when you submit theHCL Workload Automation IBM Sterling Connect:Direct job or while the job is running, as soon as the agent becomes available again HCL Workload Automation begins monitoring the job from where it stopped.
For information about how to monitor jobs using the different product interfaces available, see Monitoring HCL Workload Automation jobs.
SterlingJobExecutor.properties configuration file
The properties file is automatically generated either when you perform a "Test Connection" from the Dynamic Workload Console in the job definition panels, or when you submit the job to run the first time. Once the file has been created, you can customize it. This is especially useful when you need to schedule several jobs of the same type. You can specify the values in the properties file and avoid having to provide information such as credentials and other information, for each job. You can override the values in the properties files by defining different values at job definition time.
- On Windows operating systems
- TWS_INST_DIR\TWS\JavaExt\cfg
- On UNIX operating systems
- TWA_DATA_DIR/TWS/JavaExt/cfg
primaryNodeAddress=primaryNodeAddress
primaryUserPwd={aes}7LqI0kLt2kiNWNi2QGIIAKxQat5KCN0SNez7ENweg9w=
primaryNodePort=primaryNodePort
primaryUsername=primaryUsername
secondaryUsername=secondaryUsername
secondaryUserPwd={aes}ns2erjqeEemph8T2hGvLTiP5hbC+OzqQloXmq9Hu4sk=
secondaryNodeAddress=secondaryNodeAddress
If
you define an IBM Sterling Connect:Direct job with the
Submit file action
, the secondary node information is not read from the
SterlingJobExecutor.properties configuration file. The job uses the secondary
node name specified in the Node Name field of Dynamic Workload Console or, if not specified, the secondary
node name contained in the IBM Sterling Connect:Direct
job Process File Name input.Job properties
While the job is running, you can track the status of the job and analyze the properties of the job. In particular, in the Extra Information section, if the job contains variables, you can verify the value passed to the variable from the remote system. Some job streams use the variable passing feature, for example, the value of a variable specified in job 1, contained in job stream A, is required by job 2 in order to run in the same job stream.
For information about how to display the job properties from the various supported interfaces, see Analyzing the job log.
conman sj <Sterling_job_name>;props
where
<Sterling_job_name> is the IBM Sterling Connect:Direct job name.Extra Information
section of the output command, you see the following properties:- Submit process action
-
Extra Information Action Selected = Send Check Point Restart = Default Compression Type = None Destination Disposition = Replace Destination File Path = c:\sterling\example_ste_1.exe Primary Node Address = austin2.usa.com:1363 Primary Node User = Administrator Process Name = copy1 Process Number = 145 Secondary Node Name = austin2_bkp Secondary Node User = Administrator Source File Path = c:\sterling\examples\example_ste_1.exe
- Submit file action
-
Extra Information Child Process Name = 56415021 Primary Node Address = cleveland1.usa.com:1363 Primary Node User = Administrator Process File Name = c:\sterling\processes\PROC1.cdp Process File Location= cleveland1.usa.com Process Name = Submit1 Process Number = 416 Secondary Node Name = losangeles1 Secondary Node User = Administrator
- Action Selected
- The action to perform that you specify in the Action Selected field.
- Check Point Restart
- The check point restart value that you specify in the Check Point Restart field.
- Child Process Name
- The name of the child process invoked by the parent process specified by Process Name.
- Compression Type
- The compression type value that you specify in the Compression Type field.
- Destination Disposition
- The action to perform that you specify in the Destination Disposition field.
- Destination File Path
- The absolute file path where you save the file.
- Primary Node Address
- The host name or IP address of the workstation that is considered as the primary node on which IBM Sterling Connect:Direct is installed that you specify in the Address field.
- Primary Node User
- The name of the user authorized to access IBM Sterling Connect:Direct on the primary node workstation that you specify in the Process Name field.
- Process Name
- The name of the IBM Sterling Connect:Direct process that you specify in the Process Name field.
- Process Number
- The IBM Sterling Connect:Direct process number.
- Process File Name
- The fully qualified path and name of the file that contains the IBM Sterling Connect:Direct process definition that you specify in the Process File Name field.
- Process File Location
- The IBM Sterling Connect:Direct node on which the Process File is located that you specify in Process File Location field.
- Secondary Node Name
- The name of the workstation that is considered as the secondary node on which IBM Sterling Connect:Direct is installed that you specify in the Node Name field.
- Secondary Node User
- The name of the user authorized to access the IBM Sterling Connect:Direct on the secondary node workstation that you specify in the User ID field.
- Source File Path
- The absolute file path from which you download the file.
You can export the IBM Sterling Connect:Direct job
properties that you can see in the Extra Information
section,
to a successive job in the same job stream instance. For more information about the
list of job properties that you can export, see Properties
for IBM Sterling Connect:Direct jobs.
- Submit Process action:
- The following example shows the
EX_STE_SUB_PROC
job definition that performs the copy ofc:\repository\DBfiles\e*
non-compressed files from theny123456.usa.com
windows primary node workstation to theNy112130.usa.com
windows secondary node workstation with thereplace
Destination Disposition.MDM_WIN_EAST#EX_STE_SUB_PROC TASK <?xml version="1.0" encoding="UTF-8"?> <jsdl:jobDefinition xmlns:jsdl= "http://www.abc.com/xmlns/prod/scheduling/1.0/jsdl" xmlns:jsdlsterling= "http://www.abc.com/xmlns/prod/scheduling/1.0/jsdlsterling" name="STERLING"> <jsdl:application name="sterling"> <jsdlsterling:sterling> <jsdlsterling:SterlingParameters> <jsdlsterling:connectionInfoPanel> <jsdlsterling:primaryNode> <jsdlsterling:primaryAddress> ny123456.usa.com</jsdlsterling:primaryAddress> <jsdlsterling:primaryPort> 1363</jsdlsterling:primaryPort> <jsdlsterling:primaryCredentials> <jsdl:userName>Administrator</jsdl:userName> <jsdl:password> {aes}5HC6x+v0ZAszGSfOPNAxpJjPbNvVOq+vfIWdAw95kEA= </jsdl:password> </jsdlsterling:primaryCredentials> </jsdlsterling:primaryNode> <jsdlsterling:secondaryNode> <jsdlsterling:secondaryNodeName> Ny112130.usa.com</jsdlsterling:secondaryNodeName> <jsdlsterling:secondaryCredentials> <jsdlsterling:secondaryUserID> Administrator</jsdlsterling:secondaryUserID> <jsdlsterling:password> {aes}jQcDnhTIaroI0q1TVLnGqGLaRtG3J9g+JeIhsBGcBF8= </jsdlsterling:password> </jsdlsterling:secondaryCredentials> <jsdlsterling:secondaryPlatform> Unknown</jsdlsterling:secondaryPlatform> </jsdlsterling:secondaryNode> </jsdlsterling:connectionInfoPanel> <jsdlsterling:actionPanel> <jsdlsterling:ProcessButtonGroup> <jsdlsterling:radioButtonDefinition> <jsdlsterling:ProcessDefinitionGroup> <jsdlsterling:ActionGroup> <jsdlsterling:actionType>Send </jsdlsterling:actionType> <jsdlsterling:ActionFileGroup> <jsdlsterling:localFilenamePath> "c:\repository\DBfiles\e*"/jsdlsterling:localFilenamePath> <jsdlsterling:remoteFilenamePath> "c:\sterling\*"/jsdlsterling:remoteFilenamePath> </jsdlsterling:ActionFileGroup> </jsdlsterling:ActionGroup> <jsdlsterling:ProcessGroup> <jsdlsterling:destinationDisposition> RPL/jsdlsterling:destinationDisposition> <jsdlsterling:compressionType> EXTENDED/jsdlsterling:compressionType> </jsdlsterling:ProcessGroup> <jsdlsterling:CheckPointGroup> <jsdlsterling:checkPointRestart> Check/jsdlsterling:checkPointRestart> <jsdlsterling:checkPointAtEvery >1000</jsdlsterling:checkPointAtEvery> </jsdlsterling:CheckPointGroup> </jsdlsterling:ProcessDefinitionGroup> </jsdlsterling:radioButtonDefinition> </jsdlsterling:ProcessButtonGroup> </jsdlsterling:actionPanel> </jsdlsterling:SterlingParameters> </jsdlsterling:sterling> </jsdl:application> </jsdl:jobDefinition> DESCRIPTION "Added by composer." RECOVERY STOP
- Submit File action:
- The following example shows the
EX_STE_SUB_FILE
job definition that uses thec:/sterling/processes/PROC1.cdp
Process File saved on theNy112130.usa.com
windows secondary node workstation.MDM_WIN_EAST#EX_STE_SUB_FILE TASK ?xml version="1.0" encoding="UTF-8"?> <jsdl:jobDefinition xmlns:jsdl="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdl" xmlns:jsdlsterling= "http://www.abc.com/xmlns/prod/scheduling/1.0/jsdlsterling" name="STERLING"> <jsdl:application name="sterling"> <jsdlsterling:sterling> <jsdlsterling:SterlingParameters> <jsdlsterling:connectionInfoPanel> <jsdlsterling:primaryNode> <jsdlsterling:primaryAddress> ny123456.usa.com</jsdlsterling:primaryAddress> <jsdlsterling:primaryPort>1363</jsdlsterling:primaryPort> <jsdlsterling:primaryCredentials> <jsdl:userName>Administrator</jsdl:userName> <jsdl:password> {aes}IhgUjKAJ1fFcNTsRnNcn4KSoxowJrqV7m/lHF9LeXTo= </jsdl:password> </jsdlsterling:primaryCredentials> </jsdlsterling:primaryNode> <jsdlsterling:secondaryNode> <jsdlsterling:secondaryNodeName> Ny112130.usa.com</jsdlsterling:secondaryNodeName> <jsdlsterling:secondaryCredentials> <jsdlsterling:secondaryUserID> Administrator</jsdlsterling:secondaryUserID> <jsdlsterling:password> {aes}eFH8XJLD67gHkiJlgHjsCjgTJVCVdswVAoheU2rc+FM= </jsdlsterling:password> </jsdlsterling:secondaryCredentials> <jsdlsterling:secondaryPlatform>Windows </jsdlsterling:secondaryPlatform> </jsdlsterling:secondaryNode> </jsdlsterling:connectionInfoPanel> <jsdlsterling:actionPanel> <jsdlsterling:ProcessButtonGroup> <jsdlsterling:radioButtonFile> <jsdlsterling:ProcessFileGroup> <jsdlsterling:processFileName> "c:/sterling/processes/PROC1.cdp" </jsdlsterling:processFileName> <jsdlsterling:processFileLocation> Ny112130.usa.com</jsdlsterling:processFileLocation> <jsdlsterling:processName> proc1</jsdlsterling:processName> </jsdlsterling:ProcessFileGroup> </jsdlsterling:radioButtonFile> </jsdlsterling:ProcessButtonGroup> </jsdlsterling:actionPanel> </jsdlsterling:SterlingParameters> </jsdlsterling:sterling> </jsdl:application> </jsdl:jobDefinition> DESCRIPTION "Added by composer." RECOVERY STOP
Job log content
For information about how to display the job log from the various supported interfaces, see Analyzing the job log.
For example, you can see the job log content by
running conman sj <Sterling_job_name>;stdlist
,
where <Sterling_job_name> is the IBM Sterling Connect:Direct job
name.
sj @#@.a1;std
===============================================================
= JOB : WKS_1#JOBS[(0000 04/03/14),(JOBS)].A1
= TASK : <?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl=
"http://www.abc.com/xmlns/prod/scheduling/1.0/jsdl"
xmlns:jsdlsterling=
"http://www.abc.com/xmlns/prod/scheduling/1.0/jsdlsterling" name="STERLING">
<jsdl:variables>
<jsdl:stringVariable name=
"tws.jobstream.name">JOBS</jsdl:stringVariable>
<jsdl:stringVariable name=
"tws.jobstream.id">JOBS</jsdl:stringVariable>
<jsdl:stringVariable name=
"tws.job.name">A1</jsdl:stringVariable>
<jsdl:stringVariable name=
"tws.job.workstation">WKS_1</jsdl:stringVariable>
<jsdl:stringVariable name=
"tws.job.iawstz">201404030000</jsdl:stringVariable>
<jsdl:stringVariable name=
"tws.job.promoted">NO</jsdl:stringVariable>
<jsdl:stringVariable name=
"tws.job.resourcesForPromoted">10</jsdl:stringVariable>
<jsdl:stringVariable name="tws.job.num">
678705192</jsdl:stringVariable>
</jsdl:variables>
<jsdl:application name="sterling">
<jsdlsterling:sterling>
<jsdlsterling:SterlingParameters>
<jsdlsterling:connectionInfoPanel>
<jsdlsterling:primaryNode>
<jsdlsterling:primaryAddress>
nc112129.romelab.it.abc.com</jsdlsterling:primaryAddress>
<jsdlsterling:primaryPort>1363</jsdlsterling:primaryPort>
<jsdlsterling:primaryCredentials>
<jsdl:userName>Administrator</jsdl:userName>
<jsdl:password>
{aes}3mrvR/UH4QIXvIpaccMAQr156nu/yVaHXEGaWmIZSDE=
</jsdl:password>
</jsdlsterling:primaryCredentials>
</jsdlsterling:primaryNode>
<jsdlsterling:secondaryNode>
<jsdlsterling:secondaryNodeName>
NC112130</jsdlsterling:secondaryNodeName>
<jsdlsterling:secondaryCredentials>
<jsdlsterling:secondaryUserID>
Administrator</jsdlsterling:secondaryUserID>
<jsdlsterling:password>
{aes}THwo8M/LmpApHlPfB6r4FUtrbB+0SDS2YF7gUePvjVI=
</jsdlsterling:password>
</jsdlsterling:secondaryCredentials>
<jsdlsterling:secondaryPlatform>
Windows</jsdlsterling:secondaryPlatform>
</jsdlsterling:secondaryNode>
</jsdlsterling:connectionInfoPanel>
<jsdlsterling:actionPanel>
<jsdlsterling:ProcessButtonGroup>
<jsdlsterling:radioButtonDefinition>
<jsdlsterling:ProcessDefinitionGroup>
<jsdlsterling:ActionGroup>
<jsdlsterling:actionType>
Send</jsdlsterling:actionType>
<jsdlsterling:ActionFileGroup>
<jsdlsterling:localFilenamePath>
c:\sterling\ely\ely*</jsdlsterling:localFilenamePath>
<jsdlsterling:remoteFilenamePath>
c:\sterling\*</jsdlsterling:remoteFilenamePath>
</jsdlsterling:ActionFileGroup>
</jsdlsterling:ActionGroup>
<jsdlsterling:ProcessGroup>
<jsdlsterling:destinationDisposition>
RPL</jsdlsterling:destinationDisposition>
<jsdlsterling:compressionType>
NONE</jsdlsterling:compressionType>
</jsdlsterling:ProcessGroup>
<jsdlsterling:CheckPointGroup>
<jsdlsterling:checkPointRestart>
Default</jsdlsterling:checkPointRestart>
<jsdlsterling:checkPointAtEvery/>
</jsdlsterling:CheckPointGroup>
</jsdlsterling:ProcessDefinitionGroup>
</jsdlsterling:radioButtonDefinition>
</jsdlsterling:ProcessButtonGroup>
</jsdlsterling:actionPanel>
</jsdlsterling:SterlingParameters>
</jsdlsterling:sterling>
</jsdl:application>
<jsdl:resources>
<jsdl:orderedCandidatedWorkstations>
<jsdl:workstation>E292ED57CADA44A3830D9FF0F495F57E</jsdl:workstation>
</jsdl:orderedCandidatedWorkstations>
</jsdl:resources>
</jsdl:jobDefinition>
= TWSRCMAP :
= AGENT : WKS_1
= Job Number: 678705192
= Thu Apr 3 18:39:26 CEST 2014
===============================================================
Monitor Process
File name: c:\sterling\ely\ely.exe Percentage: 5% Bytes Sent: 3801030
File name: c:\sterling\ely\ely.exe Percentage: 46% Bytes Sent: 25994964
File name: c:\sterling\ely\ely1.exe Percentage: 14% Bytes Sent: 8388480
File name: c:\sterling\ely\ely1.exe Percentage: 88% Bytes Sent: 48975318
File name: c:\sterling\ely\ely2.exe Percentage: 45% Bytes Sent: 25339614
File name: c:\sterling\ely\ely3.exe Percentage: 17% Bytes Sent: 10288995
File name: c:\sterling\ely\ely3.exe Percentage: 56% Bytes Sent: 31521456
Total Bytes: 54476696
Percentage: 100%
Process Name: SENDRECV Process Number: 183 Return Code= 0
===============================================================
= Exit Status : 0
= Elapsed Time (Minutes) : 2
= Thu Apr 3 18:40:38 CEST 2014
===============================================================
See also
From the Dynamic Workload Console you can perform the same task as described in
For more information about how to create and edit scheduling objects, see