FI Finnish
SE Swedish
FR French
PL Polish
DE German
US English (US)

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

Finnish
FI Finnish
SE Swedish
FR French
PL Polish
DE German
US English (US)
  • Log in
  • Home
  • Identity Governance and Administration (IGA)
  • IGA-ratkaisukirjasto
  • Ohjeet ja käytännöt
  • Konnektorien määritys

SCIM-liitin

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Palveluhallinta
    Matrix42 Core -ratkaisu Matrix42 Intelligence Matrix42 Professional -ratkaisu
  • Identity Governance and Administration (IGA)
    IGA-ratkaisukirjasto IGA-yleiskatsaus
  • Alusta
    ESM ESS2 ESS Efecte Chat for Service Management Lisäosat
  • Julkaisutiedot M42 Professionalille, IGA:lle ja konversationaaliselle tekoälylle
    2026.1 2025.3 2025.2 2025.1 2024.2 2023.4 2023.3 2023.2 2023.1 2022.4 2022.3 Julkaisutiedot ja käytännöt
  • Muu materiaali
    Saavutettavuusselosteet Termit ja dokumentaatio-ohjeet
  • Palvelut
+ More
    • Palveluhallinta

    • Identity Governance and Administration (IGA)

    • Alusta

    • Julkaisutiedot M42 Professionalille, IGA:lle ja konversationaaliselle tekoälylle

    • Muu materiaali

    • Palvelut

SCIM-liitin

SCIM-liitin on osa Native Connectorsia, ja sitä käytetään datan lukemiseen SCIM-palvelimelta. Liitin on saatavilla vain Matrix42 IGA -ratkaisulle, ja sen käyttö muissa Matrix42-ratkaisuissa vaatii erillisen sopimuksen. SCIM-liitin on SCIM-asiakas, joten se voi lukea dataa SCIM-palvelimelta. Se ei kuitenkaan voi muodostaa yhteyttä toiseen SCIM-asiakkaaseen.

SCIM-liitin vaatii määrityksen asiakkaan käyttötapauksen mukaisesti, ja periaatteessa määrityksessä on kaksi (2) vaihetta:

  1. Liittimen määrittäminen – mahdollistaa liittimen yhteyden muodostamisen SCIM-palvelimeen
  2. Ajastetun tehtävän määrittäminen – käytetään, kun dataa luetaan SCIM-palvelimelta

SCIM-liittimen määrittäminen

Tässä luvussa kuvataan SCIM-liittimen määritysohjeet, joiden avulla se voi muodostaa yhteyden asiakkaan SCIM-palvelimeen.

Liitinhallinnan käyttöä varten käyttäjällä on oltava käyttöoikeudet Matrix42 Pro/IGA -ratkaisun määrityksiin.

  1. Avaa Matrix42:n ylläpitoalue (hammasratassymboli).
  2. Avaa liittimien näkymä.
  3. Valitse new connector
  4. Valitse Data Source -tyypiksi SCIM
  5. Täytä asiakkaan SCIM:ää koskevat tiedot
    • Connector name – anna liittimelle helppokäyttöinen nimi (nimen voi muuttaa myöhemmin)
    • SCIM host – isäntäosoite, jota käytetään yhteyden muodostamiseen asiakkaan SCIM:ään
    • SCIM port – porttinumero, jota käytetään yhteyden muodostamiseen asiakkaan SCIM:ään
    • SCIM username – palvelutilin nimi, jota käytetään datan lukemiseen ja kirjoittamiseen asiakkaan SCIM:stä/SCIM:ään
    • SCIM password – palvelutilin salasana
  6. Täytä WebAPI-käyttäjän tiedot
    • WebAPI user – valitse oikea WebAPI-käyttäjä, jota käytetään kirjoitettaessa dataa asiakkaan SCIM:stä asiakkaan Matrix42-ratkaisuun
    • WebAPI password – WebAPI-käyttäjän salasana
  7. Tallenna liittimen tiedot
    • Paina test connection tarkistaaksesi, että portti- ja isäntätiedot on määritetty oikein
    • Paina test authentication tarkistaaksesi, että SCIM-käyttäjän ja salasanan (palvelutilin) tiedot on määritetty oikein
  8. Asiakkaan Matrix42-ratkaisu voi nyt muodostaa yhteyden asiakkaan SCIM:ään. Seuraava vaihe on määrittää ajastettu tehtävä datan lukemista varten.

