Objets Data Relationship Management

FormattedDate (value, formatString)

Formate les dates en fonction des règles système de formule. Utile pour la compatibilité ascendante en vue d'une correspondance exacte avec les anciennes propriétés de formule.

• value doit être un objet Date ou une chaîne de date/d'heure valide

• formatString doit être une chaîne de formatage valide (reportez-vous à la fonction FormattedDate)

GetNextID(key)

Renvoie le prochain identifiant disponible pour une valeur de clé de chaîne donnée

GetPropDef(abbrev)

Renvoie un objet PropDefObject pour le nom de propriété donné. Il doit s'agir du nom qualifié complet.

GetRequestByID(int)

Renvoie une demande de workflow par ID.

GetSysPrefValue(abbrev)

Renvoie la valeur de la préférence système donnée (par exemple, HierNodeSeparator)

InRange(dataType, input, min, max, minExclusive, maxExclusive)

Correspond à la fonction de formule InRange. Les paramètres requis sont dataType, input et min.

IsNodeAbove(ancestor, child)

Renvoie True si l'ancêtre est au-dessus de l'enfant dans la hiérarchie. Renvoie False si les paramètres ne sont pas des LocalNodeObjects ou ne figurent pas dans la même hiérarchie.

IsNodeBelow(descendant, parent)

Renvoie True si le descendant est en dessous du parent dans la hiérarchie. Renvoie False si les paramètres ne sont pas des LocalNodeObjects ou ne figurent pas dans la même hiérarchie.

RunFormula(node, propDef, formulaString)

Exécute une formule Data Relationship Management et renvoie les résultats de chaîne

• node est un objet NodeObject ou LocalNodeObject. Votre chaîne de formule ne doit pas faire référence aux propriétés locales lors de la transmission dans un objet NodeObject car cela entraînera une erreur. Lors de la transmission d'un objet LocalNodeObject, vous pouvez référencer toutes les propriétés locales et globales disponibles.

• propDef : pour être analysées ou exécutées correctement, certaines fonctions de formule exigent une définition de propriété. Lorsque vous utilisez ces fonctions, vous devez indiquer une définition de propriété. En général, les caractéristiques de définition de propriété (telles que le niveau, le type, son caractère global ou local) doivent correspondre, mais elles ne doivent pas forcément correspondre à la propriété réelle à laquelle la valeur formulaString est destinée. Elles peuvent être sans rapport. Dans la plupart des formules, vous pouvez transmettre la valeur NULL pour ce paramètre. Syntaxe : Sys.GetPropDef(abbrev). Par exemple :

  Sys.RunFormula(node, Sys.GetPropDef("Custom.MyProp1"), "Concat(Prop value ', PropValue(Custom.MyProp2),' ,is, ,valid)");

• formulaString est une formule Data Relationship Management héritée ; l'espace est considéré comme une partie littérale de la formule et doit donc être enlevé si nécessaire.

  Remarque : cette méthode n'est pas recommandée et ne doit être utilisée que lorsque cela s'avère nécessaire pour atteindre une correspondance exacte avec un comportement hérité. Les performances sont réduites lors de l'utilisation de cette méthode.

Abbrev

Nom de la définition de propriété (y compris l'espace de noms qualifié complet)

Cascade

True si les valeurs de la propriété sont héritées

ColumnWidth

Largeur de colonne d'export par défaut

DataType

Valeur d'énumération DataType, par exemple DataType.String (reportez-vous à Constantes d'énumération)

Descr

Description

DefaultValue

Valeur par défaut de la définition de propriété. Le type dépend du type de données de la définition de propriété.

EditorLabel

Libellé

Global

True si la propriété est une propriété de noeud global

Hidden

True si la propriété est masquée dans la grille de propriétés

ID

ID

Niveau

Valeur d'énumération PropLevel, par exemple PropLevel.Node (reportez-vous à Constantes d'énumération)

Liste

True si la propriété permet à l'utilisateur de choisir parmi une liste de valeurs

