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:
- 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. -
A check is made for fields that are required by Prism to create a Client entry successfully:
ClientSpace Fields
PrismHR Fields
Form
Field Name
Form
Field Name
Workspace
ProjectID
N/A
N/A
Client Master
PKID
N/A
N/A
Organization
DBA
Client Details - Detail
Client Name (DBA)
Organization
Client Name
Client Details - Detail
Legal Name
Client Master
Legal Entity
Client Details - Detail
Employer
Client Team
Payroll Rep
Client Details - Account
Payroll
Client Master
Contract Type
Client Details - Detail
Service Type
Organization
County
Unknown
Unknown
Organization
Address1
Client Details - Detail
Address1
Organization
City
Client Details - Detail
City
Organization
State
Client Details - Detail
State
Organization
ZipCode
Client Details - Detail
Zipcode
N/A
DeliverChecks
(Always set to "H")
Client Details - Payroll
Deliver Checks To
Organization
Address2
Client Details - Payroll
Address 2
Organization
Contract Type
Client Details - Detail
Client Category
N/A
Cost Center
(Always empty)
Client Details - Detail
Cost Center
Organization
TelephoneExt
(PrismHR currently does not
support exporting extension.
Attempting to export it
results in error message.)
Client Details - Detail
Phone
Organization
Phone
Client Details - Detail
Phone
Organization
Fax
Client Details - Detail
Fax
Organization
Email
Unknown
Unknown
Organization
FEIN
Client Details - Tax
Federal Employee ID Number
Client Team
HR Rep
Client Details - Account
Human Resources
Client Team
Sales Rep
Client Details - Account
Sales
Location
Location Code From Primary Location
Worksite Location
Location
Client Master
Client Number
Client Details - Detail
ClientID
Client Master
StatusDate
Client Details - Detail
Status Date
Client Master
ContractDate
Client Details - Detail
Contract Date
- 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.
- If the Hard Error check passes, this rule sets the Client Master luExportStatus field to Ready and clears the Export Log field.
- 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.
- Complete the Client in Prism.
To view fields that can exported from ClientSpace to Prism: