Constructing Command Lines to Create and Apply Change Packages

Apply commands include:

  • CPAPPLY = Apply Previously Created (non-PRP) Change Package

  • PRPAPPLY = Apply PRP

  • PTPAPPLY = Apply a patch to your Current PeopleTools Release

  • PTUAPPLY = Upgrade to a New Release of PeopleTools

  • UPGAPPLY = Application Upgrade

  • DLTAPPLY = Apply Tools Delta Package

  • TDPAPPLY = Apply Translation Delta Package

  • RFUAPPLY = Apply Required for Upgrade Package

When you run the command line, the error codes are as follows:

  • 0 = Success

  • 1 = Failure

  • 2 = Manual Stop encountered

  • 3 = Failed to get lock

The RESUMEJOB parameter has the following limitations:

  • COMPLETECONTINUE cannot be used for a failed Filter Query step

    If the pending job is stopped by a failed Filter Query step, -RESUMEJOB can only have the value of RESTARTCONTINUE or READYTORUNCONTINUE. If the value is COMPLETECONTINUE , an error message is reported.

  • RESTARTCONTINUE| READYTORUNCONTINUE cannot be used for a manual stop step.

    If the pending job is stopped by a manual stop step, -RESUMEJOB can only have the value of COMPLETECONTINUE. If the value is RESTARTCONTINUE or READYTORUNCONTINUE, an error message is reported.

  • The job must exist in Change Assistant Database in order to use RESUMEJOB.

    If there is no job set in progress when the CA apply command line is run with the parameter - RESUMEJOB, a warning message is reported.

  • RESUMEJOB cannot be used when the parameter RESETJOB is Y.

    If there is a job in progress and the -RESETJOB parameters is set as Y or not set (the default value is Y) a warning message is reported as The resuming job can’t be reset.

  • All other parameters need to be consist with the parameters of existing job

    If there is a job in progress but the job parameters are not consistent with the ones in CA apply command line; a warning message is reported as The pending job can’t be resumed by the inconsistent parameter values.

The action CPCREATE is used to upgrade to a new PeopleTools release using the command line.

Command line format:

changeassistant.bat -MODE UM -ACTION CPCREATE  -UPD <change package> -OUT <path to log file>  -EXONERR <Y or N>

The parameters for CPCREATE action are:

Parameter

Description

-MODE

Change Assistant Action (Required)

UM = Update Manager

-ACTION

Action name (Required)

CPCREATE =Create Change Package

-UPD

Update ID of change package. (Required)]

Example: -UPD PTU854

-OUT

Path to log file. (Optional)

-EXONERR

Specify whether or not to launch GUI if an error or manual stop is encountered. (Optional)

  • Y = Do not Launch

  • N= Launch (default)

The action CPAPPLY is used to apply a change package that was created using PUM.

Command line format:

Changeassistant.bat -MODE UM -ACTION CPAPPLY -TGTENV <target database> -UPD <change package> -TYPE <initial pass or move to production> -SYNCTYPE <y OR n> -OUT <log file directory> -WARNINGSOK <Yor N> -RESETJOB <Y or N> -EXONERR <launch GUI Y or N> -RESUMEJOB [COMPLETECONTINUE|RESTARTCONTINUE| READYTORUNCONTINUE]

Example command line:

Changeassistant.bat -MODE UM -ACTION CPAPPLY  -TGTENV HC920001 – UPD PKG1

In this example the target database is named HC920001and the change package to apply is PKG1. All of the other parameters will use the default.

Parameter

Description

-MODE

Change Assistant mode (Required)

UM

-ACTION

Change Assistant action (Required)

CPAPPLY = Apply Previously Created (non-PRP) Change Package

-TGTENV

Target database

-UPD

The Change Package to apply. (Required)

Specify either all , a single or multiple Change Packages to apply to the specified environment.

For example:

  • -UPD all

  • -UPD PKG1

  • -UPD PKG1,PKG2

-TYPE

Apply Type. (Optional)

  • IP = Initial Pass (All steps) (default)

  • MTP = Move to production

  • IPSRC = Source only initial pass

  • IPTGT = Target only initial pass

-SYNCTYPE

Synchronize target metadata. (Optional)

  • Y = Yes (default if type is IP)

  • N = No (default if type is not IP)

-OUT

Path of log file (Optional)

If the log directory is not specified it uses the default defined under General Options.

-WARNINGSOK