ListValues

Tableau de valeurs dans lequel l'utilisateur peut effectuer une sélection

LookupValues

Paires clé-valeur d'équivalence pour une propriété d'équivalence. Utilisez les propriétés Key et Value des objets contenus dans ce tableau.

MaxValue

Valeur maximale

MinValue

Valeur minimale

Espace de noms

Espace de noms de la définition de propriété

PropType

Valeur d'énumération PropType, par exemple PropType.Defined (reportez-vous à Constantes d'énumération)

PropClass

Classe de dérivée (Formule ou Script)

ReadOnly

True si la propriété est en lecture seule (comme la propriété statistique Core)

Abbrev

Nom

Descr

Description

HierCount

Nombre de hiérarchies

ID

ID

NodeCount

Nombre de noeuds

GetHierarchies()

Permet d'obtenir un tableau de toutes les hiérarchies de la version qui sont disponibles pour l'utilisateur actuel

GetGlobalNodes()

Permet d'obtenir un tableau de tous les noeuds globaux (NodeObjects) de la version

GetOrphans()

Permet d'obtenir un tableau de tous les orphelins (objets noeud) de la version

HierByAbbrev(abbrev)

Permet d'obtenir un objet HierarchyObject par nom

HierByID(id)

Permet d'obtenir un objet HierarchyObject par ID

NodeByAbbrev(abbrev)

Permet d'obtenir un objet NodeObject par nom

NodeByID(id)

Permet d'obtenir un objet NodeObject par ID

NodeExists(abbrev)

Renvoie True si un noeud global existe avec le nom donné

Prop(abbrev)

Permet d'obtenir l'objet NodePropObject pour la propriété donnée de la version

PropValue(abbrev)

Permet d'obtenir la valeur de la propriété donnée de la version. Le type de données renvoyé dépend du type de données de la définition de propriété.

Abbrev

Nom

Descr

Description

HierarchyUrl

URL de hiérarchie

ID

ID

NodeCount

Nombre de noeuds dans la hiérarchie

SharedNodesEnabled

True si les noeuds partagés sont activés

TopNode

Noeud supérieur LocalNodeObject

Version

VersionObject

VersionAbbrev

Nom de version

VersionID

ID de version

NodeByAbbrev(abbrev)

Permet d'obtenir un objet NodeObject par nom

NodeByID(id)

Permet d'obtenir un objet NodeObject par ID

NodeExists(abbrev)

Renvoie True si un noeud local existe avec le nom donné

Prop(abbrev)

Permet d'obtenir l'objet NodePropObject pour la propriété donnée de la version

PropValue(abbrev)

Permet d'obtenir la valeur de la propriété donnée de la version. Le type de données renvoyé dépend du type de données de la définition de propriété.

Abbrev

Core.Abbrev

AddedBy

Core.AddedBy

AddedOn

Core.AddedOn

Changed

Core.Changed

ChangedBy

Core.ChangedBy

ChangedOn

Core.ChangedOn

ChildNodeCount

Nombre de noeuds enfant

Descr

Core.Descr

DomainAbbrev

Core.DomainAbbrev

DomainNodeAbbrev

Core.DomainNodeAbbrev

ID

Core.ID

Inactive

Core.Inactive

IsPrimary

True s'il s'agit du noeud principal d'un noeud partagé, False si le noeud n'est pas partagé ou n'est pas le noeud principal

IsShared

True si le noeud est un noeud partagé

Leaf

Core.Leaf

NodeApproved

Core.NodeApproved

Version

VersionObject propriétaire du noeud

VersionAbbrev

Nom de version du noeud

VersionID

ID de version du noeud

GetChildren(sorted)

Permet d'obtenir un tableau de tous les enfants directs de ce noeud, éventuellement dans l'ordre de tri. La valeur par défaut pour sorted est False.

GetDescendants(inclusive, sorted)

Permet d'obtenir un tableau de tous les descendants de ce noeud, qui inclut éventuellement ce noeud et/ou est dans l'ordre de tri. La valeur par défaut pour inclusive est True. La valeur par défaut pour sorted est False.

NodeByAbbrev(abbrev)

Permet d'obtenir un objet NodeObject par nom

NodeByID(id)

Permet d'obtenir un objet NodeObject par ID

NodeExists(abbrev)

Renvoie True si un noeud global existe avec le nom donné

Prop(abbrev)

Permet d'obtenir l'objet NodePropObject pour la propriété donnée de la version

PropValue(abbrev)

Permet d'obtenir la valeur de la propriété donnée de la version. Le type de données renvoyé dépend du type de données de la définition de propriété.

GlobalNode

Objet NodeObject global pour le noeud actuel

Hier

Objet HierarchyObject pour la hiérarchie dans laquelle le noeud se trouve

HierAbbrev

Core.HierAbbrev

HierID

Core.HierID

Niveau

Nombre représentant le niveau du noeud dans la hiérarchie

MissingPrimary

True si le noeud principal est introuvable

NodeUrl

URL de noeud

Parent

Objet LocalNodeObject pour le noeud parent de ce noeud. La valeur NULL est renvoyée pour le noeud supérieur d'une hiérarchie.

ParentNodeAbbrev

Nom du noeud parent

Primary

Noeud principal pour ce noeud partagé. Si le noeud principal ne figure pas dans cette hiérarchie, cette propriété renvoie le noeud principal de la première hiérarchie dans laquelle il se trouve. Si vous avez besoin de la liste des hiérarchies dans lesquelles le noeud principal apparaît, appelez GetReferences() sur le noeud principal renvoyé. La valeur NULL est renvoyée si aucun noeud partagé ou principal ne peut être trouvé.

PrimaryNotInHier

True si le noeud principal existe mais ne figure pas dans cette hiérarchie

AncestorsWith(func, maxResults, searchFromTop, inclusive)

Recherche dans la chaîne d'ancêtres les noeuds qui correspondent à la fonction indiquée. Il s'agit du moyen le plus rapide pour localiser des ancêtres. Renvoie un tableau de résultats LocalNodeObject.

• func doit être une fonction qui accepte un argument de noeud unique et renvoie la valeur True si le noeud doit être inclus dans les résultats ou la valeur False s'il échoue au test.

• maxResults est facultatif et sa valeur par défaut est 1. Indiquez 0 pour qu'il n'y ait aucune limite (tous les noeuds qui remplissent la condition).

• searchFromTop est facultatif et sa valeur par défaut est False. Utilisez la valeur True pour démarrer en haut de la hiérarchie.

• inclusive est facultatif et sa valeur par défaut est False. Utilisez la valeur True pour inclure le noeud actuel dans les correspondances potentielles (il doit tout de même réussir le test).

ChildrenWith(func, maxResults)

Recherche dans la liste des enfants du noeud les noeuds qui correspondent à la fonction indiquée. Il s'agit du moyen le plus rapide pour trouver des enfants. Renvoie un tableau de résultats LocalNodeObject.

• func doit être une fonction qui accepte un argument de noeud unique et renvoie la valeur True si le noeud doit être inclus dans les résultats ou la valeur False s'il échoue au test.

• maxResults est facultatif et sa valeur par défaut est 1. Indiquez 0 pour qu'il n'y ait aucune limite (tous les enfants qui remplissent la condition).

DescendantsWith(func, maxResults, inclusive, depthFirst)

Recherche dans la chaîne de descendants les noeuds qui correspondent à la fonction indiquée. Il s'agit du moyen le plus rapide pour trouver des descendants. Renvoie un tableau de résultats LocalNodeObject.

• func doit être une fonction qui accepte un argument de noeud unique et renvoie la valeur True si le noeud doit être inclus dans les résultats ou la valeur False s'il échoue au test.

• maxResults est facultatif et sa valeur par défaut est 1. Indiquez 0 pour qu'il n'y ait aucune limite (tous les noeuds qui remplissent la condition).

