Command Line Parameters

From File

To File

Database to Database

From File

Database to Database

Project

-PJFF

R

-PJTF

R

-PJC

R

-PJFC

R

-PJM

R

-CT

R

R

R

R

R

-CS

R

R

R

R

R

-CD

R

R

R

R

R

-CO

R

R

R

R

R

-CP

R

R

R

R

R

-CI

O

O

O

O

O

-CW

O

O

O

O

O

-TS

R

R

-TD

R

R

-TO

R

R

-TP

R

R

-TI

O

O

-TW

O

O

Log File

-LF

O

O

O

O

O

-FP

R

R

R

-OVD

O

O

O

-EXP

O

-RST

O

O

O

-OVW

O

O

Object

-OBJ

O

O

O

O

O

-CL

O

O

O

O

O

-AF

O

O

O

O

O

-PPL

O

O

O

O

O

-DDL

O

O

O

O

O

-CFD

O

O

O

O

O

-CFF

O

O

O

O

O

-LNG

O

O

O

O

O

-FLTR

O

O

-CMT

O

O

-TGT

O

O

-CBY

O

O

-ROD

O

O

-CMTABLE

O

O

-CMXML

O

O

-CMR

O

-CROD

O

-CRDB

O

-NOTKACT

O

-CUSTPRJ

O

-HIDE

R

R

R

R

R

-QUIET

O

O

O

O

O

-SS

O

O

O

O

O

-SN

O

O

O

O

O

-AF

Audit flags on records (0 or 1).

Enter 1 to keep the target audit flags as is. Enter 0 to take them from the source database. Example: -AF 0

Optional. The default is 1.

-CBY

Comparison By:

To compare by release, enter REL, followed by the release number. To compare by date, enter DAT, followed by a date in the following format: YYYY-MM-DD-HH.MM.SS.sss. Release numbers are included in the Available Release Numbers list. Example: 2002-02-01-12.00.00.000

Optional. The default is REL.

-CD

Database name.

Enter the name of the database to which you are connecting, as you would enter it into the PeopleSoft Signon dialog box.

Required. If you omit this parameter, the process stops and error messages are written to the log file.

-CFD

Keep Target ChartField PageField Display Size.

(Number 1 or 0). This parameter indicates whether or not the target ChartField page field display size attributes are to be kept, or whether they should be set from the source. See Upgrade options for more information.

Enter 1 to keep the target ChartField page field display size attributes.

Enter 0 to set these attributes from the source values.

Example, -CFD 0

Optional. Default is 1

-CFF

Keep Target ChartField Field Format.

(Number 1 or 0) This parameter indicates whether or not the target ChartField field format attributes are to be kept, or whether they should be set from the source. See Upgrade options for more information.

Enter 1 to keep the target ChartField field format attributes.

Enter 0 to set these attributes from the source values.

Example, -CFF 0

Optional. Default is 1

-CI

Connect ID

Enter the ID that is used to connect to the database server.

Optional.

If the connect ID is not specified, the value from the registry (psfg) is used.

-CL

Commit limit.

Enter the Commit limit (a number greater than 0) for the number of objects to be copied or compared before a commit is issued. Example: -CL 150

Optional. The default is 50 if the user does not set this parameter.

-CMPDIRPC

Compile and save all the directive PeopleCode.

Supply the -CMPDIRPC parameter in the command line and there is no need to pass any additional value. This will compile and save all the directive people.

Required. This is the parameter to compile and save the all directive PeopleCode programs in the database.

If you do not supply this parameter then directive PeopleCode programs in the database will not be compiled and saved.

-CMPPRJDIR

Compile and Save the PeopleCode for the project specified.

Enter the project name. Example: -CMPPRJDIR PROJECT1.

Required. This is the parameter to compile and save the directive PeopleCode programs in a project. If you do not supply this parameter then the directive PeopleCode programs in the project will not be compiled and saved.

-CMPRTPRJ

Enable generation of PrintProject report during compare.

Enter 1 to enable this option, and enter 0 to disable this option.

Optional. The default value is 0.

This is equivalent to setting the Generate PrintProject Reports options on the Report Options tab on the Upgrade Options dialog box.