Proceed with apply even if warnings are found. (Optional)

  • Y = Proceed with apply even if warnings are found. (default)

  • N = Stop apply when warnings are encountered.

-EXONERR

Specify whether or not to launch GUI if an error or manual stop is encountered. (Optional)

  • Y = Do not Launch

  • N= Launch (default)

-RESETJOB

Specify whether or not to reset the job if the job fails the first time it is run.

  • Y = Delete existing job and create a new job

  • N = Do NOT delete existing job and continue running the existing job. (default)

-RESUMEJOB

Specify the parameter value:

  • COMPLETECONTINUE

    To mark the first failed step or manual stop step to status COMPLETE and continue the job.

  • RESTARTCONTINUE

    To mark the first failed step or manual stop step to status RE-START and continue the job

  • READYTORUNCONTINUE

    To mark the first failed step or manual stop step to status READYTORUN and continue the job

The action PRPAPPLY is used to apply a previously downloaded PRP to the PeopleSoft Update Image.

In order to apply a PRP from the command line, you must run 2 commands, first identify the PUM source using the Options action and then apply the PRP.

  1. This is an example of the command line to set the PUM environment.

    Changeassistant.bat -MODE UM -ACTION OPTIONS -SRCYN Y -SRCENV HR92U016 -PUH D:\psft\pt\pi_home\ -PIA http://edddr32p1.us.oracle.com:8000/ps/signon.html -OUT d:\temp\PRP.LOG -EXONERR Y

    In this example, Configure PUM Source (SRCYN) is set to Y, the PUM Source database (-SRCENV) is HR92U016 , the PI home directory (-PUH) is set to D:\psft\pt\pi_home\, the PIA URL (-PIA) is set to http://edddr32p1.us.oracle.com:8000/ps/signon.html.

    See the section on Command Line for Setting Options for additional details on setting General Options.

  2. This is an example for applying the PRP.

    changeassistant.bat  -MODE UM -ACTION PRPAPPLY -UPD PRJ22534037

    In this example the change package to apply isPRJ22534037 (name of the downloaded PRP change package). All of the other parameters will use the default.

Command line format:

Changeassistant.bat -MODE UM -ACTION PRPAPPLY  –UPD <change package> -OUT <log file directory> -WARNINGSOK <Y or N> -REPLACE <Y or N> -EXONERR <launch GUI Y or N> -RESETJOB <Y or N>

Parameter

Description

-MODE

Change Assistant mode (Required)

UM = Update Manager

-ACTION

Action name (Required)

PRPAPPLY = Apply PRP

-UPD

Update ID of Change Package to apply. (Required)

-OUT

Path of log file (Optional)

If the log directory is not specified it uses the default defined under General Options.

-WARNINGSOK

Proceed with apply even if warnings are found. (Optional)

  • Y = Proceed with apply even if warnings are found. (default)

  • N = Stop apply when warnings are encountered.

-REPLACE

Replace existing data if it exists (Optional)

  • Y = Replace existing values if they exist. (default)

  • N = Do not replace values if they exist

-EXONERR

Specify whether or not to launch GUI if an error or manual stop is encountered. (Optional)

  • Y = Do not Launch

  • N= Launch (default)

-RESETJOB

Specify whether or not to reset the job if the job fails the first time it is run.

  • Y = Delete existing job and create a new job

  • N = Do NOT delete existing job and continue running the existing job. (default)

-RESUMEJOB

Specify the parameter value:

  • COMPLETECONTINUE

    To mark the first failed step or manual stop step to status COMPLETE and continue the job.

  • RESTARTCONTINUE

    To mark the first failed step or manual stop step to status RE-START and continue the job

  • READYTORUNCONTINUE

    To mark the first failed step or manual stop step to status READYTORUN and continue the job

The action PTPAPPLY is used to apply a PeopleTools Patch using the command line.

Command line format:

Changeassistant.bat -MODE UM -ACTION PTPAPPLY -TGTENV <target database> -UPD <change package>

The parameters for applying a PeopleTools patch are:

Parameter

Description

-MODE

Change Assistant Action (Required)

UM = Update Manager

-ACTION

Action name (Required)

PTPAPPLY =Apply PTP

-TGTENV

Target environment (Required)

-UPD

Update ID of change package. (Required)]

Example: -UPD PTP85401

-OUT

Path to log file. (Optional)

-WARNINGSOK