Yleisiä ohjeita ajastetuille tehtäville

Yleisiä ohjeita ajastetuille tehtäville

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. 
 

Tasks internal cache

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

Beginning from version 2026.1.1

Tasks internal cache clean scheduling was moved from properties file to Task UI.

With that change you can now also decide per scheduled task when internal cache is cleared, or if it's not cleared at all. In normal situations cache is recommended to be cleared at some point to guarantee correct data on datacards. If template and imported data doesn't contain references, cache can be cleared quite rarely. With references, it's recommended to clear cache daily or weekly to guarantee correct data on datacards.

Versions before 2026.1.1

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:

Unique check added on 26.2 version

When this Set value for deleted objects option is enabled, at least one of the attributes mapped to the unique id must also be marked as Unique on the target template. If none of the mapped attributes are unique, the task cannot be saved and the message "Unique id must be mapped to at least one unique attribute of template" is shown.

 

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:

 

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.

 

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.
 
 

 

 

Ajastetun tehtävän määrittäminen datan lukemista varten

Ajastettuun tehtävään perustuvan määrityksen tekemiseksi tarvitset pääsyn Matrix42 Pro/IGA -ratkaisun määrityskonsoliin.

Huomaa! Jos liitintä ei ole vielä luotu, sinun on ensin luotava ”new connector”, minkä jälkeen voit luoda uusia tehtäviä.

 

 

  1. Avaa Matrix42:n ylläpitoalue (hammasratassymboli).
  2. Avaa liittimien näkymä.
  3. Valitse liitin, jolle ajastettu tehtävä määritetään
  4. Valitse new task oikean liittimen alta
  5. Määritä tehtävän ajastus (ajetaanko ajastettu tehtävä säännöllisesti ja miten). Valitse ajastusväli sen mukaan, kuinka paljon dataa asiakkaan Matrix42-ratkaisuun luetaan.
  6. Täytä Task Details -tiedot
    • Anna ajastetulle tehtävälle yksilöllinen nimi; huomaa, että nimeä ei voi muuttaa myöhemmin.
    • Task usage ilmaisee, käytetäänkö tehtävää datan lukemiseen, kirjoittamiseen vai todennukseen. Huomaa, että jos tapahtumatyyppiä muutetaan myöhemmin, se voi rikkoa työnkulut.
    • Mappings type riippuu siitä, minkä tyyppistä tietoa hakemistosta luetaan
      • Identity and access rights – käytetään, kun hakemistosta luetaan käyttäjätili- ja ryhmätietoja
      • Single (identity only) – käytetään, kun hakemistosta luetaan vain käyttäjätilitietoja
      • Single (access right only) – käytetään, kun hakemistosta luetaan vain ryhmätietoja
      • Generic (one template) – käytetään, kun hakemistosta luetaan yleistä tietoa, yleensä muuta kuin käyttäjiä/ryhmiä
  7. Täytä valinnaiset suodatustiedot
    • Määritä tarvittaessa suodatin käyttäjille; lisäsuodatin Graph API -kyselyyn, jota sovelletaan käyttäjiä poimittaessa
    • Määritä tarvittaessa suodatin ryhmille; lisäsuodatin SCIM API -kyselyyn, jota sovelletaan ryhmiä poimittaessa
  8. Täytä failure-tiedot

Valinnaiset asetukset virheenkäsittelyä varten; jos ajastettu tehtävä epäonnistuu, se voi luoda Matrix42 ESM:ään tietokortin, joka näyttää virheen. Jos failure-asetukset on määritetty, ylläpitäjän ei tarvitse manuaalisesti tarkistaa ajastettujen tehtävien tilaa.

  • Failure template – valitse tietokortin malli, joka luodaan, jos provisioinnin aikana tapahtuu virheitä (yhteys tietolähteisiin, aikakatkaisut jne.)
  • Failure folder – valitse kansio, johon failure-tietokortti tallennetaan.
  • Failure attribute – valitse attribuutti, johon virhetiedot tallennetaan failure-mallissa.
  1. Täytä Identity Mappings -tiedot

