4.2.8 Type docid

4.2.8.1 Description

Les attributs de type docid permettent de faire un lien vers un ou plusieurs documents. Ils sont appelés relations.

Les attributs de type docid sont typés, c'est à dire qu'on précise de quelle famille doivent être les documents cible.
Cela se fait au moyen de la syntaxe docid("<family>") (Dans ce cas, les documents doivent être de la famille <family> ou d'une de ses ous-familles).

4.2.8.2 Représentation

• consultation :

  Un hyperlien vers le document cible, avec comme label le titre du document cible, et l'icône du document

  

  Figure 17. docid simple - consultation html

• modification :

  une aide à la saisie vers les documents de la famille cible (et de ses sous-familles). L'aide à la saisie porte sur le titre uniquement, avec le filtre contient, insensible à la casse et aux accents.

  

  Figure 18. docid simple - Modification html

• odt :

  

  Figure 19. docid simple - consultation odt

4.2.8.3 Comportement

Lors du rendu d'un docid, Dynacase récupère le titre des documents cibles. Pour chaque document cible, si l'utilisateur n'a pas le droit de voir le document cible, le titre est remplacé par le texte Information non disponible (se reporter à l'option noaccesstext pour personnaliser ce texte).

4.2.8.4 Format de stockage

La valeur stockée est l'identifiant interne du document cible.

Attention, bien que l'identifiant soit la plupart du temps un nombre, son format de stockage est un format texte.

Le type utilisé en base de donnée est text.

4.2.8.5 Options

En plus des options communes à tous les types d'attributs, ce type d'attribut dispose des options suivantes :

creation

Indique qu'un document de la famille cible de la relation pourra être créé depuis le formulaire.

Dans ce cas, un bouton sera ajouté sur le formulaire. Ce bouton ouvre un formulaire de création de la famille cible. Lors de la sauvegarde du nouveau document, ce nouveau document est inséré dans l'attribut de départ.
Si l'utilisateur n'a pas le droit de créer un document de la famille cible, le bouton ne sera pas affiché.

Pour les relations multiples, le nouveau document sera inséré dans la liste des documents.

Lorsque la relation est déjà renseignée, le bouton permet de modifier le document cible au lieu d'en créer un nouveau.
Si le document lié n'est pas accessible en modification, il sera alors affiché en consultation.

Les valeurs possibles sont :

• yes

• un objet (Attention: bien que cela y ressemble, ce n'est pas du JSON) construit de la manière suivante :

  • Pour définir la valeur d'un attribut du document cible : attrid_document_cible: "valeur" (si la valeur est fixe), ou attrid_document_cible: attrid_document_source si la valeur est à recopier depuis le document source.
  • Pour fermer la fenêtre de création lors de la sauvegarde : autoclose: "yes"

  • Pour appeler de nouveau l'aide à la saisie lors de l'insertion de la valeur dans le document source : recallhelper: "yes"

    Cela peut être utile dans le cas où l'aide à la saisie doit remplir plusieurs attributs du document source.

  Par exemple, creation={an_name:CT, an_reference :"une référence", an_target:en_source, recallhelper: "yes", autoclose: "yes"} indique que :

  • l'attribut an_name prendra comme valeur initiale *la valeur actuellement saisie par l'utilisateur dans le champ de l'aide à la saisie
  • l'attribut an_reference prendra la valeur une référence
  • l'attribut an_target prendra la valeur de l'attribut en_source du document source
  • l'aide à la saisie sera rappelée lors de la sauvegarde du document nouvellement créé
  • la fenêtre de création du nouveau document sera fermée lors de sa sauvegarde.

docrev

Indique quelle est la révision pointée par la relation.

Les valeurs possibles sont :

• latest (comportement par défaut) : Dans ce cas, la relation pointe vers la dernière révision de la lignée documentaire ;
• fixed : Dans ce cas, la relation pointe vers la révision ayant l'id référencé ;
• state(step), où step est une étape : Dans ce cas, la relation pointe vers le dernier document à l'étape step.

Cette option affecte le comportement de l'aide à la saisie générée :

• lorsque l'option a la valeur latest, c'est l'initid du document qui est retourné ;
• lorsque l'option a la valeur fixed, c'est le docid de la dernière révision au moment de l'appel qui est retourné ;
• lorsque l'option a la valeur state(step), seuls les documents à l'étape step sont listés, et c'est le docid de la dernière révision à l'étape step au moment de l'appel qui est retourné.

doctitle

Indique qu'un attribut contenant le titre du document cible doit être automatiquement renseigné.

Cela est notamment utile pour la recherche plein texte, les tris, etc.

Les valeurs possibles sont :

• no (comportement par défaut) ;
• tout id d'attribut existant : Dans ce cas, l'attribut référencé contient le titre du document cible ;
• auto : Dans ce cas, un attribut est généré (son id est <id_de_la_relation>_title et son titre est <titre_de_la_relation> (titre) )

isuser

Indique quels attributs sont utilisables pour le profilage des documents.

Les valeurs possibles sont :

• yes : Dans ce cas, il faut que le document lié soit de la famille IUSER (Utilisateur) ou dérivé de IUSER.
• no (comportement par défaut)

multiple

Indique que plusieurs documents peuvent être référencés par la relation.

Les valeurs possibles sont :

• yes
• no (comportement par défaut)

noaccesstext

Indique le texte qui est affiché lorsque le document cible n'est pas visible.

Cette valeur sera automatiquement ajoutée au catalogue de traduction.

Les valeurs possibles sont :

• toute chaîne de caractères.

En l'absence de l'option, le texte affiché est Information non disponible