• inclusive est facultatif et sa valeur par défaut est False. Utilisez la valeur True pour inclure le noeud actuel dans les correspondances potentielles (il doit tout de même réussir le test).

• depthFirst est facultatif et sa valeur par défaut est True. Si la valeur est True, chaque branche est examinée jusqu'à ses extrémités avant de sauvegarder l'arborescence et de passer à la branche suivante. Si la valeur est False, tous les enfants d'un noeud sont examinés en premier, puis les noeuds de chaque enfant sont examinés et ainsi de suite. Si vous avez une bonne idée de l'emplacement du noeud dans l'arborescence, la sélection de la valeur correcte ici peut grandement accélérer la recherche.

GetAncestorEnumerator()

Permet d'obtenir un objet NodeEnumeratorObject énumérant les noeuds ancêtres

GetAncestors(inclusive)

Permet d'obtenir un tableau des ancêtres LocalNodeObject

GetChildEnumerator(sorted)

Permet d'obtenir un objet NodeEnumeratorObject énumérant les noeuds enfant. Si sorted a la valeur True, les enfants sont dans l'ordre de tri.

GetDescendantEnumerator()

Permet d'obtenir un objet NodeEnumeratorObject énumérant les noeuds descendants

GetImplicitly SharedDescendants(inclusive)

Permet d'obtenir les noeuds enfant du noeud principal auquel ce noeud partagé est lié

GetInvertedLevel()

Equivalent à la fonction de formule InvertedLevel

GetReferences()

Permet d'obtenir un tableau des objets LocalNodeObject qui sont des références pour ce noeud (toutes les hiérarchies dans lesquelles le noeud apparaît)

GetReferenceInHier(hierAbbrev)

Permet d'obtenir la référence à ce noeud dans la hiérarchie indiquée. Si la hiérarchie n'est pas accessible ou si ce noeud n'existe pas dans cette hiérarchie, le résultat est NULL.

NextSibling()

Permet d'obtenir le semblable suivant de ce noeud dans l'ordre de tri

PreviousSibling()

Permet d'obtenir le semblable précédent de ce noeud dans l'ordre de tri

SiblingsWith(func, maxResults, inclusive)

Recherche dans les semblables du noeud les noeuds qui correspondent à la fonction indiquée. Renvoie un tableau de résultats LocalNodeObject.

• func doit être une fonction qui accepte un argument de noeud unique et renvoie la valeur True si le noeud doit être inclus dans les résultats ou la valeur False s'il échoue au test.

• maxResults est facultatif et sa valeur par défaut est 1. Indiquez 0 pour qu'il n'y ait aucune limite (tous les ancêtres qui remplissent la condition).

• inclusive est facultatif et sa valeur par défaut est False. Utilisez la valeur True pour inclure le noeud actuel dans les correspondances potentielles (il doit tout de même réussir le test).

Abbrev

Nom de la définition de propriété

ControllingHierarchy

Objet HierarchyObject pour la hiérarchie de contrôle de la définition de propriété dans cette version. Si la propriété n'est pas une propriété de noeud global, n'a pas de hiérarchie de contrôle, ou si la hiérarchie de contrôle est introuvable, la valeur renvoyée sera NULL.

Locked

True si la valeur est verrouillée

Origin

Valeur d'énumération PropOrigin, par exemple PropOrigin.Overridden (reportez-vous à Constantes d'énumération)

Owner

Objet auquel cette valeur est associée (VersionObject, HierarchyObject, NodeObject ou LocalNodeObject)

PropType

Valeur d'énumération PropType, par exemple PropType.Defined (reportez-vous à Constantes d'énumération)

StringValue

Valeur de chaîne brute de cette propriété. Dans le cas des propriétés Derived ou RWDerived, il peut s'agir de la valeur par défaut de la définition de propriété ou de la valeur remplacée.

Value

Valeur interprétée de cette propriété (par exemple, pour DataType.Float et DataType.Integer, cette valeur sera un objet Number). Tous les types de données n'ont pas forcément une représentation de type non-chaîne.

