WebSphere:*,type=PALServiceMBean PALService
MBean for administering BPM applications.
| Operation Summary | |
void | activate(Activate a process application snapshot on a Process Center server or a Process Server. |
void | checkOrphanTokens(Generate a policy file. |
void | migrateInstances(Migrate instances from the given source snapshot to the given target snapshot. |
void | createOfflinePackage(Create an installation package for a process application snapshot that can be extracted and be deployed to an off-line Process Center server instance. |
void | deactivate(This command deactivates an active snapshot. |
void | deactivateForce(This command deactivates an active snapshot including the default snapshot. |
void | deactivateForceSuspend(This command deactivates an active snapshot including the default snapshot and suspends all in-flight instances. |
void | install(Install a process application snapshot from a Process Center server to a Process Server in a test or production environment. |
void | installOfflinePackage(Install a process application snapshot from a Process Center server to an offline Process Server that is not connected to the Process Center. |
void | changeSnapshotStatus(Command for changing the status of a snapshot on a Process Center server. |
void | archiveProcessApplication(This command archives a process application. |
void | archiveToolkit(This command archives a toolkit. |
void | removeProcessApplication(Command for removing a process application. |
void | removeToolkit(Command for removing a toolkit. |
void | archive(This command stops a process application snapshot that has already been deactivated on a Process Server. |
java.lang.String | getSnapshotAcronym(Command for retrieving the acronym of a snapshop given the name of the snapshot. |
void | export(Export a process application snapshot from the Process Center server. |
void | extractOfflinePackage(Extract the process application snapshot installation package from the Process Center server. |
void | importSnapshot(Import a process application into a Process Center Server. |
java.lang.String | listProcessApplications()List all process applications and toolkits on a Process Center server or a Process Server. |
java.lang.String | listServers()List all of the Process Server instances that are federated into the Process Center server. |
void | processInstancesCleanup(Cleanup completed, failed or canceled process instances on a process server. |
void | processInstancesPurge(Purge process instances. |
java.lang.Integer | processInstancesResumption(Resume suspended process instances or return the number of resumed process instances. |
void | deleteDurableMessages(Delete messages that are stored if durable subscriptions for intermediate message events are enabled on a process server. |
java.lang.Integer | replayOnHoldEMTasks(Replay EventManager messages that are on hold because their execution has failed more often than the retry limit. |
void | deleteSnapshot(Delete process application snapshots and their dependencies on a Process Server. |
void | deleteSnapshotForce(Delete process application snapshots and their dependencies on a Process Server. |
void | snapshotCleanup(Cleanup process application snapshots and their dependencies. |
java.lang.String | showProcessApplication(Show process application data in a Process Center Server or Process Server instance. |
java.lang.String | showServer(List information for a federated Process Server instance in a Process Center server. |
java.lang.String | showSnapshot(List information about a process application or a toolkit snapshot. |
java.lang.String | showSnapshotDependents(List information about a process application or a toolkit snapshot. |
void | stop(Stop a process application snapshot that has already been deactivated on a Process Server. |
void | undeploy(Undeploy a process application snapshot from a server. |
void | setDefaultSnapshot(Change the default process application snapshot of a process application on a Process Server. |
java.lang.String | showInstallMessages(Lists detailed messages from the install of specified snapshot. |
void | tasksCleanup(Cleanup completed tasks on a process server. |
java.lang.String | showInstallStatus(Returns the installation status of a snapshot on a server. |
void | exportInstallPackage(This command exports an install package from the Process Center server. |
void | installPackage(This command enables the installation of a process application snapshot from Process Center server to any Process Servers. |
void | updateInstallationInformation(This command associates an installation package of a process application snapshot with an offline Process Center server instance. |
void | syncEnvironmentVariables(Synchronize the environment variables between two snapshots. |
void | syncParticipantGroups(Synchronize the participant groups between two snapshots. |
void | syncEPVValues(Synchronize the EPV values between two snapshots. |
void | setEnvironmentVariable(Set the value of a environment variable for a snapshot. |
void | setECMServerProperties(Set the properties of a server with type 'Enterprise Content Management Server' for a snapshot. |
void | setWebServiceServerProperties(Set the properties of a server with type 'Web Service' for a snapshot. |
void | setILOGRulesServerProperties(Set the properties of a server with type 'ILOG Rules Server' for a snapshot. |
void | setSAPServerProperties(Set the properties of a server with type 'SAP Server' for a snapshot. |
void | extractMigrationPolicy(This command extract a a migration policy file from the Process Center server. |
void | updateTheme(This command extract updates a process application's theme. |
void | regenTheme(This command regenerate a project's theme. |
void | updateFile(This command updates a server file. |
void | createSnapshot(This command create a new snapshot. |
void | updateDependency(This command updates the dependency between a process application and a toolkit. |
| Operation Detail |
public void activate(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.
public void checkOrphanTokens(java.lang.String processAppAcronym, java.lang.String sourceSnapshotName, java.lang.String sourceSnapshotAcronym, java.lang.String targetSnapshotName, java.lang.String targetSnapshotAcronym, java.lang.String outputFile, java.lang.Boolean overwrite)
processAppAcronym -
This parameter identifies the process application and is required.sourceSnapshotName -
Identifies the source snapshot that the process instances are migrated from.sourceSnapshotAcronym -
Identifies the acronym of the source snapshot that the process instances are migrated from.targetSnapshotName -
Identifies the target snapshot that the process instances are migrated to.targetSnapshotAcronym -
Identifies the acronym of the target snapshot that the process instances are migrated to.outputFile -
Identifies the the XML policy file's absolute path..overwrite -
Identifies an option that you use to overwrite a policy file if it already exists.
public void migrateInstances(java.lang.String containerAcronym, java.lang.String sourceContainerSnapshotName, java.lang.String sourceContainerSnapshotAcronym, java.lang.String targetContainerSnapshotName, java.lang.String targetContainerSnapshotAcronym, java.lang.String orphanTokenPolicyFile, java.lang.String useNetworkAvailablePolicyFile)
containerAcronym -
This parameter identifies the container process application and is required.sourceContainerSnapshotName -
Identifies the name of the source snapshot that the process instances are migrated from.sourceContainerSnapshotAcronym -
Identifies the acronym of the source snapshot that the process instances are migrated from.targetContainerSnapshotName -
Identifies the name of the target snapshot that the process instances are migrated to.targetContainerSnapshotAcronym -
Identifies the acronym of the target snapshot that the process instances are migrated to.orphanTokenPolicyFile -
Identifies the XML policy file's absolute path..useNetworkAvailablePolicyFile -
A flag to indicate whether to use a policy file that is accessible for all the nodes.
public void createOfflinePackage(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.Boolean skipGovernance)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.serverName -
The name of the process server.skipGovernance -
If the value of this optional parameter is 'true' the governance process assigned to the process application will not be triggered.
public void deactivate(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
containerAcronym -
This is a required parameter that identifies the process application or toolkit acronym.containerTrackAcronym -
This is an optional parameter that identifies the track associated with the process application or toolkit. The default value is Main.containerSnapshotAcronym -
This is a required parameter that identifies the process application or toolkit snapshot acronym. When you are not working with a snapshot, you can optionally specify Tip as the value.
public void deactivateForce(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.Boolean force)
containerAcronym -
This is a required parameter that identifies the process application or toolkit acronym.containerTrackAcronym -
This is an optional parameter that identifies the track associated with the process application or toolkit. The default value is Main.containerSnapshotAcronym -
This is a required parameter that identifies the process application or toolkit snapshot acronym. When you are not working with a snapshot, you can optionally specify Tip as the value.force -
This is an optional parameter that deactivates the default snapshot of the process application or toolkit. Default snapshots are not deactivated unless you include the force parameter.
public void deactivateForceSuspend(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.Boolean force, java.lang.Boolean suspendAllBPDInstances, java.lang.String outputFile)
containerAcronym -
This is a required parameter that identifies the process application or toolkit acronym.containerTrackAcronym -
This is an optional parameter that identifies the track associated with the process application or toolkit. The default value is Main.containerSnapshotAcronym -
This is a required parameter that identifies the process application or toolkit snapshot acronym. When you are not working with a snapshot, you can optionally specify Tip as the value.force -
This is an optional parameter that deactivates the default snapshot of the process application or toolkit. Default snapshots are not deactivated unless you include the force parameter.suspendAllBPDInstances -
This is an optional parameter that suspends all in-flight instances associated with the given context. This parameter is not supported when Tip is specified as the value for the containerSnapshotAcronym parameter.outputFile -
This is an optional parameter that specifies the file path to write log messages. If you do not provide this parameter, the messages are written to systemout.log.
public void install(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.Boolean skipGovernance)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.serverName -
The name of the process server.skipGovernance -
If the value of this optional parameter is 'true' the governance process assigned to the process application will not be triggered..
public void installOfflinePackage(java.lang.String inputFile)
inputFile -
This parameter identifies the absolute path of the offline installation package you created and extracted on the Process Center server and transferred to the offline Process Server.
public void changeSnapshotStatus(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String newSnapshotStatus)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.newSnapshotStatus -
The existing or new status of a snapshot. This is a required parameter.
public void archiveProcessApplication(java.lang.String containerAcronym)
containerAcronym -
This parameter identifies the process application and is required.
public void archiveToolkit(java.lang.String containerAcronym)
containerAcronym -
This parameter identifies the toolkit and is a required parameter.
public void removeProcessApplication(java.lang.String containerAcronym)
containerAcronym -
This parameter identifies the process application and is required.
public void removeToolkit(java.lang.String containerAcronym)
containerAcronym -
This parameter identifies the toolkit and is a required parameter.
public void archive(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.
public java.lang.String getSnapshotAcronym(java.lang.String containerAcronym, java.lang.String containerSnapshotName)
containerAcronym -
This parameter identifies the process application and is required.containerSnapshotName -
The process application snapshot name. Restricted to the following character set: A-Z|0-9|_|. This is a required parameter.
public void export(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String outputFile)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.outputFile -
Identifies the absolute path for the export file you are creating. The file name must be unique (with respect to other similar exported files) and must have a .twx extension.
public void extractOfflinePackage(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.String outputFile)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.serverName -
The name of the process server.outputFile -
Identifies the absolute path of the offline installation package you created and extracted on the Process Center server and transferred to the offline Process Server..
public void importSnapshot(java.lang.String inputFile)
inputFile -
Identifies the absolute path for the export file you are creating. The file name must be unique (with respect to other similar exported files) and must have a .twx extension.
public java.lang.String listProcessApplications()
public java.lang.String listServers()
public void processInstancesCleanup(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String instanceStatus, java.lang.String[] instanceID, java.lang.String endedAfterLocal, java.lang.String endedBeforeLocal, java.lang.String outputFile, java.lang.String maximumDuration, java.lang.String transactionSlice)
containerAcronym -
This parameter identifies the process application and is required.containerSnapshotAcronym -
Identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.instanceStatus -
The status of the process instances to remove. Specify COMPLETED, FAILED, CANCELED or ALL. This is a required parameter.instanceID -
The IDs of the process instances to remove. Specify instance IDs, if there are more than one instance ID, each instance ID must be delimited by a space for jython format command or a semicolon for jacl format command.endedAfterLocal -
The completed/failed/canceled process instances after local time to remove. Specify 'yyyy-MM-ddThh:mm:ss' (year, month, day, T, hours, minutes, seconds).endedBeforeLocal -
The completed/failed/canceled process instances before local time to remove. Specify 'yyyy-MM-ddThh:mm:ss' (year, month, day, T, hours, minutes, seconds).outputFile -
The absolute path to the log file for logging the results of the process instance cleanup. If not provided, results will be logged to the system out log file.maximumDuration -
The maximum duration in minutes. Default value is 0 (unlimited)transactionSlice -
Number of instances per transaction. Default is 1.
public void processInstancesPurge(java.lang.String containerAcronym, java.lang.String[] containerSnapshotAcronym, java.lang.String[] instanceStatus, java.lang.String[] instanceID, java.lang.String endedAfterLocal, java.lang.String endedBeforeLocal, java.lang.String outputFile, java.lang.String maximumDuration, java.lang.String transactionSlice, java.lang.Boolean force)
containerAcronym -
This parameter identifies the process application and is required if a snapshot acronym is specified.containerSnapshotAcronym -
Identifies the process application snapshots.instanceStatus -
The statuses of the process instances to remove. Specify at least one of ACTIVE, COMPLETED, FAILED, TERMINATED, DID_NOT_START, SUSPENDED or ALL. This is a required parameter.instanceID -
The IDs of the process instances to remove. Specify instance IDs, if there are more than one instance ID, each instance ID must be delimited by a space for jython format command or a semicolon for jacl format command.endedAfterLocal -
The completed/canceled process instances ended after local time to remove. Specify 'yyyy-MM-ddThh:mm:ss' (year, month, day, T, hours, minutes, seconds).endedBeforeLocal -
The completed/canceled process instances ended before local time to remove. Specify 'yyyy-MM-ddThh:mm:ss' (year, month, day, T, hours, minutes, seconds).outputFile -
The absolute path to the log file for logging the results of the process instance cleanup. If not provided, results will be logged to the system out log file.maximumDuration -
The maximum duration in minutes. Default value is 0 (unlimited)transactionSlice -
Number of instances per transaction. Default is 1.force -
Use this flag to force the command to delete instances in non end states. Non end states are: ACTIVE, FAILED, DID_NOT_START, SUSPENDED or ALL.
public java.lang.Integer processInstancesResumption(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String maxNumberOfInstances, java.lang.Boolean getNumberOfInstances)
containerAcronym -
This parameter identifies the process application and is required.containerSnapshotAcronym -
Identifies the process application snapshot and is required.maxNumberOfInstances -
The number of instances to be resumed. Default is all currently suspended instances.getNumberOfInstances -
This is an optional parameter that returns the number of suspended instances associated with the given context. Either getNumberOfInstances or maxNumberOfInstances may be specified.
public void deleteDurableMessages(java.lang.String olderThan, java.lang.String maximumDuration, java.lang.String transactionSlice)
olderThan -
The minimum age in days of the durable messages to delete.maximumDuration -
The maximum duration in minutes. Default value is 0 (unlimited)transactionSlice -
The number of instances per transaction. Default value is 1000.
public java.lang.Integer replayOnHoldEMTasks(java.lang.Boolean getNumberOfTasks, java.lang.Integer maxNumberOfTasksToReplay, java.lang.String bpdInstanceId)
getNumberOfTasks -
This parameter controls whether the number of on hold Event Manager tasks is retrieved.maxNumberOfTasksToReplay -
The maximum number of on hold Event Manager tasks to replay.bpdInstanceId -
The BPD instance Id for which on hold Event Manager tasks are to be replayed.
public void deleteSnapshot(java.lang.String containerAcronym, java.lang.String[] containerSnapshotAcronyms, java.lang.String outputFile)
containerAcronym -
This parameter identifies the process application and is required.containerSnapshotAcronyms -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.outputFile -
The absolute path to the log file for logging the results of the process instance cleanup. If not provided, results will be logged to the system out log file.
public void deleteSnapshotForce(java.lang.String containerAcronym, java.lang.String[] containerSnapshotAcronyms, java.lang.String outputFile, java.lang.Boolean force)
containerAcronym -
This parameter identifies the process application and is required.containerSnapshotAcronyms -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.outputFile -
The absolute path to the log file for logging the results of the process instance cleanup. If not provided, results will be logged to the system out log file.force -
Use this flag to force the command to delete the default snapshot. User should be very careful using this parameter.
public void snapshotCleanup(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String[] containerSnapshotAcronyms, java.lang.Integer keptNumber, java.lang.String createdAfterLocal, java.lang.String createdBeforeLocal, java.lang.String createdBeforeSnapshotAcronym, java.lang.Boolean deleteArchivedSnapshot, java.lang.Boolean ignoreDependency, java.lang.String outputFile)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronyms -
Acronyms of the archived snapshots to be cleaned up. This parameter can be specified when you want to clean up the specific archived snapshots. And if specified, no other filter parameters (keptNumber, createdBeforeLocal, createdAfterLocal, createdBeforeSnapshotAcronym, and deleteArchivedSnapshot) can be specified.keptNumber -
The number of the latest unnamed snapshots that you want to keep, specify that you only want to keep the 'keptNumber' of the latest unnamed snapshot of a PA and remove the rest. If the keptNumber has no less than the total amount of the current unnamed snapshots, nothing would be removed. If the keptNumber == 0, all of the current unnamed snapshots would be cleaned up. If you input keptNumber, you should not input the createdBeforeLocal or createdAfterLocal parameters.createdAfterLocal -
The snapshots after local time to remove. Specify 'yyyy-MM-ddThh:mm:ss' (year, month, day, T, hours, minutes, seconds).createdBeforeLocal -
The snapshots before local time to remove. Specify 'yyyy-MM-ddThh:mm:ss' (year, month, day, T, hours, minutes, seconds).createdBeforeSnapshotAcronym -
Snapshot acronym name, specifies that you want to remove all the unnamed snapshot created before the named snapshot given by this parameter.deleteArchivedSnapshot -
Indicate if the archived snapshot will be deleted along with the unnamed snapshots deletion. By default, it is false.ignoreDependency -
Indicate if to force to delete the snapshots depended by other project applications. By default, it is false.outputFile -
The absolute path to the log file for logging the results of the process instance cleanup. If not provided, results will be logged to the system out log file.
public java.lang.String showProcessApplication(java.lang.String containerAcronym)
containerAcronym -
This parameter identifies the process application and is required.
public java.lang.String showServer(java.lang.String serverName)
serverName -
The name of the process server.
public java.lang.String showSnapshot(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.
public java.lang.String showSnapshotDependents(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.Boolean showDependents)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.showDependents -
Use this flag with the BPMShowSnapshot command to show all snapshots which depend on the specified snapshot.
public void stop(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym)
containerAcronym -
This parameter identifies the process application and is required.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.
public void undeploy(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.
public void setDefaultSnapshot(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym)
containerAcronym -
This parameter identifies the process application and is required.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required.
public java.lang.String showInstallMessages(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.Boolean verbose)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.serverName -
The name of the process server.verbose -
If the value of this optional parameter is 'true' the advanced details of the messages is to also be displayed i.e. start and end time, user, thread, server.
public void tasksCleanup(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String processName, java.lang.String taskStatus, java.lang.String taskType, java.lang.String[] taskID, java.lang.String endedAfterLocal, java.lang.String endedBeforeLocal, java.lang.String outputFile, java.lang.String maximumDuration, java.lang.String transactionSlice)
containerAcronym -
The acronym of the container or project that contains the completed tasks. If you do not include the taskID parameter, you must define this parameter.containerSnapshotAcronym -
The acronym of the snapshot for the container or project that contains the completed tasks. If you do not include the taskID parameter, you must define this parameter. If you do not want to specify a snapshot, use 'Tip' to use the latest snapshot.processName -
The process in the container that contains the tasks that will be cleaned up.taskStatus -
The status a task must have to be deleted. Valid values are CLOSED, SENT, ACTIONED, DELETED, ALERT, or ALL_COMPLETED, which includes any of CLOSED, SENT, ACTIONED, DELETED.taskType -
The types of tasks to delete. Valid values are SYSTEM_TASK, USER_TASK, DECISION_TASK, ALL.taskID -
The ID of one or more tasks to delete from the runtime database. If you provide multiple task IDs, separate each task ID by using a space for Jython format or by using a semicolon for Jacl format.endedAfterLocal -
The completed tasks after local time to remove. Specify 'yyyy-MM-ddThh:mm:ss' (year, month, day, T, hours, minutes, seconds).endedBeforeLocal -
The completed tasks before local time to remove. Specify 'yyyy-MM-ddThh:mm:ss' (year, month, day, T, hours, minutes, seconds).outputFile -
The file that contains the messages that are related to cleaning up the tasks. The path to the file can be absolute or relative. The default file is the systemout.log file.maximumDuration -
The maximum time in minutes for the system to run the command. The default is 0 (no limit).transactionSlice -
The number of tasks per transaction. The default value is 100.
public java.lang.String showInstallStatus(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName)
containerAcronym -
This parameter identifies the process application and is required.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required.serverName -
This parameter identifies the name of the process server and is required.
public void exportInstallPackage(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String outputFile)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.outputFile -
This parameter identifies the absolute path of the installation package you created and extracted on the Process Center server and transferred to the online or offline Process Server.
public void installPackage(java.lang.String inputFile)
inputFile -
This parameter identifies the absolute path of the offline installation package you created and extracted on the Process Center server and transferred to the offline Process Server.
public void updateInstallationInformation(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required. You can optionally use Tip for the value if you choose to not work with a process application snapshot.serverName -
This parameter is the name of the Process Server.
public void syncEnvironmentVariables(java.lang.String containerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String targetContainerSnapshotAcronym)
containerAcronym -
This parameter identifies the process application and is required.sourceContainerSnapshotAcronym -
This parameter identifies the process application snapshot to synchronize from and is required..targetContainerSnapshotAcronym -
This parameter identifies the process application snapshot to synchronize to and is required..
public void syncParticipantGroups(java.lang.String containerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String targetContainerSnapshotAcronym)
containerAcronym -
This parameter identifies the process application and is required.sourceContainerSnapshotAcronym -
This parameter identifies the process application snapshot to synchronize from and is required..targetContainerSnapshotAcronym -
This parameter identifies the process application snapshot to synchronize to and is required..
public void syncEPVValues(java.lang.String containerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String targetContainerSnapshotAcronym)
containerAcronym -
This parameter identifies the process application and is required.sourceContainerSnapshotAcronym -
This parameter identifies the process application snapshot to synchronize from and is required..targetContainerSnapshotAcronym -
This parameter identifies the process application snapshot to synchronize to and is required..
public void setEnvironmentVariable(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String environmentVariableName, java.lang.String environmentVariableValue)
containerAcronym -
This parameter identifies the process application and is required.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotAcronym -
This parameter identifies the process application snapshot and is required.environmentVariableName -
This parameter identifies the environment variable to set and is required.environmentVariableValue -
This parameter identifies the value to set the environment variable to and is required.
public void setECMServerProperties(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.String hostname, java.lang.String port, java.lang.String secureServer, java.lang.String contextPath, java.lang.String repository, java.lang.String userId, java.lang.String password, java.lang.String alwaysUseThisConnectionInformation, java.lang.String testConnection)
containerAcronym -
The value for this parameter identifies the process application and is required.containerSnapshotAcronym -
The value for this parameter identifies the process application snapshot and is required.serverName -
The value for this parameter identifies the server configuration by name and is required.hostname -
The value for this parameter identifies the hostname property.port -
The value for this parameter identifies the port property.secureServer -
The value for this parameter identifies the secure server flag [true|false].contextPath -
The value for this parameter identifies the context path property.repository -
The value for this parameter identifies the repository property.userId -
The value for this parameter identifies the user id property.password -
The value for this parameter identifies the password property.alwaysUseThisConnectionInformation -
The value for this parameter identifies the always use this connection flag [true|false].testConnection -
The value for this parameter identifies the test connection option [true|false].
public void setWebServiceServerProperties(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.String wsdlUrl, java.lang.String protectedWsdl, java.lang.String wsdlUsername, java.lang.String wsdlPassword, java.lang.String overrideEndpoint, java.lang.String endpointAddress, java.lang.String endpointPort, java.lang.String securityMode, java.lang.String authentication, java.lang.String username, java.lang.String password, java.lang.String clientCertificateAlias, java.lang.String signRequest, java.lang.String expectEncryptedResponse, java.lang.String serverCertificateAlias, java.lang.String encryptedRequest, java.lang.String expectSignedResponse, java.lang.String policySet, java.lang.String policyBinding)
containerAcronym -
The value for this parameter identifies the process application and is required.containerSnapshotAcronym -
The value for this parameter identifies the process application snapshot and is required.serverName -
The value for this parameter identifies the server configuration by name and is required.wsdlUrl -
The value for this parameter identifies the wsdlURL property.protectedWsdl -
The value for this parameter identifies the protectedWsdl flag [true|false].wsdlUsername -
The value for this parameter identifies the wsdlUsername property.wsdlPassword -
The value for this parameter identifies the wsdlPasswordURL property.overrideEndpoint -
The value for this parameter identifies the overrideEndpoint flag [true|false].endpointAddress -
The value for this parameter identifies the endpointAddress property.endpointPort -
The value for this parameter identifies the endpointPort property.securityMode -
The value for this parameter identifies the securityMode property. [ USE_BASIC_SECURITY | USE_POLICY_SET ]authentication -
The value for this parameter identifies the authentication property. [ NONE | HTTP_AUTHENTICATION | USERNAME_TOKEN_PASSWORD_PLAINTEXT | USERNAME_TOKEN_PASSWORD_DIGEST ]username -
The value for this parameter identifies the username property.password -
The value for this parameter identifies the password property.clientCertificateAlias -
The value for this parameter identifies the clientCertificateAlias property.signRequest -
The value for this parameter identifies the signRequest flag [true|false].expectEncryptedResponse -
The value for this parameter identifies the expectEncryptedResponse flag [true|false].serverCertificateAlias -
The value for this parameter identifies the serverCertificateAlias property.encryptedRequest -
The value for this parameter identifies the encryptedRequest flag [true|false].expectSignedResponse -
The value for this parameter identifies the expectSignedResponse flag [true|false].policySet -
The value for this parameter identifies the policySet property.policyBinding -
The value for this parameter identifies the policyBinding property.
public void setILOGRulesServerProperties(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.String hostname, java.lang.String port)
containerAcronym -
The value for this parameter identifies the process application and is required.containerSnapshotAcronym -
The value for this parameter identifies the process application snapshot and is required.serverName -
The value for this parameter identifies the server configuration by name and is required.hostname -
The value for this parameter identifies the hostname property.port -
The value for this parameter identifies the port property.
public void setSAPServerProperties(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.String systemName, java.lang.String location, java.lang.String client, java.lang.String httpPort, java.lang.String httpsPort)
containerAcronym -
The value for this parameter identifies the process application and is required.containerSnapshotAcronym -
The value for this parameter identifies the process application snapshot and is required.serverName -
The value for this parameter identifies the server configuration by name and is required.systemName -
The value for this parameter identifies the system name property.location -
The value for this parameter identifies the location property.client -
The value for this parameter identifies the client property.httpPort -
The value for this parameter identifies the http port property.httpsPort -
The value for this parameter identifies the https port property.
public void extractMigrationPolicy(java.lang.String containerAcronym, java.lang.String containerSourceSnapshotAcronym, java.lang.String containerTargetSnapshotAcronym, java.lang.String outputFile)
containerAcronym -
This parameter identifies the process application and is required.containerSourceSnapshotAcronym -
This parameter identifies the process application snapshot migrate from and is required.containerTargetSnapshotAcronym -
This parameter identifies the process application snapshot migrate to and is required.outputFile -
This parameter identifies the absolute path of the installation package you created and extracted on the Process Center server and transferred to the online or offline Process Server.
public void updateTheme(java.lang.String sourceContainerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String themeName, java.lang.String targetContainerAcronym, java.lang.String targetContainerSnapshotAcronym)
sourceContainerAcronym -
This parameter identifies the source project and is required.sourceContainerSnapshotAcronym -
This parameter identifies the source project snapshot and is required.themeName -
This parameter identifies the source theme name and is optional.targetContainerAcronym -
This parameter identifies the target process application and is required.targetContainerSnapshotAcronym -
This parameter identifies target process application snapshot and is required.
public void regenTheme(java.lang.String targetContainerAcronym, java.lang.String targetContainerSnapshotAcronym, java.lang.String outputFile)
targetContainerAcronym -
This parameter identifies the target project and is required. Wildcard * is supported and all named snapshots in the server will have theme regenerated.targetContainerSnapshotAcronym -
This parameter identifies target project snapshot and is optional. If not provided, all named snapshots of the targetContainer will have theme regenerated.outputFile -
The absolute path to the log file for logging the results of the regeneration of theme. If not provided, results will be logged to the system out log file.
public void updateFile(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String fileType, java.lang.String fileName, java.lang.String inputFile)
containerAcronym -
This parameter identifies the target project and is required. Wildcard * is supported and all named snapshots in the server will have theme regenerated.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.fileType -
This parameter identifies the type of server file to be updated. Valid values are Web, Server, and Design.fileName -
This parameter identifies the server file to be updated.inputFile -
This parameter identifies the absolute path of the input file to override the current file.
public void createSnapshot(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotName, java.lang.String containerSnapshotDescription)
containerAcronym -
This parameter identifies the target project and is required. Wildcard * is supported and all named snapshots in the server will have theme regenerated.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.containerSnapshotName -
This parameter identifies the name of the snapshot to be created.containerSnapshotDescription -
This parameter identifies the description of the snaphsot to be created.
public void updateDependency(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String toolkitAcronym, java.lang.String toolkitTrackAcronym, java.lang.String toolkitSnapshotAcronym)
containerAcronym -
This parameter identifies the target project and is required. Wildcard * is supported and all named snapshots in the server will have theme regenerated.containerTrackAcronym -
This parameter identifies the process application track and is optional. The default value is Main.toolkitAcronym -
This parameter identifies the target toolkit and is required.toolkitTrackAcronym -
This parameter identifies the toolkit track and is optional. The default value is Main.toolkitSnapshotAcronym -
This parameter identifies the toolkit snapshot and is required.