Command Line Client

The CmdClient utility provides a direct method for interfacing with the Scheduler through a batch file or script (including ones that originate on the mainframe). The utility enables a script to perform these types of functions:

  • Signal a user event on the scheduler
  • Trigger a process to run immediately
  • Schedule a process to run at a later time
  • Change the value of a global variable
  • Enable/disable an agent or user
  • Pause/resume an agent
  • Send commands to the Scheduler
This section illustrates use of the AEO CmdClient utility on Windows; however, the utility functions in a similar manner on UNIX.

Syntax

AEOCmdClient [server=] [port=] [cmd=] [id=] [data=] [login=]

[pwd=] [domain=]

Parameters

These are the valid parameters:

Parameter

Description

server=

Machine name of server on which the scheduler is running.

port=

Port on which the scheduler is listening.

cmd=

Requested operation. These are the valid options:

 

runprocess

Schedule a process.

 

setvariable

Set the value of a variable.

 

getvariable

Get the value of a variable.

 

getvarrpt

Get a variable report.

You can specify wildcards as selection criteria (e.g., name="abc*").
 

getoutput

Get output of a process item.

 

sendevent

Send an event.

 

insert

Insert a process into the schedule.

 

cancel

Cancel an active process or process item.

 

hold

Hold an active process or process item.

 

release

Release a held process or process item.

 

enableuser

Enable the user specified by the id value.

 

disableuser

Disable the user specified by the id value.
 

enabledef

Enable the definition (Task or Process) specified by the id value.
 

disabledef

Disable the definition (Task or Process) specified by the id value.
 

showagent

Show the configuration for the Agent specified by the id value.

 

enableagent

Enable the agent specified by the id value.

 

disableagent

Disable the agent specified by the id value.

 

pauseagent

Pause the agent specified by the id value.

 

resumeagent

Resume the agent specified by the id value.

 

setnormal

Set the status of a completed process or process item to Normal.

 

seterror

Set the status of a completed process or process item to Error.

 

setabnormal

Set the status of a completed process or process item to Abnormal.

id=

The ID of the item on which the operation is being performed.

For process items, specify processid.itemid (e.g., 1058.2 indicates process 1058, item 2).

uid=

Valid for variable operations only. The UID for the operation.

name=

Valid for variable operations only. Name of the operation.

time=

Required with cmd=insert. Date and time (in yyyy.mm.dd hh.mm format) to run the process.

data=

Optional. Data specific for the specified command.

Values=

Optional. Specify the process variables to be set when running the process.

values : Values in the form "NAME1='VALUE1',NAME2='VALUE2'"

single quotes in data: "MYSTR1='It''s easy',MYSTR2='one,two,three'"

values are useful for cmd runprocess,insert,sendevent

val_XXXX : Values specified as separate parameters where XXXX is the name

val_NAME1="VAL1" val_NAME2="VAL2" will send: NAME1='VAL1',NAME2='VAL2'

perpectual=

Optional. If this is set as YES, then that process will run perpetually in the schedule until the end of the current production day.

hold=

Optional. If this is set as YES, then the process will start on hold.

loglevel=

Optional. Specify the highest level log message that will be output. This parameter should only be used for debugging purposes. Valid values: ERROR, WARNING, INFO, DEBUG, DETAIL, INSANE. Default value: WARNING

Authentication options:

login=

Optional. Login override value.

pwd=

Optional. Password override value.

domain=

Optional. Domain override value.

 
Examples
This sample command runs the process ID 78 on the scheduler running on machine AEO1:

                    AEOCmdClient port=7910 cmd=runprocess id=78 server=AEO1
This sample runs the process and also sets process variables:

                    AEOCmdClient port=7910 cmd=runprocess id=78 values="var1='value1',var2='value2'"
This sample command inserts the process to run on Jan 1, 2016:

                    AEOCmdClient port=7910 cmd=insert id=78 server=AEO1 time="2016.01.01 12.00"
This sample command raises user event 79:

                    AEOCmdClient port=7910 cmd=sendevent id=79 server=AEO1 
This sample command sets the value of the global variable with the ID 80 to TRUE:

                    AEOCmdClient port=7910 cmd=setvariable id=80 server=AEO1 data="TRUE"
This sample command gets the variable named var:

                    AEOCmdClient server=svr.abc.com cmd=getvariable name=var
This sample command gets a variable report for variables with names beginning with s:

                    AEOCmdClient server=svr.abc.com cmd=getvarrpt name="s*"
This sample command sends an event to AEO:

                    AEOCmdClient server=svr.abc.com cmd=sendevent id=10