Running Data Mover Scripts from the Command Line

The PeopleSoft Data Mover command line program is located as follows:

  • Microsoft Windows: PS_HOME\bin\client\winx86

  • UNIX: PS_HOME/bin

At a command prompt, change to the program directory and issue the psdmtx command with the appropriate parameters.

Standard Command Line Syntax

Use the following standard syntax to run most Data Mover scripts: 

psdmtx -CT dbtype  -CD database_name 
-CO user_ID -CP user_password[-CI connect_ID -CW connect_password] 
[-I process_instance] -FP dms_filepath

The value of each parameter follows the parameter name, separated by zero or more spaces. It doesn’t need to have quotation marks around it, even if it has internal spaces — the system treats all text following the parameter name as part of the value, up to the next parameter or the end of the command line.

Note:

You must enclose a value in quotation marks only when it includes a hyphen or forward slash, or to include leading or trailing spaces. If the value itself includes a quotation mark character, precede the double quote with a backslash (\).

To display a listing of all the command-line parameters and their arguments at the command prompt, enter:

psdmtx /help

Standard Command Line Parameters

The following table lists the standard command-line parameters and arguments for running the psdmtx command:

Parameter Argument Example

–CT

Specify the database type. Valid values are DB2, DB2ODBC, MICROSFT, and ORACLE.

Note: Notice the spelling of MICROSFT. DB2ODBC is the database type for DB2 z/OS. 

-CT ORACLE

–CS

Specify the server name

 
-CS SERVER

–CD

Specify the name of the database to connect to, as you would when signing in to PeopleSoft.

 
-CD HR857DMO

–CO

Specify the PeopleSoft user ID you're using to sign in.

 
-CO JPHAM2

–CP

Specify the user password for the PeopleSoft user ID you specified.

 
-CP password

–CI

(Optional) Specify the connect ID used to connect to the database server.

Note: This parameter is required only if you're running PeopleSoft Data Mover in regular mode. 

-CI people

–CW

(Optional) Specify the password for the Connect ID you specified.

Note: This parameter is required only if you're running PeopleSoft Data Mover in regular mode. 

-CW password

–I

(Optional) Specify the Process Scheduler process instance.

Note: This parameter is required only if you're running PeopleSoft Data Mover from PeopleSoft Process Scheduler. You generally enter the predefined metastring %%INSTANCE%% in the process type definition, and PeopleSoft Process Scheduler inserts the correct value at runtime. 

-I %%INSTANCE%%

–FP

Specify the file name and path of the PeopleSoft Data Mover script to run.

 
-FP $PS_HOME/scripts/
test.dms

/help

No value required.

 
psdmtx /help

Note:

When running scripts, be sure to consider your PS_APP_HOME location if you've installed your PeopleSoft application outside of PS_HOME.

Following is an example of a standard psdmtx command line on a UNIX system: 

psdmtx -CT DB2 -CD FS845A1 -CO PSOFT -CP PSOFT
 -CI people -CW peop1e -FP fs845a1dbo.dms

Using a Parameter File

Rather than submitting parameters manually on the command line, you can have PeopleSoft Data Mover read a file that contains appropriate parameters. Create a text file that contains a complete set of parameters as you would enter them on the command line.

If you submit a parameter file name and path to PeopleSoft Data Mover as the first parameter in the command line, PeopleSoft Data Mover reads the contents of the file and interprets them as parameters entered on the command line. For example:

psdmtx c:\dms\myparmfile.txt

Note:

You must enter the full path to the parameter file.

WARNING:

For security reasons, after PeopleSoft Data Mover interprets the contents, it immediately deletes the parameter file.