Configuring Benefit Plan API Business Rules

To configure Benefit Plan API business rules:

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

    The Custom Logic Rules dashboard opens.

  2. Mark the relevant business rules Active.

    1. Locate each of the business rules listed in the table below.

    2. Open them (by double-clicking the row or clicking (Open).

      The Rule Detail window displays.

    3. Ensure that the Active checkbox in the bottom left corner of the Rule Details window is checked.

    Dataform

    Rule Title

    Method Name

    Description

    Benefits Batch

    Validate Ben Plan Export

    HE_ValidateBenefitPlanExportToPrism

    Checks for the following occurrences when exporting Offered Benefit Plans to PrismHR and displays an appropriate error message if the validation requirement is not met:

    • The export rule has a PrismHRAPI value entered in the APPCODE field (System Admin > Advanced > Manage Rules > Rule Details form).

    • The Benefit Plan referenced on each selected Offered Benefits Plan exists in PrismHR.

    • An Effective Date is populated on each selected Offered Benefits Plan in the Benefits Batch.

    • There is a working Benefit Plan API configuration record that connects to PrismHR.

    • There are no Offered Benefits Plans on the same Benefit Batch with the same Benefit Plan and Benefit Group combination.

    Benefits Batch

    Export Benefit Plan

    ExportOfferedPlansToPrism

    Exports Offered benefit plans in Selected status to PrismHR.

    Benefits Batch

    Require Open Enrollment Start Date

    _RequireFieldOnThisForm

    Prior to export of any offered plans, this rule requires the Open Enrollment Start Date to have a value.

    Benefits Batch

    Export Benefit Groups to Prism

    ExportBenefitGroupsToPrism

    Exports Benefit Groups to PrismHR.

    Benefits Batch

    Export Benefit Rules to Prism

    ExportBenefitRulesToPrism

    Exports Benefit Rules to PrismHR.

    Benefits Batch

    Validate Offered Plan Required Fields

    HE_ValidateOfferedPlanRequiredFields

    Validates that the Annual Periods field is populated for all Offered Benefits Plans associated with a Benefit Batch.

    Offered Benefits Plan

    Set Expiration Date

    _SetFieldFromRelatedForm

    Sets the Expiration Date from the related master plan in the Admin Workspace.
  1. Click Save on the Rule Details window for each business rule.

Exporting Benefits in Multi-Tenant Environments

ALERT:  Please contact the ClientSpace Professional Services team for configuration assistance before attempting to use the Benefit Plan API in a multi-tenant environment for the first time.

The business logic for the ExportOfferedPlansToPrism, ExportBenefitGroupsToPrism, ExportBenefitRulesToPrism business rule methods work in both single tenant environments (where ClientSpace exports to a single PrismHR database) and multi-tenant environments (where ClientSpace exports to more than one PrismHR database).

To use the Benefit Plan API in a multi-tenant environment, verify the following settings:

  • Verify that the Use Multitenancy field value on the PEO Configuration record (System Admin > Administrative Data > PEO Configuration) is set to Yes.

  • Verify that there is an active API configuration record set up for each PrismHR instance. The Secondary ID field of each multi-tenant API configuration record must contain the PEOID number from the Client Master record associated with that instance.

Once ClientSpace is properly configured, this is what happens when a user clicks the Export Benefits to Prism link:

  • The system evaluates the PEOID on the Client Master record associated with the Client Workspace and attempts to locate an active API configuration record associated with the Client Master PEOID.

    • There must be a matching PEOID value in the Secondary ID field of an active API configuration record to proceed associated with the workspace where the export is being initiated.

    • If the PEOID is missing on the Client Master record, the following warning message displays: "There is no PEOID on this client's Client Master form. Please make sure that a valid PEOID is filled out on this client's Client Master before attempting to export this again."

    • If the PEOID is invalid on the Client Master record (i.e., it does not match to any existing API configuration record), the following message displays: "The PEOID , "{PEOID#}" on this client's Client Master is invalid. Please correct the PEOID on the Client Master before trying to export this again."

  • Once an active API configuration record is located for a valid Client Master PEOID, the offered plans, benefit groups and benefit rules are exported to the correct PrismHR database instance.

Note: In a single tenant environment, ClientSpace uses the default PrismHRAPI API Configuration record to export offered plans, benefit groups and benefit rules to PrismHR .