It has been a common requirement to have a single LiveCycle ES2 orchestration that can be used for comparing the performance of LiveCycle ES2 on various software and hardware platforms.
Within Adobe’s eTech team in Technical Marketing, we have been using a short-lived orchestration for this in LiveCycle ES which has been tremendously useful. We have improved it for ES2 and are publishing it for general use. You can download the LCA. View screenshot.
For those new to developing LiveCycle orchestrations, this can be used as a reference implementation. However, please note that setting this orchestration up requires significant amount of work if you are new to LiveCycle.
REQUIRED LIVECYCLES ES2 MODULES
- Forms ES2
- Reader Extensions ES2
- Digital Signatures ES2
- Rights Management ES2
HOW TO CONFIGURE THE ORCHESTRATION
Import the LCA
1) Login to LiveCycle Admin UI at http://server:port/adminui
2) Navigate to Services->Applications and Services->Application Management
3) In the “LiveCycle Applications (9.x) tab, click on ‘Import’, browse your way to where you downloaded the LCA and click ‘Preview’
4) Check the checkbox for ‘Deploy assets to runtime when import is complete’. Click ‘Import’
5) Verify that a green check icon is shown next to “LiveCycle_Benchmark” under the column “Deployed”
5) Verify by navigating to Services->Applications and Services->Service Management. Filter using the Category ‘LiveCycle_Benchmark’ and make sure that a service called ‘LiveCycle_Benchmark/Processes/LiveCycle_Benchmark: 1.0″ is in the ‘Running” state.
Configure the Orchestration
1) Login to LiveCycle Workbench ES2
2) In the ‘Process Design’ perspective, in the ‘Applications’ tab, choose the menu File->Get Application. (You are “getting” it from the server).
Expand the LiveCycle_Benchmark node, highlight its child node and click OK.
3) In the ‘Applications’ tab, expand ‘LiveCycle_Benchmark’ and navigate down one level. Highlight it and click OK.
4) In the Applications frame on the left, navigate down to LiveCycle_Benchmark->LiveCycle_Benchmark/1.0->Processes->LiveCycle_Benchmark. Highlight it, right-click the mouse and choose ‘Check Out’
5) Right-click the mouse again and choose ‘Open’
CONFIGURE SERVICE PROPERTIES
Choose the menu option Window->Show View->Process Properties.
Configure FOUNDATION : Read XML form data from disk
1) Click on the FOUNDATION – Read XML form data from disk’ activity (icon).
2) Download this XML file (instead of clicking the link, right-click and choose “Save Target As”) and copy it to a folder on the server.
3) On the left, make sure you that the ‘Process Properties’ window is available. Copy-paste the full path to this XML file to the ‘Filename’ field.
Cofigure FOUNDATION : Read PDF from disk
1) Click on the FOUNDATION’ activity (icon).
2) Download this PDF file (instead of clicking the link, right-click and choose “Save Target As”) and copy it to a folder on the server.
3) On the left, make sure you that the ‘Process Properties’ window is available. Copy-paste the full path to this PDF file to the ‘Filename’ field.
Configure RIGHTS MANAGEMENT
1) Create a local user named ‘rm_usr’ in the ‘DefaultDom’ domain and give it the ‘LiceCycle Rights Management End User’ role
2) Using the AdminUI, enable the users beloging to the ‘DefaultDom’ to be visible to the ‘Global Policy Set’
3) Create a new policy in the ‘Global Policy Set’ called ‘test_policy’. Add the user ‘rm_user’ to the policy as having ‘Print’ privileges only. Configure a validity of 365 days, audit the document, offline lease should be 5 days, enable ‘Dynamic Watermark’, Encryption algorithm and keylength should be 128 bits, and choose to ‘Encrypt all document contents except metadata’.
4) Save the policy
5) Enable the policy
6) Logout of Workbench and log back in.
7) On the left, make sure you that the ‘Process Properties’ window is available. Ensure that in the ‘Input’ section, values for ‘Polcy Set’, ‘Policy’, ‘Publisher Username’, and ‘Domain’ are properly populated.
Configure DIGITAL SIGNATURES
1) Download this document signing credential (instead of clicking the link, right-click and choose “Save Target As”).
2) Configure it using the LiveCycle AdminUI. Navigate to Settings->Trust Store Management->Local Credentials. Name it “DOCSIGN_CREDENTIAL”. Password is “password’. make sure that you check the box for ‘Document Signing Credential’.
3) Logout of Workbench and log back in.
4) On the left, make sure you that the ‘Process Properties’ window is available. Ensure that in the ‘Common’ section, the values for ‘Certifying Credential Alias’ is properly populated.
Configure READER EXTENSIONS
1) Click on the READER EXTENSIONS activity (icon).
2) If you have not configured a Reader Extensions credential, you will get a message to that effect. To configure one, navigate to Settings->Trust Store Management->Local Credentials.
3) Configure a Reader Extensions credential and then choose its name from the dropdownlist next to ‘Credential Alias’ in the ‘Input’ section of the ‘Process Properties’ window (you might have to log out and log back in if this list is empty)
4) Ensure that the checkbox for ‘Digital Signatures’ is checked.
5) Also choose the radiobutton for ‘No’ for ‘Count Credential Usage’, if this is a load test.
Check-In the Changed Orchestration
1) In Workbench, in the Applications frame on the left, navigate down to LiveCycle_Benchmark->LiveCycle_Benchmark/1.0->Processes->LiveCycle_Benchmark. Highlight it, right-click the mouse and choose ‘Check In’
2) Right-click the mouse and choose ‘Deploy’ to deploy the changed orchestration.
3) Navigate up to LiveCycle_Benchmark->LiveCycle_Benchmark/1.0. Right-click the mouse and choose ‘Deploy’.
4) Navigate down to LiveCycle_Benchmark->LiveCycle_Benchmark/1.0->Processes->LiveCycle_Benchmark. Highlight it, right-click the mouse and choose ‘Invoke’.
5) Click OK to the “…has no input variables’ dialog.
6) Make sure you get a document back. If not, check the server log and fix the problem(s). To view the document, you have to configure your Reader/Acrobat to login to the LiveCycle server.
7) If you get exceptions, fix them iteratively. If there are no exceptions, you should get a finished dialog. Click on view document.
HOW TO TEST
You can invoke the orchestration from a browser using its REST endpoint:
You can also use Apache Jakarta JMeter to set up a load test.
CONFIGURE LIVECYCLE CLIENT AND SERVER FOR SSL
See here for instructions.
REPORTING TEST RESULTS
To compare results of one test against another, three parameters are necessary:
- throughput achieved in transactions per hour
- mean elapsed time for those transactions
- number of concurrent requests at any given point in time
Example : 3,700/hr @ 3.8 seconds @ 4 concurrent requests
Start with one user/thread and increase it by one until the server CPU(s) saturate. This is called a “step test”. The throughput achieved at the point where the CPUs saturate is the maximum achievable throughput on that particular hardware. If you increase the concurrent request load beyond that point, mean elpased time will deteriorate significantly.