HelloID-Conn-Prov-Target-AFAS-Profit-Users

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-AFAS-Profit-Users
  • Table of Contents
    • Requirements
    • Remarks
  • Introduction
  • Getting started
    • Provisioning PowerShell V2 connector
      • Correlation configuration
      • Field mapping
    • Connection settings
      • Scope
  • Setup the connector
  • Getting help
  • HelloID docs

Requirements

• HelloID Provisioning agent (cloud or on-prem).
• Loaded and available AFAS GetConnectors.
• In addition to use to the above get-connector, the connector also uses the following build-in Profit update-connectors:

• KnUser

• AFAS App Connector with access to the GetConnectors and associated views.
  • Token for this AppConnector

Tip

For this connector we have created a default set [Tools4ever - HelloID - T4E_HelloID_Users_v2.gcn], which can be imported directly into the AFAS Profit environment.

Note

When the connector is defined as target system, only the following GetConnector is used by HelloID:

• Tools4ever - HelloID - T4E_HelloID_Users_v2
  

Remarks

Important

In view of GDPR, the persons private data, such as private email address and birthdate are not in the data collection by default. When needed for the implementation (e.g. set emailaddress with private email address on delete), these properties will have to be added.

Important

We never delete users in AFAS, we only clear the unique fields and block the users.

Important

InSite is a required field when creating a user. If this field is not mapped, the default value is true. Enabling InSite will automatically enable Pocket.

Important

Profit Windows is a required field when creating a user. If this field is not mapped, the default value is true. Enabling Profit Windows will automatically enable both InSite and Pocket.

Introduction

HelloID-Conn-Prov-Target-AFAS-Profit-Users is a target connector. AFAS-Profit-Users provides a interface to communicate with Profit through a set of GetConnectors, which is component that allows the creation of custom views on the Profit data. GetConnectors are based on a pre-defined 'data collection', which is an existing view based on the data inside the Profit database.

Endpoint	Description
profitrestservices/connectors

The following lifecycle actions are available:

Action	Description
create.ps1	PowerShell create or correlate lifecycle action. Create or correlate AFAS user
delete.ps1	PowerShell delete lifecycle action. Block, remove from all groups and update AFAS user
disable.ps1	PowerShell disable lifecycle action. Block and optionally update AFAS user
enable.ps1	PowerShell enable lifecycle action. Unblock and optionally update AFAS user
update.ps1	PowerShell update lifecycle action. Update AFAS user
configuration.json	Default configuration.json
fieldMapping.json	Default fieldMapping.json

Getting started

By using this connector you will have the ability to update users in the AFAS Profit system.

Connecting to Profit is done using the app connector system. Please see the following pages from the AFAS Knowledge Base for more information.

Create the APP connector

Manage the APP connector

Manual add a token to the APP connector

Provisioning PowerShell V2 connector

Correlation configuration

The correlation configuration is used to specify which properties will be used to match an existing account within {connectorName} to a person in HelloID.

To properly setup the correlation:

1. Open the Correlation tab.

2. Specify the following configuration:

   Setting	Value
   Enable correlation	True
   Person correlation field	PersonContext.Person.ExternalId
   Account correlation field	Medewerker

Tip

For more information on correlation, please refer to our correlation documentation pages.

Field mapping

The field mapping can be imported by using the fieldMapping.json file.

Note

Fill in the correct customer code in the field mapping for UsId.

Connection settings

The following settings are required to connect to the API.

Setting	Description	Mandatory
Base Uri	The URL to the AFAS environment REST services	Yes
Token in XML format	The AppConnector token to connect to AFAS	Yes
Get Connector	The GetConnector in AFAS to query the user with	Yes
Update Connector	The UpdateConnector in AFAS to update the user with	Yes
Create account when not found	When toggled, if the user account is not found, a new the AFAS user account will be created in the create action (only in the create action).
Update on update	When toggled, if the mapped data differs from data in AFAS, the AFAS user will be updated when a update is triggerd.
Update User ID	When toggled, the User ID will be updated if it doesn't match mapped naming convention. Note that this is not advised as this can break certain links in AFAS. Use with care!
Toggle debug logging	When toggled, extra logging is shown. Note that this is only meant for debugging, please switch this off when in production.

Scope

The data collection retrieved by the set of GetConnector's is sufficient for HelloID to provision persons. The data collection can be changed by the customer itself to meet their requirements.

Connector	Field	Default filter
Tools4ever - HelloID - T4E_HelloID_Users_v2	contract start date	<[Vandaag + 3 maanden]
	contract end date	>[Vandaag - 3 maanden];[]

Setup the connector

Tip

Optionally, you can provide additional properties in enable and disable to update, e.g. "EmAd", "Upn". The default example sets these with the AD values. This action is perfomed with entry code "6". For more information on the entry codes, see the AFAS documenation

Tip

Update with the specified properties, e.g. "EmAd", "Upn", etc. The default example sets these with the AD values. This action is perfomed with entry code "1". For more information on the entry codes, see the AFAS documenation

Tip

Optionally, you can provide additional properties in delete to update, e.g. "EmAd", "Upn". The default example clears these values, as the values have to be unique over all AFAS environments. This action is perfomed with entry code "0". For more information on the entry codes, see the AFAS documenation. |

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/