Cette section explique comment configurer les connecteurs pour les utiliser dans l'étape Activité personnalisée.

Pour pouvoir utiliser des connecteurs dans votre robot, sélectionnez Autoriser l'utilisation de connecteurs dans l'onglet Sécurité de l'application Paramètres du RoboServer. L'application Paramètres du RoboServer peut être lancée à partir du menu Démarrer de Windows. Pour plus d'informations, consultez « Configuraton de RoboServer » dans le Guide de l'administrateur de Kofax RPA.

Pour utiliser vos connecteurs personnalisés avec le dispositif local dans votre robot, sélectionnez l'option Autoriser l'utilisation des connecteurs dans l'application Paramètres de RoboServer du dispositif local RoboServer.

Le fichier manifest.json doit contenir les éléments JSON suivants :

Activité

Le format des activités est détaillé dans le tableau suivant.

Tableau 1. Format d'activité

Champ	État	Description
nom	requis	Nom de l'activité.
type	requis	Type de l'activité. Il doit s'agir d'un des éléments suivants : « program », « shell », « node » ou « python ».
paramètres	facultatif	Ensemble de paramètres représentés dans l'étape d'activité personnalisée sous forme de champs d'entrée.
réponse	facultatif	Ensemble de réponses représentées dans l'étape d'activité personnalisée comme champs de sortie. Si ce champ est omis, un ensemble de réponses par défaut est utilisé en fonction de la définition de l'activité.
commandline	requis	Ensemble de chaînes de caractères représentant les paramètres de la commande de demande. Pour les activités « program », le premier paramètre est l'exécutable. Les paramètres peuvent être insérés en utilisant des échappements %n (insertion de la nième valeur du tableau des paramètres). Utilisez %% pour insérer un signe de pourcentage. Les éléments qui sont vides après la substitution de paramètres sont supprimés. Pour les demandes « node » et « python », il est permis d'envoyer des scripts complets.
prune	facultatif	Booléen Indique que les éléments développés en chaîne vide doivent être supprimés du tableau de la ligne de commande. Valeur par défaut : true
attendre	facultatif	Booléen Indique que le robot doit attendre la fin de l'activité. Ce paramètre est ignoré pour les activités « node » et « python » ou si l'activité possède un tableau de réponse. Valeur par défaut : true
stdout	facultatif	Booléen Permet la capture du flux de sortie standard à partir d'une activité « program » ou « shell » dans une variable. Ce champ est ignoré si « wait » a la valeur false. Valeur par défaut : false
stderr	facultatif	Booléen Permet la capture du flux d'erreur standard à partir d'une activité « program » ou « shell » dans une variable. Ce champ est ignoré si « wait » a la valeur false. Valeur par défaut : false

Paramètre

Le format des paramètres est détaillé dans le tableau suivant.

Tableau 2. Format des paramètres

Champ	État	Description
nom	requis	Nom du paramètre. Le nom est indiqué dans l'étape d'activité personnalisée.
type	requis	Type du paramètre. Le type doit être l'un des types suivants : « chaîne » ou « nombre » Les paramètres « number » sont limités aux nombres entiers.
default	facultatif	Valeur par défaut du paramètre. Par défaut : "" ou 0 selon le type de paramètre.
min	facultatif	Nombre Valeur minimale autorisée pour le paramètre. Cet attribut n'est pris en charge que pour les paramètres « number » ; il est ignoré pour les autres types. Par défaut : -2147483648
max	facultatif	Nombre Valeur maximale autorisée pour le paramètre. Cet attribut n'est pris en charge que pour les paramètres « number » ; il est ignoré pour les autres types. Par défaut : +2147483647
facultatif	facultatif	Booléen Les paramètres facultatifs peuvent être laissés non assignés ou vides dans le robot. Valeur par défaut : false
escape	facultatif	Booléen Placez la valeur entre guillemets et échappez les caractères spéciaux. Cet attribut est actuellement pris en charge pour les paramètres de chaîne « node » et « python » ; il est ignoré dans tous les autres cas. Valeur par défaut : true

