Release 154 Notes

Added New User GET Method to Version 3.0 of the ClientSpace API

The following new User GET method has been added to the ClientSpace API:

GET/api/user/v3.0/{id}

This method retrieves a single User and associated details specified by the primary key (ID) requested.

Note: An example model for client developers listing 18 exposed fields can be found in the Swagger interface by expanding the Dataform section and then expanding the GET/api/user/v3.0/{id} method.

Added the Ability to Require an Acknowledged Disclaimer and Related Workflow

You can now require users to acknowledge one or more disclaimers in BPM. Disclaimer(s) are added as links to the BPM Signature page. BPM users cannot finalize their selections in BPM without checking an acknowledgment that they have read and understood the disclaimer(s).

Their acknowledgment is tracked on the related Benefits Batch record in the Disclaimer Reviewed field once the acknowledgment is checked and the client review is finalized.

If the user does not acknowledge the disclaimer(s) they cannot finalize selections. The following message displays:

See:

• Configuring BPM Disclaimers

• BPM Option 1: Reviewing, Selecting, and Approving Benefits With Prior Batch History

• BPM Option 2: Reviewing, Selecting, and Approving Benefits - No Prior Batch History

Added "Using BPM" Lookup to Allow Hiding of Certain Workflow Links when BPM is Used

A new lookup field named Using BPM has been added to the Benefits Batch field to display or hide Action Center Links in a way that supports BPM workflow if BPM is used.

The default value in the field is No. Optionally, you can manually set it to Yes if you are using BPM. This will hide the following Action Center Status links as the status changes are automatically handled by BPM processes.

• Update Selections

• Send for Approval

• Approved

Note: Preconfigured custom link condition configuration (System Admin > Advanced > Custom Links) of these links is used to trigger the display or removal of the links based on your selection in the Using BPM field.

• Update Selections - The link condition configuration is set to display the Updated Selections link when the Benefits Batch Status = Client Review AND Using BPM ≠ Yes (i.e., is No or cleared). This means that when Using BPM is set to No (or has been cleared) and the batch is in Client Review Status, the link is displayed. When Using BPM is set to Yes, regardless of Status, the link is hidden.

• Send for Approval - The link condition configuration is set to display the Send for Approval link when the Benefits Batch Status = Update Client Selection AND Using BPM ≠ Yes (i.e., is No or cleared). This means that when Using BPM is set to No (or has been cleared) and the batch is in Update Client Selection Status, the link is displayed. When Using BPM is set to Yes, regardless of Status, the link is hidden.

• Approved - The link condition configuration is set to display the Send for Approval link when the Benefits Batch Status = Sent For Approval AND Using BPM ≠ Yes (i.e., is No or cleared). This means that when Using BPM is set to No (or has been cleared) and the batch is in Sent For Approval Status, the link is displayed. When Using BPM is set to Yes, regardless of Status, the link is hidden.

See Finalizing a Benefits Batch for BPM and Sending for Client Review.

Updated Benefit Premium Basis Metadata Lookups

The following changes have been made to the Benefit Premium Basis metadata lookup group:

• Previously, there were three Premium Basis lookup values for plan classifications:

  • Per $10,000 of coverage

  • Per $1,000 of salary

  • Per employee per month

  Now, three additional plan classification lookup values have been added:

  • Per $1000 of payroll

  • Per $100 of MONTHLY payroll

  • Per $10 of WEEKLY payroll

• Previously, there was no default Premium Basis set for each Benefit Plan category. Now, the following default Premium Basis lookup values have been set for each Benefit Plan category listed below.

  Note: If you have previously set the Premium Basis for your plans, receiving this update will not override your settings.

  Benefit Plan Category	Default Premium Basis Value
  Health	Per employee per month
  Dental	Per employee per month
  Vision	Per employee per month
  Life Insurance (Company Paid)	Per $1000 of payroll
  Life Insurance (Voluntary)	Per $1000 of payroll
  Long-Term Disability (Company Paid)	Per $100 of MONTHLY payroll
  Long-Term Disability (Voluntary)	Per $100 of MONTHLY payroll
  Short-Term Disability (Company Paid)	Per $10 of WEEKLY payroll
  Short-Term Disability (Voluntary)	Per $10 of WEEKLY payroll
  Supplemental	Per employee per month
  Bond	Per employee per month
  Other	Per employee per month

See Configuring the Benefit Plan Category Premium Basis.

Updated the "Open to BPM = No" Business Rule

Previously, the Open to BPM = No business rule was only used to set the Open to BPM field value to No on the Benefits Batch when the Status field is not set to "Client Review". Now, the functionality has been expanded to also trigger a "Not Authorized" error message when a user with an external link attempts to access the Benefits Batch in BPM.

Users are prevented from accessing all pages of BPM. For example, if a user bookmarked the URL to the Selection Summary, the link will no longer work. Regardless of whether the URL leads to the Welcome page, Batch Summary, Group Summary, or Selection Summary, the same message displays. This change ensures that users cannot make changes to a Benefits Batch when access has been disabled.

See Configuring BPM Business Rules.

Updated Benefit Plan Lookup Values to Display Effective Date and Plan Title

Previously, when you opened the Benefit Plan drop-down list on an Offered Benefits Plan, the list values were not sorted. Now, the list is sorted by Effective Date and then by Plan Name (i.e., Plan Name within Effective Date), with the newest plans displaying first.

Note:

