HR-anslutningen använder Efecte Provisioning Engine (anpassad skriptanslutning) för att läsa data från filen. Anslutningen är utformad för att användas i IGA lösningars användarlivscykelhantering. För att använda den för andra ändamål krävs att skript exporteras från värddatorn och modifieras enligt kundens krav. Observera att det också är möjligt att skapa ett nytt skript från början och använda en anpassad skriptanslutning för att validera och importera det.

HR-anslutningen stöder en eller flera arbetsperioder, så länge arbetsperioderna genereras enligt beskrivningen i kapitlet "generera fil från HR-lösning".

Grundprinciper för HR-koppling,

1. Anslutningen använder extra argument, definierade i den schemalagda provisioneringsuppgiften, för att hitta filen från sökvägen (om extra argument saknas stoppas processen)

2. Filer transformeras till JSON-format (dict) och lagras som JSON

3. Varje fil kan köras som en fullständig eller delvis körning

4. Delvis körning jämför alltid data med den arkiverade filen (om en arkivfil saknas stoppas processen)

5. I JSON-formaterade filer är alla mappade attribut obligatoriska fält och uppgiften stoppar importen om obligatoriska attribut saknas i något av de importerade objekten. CSV-formatet fungerar annorlunda, det räcker att alla mappade attribut hittas från rubrikraden som kolumner.

6. Anslutningsprogrammet importerar IGA administratörsuppgifter till IGA lösningen, inklusive fel och JSON-filer som innehåller arkiverade och importerade rader, efter att importen har utförts.

Anslutningsfiler,

HR-anslutningen förväntar sig att filen genereras från HR-lösningen baserat på följande logik och att filen lagras på kundens SFTP-server, där anslutningen kan hämta filen/filerna. Observera att kodningen måste vara UTF-8.
Om du använder csv-filformat är standardfältavgränsaren som används av HR-kopplingsskriptet ; (semikolon).

Hur filen genereras varierar beroende på vilken HR-lösning kunden använder, till exempel kräver särskilt IGA lösningen att information tas emot från det förflutna och från framtiden.

För Workday HR-lösningar rekommenderas det att skapa en anpassad rapport till Workday, som rapporterar nödvändig information, och använda json-format för att formatera informationen.

Exempel på vilken information som används för att generera den erforderliga filen,

Om kunden vill använda HR-anslutningen för att importera många olika typer av data rekommenderas det att ha en HR-anslutning per datatyp.

Om kunden till exempel vill importera organisationer och användare, bör de ha två kopplingar, som "HR-kopplingsorganisationer" och "HR-kopplingsanvändare".

Och om de två connector-filerna finns på samma ftp-server, kan mappstrukturen till exempel vara:

/sftp/iga/in/organisation

/sftp/iga/in/organisation/arkiv

/sftp/iga/in/användare

/sftp/iga/in/användare/arkiv

En datamapp bör endast innehålla en fil åt gången.

Med den mappstrukturen kan du använda dessa skriptparametrar för HR-anslutningsorganisationer:

“sftp_remote_path_data”:"/sftp/iga/in/organization",

“sftp_remote_path_archive”:"/sftp/iga/in/organization/archive",

“file_path”:"./organization/*.csv"

Och liknande olika skriptparametrar för HR-anslutningsanvändare.

Parametrar

Används för att definiera inställningar för HR-anslutningen, vilka valideras när skriptet körs.
Kom ihåg att förvara lösenordet på ett säkert ställe, ifall du behöver granska parametrar efter att du har sparat den schemalagda uppgiften.

HR-kopplingen använder följande parametrar,

Godkännande

Validering innebär att HR-anslutningen validerar att all obligatorisk information relaterad till användare tas emot från HR-lösningen och om den saknas skapar HR-anslutningen IGA administratörsuppgift som standard.

Kunden kan definiera fler attribut som ska läsas, utanför listan nedan, men det kräver att HR-kopplingsskriptet modifieras (läs mer i kapitlet om expansionsmöjligheter).

Undantag

Kunden kan definiera i vilken mall, mapp och attribut HR-kopplingen genererar följande undantag,

Dessa instruktioner uid hur man använder en förkonfigurerad HR-anslutning eller hur man skapar en från början. Observera att det krävs kunskaper i Python-skript för att modifiera skriptet.

Allmän uid för schemalagda uppgifter

General g uid ance for scheduled tasks

How to Create New Scheduled Task to import data

