Créer / Modifier les règles d'export¶

Une règle d’export a pour but de définir, à partir d’un référentiel, les objets à exporter et leurs emplacements. Par exemple, pour un référentiel de type annuaire, il faudra définir les objets à exporter et les OUs dans lesquelles la recherche s’effectuera.

Chaque export réalisé génèrera un fichier de données au format XML.

2 modes d’export sont possibles et sont à prévoir selon les cas d’usages :

Complet : tous les objets respectant les règles d’export sont exportés dans le fichier de sortie. Le fichier de sortie est au format XML.
Unitaire : Export d’un seul objet filtrer sur la valeur d’un attribut.

Selon le type de référentiel, les règles d’export à configurer sont différentes.

Export d’un référentiel de type annuaire (LDAP, AD, AD/LDS, OpenLDAP, etc.)¶

Type d’objet : précisez le type d’objet à exporter (exemple : user, classes, etc.).
Filtre de recherche : champ facultatif pour appliquer des filtres sur les objets à exporter (exemple : « employeeID » différent de vide).
Filtre unitaire : attribut qui permet filtrer un objet en définissant sa valeur.
Attributs : liste des attributs des objets à exporter.
OUs : précisez les OUs dans lesquelles les objets seront exportés.
Filtres des groupes : Liste des groupes à gérer ou exclure dans les actions de suppression :
- Si option ‘Remove the groups instead of keeping them’ non cochée : la liste des groupes indique ceux qui ne doivent pas être supprimés.
- Si option ‘Remove the groups instead of keeping them’ cochée : la liste des groupes indique ceux qui peuvent être supprimés.

Résultats et options :

Chaque attribut est exporté dans une balise XML avec pour nom, le nom d’attribut de l’annuaire. Le format de la donnée exportée par défaut est une chaîne de caractères.

Par chaque attribut, il est possible de spécifier un type différent avec pour choix :

Binary
Date
Date_Filetime

Pour modifier le format d’export, il faut sélectionner l’attribut souhaité et cliquer sur le bouton « Modifier ».

Export d'un référentiel de type fichier plat (CSV)¶

Attributs : liste des colonnes composants le fichier plat (le fichier est définit par la création du référentiel).
- Cliquez sur ‘Add’ pour ajouter une entrée.
- Sélectionnez un attribut pour le modifier ou le supprimer.
- Si le fichier csv possède des entêtes de colonnes, il est possible de cliquer sur le bouton « Get Column Name » pour récupérer de manière automatique le nom des colonnes.
Attribut de comparaison pour une recherche filtrée : colonne qui permet d’exporter un seul objet en définissant sa valeur

Résultats et options :

Chaque attribut est exporté dans une balise XML avec pour nom, le nom d’attribut spécifié. Le format de la donnée exportée par défaut est une chaîne de caractères.

Par chaque attribut, il est possible de spécifier un type différent avec pour choix :

Binary
Date
Date_Filetime

Pour modifier le format d’export, il faut sélectionner l’attribut souhaité et cliquer sur le bouton « Modifier ».

Export d'un référentiel de type base de données (SQL Serveur, Oracle, etc.)¶

Type objet : valeur indicative, non impactante sur la configuration
Requête SQL : requête qui permet d’extraire l’ensemble des informations souhaitées
Filtre unitaire : requête dans laquelle un filtre est spécifié pour ne ramener qu’un seul résultat
Attributs : encart prévu pour ajouter des requêtes SQL afin d’exporter des informations complémentaires. Chaque requête ne peut exporter qu’un seul attribut, mais il peut être multivalué (requêtes ramenant plusieurs lignes)
Option multilignes : option à cochée dans le cas où un des attributs exportés de la requête principale est multivalué. Le nom de cet attribut est à noter dans le champ « Multiline Matching Attribute ». Il ne peut y avoir qu’un seul attribut multivalué dans la requête principale.

Note importante : si cette option est cochée, il est impératif de réaliser un « order by » dans la requête pour trier avec l’attribut renseigné dans le champ « Multiline Matching Attribute ».

Résultats et options :

Chaque colonne définie dans la requête est exportée dans une balise XML avec pour nom, le nom de la colonne spécifiée. Le format de la donnée exportée est une chaîne de caractères.

Export d'un référentiel de type API (REST — protocole SIM)¶

Type objet : cliquez sur le bouton « Get Object Type List » pour récupérer la liste des objets disponibles pour l’export du référentiel de l’application
Attribut d’appairage : cliquez sur le bouton « Get Attributes List » pour récupérer la liste des attributs disponibles. La liste des attributs dépend du type d’objet choisit.
Cliquez sur le bouton « Set » pour valider les mises à jour.

Résultats et options :

Chaque attribut définit dans le type d’objet renvoyé par l’API est exporté dans une balise XML. Le format de la donnée exportée est une chaîne de caractères.

Export d'un référentiel de type XML¶

Pour réaliser un export d’un référentiel de type XML, il est nécessaire de réaliser une action de type XSLT.

