Configuring BPM Business Rules

Open to BPM Rules

BPM uses two business rules on the Benefits Batch dataform to automatically set the value in the Open to BPM field to Yes or No:

  • Set Open to BPM to Yes when Client Review: Sets the Open to BPM field value to Yes when the Benefits Batch Status field is set to Client Review. The rule is triggered when the Client Review workflow link is clicked or when Client Review is manually selected in the Status field on the Benefits Batch.

  • Set Open to BPM to No if Not Client Review: Sets the Open to BPM field value to No when the Benefits Batch Status field contains any value other than Client Review and also triggers a "Not Authorized" error message when a user with an external link attempts to access the Benefits Batch in BPM.. The rule is triggered when workflow links are clicked which change the Status to something other than Client Review or when a value other than Client Review is manually selected in the Status field on the Benefits Batch.

Both rules use the _SetFieldValue business rule method.

Configuring "Set Open to BPM to Yes when Client Review"

To configure the "Set Open to BPM To Yes when Client Review" rule:

  1. Go to System Admin > Advanced > Manage Business Rules.

    The Custom Logic Rules dashboard opens.

  2. What do you want to do?

    • To add a business rule: Click Add.

    • To edit an existing rule: Locate the "Set Open to BPM To True when Client Review" rule in the grid, select it, and then click Edit.

    3. The Rule Details form opens.

  3. Complete the following fields:

    Field Name

    Definition

    Table Name

    This is the dataform where this rule will execute when the dataform is saved. Select Benefits Batch.

    Method

    Select _SetFieldValue.

    Rule Title

    The default title is: Set Open to BPM to True when Client Review.

    Description

    'Open to BPM' field is set to 'Yes' when the status is 'Client Review'.

    Primary Source

    Select Benefits Batch.

    Primary Trigger Field

    Select Status.

    Primary Trigger Operator

    Select Equals.

    Primary Trigger Value

    Select Client Review.

    Execution Pipeline

    Set to Default, Imports.

    Execution Order

    This field controls the order in which rules execute. Rules execute from the lowest to the highest number. It may be necessary to look at other rules already configured on this dataform to determine the order of precedence for executing rules. The default is 0.

    Save Action

    Select Both.

    Workspace Template

    Select All Templates.

    sFieldName

    Enter luOpenToBPM.

    SFieldValue

    Enter Yes.

  4. Click Save.

Configuring "Set Open to BPM to No if Not Client Review"

To configure the "Set Open to BPM to No if Not Client Review" rule:

  1. Go to System Admin > Advanced > Manage Business Rules. The Custom Logic Rules dashboard opens.

  2. What do you want to do?

    • To add a business rule: Click Add.

    • To edit an existing rule: Locate the "Set Open to BPM to No if Not Client Review" rule in the grid, select it, and then click Edit.

    The Rule Details form opens.

  3. Complete the following fields:

    Field Name

    Definition

    Table Name

    This is the dataform where this rule will execute when the dataform is saved. Select Benefits Batch.

    Method

    Select _SetFieldValue.

    Rule Title

    The default title is: Set Open to BPM to No if Not Client Review.

    Description

    'Open to BPM' field is set to 'No' when the status is not in 'Client Review'. Also triggers a "Not Authorized" error message when a user with an external link attempts to access the Benefits Batch in BPM.

    Primary Source

    Select Benefits Batch.

    Primary Trigger Field

    Select Status.

    Primary Trigger Operator

    Select Does Not Equal.

    Primary Trigger Value

    Select Client Review.

    Execution Pipeline

    Set to Default, Imports.

    Execution Order

    This field controls the order in which rules execute. Rules execute from the lowest to the highest number. It may be necessary to look at other rules already configured on this dataform to determine the order of precedence for executing rules. The default is 0.

    Save Action

    Select Both.

    Workspace Template

    Select All Templates.

    sFieldName

    Enter luOpenToBPM.

    SFieldValue

    Enter No.

  4. Click Save.

Reject OPBs and Other Save Operation Rules

All BPM Save operations are routed through the BPM pipeline. The RejectOBPs business rule method is used to create the Reject OBPs business rule, a Save operation rule that uses the BPM pipeline and the BPMSubmit Header Action(HdrAction). This is one of the six HdrAction triggers used to create Save operation business rules in BPM. Each unique HdrAction allows tracking of the Save operation source.

 

The HdrAction triggers are as follows:

Save Operation HdrAction Trigger Value

The Welcome Page

 BPMWelcome

When Review Selections is clicked

 BPMSubmit

When a plan is selected, rejected or dropped from Plan Comparison

 BPMPlanSelection

When Contributions or Enrollment Counts are updated

 BPMPlanContribution

When HSA/FSA options are saved

 BPMHSAUpdate

When the Finalize button is clicked

 BPMBatchApprove

 

The example below of Reject OPBs business rule configuration shows how a Save operation business rule is set up for BPM. The Primary Trigger Field = HdrAction, the Primary Trigger Operator = Equals, the Primary Trigger Value = BPM Submit ,and the Execution Pipeline = BPM. For a different save operation, a different Primary Trigger Value would be selected:

Related Topics: