Summary
iPaaS.com Employee records can be written into Revel through the Add/Update Revel Employee FROM iPaaS.com mapping collection. The integration creates a Revel employee the first time a record is transferred and updates that employee on every transfer afterward. Two of the values Revel requires — the employee's PIN and start date — are supplied from iPaaS.com custom fields.
ID Format
Manual Sync ID Format
Enter the iPaaS.com Employee ID — the record identifier iPaaS.com assigns to the employee, not the Revel one.
External ID Format
After a successful transfer, iPaaS.com saves the Revel Employee ID as the external ID on a dedicated external-ID record. That record is the primary match for every subsequent transfer of the same employee, routing it to an update of the existing Revel employee rather than creating a duplicate.
Deleted Record Support
Outbound delete is not part of this collection. It adds and updates records only. Delete mappings are not included in the default templates, and removing an Employee record in iPaaS.com does not remove the matching Revel employee.
Custom Field Support
Revel custom fields are not supported. This collection does, however, read two iPaaS.com custom fields on the Employee record to supply values Revel requires:
RevelEmployeePIN: the employee's Revel point-of-sale PIN.
RevelEmployeeStartDate: the employee's start date.
Subscribers or their MiSP must add both custom fields to their iPaaS.com Employee records and populate them for every employee written to Revel.
Mapping Collection Status
Status: Enabled. This collection has no mapping filter, so every iPaaS.com Employee dispatched to it is processed.
Trigger Events: Create, Update — dispatched by the iPaaS.com Employee outbound triggers the subscriber enables under Outbound Data Flows.
Duplicate or Conflicting Mappings
The Add/Update Revel Employee TO iPaaS.com collection transfers Revel employees into iPaaS.com. Before enabling both directions at once, review the mapping filters on each so a change written by one direction does not immediately flow back through the other, and decide which system is the source of truth for employee data.
Supported Child Collections
None. An employee is written as a single record. The establishment, role, and hourly wage assignment described under Integration Flow is written as part of this collection's own transfer, not through a separate child collection, and its mappings are not configured by default.
System Caveats
Revel Caveats
Required fields. Revel requires a first name, last name, PIN, and start date on every employee it creates, and rejects the record if any is missing.
The PIN must be unique and at most 10 characters. Revel rejects an employee whose PIN collides with an existing one. Revel does not publish the scope over which uniqueness is enforced; confirm the behavior in a staging environment before relying on it in production.
Records are attributed to the configured agent. Revel requires every record to name the user that created and last updated it. The integration supplies the AgentId subscription setting for both; it must be a valid Revel user or writes fail.
Updates are partial. Only the mapped fields are written; values already on the Revel employee that this collection does not map are left untouched.
iPaaS.com Caveats
Two custom fields must exist and be populated. The PIN and start date are read from the RevelEmployeePIN and RevelEmployeeStartDate custom fields on the iPaaS.com Employee record. An employee whose custom fields are empty fails to transfer.
Setup Requirements
iPaaS.com configuration. Add the RevelEmployeePIN and RevelEmployeeStartDate custom fields to the iPaaS.com Employee record and populate them for every employee to be written to Revel. Enable the Employee outbound triggers under Outbound Data Flows for automatic transfers. See the Revel Installation Instructions for the connection and credential setup, including the AgentId value that records are attributed to.
Integration Flow
The iPaaS.com Employee is dispatched to Revel, either by an enabled outbound trigger or by a Manual Sync using the iPaaS.com Employee ID.
The integration matches the employee to an existing Revel employee by its saved external ID. If none exists, a new employee is created; otherwise the existing employee is updated in place, changing only the mapped fields.
If an establishment, role, and wage are supplied for the employee, the integration writes that assignment to Revel after the employee itself — creating it when the employee has none for the establishment, or updating an existing one. This step is skipped when no establishment is supplied, or when neither a wage nor a role is supplied. A failure at this step does not undo the employee create or update.
Mappings
Add/Update Revel Employee FROM iPaaS.com
iPaaS.com data type: Employee
This collection writes an employee's identity, PIN, and start date from iPaaS.com into Revel.
Mapping Type | Source Field (iPaaS.com) | Destination Field (Revel) | Description |
Field |
| FirstName | Required. The employee's given name. Revel rejects the record without it. |
Field |
| LastName | Required. The employee's family name. Revel rejects the record without it. |
Field | Custom field | Pin | Required. The employee's Revel PIN. Must be unique and at most 10 characters. Read from an iPaaS.com custom field. |
Field | Custom field | EmployeeStart | Required. The employee's start date. Read from an iPaaS.com custom field. |
Field |
| Optional. The employee's email address. Revel does not require it, though a value is almost always present. |
Error Handling
Errors are cataloged in the Revel Error Messages reference. Common errors on this flow are a missing required field, a duplicate PIN, and empty PIN or start-date custom fields, each of which Revel rejects.
Testing & Validation
Test Scenarios
Populate the RevelEmployeePIN and RevelEmployeeStartDate custom fields on an iPaaS.com Employee, transfer it, and confirm a Revel employee is created with the expected name, PIN, and start date.
Update the employee's name in iPaaS.com and confirm the change propagates to the existing Revel employee without creating a duplicate.
Transfer an employee with an empty PIN custom field and confirm Revel rejects the record with an error in the error log.
Transfer an employee whose PIN duplicates an existing Revel employee's PIN and confirm the record is rejected.
Validation Checklist
The RevelEmployeePIN and RevelEmployeeStartDate custom fields exist on the iPaaS.com Employee record and are populated.
The AgentId subscription setting is a valid Revel user.
A second transfer of the same employee updates the existing Revel employee rather than creating a duplicate.