-CMR [0 | 1]

Use 0 to disable, 1 to enable, the generation of the Composite Compare Reports. Parameter is only valid when used in conjunction with the -PJM option. Ignored otherwise.

Optional. If not used, then composite report disabled. Must also use –CROD and -CRDB options when using -CMR.

-CMT

Compare type: project (1) or database (0). Example: -CMT 0

Optional. The default is 1.

- CMTRAD

Enable generation of traditional compare reports during compare.

Enter 1 to enable this option, and enter 0 to disable this option.

Optional. The default value is 1.

This is equivalent to setting the Generate Traditional Reports options on the Report Options tab on the Upgrade Options dialog box.

-CMTABLE [0|1]

Select this option to write the compare output to database tables. This enables you to keep a historical record of your compares in your database, and it also provides you the flexibility of being able to design custom queries for analyzing specific definitions, attributes, and so on. Enter 1 to enable this option, and enter 0 to disable this option.

SeeUsing the Upgrade Workspace

Optional. The default is 1.

-CMXML

Generate browser reports (0 or 1).

This command enables you to enable the option of generating browser reports written to your report output directory. This is equivalent to setting the Generate Browser Reports options on the Report Options tab on the Upgrade Options dialog box.

Enter 1 to enable this option, and enter 0 to disable this option.

Example: -CMXML 1

See Working with Browser Reports

Optional. The default is 0.

-CO

User ID.

Enter the PeopleSoft user ID that is needed to sign in to the connect database.

Required. If you omit this parameter, the last database type is taken from the registry. If it fails, the process stops and error messages are written to the log file.

-CP

User password.

Enter the password for the specified user ID for the connect database.

Required. If you omit this parameter, the PeopleSoft Signon dialog box appears and prompts the user for the password. If the password fails, the process stops and error messages are written to the log file if the log file name parameter is specified.

-CRDB [database name]

Pass the value of the Old Release Source Database name when generating Composite Reports. This value must match the Source Database name value from the Old Release Report for each definition type. This is to ensure the original old release report is valid and contains the expected data. If the old release report source database name for the current definition type does not match the passed value, then an error message is generated to the log file, but process continues for other definition types.

Optional.

-CROD [directory path]

Set path for the Old Release Compare reports when generating Composite Reports (-CMR 1). Only valid when used in conjunction with the -PJM and -CMR 1 options, ignored otherwise.

If not set when generating composite reports (-CMR 1) then its an error condition, and processing should stop, and an error generated to the log file. Directory path can be a local directory, a mapped network directory, or a UNC path specification.

-CS

Server name.

Enter the name of the database server for the database to which you are connecting.

Required for some database types. If you omit this parameter, the process stops and error messages are written to the log file.

-CT

Database type.

Enter the type of the database to which you are connecting (ORACLE, DB2, and so on).

Required. If you omit this parameter, the last database type is taken from the registry. If it fails, the process stops and error messages are written to the log file.

-CW

Connect ID password.

Enter the password for the specified connect ID.

Optional.

If the connect ID password is not specified, the value from the registry (psfg) is used.

-DDL

Data definition language (DDL) on records and indexes (0 or 1).

Enter 1 to keep the target database DDL flags as is. Enter 0 to take them from the source database. Example: -DDL 0

Optional. The default is 1.

-EXOBJ

Exclude object from copy.

Object types to exclude from copy: List the object types as numbers with commas as delimiters. For example, if you choose to exclude file references and file type codes for copying, use the appropriate numbers for file references and file type codes from the Definition Type Selection table (PTOBJECTTYPES). For file references, the number is 68, and for the file type codes, the number is 69. Example: -EXOBJ 68,69

Optional.

-EXP

Export project definition (0 or 1).

Enter 1 to export the project definition to the target database when using the Database Copy process. Not applicable for Copy Project to File process.

Optional. The default is 1. Any project with the same name is overwritten with the new project definition.

-FLTR

Report filter.

The command line report filter options are equivalent to those displayed on the Report Filter tab on the Upgrade Options dialog box.

The syntax is:

-FLTR XXXXX XXXXX XXXXX
 XXXXX XXXXX