Proceed with apply even if warnings are found. (Optional)

  • Y = Proceed with apply even if warnings are found. (default)

  • N = Stop apply when warnings are encountered.

-EXONERR

Specify whether or not to launch GUI if an error or manual stop is encountered. (Optional)

  • Y = Do not Launch

  • N= Launch (default)

-RESUMEJOB

Specify the parameter value:

  • COMPLETECONTINUE

    To mark the first failed step or manual stop step to status COMPLETE and continue the job.

  • RESTARTCONTINUE

    To mark the first failed step or manual stop step to status RE-START and continue the job

  • READYTORUNCONTINUE

    To mark the first failed step or manual stop step to status READYTORUN and continue the job

The action PTUAPPLY is used to upgrade to a new PeopleTools release using the command line.

Command line format:

changeassistant.bat -MODE UM -ACTION PTUAPPLY -TGTENV <target database> -UPD <change package> -OUT <path to log file> -WARNINGOK <Y or N> -EXONERR <Y or N>

The parameters for PTUAPPLY action are:

Parameter

Description

-MODE

Change Assistant Action (Required)

UM = Update Manager

-ACTION

Action name (Required)

PTUAPPLY=Apply PTU

-TGTENV

Target environment (Required)

-UPD

Update ID of change package. (Required)]

Example: -UPD PTU854

-OUT

Path to log file. (Optional)

-WARNINGSOK

Proceed with apply even if warnings are found. (Optional)

  • Y = Proceed with apply even if warnings are found. (default)

  • N = Stop apply when warnings are encountered.

-EXONERR

Specify whether or not to launch GUI if an error or manual stop is encountered. (Optional)

  • Y = Do not Launch

  • N= Launch (default)

-RESUMEJOB

Specify the parameter value:

  • COMPLETECONTINUE

    To mark the first failed step or manual stop step to status COMPLETE and continue the job.

  • RESTARTCONTINUE

    To mark the first failed step or manual stop step to status RE-START and continue the job

  • READYTORUNCONTINUE

    To mark the first failed step or manual stop step to status READYTORUN and continue the job

The action UPGAPPLY is used to upgrade to 9.2 application release using the command line.

Command line format:

changeassistant.bat -MODE UM -ACTION UPGAPPLY -TGTENV <target database> -UPD <change package> -OUT <path to log file> -WARNINGOK <Y or N> -EXONERR <Y or N>

The parameters for PTUAPPLY action are:

Parameter

Description

-MODE

Change Assistant Action (Required)

UM = Update Manager

-ACTION

Action name (Required)

UPGAPPLY=Apply PTU

-TGTENV

Target environment (Required)

-UPGSRC

Upgrade source environment (Required)

-UPD

Update ID of change package. (Required)]

Example: -UPD HCM91TO92UPG

-RFU

Required for upgrade change package (Optional)

  • Y Yes (apply)

  • N No(not apply)

-PTU

Peopletools upgrade change package (Optional)

Example: -PTU PTU856

-TYPE

Apply Type. (Optional)

  • IP = Initial Pass (All steps) (default)

  • MTP = Move to production

  • SP= Subsequent Pass

-SYNCTYPE

Synchronize Target Metadata (Optional)

  • Y Yes (default if type is IP)

  • N No(default if type is not IP)

-OUT

Path to log file. (Optional)

-WARNINGSOK

Proceed with apply even if warnings are found. (Optional)

  • Y = Proceed with apply even if warnings are found. (default)

  • N = Stop apply when warnings are encountered.

-RESETJOB

Reset Job Set before applying (Optional)

  • RESETJOB Y = Reset Job Set before applying (default)

  • RESETJOB N = Do Not Reset Job Set before applying

-EXONERR

Specify whether or not to launch GUI if an error or manual stop is encountered. (Optional)

  • Y = Do not Launch

  • N= Launch (default)

-RESUMEJOB

Specify the parameter value:

  • COMPLETECONTINUE

    To mark the first failed step or manual stop step to status COMPLETE and continue the job.

  • RESTARTCONTINUE

    To mark the first failed step or manual stop step to status RE-START and continue the job

  • READYTORUNCONTINUE

    To mark the first failed step or manual stop step to status READYTORUN and continue the job

-FS

Specify either the file servers or ini path.

File servers hostname#configPath (Optional)

  • -FS all (default)

  • -FS slc06ejv#c:\pt8.53-102-r1

  • -FS slc06ejv#c:\pt8.53-102-r1;slc08eyu#c:\pt8.53-103-r1

The action DLTAPPLY is used to apply a Tools Delta change package that was created using PUM.

Command line format:

Changeassistant.bat -MODE UM -ACTION DLTAPPLY -TGTENV <target database> -UPD <change package> -TYPE <initial pass or move to production> -SYNCTYPE <y OR n> -OUT <log file directory> -WARNINGSOK <Yor N> -RESETJOB <Y or N> -EXONERR <launch GUI Y or N> -RESUMEJOB [COMPLETECONTINUE|RESTARTCONTINUE| READYTORUNCONTINUE]

Example command line:

Changeassistant.bat -MODE UM -ACTION DLTAPPLY  -TGTENV HC920001 – UPD PKG1

In this example the target database is named HC920001and the change package to apply is PKG1. All of the other parameters will use the default.

Parameter

Description

-MODE

Change Assistant mode (Required)

UM

-ACTION

Change Assistant action (Required)

DLTAPPLY = Apply Tools Delta Change Package

-TGTENV

Target database (Required)

Optional if TYPE is IPSRC

-UPD

The Change Package to apply. (Required)

Specify either all , a single or multiple Change Packages to apply to the specified environment.

For example:

  • -UPD all

  • -UPD PKG1

  • -UPD PKG1,PKG2

-TYPE

Apply Type. (Optional)

  • IP = Initial Pass (All steps) (default)

  • MTP = Move to production

  • IPSRC = Source only initial pass

  • IPTGT = Target only initial pass

-SYNCTYPE

Synchronize target metadata. (Optional)

  • Y = Yes (default if type is IP)

  • N = No (default if type is not IP)

-OUT

Path of log file (Optional)

If the log directory is not specified it uses the default defined under General Options.

-WARNINGSOK

Proceed with apply even if warnings are found. (Optional)

  • Y = Proceed with apply even if warnings are found. (default)

  • N = Stop apply when warnings are encountered.

-EXONERR

Specify whether or not to launch GUI if an error or manual stop is encountered. (Optional)

  • Y = Do not Launch

  • N= Launch (default)

-RESETJOB

Specify whether or not to reset the job if the job fails the first time it is run.

  • Y = Delete existing job and create a new job

  • N = Do NOT delete existing job and continue running the existing job. (default)

-RESUMEJOB

Specify the parameter value:

  • COMPLETECONTINUE

    To mark the first failed step or manual stop step to status COMPLETE and continue the job.

  • RESTARTCONTINUE

    To mark the first failed step or manual stop step to status RE-START and continue the job

  • READYTORUNCONTINUE

    To mark the first failed step or manual stop step to status READYTORUN and continue the job

-FS

Specify either the file servers or ini path.

File servers hostname#configPath (Optional)

  • -FS all (default)

  • -FS slc06ejv#c:\pt8.53-102-r1

  • -FS slc06ejv#c:\pt8.53-102-r1;slc08eyu#c:\pt8.53-103-r1

The action DLTAPPLY is used to apply a Tools Delta change package that was created using PUM.

Command line format:

Changeassistant.bat -MODE UM -ACTION TDPAPPLY -TGTENV <target database> -UPD <change package> -TYPE <initial pass or move to production> -SYNCTYPE <y OR n> -OUT <log file directory> -WARNINGSOK <Yor N> -RESETJOB <Y or N> -EXONERR <launch GUI Y or N> -RESUMEJOB [COMPLETECONTINUE|RESTARTCONTINUE| READYTORUNCONTINUE]

Example command line:

Changeassistant.bat -MODE UM -ACTION TDPAPPLY  -TGTENV HC920001 – UPD PKG1

In this example the target database is named HC920001and the change package to apply is PKG1. All of the other parameters will use the default.

Parameter

Description

-MODE

Change Assistant mode (Required)

UM

-ACTION

Change Assistant action (Required)

TDPAPPLY = Apply Translation Delta Change Package

-TGTENV

Target database (Required)

Optional if TYPE is IPSRC

-UPD

The Change Package to apply. (Required)

Specify either all , a single or multiple Change Packages to apply to the specified environment.

For example:

  • -UPD all

  • -UPD PKG1

  • -UPD PKG1,PKG2

-TYPE

Apply Type. (Optional)

  • IP = Initial Pass (All steps) (default)

  • MTP = Move to production

  • IPSRC = Source only initial pass

  • IPTGT = Target only initial pass