For configuring scheduled-based provisioning task, you will need access to Administration / Connectors tab.

1. Open the Administration area (a cogwheel symbol).

2. Open Connectors view.

3. Choose Connector for Scheduled-based task and select New Task
   Note! If connector is not created, you have to choose first New connector and after that New task.

 

4. Continue with connector specific instructions: Native Connectors

 

 

Should I use Incremental, Full or Both?

Scheduled task can be either Incremental or Full -type.

Do not import permissions with AD and LDAP incremental task

Incremental task has issue with permissions importing. At the moment it is recommended not to import group memberships with incremental scheduled task.

On Microsoft Active Directory and OpenLDAP connectors, remove this mapping on incremental task:
 

 

 

Setting on Scheduled tasks:

Incremental type is supported only for Microsoft Active Directory, LDAP and Microsoft Graph API (formerly known as Entra ID) Connectors.

Incremental type means, that Native Connectors (EPE) fetches data from source system, using changed timestamp information, so it fetches only data which is changed or added after previous incremental task run.

When Incremental type task is run for very first time, it does a full fetch (and it marks the current timestamp to EPE database),  thereafter, task uses that timestamp to ask the data source for data that changed since that timestamp (and then EPE updates the timestamp to EPE database for next task run). Clearing task cache doesn't affect this timestamp, so Incremental task is always incremental after first run.
 

Full type is supported for all Connectors.

