Group Benefits Import API

The Group Benefits Import API is used to import system-level benefit plans (i.e., master benefit plans) into the Admin workspace of ClientSpace. The Group Benefits API allows you to import the plans as a stand-alone process outside of the PrismHR Initial or Ongoing Import API processes.

Note: Please contact your Professional Services team representative or log an extranet case if you are interested in this feature.

Feature Overview

The Group Benefits Import API:

  • Runs through the PrismHR Special Processes scheduled process. The process runs hourly and picks up each active Special PrismHR Processes record with a Process Status of "Queued".

  • Uses the Special PrismHR Processes dataform in the Admin workspace as its queue record. Selecting a Process Type of Group Benefit Import displays the "Group Benefit Import" fieldset, where you choose which PrismHR plans to import.

  • Imports all system-level plans from the selected PrismHR tenant, or only the plans that match a Plan ID, Carrier, Offer Type, or Insurance Class filter.

  • Creates new benefit plan records and updates existing ones. A plan is matched on its Import ID, which is the PrismHR unique plan code plus its effective date (for example, MED01-20270101).

  • Imports all plans into the Admin workspace. The import file and its results can be reviewed in System Admin > Imports > Manage Import.

  • Works in single-tenant and multi-tenant environments. The API Configuration field on each record is used to select the PrismHR tenant.

Before You Begin: Configuration Notes

  • Security: Users must have the AllowSpecialPrismHRProcesses security entity. See Standard Security Entities.

  • API Configuration: An active API Configuration with an API type of PrismHR API must exist for each tenant. Only active PrismHR API configurations appear for selection in the API Configuration field of the Special PrismHR Processes dataform. They display in the drop-down list using the following format: Secondary ID - API Application Name. See Configuring the API Account Information.

  • Carrier Payee IDs: Each carrier organization should have a PrismHR Payee ID in the Carrier Details fieldset of its ClientSpace Organization detail record on the Other Info tab. The import uses the Payee ID to link each plan to its carrier. If you filter by carrier on the Special PrismHR Processes dataform, a carrier without a Payee ID causes the record to fail.

  • Benefit Plan Category Mapping: Each Benefit Plan Category's metadata record lists the PrismHR offer types that belong to it in the Associated Offer Type(s) field of the Benefit Plan Category lookup group. Each PrismHR offer type must map to exactly one category. Plans with no matching category, or with more than one, are skipped. For detailed steps to configure a lookup group, see Configuring Lookups.

  • Import Mapping: The Group Benefits Import API uses an import map header file named PHRAPI_special_groupBenefits*.csv which is preconfigured for you. To view the configuration, see Group Benefits Import PHRAPI Import Mapping.

Topics in this section