Skip to main content

Getting Started with Universal Command Agent for SOA - XD Connector

Objective​

The objective of this document is to assist in the following activities regarding the Universal Command Agent for SOA: XD Connector:

  • Installing Universal Agent for SOA 8.0.x, which is comprised of:
    • Universal Command Agent for SOA
    • Universal Event Monitor for SOA
  • Validating the WebSphere environment.
  • Running the XD Connector on Universal Command Agent for SOA.

Installation Requirements​

For installation requirements, see Universal Agent for SOA for UNIX - Installation Requirements.

Installation​

For installation information, see Universal Agent for SOA for Linux Installation.

Validating the WebSphere XD Environment​

To ensure trouble-free operation of Universal Command Agent for SOA: XD Connector 8.0.x, the WebSphere XD environment must be set up correctly.

The following steps should be made before using the Universal Command Agent for SOA: XD Connector 8.0.x.

Step 1

Application Security
After installing the XD environment application, security must be enabled (if it is not on by default).

  1. Select Security / Secure administration, applications, and infrastructure in the Integrated Solutions Console menu.

  2. Check the Enable application security checkbox in the Application Security group.

Step 2

Map Users to Job Scheduler

Users that have been set up in WebSphere must be mapped to a user in the job scheduler before they can run operations in the job scheduler.

  1. Select System administration / Job scheduler in the Integrated Solutions Console menu.

  2. Click Security role to user/group mapping in the Addition Properties group to display the Security role to user/group mapping page.

    Assign WebSphere users to lrsubmitter or lradmin (or other job scheduler users if you have created them). Make sure the All authenticated? checkbox is checked.

    The following screen illustrates the results of mapping the WebSphere user admin to the lrsubmitter job scheduler user.

Step 3

Install the Job Scheduler Sample Applications

You must install the SimpleCIEar and PostingsSampleEar applications if you want to validate the WebSphere XD installation and the Universal Command Agent for SOA: XD Connector operation.

Go to Applications / Install New Applications in the Integrated Solutions Console menu. Keep in mind that the PostingsSampleEar application requires the database to be set up before you install the application.

The following screen illustrates the two applications after they are installed.

Step 4

Run Sample Applications using lrcmd.sh Utility

Now that you have successfully installed the sample applications, you can test that your WebSphere XD environment is set up correctly by running the applications using the lrcmd.sh utility.

  1. The lrcmd.sh utility is located in /opt/IBM/WebSphere/AppServer/bin or where your local WebSphere installation path points to the bin directory.

  2. The command syntax for submitting a job using lrcmd.sh is:

    ./lrcmd.sh -cmd=submit -
    xJCL=/opt/IBM/WebSphere/AppServer/longRuning/postingSampleXJCL.xml -
    host=localhost -port=9080 -userid=yourusername -password=yourpassword
    info

    For the SimpleCIEar application, the xJCL is named SimpleCIxJCL.xml and host can be the name of any server on which WebSphere is installed.

The response to the submit command is:

3. When you have submitted the job, you can check its status by using the Job Management Console at https://yourservername:9443/jmc/console.jsp and running the status command.

The syntax for using the status command is:
./lrcmd.sh -cmd=status -jobid=PostingsSampleEar:1 -host=localhost -port=9080 -userid=yourusername -password=yourpassword

The response to the status command is shown below:

Running a Universal Command Agent for SOA Job on z/OS Connecting to XD Connector​

You now can run jobs in WebSphere XD using the Universal Command Agent for SOA: XD Connector.

The following z/OS examples reference the PostingsSampleEar application.

Step 1

Create the UMCD Manager JCL.

This provides the UCMD Manager options, references to the XD Connector options, and the xJCL payload.

It has the following format:

//UACXD1A  JOB CLASS=A,MSGCLASS=X,NOTIFY=&SYSUID
//*
//***********************************************************
//*PostingsSampleEar
//*UCMD is the proc that calls UC Manager
//*LOGON is the DD with userid and passwd (can use encrypted)
//*SCR is the script that contains the XD Connector information //* to connect to Websphere job scheduler
//*UNVIN provides the payload for the script in SCR
//***********************************************************
//*
//         JCLLIB ORDER=SBI.UNV.SUNVSAMP
//*
//UCMD     EXEC UCMDPRC
//LOGON    DD  DISP=SHR,DSN=SUPPORT.UAC.LOGON(YOURUSER)
//SCR      DD  DISP=SHR,DSN=SUPPORT.UAC.SCRIPTS(SCRXD1)
//UNVIN    DD  DISP=SHR,DSN=SUPPORT.UAC.SCRIPTS(PYLXD1)
//SYSIN    DD  *
-s scr -script_type service
-i yourserver -G yes -f logon

Step 2

Create the XD Connector Command Options Data Set Member.

This member contains the command options for the XD Connector that specify the required information to submit a job to the WebSphere XD environment.

It is referenced with the SCR ddname and has the following format:

# protocol is what protocol you are choosing(XDSOAP)
# mep is the type of message (Request)
# xdcmd is the xd command you want to perform (submit,restart)
# cmdid is a unique identifier to match to jobid(websphere jobid)
# serviceurl is the websphere url to the job scheduler
# serviceusername is the websphere user
# servicepassword is the websphere user password
# timeoutms is the timeout in milliseconds for the job
#************************************************
-protocol XDSOAP
-mep Request
-xdcmd SUBMIT
-cmdid 10010
-serviceurl http://sup\-wasxd:9080/LongRunningJobSchedulerWebSvcRouter/services/JobScheduler  
-serviceusername admin
-servicepassword admin    
-timeoutms 120000000

Step 3

Create the xJCL Payload Data Set Member.

This member contains the xJCL that WebSphere XD will use to run the job specified in the xJCL and is read via STDIN.

The xJCL length depends on the job it describes. Verify that your data set member record length can accommodate the maximum line length in your xJCL.

The xJCL is an XML document. It is referenced using the UNVIN ddname, and can be referenced in your WebSphere XD install by going to:
/opt/IBM/WebSphere/AppServer/longRunning/postingSampleXJCL.xml

(Your path may be different, depending on how you configured your WebSphere XD install.)