ℹ️ Information |
---|
This repository contains the connector and configuration code only. The implementer is responsible to acquire the connection details such as username, password, certificate, etc. You might even need to sign a contract or agreement with the supplier before implementing this connector. Please contact the client's application manager to coordinate the connector requirements. |
- HelloID-Conn-Prov-Target-Facilitor
HelloID-Conn-Prov-Target-Facilitor is a target connector. Facilitor provides a set of REST API's that allow you to programmatically interact with its data. The HelloID connector uses the API endpoints listed in the table below.
Endpoint | Description |
---|---|
/persons | |
/authorizationgroups |
The following lifecycle events are available:
Event | Description |
---|---|
create.ps1 | Create and/or correlate the Account |
update.ps1 | Update the Account |
enable.ps1 | Enable the Account |
disable.ps1 | Disable the Account |
delete.ps1 | Not supported |
permissions.ps1 | Retrieve the permissions |
grant.ps1 | Grant permission |
revoke.ps1 | Revoke permission |
This is Provisioning PowerShell V2 connector. Meaning that the configuration is a little different contrary to a Provisioning PowerShell V1 connector. For more information on how to configure a HelloID PowerShell V2 connector, please refer to our documentation pages.
The mapping plays a fundamental role in every connector and is essential for aligning the data fields between a HelloID person and the target system. The Provisioning PowerShell V2 connector comes with a UI-based field mapping and is therefore, more accessible to a broader audience, including people who may not have a programming background. The mapping can be imported in HelloID using the MappingExportfacilitor.json file
The correlation configuration is used to specify which properties will be used to match an existing account within Facilitor to a person in HelloID.
To properly set up the correlation:
-
Open the
Correlation
tab. -
Specify the following configuration:
Setting Value Enable correlation True
Person correlation field Person.ExternalId
Account correlation field employeenumber
The following settings are required to connect to the API.
Setting | Description | Mandatory |
---|---|---|
UserName | The UserName to connect to the API | Yes |
Password | The Password to connect to the API | Yes |
BaseUrl | The URL to the API | Yes |
During account creation, both the Department
& CostCentre
will be validated on existence within Facililtor.
:exclamation Note, department and costcenter selection is not yet determined, currently using a hardcoded id, instead of wat is listed elseware in this document |
---|
- The
CostCentre
is validated based on thePerson.PrimaryContract.CostCenter.ExternalId
. The result of this validation is acostCentre
object containing theid
. - The
Department
will then be validated based on theid
from thecostCentre
object.
Both the costCentre
and department
must exists within Facilitor.
When either of these validations fail, the account will not be created. If the account does already exist, then the department will not be updated with the new value in this case, but the other attributes will be updated as normal.
Locations can only be used in combination with: building
, floor
and room
. Because the building
, floor
and room
data might absent within the HR source, the locationcode is currently not available within the connector.
Both the enable and disable lifecycle actions, will set the deactivated
property. The value of this property is a [DateTime]
string in format: yyyy-MM-ddTHH:mm:ssZ
.
- ℹ️ Within the disable lifecycle action, the value will be set to the current date.
Updating the account is based on a HTTP.PUT. A partial PUT is supported within Facilitor. Meaning; only the properties that have changed will be updated.
ℹ️ For more information on how to configure a HelloID PowerShell V2 connector, please refer to our documentation pages
ℹ️ If you need help, feel free to ask questions on our forum
The official HelloID documentation can be found at: https://docs.helloid.com/