LiveCycle ES provides a means to purge process data by using the LiveCycle ES Java API and web service API. Process data that is generated when a long-lived process is invoked can become too large, resulting in lower LiveCycle ES performance and the use of unnecessary disk space. It is good practice to purge process data when records are no longer necessary. For information about long-lived processes, see Understanding processes.
Note: The ability to purge data was introduced in LiveCycle ES 8.2.
When purging process data, you can purge a specific process or all processes that belong to a category defined in LiveCycle Workbench ES. For example, consider the processes shown in the following illustration.
If you purge process data that corresponds to processes under the Samples - LiveCycle ES category, then all process data that belongs to the MortgageLoan - Prebuilt and SecureDocument processes is deleted. To purge data that belongs to a specific process, specify the name of the process. For example, you can purge process data that corresponds to the SecureDocument process (shown in the previous illustration). Optionally, when purging process data, you can define a filter expression that only purges data that conforms to the filter.
When purging data, it is possible to purge just that process or the process and its child processes. A child process is a process that was instantiated as part of another process execution (for example, the parent process).
Note: The name of the service that is invoked when purging process data is ProcessManager. To create a proxy object that lets you invoke purge data operations by using a web service, specify this WSDL definition: http://localhost:8080/soap/services/ProcessManager?WSDL&lc_version=8.2.1. You must specify &lc_version=8.2.1 because the purge operation was added in LiveCycle ES 8.2. (See Invoking LiveCycle ES Using Web Services.)
Note: This topic discusses how to purge a specific process using a filter as opposed to purging processes that belong to a category.
|
2.
|
Create a ProcessManager Client API object.
|
Include necessary files in your development project. If you are creating a client application by using Java, include the necessary JAR files. If you are using web services, make sure that you include the proxy files.
|
•
|
adobe-utilities.jar (required if LiveCycle ES is deployed on JBoss)
|
|
•
|
jbossall-client.jar (required if LiveCycle ES is deployed on JBoss)
|
For information about the location of these JAR files, see Including LiveCycle ES Java library files.
Create a ProcessManager Client API object
To programmatically purge process data, you create a Process Management ES client object to use the Process Manager Service API.
|
•
|
|
•
|
These operators are expressed as a ConditionEnum enueration value. For example, to specify greater than, you use the following value ConditionEnum.GREATER_THAN.
Condition filters can be combined using logical filters (AndFilter and OrFilter) to build complex expressions. For example:
(approved=true | approved=yes) & date<'January 10, 2008' & customer ~ 'John Doe'
Using complex expressions is the only way to specify multiple process variables in one filter expression. The logical filters are created by using the AndFilter (PurgeFilter left, PurgeFilter right) or OrFilter (PurgeFilter left, PurgeFilter right) constructors, where left and right are other instances of a condition or logical filter.
Note: A filter is only used when purging data that corresponds to a specific process. If you are purging data that corresponds to processes belonging to a category, then a filter is not used.
After you include required library files, create a ProcessManager Client API object, and optionally define a filter, you can purge process data. When purging process data, you can specify the minor and major version of the process and specify whether child process data should also purged.
Tip: You can determine whether process data has been successfully purged by searching for process data using LiveCycle Process Management ES. (See Process Management Administration Help).