Funktionsdefinitionen

Im Folgenden finden Sie eine alphabetische Liste der verfügbaren Funktionen, die mit Eigenschaftsdefinitionen von abgeleiteten Formeln verwendet werden.

Abbrev

Beschreibung

Gibt den Namen (Abkürzung) des aktuellen Knotens zurück.

Syntax

Abbrev(): String 

Beispiel

Abbrev()

Der Rückgabewert ist der Name des Knotens.

Add

Beschreibung

Fügt zwei angegebene Ganzzahlenwerte hinzu und gibt das Ergebnis zurück.

Syntax

Add(Int1,Int2:Integer):Integer

Beispiel

Add(1,4)

Der Rückgabewert lautet: 5.

AddedBy

Beschreibung

Gibt den Wert der Änderungsverfolgungseigenschaft "Hinzugefügt von" zurück.

Syntax

AddedBy():String

Beispiel

AddedBy()

Gibt den Namen des Benutzers zurück, der den aktuellen Knoten zur Version hinzugefügt hat.

AddedOn

Beschreibung

Gibt den Wert der Änderungsverfolgungseigenschaft "Hinzugefügt am" als Datum/Uhrzeit zurück.

Syntax

AddedOn():Date/Time

Beispiel

AddedOn()

Gibt das Datum und die Uhrzeit zurück, zu der der aktuelle Knoten zur Version hinzugefügt wurde.

AddFloat

Beschreibung

Fügt zwei angegebene Gleitkommawerte hinzu und gibt das Ergebnis zurück.

Syntax

AddFloat(Float1,Float2:Float):Float

Beispiel

AddFloat(2.14,3.75)

Der Rückgabewert lautet: 5.89

AncestorProp

Beschreibung

Gibt einen Eigenschaftswert des ersten Vorgängers zurück, wobei eine Eigenschaft einem angegebenen Wert entspricht.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

AncestorProp(Operator:String,Property:String,Value:String,FromTop:Boolean,ReturnProp:String)

Operator ist der Operator, der zum Vergleichen der Eigenschaft und des Wertes verwendet werden soll. Gültige Werte: =, <, >, >= und <=.

Property ist der Name der zu verwendenden Eigenschaft.

Value ist der zu vergleichende Wert.

FromTop gibt an, ob ab dem obersten Knoten der Hierarchie gesucht werden soll. Wenn der Wert "False" lautet, wird die Suche ab dem aktuellen Knoten ausgeführt

ReturnProp ist der Name der zurückzugebenden Eigenschaft.

And

Beschreibung

Gibt "True" zurück, wenn alle angegebenen booleschen Ausdrücke mit "True" ausgewertet werden.

Syntax

And(Expression1,Expression2,...ExpressionN:Boolean):Boolean 

Beispiel

And(1,T,True)

Der Rückgabewert lautet: True

ArrayCount

Beschreibung

Gibt die Anzahl der Elemente in einer angegebenen Liste (Array) zurück.

Syntax

ArrayCount(List:String,Delimiter:String):Integer

List gibt die Liste der Zeichenfolgen an, in denen gesucht werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

Beispiel

ArrayCount(Diet Cola;Root Beer;Cola,[comma])

Der Rückgabewert lautet: 3

ArrayIndex

Beschreibung

Gibt die Position des ersten Auftretens des angegebenen Elements in der Liste (Array) zurück. Gibt Null (0) zurück, wenn das Element nicht gefunden wird.

Syntax

ArrayIndex(Item:String,List:String,Delimiter:String):Integer 

Item gibt den zu testenden Zeichenfolgenwert an.

List gibt die Liste der Zeichenfolgen an, in denen gesucht werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

Beispiel

ArrayIndex(Cola,Diet Cola;Root Beer;Cola,[comma])

Der Rückgabewert lautet: 3

ArrayItem

Beschreibung

Gibt das Element in der Liste (Array) an der angegebenen Indexposition zurück.

Syntax

ArrayItem(List:String,Delimiter:String,Index:Integer):String

List gibt die Liste der Zeichenfolgen an, in denen gesucht werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

Index ist die Position der Zeichenfolge in der Liste. Ein negativer Wert gibt das letzte Element in der Liste an.

Beispiel

ArrayItem(Diet Cola;Root Beer;Cola,;,3)

Der Rückgabewert lautet: Cola

AscNodeProp

Beschreibung

Gibt einen Eigenschaftswert des zugeordneten Knotens zurück, den die angegebene Eigenschaft referenziert.

Syntax

AscNodeProp(LookUpProperty,ReturnProperty)

LookupProperty ist der Name der Eigenschaft, die auf den Knoten verweist. Der Datentyp der Eigenschaft muss "Node" oder "AscNode" lauten.

ReturnProperty ist der Name der Eigenschaft des zurückzugebenden zugeordneten Knotens. Die Eigenschaft muss global sein.

AvgList

Beschreibung

Gibt den Durchschnittswert der Elemente in einer Liste zurück, wobei leere Elemente ignoriert werden. Gibt eine leere Zeichenfolge zurück, wenn die Liste ein Element enthält, das nicht dem angegebenen Elementtyp entspricht.

Syntax

AvgList(InputList:String,Delimiter:String,ItemType:String):String

InputList legt fest, welche Liste verwendet werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

ItemType gibt den erwarteten Elementdatentyp für Listenelemente an. Gültige Werte: "integer", "float" und "datetime". Der Standardwert ist "float".

Beispiel

AvgList(1;2;3,[comma],Integer)

Der Rückgabewert lautet: 2

BoolToStr

Beschreibung

Gibt einen in "True" oder "False" konvertierten booleschen Wert zurück. Gibt "False" zurück, wenn die Eingabe keinen booleschen Wert darstellt.

Syntax

BoolToStr(Expression:Boolean):String 

Beispiel

BoolToStr(1)

Der Rückgabewert lautet: True

Changed

Beschreibung

Gibt den Wert der Änderungsverfolgungseigenschaft "Knoten geändert" als booleschen Wert zurück.

Syntax

Changed()

ChangedBy

Beschreibung

Gibt den Namen des Benutzers zurück, der den aktuellen Knoten in der Version zuletzt aktualisiert hat.

Syntax

ChangedBy():String

Beispiel

ChangedBy()

ChangedOn

Beschreibung

Gibt den Wert der Änderungsverfolgungseigenschaft "Geändert am" zurück.

Syntax

ChangedOn():Date/Time

Beispiel

ChangedOn()

Gibt das Datum und die Uhrzeit zurück, zu der der aktuelle Knoten in der Version zuletzt aktualisiert wurde.

Concat

Beschreibung

Verkettet zwei oder mehr angegebene Zeichenfolgen zu einer und gibt das Ergebnis zurück.

Syntax

Concat(Item1,Item2,... ItemN:String):String 

Beispiel

Concat(Abbrev,-,Descr())

Wenn der Name des aktuellen Knotens "100" und die Beschreibung des aktuellen Knotens "Colas" lautet, wird "100-Colas" zurückgegeben.

ConcatWithDelimiter

Beschreibung

Verkettet zwei oder mehr Zeichenfolgen zu einer Liste mit Trennzeichen und gibt das Ergebnis zurück.

Syntax

ConcatWithDelimiter(Delimiter:String,SkipBlanks:Boolean,Items:String)

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

SkipBlanks gibt an, ob leere Werte in der Liste der Zeichenfolgen übersprungen werden sollen. Gültige Werte: 1, 0, T, F, t, f.

Items gibt die Liste der zu verkettenden Zeichenfolgen an.

Beispiel

ConcatWithDelimiter([comma],1,Item1,Item2,Item3,Item4)

Der Rückgabewert lautet: Item1; Item2; Item3; Item4

Decode

Beschreibung