-SYNCTYPE

Synchronize target metadata. (Optional)

  • Y = Yes (default if type is IP)

  • N = No (default if type is not IP)

-OUT

Path of log file (Optional)

If the log directory is not specified it uses the default defined under General Options.

-WARNINGSOK

Proceed with apply even if warnings are found. (Optional)

  • Y = Proceed with apply even if warnings are found. (default)

  • N = Stop apply when warnings are encountered.

-EXONERR

Specify whether or not to launch GUI if an error or manual stop is encountered. (Optional)

  • Y = Do not Launch

  • N= Launch (default)

-RESETJOB

Specify whether or not to reset the job if the job fails the first time it is run.

  • Y = Delete existing job and create a new job

  • N = Do NOT delete existing job and continue running the existing job. (default)

-RESUMEJOB

Specify the parameter value:

  • COMPLETECONTINUE

    To mark the first failed step or manual stop step to status COMPLETE and continue the job.

  • RESTARTCONTINUE

    To mark the first failed step or manual stop step to status RE-START and continue the job

  • READYTORUNCONTINUE

    To mark the first failed step or manual stop step to status READYTORUN and continue the job

-FS

Specify either the file servers or ini path.

File servers hostname#configPath (Optional)

  • -FS all (default)

  • -FS slc06ejv#c:\pt8.53-102-r1

  • -FS slc06ejv#c:\pt8.53-102-r1;slc08eyu#c:\pt8.53-103-r1

The action RFUAPPLY is used to apply a Tools Delta change package that was created using PUM.

Command line format:

Changeassistant.bat -MODE UM -ACTION RFUAPPLY -TGTENV <target database> -UPD <change package> -TYPE <initial pass or move to production> -SYNCTYPE <y OR n> -OUT <log file directory> -WARNINGSOK <Yor N> -RESETJOB <Y or N> -EXONERR <launch GUI Y or N> -RESUMEJOB [COMPLETECONTINUE|RESTARTCONTINUE| READYTORUNCONTINUE]

Example command line:

Changeassistant.bat -MODE UM -ACTION RFUAPPLY  -TGTENV HC920001 – UPD PKG1

In this example the target database is named HC920001and the change package to apply is PKG1. All of the other parameters will use the default.

Parameter

Description

-MODE

Change Assistant mode (Required)

UM

-ACTION

Change Assistant action (Required)

RFUAPPLY = Apply Required for Upgrade Change Package

-TGTENV

Target database (Required)

Optional if TYPE is IPSRC

-UPD

The Change Package to apply. (Required)

Specify either all , a single or multiple Change Packages to apply to the specified environment.

For example:

  • -UPD all

  • -UPD PKG1

  • -UPD PKG1,PKG2

-TYPE

Apply Type. (Optional)

  • IP = Initial Pass (All steps) (default)

  • MTP = Move to production

  • IPSRC = Source only initial pass

  • IPTGT = Target only initial pass

-SYNCTYPE

Synchronize target metadata. (Optional)

  • Y = Yes (default if type is IP)

  • N = No (default if type is not IP)

-OUT

Path of log file (Optional)

If the log directory is not specified it uses the default defined under General Options.

-WARNINGSOK

Proceed with apply even if warnings are found. (Optional)

  • Y = Proceed with apply even if warnings are found. (default)

  • N = Stop apply when warnings are encountered.

-EXONERR

Specify whether or not to launch GUI if an error or manual stop is encountered. (Optional)

  • Y = Do not Launch

  • N= Launch (default)

-RESETJOB

Specify whether or not to reset the job if the job fails the first time it is run.

  • Y = Delete existing job and create a new job

  • N = Do NOT delete existing job and continue running the existing job. (default)

-RESUMEJOB

Specify the parameter value:

  • COMPLETECONTINUE

    To mark the first failed step or manual stop step to status COMPLETE and continue the job.

  • RESTARTCONTINUE

    To mark the first failed step or manual stop step to status RE-START and continue the job

  • READYTORUNCONTINUE

    To mark the first failed step or manual stop step to status READYTORUN and continue the job

-FS

Specify either the file servers or ini path.

File servers hostname#configPath (Optional)

  • -FS all (default)

  • -FS slc06ejv#c:\pt8.53-102-r1

  • -FS slc06ejv#c:\pt8.53-102-r1;slc08eyu#c:\pt8.53-103-r1