-deletecpimessages
Parameter to start the deletion procedure of CPI messages. As a stand-alone parameter with no effect. At least one of the following parameters must be transferred as a filter: -excluding, -messagetype, and –owner.
-mode <delete|mark_deleted>
Specifies if messages will be deleted (delete mode) or are set to be deleted (mark_deleted mode).
In mark_deleted mode, all CPI messages are set to be deleted without actually being deleted permanently. These messages can be restored. Default value for –mode (without –mode parameter) is mark_deleted.
The –deletecpimessages parameter is absolutely necessary for starting the deletion procedure. The parameters -excluding, -messagetype and -owner are AND-linked and restrict the set of messages to be deleted.
Example 1
runppmcpi … - deletecpimessages –excluding 5w –mode mark_deleted
All CPI messages older than 5 weeks are set to the to_delete status.
Example 2
runppmcpi … -deletecpimessages –excluding 5w –mode delete
All CPI messages older than 5 weeks are deleted.
-excluding <n>[y|q|m|w|d]
Excluding filter with current reference date: y=year, q=quarter, m=month, w=week, d=day. "n" must be an integer.
All CPI messages older than the excluding filter are permanently deleted/set to the to_delete status.
Example
runppmcpi … -deletecpimessages –excluding 5w –mode delete
All CPI messages older than 5 weeks are deleted.
-messagetype <system_message, activity, comment, outlier_message, earlyalert_message, alarm_message, target_message, processmining_message>
The parameter filters by the type of CPI message. All CPI messages of the transferred messagetype are deleted. Multiple messagetypes can be transferred.
Example 1
runppmcpi … -deletecpimessages -messagetype comment –mode delete
All comments will be deleted.
Example 2
runppmcpi … -deletecpimessages -messagetype comment earlyalert_message
All comments AND early alert messages will be set to the to_delete status.
-owner <owner>
The CPI messages of the user specified by owner will be deleted.
Example
runppmcpi … -deletecpimessages –owner mueller -messagetype comment –mode delete
All comments with owner=mueller will be deleted.
-registry <host:port>
By specifying this parameter, you can access a remote PPM system whose RMI registry can be reached via the specified computer name and port number.
-usessl <true|false|default>
If you specified the -registry parameter, you can use the -usessl parameter to specify whether the remote system is to use SSL-encrypted data communication or not.
Parameter |
Description |
---|---|
true |
The remote PPM system uses encrypted data transfer. Ensure that the local system and remote system are using the same keystore. |
false |
The remote system uses unencrypted data transfer. |
default |
The settings of the local PPM system are used. |
Master-sub-server system
In a scaled system, CPI messages can be created on the master and sub-servers. When deleting messages via runppmcpi, master and sub-servers are considered stand-alone servers. No deletion will take place.