Aller au contenu

Rapport Texte

Résumé

  • Nom interne : TextReport
  • Catégorie : Outils
  • Objectif : Écrire un message texte dans le rapport d'exécution AndroMate avec un type d'affichage spécifié (Info, Titre ou Erreur).
  • Type de tâche : Normale

Compatibilité

  • Version minimale AndroMate : 1.1.0

  • Version maximale AndroMate : 1.1.0

  • Android minimum : Android 13 (API 33)

  • Android maximum testé : Android 16 (API 36)

  • Constructeurs supportés :

    • Samsung (One UI 6.x / 7.x / 8.x)
    • Autres constructeurs - pas encore supportés (Xiaomi HyperOS et Google Pixel en cours d'adaptation)
  • Permissions requises :

    • Aucune

Description détaillée

La tâche Rapport Texte écrit un message dans le rapport d'exécution AndroMate pendant l'exécution du workflow. Le message est résolu depuis le champ texte (supporte les références $variable_workflow) et rendu selon le type d'affichage défini dans texte_type.

Trois types d'affichage sont disponibles :

Valeur texte_type Type d'affichage Effet
"Info Text" Informatif Ajoute un message informatif standard au rapport
"Title Text" Titre / En-tête Ajoute un titre ou un en-tête de section au rapport
"Error Text" Erreur Ajoute un message d'erreur au rapport

Remarque : Toute valeur de texte_type autre que les trois listées ci-dessus déclenche une exception Text-Report-ERROR-001.


Paramètres d'entrée

Paramètre Type Obligatoire Valeurs possibles Compatibilité Android Compatibilité AndroMate Défaut
texte String Oui Toute chaîne - supporte les références $variable Android 13 (API 33) -> Android 16 (API 36) 1.1.0 -> 1.1.0 ""
texte_type String Oui "Info Text" / "Title Text" / "Error Text" Android 13 (API 33) -> Android 16 (API 36) 1.1.0 -> 1.1.0 ""

Paramètres de sortie

Cette tâche ne produit aucune variable de sortie. Elle retourne VoidResult.

Champ Type Condition de déclenchement Compatibilité Android Compatibilité AndroMate Défaut
- VoidResult Toujours - - -

Exceptions

Code Nom de l'exception Description
Text-Report-ERROR-001 Type de texte non supporté La valeur fournie dans texte_type ne fait pas partie des types supportés : "Info Text", "Title Text", "Error Text".
ERROR-000 Autre erreur Une erreur runtime inattendue s'est produite pendant l'exécution.

Diagramme d'exécution

Le diagramme suivant illustre l'implémentation réelle basée sur le code Android :

flowchart TD
    Start([Démarrer TextReportTask]) --> ResolveText[Résoudre texte\ndepuis le contexte workflow]
    ResolveText --> ParseType{Parser texte_type}

    ParseType -->|"Info Text"| InfoOp[rs.info\nÉcrire message info dans le rapport]
    ParseType -->|"Title Text"| TitleOp[rs.appendTitle\nÉcrire titre dans le rapport]
    ParseType -->|"Error Text"| ErrorOp[rs.errorMsg\nÉcrire message d'erreur dans le rapport]
    ParseType -->|Inconnu| E1[Text-Report-ERROR-001]

    InfoOp --> Success([VoidResult])
    TitleOp --> Success
    ErrorOp --> Success
    E1 --> Error([Exception])

    style Start fill:#e3f2fd
    style Success fill:#c8e6c9
    style Error fill:#ffcdd2
    style E1 fill:#ffcdd2
    style ResolveText fill:#fff9c4
    style InfoOp fill:#c8e6c9
    style TitleOp fill:#c8e6c9
    style ErrorOp fill:#ffe0e0

Comment ça fonctionne :

  1. Résoudre le texte : texte est résolu depuis le contexte workflow (remplacement des références $variable)
  2. Parser le type : texte_type est comparé aux trois valeurs supportées (insensible à la casse)
  3. Écrire dans le rapport : la méthode de rapport appropriée est appelée
  4. Résultat : retourne VoidResult en cas de succès

Exemples de code

Exemple 1 - Message d'information

{
  "TextReport": [
    {
      "id": "1",
      "title": "Journaliser l'étape",
      "texte": "Ping démarré vers 8.8.8.8",
      "texte_type": "Info Text"
    }
  ]
}

Exemple 2 - Titre de section

{
  "TextReport": [
    {
      "id": "2",
      "title": "En-tête de section",
      "texte": "Mesures Réseau",
      "texte_type": "Title Text"
    }
  ]
}

Exemple 3 - Message d'erreur avec variable

{
  "TextReport": [
    {
      "id": "3",
      "title": "Journaliser l'échec",
      "texte": "Tâche $id_tache_echouee en échec : [$code_erreur] $desc_erreur",
      "texte_type": "Error Text"
    }
  ]
}

Détails des paramètres d'entrée

1. Paramètre d'entrée : texte

Le contenu textuel à écrire dans le rapport d'exécution. Supporte les références $variable_workflow - résolues à l'exécution avant l'écriture.

  • Défaut : "" (chaîne vide)
  • Supporte les variables : Oui

2. Paramètre d'entrée : texte_type

Contrôle comment le message est rendu dans le rapport d'exécution AndroMate.

Valeur Méthode de rapport Rendu
"Info Text" rs.info() Message informatif standard
"Title Text" rs.appendTitle() En-tête de section / titre
"Error Text" rs.errorMsg() Message d'erreur
  • Défaut : "" - déclenche Text-Report-ERROR-001 si non renseigné avec une valeur valide

Exemple JSON complet

{
  "TextReport": [
    {
      "id": "1",
      "title": "Journaliser résultat téléchargement",
      "texte": "Téléchargé $octets_dl octets en $temps_dl_ms ms",
      "texte_type": "Info Text"
    }
  ]
}