Pour les paramètres numériques, la valeur par défaut doit être comprise entre les valeurs min et max (incluses). Les trois valeurs doivent être comprises entre -2147483648 et +2147483647 (inclus).

Réponse

Le tableau suivant décrit le format de la réponse.

Tableau 3. Format de la réponse

Champ	État	Description
nom	requis	Nom de la réponse. Le nom est indiqué dans l'étape d'activité personnalisée.
type	requis	Type de réponse. Le type doit être l'un des types suivants : « chaîne » ou « nombre » Les réponses « nombre » sont converties en nombres entiers.
facultatif	facultatif	Booléen Indique que la réponse n'a pas à être présente dans la sortie. Si la réponse est omise, la variable est remplie avec sa valeur par défaut. Valeur par défaut : false
default	facultatif	Valeur par défaut du paramètre. Cette valeur est utilisée si un paramètre facultatif est omis dans la réponse. Par défaut : "" ou 0 selon le type de paramètre.

Les valeurs numériques à virgule flottante dans la réponse de l'application sont converties en nombres entiers.

exemples manifest.json

Les exemples suivants, basés sur Linux, utilisent différents connecteurs (shell, node, python, programme) qui appellent des fonctions correspondantes pour ajouter deux nombres. Les paramètres de la fonction sont définis dans l'ordre dans lequel ils sont transmis à cette fonction, par exemple : Premier numéro et deuxième numéro. Le résultat du calcul est renvoyé au robot dans la variable affectée de la valeur Sum. La valeur de sortie est attribuée différemment selon les connecteurs.

python.connector

Pour que ce connecteur fonctionne, installez la dernière version de Python sur l'ordinateur où un robot doté de ce connecteur s'exécute.

{"actions": [
    {
      "name": "Adder",
      "type": "python",
      "parameters": [
        {
          "name": "First number",
          "type": "number"
        },
        {
          "name": "Second number",
          "type": "number",
          "min": 1,
          "default": 1000
        }
      ],
      "response": [
        {
          "name": "Sum",
          "type": "number"
        }
      ],
      "commandline": [
        "rpa_return = { 'Sum': %1 + %2 }"
      ]
    }
  ],
  "name": "Adder Function (python)"
}

shell.connector

{
  "actions": [
    {
      "name": "Adder",
      "type": "shell",
      "parameters": [
        {
          "name": "First number",
          "type": "number"
        },
        {
          "name": "Second number",
          "type": "number",
          "min": 1,
          "default": 1000
        }
      ],
      "response": [
        {
          "name": "Sum",
          "type": "number"
        }
      ],
      "commandline": [
	"echo \"{ \\\"Sum\\\": $((%1 + %2)) }\""
      ]
    }
  ],
  "name": "Adder Function (shell)"
}

node.connector

{
  "actions": [
    {
      "name": "Adder",
      "type": "node",
      "parameters": [
        {
          "name": "First number",
          "type": "number"
        },
        {
          "name": "Second number",
          "type": "number",
          "min": 1,
          "default": 1000
        }
      ],
      "response": [
        {
          "name": "Sum",
          "type": "number"
        }
      ],
      "commandline": [
        "return { Sum: %1 + %2 };"
      ]
    }
  ],
  "name": "Adder Function (node)"
}

program.connector

Ce connecteur utilise un programme exécutable « add » appelé par le connecteur.

{
  "actions": [
    {
      "name": "Adder",
      "type": "program",
      "parameters": [
        {
          "name": "First number",
          "type": "number"
        },
        {
          "name": "Second number",
          "type": "number",
          "min": 1,
          "default": 1000
        }
      ],
      "response": [
        {
          "name": "Sum",
          "type": "number"
        }
      ],
      "commandline": [
        "./add", "%1", "%2"
      ]
    }
  ],
  "name": "Adder Function (program)"
}

Définitions des réponses

Programme

