purge_processes

Purges completed processes based on the last-modified date of the process. Objects such as e-mail messages that reference the process are not deleted. Use the -f argument to delete both in-process and completed processes and sever the references between objects and the processes. Note As long as the -r argument is not configured then purge_processes will automatically purge existing orphan status objects. Syntax purge_processes [-u=user-id {-p=password | -pf=password-file} -g=group-name] {-d=MM-DD-YYYY| -folder=folder-name} [-force] [-r] [-h] [-pso][pso_batch_size=][-pdm][-pdm_batch_size=][-pdm_start_date=MM-DD-YYYY][-pdm_end_date=MM-DD-YYYY] Arguments Entries in parentheses are accepted abbreviations for arguments. -u Specifies the user ID. This is a user with Teamcenter administration privileges. Note If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the user's password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -d Specifies the cut-off date for processes to be purged. This is the last-modified date of the process. All processes with a last-modified date equal to or before the specified date are purged. The utility will only accept either the -d argument or the -folder argument, but not both. If the -d argument is configured then do not configure the -folder argument. -folder Specifies the folder containing the processes to be purged. The folder must exist directly inside the executing user's Home folder. The utility will only accept either the -folder argument or the -d argument but not both. If the -folder argument is configured then do not configure the -d argument. -pso Purges status objects (Fnd0ObjectStatus) associated with completed jobs. Workflow utilizes status objects to store error information so it can be retained until the issue causing the error is resolved. If the -pso argument is configured, then after the utility purges processes, it will then purge status objects from any remaining completed processes. -pso_batch_size The batch size provided is an integer that indicates the maximum number of status objects (Fnd0ObjectStatus) that will get purged. This argument is only valid when the -pso argument is configured. If -pso_batch_size is not configured when -pso is configured, then all status objects (Fnd0ObjectStatus) associated with completed jobs will be purged. -pdm Purges unreferenced detailed message objects (Fnd0DetailedMessage). If -pdm is configured and -pdm_batch_size is not configured, then then all unreferenced detailed message objects (Fnd0DetailedMessage) will be purged. -pdm_batch_size The batch size provided is an integer that indicates the maximum number of detailed message objects (Fnd0DetailedMessage) that will get purged. This argument is only valid when the -pdm option is configured. If -pdm_batch_size is not configured when -pdm is configured, then all unreferenced detailed message objects (Fnd0DetailedMessage) will be purged. -pdm_start_date This is the start date in a date range. This argument is only valid when both the -pdm and -pdm_end_date arguments are also configured. The combination of -pdm_start_date and -pdm_end_date will be used to form a date range. -pdm_end_date This is the end date in a date range. This argument is only valid when both the -pdm and -pdm_start_date arguments are also configured. The combination of -pdm_start_date and -pdm_end_date will be used to form a date range. -f Deletes in-process and completed processes specified by the -d argument from the system and severs references between objects and the processes being deleted. If this argument is not specified, only completed processes that have no referenced objects are purged. -r Generates a report of the number and names of processes to be purged without purging the processes. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions The utility will only accept either the -d argument or the -folder argument but not both. Configure only one of these arguments. Examples To remove all processes that have been modified on or before 15th April 1998, enter the following command on a single line: Copy purge_processes -u=user-id -p=password -g=dba -d=04-15-1998 To purge processes as described in the previous example and also purge status objects, execute the following command: Copy purge_processes -u=user-id -p=password -g=dba -d=04-15-1998 -pso To remove processes located in the folder named my_folder where the folder is located beneath the executing user's Home folder, search for processes, type Job, using any search criteria desired, and copy the processes into the folder my_folder. Execute the following command: Copy purge_processes -u=user-id -p=password -g=dba -folder=my_folder To purge processes as described in the previous example and purge status objects, execute the following command: Copy purge_processes -u=user-id -p=password -g=dba -folder=my_folder -pso To only purge status objects and not affect processes, create a folder beneath the executing user's Home folder and leave the folder empty. For instance, create a folder named my_folder and leave it empty. No processes will be affected since the folder is empty, but the -pso option will still find and purge status objects associated with completed processes. Execute the following command: Copy purge_processes -u=user-id -p=password -g=dba -folder=my_folder -pso The following examples will all make use of the empty folder named my_folder as previously described. To purge all status objects (Fnd0ObjectStatus) associated with completed workflow processes (jobs), execute the following command: Copy purge_processes -u=user-id -p=password -g=dba -folder=my_folder -pso To purge a maximum of 100 status objects associated with completed workflow processes (jobs), execute the following command: Copy purge_processes -u=user-id -p=password -g=dba -folder=my_folder -pso - pso_batch_size=100 To purge all unreferenced detailed message objects, execute the following command: Copy purge_processes -u=user-id -p=password -g=dba -folder=my_folder -pdm To purge a maximum of 200 unreferenced detailed message objects, execute the following command: Copy purge_processes -u=user-id -p=password -g=dba -folder=my_folder -pdm - pdm_batch_size=200 To purge all unreferenced detailed message objects between June 15, 2019 and August 10 2020, execute the following command: Copy purge_processes -u=user-id -p=password -g=dba -folder=my_folder -pdm -pdm_start_date=06-15-2019 -pdm_end_date=08-10-2020 To purge a maximum of 175 unreferenced detailed message objects between June 15, 2019 and August 10, 2020, execute the following command: Copy purge_processes -u=user-id -p=password -g=dba -folder=my_folder -pdm -pdm_start_date=06-15-2019 -pdm_end_date=08-10-2020 -pdm_batch_size=175 Related Topics Workflow Designer on Rich Client