En effet, les fichiers XML peuvent avoir des structures différentes, il est donc nécessaire de produire un fichier de transformation pour le convertir au format XML compatible avec le moteur de provisioning SIP.

Export Identity : identités¶

Type d’objet : Saisir la valeur « USERS »
Type de personne : préciser le code des types de personnes à exporter depuis le référentiel Identity
Attribut de comparaison pour l’export unitaire : ‘personne_uid’

Résultats et options :

Pour chaque identité, tous les attributs qui possèdent une valeur sont automatiquement exportés dans une balise XML avec pour nom, le code de l’attribut. Le format de la donnée exportée est une chaîne de caractères.

Export Identity : Énumérations¶

Type d’objet : Saisir la valeur « ENUMERATIONS »
Liste des Codes : Code des énumérations à exporter depuis le référentiel Identity ; plusieurs énumérations peuvent être exportées en même temps.

Pas d’export unitaire géré sur les énumérations.

Résultats et options :

Pour chaque énumération, les balises suivantes sont exportées :

Type = Code de l’attribut (ou code type énumération) contenant la liste des valeurs
Code = Code d’une valeur d’énumération
Name = Libellé associé au code
Description = Description de la valeur de l’énumération. Cette information est facultative et n’est exportée que si elle n’est pas vide.

Le format des données exportées est une chaîne de caractères.

Export Identity : Tables de correspondance¶

Type d’objet : Saisissez la valeur « MATCHINGTABLE »
Liste des Codes : Code des tables de correspondances à exporter depuis le référentiel Identity ; plusieurs tables de correspondances peuvent être exportées en même temps.

Pas d’export unitaire géré sur les tables de correspondances.

Résultats et options :

Pour chaque table de correspondances, les balises suivantes sont exportées :

Type = Code du type de table de correspondances
Key = Clé de la table de correspondances
Value = Valeur(s) associée(s) à la clé. La valeur peut être multivaluée.
Description = Description de la valeur de la table de correspondances. Cette information est facultative et n’est exportée que si elle n’est pas vide.

Le format des données exportées est une chaîne de caractères.

Export Identity : dotations (ressources)¶

Type d’objet : Saisissez la valeur « OBJECTS »
Liste de code : précisez le code des types de dotations (ressources) à exporter depuis le référentiel Identity
Option pour exporter les structures qui possèdent un lien avec la dotation
Option pour exporter les identités qui possèdent un lien avec la dotation
Attribut de comparaison pour l’export unitaire : ‘object_instance_code’

Résultats et options :

Pour chaque dotation (ressource), tous les attributs qui possèdent une valeur sont automatiquement exportés dans une balise XML avec pour nom, le code de l’attribut. Le format de la donnée exportée est une chaîne de caractères.

Export Identity : états de provisioning¶

Type d’objet : Saisissez la valeur « STATUS »
Référentiel : code du référentiel dont on veut exporter les personnes et leur compte associé. Attention, il doit être unique pour un bon fonctionnement.
Attribut de comparaison pour l’export unitaire : « Account.login »

Résultats et options :

Pour chaque compte du référentiel, les balises suivantes sont exportées :

Account.Id : Id du compte
Account.login : Login du compte. Servira pour l’opération de comparaison
Account.state : Etat de provisioning du compte (0 : non provisionné, 1 : provisionné)
Person.Id : Id de la personne primaire
Person.uniqueId : UID de la personne primaire
Pour chaque habilitation liée au compte :
- [code_mapping_droit]#right.id : balise d’information pour récupérer la liste d’ID des droits qui ont pour code mapping la valeur indiquée dans la première partie de la balise. Valeurs multivaluées possibles.
- [code_mapping_droit]#[right.id] : Une balise de ce type pour chaque habilitation qui a pour code mapping la valeur indiquée dans la première partie de la balise. Contient la valeur de l’habilitation
- [code_mapping_droit] : balise d’information pour récupérer la liste des valeurs des habilitations qui ont pour code mapping la valeur indiquée dans la première partie de la balise. Valeurs multivaluées possibles.
- [code_mapping_droit]#state : Liste des états de provisioning pour chaque habilitation qui a pour code mapping la valeur indiquée dans la première partie de la balise.

Le format des données exportées est une chaîne de caractères.

Export Identity : structures¶

Type d’objet : Saisissez la valeur « STRUCTURES »
Liste de codes : précisez le code des types de structures à exporter depuis le référentiel Identity
Attribut de comparaison pour l’export unitaire : ‘structure_code’

Résultats et options :

Pour chaque structure, tous les attributs qui possèdent une valeur sont automatiquement exportés dans une balise XML avec pour nom, le code de l’attribut. Le format de la donnée exportée est une chaîne de caractères.

Export Identity : identités + habilitations¶

Type d’objet : Saisissez la valeur « USERS+ACCESS »
Référentiel : code du référentiel dont on veut exporter les personnes et leur compte associé. Attention, il doit être unique pour un bon fonctionnement.
Type de personne : précisez le code des types de personnes à exporter depuis le référentiel Identity
Attribut de comparaison pour l’export unitaire : ‘personne_uid’