Käyttäjät tuodaan IGA Account -malliin, ja on pakollista määrittää Target folder, datasourceid sekä yksilölliset arvot, joita käytetään käyttäjien tunnistamiseen asiakkaan SCIM:n ja Matrix42-ratkaisun välillä. Esimerkiksi.

  • Target template – valitse malli attribuuttimappausten määrittämiseksi
  • Target folder – valitse kansio luettelosta. Luettelo rajataan vastaamaan valittua mallia.
  • Data Source Type mapping – valinnainen. Jos se on asetettu, se kirjoittaa liittimen tyypin kyseiseen attribuuttiin.
  • Task Id mapping – tehtävän id-numero kirjoitetaan tähän attribuuttiin. Tämän on oltava ei-yksilöllinen attribuutti.
  • Set value to datacard fo object deleted from source system – tämä toiminto otetaan käyttöön valitsemalla valintaruutu. Kun objekti, joka on aiemmin luettu kolmannen osapuolen järjestelmästä ratkaisuun, poistetaan kolmannen osapuolen järjestelmästä (eli tämän tehtävän kysely ei enää palauta sitä), ajastettu tehtävä huomaa poiston ja merkitsee kyseisen tietokortin valitun attribuutin halutulla arvolla. Tätä voidaan käyttää esimerkiksi Status-attribuutin asettamiseen arvoon Deleted. Tämä toiminto toimii vain Full-tyyppisille tehtäville, ei Incremental-tehtäville.
  • Attribute mappings
    1. External attribute – mikä SCIM-palvelimen attribuutti mapataan
    2. Local attribute – mihin tietokortin attribuuttiin attribuutti mapataan.
  • On mahdollista määrittää lisäattribuutteja, jotka luetaan käyttäjätileiltä, valitsemalla New attribute
  1. Täytä Access Rights Mappings -tiedot

Ryhmät luetaan IGA Entitlement -malliin, ja on pakollista määrittää target folder, datasourceid sekä yksilölliset arvot, joita käytetään käyttäjien tunnistamiseen asiakkaan SCIM-palvelimen ja Matrix42 Core-, Pro- tai IGA-ratkaisun välillä.

  • Target template – valitse malli attribuuttimappausten määrittämiseksi
  • Target folder – valitse kansio luettelosta. Luettelo rajataan vastaamaan valittua mallia.
  • Attribute mappings
    1. Matrix42 template attribute – mihin Matrix42-hakemiston attribuuttiin attribuutti mapataan.
    2. Directory attribute – mikä hakemiston attribuutti mapataan Matrix42:een
  • On mahdollista määrittää lisäattribuutteja, jotka luetaan hakemiston käyttäjätileiltä, valitsemalla New attribute
  1. Tallenna provisiointitehtävä Save-painikkeesta. Jos joitakin pakollisia attribuutteja puuttuu, save-painike näkyy harmaana, ja se näyttää, mitä asetuksista puuttuu.
  2. Olet nyt määrittänyt ajastettuun tehtävään perustuvan liitintehtävän SCIM-datan lukemista varten.
    • Voit nyt odottaa, että tehtävä käynnistyy ajastuksen mukaisesti, tai
    • Run task manually – painiketta napsauttamalla tehtävä ajastetaan käynnistymään heti. Yleensä käytetään testiajoihin tai kun ei haluta muuttaa ajastusasetuksia, mutta halutaan ajaa tehtävä nyt.

Vianmääritys

Tässä luvussa kuvataan vianmääritysvaihtoehtoja,

  • Jos failure-mallia käytetään, tarkista virhetiedot oikeasta tietokortista
  • Tarkista ajastetun tehtävän historia liitinhallinnasta
  • Tarkista Matrix42 Native Connectors -lokit; ne löytyvät Connectors-välilehdeltä, Logs-osiosta
  • Tarkista FAQ-dokumentit

 

Was this article helpful?

Yes
No
Give feedback about this article

Table of Contents

Related Articles

  • Määritys: EPE:n käyttö SCIM-tietojen lukemiseen Microsoft Entralla
  • Määritys: EPE Luo tietokortti kohde-ESM:ään
  • Määritys: EPE Poista tietokortti kohde-ESM:stä
  • Liittimien työnkulkutoiminnot
  • Microsoft Active Directory (AD) -liitin

Copyright 2026 – Matrix42 Professional.

Matrix42 homepage


Knowledge Base Software powered by Helpjuice

0
0
Expand