Gibt die Eingabezeichenfolge zurück, wobei alle Vorkommen von [openparen], [closeparen], [comma], [tab], [space], [crlf], [cr] und [lf] durch das entsprechende Zeichen ersetzt werden.

Syntax

Decode(CodedString:String):String

CodedString ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

DefaultProp

Beschreibung

Gibt den Standardwert für die Eigenschaft zurück.

Syntax

DefaultProp(Property:String)

Property ist der Name der zu verwendenden Eigenschaft.

Descr

Beschreibung

Gibt die Beschreibung des aktuellen Knotens zurück.

Syntax

Descr():String

Beispiel

Wenn die Beschreibung des aktuellen Knotens "Colas" lautet, wird "Colas" zurückgegeben.

Divide

Beschreibung

Dividiert zwei angegebene Ganzzahlenwerte und gibt das Ergebnis zurück.

Syntax

Divide(Int1,Int2:Integer):Integer

Beispiel

Divide(200,10)

Der Rückgabewert lautet: 20

DivideFloat

Beschreibung

Dividiert zwei Gleitkommazahlen (Float) und gibt das Ergebnis zurück.

Syntax

Divide(Float1,Float2:Float):Float

Beispiel

DivideFloat(2.535,1.5)

Der Rückgabewert lautet: 1.69

DualAncestorProp

Beschreibung

Gibt einen Eigenschaftswert des ersten Vorgängers zurück, wobei zwei Eigenschaften den angegebenen Werten entsprechen.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

DualAncestorProp(Operator1:String,Property1:String,Value1:String,Operator2:String,Property2:String,Value2:String,FromTop:Boolean,ReturnProp:String):String

Operator1 ist der Operator, der zum Vergleichen der ersten Eigenschaft und des ersten Wertes verwendet werden soll. Gültige Werte: =, <, >, >= und <=.

Property1 ist der Name der ersten zu prüfenden Eigenschaft.

Value1 ist der erste zu vergleichende Wert.

Operator2 ist der Operator, der zum Vergleichen der zweiten Eigenschaft und des zweiten Wertes verwendet werden soll. Gültige Werte: =, <, >, >= und <=.

Property2 ist der Name der zweiten zu prüfenden Eigenschaft.

Value2 ist der zweite zu vergleichende Wert.

FromTop gibt an, ob ab dem obersten Knoten der Hierarchie gesucht werden soll. Wenn der Wert "False" lautet, wird die Suche ab dem aktuellen Knoten ausgeführt

ReturnProp ist der Name der Eigenschaft des zurückzugebenden Vorgängers.

Equals

Beschreibung

Gibt "True" zurück, wenn zwei angegebene Werte identisch sind. Bei dieser Funktion muss die Groß-/Kleinschreibung berücksichtigt werden.

Syntax

Equals(ParamType:String,Param1:String,Param2:String):Boolean

DataType ist der zum Vergleichen von Werten zu verwendende Datentyp. Gültige Werte: "string", "integer", "float" und "date". Der Standardwert ist "integer".

Param1 ist der erste zu vergleichende Wert.

Param2 ist der zweite zu vergleichende Wert.

Beispiel

Equals(integer,01,1)

Der Rückgabewert lautet: True

FlipList

Beschreibung

Gibt eine Zeichenfolge zurück, die die Umkehrung der angegebenen Liste darstellt.

Syntax

FlipList(List,Delimiter:String):String

List gibt die Liste der umzukehrenden Zeichenfolgen an.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

Beispiel

FlipList(DietCola;Orange Soda;Root Beer;Lemonade,[comma])

Der Rückgabewert lautet: Lemonade,Root Beer,Orange Soda,Diet Cola

FloatToStr

Beschreibung

Gibt einen in eine Zeichenfolge konvertierten Gleitkommawert zurück. Gibt Null (0) zurück, wenn der Eingabewert keinen Gleitkommawert darstellt.

Syntax

FloatToStr(Float1:Float):String

Beispiel

FloatToStr(1.001)

Der Rückgabewert lautet: 1.001.

Format

Beschreibung

Formatiert den Wert mit einer angegebenen Formatzeichenfolge, einer Parametertypkennung und einem Parameterwert des angegebenen Typs. Diese Funktion ist auf einen einzigen Wertparameter beschränkt.

Syntax

Format(Format:String,ParamType:String, ValueToFormat:String):String

Format ist das anzuwendende Format.

DataType ist der zum Vergleichen von Werten zu verwendende Datentyp. Gültige Werte: "string", "integer", "float" und "date". Der Standardwert ist "integer".

ValueToFormat ist der Wert, für den die Funktion ausgeführt werden soll.

Beispiel

Format('%8.2f',Float,123.456)

Der Rückgabewert lautet: 123.46.

FormattedDate

Beschreibung

Gibt den Wert einer mit der angegebenen Formatzeichenfolge formatierten Datumseigenschaft zurück.

Syntax

FormattedDate(PropertyName:String,FormatString:String): String

PropertyName ist der Name der zu verwendenden Eigenschaft.

FormatString gibt das anzuwendende Datumsformat an.

GreaterThan

Beschreibung

Vergleicht zwei Werte und gibt "True" zurück, wenn der erste Wert größer als der zweite Wert ist.

Syntax

GreaterThan(Value1:Integer,Value2:Integer,ParamType:String):Boolean

Value1 ist der erste zu vergleichende Wert.

Value2 ist der zweite zu vergleichende Wert.

DataType ist der zum Vergleichen von Werten zu verwendende Datentyp. Gültige Werte: "string", "integer", "float" und "date". Der Standardwert ist "integer".

Beispiel

GreaterThan(1,2)

Der Rückgabewert lautet: False

GreaterThanOrEqual

Beschreibung

Vergleicht zwei Werte und gibt "True" zurück, wenn der erste Wert größer als oder gleich dem zweiten Wert ist.

Syntax

GreaterThanOrEqual(Value1:Integer,Value2:Integer,ParamType:String):Boolean

Value1 ist der erste zu vergleichende Wert.

Value2 ist der zweite zu vergleichende Wert.

DataType ist der zum Vergleichen von Werten zu verwendende Datentyp. Gültige Werte: "string", "integer", "float" und "date". Der Standardwert ist "integer".

Beispiel

GreaterThanOrEqual(2,2)

Der Rückgabewert lautet: True

HasCharacters

Beschreibung

Gibt "True" zurück, wenn die angegebene Eingabe Zeichen aus den Zeichenklassen, Sonderzeichen oder in CharList aufgelistete Zeichen enthält.

Syntax

HasCharacters(Input:String,CharList:String):Boolean

Input ist der zu testende Zeichenfolgenwert.

CharList ist eine Liste zu testender Zeichen, einschließlich optionaler Sonderzeichen. Sonderzeichenwerte werden in Klammern eingeschlossen und durch Kommas getrennt. Gültige Werte: [alpha], [numeric], [whitespace], [punctuation], [uppercase], [lowercase], [comma], [space], [tab], [crlf], [cr], [lf], [openparen] und [closeparen].

HasChildWith

Beschreibung

Gibt "True" zurück, wenn der angegebene Ausdruck für ein beliebiges untergeordnetes Element des aktuellen Knotens "True" ist.

Syntax

HasChildWith(Expression:Boolean):Boolean 

Beispiel

HasChildWith(GreaterThan(ID(),200))

Wenn der aktuelle Knoten untergeordnete Elemente mit einer ID enthält, die größer als 200 ist, wird "True" zurückgegeben.

HasParentNode

Beschreibung

Gibt "True" zurück, wenn der aktuelle lokale Knoten über einen übergeordneten Knoten verfügt.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

HasParentNode():Boolean

Beispiel

HasParentNode()

Wenn der Knoten ein untergeordnetes Element des obersten Knotens einer Hierarchie oder eines abhängigen Knotens ist, wird "True" zurückgegeben.

HasSiblingWith

Beschreibung

