Flux

Une fiche « Flux », telle que l'API la lit et l'écrit (Flow dans la référence). Sa liste et sa création : https://staging-api.docage.com/Flows ; une fiche : https://staging-api.docage.com/Flows/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.

Ses propriétés

• ConcurrencyModeFlowConcurrencyMode

  Mode de concurrence

• CreditsSpentnombreÉcrite par le serveur

  Crédits dépensés

• DepthentierÉcrite par le serveur

  Profondeur

• Descriptiontexte

  Description

• EndedOndate et heure (UTC)Écrite par le serveur

  Fin

• EntryFlowNodeIdidentifiantÉcrite par le serveur

  Identifiant du nœud d'entrée

• ErrorBranchFinalStatusFlowErrorBranchFinalStatus

  Le statut final d'une exécution dont une étape a échoué et a suivi sa branche d'erreur. Lu par FlowExecutor.ConcludeIfFinished ; recopié du modèle dans chaque exécution comme les autres réglages.

• ErrorMessagetexteÉcrite par le serveur

  Message d'erreur

• ErrorPolicyFlowErrorPolicy

  Politique d'erreur

• ExecutionModeFlowExecutionModeÉcrite par le serveur

  Le régime de cette exécution, et non celui du modèle, qui peut porter les deux : une exécution interne (Internal) ne suit que les liens internes, une exécution différée (Deferred) que les autres ; une exécution ne mélange jamais les deux. Un flux dont le départ porte les deux sortes de branches produit donc deux exécutions : l'une jouée pendant l'enregistrement de la fiche, l'autre ensuite, par la file d'attente des exécutions. Une exécution interne est déjà terminée quand elle est enregistrée.

• FlowCanvasFlowCanvasÉcrite par le serveur

  Canevas

• FlowLinksliste de FlowLinkÉcrite par le serveur

  Liens

• FlowNodesliste de FlowNodeÉcrite par le serveur

  Nœuds

• FlowVariablesliste de FlowVariableÉcrite par le serveur

  Variables

• IsEnabledoui ou nonÉcrite par le serveur

  Actif

• IsPreviewoui ou nonÉcrite par le serveur

  Prévisualisation

• LastNodeNumberentierÉcrite par le serveur

  Dernier numéro d'étape

• LeasedBytexteÉcrite par le serveur

  Bail détenu par

• LeasedUntildate et heure (UTC)Écrite par le serveur

  Bail jusqu'à

• MaxCreditsPerDayentier

  Crédits maximum par jour

• MaxRunsPerTargetPerDayentier

  Exécutions maximum par entité et par jour

• MergeEntitiesliste de MergeEntity

  Entités de fusion

• OwnerDocageUserIdidentifiantÉcrite par le serveur

  Identifiant du propriétaire

• ResumeAfterdate et heure (UTC)Écrite par le serveur

  Reprise après

• RunAsDocageUserIdidentifiantÉcrite par le serveur

  Identifiant de l'identité d'exécution

• RunAsModeFlowRunAsMode

  L'identité sous laquelle le flux agit : l'utilisateur à l'origine du déclenchement s'il y en a un, sinon le propriétaire du modèle (FlowRunAsMode.Executant, par défaut), ou toujours le propriétaire du modèle (FlowRunAsMode.TemplateOwner) — qui ne peut être que le créateur du modèle ou l'auteur du formulaire dont il est issu, jamais un compte désigné à la main (OwnerDocageUserId). Choisie par le créateur du flux ; ensuite, seul un utilisateur qui a le droit d'administrer le flux peut la changer : le droit de le modifier ne suffit pas.

• RunRetentionDaysentier

  Rétention des exécutions (jours)

• StartedOndate et heure (UTC)Écrite par le serveur

  Début

• StatusFlowStatusÉcrite par le serveur

  État

• TargetEntityIdidentifiantÉcrite par le serveur

  Identifiant de l'entité cible

• TargetEntityTypeNametexteÉcrite par le serveur

  Nom du type d'entité cible

• TriggeredByFlowIdidentifiantÉcrite par le serveur

  Identifiant du flux déclencheur

• TriggeredByFlowTriggerIdidentifiantÉcrite par le serveur

  Identifiant du déclencheur

Aucune propriété ne correspond.

Ses énumérations

Ses liaisons

Les fiches auxquelles elle se lie, et le rôle de chacune : ce que LinkedToTypeName et LinkedToId retrouvent dans une liste (voir Lire des listes).

• FluxModèle