Connecteurs - fonctionnalités générales

Cet article décrit les fonctionnalités générales de gestion des connecteurs natifs dans la solution. Tous les connecteurs natifs sont gérés depuis la même interface de gestion.

Notez qu'il existe des descriptions distinctes pour chaque connecteur, où les fonctionnalités spécifiques au connecteur et les instructions de configuration sont décrites à un niveau détaillé.

Pour accéder à la gestion des connecteurs, l'utilisateur doit disposer des autorisations d'administrateur pour la configuration de la plateforme client. Une fois les accès accordés, l'onglet Connecteurs s'affiche et l'utilisateur peut gérer les connecteurs.

Menu de gauche

La gestion des connecteurs est divisée en quatre onglets :

• Présentation : pour créer et mettre à jour des connecteurs natifs. L'administrateur peut consulter leur statut, leur type et le nombre de tâches planifiées ou d'événements qui leur sont associés.
• Authentification : pour créer et mettre à jour les tâches d'authentification. La tâche de Pro pour l'authentification est nécessaire pour que Secure Access puisse définir quels utilisateurs finaux peuvent accéder à la page de connexion Matrix42 Core , Pro and IGA .
• Journaux - pour télécharger les journaux du connecteur natif et Secure Access à partir de l'interface utilisateur.
• Paramètres - paramètres généraux pour les connecteurs natifs et Secure Access , y compris le type d'environnement pour la journalisation et la surveillance.

Onglet Présentation des connecteurs

Depuis la page d'aperçu, l'utilisateur peut facilement et rapidement voir l'état de tous les connecteurs.

Barre supérieure :

• Statut des connecteurs natifs (EPE)
  • Le texte vert indique que les connecteurs natifs sont en ligne. Tous les services nécessaires sont opérationnels.
  • Le texte rouge indique qu'il y a un problème avec les connecteurs natifs, tous les services ne fonctionnent pas.
• Statut d' Secure Access ( ESA )
  • Le texte vert indique que Secure Access est en ligne. Tous les services nécessaires sont opérationnels.
  • Le texte rouge indique qu'il y a un problème avec Secure Access , tous les services ne fonctionnent pas.
• Le numéro de version des connecteurs natifs est affiché dans le coin supérieur droit
  

Barre supérieure pour la vue en liste :

• Nouveau connecteur - ouvre une nouvelle fenêtre pour ajouter et configurer un nouveau connecteur
• Supprimer le(s) connecteur(s) - les références de workflow sont calculées et une fenêtre contextuelle apparaît pour confirmer la suppression (notez que le calcul des références peut prendre plusieurs secondes)
• Exporter : l'administrateur peut exporter un ou plusieurs connecteurs (et tâches) depuis l'environnement. Cette fonction est généralement utilisée pour exporter des connecteurs et des tâches du test vers la production. Les informations confidentielles des connecteurs natifs sont protégées par mot de passe.
• Importation : l'administrateur peut importer un ou plusieurs connecteurs (et tâches) dans l'environnement. Cette fonction est généralement utilisée pour importer des connecteurs (et tâches) du test vers la production.
  • L'administrateur ne peut pas importer de données depuis l'ancienne interface EPE (antérieure à 2024.1) vers la nouvelle. Les environnements source et cible doivent avoir la même version.
  • L'importation échouera si la configuration (modèles, attributs) n'est pas la même - par exemple lorsqu'un attribut est manquant
  • Si vous importez quelque chose avec les mêmes détails de connecteur, il sera fusionné sous le connecteur existant
• Actualiser - L'administrateur peut actualiser la vue des connecteurs en cliquant sur le bouton .

Vue de liste pour un aperçu,