Gibt "True" zurück, wenn der angegebene Ausdruck für ein beliebiges gleichgeordnetes Element des aktuellen Knotens "True" ist.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

HasSiblingWith(Expression:Boolean):Boolean 

Beispiel

HasSiblingWith(PropValue(Leaf))

Wenn eines der untergeordneten Elemente ein Blatt ist, wird "True" zurückgegeben.

HierNodePropValue

Beschreibung

Gibt den Wert der angegebenen Eigenschaft des angegebenen Knotens in der angegebenen Hierarchie zurück.

Syntax

HierNodePropValue(HierAbbrev:String,NodeAbbrev:String,PropAbbrev:String):String

HierAbbrev ist der Name der zu verwendenden Hierarchie.

NodeAbbrev ist der Name des zu verwendenden Knotens.

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

HierNodePropValue(Assets,1000,Description)

Wenn die Beschreibung für Knoten 1000 in der Anlagenhierarchie "Banking" lautet, wird "Banking" zurückgegeben.

ID

Beschreibung

Gibt die ID des aktuellen Knotens zurück.

Syntax

ID():Integer

Beispiel

ID()

Wenn die ID des aktuellen Knotens "2000" lautet, wird "2000" zurückgegeben.

If

Beschreibung

Gibt den Wert des TrueResult-Parameters zurück, wenn der angegebene Ausdruck mit "True" ausgewertet wird. Anderenfalls wird der Wert des FalseResult-Parameters zurückgegeben.

Syntax

If(Expression:Boolean, TrueResult:String,FalseResult:String):String

Expression ist ein zu evaluierender boolescher Ausdruck.

TrueResult ist der Zeichenfolgenwert, der zurückgegeben werden soll, wenn die Bedingung "True" ist.

FalseResult ist der Zeichenfolgenwert, der zurückgegeben werden soll, wenn die Bedingung "False" ist.

Beispiel

If(Equals(String,Descr(),),Abbrev(),Concat(Abbrev,-,Descr()))

Wenn der Knotenname "Colas" lautet und die Beschreibung des aktuellen Knotens leer ist, wird "Colas" zurückgegeben.

Wenn der Knotenname "100" lautet und die Beschreibung des aktuellen Knotens "Colas" ist, wird "100-Colas" zurückgegeben.

InheritedPropOrigin

Beschreibung

Gibt den Namen des Knotens zurück, aus dem ein geerbter Eigenschaftswert stammt. Wenn die angegebene Eigenschaft global ist, wird auch die Ursprungshierarchie zurückgegeben. Gibt "False" zurück, wenn die angegebene Eigenschaft nicht erbend ist oder wenn der Knoten oder die Eigenschaft nicht gefunden wurde.

Diese Funktion kann lokal ausgerichtet sein, wenn eine lokale Eigenschaft in den Parametern übergeben wird.

Syntax

InheritedPropOrigin(PropAbbrev:String,Node:String):String

Beispiel

InheritedPropOrigin(Custom.AccountType,Abbrev())

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Node ist der Name des zu verwendenden Knotens.

InRange

Beschreibung

Gibt "True" zurück, wenn der angegebene Wert in einen angegebenen Wertebereich fällt. Wenn der Eingabeparameter eine Zeichenfolge ist, geben die Parameter "Min" und "Max" für die Zeichenfolge einen Längenbereich für die Prüfung an. Für andere Typen geben "Min" und "Max" einen numerischen oder Datenwertebereich für die Prüfung an.

Syntax

InRange(DataType:String,Input:String,Min:String,Max:String,MinExclusive:String,MaxExclusive:String):Boolean

DataType ist der zu verwendende Datentyp. Gültige Werte: "string", "integer", "float" und "datetime".

Input ist der zu testende Zeichenfolgenwert.

Min ist der Mindestwert für die Längen- oder Bereichsprüfung.

Max ist der Höchstwert für die Längen- oder Bereichsprüfung.

MinExclusive gibt an, ob der Mindestwert aus dem Prüfbereich auszuschließen ist.

MaxExclusive gibt an, ob der Höchstwert aus dem Prüfbereich auszuschließen ist.

Beispiel

InRange(Integer,5,1,10,False,False)

Der Rückgabewert lautet: True

InternalPrefix

Beschreibung

Gibt das nicht numerische Präfix des Namens des aktuellen Knotens zurück.

Syntax

InternalPrefix()

Intersection

Beschreibung

Gibt die Elemente zurück, die in beiden Wertlisten vorkommen. Die Reihenfolge der Ergebnisse richtet sich danach, wie die Elemente in der ersten angegebenen Liste angezeigt werden.

Syntax

Intersection(List1:String,List2:String,Delimiter:String):String

List1 gibt eine Liste mit Zeichenfolgen an, in denen gesucht werden soll.

List2 gibt eine Liste mit Zeichenfolgen an, in denen gesucht werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

Beispiel

Intersection(A;B;C;D;E,C;E;F;A,[comma])

Der Rückgabewert lautet: A,C,E

IntToStr

Beschreibung

Gibt den angegebenen Ganzzahlenwert konvertiert in einen Zeichenfolgen-Datentyp zurück. Gibt Null (0) zurück, wenn der Eingabewert keine Ganzzahl darstellt.

Syntax

IntToStr(Int1:Integer):String

Beispiel

IntToStr(12345)

Der Rückgabewert lautet: 12345

InvertedLevel

Beschreibung

Gibt die maximale Tiefe abhängiger Elemente unterhalb des aktuellen Knotens zurück.

Syntax

InvertedLevel()

IsAlpha

Beschreibung

Gibt "True" zurück, wenn die angegebene Zeichenfolge nur alphabetische Zeichen (ohne Beachtung der Groß-/Kleinschreibung) enthält.

Syntax

IsAlpha(String:String):Boolean

Beispiel

IsAlpha(A23D)

Der Rückgabewert lautet: False

IsAlphaNumeric

Beschreibung

Gibt "True" zurück, wenn die angegebene Zeichenfolge nur alphabetische oder numerische Zeichen (ohne Beachtung der Groß-/Kleinschreibung) enthält.

Syntax

IsAlphaNumeric(String:String,AllowBlanks:Boolean):Boolean

String ist der zu testende Zeichenfolgenwert.

AllowBlanks gibt an, ob eine leere Zeichenfolge als numerisch zu behandeln ist. Der Standardwert lautet "False".

Beispiel

IsAlphaNumeric(ABC123,True)

Gibt "True" zurück.

IsBlank

Beschreibung

Gibt "True" zurück, wenn der angegebene Eingabewert eine leere Zeichenfolge ist (Nulllänge).

Syntax

IsBlank(Input:String):Boolean

Beispiel

IsBlank(Descr())

Gibt "True" zurück, wenn die Knotenbeschreibung leer ist.

IsBottomNode

Beschreibung

Gibt "True" zurück, wenn der angegebene Knoten keine untergeordneten Knoten enthält. Gibt "False" zurück, wenn der Knoten nicht gefunden wird.

Syntax

IsBottomNode(Node:String):Boolean

Node ist der Name des zu verwendenden Knotens.

Beispiel

IsBottomNode(Abbrev)

Gibt "True" zurück, wenn der Knoten keine untergeordneten Elemente enthält.

IsDataType

Beschreibung

Gibt "True" zurück, wenn der Eingabewert mit dem angegebenen Datentyp übereinstimmt.

Syntax

IsDataType(DataType:String,Input:String):Boolean

DataType ist der zu verwendende Datentyp. Gültige Werte: "boolean", "string", "integer", "float" und "datetime".

Input ist der zu testende Zeichenfolgenwert.

Beispiel

IsDataType(123,Integer)

Gibt "True" zurück.

IsDefinedPropVal

Beschreibung

Gibt "True" zurück, wenn die angegebene Eigenschaft für den angegebenen Knoten einen definierten Wert (Überschreibung) enthält. Gibt "False" zurück, wenn der Knoten oder die Eigenschaft nicht gefunden wird.

Diese Funktion kann lokal ausgerichtet sein, wenn eine lokale Eigenschaft in den Parametern übergeben wird.

Syntax

IsDefinedPropVal(PropAbbrev:String,Node:String):Boolean

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Node ist der Name des zu verwendenden Knotens.

Beispiel

IsDefinedPropVal(Custom.AccountType,Abbrev())

Gibt "True" zurück, wenn die Eigenschaft für den Kontotyp einen definierten Wert (Überschreibung) enthält.

IsNodeAbove

Beschreibung

Gibt "True" zurück, wenn der erste Knoten ein Vorgänger des zweiten Knotens in der aktuellen Hierarchie ist. Gibt "False" zurück, wenn Node1 oder Node2 nicht gefunden wird.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

IsNodeAbove(Node1:String,Node2:String):Boolean

Node1 ist der Name des ersten zu verwendenden Knotens.

Node2 ist der Name des zweiten zu verwendenden Knotens.

Beispiel

IsNodeAbove(Parent,Child)

Gibt "True" zurück, wenn der übergeordnete Knoten ein Vorgänger des untergeordneten Knotens ist.

IsNodeBelow

Beschreibung

Gibt "True" zurück, wenn der erste Knoten ein abhängiges Element des zweiten Knotens in der aktuellen Hierarchie ist. Gibt "False" zurück, wenn Node1 oder Node2 nicht gefunden wird.

Syntax

IsNodeBelow(Node1:String,Node2:String):Boolean

Node1 ist der Name des ersten zu verwendenden Knotens.

Node2 ist der Name des zweiten zu verwendenden Knotens.

Beispiel

IsNodeBelow(Child,Parent)

Gibt "True" zurück, wenn der untergeordnete Knoten ein abhängiges Element des übergeordneten Knotens ist.

IsNumeric

Beschreibung

Gibt "True" zurück, wenn der angegebene Wert nur numerische Zeichen (0-9) enthält.

Syntax

IsNumeric(String: String,AllowBlanksAsNumeric:Boolean):Boolean

String ist der zu testende Zeichenfolgenwert.

AllowBlanksAsNumeric gibt an, ob ein leerer Wert als Zeichenfolge gelten soll. Der Standardwert ist False.

Beispiel

IsNumeric(12345)

Der Rückgabewert lautet: True

IsRangeListSubset

Beschreibung

Gibt "True" zurück, wenn der angegebene Wert eine Teilmenge der angegebenen Bereichsliste ist.

Syntax

IsRangeListSubset(RangeList:Range List,SubsetRangeList:Range List,Delimiter:String):Boolean

RangeList ist eine Liste zu durchsuchender Ganzzahlbereiche, die durch das angegebene Trennzeichen getrennt sind.

SubsetRangeList ist eine Teilmengenliste zu durchsuchender Ganzzahlbereiche, die durch das angegebene Trennzeichen getrennt sind.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

Length

Beschreibung

Gibt die Zeichenanzahl im angegebenen Zeichenfolgenwert zurück.

Syntax

Length(String:String):Integer

Beispiel

Length(Desc())

Wenn die Beschreibung des aktuellen Knotens "Colas" lautet, wird "5" zurückgegeben.

LessThan

Beschreibung

Vergleicht zwei Werte und gibt "True" zurück, wenn der erste Wert kleiner als der zweite Wert ist.

Syntax

LessThan(Value1:Integer,Value2:Integer,ParamType:String):Boolean

Value1 ist der erste zu vergleichende Wert.

Value2 ist der zweite zu vergleichende Wert.

DataType ist der zum Vergleichen von Werten zu verwendende Datentyp. Gültige Werte: "string", "integer", "float" und "date". Der Standardwert ist "integer".

Beispiel

LessThan(1,2)

Der Rückgabewert lautet: True

LessThanOrEqual

Beschreibung

Vergleicht zwei Werte und gibt "True" zurück, wenn der erste Wert kleiner als oder gleich dem zweiten Wert ist.

Syntax

LessThanOrEqual(Value1:Integer,Value2:Integer,ParamType:String):Boolean

Value1 ist der erste zu vergleichende Wert.

Value2 ist der zweite zu vergleichende Wert.

DataType ist der zum Vergleichen von Werten zu verwendende Datentyp. Gültige Werte: "string", "integer", "float" und "date". Der Standardwert ist "integer".

Beispiel

LessThanOrEqual(3,3)

Der Rückgabewert lautet: True

ListAncestors

Beschreibung

Gibt eine kommagetrennte Liste der Namen der Vorgänger des aktuellen Knotens zurück, beginnend mit dem obersten Knoten. Gibt eine leere Zeichenfolge zurück, wenn der aktuelle Knoten kein lokaler Knoten ist.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

ListAncestors(SortOrder:String):String

SortOrder gibt die Sortierreihenfolge für die zurückgegebene Knotenliste an. Unterstützte Werte für die Sortierreihenfolge:

• [hier] – Standardwert für lokalen Kontext. Die Knotenliste wird in der Sortierreihenfolge der Standardhierarchie für die aktuelle Hierarchie zurückgegeben.

• [alpha] – Die Knotenliste wird nach Knotennamen sortiert zurückgegeben.

• [nodeid] – Wird nur aus Gründen der Abwärtskompatibilität unterstützt. Die Knotenliste wird numerisch nach der Knoten-ID jedes Knotens sortiert in der Rückgabeliste zurückgegeben.

Beispiel

ListAncestors([alpha])

Wenn A, B, C und D untergeordnete Elemente von Z sind, Z ein untergeordnetes Element von Y ist und der aktuelle Knoten "D" lautet, wird "Z,Y" zurückgegeben.

ListChildren

Beschreibung

Gibt eine kommagetrennte Liste untergeordneter Elemente für den aktuellen Knoten zurück.

Syntax

ListChildren(SortOrder:String):String

SortOrder gibt die Sortierreihenfolge für die zurückgegebene Knotenliste an. Unterstützte Werte für die Sortierreihenfolge:

• [hier] – Standardwert für lokalen Kontext. Die Knotenliste wird in der Sortierreihenfolge der Standardhierarchie für die aktuelle Hierarchie zurückgegeben.

• [alpha] – Die Knotenliste wird nach Knotennamen sortiert zurückgegeben.

• [nodeid] – Wird nur aus Gründen der Abwärtskompatibilität unterstützt. Die Knotenliste wird numerisch nach der Knoten-ID jedes Knotens sortiert in der Rückgabeliste zurückgegeben.

Beispiel

ListChildren([alpha])

Wenn A, B, C und D untergeordnete Elemente von Z sind und der aktuelle Knoten "Z" lautet, wird "A,B,C,D" zurückgegeben.

ListContains

Beschreibung

Gibt "True" zurück, wenn die angegebene Liste den angegebenen Wert enthält.

Syntax

ListContains(List:String,Item:String,Delimiter: String):Boolean

List gibt die Liste der Zeichenfolgen an, in denen gesucht werden soll.

Item gibt den Zeichenfolgenwert an, in dem die Funktion ausgeführt werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

Beispiel

ListContains(PropValue(NodeList),Colas,[comma])

Der Rückgabewert lautet: True

ListDescendants

Beschreibung

Gibt eine kommagetrennte Liste mit abhängigen Elementen für den aktuellen Knoten zurück.

Syntax

ListDescendants(SortOrder:String):String 

SortOrder gibt die Sortierreihenfolge für die zurückgegebene Knotenliste an. Unterstützte Werte für die Sortierreihenfolge:

• [hier] – Standardwert für lokalen Kontext. Die Knotenliste wird in der Sortierreihenfolge der Standardhierarchie für die aktuelle Hierarchie zurückgegeben.

• [alpha] – Die Knotenliste wird nach Knotennamen sortiert zurückgegeben.