Where each X corresponds to a specific check box on the Report Filter tab, and each set of X's corresponds to a row in the matrix on the Report Filter tab, moving left-to-right, top-to-bottom, beginning with the top, left-hand corner (Source, Absent/Target, Absent).

The value of X can be either a 0 (not selected) or 1 (selected).

For example:

-FLTR 00000 00011 00011
 01111 01111

Using this example, and comparing this to the GUI on the Report Filter tab, none of the check boxes would be selected in the first row, only the check boxes in the Custom Changed and Custom Unchanged columns would be selected, and so on.

Optional. If report filter options are not submitted on the command line, the system uses the current settings on the Report Filter tab on the Upgrade Options dialog box.

-FP

Project file path.

Enter the project file path.

Required for a Copy To File or Copy From File process (but not for a Database Copy process). For the Copy From File process, the directory must exist. For the Copy To File process, any project with the same name is overwritten unless you use the -OVW parameter. A directory specification is created if it does not exist. Do not include the name of the project in the file path. Use -PJTF or -PJFF to specify the project name.

Required for Compare from file.

-HIDE

Use to hide the PeopleSoft Application Designer interface. Always use this parameter when performing a command line Copy process.

Required for all project command line processes.

-LF

Log file name.

Enter the name of the file in which error messages are logged.

Optional. If you omit this parameter, a file is created with the specified path and name, and all of the processing and error messages are written to that file.

-LNG

List the language codes with commas as delimiters or enter ALL to select all available languages. For new languages that are not listed in the Language Selection table, use the xlat short name from the LANGUAGE_CD field in the translate table. For example, if you choose English and Spanish for copying or comparing, enter the appropriate codes for English and Spanish from the Language Selection table. For English, the code is ENG, and for Spanish, the code is ESP. Example: -LNG ENG,ESP

See Language Selections.

Optional. If you omit this parameter, then the languages that are already set in the project are used as the default. The COMMON language code refers to nonlanguage attributes that are not translated. Translated attributes can be copied or compared separately from nontranslated attributes. If you do not specify the COMMON code when using -LNG, you copy or compare only the translated language attributes.

Changing languages on the command line changes the values that are stored with the project definition. Subsequent Copy and Compare processes on the modified project use the new values unless they are explicitly changed again in the upgrade options.

-OBJ

Object types to copy: List the object types as numbers with commas as delimiters. For example, if you choose records and indexes alone for copying, use the appropriate numbers for records and indexes from the Definition Type Selection table. For records, the number is 0, and for the indexes, the number is 1. Example: -OBJ 0,1

Definition type to compare: List the definition types to compare as numbers with commas as delimiters, or enter All. Example: -OBJ 0,1

Optional. If you omit this parameter, then all of the objects or definitions are copied or compared by default.

For a project comparison, this refers to all definitions in the project. For a database comparison, this includes all definitions in the database.

-OVD

Override dependencies (0 or 1).

Enter 1 to override the checks for unapplied dependency incidents and to perform the copy even if dependency incidents for the project have not been applied to the source database.

Optional. The default is 0. When you enter the default and if the project's dependency incidents have not been applied to the source database, an error message is written to the log file listing which incidents need to be applied. The copy process also stops. When you enter 1, a warning message is written to the log for unapplied incidents and processing continues.

-OVW

Overwrite existing project (0 or 1). Enter 1 to overwrite any existing projects with the same name in the specified path during the Copy Project To File process, or in the database in the Copy Project From File process. Enter 0 to not overwrite existing projects. This parameter applies to the Copy Project To and From File processes only.

Optional. The default is 1.

-PJB

Project name.

Enter the name of the project to be built. This project should be available in the database before starting the command line project build.

Required. This is the main parameter and is used internally to decide whether the user can build a project. If you omit this parameter and if you supply all of the source database login parameters, the program only starts the application.

-CFG

RDM build setting configuration file.

Required. This parameter is used with -PJB to set the build settings.

Sample file is available at <PS_HOME>\setup\ptbld.cfg.

-PJC

Source project name.

Enter the name of the project that is to be copied from the source database to the target database. This project should be available in the source database before starting the command line Upgrade Copy process to target database.