• Sélectionner le(s) connecteur(s) - Sélectionnez un connecteur en cliquant sur la case à cocher devant la ligne de connecteur ou en cliquant sur la case à cocher dans la ligne d'en-tête pour sélectionner tous les connecteurs
• ID - ID unique du connecteur généré automatiquement. Non modifiable.
• Statut - indique l'état de la tâche planifiée
  • Coche verte - La tâche est exécutée sans aucune erreur
  • Croix- Rouge - La tâche est exécutée, mais il y a eu une erreur
  • Horloge grise - La tâche n'est pas encore exécutée, en attente de planification
  • Orange - l'une des tâches présente un problème
  • Aucune valeur - La tâche planifiée est manquante
• Nom - Nom du connecteur ajouté aux paramètres. Nom unique du connecteur contenant la configuration d'une source de données.
• Type - indique le système cible/source
• Planifié - informe du nombre de tâches planifiées configurées
• Événement - informe du nombre de tâches d'événement configurées
• Gérer
  • Icône de stylo - ouvre les paramètres du connecteur (double-cliquez sur la ligne du connecteur pour ouvrir également les paramètres)
  • Icône papier - copie le connecteur
  • Arrêter - les références de flux de travail sont calculées et une fenêtre contextuelle apparaît pour confirmer la suppression
• Recherche : l'utilisateur peut rechercher un connecteur en saisissant le terme recherché dans le champ correspondant. Les champs ID, Statut, Nom, Type, Planifié et Événement peuvent être consultés.

Informations sur les tâches planifiées (cliquez sur la flèche devant le connecteur)

Lorsque vous cliquez sur la flèche au début de la ligne du connecteur, toutes les tâches planifiées et événementielles associées sont affichées

Barre supérieure pour les tâches planifiées

• Nouvelle tâche - ouvre la page de configuration pour la nouvelle tâche
• Supprimer la ou les tâches - supprime la ou les tâches sélectionnées du système et elles ne peuvent plus être récupérées.
• Actualiser - actualiser la vue des tâches planifiées
• Recherche - l'utilisateur peut rechercher une tâche en saisissant le terme de recherche dans le champ correspondant pour l'ID, le nom, l'activation, l'état d'extraction/chargement.

Vue de liste pour les tâches planifiées

• Sélectionner la ou les tâches - Sélectionnez la tâche à supprimer dans la vue liste en cochant la case.
• ID : identifiant unique de la tâche. Généré automatiquement et non modifiable.
• Nom - Nom de la tâche ajouté aux paramètres de la tâche, nom unique de la tâche.
• Activé - Affiche si la tâche est planifiée ou non
  • Coche verte - La tâche est planifiée
  • Croix -Rouge - La tâche n'est pas planifiée
• État d'extraction - Affiche l'état de l'extraction des données du répertoire/système cible
  • Coche verte : les données ont été extraites avec succès
  • Croix- Rouge - les données sont extraites avec des erreurs ou l'extraction a échoué
  • Horloge - La tâche est en attente d'exécution
• État de chargement - Affiche l'état de l'exportation des données du fichier json vers la solution du client
  • Coche verte : les données ont été importées avec succès vers la solution client
  • Croix- Rouge - les données sont importées avec des erreurs ou l'importation a échoué
• Gérer
  • Icône de stylo - ouvre les paramètres de la tâche dans sa propre fenêtre (un double-clic sur la ligne de la tâche ouvre également les paramètres de la tâche)
  • Icône papier - copie la tâche
  • Icône d'horloge - ouvre la vue de l'historique des tâches
  • Arrêter - supprimer la tâche, une fenêtre contextuelle s'ouvre pour confirmer la suppression

Affichage de l'historique des tâches planifiées

En cliquant sur l'icône de l'horloge dans la ligne des tâches planifiées, l'historique de la planification sera affiché.

Barre supérieure pour afficher l'historique

• Actualiser : actualise l'état de la tâche planifiée. Cela n'affecte pas la tâche ; l'interface utilisateur est simplement mise à jour pour afficher les dernières informations sur son exécution.

Vue de liste pour l'historique des tâches planifiées

• La couleur de la ligne indique le statut
  • Vert - tâche exécutée avec succès
  • Rouge - une erreur s'est produite lors de l'exécution