• Si l'activité comporte un tableau de réponses, le champ d'attente est ignoré et le robot attend que le programme se termine. La sortie standard du programme est capturée et analysée comme une chaîne JSON, et les variables sont remplies avec les champs respectifs de cette chaîne. Le robot échoue si le programme ne produit pas une chaîne JSON valide.
• Si l'activité n'a pas de tableau de réponses et que le champ d'attente est faux, l'étape n'a pas de variables de réponse.
• Si l'activité n'a pas de tableau de réponses et que le champ d'attente est vrai, l'étape a les variables de réponse suivantes :
  • rc : Code de retour du programme.
  • stdout : Flux de sortie standard du programme (fourni uniquement si stdout est vrai).
  • stderr : Flux d'erreur standard du programme (fourni uniquement si stderr est vrai).

Quelle que soit la configuration du connecteur, le flux de sortie standard et le flux d'erreur standard sont enregistrés au niveau INFO dans les journaux Kofax RPA.

Shell

Les activités de shell sont exécutées en utilisant CMD.EXE sous Windows, et bash sous Linux.

• Si l'activité possède un tableau de réponses, le champ d'attente est ignoré et le robot attend que le shell se termine. La sortie standard du shell est capturée et analysée comme une chaîne JSON, et les variables sont remplies avec les champs respectifs de cette chaîne. Le robot échoue si le programme ne produit pas une chaîne JSON valide.
• Si l'activité n'a pas de tableau de réponses et que le champ d'attente est faux, l'étape n'a pas de variables de réponse.
• Si l'activité n'a pas de tableau de réponses et que le champ d'attente est vrai, l'étape a les variables de réponse suivantes :
  • rc : Code de retour du shell.
  • stdout : Flux de sortie standard du shell (fourni uniquement si stdout est vrai).
  • stderr : Flux d'erreur standard du shell (fourni uniquement si stderr est vrai).

Quelle que soit la configuration du connecteur, le flux de sortie standard et le flux d'erreur standard sont enregistrés au niveau INFO dans les journaux Kofax RPA.

NodeJS

La ligne de commande est exécutée dans le contexte d'une fonction. La commande doit utiliser l'instruction return pour renvoyer ses résultats au robot.

• Si l'activité comporte un bloc de réponse, elle est censée renvoyer un objet ou une chaîne JSON, et les variables sont remplies avec les champs respectifs de cet objet. Le robot échoue si une exception est émise et qu'elle n'est pas traitée.
• Si l'activité ne comporte pas de bloc de réponse, l'étape comporte les deux variables de réponse suivantes :

  result : Si l'instruction a abouti, cette variable reçoit la valeur qu'elle renvoie.

  error : Si une exception est émise et qu'elle n'est pas traitée dans le code JavaScript, cette variable contient le texte de l'exception.

Python

La ligne de commande est exécutée à l'aide de la fonction exec(). La commande doit attribuer une valeur à la variable globale rpa_return pour renvoyer ses résultats au robot.

1. Si l'activité comporte un bloc de réponse, rpa_return doit contenir un objet ou une chaîne JSON, et les variables sont remplies avec les champs respectifs de cet objet. Le robot échoue si une exception est émise et qu'elle n'est pas traitée.

1. Si l'activité ne comporte pas de bloc de réponse, l'étape comporte les deux variables de réponse suivantes :

   • result : Si l'instruction a abouti; cette variable reçoit la valeur rpa_return.

   • error : Si une exception est émise et n'est pas traitée dans le code Python, cette variable contient le texte de l'exception.

Informations sur la mise en œuvre

Les éléments suivants du fichier .zip sont réservés :

Type	Chemin	Description
fichier	/manifest.json	Manifeste
fichier	/node	Exécutable Node.js pour la plate-forme Linux. Si ce fichier n'est pas présent, l'instance Node.js incluse avec Kofax RPA est utilisée.
fichier	/node.exe	Exécutable Node.js pour la plate-forme Windows. Si ce fichier n'est pas présent, l'instance Node.js incluse avec Kofax RPA est utilisée.
répertoire	/node_modules	Emplacement des modules de Node.js.
répertoire	/RPAConnector	Réservé à un usage interne.
répertoire	/node_modules/RPAConnector	Réservé à un usage interne.