• [nodeid] – Wird nur aus Gründen der Abwärtskompatibilität unterstützt. Die Knotenliste wird numerisch nach der Knoten-ID jedes Knotens sortiert in der Rückgabeliste zurückgegeben.

Beispiel

ListDescendants([hier])

Wenn A, B, C und D untergeordnete Elemente von Z sind, Z ein untergeordnetes Element von Y ist und der aktuelle Knoten "Y" lautet, wird "Z,A,B,C,D" zurückgegeben.

ListDistinct

Beschreibung

Gibt eine Liste eindeutiger Elemente aus einer angegebenen Liste zurück, wobei mehrfach vorkommende Elemente entfernt werden.

Syntax

ListDistinct(InputList:String,Delimiter:String):String

InputList legt fest, welche Liste verwendet werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

Beispiel

ListDistinct(A;B:C;A;D,[comma])

Der Rückgabewert lautet: A,B,C,D.

ListNodePropValues

Beschreibung

Gibt eine Liste der Eigenschaftswerte für die angegebene Eigenschaft für eine angegebene Knotenliste zurück. Gibt für jeden nicht gefundenen Knoten eine leere Zeichenfolge in der Liste zurück.

Diese Funktion kann lokal ausgerichtet sein, wenn eine lokale Eigenschaft in den Parametern übergeben wird.

Syntax

ListNodePropValues(NodeList:String,Delimiter:String,PropAbbrev:String):String

NodeList ist eine kommagetrennte Liste mit Knotennamen.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

ListNodePropValues(100;200;300,[comma],Core.Leaf)

Gibt "True,True,True" zurück, wenn die Knoten "100", "200" und "300" Blattknoten sind.

ListNodesWith

Beschreibung

Gibt eine Liste der Knoten aus der angegebenen Knotenliste zurück, für die der angegebene Ausdruck mit "True" ausgewertet wird.

Syntax

ListNodesWith(NodeList:String,Delimiter:String,Expression:String):String

NodeList ist eine kommagetrennte Liste mit Knotennamen.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

Expression ist ein zu evaluierender boolescher Ausdruck.

Beispiel

ListNodesWith(100;200;300,[comma],NodeIsLeaf())

Gibt "True,True,True" zurück, wenn die Knoten "100", "200" und "300" Blattknoten sind.

ListRelatedNodesWith

Beschreibung

Gibt eine Liste der zugehörigen Knoten des aktuellen Knotens zurück, für die der angegebene Ausdruck mit "True" ausgewertet wird.

Diese Funktion ist lokal ausgerichtet, wenn der Beziehungsparameter ein gleichgeordnetes oder ein Vorgängerelement ist.

Syntax

ListRelatedNodesWith(Relation:String,Expression:String,SortOrder:String,Max:Integer):String

Relation kann folgende Bedeutungen haben:

• Vorgänger – Lokale Eigenschaften können im angegebenen Ausdruck referenziert werden.

• Gleichgeordnete Elemente – Lokale Eigenschaften können im angegebenen Ausdruck referenziert werden.

• Untergeordnete Elemente – Lokale und globale Eigenschaften können im angegebenen Ausdruck referenziert werden.

• Abhängige Elemente – Lokale und globale Eigenschaften können im angegebenen Ausdruck referenziert werden.

Expression ist ein zu evaluierender boolescher Ausdruck.

SortOrder gibt die Sortierreihenfolge für die zurückgegebene Knotenliste an. Unterstützte Werte für die Sortierreihenfolge:

• [hier] – Standardwert für lokalen Kontext. Die Knotenliste wird in der Sortierreihenfolge der Standardhierarchie für die aktuelle Hierarchie zurückgegeben.

• [alpha] – Die Knotenliste wird nach Knotennamen sortiert zurückgegeben.

• [nodeid] – Wird nur aus Gründen der Abwärtskompatibilität unterstützt. Die Knotenliste wird numerisch nach der Knoten-ID jedes Knotens sortiert in der Rückgabeliste zurückgegeben.

Max ist ein Ganzzahlwert, der die maximale Anzahl der zurückzugebenden Knoten angibt. Durch das Eingeben einer Null oder das Weglassen dieses Wertes wird keine Grenze gesetzt, und alle Knoten werden zurückgegeben.

Beispiel

ListRelatedNodesWith(children,True,[alpha],1000)

Gibt "100,200,300" zurück, wenn die Knoten untergeordnete Knoten des aktuellen Knotens sind.

ListSiblings

Beschreibung

Gibt eine kommagetrennte Liste von gleichgeordneten Elementen (Peers) des aktuellen Knotens zurück.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

ListSiblings(SortOrder:String):String

SortOrder gibt die Sortierreihenfolge für die zurückgegebene Knotenliste an. Unterstützte Werte für die Sortierreihenfolge:

• [hier] – Standardwert für lokalen Kontext. Die Knotenliste wird in der Sortierreihenfolge der Standardhierarchie für die aktuelle Hierarchie zurückgegeben.

• [alpha] – Die Knotenliste wird nach Knotennamen sortiert zurückgegeben.

• [nodeid] – Wird nur aus Gründen der Abwärtskompatibilität unterstützt. Die Knotenliste wird numerisch nach der Knoten-ID jedes Knotens sortiert in der Rückgabeliste zurückgegeben.

Beispiel

ListSiblings([alpha])

Wenn A, B, C und D untergeordnete Elemente von Z sind, und der aktuelle Knoten B ist, lauten die Rückgabewerte A, C, D.

LowerCase

Beschreibung

Gibt den angegebenen Zeichenfolgenwert konvertiert in Kleinbuchstaben zurück.

Syntax

LowerCase(String:String):String

Beispiel

LowerCase(HOBBES)

Der Rückgabewert lautet: hobbes

LTrim

Beschreibung

Gibt den angegebenen Wert zurück, wobei alle Leerzeichen vom Anfang der Zeichenfolge abgeschnitten sind.

Syntax

LTrim(String: String): String 

Beispiel

LTrim("   101203")

Der Rückgabewert lautet: 101203

MaxList

Beschreibung

Gibt die maximale Anzahl an Elementen aus der angegebenen Liste zurück, wobei leere Elemente ignoriert werden. Gibt eine leere Zeichenfolge zurück, wenn die Liste ein Element enthält, das nicht dem angegebenen Typ entspricht.

Syntax

MaxList(InputList: String,Delimiter: String,ItemType: String)

InputList legt fest, welche Liste verwendet werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

ItemType gibt den erwarteten Elementdatentyp für Listenelemente an. Gültige Werte: "integer", "float" und "datetime". Der Standardwert ist "float".

Beispiel

MaxList(1;2;3,[comma],Integer)

Der Rückgabewert lautet: 3

MinList

Beschreibung

Gibt die minimale Anzahl an Elementen aus der angegebenen Liste zurück, wobei leere Elemente ignoriert werden. Gibt eine leere Zeichenfolge zurück, wenn die Liste ein Element enthält, das nicht dem angegebenen Typ entspricht.

Syntax

MinList(InputList:String,Delimiter:String,ItemType:String)

InputList legt fest, welche Liste verwendet werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

ItemType gibt den erwarteten Elementdatentyp für Listenelemente an. Gültige Werte: "integer", "float" und "datetime". Der Standardwert ist "float".

Beispiel

MinList(1;2;3,[comma],Integer)

Der Rückgabewert lautet: 1.

Modulus

Beschreibung

Gibt den Modulus (Rest) der Division aus zwei angegebenen Ganzzahlen zurück.

Syntax

Modulus(Dividend: Integer, Divisor: Integer): Integer 

Dividend ist der Zähler des Bruches, der dividiert wird.

Divisor ist der Nenner des Bruches, der dividiert wird.

Beispiel

Modulus(5,2)

Der Rückgabewert lautet: 1

Multiply

Beschreibung

