PALService MBean

Partial ObjectName:
WebSphere:*,type=PALService


MBean PALService

MBean for administering BPM applications.


Operation Summary
voidactivate(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
           Activate a process application snapshot on a Process Center server or a Process Server.
voidcheckOrphanTokens(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)
           Generate a policy file.
voidmigrateInstances(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)
           Migrate instances from the given source snapshot to the given target snapshot.
voidcreateOfflinePackage(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.Boolean skipGovernance)
           Create an installation package for a process application snapshot that can be extracted and be deployed to an off-line Process Center server instance.
voiddeactivate(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
           This command deactivates an active snapshot.
voiddeactivateForce(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.Boolean force)
           This command deactivates an active snapshot including the default snapshot.
voiddeactivateForceSuspend(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.Boolean force, java.lang.Boolean suspendAllBPDInstances, java.lang.String outputFile)
           This command deactivates an active snapshot including the default snapshot and suspends all in-flight instances.
voidinstall(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.Boolean skipGovernance)
           Install a process application snapshot from a Process Center server to a Process Server in a test or production environment.
voidinstallOfflinePackage(java.lang.String inputFile)
           Install a process application snapshot from a Process Center server to an offline Process Server that is not connected to the Process Center.
voidchangeSnapshotStatus(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String newSnapshotStatus)
           Command for changing the status of a snapshot on a Process Center server.
voidarchiveProcessApplication(java.lang.String containerAcronym)
           This command archives a process application.
voidarchiveToolkit(java.lang.String containerAcronym)
           This command archives a toolkit.
voidremoveProcessApplication(java.lang.String containerAcronym)
           Command for removing a process application.
voidremoveToolkit(java.lang.String containerAcronym)
           Command for removing a toolkit.
voidarchive(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
           This command stops a process application snapshot that has already been deactivated on a Process Server.
java.lang.StringgetSnapshotAcronym(java.lang.String containerAcronym, java.lang.String containerSnapshotName)
           Command for retrieving the acronym of a snapshop given the name of the snapshot.
voidexport(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String outputFile)
           Export a process application snapshot from the Process Center server.
voidextractOfflinePackage(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.String outputFile)
           Extract the process application snapshot installation package from the Process Center server.
voidimportSnapshot(java.lang.String inputFile)
           Import a process application into a Process Center Server.
java.lang.StringlistProcessApplications()
           List all process applications and toolkits on a Process Center server or a Process Server.
java.lang.StringlistServers()
           List all of the Process Server instances that are federated into the Process Center server.
voidprocessInstancesCleanup(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)
           Cleanup completed, failed or canceled process instances on a process server.
voidprocessInstancesPurge(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)
           Purge process instances.
java.lang.IntegerprocessInstancesResumption(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String maxNumberOfInstances, java.lang.Boolean getNumberOfInstances)
           Resume suspended process instances or return the number of resumed process instances.
voiddeleteDurableMessages(java.lang.String olderThan, java.lang.String maximumDuration, java.lang.String transactionSlice)
           Delete messages that are stored if durable subscriptions for intermediate message events are enabled on a process server.
java.lang.IntegerreplayOnHoldEMTasks(java.lang.Boolean getNumberOfTasks, java.lang.Integer maxNumberOfTasksToReplay, java.lang.String bpdInstanceId)
           Replay EventManager messages that are on hold because their execution has failed more often than the retry limit.
voiddeleteSnapshot(java.lang.String containerAcronym, java.lang.String[] containerSnapshotAcronyms, java.lang.String outputFile)
           Delete process application snapshots and their dependencies on a Process Server.
voiddeleteSnapshotForce(java.lang.String containerAcronym, java.lang.String[] containerSnapshotAcronyms, java.lang.String outputFile, java.lang.Boolean force)
           Delete process application snapshots and their dependencies on a Process Server.
voidsnapshotCleanup(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)
           Cleanup process application snapshots and their dependencies.
java.lang.StringshowProcessApplication(java.lang.String containerAcronym)
           Show process application data in a Process Center Server or Process Server instance.
java.lang.StringshowServer(java.lang.String serverName)
           List information for a federated Process Server instance in a Process Center server.
java.lang.StringshowSnapshot(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
           List information about a process application or a toolkit snapshot.
java.lang.StringshowSnapshotDependents(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.Boolean showDependents)
           List information about a process application or a toolkit snapshot.
voidstop(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym)
           Stop a process application snapshot that has already been deactivated on a Process Server.
voidundeploy(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
           Undeploy a process application snapshot from a server.
voidsetDefaultSnapshot(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym)
           Change the default process application snapshot of a process application on a Process Server.
java.lang.StringshowInstallMessages(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.Boolean verbose)
           Lists detailed messages from the install of specified snapshot.
voidtasksCleanup(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)
           Cleanup completed tasks on a process server.
java.lang.StringshowInstallStatus(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName)
           Returns the installation status of a snapshot on a server.
voidexportInstallPackage(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String outputFile)
           This command exports an install package from the Process Center server.
voidinstallPackage(java.lang.String inputFile)
           This command enables the installation of a process application snapshot from Process Center server to any Process Servers.
voidupdateInstallationInformation(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName)
           This command associates an installation package of a process application snapshot with an offline Process Center server instance.
voidsyncEnvironmentVariables(java.lang.String containerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String targetContainerSnapshotAcronym)
           Synchronize the environment variables between two snapshots.
voidsyncParticipantGroups(java.lang.String containerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String targetContainerSnapshotAcronym)
           Synchronize the participant groups between two snapshots.
voidsyncEPVValues(java.lang.String containerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String targetContainerSnapshotAcronym)
           Synchronize the EPV values between two snapshots.
voidsetEnvironmentVariable(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String environmentVariableName, java.lang.String environmentVariableValue)
           Set the value of a environment variable for a snapshot.
voidsetECMServerProperties(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)
           Set the properties of a server with type 'Enterprise Content Management Server' for a snapshot.
voidsetWebServiceServerProperties(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)
           Set the properties of a server with type 'Web Service' for a snapshot.
voidsetILOGRulesServerProperties(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.String hostname, java.lang.String port)
           Set the properties of a server with type 'ILOG Rules Server' for a snapshot.
voidsetSAPServerProperties(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)
           Set the properties of a server with type 'SAP Server' for a snapshot.
voidextractMigrationPolicy(java.lang.String containerAcronym, java.lang.String containerSourceSnapshotAcronym, java.lang.String containerTargetSnapshotAcronym, java.lang.String outputFile)
           This command extract a a migration policy file from the Process Center server.
voidupdateTheme(java.lang.String sourceContainerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String themeName, java.lang.String targetContainerAcronym, java.lang.String targetContainerSnapshotAcronym)
           This command extract updates a process application's theme.
voidregenTheme(java.lang.String targetContainerAcronym, java.lang.String targetContainerSnapshotAcronym, java.lang.String outputFile)
           This command regenerate a project's theme.
voidupdateFile(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String fileType, java.lang.String fileName, java.lang.String inputFile)
           This command updates a server file.
voidcreateSnapshot(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotName, java.lang.String containerSnapshotDescription)
           This command create a new snapshot.
voidupdateDependency(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String toolkitAcronym, java.lang.String toolkitTrackAcronym, java.lang.String toolkitSnapshotAcronym)
           This command updates the dependency between a process application and a toolkit.

Operation Detail

activate

public void activate(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
Activate a process application snapshot on a Process Center server or a Process Server.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

checkOrphanTokens

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)
Generate a policy file. The policy file manages the orphaned tokens that may be generated when a process instance of a source snapshot is migrated to a target snapshot.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

migrateInstances

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)
Migrate instances from the given source snapshot to the given target snapshot.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

createOfflinePackage

public void createOfflinePackage(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.Boolean skipGovernance)
Create an installation package for a process application snapshot that can be extracted and be deployed to an off-line Process Center server instance.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

deactivate

public void deactivate(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
This command deactivates an active snapshot. The deactivating function prevents any new requests but allows all existing instances and in-flight requests to complete processing.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

deactivateForce

public void deactivateForce(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.Boolean force)
This command deactivates an active snapshot including the default snapshot. The deactivating function prevents any new requests but allows all existing instances and in-flight requests to complete processing. Using the optional parameters you can also deactivate the default snapshot as well.
Parameters:
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.
Since:
8.5.5.0
Security Roles:
administrator
operator

deactivateForceSuspend

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)
This command deactivates an active snapshot including the default snapshot and suspends all in-flight instances. The deactivating function prevents any new requests but allows all existing instances and in-flight requests to complete processing. Using the optional parameters you can also deactivate the default snapshot as well as suspend in-flight instances.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

install

public void install(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.Boolean skipGovernance)
Install a process application snapshot from a Process Center server to a Process Server in a test or production environment.
Parameters:
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..
Since:
8.5.0.1
Security Roles:
administrator
operator

installOfflinePackage

public void installOfflinePackage(java.lang.String inputFile)
Install a process application snapshot from a Process Center server to an offline Process Server that is not connected to the Process Center.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

changeSnapshotStatus

public void changeSnapshotStatus(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String newSnapshotStatus)
Command for changing the status of a snapshot on a Process Center server.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

archiveProcessApplication

public void archiveProcessApplication(java.lang.String containerAcronym)
This command archives a process application.
Parameters:
containerAcronym - This parameter identifies the process application and is required.
Since:
8.5.6.0
Security Roles:
administrator
operator

archiveToolkit

public void archiveToolkit(java.lang.String containerAcronym)
This command archives a toolkit.
Parameters:
containerAcronym - This parameter identifies the toolkit and is a required parameter.
Since:
8.5.6.0
Security Roles:
administrator
operator

removeProcessApplication

public void removeProcessApplication(java.lang.String containerAcronym)
Command for removing a process application. This would only work if the same process application has been archived.
Parameters:
containerAcronym - This parameter identifies the process application and is required.
Since:
8.5.6.0
Security Roles:
administrator
operator

removeToolkit

public void removeToolkit(java.lang.String containerAcronym)
Command for removing a toolkit. This would only work if the same toolkit has been archived.
Parameters:
containerAcronym - This parameter identifies the toolkit and is a required parameter.
Since:
8.5.6.0
Security Roles:
administrator
operator

archive

public void archive(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
This command stops a process application snapshot that has already been deactivated on a Process Server. It is available only for snapshots that use Advanced Integration services.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

getSnapshotAcronym

public java.lang.String getSnapshotAcronym(java.lang.String containerAcronym, java.lang.String containerSnapshotName)
Command for retrieving the acronym of a snapshop given the name of the snapshot.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

export

public void export(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String outputFile)
Export a process application snapshot from the Process Center server.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

extractOfflinePackage

public void extractOfflinePackage(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.String outputFile)
Extract the process application snapshot installation package from the Process Center server.
Parameters:
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..
Since:
8.5.0.1
Security Roles:
administrator
operator

importSnapshot

public void importSnapshot(java.lang.String inputFile)
Import a process application into a Process Center Server.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

listProcessApplications

public java.lang.String listProcessApplications()
List all process applications and toolkits on a Process Center server or a Process Server.
Since:
8.5.0.1
Security Roles:
administrator
operator

listServers

public java.lang.String listServers()
List all of the Process Server instances that are federated into the Process Center server.
Since:
8.5.0.1
Security Roles:
administrator
operator

processInstancesCleanup

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)
Cleanup completed, failed or canceled process instances on a process server.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

processInstancesPurge

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)
Purge process instances.
Parameters:
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.
Since:
8.5.7.0
Security Roles:
administrator
operator

processInstancesResumption

public java.lang.Integer processInstancesResumption(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String maxNumberOfInstances, java.lang.Boolean getNumberOfInstances)
Resume suspended process instances or return the number of resumed process instances.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

deleteDurableMessages

public void deleteDurableMessages(java.lang.String olderThan, java.lang.String maximumDuration, java.lang.String transactionSlice)
Delete messages that are stored if durable subscriptions for intermediate message events are enabled on a process server.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

replayOnHoldEMTasks

public java.lang.Integer replayOnHoldEMTasks(java.lang.Boolean getNumberOfTasks, java.lang.Integer maxNumberOfTasksToReplay, java.lang.String bpdInstanceId)
Replay EventManager messages that are on hold because their execution has failed more often than the retry limit.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

deleteSnapshot

public void deleteSnapshot(java.lang.String containerAcronym, java.lang.String[] containerSnapshotAcronyms, java.lang.String outputFile)
Delete process application snapshots and their dependencies on a Process Server.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

deleteSnapshotForce

public void deleteSnapshotForce(java.lang.String containerAcronym, java.lang.String[] containerSnapshotAcronyms, java.lang.String outputFile, java.lang.Boolean force)
Delete process application snapshots and their dependencies on a Process Server.
Parameters:
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.
Since:
8.5.5.0
Security Roles:
administrator
operator

snapshotCleanup

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)
Cleanup process application snapshots and their dependencies.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

showProcessApplication

public java.lang.String showProcessApplication(java.lang.String containerAcronym)
Show process application data in a Process Center Server or Process Server instance.
Parameters:
containerAcronym - This parameter identifies the process application and is required.
Since:
8.5.0.1
Security Roles:
administrator
operator

showServer

public java.lang.String showServer(java.lang.String serverName)
List information for a federated Process Server instance in a Process Center server.
Parameters:
serverName - The name of the process server.
Since:
8.5.0.1
Security Roles:
administrator
operator

showSnapshot

public java.lang.String showSnapshot(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
List information about a process application or a toolkit snapshot. If you are not working with a snapshot, it also lists information about the tip.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

showSnapshotDependents

public java.lang.String showSnapshotDependents(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.Boolean showDependents)
List information about a process application or a toolkit snapshot. If you are not working with a snapshot, it also lists information about the tip.
Parameters:
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.
Since:
8.5.5.0
Security Roles:
administrator
operator

stop

public void stop(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym)
Stop a process application snapshot that has already been deactivated on a Process Server. It is available only for snapshots that use Advanced Integration Services.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

undeploy

public void undeploy(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym)
Undeploy a process application snapshot from a server. It is available only if the snapshot uses Advanced Integration Services and has a corresponding business level application (BLA) deployed on the server.
Parameters:
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.
Since:
8.5.0.1
Security Roles:
administrator
operator

setDefaultSnapshot

public void setDefaultSnapshot(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym)
Change the default process application snapshot of a process application on a Process Server.
Parameters:
containerAcronym - This parameter identifies the process application and is required.
containerSnapshotAcronym - This parameter identifies the process application snapshot and is required.
Since:
8.5.0.1
Security Roles:
administrator
operator

showInstallMessages

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)
Lists detailed messages from the install of specified snapshot. This command can aid in problem determination when an install failed or can be used to determine the current installation step when a snapsot is in the process of being installed.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

tasksCleanup

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)
Cleanup completed tasks on a process server.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

showInstallStatus

public java.lang.String showInstallStatus(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName)
Returns the installation status of a snapshot on a server.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

exportInstallPackage

public void exportInstallPackage(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String outputFile)
This command exports an install package from the Process Center server.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

installPackage

public void installPackage(java.lang.String inputFile)
This command enables the installation of a process application snapshot from Process Center server to any Process Servers.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

updateInstallationInformation

public void updateInstallationInformation(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName)
This command associates an installation package of a process application snapshot with an offline Process Center server instance.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

syncEnvironmentVariables

public void syncEnvironmentVariables(java.lang.String containerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String targetContainerSnapshotAcronym)
Synchronize the environment variables between two snapshots.
Parameters:
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..
Since:
8.5.6.0
Security Roles:
administrator
operator

syncParticipantGroups

public void syncParticipantGroups(java.lang.String containerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String targetContainerSnapshotAcronym)
Synchronize the participant groups between two snapshots.
Parameters:
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..
Since:
8.5.6.0
Security Roles:
administrator
operator

syncEPVValues

public void syncEPVValues(java.lang.String containerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String targetContainerSnapshotAcronym)
Synchronize the EPV values between two snapshots.
Parameters:
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..
Since:
8.5.6.0
Security Roles:
administrator
operator

setEnvironmentVariable

public void setEnvironmentVariable(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotAcronym, java.lang.String environmentVariableName, java.lang.String environmentVariableValue)
Set the value of a environment variable for a snapshot.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

setECMServerProperties

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)
Set the properties of a server with type 'Enterprise Content Management Server' for a snapshot.
Parameters:
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].
Since:
8.5.7.0
Security Roles:
administrator
operator

