How To Implement Directed Web Access
About Directed Web Access
Directed Web Access (DWA) allows anyone with Internet Explorer and email access to perform a Process Commander assignment, even if they do not have a Process Commander operator ID. Assignments sent to such outside parties are called external assignments.
When Process Commander creates an external assignment , it sends an email message to the assignment recipient. The email contains a link to a specially formatted URL, as shown in the red circle.
When the recipient clicks this link, a browser session opens and submits a one-time-only signature token to the Process Commander server. Process Commander evaluates the token to authenticate the external user and displays the assignment in her browser window. The user completes and submits the requested information, which ends the requestor connection. The link can be used only once.
Complete these steps to implement basic DWA in your application:
- Verify Prerequisites for DWA
- Create an Operator ID for the External User
- Configure the URL for your Process Commander System
- Create a Correspondence Rule
- Call a DWA Flow
The following sections describe these steps in detail.
Before you implement DWA on your system, verify that the following prerequisites are in place:
- Process Commander is configured to send outgoing e-mail.
- Process Commander is configured for SSL (optional).
- The flow that will use DWA already exists.
- The external user you want to send the assignment to is a party in the flow's work object.
Complete the following steps to create an operator ID for the external user:
- Create a new Operator ID that starts with the reserved word
- On the Operator tab, specify an access group, organization, and division that provides the external operator with the ability to complete the external assignment. For security reasons, reference an access group that provides only the minimal RuleSet Versions that the external user needs to complete the assignment.
- Click the Security tab. Set the License Type field to
Invocation. Leave the Use external authentication? check box blank.
Complete the following steps to configure your system's base URL:
- Locate the Data-Admin-System-Settings instance named Pega-ProCom.PublicLinkURL. This instance contain a URL that identifies your Process Commander system.
- Set the Value field to the URL that you want to appear to external users. (For example, the URL may reference a proxy server rather than your actual Process Commander server.)
The ExternalInstructions HTML fragment rule, referenced in the correspondence rule that you create in the next step, contains code that uses this value as part of the DWA URL.
Complete the following steps to create a correspondence rule that contains the DWA URL:
- Create a correspondence rule (Rule-Obj-Corr type).
- Set the Correspondence Type field to email.
- Choose a name for the correspondence rule that begins with the word "External".
- In the HTML Source field, use an include JSP tag or directive to copy in the standard correspondence fragment named ExternalInstructions.Emailat the point where you want the DWA URL to appear.:
V5.2 includes two standard flow rules that support DWA:
The flow that your application calls determines the type of processing used for the external assignment:
- For synchronous processing, where flow execution waits until processing on the external assignment is complete before continuing, use the standard Work-.EngageExternal flow action, which starts the EngageExternalQuick flow.
- For asynchronous processing, where the calling flow continues execution while the external assignment is pending, add a spin-off shape in the flow that starts the Work-.EngageExternalForInformation flow.
For a detailed description of these standard flows, see How to extend and tailor basic Directed Web Access.
Calling the Work-.EngageExternalQuick Flow
To call the Work-.EngageExternalQuick flow, add the EngageExternal local flow action to an existing assignment. Complete the following steps to call the flow.
- Include the standard local flow action EngageExternal (or another you have based on that one) as a local flow action in an assignment. When selected, this starts a flow execution of the standard flow Work-.EngageExternalQuick.
- Test the flow. At runtime, the operator uses the EngageExternal flow action to identify the party (or email-addressee) to receive the email correspondence, enter a subject line, and select the correspondence rule.
Adding a Spin-Off Shape That Calls the Work-.EngageExternalForInformation Flow
Complete the following steps to call the Work-.EngageExternalForInformation flow:
- Open a flow for editing.
- Add a Spin-Off shape in the appropriate location.
- Set the value of the Flow Rule field, located in the Spinoff Properties form, to .EngageExternalForInformation.
- Test the flow.