Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Configuring Directed Web Access

Updated on March 29, 2022

Configure the Directed Web Access (DWA) capability to support external assignments in a case. By collecting information from stakeholders who are outside of your organization, you can extend the scope of your application and provide necessary details for case processing.

For example, in a mortgage loan application, for the house valuation stage, you need a note from an external agency that does the valuation of the house. To request the note, send an email link, and then attach the received note to the loan case.
Before you begin: To give an external party a one-time directed web access to perform an action, ensure that the flow in which you want to use DWA already exists. For more information, see Creating a top-level case type.
  1. Update the operator ID for the external user:
    1. In the header of Dev Studio, click ConfigureOrg & SecurityOrganizationOperators.
    2. In the list of operators, search for and open the External operator ID.
    3. On the Profile tab of the operator rule form, in the Access Group section, add a new access group item that gives external users access to your application rulesets.
      For example: The following figure shows adding an access group for the external user:
      Adding a new access group for the external user
      Note: For security reasons, give the external users only the minimum necessary access to the rulesets of your application.
    4. On the Work tab, in the Team field, add the work group to which the user belongs.
    5. On the Security tab, ensure that the License type field is set to Invocation and that the Use external authentication and Disable Operator check boxes are empty.
    6. Click Save.
  2. Update the Public Link URL:
    1. In the header of Dev Studio, click ConfigureSystemSettingsURLs.
    2. Complete the Public Link URL field with the URL that you want to convey to external users.
      For example: Enter http://mysystem/prweb/.
      Note: The value of the URL might reference a proxy server other than your Pega Platform server.
  3. Ensure that you have a valid email account and that the system is configured to send and receive email:
    1. In the header of Dev Studio, click ConfigureIntegrationEmailEmail Accounts.
    2. Create an email account in the appropriate class group.

      For more information, see Creating an email account.

    3. Click the Test connectivity link and ensure that you have the outbound email rule for the application running.
  4. Configure a correspondence rule that contains the DWA URL:
    1. Create a correspondence rule of the Rule-Obj-Corr type.
      For more information about how to open a create rule form, see Creating a rule.
    2. In the correspondence rule form, in the Label field, enter a name that starts with External.
      For example: Enter External_Corr.
    3. In the Correspondence Type field, select Email.
    4. Click Create and Open.
    5. In the correspondence rule form, add an external correspondence fragment, such as ExternalInstructions, ExternalDWAInstructions, or workLink, by clicking the Insert Rule button, and then click Save.
      For example: The following figure shows adding the ExternalInstructions correspondence fragment:
      Including the ExternalInstructions correspondence fragment to the correspondence rule
  5. Add the external user as a work party for your case type:
    1. In the navigation pane of Dev Studio, click Case types, and then click the case type that you want to open.
    2. On the Settings tab, click Participants.
    3. In the Participant configuration form, in the Role name field, enter the operator ID for the external user.
      Note: Ensure that you use the operator ID, not the operator description:
      Operator ID on the edit operator form

      For more information about how to configure a case participant, see Defining case participants.

    4. In the Data transform field, enter a name for a new data transform.
    5. In the data transform configuration form, on the Definition tab, in the Target field, enter .pyWorkPartyUri.
      Each party represented in a work object has a unique identifier, recorded in the pyWorkPartyUri standard property. Depending on the class or other processing, it can be an operator ID, email address, account number, or other information.
    6. In the Source field, enter the operator ID for the external user.
      For example: The following figure shows a data transform for mapping a user identifier with the external user role:
      Data transform configured to map the property that identifies users and the operator ID for the external user
    7. Click Save.
    8. Select the Create participant automatically when the case starts check box.
    9. Click Done.
    10. Click Save.
  6. Configure the assignment shape:
    1. In the navigation pane of Dev Studio, click App.
    2. On the Classes tab, expand the case type in which you want to edit the assignment, and then click ProcessFlow.
    3. In the Flow form, on the Diagram tab, double-click an assignment.
    4. In the Assignment properties dialog box, in the Routing section, from the Route to list, select Custom.
    5. In the Assignment type list, select External.
    6. In the Router field, select ToWorkbasket, and then provide the name of the work queue to which you want to route the assignment.
    7. In the Advanced section, click the Assignment details node, and then, in the OperatorModel field, select the operator ID for the external user.
    8. In the DaysToExpiration field, enter the number of days after which the DWA link expires and the external user can no longer open the assignment.
    9. In the Party field, enter the operator ID, for example External.
    10. In the Subject field, enter the email message subject.
    11. In the HarnessPurpose field, select PerformExternal.
    12. Click Submit.
    13. Click Save.
Result: At run time, the system identifies the party that is also an email recipient to receive the email correspondence, and then enters a subject line and message. The system creates the external assignment. The flow pauses until the external party completes the external assignment. The link in the external assignment does not require login, but the user can use it only once.
  • Previous topic Directed Web Access in configuring assignments for external users
  • Next topic Configuring a data model for a case

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us