Exporting Clients

The Export Client to PrismHR process creates a ClientSpace Client entry in Prism. Prism returns a Client Number, which is then stored on the ClientSpace Client Master for the respective Client. Although the Export Client to PrismHR process delivers much of the necessary Prism data, it does not mean that the Client will be fully configured in Prism. You may have to manually configure additional fields in Prism before this Client is ready to accept Employees.

Two business rules prepare a ClientSpace Client for export: ClientMaster.HE_ValidateExportClient and ClientMaster.ExportClientToHRP.

Note: ClientSpace supports exporting Clients to PrismHR in multi-tenant environments (whereby an install has multiple Prism API configurations and where the Client Number may not be unique across Prism database instances.) See Multi-tenant Environments in ClientSpace.

To export Clients:

  1. In the Action Center, click the link Export Client to PrismHR.
    This action executes the validation rule HE_ValidateExportClient and the Business Rule ExportClientToHRP with a Header Action of ExportClient.

  2. A check is made for fields that are required by Prism to create a Client entry successfully:

    • Org Name
    • Org AKA
    • ImportID
    • Org DBA
    • Org County
    • Org Address1
    • Org Address2
    • Org City
    • Org State
    • Org Postal Code
    • CM Contract Type
    • CM Status
    • CM Status Date
    • Org Business Type
    • Org Phone
    • Org Fax
    • Org Email
    • CM Contract Effective Date
    • Org Employer ID Number
    • Admin
    • Legal Entity
    • Processing Team Payroll Specialist
    • User ID
    • Import ID
  3. For missing fields: A Hard Error is thrown indicating the missing fields. The business rule does not execute. The Export Status is set to Failed Validation.
  4. If the Hard Error check passes, this rule sets the Client Master luExportStatus field to Ready and clears the Export Log field.
  5. The Business Rule does the following:
    • Packages the Client data.
    • Issues the data to Prism to create a Client.
    • If the Export fails:
      • NO MESSAGES ARE ISSUED! You must review the Export Status and Export Log fields for results.
      • The Export Status field is set to Failed API, and the Export Log field contains the cause of the failure. Some of the errors may be ClientSpace related, and some may be Prism related. Saved via Business Logic, HRP pipeline.
      • At this point, correct the errors before proceeding.
    • If the Export passes, the Export Status field is set to Client Export Complete. The Client Number is populated with the value provided by Prism. Saved via Business Logic, HRP pipeline.
  6. Complete the Client in Prism.

To view fields that can exported from ClientSpace to Prism:

Open the ClientSpace-PrismAPI Data Mapping spreadsheet.