SAINET apis and documentation (stable/4.8.x)

Tâches et lanceurs

Cette catégorie contient toutes les actions disponibles sur les tâches telles que ouvertures, lancement des traitements, etc…


Ouvrir une tâche
Appeler la fonction run sur une tâche/page
Lancer un traitement/une vue
Créer une nouvelle page dans la tâche
Attendre que la tâche soit fermée pour continuer
Selectionner une entrée dans un des navigateurs de la tâche
Selectionner une page dans l'arbre de pages de la tâche
Imprimer la fiche
Valider la page courante

Ouvrir une tâche

L’action open_task permet d’ouvrir une tâche dans la société souhaitée avec des paramètres initiaux de type écran ou visuel. Il est possible de préselectionner des entrées voir des pages dans le cas de tâches de type dossier.

Exemples

<action type="open_task" taskId="${actionId}">
  <screen>
    <field id="MOIS_DEBUT" datafieldId="SAL_MOIS_DEBANN">${CURRENT_MONTH}</field>
    <field id="MOIS_FIN" datafieldId="SAL_MOIS_FINANN">${CURRENT_MONTH}</field>
  </screen>
</action>

Cette action va ouvrir la tâche définie par le paramétrage du popup dans le domaine courant de l’utilisateur. Dans cette tâche, les champs MOIS_DEBUT et MOIS_FIN seront remplis avec le mois courant

<action type="open_task" taskId="SALE4" domainId="${SALSOC.ID_PK}">
  <presentation state="maximized" />
</action>

Cette action va ouvrir le SALE4 dans le domaine récupéré du contexte. Cette tâche sera en plein écran

<action type="open_task" taskId="SALSE">
  <screen>
    <field id="2" datafieldId="DEFAULT_VIEW_FILTER"><![CDATA[Employé: '${SALEMP.ID_PK}' , Année : '${current_year}' , Mois : '${current_month}']]></field>
  </screen>
  <presentation type="full_simplified" />
</action>

Cette action ouvre le SALSE dans le domaine courant. La tâche remplit le filtre automatiquement par des valeurs venant du contexte. La tâche est présentée en mode fenetré simplifié (pas de barres, pas de paramètres, juste la grille resultante)

Inputs

taskId : string

L’identifiant de la tâche à lancer (ex : SAL24, CRMX6, etc…)

domainId : string

L’identifiant de la société dans laquelle la tâche va être lancée. Cette société doit être disponible à l’utilisateur et la tâche doit être disponible dans cette société.

modal : boolean

Détermine si la fenêtre est modale (false par défaut). Si cette valeur est true, la notification va s’arrêter jusqu’à ce que l’utilisateur ait fermé la fenêtre.

screen : node xml

Ce noeud xml représente une une définition d’écran standard dans les actions (detail). Ce noeud n’est pas compatible avec key et filter.

key : node xml

Ce noeud xml représente une clé d’un record dans la base suivant la structure standard d’une clé dans le framework SAINET (detail). Ce noeud n’est pas compatible avec screen et filter.

page : node xml

Ce noeud xml permet de selectionner une page (detail). Ce noeud n’est pas compatible avec screen et filter mais est compatible avec une key

filter : node xml

Noeud permettant d’appliquer un filtre. Ce noeud n’est pas compatible avec une key et screen.

presentation : node xml

Ce noeud xml permet de définir le visuel d’une tâche (detail).

Outputs

Aucune variable du context n’est ajoutée ou modifiée lors de cette action.

Appeler la fonction run sur une tâche/page

L’action run_task va appeler la méthode run sur le serveur en lui transmettant le contexte courant (la page ou la tâche). Dans les session-vars, il y aura les variables suivantes:

NOTIFICATION_ACTIONID

Contient la valeur définie dans l’attribut ActionID du popup ou vide si non défini.

NOTIFICATION_POPUPID

Contient le nom du popup depuis lequel l’appel a été fait.

NOTIFICATION_ITEMID

Contient l’identifiant de l’item du popup depuis lequel l’appel a été fait.

Exemple

<action type="run_task"></action>

Inputs

Aucun input particulier pour cette action

Outputs

Aucun output particulier pour cette action

Lancer un traitement/une vue

L’action execute_task permet de lancer un traitement ou une vue. Dans le cas d’une tâche de vue, cela revient à appuyer sur le bouton afficher qui rafraichit la vue. Dans le cas d’une tâche de traitement ou de liste cela va lancer le traitement en question.

Exemple

<action type="execute_task"></action>

Inputs

Aucun input particulier pour cette action

Outputs

Aucun output particulier pour cette action

Créer une nouvelle page dans la tâche

L’action create_task_page ouvre soit une nouvelle page du type demandé dans le contexte qui doit être un dossier, soit ouvre l’abre des thêmes si la page n’est pas fournie.

Exemple

<action type="create_task_page" datapageId="SECTION">
  <screen>
    ...
  </screen>
</action>

Dans le contexte de dossier fourni, la page SECTION va être préparée. L’utilisateur peut alors la remplir et valider.

<action type="create_task_page" />

Dans ce contexte de dossier le système va simplement ouvrir l’arbre des themes

Inputs

datapageId Le type de page à créer tel que définie par le descripteur de datapage de la table associée à la tâche du contexte, ou vide si on veut juste ouvrir l’arbre des thêmes.

screen : node xml

Dans le cas ou la page a été précisée, ce noeud contient les valeurs a insérer dans la tâche manuellement au moment de la création. Ceci permet d’overrider des valeurs par defaut. C’est une définition d’écran standard dans les actions (plus de details)

Outputs

Aucun output particulier pour cette action

Attendre que la tâche soit fermée pour continuer

L’action wait_for_task_close attend que la tâche soit fermée pour continuer. La tâche ne peut pas être la tâche initiale de la notification mais seulement une tâche ouverte pendant la notification.

Exemple

<action type="wait_for_task_close" />

Inputs

Aucun input particulier pour cette action.

Outputs

Aucun output particulier pour cette action.

Selectionner une entrée dans un des navigateurs de la tâche

L’action select_record permet de selectionner (optionnellement dans un onglet de supertâche spécifique) Une entrée de navigateur. Dans le cas d’une tâche de type Dossier, il est possible de selectionner une page particulière suite à l’ouverture du record

Exemples

<action type="select_record" tab="CRM06-1">
  <key>
  <datafield datafieldId="CRMPRJ.ID_PK">15-00091</datafield>
  </key>
  <page occurrence="3">PAGE_INTERVENANT</page>
</action>

Cette action va selectionner l’entrée 15-00091 dans l’onglet d’id unique CRM06-1. Il va ensuite essayer d’ouvrir la page PAGE_INTERVENANT d’occurrence 3

Inputs

tab : string

L’identifiant unique de l’onglet à selectionner. Optionnel dans le cas ou ce n’est pas une supertâche ou si on veut garder l’onglet principal/courant comme acteur de l’action.

key : node xml

Ce noeud xml représente une clé d’un record dans la base suivant la structure standard d’une clé dans le framework SAINET (detail). Ce noeud n’est pas compatible avec screen.

page : node xml

Ce noeud xml permet de selectionner une page (detail). Ce noeud n’est pas compatible avec screen mais est compatible avec une key

Outputs

Aucune variable du context n’est ajoutée ou modifiée lors de cette action

Selectionner une page dans l'arbre de pages de la tâche

L’action select_page permet de selectionner une page dans le dossier courant.

Exemples

<action type="select_page" datapageId="SECTION" occurrence="2"></action>

Cette action va selectionner la page SECTION d’occurrence 2 dans le dossier courant

Inputs

datapageId : string

L’identifiant de la page à selectionner

occurrence : number

L’occurrence unique de la page du type défini par datapageId

Outputs

Aucune variable du context n’est ajoutée ou modifiée lors de cette action

L’action print_fiche lance la fiche d’impression de l’enregistrement courant.

Exemple

<action type="print_fiche" configId="CFG1" />

Inputs

configId : string

L’identifiant de configuration de fiche à utiliser (définit dans SYS26).

Outputs

Aucun output particulier pour cette action.

Valider la page courante

L’action validate_page permet de valider la page courante du dossier. La page doit être dans un état validable, ou une erreur apparaitra.

Exemples

<action type="validate_page"></action>

Cette action va valider la page courante

Inputs

Aucun Input nécéssaire à cette action

Outputs

Aucune variable du context n’est ajoutée ou modifiée lors de cette action