Workflow Validation Codes in PICSWeb

This section is only available if you have the Workflows licence. Please Get in Touch if you are interested in using this feature.

When you Create a New Validation for a learner Workflow Transition, you will need to choose the Validation Code, which controls the type of validation check that will take place. Each of these types works differently and affects the rest of the creation process.

This page explains each of the codes and how they work.

Compare Field

The Compare Field validation code allows you to identify a certain field in the record and compare it against an absolute value or another PICSWeb field. This process is made up of the following steps:

Source Options

This is where you identify which field you want to use for the comparison. This is referred to as the Source Field.

The first step allows you to specify the Record Type where you want to find the source field. This could be the main record linked to the workflow, or a child record attached to that main record. Depending on the workflow type, the following options are available:

Workflow Type

Record Type

Location

Workflow Type

Record Type

Location

Learner

Learner

The entire Learner Record

Review

Reviews tab in the Delivery Plan

Component

Components tab in the Delivery Plan

Appointment

Calendar in the Delivery Plan

Call

Communications tab in the Learner Summary

Email

Communications tab in the Learner Summary

Applicant

Applicant

The entire Applicant Record

Appointment

Calendar in the Applicant Summary

Call

Communications tab in the Applicant Summary

Email

Communications tab in the Applicant Summary

Once you have chosen the record type, you can then search for the specific Field Name from the drop-down menu.

If you choose a date field in the Field Name drop-down, you can use the date options underneath:

  • Add Days – Here you can choose a number of days to add on to whatever date is found in the source field. This means that when you compare the date against a value, this modified date will be used instead of actual value in the source field.

  • Working Days – If this is ticked, the Add Days number above will add on working days only, rather than all 7 days of the week.

  • Date Only – If this is ticked, any fields that include both a date and time will only have the date included in the comparison.

Operator Options

After choosing the value to compare, the next step allows you to specify how the source field will be compared against the target. The following options are available:

  • Equals – This means that validation will only be passed if the source field equals the target.

  • Not Equals – This means that validation will only be passed if the source field does not equal the target.

  • Greater Than – This means that validation will only be passed if the source field is greater than the target.

  • Less Than – This means that validation will only be passed if the source field is less than the target.

  • Is Set – This means that validation will only be passed if a value has been entered into the source field. As this does not require another value to compare against, if you choose this option you will skip the other steps in the process.

  • Is Not Set – This means that validation will only be passed if no value has been entered into the source field. As this does not require another value to compare against, if you choose this option you will skip the other steps in the process.

Select Target Type

If you have set Equals, Not Equals, Greater Than or Less Than as the Operator, then you will need a Target to compare the source field against. This step allows you to specify what kind of target you want to use. The following target types are available:

  • Static Value – This allows you to specify a constant value to compare the source field against.

  • Lookup Field – This allows you to specify a target field in PICSWeb data to compare the source field against.

  • Built In Function – This should only be used if the source field is a date value. It allows you to compare the source field to a date relative to the date that the validation takes place.

The Target Options for each type are explained below.

Target Options

This final step allows you to specify the actual target value or field that the source field will be compared against.

If the Target Type is set to Static Value, a field will be available for you to enter the value.

If the Target Type is set to Lookup Field, fields will be available to locate the target field. The Record Types and Field Names available here are the same as those for the source field, as shown in the table above.

If the Target Type is set to Built in Function, a field is available to specify the function. Currently, the only available option here is Today, which will set the target value as the date that the validation occurs.

For each target type, the following fields are also available for date values or fields:

  • Add Days – Here you can choose a number of days to add on to the target. This means that the source field will be compared against this modified value rather than the original target value.

  • Working Days – If this is ticked, the Add Days number above will add on working days only, rather than all 7 days of the week.

  • Date Only – If this is ticked, any fields that include both a date and time will only have the date included in the comparison.

Has Child Record

The Has Child Record validation code allows you to check for a certain record linked to the record before the transition can be enacted.

This process is made up of only one step, Source Options. The first drop-down menu is used to specify the Record Type that you want to look for. Depending on the workflow type, the following record types are available:

Workflow Type

Record Type

Location

Workflow Type

Record Type

Location

Learner

Review

Reviews tab in the Delivery Plan

Component

Components tab in the Delivery Plan

Appointment

Calendar in the Delivery Plan

Call

Communications tab in the Learner Summary

Email

Communications tab in the Learner Summary

File

Files tab in the Learner Summary

Tag

Tags are found attached to the learner throughout the learner record.

Form

A list of all WebForms, and the learners they are linked to, can be found in the Form List

Applicant

Appointment

Calendar in the Applicant Summary

Call

Communications tab in the Applicant Summary

Email

Communications tab in the Applicant Summary

File

Files tab in the Applicant Summary

Tag

Tags are found attached to the applicant throughout the applicant record.

Form

A list of all WebForms, and the applicants they are linked to, can be found in the Form List

The other options in this window depend on the Record Type chosen, and allow you to specify a certain Type or Status that the required record must have.

Some types also allow you to specify Date Type. This is used to choose a specific child record to check to see if it has the required Status, Type, or whatever other field you are allows to specify. For example, in the screenshot below, rather than just checking for a Progress Review attached to the learner, only the Most Recent Completed review will be looked at. If the Type for that review is Progress Review, the validation will be passed.

User Has Permission

The User has Permission validation code allows you to check that the user who has tried to enact the transition has a specific User Permission. This process is made up of only one step, Source Options, where you can choose which User Permission is required from the drop-down menu,

User In Group

The User in Group validation code allows you to check that the user who has tried to enact the transition is in a specified User Group. This process is made up of only one step, Source Options, where you can choose which User Group is required from the drop-down menu,