• ID d'exécution - ID unique pour la ligne de tâche planifiée
• Heure prévue d'extraction - quand la prochaine extraction du répertoire/de l'application est prévue
• Heure d'achèvement de l'extraction - quand l'extraction a été terminée
• Extraire l'état - état de récupération des données du répertoire/de l'application
• Heure de début du chargement - heure à laquelle le prochain chargement de la solution client est prévu
• Heure de fin de chargement - quand le chargement a été terminé
• Statut de chargement - statut de chargement des informations vers la solution client

Vue de liste pour l'état des tâches planifiées

• Heure de début réelle - horodatage du début réel
• Fichier utilisateurs - Fichier JSON contenant les informations utilisateur lues à partir du répertoire/de l'application
• Fichier de groupe - Fichier JSON contenant des informations de groupe lues à partir du répertoire/de l'application
• Fichier générique - Fichier JSON contenant des informations génériques lues à partir du répertoire/de l'application
• Extraire des informations - informations détaillées sur la lecture des informations du répertoire/de l'application
• Informations sur le chargement - informations détaillées sur le chargement des informations vers les solutions clients Matrix42 Core , Pro and IGA

Fenêtre d'édition pour la tâche planifiée

La configuration de la tâche planifiée peut être ouverte en cliquant sur l'icône du stylo ou en double-cliquant sur la ligne de la tâche.

Le menu de gauche et les attributs varient en fonction des options sélectionnées et, par conséquent, des instructions plus détaillées pour l'édition des tâches peuvent être trouvées dans la description du connecteur, mais il existe des fonctionnalités communes à toutes les tâches planifiées qui sont décrites ci-dessous.

Sauvegarder la tâche

Si des informations obligatoires manquent dans la tâche, passer la souris sur le bouton d'enregistrement affichera les attributs encore vides.

Barre supérieure pour modifier la tâche planifiée

• Exécuter la tâche manuellement - l'administrateur peut exécuter la tâche manuellement en dehors de la planification définie
• Arrêter la tâche : l'administrateur peut arrêter une tâche planifiée en cours d'exécution. La tâche sera alors arrêtée et son statut passera à « Arrêté ». Elle restera dans cet état jusqu'à la prochaine exécution.
• Vider le cache de données : le cache de données pour le prochain provisionnement des utilisateurs et des groupes sera vidé. Cela signifie que la prochaine exécution sera exécutée comme la première fois.
  • Par défaut, nous vidons le cache tous les jours à 00h00 UTC
  • Si vous souhaitez vider le cache à un moment différent, vous devez spécifier une valeur différente dans le fichier hôte « custom.properties ».
  • Le cache EPE est également vidé lorsque EPE est redémarré, l'environnement entier est redémarré, les mappages EPE ont été modifiés
    

Informations sur les tâches d'événement

Lorsque vous cliquez sur la flèche au début de la ligne du connecteur, toutes les tâches planifiées et événementielles associées sont affichées

Barre supérieure pour les tâches d'événement

• Nouvelle tâche - ouvre la page de configuration pour une nouvelle tâche d'événement
• Supprimer la ou les tâches - supprime la ou les tâches sélectionnées, une fenêtre contextuelle apparaît pour confirmer la suppression
• Actualiser - actualise la vue des tâches d'événement
• Afficher les références de workflow : calcule les relations et les statuts des workflows liés aux tâches. Ceci est très utile si vous ignorez de quels workflows proviennent les tâches basées sur les événements.

Vue de liste pour les tâches d'événement

• Sélectionner la ou les tâches - Sélectionnez la tâche à supprimer dans la vue liste en cochant la case.
• ID : identifiant unique de la tâche. Généré automatiquement et non modifiable.
• Nom - Nom de la tâche ajouté aux paramètres de la tâche, nom unique de la tâche.
• Relations de flux de travail
  • Le point d'interrogation affiche une fenêtre contextuelle contenant des informations détaillées sur la référence
• Statut du flux de travail
  • Non utilisé - Aucune relation avec le flux de travail
  • En cours d'utilisation - Workflow(s) attaché(s) à la tâche, la tâche ne peut pas être supprimée