setWebServiceServerProperties

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)
Set the properties of a server with type 'Web Service' for a snapshot.
Parameters:
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.
Since:
8.5.7.0
Security Roles:
administrator
operator

setILOGRulesServerProperties

public void setILOGRulesServerProperties(java.lang.String containerAcronym, java.lang.String containerSnapshotAcronym, java.lang.String serverName, java.lang.String hostname, java.lang.String port)
Set the properties of a server with type 'ILOG Rules Server' for a snapshot.
Parameters:
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.
Since:
8.5.7.0
Security Roles:
administrator
operator

setSAPServerProperties

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)
Set the properties of a server with type 'SAP Server' for a snapshot.
Parameters:
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.
Since:
8.5.7.0
Security Roles:
administrator
operator

extractMigrationPolicy

public void extractMigrationPolicy(java.lang.String containerAcronym, java.lang.String containerSourceSnapshotAcronym, java.lang.String containerTargetSnapshotAcronym, java.lang.String outputFile)
This command extract a a migration policy file from the Process Center server.
Parameters:
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.
Since:
8.5.6.0
Security Roles:
administrator
operator

updateTheme

public void updateTheme(java.lang.String sourceContainerAcronym, java.lang.String sourceContainerSnapshotAcronym, java.lang.String themeName, java.lang.String targetContainerAcronym, java.lang.String targetContainerSnapshotAcronym)
This command extract updates a process application's theme.
Parameters:
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.
Since:
8.5.7.0
Security Roles:
administrator
operator

regenTheme

public void regenTheme(java.lang.String targetContainerAcronym, java.lang.String targetContainerSnapshotAcronym, java.lang.String outputFile)
This command regenerate a project's theme.
Parameters:
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.
Since:
8.5.7.0
Security Roles:
administrator
operator

updateFile

public void updateFile(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String fileType, java.lang.String fileName, java.lang.String inputFile)
This command updates a server file.
Parameters:
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.
Since:
8.5.7.0
Security Roles:
administrator
operator

createSnapshot

public void createSnapshot(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String containerSnapshotName, java.lang.String containerSnapshotDescription)
This command create a new snapshot.
Parameters:
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.
Since:
8.5.7.2
Security Roles:
administrator
operator

updateDependency

public void updateDependency(java.lang.String containerAcronym, java.lang.String containerTrackAcronym, java.lang.String toolkitAcronym, java.lang.String toolkitTrackAcronym, java.lang.String toolkitSnapshotAcronym)
This command updates the dependency between a process application and a toolkit.
Parameters:
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.
Since:
8.5.7.2
Security Roles:
administrator
operator

Copyright IBM Corp. 1996-2014