Page Documentation

Cette page et ses sous-pages vous permettent de saisir les informations importantes pour l'objetLes activités et déroulements que contrôle l'Automation Engine sont représentés à l'aide d'objets (voir aussi Tâche).. Ces informations peuvent être structurées ou non.

Par défaut, lorsque vous ouvrez l'onglet Documentation, la page principale vous permettant de saisir de la documentation non structurée, s'ouvre. Des sous-pages supplémentaires peuvent également être proposées pour saisir de la documentation. Le nombre et le type de sous-pages proposées pour documenter l'objet dépend de votre configurationUn ensemble de composants qui constituent un système. Ceci comprend des informations relatives à la manière dont les composants sont connectés, ainsi que les paramètres appliqués. système, puisque c'est l'administrateur système qui le définit dans la variable UC_OBJECT_DOCU du clientEnvironnement indépendant pour la création et l'exécution d'objets dans un système AE. Le nom d'un client est un nombre de quatre chiffres à saisir lors de la connexion d'un utilisateur au système AE. Les utilisateurs et leurs droits y sont aussi définis.Egalement un type d'objet distinct dans l'Automation Engine. 0 (les pages non structurées sont simplement définies par des valeurs séparées par des virgules, tandis que les pages non structurées sont définies par des valeurs séparées par des virgules et un préfixe "@").

Documentation non structurée

De manière générale, la documentation non structurée vous sert à saisir les informations de maintenance et d'urgence relatives à l'objet sous forme de texte libre, à des fins de conseils d'utilisation dans Automation EngineCe composant commande un système Automation Engine. Il se compose de plusieurs processus serveur., etc.

Documentation structurée

La documentation structurée peut être utilisée pour diviser la grande quantité d'informations d'un objet en parties clairement organisées. Dans la documentation structurée, vous pouvez utiliser le langage de scriptEgalement un type d'objet distinct dans l'Automation Engine. Automation Engine pour lire les valeurs à l'aide d'un Objet script (SCRI). Les paramètres contenus dans cette page peuvent être ensuite demandés par d'autres objets exécutables.

Outre des attributs et du texte, vous pouvez également saisir des liens vers des fichiers, des dossiers, des documents, l'intranet ou Internet. Les fichiers et documents liés s'ouvrent dans les programmes et les URL appellent le navigateur par défaut en fonction des programmes installés et de la configuration du PC.

Règles et conventions

Le nom des nœuds et des attributs devant être conforme aux conventions de nommage XML, vous pouvez utiliser des caractères alphanumériques aussi bien que les signes "-", ".", "_".

Les règles suivantes doivent être respectées :

La lecture de la documentation structurée requiert des éléments de script spécifiques (XML_*)

ClosedCréer une documentation structurée

Pour créer une documentation structurée, créez une structure de nœuds et sous-nœuds, puis ajoutez à ces nœuds des attributs avec des valeurs.

  1. Ouvrez la sous-page vous permettant de saisir des informations structurées. La quantité de sous-pages disponibles pour la documentation et leur mode d'activation dépend de votre configuration système.

    La barre d'outils de documentation propose les fonctions nécessaires à la création de structures de nœuds et sous-nœuds.

  2. Vous pouvez créer autant de nœuds parents et enfants que nécessaire :
    1. Cliquez sur le bouton Ajouter nœud de la barre d'outils pour saisir le nom de nœud dans la boîte de dialogue qui s'ouvre. Respectez les règles et conventions de nommage mentionnées ci-dessus. Vous pouvez créer autant de nœuds que nécessaire.
    2. Les nœuds enfants peuvent être créés de deux manières :
    3. Pour trier l'ordre des nœuds dans l'arborescence, faites-les glisser vers leur nouvel emplacement.
    4. Cliquez sur le bouton Supprimer élément pour supprimer un nœud existant.
    5. Cliquez sur le bouton Éditer élément pour le renommer.
    6. Cliquez sur le bouton Dupliquer élément pour créer un même nœud au même endroit exactement.
  3. Ajouter des attributs aux nœuds :
    1. Sélectionnez un nœud, puis cliquez sur le bouton Ajouter attribut.
    2. Dans la boîte de dialogue Ajouter attribut, saisissez le nom de l'attribut et définissez son type :
      • Sélectionnez Texte et saisissez une valeur dans le champ de saisie en-dessous.
      • Sélectionnez Enumération pour créer une liste déroulante avec les valeurs saisies dans le tableau :

        Pour ajouter / éditer une ligne, vous devez d'abord cocher sa case pour l'activer. Vous disposez alors des options suivantes :

        Option

        Description

        Insère une nouvelle ligne en bas du tableau

        Supprime la ligne

        Supprime l'entrée de la liste et la colle dans le presse-papiers. Cliquez sur Coller pour l'ajouter en bas du tableau.

        Duplique l'entrée. Cliquez sur Coller pour l'ajouter en bas du tableau.
        Active toutes les lignes du tableau.

    3. Cliquez sur Ajouter pour insérer le nouvel attribut dans la liste Attributs, ou Ajouter et nouveau pour continuer à définir des attributs.
  4. Enregistrez vos modifications.