-d <Database>/<Passwd>

Mandatory: Database user (Oracle) or Database name (SQL Server)/password

-p <Port Number>

Mandatory: The port number of the API Agent's API port

-u <URL>

Mandatory: The URL of the SOAP service to receive the job dispatch information.

-H <Host Machine>

Mandatory: The name or IP address of the SP Server.

-n <Service User>

If present indicates the username for authentication by the user's dispatch service. If this parameter is supplied but either the w or i parameters are not, the values of the missing ones of these latter parameters are set to a zero length string.

-w <Service Password>

If present indicates the user password for authentication by the user's dispatch service. If this parameter is supplied, the n parameter must also be supplied.

-i <Service Instance>

If present indicates the instance identifier for authentication by the user's dispatch service. If this parameter is supplied, the n parameter must also be supplied.

-U <HTTP User>

If present, indicates the User for HTTP authentication of the SOAP Service. If not supplied, it is assumed that no authentication is required and no user ID is sent.

-W <HTTP Password>

If present, indicates the Password for HTTP authentication of the SOAP Service. If not supplied, it is assumed that no password authentication is required and no password is sent.

If present indicates the location of the HTTPS certificate. It assumes that the URL will be HTTPS. 

-o <Timeout (secs)>

If present, indicates the timeout in seconds for which we will wait for a response from the SOAP service.
Default: 30 secs.

-r <FRU Names>

If present the dispatch is to run for just the named FRUs. If not present, the dispatch client runs system wide. If one FRU is required, just its ID is given; where more than one FRU is to be specified, the IDs must be separated by semi-colon (";") delimiters. There should be no leading or trailing delimiters.

-t <Team Names>

Applies to batch dispatch only.
If present the batch dispatch is to run for just the named Teams. If not present, the dispatch client runs system wide. If one Team is required, just its name is given; where more than one Team is to be specified, the names must be separated by semi-colon (";") delimiters. There should be no leading or trailing delimiters.

-P <Engineer ID>

Applies to batch dispatch only.
If present the batch dispatch is to run for just the named Engineer. If not present, the dispatch client runs system wide. If specified, this should contain the identifier of one engineer.

-b <Run Date(s)>

If present specifies the start and end dates for a batch run. If a single date, the same date is used for the start and end of a run. If two dates are , they must be separated by semi-colon (";") delimiters. There should be no leading or trailing delimiters.
If not present, this is real time dispatch.

-c <Range Start>

If present, -b must also be specified.
Specifies the start of the time range for a batch run – i.e. the time from which jobs will be dispatched.
If not present and the -b parameter is specified, the default of 00:00 (0000) is used.

-e <Range End>

Specifies the end of the time range for a batch run – i.e. the time up to which jobs will be dispatched.
If not present and the -b parameter is specified, the default of 23:59 (2359) is used.

-y <Range Type>

If present, -b must also be specified.
Specifies the type of time range for a batch run.
If the value is 0, job start times will be compared to the range defined by -c and -e; if the value is 1, shift start times will be compared to the range.
If not present the default value of 0 is used.

-m <Jobs Max>

If present, -b must also be specified.
Specifies the maximum number of jobs to be dispatch per engineer, within the time range for a batch dispatch run.
If not present, the default is for there to be no formal limit to the number of jobs dispatched per engineer.

-z <Time Zone>

If present must contain a POSIX timezone specification.
This specifies the timezone of times returned in the dispatch messages.
If not present and value of the ServicePower system parameter, tz_disp_api, is used. This is the recommended mode of working for most cases.

-S <SP Service User>

If present gives the name of the user under which the Service for the ServicePower instance to which we are connecting is running. This is needed to determine the location of the log directory into which a log file will be written.
NOTE that if this parameter is specified, the case of the value for this parameter and for the -H parameter must match the case used by the ServicePower server software at the start of the log file names (in the '<User Account>.<Machine>' part). See Log Files within the next section.
There is no default, if the parameter is absent, no log file is produced.

-T

If present, indicates that the dispatch client should terminate if a timeout (return code SP_OK_DISPATCH_REQUEST_TIMEOUT) is received from an SP_DispatchRequest call.
If not present, the dispatch client calls SP_DispatchRequest again.