• Gérer
  • Icône de stylo - ouvre les paramètres de la tâche dans sa propre fenêtre
  • Icône papier - copie la tâche
  • Icône d'arrêt - supprime la tâche, une fenêtre contextuelle apparaît pour confirmer la suppression

Fenêtre d'édition pour la tâche d'événement

La configuration de la tâche d'événement peut être ouverte en cliquant sur l'icône du stylo ou en double-cliquant sur la ligne de la tâche.

Le menu de gauche et les attributs varient en fonction des options sélectionnées et, par conséquent, des instructions plus détaillées pour l'édition des tâches peuvent être trouvées dans la description du connecteur, mais il existe des fonctionnalités communes à toutes les tâches d'événement qui sont décrites ci-dessous.

Modifier la fenêtre des tâches d'événement

• Utilisation de la tâche, modifiable ? - cela apparaît lors de la modification d'une tâche existante et la modification du type d'utilisation de la tâche interrompt les flux de travail
• Type de mappage, modifiable ? - cela apparaît lors de la modification d'une tâche existante et la modification du type de mappage interrompt les flux de travail.

Sauvegarder la tâche

Si des informations obligatoires manquent dans la tâche, passez la souris sur le bouton Enregistrer pour afficher les attributs encore vides.

Onglet Authentification

