22 June 2023

How to add clearance checks

The following procedure describes how to build an example workflow that adds clearance checks to international applications.

How it works

The image Example workflow shows a workflow that runs when the applicant category is set to international on an application. If the applicant is international, then visa checks are added to the application.

Example workflow
workflow designer example

Build the workflow

Build the workflow as follows:

  1. Create a new scheme: in Business Entities, on the Workflow Service Code of ADMISSIONS with the Business Entity Code of APPLICATION go to the business entity scheme menu button and then selectview schemesView Schemes and then the create new scheme button. Then, define the following:

    • On Scheme details, in Trigger for, select Create.
    • Select add scheme button, and Save and view scheme.
    Scheme details
    the scheme information section highlighting custom name set to application clearance check
  2. On the workflow designer, check that the initial Start activity is present. To add an initial activity, select create activity and then drag the activity to the required position.

    Then, edit the activity: double-click the activity or select the activity and then editand edit the activity as follows:

    • Enter Start in Name and State. Note that when you enter text in Name, the State changes to the same text.

    • Select Initial and For set state.

    • Do not Create any actions.

    Initial activity
    the workflow designer create activity pop up
  3. Add another activity: select the initial activity, then to add the transition and activity, select add transition and activity.

    Transition and activity
    workflow designer example with transition and activity
  4. Edit the transition as follows:

    • Set the Trigger to Auto.

    • Set the Condition to Conditional?

    • Set the condition Type to Action and in Action select IsApplicantCategory and in Action parameter select International. Applications with the applicant category set to international move to the activity.

    The image Conditional transition shows the transition is conditional and the defined condition.

    Conditional transition
    example with conditional transition set to check the applicant category
  5. Edit the activity to add visa clearance checks as follows:

    • In Name, enter Visa Checks. Note that the State automatically becomes the same as the name.

    • Select Create, then in Action, select CreateClearanceChecks.

    • Set the Action parameter: select set, then in Clearance checks to create, select Valid Visa and Visa check (Upload evidence).

    Settings for the activity to move to ready for decision
    workflow designer activity pop up with the visa clearance check settings entered
  6. Add the final activity that ends the workflow process: in Name, enter End and then select Final, as shown in the image Settings for the final activity.

    Settings for the final activity
    the workflow designer create activity pop up with the name set to end
  7. Add a transition Otherwise from the initial activity to the final activity: to add a transition, select the initial activity and thenbutton add transition , then drag the transition arrow to the final transition. Then, edit the transition as follows:

    • Set the Trigger to Auto.

    • Set the Condition to Otherwise

    Transition otherwise
    workflow designer example with otherwise transition linking the inital and end activities
  8. Add a transition from the move to folder transition to the final activity: to add a transition, select the activity and thenbutton add transition , then drag the transition arrow to the final transition. Then, edit the transition as follows:

    • Set the Trigger to Auto.

    • Set the Condition to Always

    Final transition
    workflow designer example with auto transition linking visa checks activity to end activity