Multipliziert zwei angegebene Ganzzahlen und gibt das Ergebnis zurück.

Syntax

Multiply(Int1: Integer, Int2: Integer): Integer 

Beispiel

Multiply(2,5)

Der Rückgabewert lautet: 10

MultiplyFloat

Beschreibung

Multipliziert zwei angegebene Gleitkommazahlen (Float) und gibt das Ergebnis zurück.

Syntax

Multiply(Float1: Float, Float2: Float): Float

Beispiel

MultiplyFloat(4.76,2.3)

Der Rückgabewert lautet: 10.948

NextSibling

Beschreibung

Gibt das nächste gleichgeordnete Element für den aktuellen Knoten entsprechend der Sortierreihenfolge der aktuellen Hierarchie zurück.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

NextSibling(): String

Beispiel

NextSibling()

Wenn A, B, C und D untergeordnete Elemente von Z sind und der aktuelle Knoten "B" lautet, wird "C" zurückgegeben.

NodeAccessGroups

Beschreibung

Gibt eine kommagetrennte Liste der Knotenzugriffsgruppen für den aktuellen Benutzer und den aktuellen Knoten zurück.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

NodeAccessGroups(): String 

Beispiel

NodeAccessGroups()

Der Rückgabewert lautet: Accounts, Finance

NodeExists

Beschreibung

Gibt "True" zurück, wenn der angegebene Knoten vorhanden ist.

Syntax

NodeExists(NodeAbbrev: string): Boolean 

NodeAbbrev ist der Name des zu verwendenden Knotens.

Beispiel

NodeExists(2000)

Wenn Knoten 2000 vorhanden ist, wird "True" zurückgegeben.

NodeInHier

Beschreibung

Gibt "True" zurück, wenn der angegebene Knoten in der angegebenen Hierarchie vorhanden ist.

Syntax

NodeInHier(NodeAbbrev, HierAbbrev: string): Boolean 

NodeAbbrev ist der Name des zu verwendenden Knotens.

HierAbbrev ist der Name der zu verwendenden Hierarchie.

Beispiel

NodeInHier(2000,Assets)

Wenn Knoten 2000 in der Anlagenhierarchie vorhanden ist, wird "True" zurückgegeben.

NodeIsLeaf

Beschreibung

Gibt "True" zurück, wenn der aktuelle Knoten ein Blattknoten ist.

Syntax

NodeIsLeaf(): Boolean 

Beispiel

NodeIsLeaf()

Wenn der aktuelle Knoten ein Blatt ist, wird "True" zurückgegeben.

NodeIsValidForPropertyHiers

Beschreibung

Gibt "True" zurück, wenn der angegebene Knoten die Hierarchiebeschränkung für die angegebene Eigenschaft erfüllt. Gibt auch dann "True" zurück, wenn die Eigenschaft keine Knotenwerte speichert oder wenn für die Eigenschaft keine Beschränkung definiert ist.

Diese Funktion kann lokal ausgerichtet sein, wenn eine lokale Eigenschaft in den Parametern übergeben wird.

Syntax

NodeIsValidForPropertyHiers(NodeAbbrev: String, PropAbbrev: String): Boolean

NodeAbbrev ist der Name des zu verwendenden Knotens.

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

NodePropValue

Beschreibung

Gibt den Wert der angegebenen Eigenschaft des angegebenen Knotens in der aktuellen Hierarchie für einen lokalen Knoten oder in der aktuellen Version für einen globalen Knoten zurück.

Diese Funktion kann lokal ausgerichtet sein, wenn eine lokale Eigenschaft in den Parametern übergeben wird.

Syntax

NodePropValue(NodeAbbrev: String, PropAbbrev: String): String 

NodeAbbrev ist der Name des zu verwendenden Knotens.

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

NodePropValue(2000,Abbrev())

Der Rückgabewert lautet: 2000.

Not

Beschreibung

Gibt das boolesche Gegenteil des angegebenen booleschen Ausdrucks zurück.

Syntax

Not(Expression: Boolean): Boolean 

Beispiel

Not(NodeIsLeaf())

Wenn der Knoten ein Ast ist, wird "True" zurückgegeben.

Now

Beschreibung

Gibt das aktuelle Systemdatum/die aktuelle Systemuhrzeit zurück.

Syntax

Now([DateTimeType: String]): DateTime

DataTimeType ist optional, um anzugeben, welcher Datumsbereich zurückgegeben werden soll. Gültige Werte: "Date", "Time", "Datetime". Der Standardwert ist "Date".

Beispiel

Now()

Gibt das aktuelle Datum und die aktuelle Uhrzeit zurück, z.B. 3/25/2010 9:20:44 AM.

Now(Time)

Gibt nur die aktuelle Uhrzeit zurück, z.B. 9:20:44 AM.

Now(Date)

Gibt nur das aktuelle Datum zurück, z.B. 3/5/2010.

NumChildWith

Beschreibung

Gibt die Anzahl der untergeordneten Elemente für den aktuellen Knoten zurück, für die der angegebene Ausdruck mit "True" ausgewertet wird.

Syntax

NumChildWith(Expression: Boolean): Integer 

Beispiel

NumChildWith(NodeIsLeaf())

Wenn der Knoten über zwei untergeordnete Blattelemente verfügt, wird "2" zurückgegeben.

NumDescendantsWith

Beschreibung

Gibt die Anzahl der abhängigen Elemente für den aktuellen Knoten zurück, für die der angegebene Ausdruck mit "True" ausgewertet wird.

Syntax

NumDescendantsWith(Expression: Boolean): Integer 

Beispiel

NumDescendantsWith(NodeIsLeaf())

Wenn der Knoten über zwei untergeordnete Elemente verfügt und jedes untergeordnete Element über 10 untergeordnete Blattelemente verfügt, wird "20" zurückgegeben.

Or

Beschreibung

Gibt "True" zurück, wenn einer der angegebenen booleschen Ausdrücke mit "True" ausgewertet wird.

Syntax

Or(Expression1, Expression2,... ExpressionN: Boolean): Boolean

Beispiel

Or(NodeIsLeaf(),Equals(Integer,PropValue(Level),3))

Wenn der aktuelle Knoten entweder ein Blatt ist oder sich in Ebene 3 der Hierarchie befindet, wird "True" zurückgegeben.

OrigPropValue

Beschreibung

Gibt den Wert der angegebenen Eigenschaft für den Ursprungsknoten zurück, wenn die Funktion HasSiblingWith oder NumDescendantsWith verwendet wird.

Diese Funktion kann lokal ausgerichtet sein, wenn eine lokale Eigenschaft in den Parametern übergeben wird.

Syntax

OrigPropValue(PropAbbrev: String): String 

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

HasSiblingWith(GreaterThan(OrigPropValue(ID),ID())

Wenn die ID des aktuellen Knotens "200" lautet und über untergeordnete Elemente mit einer Knoten-ID verfügt, die größer als 200 ist, wird "True" zurückgegeben.

PadChar

Beschreibung

Gibt eine angegebene Zeichenfolge zurück, deren Länge mit einem angegebenen Auffüllzeichen festgelegt wird. Das Auffüllen kann links oder rechts von der ursprünglichen Zeichenfolge erfolgen. Die daraus resultierende Zeichenfolge ist mindestens so lang wie die angegebene Anzahl von Ziffern. Wenn die ursprüngliche Zeichenfolge länger als die angegebene Anzahl von Ziffern ist, wird die ursprüngliche Liste zurückgegeben.

Syntax

PadChar(String: String, PadChar: String; PadLeft: Boolean; NewLength: Integer): String 

String ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

PadChar ist das Zeichen, das zum Auffüllen der Zeichenfolge verwendet werden soll.

PadLeft gibt an, ob die Zeichenfolge auf der linken Seite aufgefüllt werden soll. Gültige Werte: 1, 0, T, F, t oder f.

NewLength ist eine Ganzzahl, die die Länge des Ergebnisses angibt.

Beispiel

PadChar(102,0,1,6)

Der Rückgabewert lautet: 000102

PadList

Beschreibung

Gibt eine angegebene Liste zurück, deren Länge mit einem angegebenen Auffüllzeichen festgelegt wird. Das Auffüllen kann links oder rechts von der ursprünglichen Liste erfolgen. Die daraus resultierende Liste ist mindestens so lang wie die angegebene Anzahl von Ziffern. Wenn die ursprüngliche Liste länger als die angegebene Anzahl von Ziffern ist, wird die ursprüngliche Liste zurückgegeben.

Syntax

PadList(String, DelimChar, PadChr:String, PadLeft: Boolean, NewLength:Integer): String 

StringList ist die Liste der Zeichenfolgen, die aufgefüllt werden sollen, getrennt durch das angegebene Trennzeichen.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

PadChar ist das Zeichen, das zum Auffüllen der Zeichenfolge verwendet werden soll.

PadLeft gibt an, ob die Zeichenfolge auf der linken Seite aufgefüllt werden soll. Gültige Werte: 1, 0, T, F, t oder f.

NewLength ist eine Ganzzahl, die die Länge des Ergebnisses angibt.

Beispiel

PadList(1;2;3;4,;,T,3)

Der Rückgabewert lautet: 001;002;003,004

ParentPropValue

Beschreibung

Gibt den Wert der angegebenen Eigenschaft des übergeordneten Knotens des aktuellen Knotens zurück. Gibt eine leere Zeichenfolge zurück, wenn der Knoten über keinen übergeordneten Knoten verfügt oder wenn der aktuelle Knoten kein lokaler Knoten ist.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

ParentPropValue(PropAbbrev: String): String 

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

ParentPropValue(Abbrev)

Wenn der übergeordnete Knotenname "Colas" lautet, wird "Colas" zurückgegeben.

Pos

Beschreibung

Gibt die Position (Index) des ersten Zeichens der angegebenen Teilzeichenfolge innerhalb der angegebenen Zeichenfolge zurück, wobei unter Berücksichtigung der Groß-/Kleinschreibung gesucht wird. Es wird ein Nullwert zurückgegeben, wenn die Teilzeichenfolge innerhalb des Zeichenfolgenwertes nicht gefunden wird.

Syntax

Pos(SubString: String, String: String): Integer 

Substring ist der Zeichenfolgenwert, nach dem gesucht werden soll.

String ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

Beispiel

Pos(D,ABCDEFG)

Der Rückgabewert lautet: 4

PreviousSibling

Beschreibung

Gibt das vorherige gleichgeordnete Element für den aktuellen Knoten entsprechend der Sortierreihenfolge der aktuellen Hierarchie zurück.

Diese Funktion ist lokal ausgerichtet und funktioniert bei Verwendung in einem globalen Kontext nicht ordnungsgemäß.

Syntax

PreviousSibling(): String

Beispiel

PreviousSibling()

Wenn A, B, C und D untergeordnete Elemente von Z sind und der aktuelle Knoten "B" lautet, wird "A" zurückgegeben.

PropControllingHier

Beschreibung

Gibt den Namen der Steuerhierarchie der angegebenen Eigenschaft in der aktuellen Version zurück.

Syntax

PropControllingHier(PropAbbrev: String): String 

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

PropControllingHier(TimeBalance)

Der Rückgabewert lautet: Accounts

PropDefaultValue

Beschreibung

Gibt den Standardwert der angegebenen Eigenschaftsdefinition zurück.

Syntax

PropDefaultValue(PropAbbrev: String): String 

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

PropDefaultValue(Currency)

Der Rückgabewert lautet: USD

PropertyCategories

Beschreibung

Gibt eine kommagetrennte Liste mit Eigenschaftskategorien für den aktuellen Benutzer zurück.

Syntax

PropertyCategories(AccessType: String) :String

AccessType ist die Zugriffsebene für eine Eigenschaftskategorie. Gültige Werte: "ReadOnly", "ReadWrite" oder "Both".

Beispiel

PropertyCategories(Both)

Der Rückgabewert lautet: System, All, Essbase, Enterprise, HFM, Planning

PropMaxValue

Beschreibung

Gibt den Höchstwert der angegebenen Eigenschaftsdefinition zurück.

Syntax

PropMaxValue(PropAbbrev: String): Integer 

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

PropMaxValue(Volume)

Der Rückgabewert lautet: 10

PropMinValue

Beschreibung

Gibt den Mindestwert der angegebenen Eigenschaftsdefinition zurück.

Syntax

PropMinValue(PropAbbrev: String): Integer

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

PropMinValue(Volume)

Der Rückgabewert lautet: 1

PropValue

Beschreibung

Gibt den Wert der angegebenen Eigenschaft für den aktuellen Knoten zurück.

Diese Funktion kann lokal ausgerichtet sein, wenn eine lokale Eigenschaft in den Parametern übergeben wird.

Syntax

PropValue(PropAbbrev: String): String 

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

PropValue(Volume)

Der Rückgabewert lautet: 2

RangeListContains

Beschreibung

Gibt "True" zurück, wenn die angegebene Bereichsliste den angegebenen Wert enthält.

Syntax

RangeListContains(RangeList: String, Value: Integer, Delimiter: String): Boolean

RangeList ist eine Liste zu durchsuchender Ganzzahlbereiche, die durch das angegebene Trennzeichen getrennt sind. Beispiele: 1-100, 201-300

Value ist ein ganzzahliger Wert, nach dem in der Liste der Bereiche gesucht werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

Beispiel

RangeListContains(PropValue(MyRangeList),1,[Comma])

Wenn die Eigenschaft MyRangeList' einen Wert von 1-10, 101-10000 hat, wird "True" zurückgegeben, da der Wert "1" im angegebenen Bereich enthalten ist. Mit RangeListContains(PropValue(MyRangeList),11,[Comma]) wird aber "False" zurückgegeben, da der Wert "11" nicht im angegeben Bereich enthalten ist.

ReplacementAbbrev

Beschreibung

Gibt den Namen des Ersetzungs-(Zusammenführungs-)Knotens für den aktuellen Knoten zurück, wenn der Knoten inaktiv ist und ein Zusammenführungsknoten angegeben wurde.

Syntax

ReplacementAbbrev(): String 

Beispiel

ReplacementAbbrev()

ReplacePropValue

Beschreibung

Gibt den angegebenen Eigenschaftswert für den Ersetzungs-(Zusammenführungs-)Knoten des aktuellen Knotens zurück, wenn der Knoten inaktiv ist und ein Zusammenführungsknoten angegeben wurde.

Diese Funktion kann lokal ausgerichtet sein, wenn eine lokale Eigenschaft in den Parametern übergeben wird.

Syntax

ReplacePropValue(PropAbbrev: String): String 

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

Beispiel

ReplacePropValue(Description)

ReplaceStr

Beschreibung

Gibt die Zeichenfolge mit Instanzen des alten Musters zurück, das durch das neue Muster ersetzt wurde.

Syntax

ReplaceStr(String: String,OldPattern: String,NewPattern: String,ReplaceAll: Boolean): String

String ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

NewPattern ist der Zeichenfolgenwert, durch den die gefundene Zeichenfolge ersetzt werden soll.

OldPattern ist der Zeichenfolgenwert, nach dem gesucht werden soll.

ReplaceAll gibt an, ob alle Vorkommen der Suchzeichenfolge durch die Ersetzungszeichenfolge ersetzt werden sollen. Gültige Werte: 1, 0, T, F, t oder f.

Beispiel

ReplaceStr(A1;A2;A3,A,B,T)

Der Rückgabewert lautet: B1;B2;B3

RTrim

Beschreibung

Gibt den angegebenen Wert zurück, wobei alle Leerzeichen vom Ende der Zeichenfolge abgeschnitten sind.

Syntax

RTrim(String: String): String 

String ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

Beispiel

RTrim("100   "))