L'authentification pour les solutions Matrix42 Core , Pro and IGA est configurée à partir de l'onglet Authentification. Notez que seuls certains connecteurs (connecteurs d'annuaire) prennent en charge l'authentification. Il n'est donc pas possible de créer des tâches d'authentification sur tous les connecteurs disponibles.

Barre supérieure pour l'authentification

• Nouveau connecteur - ouvre une nouvelle fenêtre pour configurer un nouveau connecteur (notez que tous les connecteurs ne prennent pas en charge l'authentification)
• Supprimer le(s) connecteur(s) - supprime la ou les tâches sélectionnées, une fenêtre contextuelle apparaît pour confirmer la suppression
• Exporter : l'utilisateur peut exporter une ou plusieurs tâches de l'environnement. Cette option est généralement utilisée pour exporter des tâches du test vers la production. Les connecteurs EPE sont protégés par mot de passe.
  • Notez que le domaine pour les tâches d'authentification n'est pas exporté, vous devez le définir manuellement après l'importation
• Importer : l'utilisateur peut importer une ou plusieurs tâches dans l'environnement. Ce paramètre est généralement utilisé pour importer des tâches de test vers la production.
• Actualiser - actualise la vue des tâches d'authentification

Vue de liste pour l'aperçu de l'authentification

• Sélectionner le(s) connecteur(s) - Sélectionnez un connecteur en cliquant sur la case à cocher devant la ligne de connecteur ou en cliquant sur la case à cocher dans la ligne d'en-tête pour sélectionner tous les connecteurs
• ID - Identifiant unique du connecteur généré automatiquement. Non modifiable.
• Nom - Nom du connecteur ajouté aux paramètres. Nom unique du connecteur contenant la configuration d'une source de données.
• Type - indique le système cible/source
• Count - informe du nombre de tâches d'authentification configurées
• Gérer
  • Icône de stylo - ouvre les paramètres de la tâche d'authentification dans sa propre fenêtre
  • Icône papier - copie la tâche
  • Icône d'arrêt - supprime la tâche sélectionnée

Informations sur la tâche d'authentification

Lorsque vous cliquez sur la flèche au début de la ligne du connecteur, toutes les tâches planifiées et événementielles associées sont affichées

Barre supérieure pour l'aperçu de l'authentification

• Créer une nouvelle tâche - ouvre la page de configuration pour une nouvelle tâche d'authentification
• Supprimer la ou les tâches - supprime la ou les tâches sélectionnées, une fenêtre contextuelle apparaît pour confirmer la suppression
• Actualiser - actualise la vue des tâches d'authentification

Vue de liste pour l'aperçu de l'authentification,

• Sélectionner la ou les tâches - Sélectionnez la tâche à supprimer dans la vue liste en cochant la case.
• ID : identifiant unique de la tâche. Généré automatiquement et non modifiable.
• Nom - Nom de la tâche ajouté aux paramètres de la tâche, nom unique de la tâche.
• Gérer
  • Icône de stylo - ouvre les paramètres de la tâche dans sa propre fenêtre (double-cliquez sur la ligne de la tâche pour ouvrir également la fenêtre des paramètres)
  • Icône papier - copie la tâche
  • Icône d'arrêt - supprime la tâche, une fenêtre contextuelle apparaît pour confirmer la suppression

Onglet Journaux

L'onglet Journaux permet de télécharger les journaux du connecteur natif et Secure Access à partir de l'interface utilisateur pour un dépannage détaillé.

• Journaux epe-master - contiennent des messages d'avertissement, de débogage et d'erreur sur les connecteurs natifs et des informations sur la durée pendant laquelle les actions de tâche ont été effectuées.
• Journaux epe-worker-ad : contient les données d'état extraites du connecteur Active Directory (ce que le connecteur natif charge pour les clients Matrix42 Core , Pro and IGA ). Si la sélection est vide, cela signifie que le répertoire n'est pas utilisé dans cet environnement.
• Journaux epe-worker-azure : contient l'état des données extraites de Entra ID (ce que Native Connector charge pour les clients Matrix42 Core , Pro and IGA ). Si la sélection est vide, cela signifie que le répertoire n'est pas utilisé dans cet environnement.
• Journaux epe-worker-ldap : contient l'état des données extraites LDAP (ce que Native Connector charge pour les clients Matrix42 Core , Pro and IGA ). Si la sélection est vide, cela signifie que l'annuaire n'est pas utilisé dans cet environnement.
• Journaux du lanceur epe - contient des informations sur les lancements EPE
• datapump-itsm l ogs - Contient des informations sur l'exportation de données vers les clients Matrix42 Core , Pro and IGA .
• Journaux esa - Contient des informations sur l'authentification Secure Access .

Onglet Paramètres

Les onglets Paramètres sont utilisés pour surveiller les environnements avec des connecteurs.

• Type d'environnement - doit obligatoirement être sélectionné et les informations sont utilisées par exemple pour définir une alerte de manière critique.
  • Test - sélectionnez cette option lorsque votre environnement est utilisé comme environnement de test
  • Pro d - sélectionnez cette option lorsque votre environnement est utilisé comme environnement de production
  • Démo - sélectionnez cette option lorsque votre environnement est utilisé comme environnement de démonstration ou de formation
  • Dev - sélectionnez cette option lorsque votre environnement est utilisé comme environnement de développement

Que surveillons-nous ?

• Échecs dans le provisionnement planifié (extraction de données, exportation de données vers ESM, certificats obsolètes, mots de passe incorrects, base de recherche/filtre incorrect, mappages incorrects, etc.)
• Échecs dans le provisionnement basé sur les événements (échec d'écriture dans AD / Azure , etc.)
• Provisionnement basé sur les événements : quels connecteurs sont utilisés pour écrire des données vers des applications/répertoires.
• ESA a enregistré plus de dix tentatives de connexion infructueuses pour un même utilisateur au cours des trois derniers jours.
• Type d'environnement - doit obligatoirement être sélectionné et les informations sont utilisées par exemple pour définir une alerte de manière critique.

Migrations de données

Ne cliquez pas sur « Migrer les mappages d’attributs » ou « Migrer les workflows », si Matrix42 ne vous le demande pas.

General info

Generic Python Script connector comes with couple out-of-the box Python scripts. You should not modify those. Instead, if you need to make modifications to those, copy-paste those to new name and then do your modifications to newly named python script file. And as last step, modify your connector to use that script.

Work order:

1. Create your custom scheduled or task-based script
2. Take it into use to connector from Connectors UI

Scheduled scripts

How to take your custom python script into use for scheduled tasks, guidance for 1 host and 1 worker environment:

Note! Do not change "default" .py files which came with environment installation.

Copy your customly named (in this example mypythonscript.py) python script to these folders from HOST (remember to use correct tenant_name in path):

cp mypythonscript.py /var/lib/efecteone/tenant_files/{tenant_name}/epe-master/files/custom-provisioning-scripts/only_scheduled

cp mypythonscript.py /var/lib/efecteone/tenant_files/{tenant_name}/epe-worker-1/files/custom-provisioning-scripts

cp mypythonscript.py /var/lib/efecteone/tenant_files/{tenant_name}/epe-master/files/custom-provisioning-scripts

Change your custom python script file permission to 755 on all those above locations where you copied your script(in this example mypythonscript.py) (remember to use correct tenant_name in path):

chmod 755 /var/lib/efecteone/tenant_files/{tenant_name}/epe-master/files/custom-provisioning-scripts/only_scheduled/mypythonscript.py

chmod 755 /var/lib/efecteone/tenant_files/{tenant_name}/epe-worker-1/files/custom-provisioning-scripts/mypythonscript.py

chmod 755 /var/lib/efecteone/tenant_files/{tenant_name}/epe-master/files/custom-provisioning-scripts/mypythonscript.py

If you have more hosts, repeat on every host.

If you have more workers, repeat to every worker(check that worker folder name is correct).

Event-based scripts

How to take your custom python script into use for event-based tasks, guidance for 1 host environment:

Note! Do not change "default" .py files which came with environment installation.

Copy your customly named (in this example mypythonscript.py) python script to these folders from HOST (remember to use correct tenant_name in path):

cp mypythonscript.py /var/lib/efecteone/tenant_files/{tenant_name}/epe-master/files/custom-provisioning-scripts/only_event

cp mypythonscript.py /var/lib/efecteone/tenant_files/{tenant_name}/epe-master/files/custom-provisioning-scripts

Change your custom python script file permission to 755 on all those above locations where you copied your script(in this example mypythonscript.py) (remember to use correct tenant_name in path):

chmod 755 /var/lib/efecteone/tenant_files/{tenant_name}/epe-master/files/custom-provisioning-scripts/only_event/mypythonscript.py

chmod 755 /var/lib/efecteone/tenant_files/{tenant_name}/epe-master/files/custom-provisioning-scripts/mypythonscript.py

If you have more hosts, repeat on every host.

#!/usr/bin/python3

import json
import sys
import logging

def main():
    # Configure logging, change log file name
    logging.basicConfig(filename='python_event_task_abc.log', level=logging.INFO, format='%(asctime)s - %(message)s')
    
    # Read inputs from stdin
    lines = sys.stdin.read().splitlines()

    if len(lines) != 2:
        print("Error: Expected exactly two lines of input.")
        raise Exception("Expected exactly two lines of input.")

    # Parse the first line, this contains connector variables
    try:
        connector_parameters = json.loads(lines[0])
        host = connector_parameters.get('host', None)
        password = connector_parameters.get('password', None)
        logging.info(f"Connector parameters, Host={host}")
        # read custom connector parameters here
    except json.JSONDecodeError:
        raise Exception("Connector parameters is not a valid JSON string.") 

    # Parse the second line, this contains mappings data from template datacard
    try:
        task_mappings = json.loads(lines[1])
        logging.info(f"Task mappings JSON: {task_mappings}")
        #read task mappings data here

        # Implement your logic here

        
    except json.JSONDecodeError as e:
        raise Exception("Task mappings is not a valid JSON string.") from e
        # Exceptions raised are controlling workflow orchestration node flow, on exception it goes to Exception path, otherwise it goes to Completed path. Exception raised can be seen on Provisioning exception attribute value.
    except Exception as e:
        raise Exception("An unexpected error occurred") from e

if __name__ == "__main__":
    main()

Take customly named script into use to connector

How to take your customly named Python script into use, by selecting it from Connectors UI. Select your script from connectors Provisioning script -dropdown: