HelloID-Conn-Prov-Target-Facilitor

Important

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.

Table of contents

• HelloID-Conn-Prov-Target-Facilitor
  • Table of contents
  • Introduction
  • Getting started
    • Provisioning PowerShell V2 connector
      • Field mapping
        • Complex mapping
          • FamilyName
          • Mail
      • Correlation configuration
    • Connection settings
    • Remarks
      • Department & CostCentre validation
      • locationcode
      • Enable / Disable
      • Updating using a HTTP.PUT
  • Getting help
  • HelloID docs

Introduction

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

Getting started

Provisioning PowerShell V2 connector

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.

Field mapping

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

Correlation configuration

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:

1. Open the Correlation tab.

2. Specify the following configuration:

   Setting	Value
   Enable correlation	True
   Person correlation field	Person.ExternalId
   Account correlation field	employeenumber

Connection settings

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

Remarks

Department & CostCentre mapping

Both the costcenter and department use mappings to align HR data with the correct id within Facilitor. The connector will verify if these exist; if not, an error will be thrown and the account will not be created.

The CostCentre is mapped based on the Person.PrimaryContract.CostCenter.ExternalId. The Department is validated using the id from the Person.PrimaryContract.Department.ExternalId object.

A default mapping for both is included.

Enable / Disable

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.

Tip

Within the disable lifecycle action, the value will be set to the current date.

Updating using a HTTP.PUT

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.

Getting help

Tip

For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages.

Tip

If you need help, feel free to ask questions on our forum.

HelloID docs

The official HelloID documentation can be found at: https://docs.helloid.com/