Required for a Database Copy process. This is the main parameter that is used internally by the executable file to identify an Upgrade Copy process. If you omit this parameter and if you supply all of the source database login parameters, the executable file starts the application.

-PJFF

Copy Project From File project name.

Enter the name of the project to be copied from the file into the source database.

Required for a Copy From File process. Do not include the file path to the project with this parameter. Use -FP to specify the file path.

-PJFC

Compare from file.

Required for Compare from file.

-PJM

Source project name.

Enter the name of the project that is to be compared from the source database to the target database. This project should be available in the source database before starting the command line Upgrade Compare process to the target database.

Required. This is the main parameter that is used internally by the executable file to identify an upgrade compare. If you do not supply this parameter and if you supply all of the source database login parameters, this executable file starts the application.

-PJTF

Copy Project To File project name.

Enter the name of the project to be copied from the source database to the file.

Required for a Copy To File process. Do not include the file path to the project with this parameter. Use -FP to specify the file path.

-PJV

Validate Project

Required for Validate Project.

-PLRM

Permission List, Role, Menu (0 OR 1).

Enter 1 to keep the target database tracking data for permissions lists, roles and menus. Enter 0 to take the tracking data from the source database.

Example: -PLRM 0

Optional. The default is 0.

-PPL

Portal registry structures permission list references.

Enter 1 to keep the target portal registry permission list references as is. Enter 0 to take them from the source database.

Optional. The default is 1.

-QUIET

Use to run in quiet mode so that no message boxes appear. The system writes messages to the log file or trace file, depending on whether you also use the -LF parameter. Quiet mode is recommended for use with processes that require no human interaction.

-ROD

Report Output Directory.

Enter the report output directory location. Example-ROD c:\temp\upgreports

Optional. If you do not supply this parameter, the system uses the Report Output Directory value from the Tools > Options General tab.

-RST

Reset done flags (0 or 1).

Enter 1 to reset the done flags before initiating the Copy process. Enter 0 to not reset them. Example: -RST 0

Optional. The default is 1.

-SN

Use to suppress the sound that plays when you sign in to the PeopleSoft system. Any other value causes the sound to play.

Optional

-SS

Use to suppress the display of the PeopleSoft splash screen. Any other value causes the splash screen to appear.

Optional

-TD

Target database name.

Enter the name of the target database to which you are connecting as you would enter it into the PeopleSoft Signon dialog box.

Required for Compare (Database to Database).

Required for a database Copy process (but not used for a Copy To File or Copy From File process).

If you omit this parameter, the process stops and error messages are written to the log file if the log file name parameter is specified.

-TGT

Target Orientation: PeopleSoft vanilla (0) or keep personalization (1).

Optional. The default is 0.

-TI

Target connect ID.

Enter the ID that is used to connect to the target database server. If the connect ID for the target database is the same as the connect ID for the connect database, this parameter is not necessary.

Optional. If no value is specified, CA determines the value in this order:

1. Uses the -CI value (Connect ID.)

2. Reads the value from the registry. This value is populated by pscfg.

-TO

Target user ID.

Enter the PeopleSoft user ID to use to sign in to the target database.

Required for Compare (Database to Database).

Required for a Database Copy process (but not used for a Copy To File or Copy From File process).

If you omit this parameter, the process stops and error messages are written to the log file if the log file name parameter is specified.

-TP

Target user password.

Enter the password for the specified user ID for the target database.

Required for Compare (Database to Database).

Required for a Database Copy process (but not used for a Copy To File or Copy From File process).

If you omit this parameter, the process stops and error messages are written to the log file if the log file name parameter is specified.

-TS

Target server name.

Enter the name of the target database server for the database to which you are connecting.

Required for Compare (Database to Database).

Required for some database types and for a Database Copy process (but not used for a Copy To File or Copy From File process). If you omit this parameter, the process stops and error messages are written to the log file if the log file name parameter is specified.

-TW

Target connect ID password.

Enter the connect ID password for the target database. If the connect ID password for the target database is the same as the connect database, this parameter is not necessary.

Optional. If no value is specified, CA determines the value in this order:

1. Uses the -CW value (Connect ID.)

2. Reads the value from the registry. This value is populated by pscfg.