DMSRVBATCHJOB Function

Runs a DataFlux data or process job on a DataFlux Data Management Server and returns a job identifier.

Valid in: DATA step, PROC SQL, and SCL
Requirements: If specified, the locale must be loaded into memory as part of the locale list.
The character variable that receives the return value must have a minimum length of 52.

Syntax

DMSRVBATCHJOB(job-name, host, port <,parameter-list>)

Required Arguments

job-name

the DataFlux Data Management Studio job or process as it exists on the specified DataFlux Data Management Studio Server.

host

identifies the host of the DataFlux Data Management Server. The host name can be a variable or a literal string. The literal string or the value of the variable is the URL of the server in single quotation marks.

When DataFlux Data Management Server is secured with SSL, the URL must use https instead of http (for example, https://myhost.unx.com).
Interaction If a zero-length string is entered for the host argument, then the value localhost is used.
Example
        /* Incorrect use of function arguments */
           dmsrvBatchJob('jobname');   
        /* Localhost is used for the host */
           dmsrvBatchJob(jobname, '', 21036); 

        /* Correct */
           dmsrvBatchJob(jobname, 'http://myhost.unx.com', 21036);   

port

identifies the port through which the host communicates with the DataFlux Data Management Server.

Interaction If the value specified is less than or equal to 0, then port number 21036 is used with SOAP, or port number 21037 is used when using Wireline.
Example
        /* Incorrect use of function arguments */
           dmsrvBatchJob('jobname'); 

        /* Port 21036 or 21037 is used */
           dmsrvBatchJob('jobname', 'http://myhost.unx.com', 0); 

        /* Correct */
           dmsrvBatchJob('jobname', 'http://myhost.unx.com', 21036);   

Optional Argument

parameter-list

the variable list of name and value pairs, where each name and value pair in the list must be defined as an input to the job.

Details

The DMSRVBATCHJOB function returns a job-identifier. The return value is either a job identifier of up to 52 characters or the value MISSING. Use the job identifier in subsequent function calls to manage the job, using DMSRVJOBSTATUS, DMSRVCOPYLOG, DMSRVDELETELOG, and DMSRVKILLJOB.
  • You can specify any number of macro value pairs.

Example: DMSRVBATCHJOB Function

The following example runs a job on a DataFlux Data Management Server.
data _null_;
     jobid = dmsrvBatchJob  ('myjob.djf', 'http://myhost.unx.com', 21036);
run;