GetPropDef()

Permet d'obtenir l'objet PropDefObject de la propriété de noeud

Ranges

Tableau d'objets. Chaque objet comporte deux propriétés :

• start : début de l'entrée de plage

• end : fin de l'entrée de plage

Cette propriété est en lecture seule. Pour modifier la plage, utilisez les méthodes ci-dessous.

AddRange(start, end)

Ajoute une nouvelle plage à la liste de plages. Peut étendre une entrée de plage existante ou en créer une autre. Pour ajouter un seul nombre à la liste, utilisez-le à la fois pour les paramètres start et end. Les deux paramètres seront soumis à une contrainte de nombres entiers si nécessaire.

Contains(value)

Renvoie la valeur True si la valeur figure dans la liste de plages, sinon renvoie la valeur False.

value sera soumis à une contrainte de nombres entiers si nécessaire.

IsSupersetOf(range)

Renvoie True si l'objet RangeListObject en cours est un sur-ensemble de l'objet RangeListObject donné. La transmission d'un autre type d'objet est une erreur.

RemoveRange(start, end)

Enlève une plage de la liste. Ce retrait peut fractionner une entrée de plage existante en deux ou enlever une entrée dans sa totalité. Pour enlever un seul nombre de la liste, utilisez-le pour les paramètres start et end. Les deux paramètres seront soumis à une contrainte de nombres entiers si nécessaire.

GetCurrent()

Noeud actuel (objet NodeObject ou LocalNodeObject selon le contexte).

MoveNext()

Fait avancer l'énumérateur au noeud suivant. Renvoie la valeur False s'il n'y a plus de noeud à énumérer.

Abbrev

Nom de la validation (y compris l'espace de noms qualifié complet)

Descr

Description

EditorLabel

Libellé

Cascade

True si l'affectation de la validation est héritée

ValidationClass

Nom de la classe de validation

ValidationLevel

Valeur d'énumération ValidationLevel, par exemple ValidationLevel.Node (reportez-vous à Constantes d'énumération).

ValidationType

Valeur d'énumération ValidationType, par exemple ValidationType.Batch (reportez-vous à Constantes d'énumération).

ID

ID

Title

Titre de demande

Version

Version cible de la demande

ModelName

Modèle de workflow pour la demande

StageName

Etape en cours de la demande

StageType

Valeur d'énumération WorkflowStageType, par exemple, WorkflowStageType.Submit (reportez-vous à Constantes d'énumération)

Status

Valeur d'énumération WorkflowStatus, par exemple, WorkflowStatus.Submitted (reportez-vous à Constantes d'énumération)

Items

Liste des RequestItemObject ajoutés à la demande

ItemID

ID d'élément

RequestID

ID de demande

Demande

Objet de demande auquel appartient l'élément

NodeName

Core.Abbrev du noeud en cours de mise à jour

Description

Core.Descr du noeud en cours de mise à jour

HierarchyName

Hiérarchie du noeud en cours de mise à jour

ParentName

Core.Parent du noeud en cours de mise à jour

TaskName

Nom de la tâche de workflow de l'élément de demande

TaskAction

Valeur d'énumération WorkflowAction, par exemple, WorkflowAction.AddLimb (reportez-vous à Constantes d'énumération)

TaskDomain

Nom de domaine (s'il existe) de la tâche de workflow

ItemDetails

Liste des RequestItemDetailObject pour l'élément de demande

NodeNamePendingInRequest(name)

Accepte un paramètre d'un nom de noeud donné à tester. Renvoie True si une demande en attente de traitement autre que celle en cours pour la version contient un élément AddLimb/Leaf portant le nom indiqué.

CalcValue

Valeur de propriété calculée

HasCalcValue

Renvoie True si la valeur est calculée

Modified

Renvoie True si la valeur a été modifiée dans la demande

PropertyName

Nom de propriété

Value

Valeur de propriété