Der Rückgabewert lautet: 100

SortList

Beschreibung

Gibt die angegebene Liste in einer sortierten Reihenfolge zurück.

Syntax

SortList(InputList: String,Delimiter: String,IgnoreCase: Boolean,ItemType: String)

InputList legt fest, welche Liste verwendet werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

IgnoreCase gibt an, ob die Groß-/Kleinschreibung beim Sortieren ignoriert werden soll. Der Standardwert lautet "False".

ItemType gibt den Zieldatentyp für Elemente der Ergebnisliste an. Gültige Werte: "string", "integer", "float date", "time" und "datetime". Der Standardwert ist "string". Wenn irgendein Element nicht in den angegebenen Typ konvertiert werden kann, gibt die Funktion eine leere Zeichenfolge zurück.

StripPadChar

Beschreibung

Entfernt ein angegebenes Auffüllzeichen vom Anfang einer angegebenen Zeichenfolge und gibt den geänderten Wert zurück. Wenn die ursprüngliche Zeichenfolge weniger Auffüllzeichen enthält als für StripCount angegeben, wird der ursprüngliche Zeichenfolgenwert zurückgegeben.

Syntax

StripPadChar(String: String, PadChar: String, StripCount: Integer): String

String ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

PadChar ist das Zeichen, das zum Auffüllen der Zeichenfolge verwendet werden soll.

StripCount ist eine Ganzzahl, die die Anzahl der Zeichen angibt, die aus der Zeichenfolge entfernt werden sollen. Mit Null werden alle aufgefüllten Zeichen entfernt.

Beispiel

StripPadChar(0003333,0,6)

Der Rückgabewert lautet: 3333

StrToBool

Beschreibung

Gibt einen booleschen Wert auf der Grundlage der angegebenen Zeichenfolge zurück. Wenn die Zeichenfolge mit Y, T oder 1 (Eins) beginnt, wird unabhängig von der Groß-/Kleinschreibung oder von folgenden Zeichen der Wert "True" zurückgegeben. Wenn die Zeichenfolge mit N, F oder 0 (Null) beginnt, wird unabhängig von der Groß-/Kleinschreibung oder von folgenden Zeichen der Wert "False" zurückgegeben.

Syntax

StrToBool(String: String): Boolean

String ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

Beispiel

StrToBool(0)

Der Rückgabewert lautet: False

StrToFloat

Beschreibung

Gibt den Gleitkommawert der angegebenen Zeichenfolge zurück. Gibt Null (0) für ein Leerzeichen oder eine leere Zeichenfolge zurück.

Wenn die angegebene Zeichenfolge keine Gleitkommazahl ist, wird ein Fehler zurückgegeben.

Syntax

StrToFloat(String: String): Float 

String ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

Beispiel

StrToFloat(11.101)

Der Rückgabewert lautet: 11.101

StrToInt

Beschreibung

Gibt den Ganzzahlenwert der angegebenen Zeichenfolge zurück. Gibt Null (0) für ein Leerzeichen oder eine leere Zeichenfolge zurück.

Wenn die angegebene Zeichenfolge keine Ganzzahl ist, wird ein Fehler zurückgegeben.

Syntax

StrToInt(String: String): Integer 

String ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

Beispiel

StrToInt(101)

Der Rückgabewert lautet: 101

Stuff

Beschreibung

Gibt den angegebenen Wert zurück, bei dem die angegebenen Zeichen durch die angegebene Zeichenfolge ersetzt wurden.

Syntax

Stuff(PropAbbrev: String, CharsToReplace: String, ReplacementChars: String): String 

PropAbbrev ist der Name der zu verwendenden Eigenschaft.

CharsToReplace ist der Zeichenfolgenwert, nach dem gesucht werden soll.

ReplacementChars ist der Zeichenfolgenwert, durch den die gefundene Zeichenfolge ersetzt werden soll.

Beispiel

Stuff(Abbrev(),GEO,RIO)

Wenn die Abkürzung "GEO101" lautet, wird "RIO101" zurückgegeben.

SubString

Beschreibung

Gibt einen Teil der angegebenen Zeichenfolge zurück, beginnend am angegebenen Index und mit der angegebenen Anzahl von Zeichen.

Syntax

SubString(String: String, Index: Integer, Count: Integer): String

SubString ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

Index ist eine Ganzzahl, die die Indexposition darstellt, ab der nach der Teilzeichenfolge gesucht werden soll. Null gibt die erste Zeichenposition in der Zeichenfolge an.

Count ist eine Zahl, die die Anzahl der zu suchenden Zeichen angibt, beginnend ab dem Startindex.

Beispiel

SubString(Colas,1,2)

Der Rückgabewert lautet: Co

Subtract

Beschreibung

Subtrahiert den zweiten Ganzzahlenwert vom ersten Wert und gibt das Ergebnis zurück.

Syntax

Subtract(Minuend: Integer,Subtrahend: Integer): Integer 

Minuend ist ein ganzzahliger Wert.

Subtrahend ist ein ganzzahliger Wert.

Beispiel

Subtract(10,2)

Der Rückgabewert lautet: 8

SubtractFloat

Beschreibung

Subtrahiert den zweiten Gleitkommawert vom ersten Wert und gibt das Ergebnis zurück.

Syntax

SubtractFloat(Minuend,Subtrahend: Float): Float

Minuend ist ein Gleitkommawert.

Subtrahend ist ein Gleitkommawert.

Beispiel

SubtractFloat(8.09,3.76)

Der Rückgabewert lautet: 4.33

SumList

Beschreibung

Gibt die Summe der Elemente in einer Liste zurück, wobei leere Elemente ignoriert werden. Gibt eine leere Zeichenfolge zurück, wenn die Liste ein Element enthält, das nicht dem angegebenen Elementtyp entspricht.

Syntax

SumList(InputList: String,Delimiter: String,ItemType: String):Integer

InputList legt fest, welche Liste verwendet werden soll.

Delimiter ist das Zeichen, das zum Trennen von Elementen in der Zeichenfolgenliste verwendet werden soll. Unterstützte Sonderzeichen:

• [comma]

• [space]

• [tab]

ItemType gibt den erwarteten Elementdatentyp für Listenelemente an. Gültige Werte: "integer" und "float". Der Standardwert ist "float".

Beispiel

SumList(1;2;3,;,Integer)

Der Rückgabewert lautet: 6.

Trim

Beschreibung

Gibt den angegebenen Wert zurück, wobei alle Leerzeichen vom Anfang und Ende der Zeichenfolge abgeschnitten sind.

Syntax

Trim(String: String): String 

String ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

Beispiel

Trim("   101   ")

Der Rückgabewert lautet: 101

UpperCase

Beschreibung

Gibt einen in Großbuchstaben konvertierten Zeichenfolgenwert zurück.

Syntax

UpperCase(String: String): String 

String ist der Zeichenfolgenwert, für den die Funktion ausgeführt werden soll.

Beispiel

UpperCase(smaller)

Der Rückgabewert lautet: SMALLER

UserName

Beschreibung

Gibt den Benutzernamen des aktuellen Benutzers zurück.

Syntax

UserName(): String 

Beispiel

UserName()

Der Rückgabewert ist der Name des Benutzers.

XOr

Beschreibung

Gibt "True" zurück, wenn genau einer der angegebenen booleschen Ausdrücke mit "True" ausgewertet wird.

Syntax

XOr(Expression1:Boolean, Expression2: Boolean): Boolean 

Beispiel

XOr(NodeIsLeaf(),Equals(Integer,PropValue(Level),3))

Wenn der Knoten entweder ein Blatt ist oder sich in Ebene 3 der Hierarchie befindet, wird "True" zurückgegeben.