One Step Review Collaboration Job

   Journey Manager (JM) The transaction engine for the platform.  |    System Manager / DevOps  |  All versions This feature is related to all versions.

After a user submits an application form, it has to be reviewed and a decision has to be made whether to approve or decline the application. A one step review collaboration job implements the simplest review process, so we will use to illustrate how a collaboration job works. TheJob Example 1 implements the review workflow using the Form - Job Example 1 form, which contains only the fields that are used in the collaboration job. It also explains how attachments are reviewed using the In Form Attachment widget.

The review workflow is shown below.

  1. A user fills in an application form and submits it.
  2. The form goes to the Application Review step where it is reviewed by a member of the Job Reviewer group.
  3. The reviewer may Accept or Reject the application:
    • If it is rejected, the collaboration job moves to the Application Rejected endpoint.
    • If it is accepted, the collaboration job progresses to the Application Approved endpoint and the form is delivered (this step is not shown) .

Configure a Form

Below is the Job Example 1 form, which is built using our Composer product.

The form has the following mandatory fields, which are data extracts, which are populated when an authenticated user is logged into the form space. Forms can use the same Job Controller as long as they have the same data extract fields.:

  • First Name - the Text Field
  • Surname - the Text Field
  • Email - the Email Field

The form also has the optional fields:

  • Test Field - the Text Field.
  • Drivers License - the Inform Attachment Field, which is configured as read-only in the Application Review step.
  • Route Name - the Collaboration Routes Dropdown list.
Note

When the form is opened by the Applicant the Route Name Dropdown is hidden.This is because the Job hasn't started until this form has been submitted. As the form is not a Task that part of a Job and the job context isn't populated in the form data and hence the Available Routes Names are empty. The Route Name Dropdown field will appear when the form is a Task at the Application Review step Available Routed Names Approve and Reject associated with the step are listed in the form data.

Configure Manager

  1. Open the Job Example 1 form.
  2. Confirm that the delivery channel in the Form Details Delivery Channel is set to the Trash Can Delivery.
  3. Click Services of the latest form version to configure its job controller service.
  4. Select the Review and Approval - 1 Step Group Review service as a job template from the Job Controller Service dropdown list and click Save.
  5. Note

    The Job Example 1 form also works with the Review and Approval - 1 Step User Review job controller.

  6. Select the Job Properties tab, which is available for job templates, to customize the job controller under the Step - Application Review section. Properties can use data extracts and other model elements.
  7. Select the Job Example 1 from the Review Form dropdown list.
  8. Select the Job Reviewers from the Reviewer Group dropdown list.
  9. Click Save to update the changes.

  10. Check the Review and Approval - 1 Step Group Review job controller's definitions.

Configure Users and Groups

This example uses the following users, which are the actors in the job definition. The users have access to the Maguire form space and are in the Maguire organization.

Group Login Name Description
Job Applicants anne Anne Applicant Anne is the applicant who submits the application.
Job Reviewers roger Roger Reviewer Roger is the reviewer who reviews the application and belongs to the Job Reviewers group.

However, you can substitute existing users for Anne and Roger. The form can be submitted as an public anonymous user or an authenticated user, but the reviewer has to be an authenticate user.

The Job Example 1 form pre-populates data for an authentication user only. You can customize your form flow by selecting the Authenticated Only from the User Authentication dropdown list, as shown below.

You should also configure the Job Reviewers group by adding Roger to the Group Members in the Members tab.

Now, you can run the example and see how collaboration job works.

Form - Anne

  1. Log on to Manager as Anne.
  2. Open the Maguire form space and select the Forms tab.
  3. Locate the Job Example 1 form and click Direct to display the form in a form space in a new browser tab. If the form requires an authenticated user, It will first redirect to the portal login page. After logging in with the correct credentials, it will redirect you to the form page itself.
  4. Fill in the First Name, Last Name and Email fields.
  5. Upload a copy of a driver license as an image file using the Drivers License field browser and click Submit.
  6. Take a note of the Reference Code of the form submission, T4G7SY in this case, so you can later use as the Job Number.
  7. Click Return to Portal to return to your form space.

Manager - Administrator

This submission creates a collaboration job, which you can check in Manager:

  1. Log on to Manager as an administrator.
  2. Locate the created collaboration job.
  3. Check the collaboration job state, which should be:
    • Current Step - Application Start
    • Current Action - Accept Quote
    • Action Status - Ready.

    This means the collaboration job is available and is waiting to be processed. Form more information, see collaboration job modes.

  4. Click Process Job to execute this collaboration job, so you can test it right away. Manager processes the collaboration job and moves it to the Application Review step, as shown below.
  5. Click View and select the Actions tab for this collaboration job instance to see each action and its status.
  6. Note

    The Application Review - Assign Review entry is assigned to Job Reviewers.

  7. Click Close.

Form Space - Anne

You can see the collaboration job in your Journey Space:

  1. Log on to Journey Space as Anne.
  2. Click History tab to see the Processing Status of the collaboration job.
  3. Log out as Anne

Form Space - Roger

You can review the collaboration job and decide whether to approve or reject it.

  1. Log on to the Maguire form space as Roger.
  2. Click the Tasks tab and select the Group Items checkbox to see the Group Task details as shown below.
  3. Click Claim and Open to open the form and check the Step Name and Job Number. The Drivers License field, which is the inform attachment, is read only. The Route Name dropdown is now populated with the following choices: Approve or Reject.
  4. Select Approve from the Route Name dropdown list and click Submit.
  5. Click Return to Portal on the confirmation page and click Logout.

Manager - Administrator

  1. Locate the collaboration job and click Press Process Job, if its still at the Application Review step.
  2. Check that the collaboration job moves to the Application Delivery step where it waits for the delivery to be completed.
  3. A scheduled job performs the delivery, which runs every 5 minutes by default. However, you can click Trigger Job to execute it right away, as shown below.

Form Space - Anne

  1. Log on to the Maguire form space as Anne.
  2. Select the History tab to see that the application has now been approved now.
  3. Close the form space.

This concludes the example.

Download

You can download the complete code example here.

Next, learn about multi-step group review collaboration jobs.