Résultats et options :

Pour chaque identité, tous les attributs qui possèdent une valeur sont automatiquement exportés dans une balise XML avec pour nom, le code de l’attribut. Le format de la donnée exportée est une chaîne de caractères.

Si l’identité possède un compte du référentiel spécifié, alors des balises XML complémentaires sont exportées :

HPPAccountLogin
HPPAccountPwd
HPPAccountState

Si l’identité possède des habilitations sur le référentiel spécifié, alors des balise XML complémentaires sont exportées :

HPPAccessRight qui contiendra toutes les valeurs des habilitations de type « Groupe » et « Groupe dynamique »
Une balise XML pour chaque code différent défini dans le mapping des habilitations de type « Attribut » ou « Attribut dynamique ». Si plusieurs habilitations sont configurées avec le même code mapping, alors une seule balise XML sera exportée avec plusieurs valeurs à l’intérieure.

Export Identity : comptes + habilitations¶

Type d’objet : sélectionnez la valeur « ACCOUNT »
Référentiel : précisez le code du référentiel dont les comptes et habilitations sont à exporter. Attention, même si techniquement il est possible de saisir plusieurs codes de référentiels, il est impératif de n’en saisir qu’un seul pour un bon fonctionnement du connecteur de provisioning.

Résultats et options : Tous les comptes du référentiel choisit sont exportés.

Pour chaque compte, les balises suivantes sont exportées :

ID = Id du compte, à utiliser pour les mises à jour et suppression
Account_login = Le login du compte
password = Le mot de passe du compte, exporté chiffré
Account_provisioning = Etat de provisioning du compte :
- 1 : compte théorique uniquement
- 2 : compte orphelin
- 3 : compte théorique et provisionné
Account_state = Etat théorique du compte
- -1 : Aucun compte (valeur non possible en export)
- 0 : compte théorique uniquement
- 1 : compte actif
- 2 : compte désactivé
Account_type = Id du type de compte
roles = Rôles associés au compte
Les attributs et les habilitations sont exportées dans les balises nommées par la configuration.

Export Identity : rôles¶

Type d’objet : sélectionnez la valeur « ROLE »
Référentiels : précisez les codes du référentiel dont les rôles existants liés sont à exporter. Facultatif.

Résultats et options : Tous les rôles existants sont exportés. Si un ou plusieurs référentiels précisés, alors uniquement les rôles liés à ces référentiels seront exportés.

Pour chaque rôle, les balises suivantes sont exportées :

id = Id du rôle
code = Le code du rôle
name = Le nom du rôle
description = La description du rôle
repositories = code des référentiels liés au rôle
accountTypes = code des types de compte liés au rôle

Export Identity : habilitations¶

Type d’objet : sélectionnez la valeur « RIGHT »
Référentiels : précisez les codes du référentiel dont les habilitations existantes liées sont à exporter. Facultatif.

Résultats et options : Toutes les habilitations existantes sont exportées. Si un ou plusieurs référentiels précisés, alors uniquement les habilitations liées à ces référentiels seront exportées.

Pour chaque habilitation, les balises suivantes sont exportées :

Id = L’id de l’habilitation
code = Le code de l’habilitation
name = Le nom de l’habilitation
category = Le code de la catégorie de l’habilitations
application = Le code de l’application de l’habilitation
repository =Le code du référentiel de l’habilitation
type = Le type de l’habilitation
- 3 = groupe. Attention, l’usage de ce type d’habilitation est déprécié à partir de la version 7.0. Privilégier le type « attribute »
- 6 = attribut
mode = Le mode de l’habilitation
- 0 = Statique. Valeur statique à préciser dans la balise « value »
- 1 = dynamique : valeur d’un attribut préciser dans la balise nommée « template#[code_type_objet] »
Le nom de l’attribut pour l’export des habilitations liées aux comptes ou aux personnes dans la balise « mappingCode »

Export Identity : identités + rôles¶

Type d'objet : sélectionnez la valeur « PERSON_ROLES »
Référentiels : précisez les codes du référentiel dont les rôles existants liés sont à exporter.

Résultats et options : tous les liens identités-rôles liés aux référentiels sélectionnés sont exportés.

Pour chaque lien identité-rôle, les balises suivantes sont exportées :

person = UID de l'identité
role = Code du rôle à affecter
startdate = Date de début du rôle
enddate = Date de fin du rôle
id = id du lien identité-rôle

Export Identity : identités + rôles + habilitations¶

Type d'objet : sélectionnez la valeur « PERSON_RIGHTS »
Référentiels : précisez les codes du référentiel pour lesquels vous voulez créer des liens identités/rôles-habilitations.

Résultats et options : tous les liens identités/rôles-habilitations liés aux référentiels sélectionnés sont exportés.

Pour chaque lien identité/rôle-habilitation, les balises suivantes sont exportées :

person = UID de l'identité
role = code du rôle
right = code de l'habilitation
startdate = date du début de l'habilitation
enddate = date de fin de l'habilitation
id = id du lien identité-rôle-habilitation