Run Jobs with the dmpexec Command :: DataFlux(R) Data Management Server 2.6: Administrator's Guide

Overview

You can run execute jobs on the DataFlux Data Management Server with the command install-path/bin/dmpexec.

dmpexec Options

The dmpexec command accepts the following options:

Option	Purpose
-c filename	Reads a configuration file to set option values that are specific to the job or command, including the authentication option. (See the -a option.)
-j file	Executes the job in the specified file.
-l path-filename	Writes job run log messages to a file. Specify different log files for each job run, The path value is absolute. It is not affected by the values of any configuration option.
-i key=value	Sets the input variable key to a value before running the job.
-o key=value	Sets a server option to a value.
-b key=value	Sets a job option to a value.
-a	Authenticates the user who is executing dmpexec using a Metadata Server or Authentication Server. This option is required for domain-enabled connections. To successfully authenticate, you need to specify options that specify the authenticating server, user name, and password.

Note: You can use the -i, -b, and -o options multiple times to set multiple values.

Configure Authentication for dmpexec

When you specify the -a option in the dmpexec command, the DataFlux Data Management Server requires three server configuration options. The following configuration options specify the location of the authenticating server, a user name that is registered on the authenticating server, and the password that validates the user name:

BASE/AUTH_SERVER_LOC=network-path:port defines how to connect to the authenticating server.

BASE/AUTH_SERVER_USER=user-name specifies the user name that will be authenticated by the specified server.

BASE/AUTH_SERVER_PASS=password specifies the password that is associated with the user name.

The authenticating server can be a Metadata Server or an Authentication Server.

You can set default values for these options in the configuration file dmserver.cfg. You can also specify these options in a configuration file that you create specifically for a given job or command, using the -c option.

Return Codes for the dmpexec Command

The dmpexec command returns the following status codes:

Return Code	Reason
0	Job is still running
1	Job has finished successfully
2	Job has finished with errors: general error (see job log file)
3	Job has finished with errors: process terminated
4	Job has finished with errors: job was canceled

Configure a Log File for dmpexec

Follow these steps to generate a log file that applies specifically to your use of dmpexec:

In the directory install-path/etc, copy the file batch.cfg to create the new file dfwfproc.cfg.
In the same directory, copy the file batch.log.xml to create the new file dfwfproc.log.xml.
Edit dfwfproc.cfg to specify the location of dfwfproc.log.xml.
Open the new file dfwfproc.log.xml. In the file, replace this text:
```
{OSENV.DIS_LOG_DIR}/batch
```
With this text:
```
{OSENV.DFEXEC_HOME}/var/server_logs/dfwfproc
```
Save and close the new files.