Full type import fetches always all data (it's configured to fetch) from source system, on every run. 
 

Both Full and Incremental type tasks use also Task cache in EPE, which makes certain imports faster and lighter for M42 system.

By default that task cache is cleared ad midnight UTC time. When cache is cleared, next import after that is run without caching used to reason if data fetched should be pushed to ESM, all fetched data is pushed to ESM. But after that, next task runs until next time cache is cleared, are using EPE cache to determine if fetched data needs to be pushed to ESM or not.

You can configure at what time of day task cache is emptied, by changing global setting in EPE datapump configuration: 

/opt/epe/datapump-itsm/config/custom.properties

which is by default set to: clearCacheHours24HourFormat=0

You can also clear cache many times a day, but that needs to be thinked carefully, as it has impact on overall performance as EPE will push changes to ESM, that probably are already there, example(do not add spaces to attribute value): clearCacheHours24HourFormat=6,12

After changing this value, reboot EPE datapump container to take change into use.

Recommendations:

Have always by default Full type scheduled task.

If you want to fetch changes to data fetched already by full task, more frequently than you can run full task, add also incremental task. Usually incremental task is not needed.

 

 

Recommended Scheduling Sequence

Recommended scheduling sequence, depends how much data is read from Customers system/directory to the Matrix42 Core, Pro or IGA solution and is import Incremental or Full. 

Examples for scheduling, 

Total amount of users	Total amount of groups	Full load sequence	Incremental load sequence
< 500	< 1000	Every 30 minutes if partial load is not used Four (4) times a day if partial load is used	Every 10 minutes
< 2000	< 2000	Every 60 minutes, if partial load is not used Four (4) times a day if partial load is used	Every 15 minutes
< 5000	< 3000	Every four (4) hours, if partial load is not used Twice a day if partial load is used	Every 15 minutes
< 10 000	< 5000	Maximum imports twice a day, no matter if partial load is or is not used	Every 30 minutes
< 50 000	< 7000	Maximum import once a day, no matter if partial load is or is not used	Every 60 minutes
Over 50 000	Over 7000	There might be a need for another EPE-worker, please contact Product Owner	Separately evaluated

Please note that if there are several tasks running at the same time you may need more EPE-workers. The tasks should be scheduled at different times and can be completed according to the table above. However, if there are more than 6 tasks running at the same time, the number of epeworkers should be increased. It's best practice not to schedule tasks to run at same time, if possible.

Recommendations related to performance
If the amount fo data to be imported is over 10000 concider these things:
Adjust log level of ESM and DATAPUMP to ERROR-level, to lowe the amount of logging during task run
Have as few as possible automations starting immediately for imported datacards (listeners, handlers, workflows), as those make ESM to take longer time handling new datacards.

 

 

Set removed accounts and entitlements status removed/disabled

With this functionality, you can mark account and entitlement status to e.g. Deleted or Disabled, when account or entitlement is removed from source system. Starting from version 2025.3 you can also set status to generic objects (not only to accounts/identities and entitlements/groups). 

For version 2025.3 and newer

In version 2025.3 these settings are moved from properties files to Task UI. Also you can now set these settings for Generic objects, which have not been possible before this version.

There is separate configuration for each scheduled task, and for all mapping types. Here is example of this config on task:

For version 2025.2 and older

This functionality is available for “full” type scheduled tasks.

Settings are on datapump dockers configuration file. To change those parameter values, you need to set those in /opt/epe/datapump-itsm/config/custom.properties file.

Configuration

To enable disabling functionality, datapump config should have these parameters set to true:

disable.unknown.esm.users=true
disable.unknown.esm.groups=true

Those 2 parameters are false by default in 2024.2 and 2025.1 versions. In 2025.2 and newer version those are true by default.

 

Next are these parameters:

personTemplateStatusCodeAttributeKey=accountStatus
personTemplateStatusAttributeDisabledValueKey=Deleted
groupTemplateStatusCodeAttributeKey=status
groupTemplateStatusAttributeDisabledValueKey=5 - Removed

First two attributes should point to the DatacardHiddenState attribute in the User template, and tell which value should be send there when the user is deleted.

By default its accountStatus and Value 5 - Removed on IGA Account template.

All these needs to match with the attribute configuration:

 

Open 1.PNG

Same thing applies for the next two paramaters, but its for Groups.'

If you need to change those parameters in properties file, do changes in Datapump container to file: /opt/epe/datapump-itsm/config/custom.properties and those changes will then survive over container reboot and will be copied on reboot to /opt/epe/datapump-itsm/config/application.properties.

Description

Tasks save their __taskid__ shown as Task Id mapping in the UI to the datacards, its then used to determine if the datacard was added by this task. In case there are multiple tasks with different sets of users.

This field was previously used as datasourceid, but since we moved to the model where connector can have multiple tasks its identifier cannot be used anymore, thats why the field was repurposed as taskid instead.

 

Taking users as an example, when task runs ESM is asked for the list of users that have its taskid in Task Id mapping field, and doesn't have a personTemplateStatusAttributeDisabledValueKey value in the personTemplateStatusCodeAttributeKey

This result is then compared to what the task fetched, and the datacards of users that were not fetched have their personTemplateStatusattribute set to value specified in the config - 5 - Removedby default.

Example log below shows described process and informs that one user was removed.

 

Open 2.PNG

Same thing applies to groups but groupTemplateStatusattributes are used instead.

Notes

• Feature works only with full fetch scheduled tasks..
• No support for generic templates yet, only identity and access
• When migrating from the previous versions where datasourceid was still used it needs to run at least once to set its taskid’s in the datacards first.
• EPE identifies Disabled users or groups as the ones that were removed from the AD, at the present we do not support statuses related to the entity beign active or not.
• EPE does not enable users back on its own.
• If more than one tasks fetches the same users or groups it may overwrite the taskid in the datacard depending on which task ran last. It is suggested that many full type tasks are not fetching same user or group.
• Always do configuration file changes to custom.properties, do not change only application.properties as those changes are lost on container reboot if you have not done same changes to custom.properties.

 

 

 

Konfigurera HR-anslutning och schemalagd uppgift

För att få åtkomst till kopplingshantering måste användaren ha behörighet till Efecte Platform-konfigurationen.

1. Öppna administrationsområdet för Efecte (en kugghjulssymbol).
2. Öppna kopplingsvyn.
3. Välj ny kontakt

2. Välj datakälltyp som anpassad backend

3. Uppfylla information

• Fyll i ett unikt kopplingsnamn för kopplingen. Observera att namnet inte kan ändras i efterhand.
• Välj IGA Connector.py-skript från provisioneringsskriptfältet
• Lösenord för parameterkryptering behövs för att dölja/visa parametrar efter att anslutningen har sparats
• Web API användare behövs när HR-anslutningen skriver data till kunder Efecte-lösning
• Lösenord för webb API behövs när HR-anslutningen skriver data till kunder Efecte-lösning

4. Visa och modifiera parametrar enligt kundens definitioner

• Spara krypteringslösenordet på ett säkert ställe. Du kommer att behöva det senare om det finns behov av att justera parametrarna.
  
  Exempel på parametrar:
  {"objectGUID_field_name":"objectGUID", "sftp_server_fqdn":"transfer.xx.com", "sftp_server_ssh_port_number":"22", "sftp_username":"username_here", "sftp_password":"username_here", "sftp_remote_path_data":"/sftp/data", "sftp_remote_path_archive":"/sftp/archive",
"file_path":"./data/workperiod*.csv", // Path and file pattern where file is located. Mandatory value
"data_type":"workperiod", // Values: costcenter, organization, title or workperiod. Mandatory value
"run_type":"partial", // Run type specifies if comparison to previous file will be done. Values: full or partial. Optional value, default is 'partial'
"update_limit": 100, // How many updates are allowed to IGA System. Mandatory value
"override_update_limit":false, // overrides update limit, if amoun of updates is more than given limit. Values: true or false. Optional value, defaul is 'false'
"minimum_row_count": 10, // What is the minimum amount of rows, that should exist in the file. Optional value
"webapi_user": " IGA .Web API ", // Web API user for report creation. Requires Create and Read permissions to IGA Adminisitration task. Mandatory value
"webapi_password": "aeiou", // Web API user's password. Mandatory value
"webapi_url":"https://eisdemo.efectecloud-demo.com", // URL to ESM environment. Mandatory value
"report_template_code":" IGA WorkflowTaskInformation", // Target template code. Mandatory value
"report_folder_code":"iga_tasks", // Target folder code. Mandatory value
"debug": false, // Enables debug logging. Values: true of false. Optional value, default is 'false'
"language": "en" // Sets IGA Administration Task report language. Optional value, default is 'en'
}

5. Skapa en ny schemalagd uppgift för HR-anslutningen

6. Fyll i uppgiftsuppgifter

• Unikt uppgiftsnamn för kopplingen, observera att namnet inte kan ändras i efterhand.
• Uppgiftsanvändning är inställd på schemalagd
• Mappningstypen är inställd på generisk (en mall)

• Attributnamn för uid . Skrev namnet på din indatakolumn/attribut, som innehåller en unik identifierare för raden. Till exempel: objectGUID

7. Fyll i felinformation

Valfria inställningar för felhantering. Om en schemalagd uppgift misslyckas kan ett datakort skapas till Efecte ESM som visar felet. Om felinställningar har definierats behöver administratören inte manuellt kontrollera statusen för schemalagda uppgifter.

• Felmall – Välj en mall för datakort som skapas vid fel under etableringen (anslutning till datakällor, timeouts etc.)
• Felmapp – Välj mapp där feldatakortet lagras.
• Felattribut – Välj ett attribut där i felmallen felinformationen ska lagras.

8. Fyll i mappningar för generisk mall

Generiska data läses till valfri mall som användarna önskar och det är obligatoriskt att ange målmapp, datakälla-ID och unika värden som används för att identifiera data mellan kundernas HR- och Efecte-lösning.

• Målmall – Välj en mall för att definiera attributmappningar
  Välj en mall för att definiera attributmappningar
• Målmapp – Välj en mapp från en lista med mappar. Listan begränsas för att matcha kompatibilitet med vald mall.
• Attributmappningar
  1. Efecte-mallattribut - till vilket attributet i Efecte-katalogen är mappat.
  2. HR-attribut - vilket attribut från filen mappas till Efecte

9. Om du behöver ändra själva skriptet måste det laddas ner från kundens värddator, modifieras och laddas upp igen.

• Om du inte har åtkomst till värddatorn, vänligen kontakta Efectes Service Desk för hjälp.

10. Spara dina ändringar

11. Innan du kör den schemalagda uppgiften för HR-anslutningen,

• Kontrollera att all konfiguration relaterad till arbetsflöden och inställningar i datakort är på plats.
• När du kör för första gången, se till att provisionering är inaktiverat för kataloger och applikationer

12. Kör uppgiften manuellt eller vänta tills den schemalagda körningen har startats.

13. Kontrollera att data har lästs till korrekta datakort och att korrekta attribut finns på plats.

14. Felsökning

• Om felmall används, kontrollera korrekt datakort
• Kontrollera historiken för schemalagda uppgifter från kopplingshanteringen
• Kontrollera Efecte Provisioning Engine loggar

Välj HR-koppling om:

• HR-filen är i XML-, CSV- eller JSON-format
• Kunden har en SFTP-server
• HR-information tas emot från det förflutna och från framtiden
• Datatypen är kostnadsställe, organisation, titel eller arbetsperiod
• Data innehåller minst efternamn, förnamn, anställningsstartdatum, titel-ID, chefs-ID, organisationsenhets-ID
• Data innehåller minst ett av dessa unika värden: Personnummer / nationellt ID / Anställningsnummer