• Plans that have the same Effective Date are sorted alphabetically by Plan Name within the Effective Date.

• Special characters in a Plan Name are sorted before letters.

Completed Phase 1 of User Admin for Non-Global Admins Feature

We are currently working on adding a base module that will allow users who are not Global Administrators (such as Supervisors) the ability to manage the user profiles of their reports. In Phase 1, we completed laying the groundwork for this functionality and plan to have a releasable feature in the next ClientSpace update (ClientSpace Release 155).

Added _HE_CustomMessage and __SE_CustomMessage Business Rule Methods

Two new business rule methods were added to allow you to configure a rule that displays a custom hard or soft error message on a dataform based on the conditions defined for the business rule (System Admin > Advanced> Manage Business Rules). Enter the custom message in the Error Message Override field of the hard error (_HE_CustomMessage) or soft error (_SE_CustomMessage) business rule configuration form as shown in the example below:

Once configured, when a hard error is triggered, users are unable to continue the Save process until the specified condition is met. When a soft error is triggered, a Save Anyway option allows users to continue the Save process without meeting the condition.

See Business Rule Methods.

Added Email Template Merge Procedure

A new email template merge procedure named peo_employee_emailtemplate_merge_proc has been added to the Merge Procedure field drop-down list of the Email Template configuration Step 1: Initial tab when the Triggering Form field is set to Employee. The procedure adds all Replace fields which were already included with the peo_merge_ee_termination email template merge procedure plus the following additional Replace fields to Email Template Configuration Step 2: Content:

How this can help: Use the additional fields to generate notifications, such as COBRA notices.

Deleted "Create Benefits Group" Business Rule

The Create Benefits Group business rule has been deleted. This rule was no longer recommended for use as it incorrectly created an extra placeholder benefit group named "Main" even when Benefits Groups had already been created.

Added the Ability to Specify a Contact Type as an Email Template Recipient

On Step 3: Addresses of Email Templates, there is now a new Source named Contact for both the To and CC Types. Once the Source is identified as Contact, you can then select the Contact Type in the Address field.

When triggered, the email template is distributed to all Active contacts with the selected Contact Type associated with the triggering workspace.

Note: 

• The Contact Type lookup field must be associated with the ContactTypeOtherInfo lookup group for this to work.

• On Step 3: Addresses of Email Templates, when Contact is selected as the Source, the Supervisor field is inaccessible and marked N/A.

See Step 3: Addresses.

Updated Uploaded Files Queue Quick Search to Include Signers and Log Data Wildcard (%) Search

The Signers and Log Data fields have been added to Quick Search (%) Search Fields (contains) on the Uploaded Files Queue dashboard (System Admin > Imports> Uploaded Files Queue). The Quick Search tooltip has also been updated to reflect this change.

Added Ability to Configure Numeric Datatype "Between" Searches on Custom Module Dashboard "More" Search Fields

A new Search Operator drop-down field has been added to the Dataform Admin (System Admin > Advanced > Dataform Admin) Field Properties form containing two values: Equals and Between. Use the new field to configure a module dashboard "Between" search on numeric datatypes (i.e., Integer, Decimal, Percentage, and Money) within a specified range or reapply the default "Equals" search functionality.

When a "Between" search is configured, two fields for entering the search range are added to the More search of the associated module dashboard as shown in the example below of a custom Cases module dashboard (not the out-of-the-box Cases 2.0 module which cannot be customized). Case Cost, a user-defined Money datatype field, has been configured as a "Between" search:

Note: 

• The default search functionality used for numeric datatype More searches defaults to "Equals" behavior even when nothing is selected (which is the pre-existing functionality).

• This functionality cannot be used on modules that are built into the product, like those that include fields from other forms, such as Employees using "PEOID" or Benefits Batches using "Plan Types". They cannot be customized. These modules often have URLs like ~/peo/employee or ~/peo/benefitsbatch/index, which indicate they are tied to specific system functionality rather than just a standalone dataform. You can use this functionality on modules you created, such as a custom dataform that you configured to open as a module. (See Configuring a Dataform to Open as a Module.) You can use the feature on any module that pointing to a dataform and has no deeper system dependencies.

Tips:

• If you type 1 as the beginning range or "from" value and leave the "to" value blank, all values above 1 are returned.

  

• If you type -1 as the ending range or "to" value and leave the "from" value blank, all negative values below -1 are returned.

  

See Adding Dataform Fields.

Added Subscriber Filter to Cases 2.0 Module "More" Search

A Subscriber search option has been added to the "Advanced Filters" section of the Cases 2.0 module More search.

See Searching Cases and Tasks.

A customer reported receiving the following error message when they attempted to save a new dataform with a long name: "Whoops! Something went wrong during the save. Please contact your administrator if this issue persists." This was happening because the user interface appeared to allow 100 characters when the character limit was capped at 50 in the database. Now, the following changes have been made:

• The character limit on the UI and in the database is now 95, including spaces. (This is five characters short of 100 to allow ClientSpace to prepend gen_z to the dataform name, which distinguishes it and the associated table as a custom dataform created by a customer and not a system table/dataform.)

• Added the following new hard error message when a user exceeds the character limit: "Dataforms names cannot exceed 95 characters in length, including spaces."

Previously, if you changed the Contribution Method on an offered plan in BPM from an "Employee Plus Dependent" contribution method that included a dependent percentage to different contribution method that did not include a dependent percentage, the dependent percentage from the previously selected contribution method did not clear. This has been corrected.