# System ## ActionResult Creates an Action Result #### Syntax ``` ActionResult ( [ExecutionResult] [, Message] ) ``` #### Parameters ***ExecutionResult*** (optional)\ The result type ('Success', 'Cancelled', 'NeedsInput', 'Error').\ Type: String ***Message*** (optional)\ The Message to display to the User.\ Type: String #### Return Type ActionResult ## AddItem Takes a list of any type and an item of the same type and appends the item to the list. #### Syntax ``` AddItem ( List , Item ) ``` #### Parameters **List**\ The list which the element is added to.\ Type: List\ **Item**\ The element which is be added to the list.\ Type: Any #### Return Type List\ ## AddUserToLicense Adds a user to a license or license item. Throws an error if the license or license item does not support user assignments. #### Syntax ``` AddUserToLicense ( LicenseId [, ItemId] , OfficeId, UserId ) ``` #### Parameters **LicenseId**\ The ID of the license the user should get assigned to.\ Type: Guid ***ItemId*** (optional)\ The ID of the license item the user should get assigned to.\ Type: Guid **OfficeId**\ The office to filter the features (the current office if left empty).\ Type: Guid **UserId**\ The ID of the user to assign the license to.\ Type: Guid #### Return Type Void ## CheckoutDocument Checks out the document associated to the given Object. #### Syntax ``` CheckoutDocument ( Object ) ``` #### Parameters ***Object***\ The Object which document will be checked out.\ Type: Object #### Return Type Void ## Close Closes the Layout associated to the given Object. #### Syntax ``` Close ( Object ) ``` #### Parameters ***Object***\ The Object which Layout to close.\ Type: Object #### Return Type Exit ## Condition Represents a Condition in a Selection. #### Syntax ``` Condition ( [LeftParenthesis] , FieldId [, IsNegated] , Operator , Value [, RightParenthesis] [, LogicalOperator] ) ``` #### Parameters ***LeftParenthesis*** (optional)\ The left parenthesis to use for the Condition (e. g. '(').\ Type: String ***FieldId***\ The ID of the Field to compare to.\ Type: Guid ***IsNegated*** (optional)\ Determines whether the Condition is negated or not (default: false).\ Type: Boolean ***Operator***\ The Operator used for the comparison ('Equal', 'NotEqual', 'Smaller', 'SmallerOrEqual', 'Greater', 'GreaterOrEqual', 'BeginsWith', 'Contains', 'EndsWith', 'IsNull', 'IsNotNull', 'IsEmpty', 'IsNullOrEmpty', 'IsNotEmpty', 'In').\ Type: String ***Value***\ The Value to compare to (or NULL for 'IsNull', 'IsEmpty').\ Type: String Converts a Source document to a Target Format. The following conversions are supported: doc, docm, docx, dot, dotm, dotx, htm, html, log, mht, mhtml, odt, ott, rtf, txt, xhtml, xml to doc, docm, docx, dot, dotm, dotx, htm, html, log, mht, mhtml, odt, ott, rtf, txt, xhtml, xml - eml, msg to eml, msg - csv, doc, docm, docx, dot, dotm, dotx, eml, emlx, epub, fo, htm, html, ics, latex, log, mbox, mht, mhtml, msg, odp, ods, odt, oft, otp, ots, ott, pcl, pdf, pot, potm, potx, pps, ppsm, ppsx, ppt, pptm, pptx, rtf, tnef, txt, vcf, vdw, vdx, vsd, vsdx, vss, vst, vsx, vtx, xhtml, xls, xlsb, xlsm, xlsx, xltm, xltx, xml, xps to pdf ***RightParenthesis*** (optional)\ The right parenthesis to use for the Condition (')').\ Type: String ***LogicalOperator*** (optional)\ The logical Operator combining this and the next Condition ('And', 'Or', 'None').\ Type: String #### Return Type Condition ## Convert Converts a Source document to a Target Format. {% hint style="info" %} The following conversions are supported: * doc, docm, docx, dot, dotm, dotx, htm, html, log, mht, mhtml, odt, ott, rtf, txt, xhtml, xml **to** doc, docm, docx, dot, dotm, dotx, htm, html, log, mht, mhtml, odt, ott, rtf, txt, xhtml, xml * eml, msg **to** eml, msg * bmp, csv, doc, docm, docx, dot, dotm, dotx, emf, eml, emlx, epub, exif, fo, gif, htm, html, icon, ics, jpeg, jpg, latex, log, mbox, mht, mhtml, msg, odp, ods, odt, oft, otp, ots, ott, pcl, pdf, png, pot, potm, potx, pps, ppsm, ppsx, ppt, pptm, pptx, rtf, tiff, tnef, txt, vcf, vdw, vdx, vsd, vsdx, vss, vst, vsx, vtx, wmf, xhtml, xls, xlsb, xlsm, xlsx, xltm, xltx, xml, xps **to** pdf {% endhint %} #### Syntax ``` Convert ( Source [, SourceFormat] , TargetFormat ) ``` #### Parameters **Source**\ The Source document to convert.\ Type: Document ***SourceFormat*** (optional)\ The Source Format of the document. Analyses the given source if format is omitted.\ Type: String **TargetFormat**\ The Target Format to convert to.\ Type: String #### Return Type Document ## CopyContent Copied Content of the SourceObject to TargetObject. Optional with FieldNameList and Parameters. #### Syntax ``` CopyContent ( SourceObject , TargetObject [, FieldValues] [, Parameters] ) ``` #### Parameters ***SourceObject***\ The Source Object to copy from.\ Type: Object ***TargetObject***\ Target Object to copy to.\ Type: Object ***FieldValues*** (optional)\ The values to set (does not copy the Source fields if this is set).\ Type: Dictionary\ ***Parameters*** (optional)\ The values to set (does copy the Source fields if this is set).\ Type: Dictionary\ #### Return Type Object ## CopyValues Copies values from the source to the target while including or excluding specific keys. #### Syntax ``` CopyValues ( Source , Target [, Include ] [, Exclude ] ) ``` #### Parameters **Source**\ The source Object or Dictionary\ to copy from.\ Type: Any **Target**\ The target Object or Dictionary\ to copy to.\ Type: Any ***Include*** (optional)\ A list of keys to include (all by default).\ Type: List\ ***Exclude*** (optional)\ A list of keys to exclude (none by default).\ Type: List\ #### Return Type Void ## CountDocumentPages Returns the number of pages from a PDF or Word document. #### Syntax ``` CountDocumentPages ( Document ) ``` #### Parameters ***Document***\ The PDF or Word document.\ Type: Document #### Return Type Int ## CreateAndExecuteTemplate Creates a temporary document template and execute the template. #### Syntax ``` CreateAndExecuteTemplate ( Object , Document [, Parameters] ) ``` #### Parameters ***Object***\ The object which the template is performed on.\ Type: Any ***Document***\ The template document.\ Type: Any ***Parameters*** (optional)\ List of Replacing Parameters (key: replace tag, value: replacing text).\ Type: Dictionary\ #### Return Type Document ## **CreateDocumentFromBase64String** Creates a document from a Base64 encoded String and returns it. #### Syntax ``` CreateDocumentFromBase64String ( Content , FileName [, MimeType] ) ``` #### Parameters **Content**\ The Base64 encoded document content.\ Type: String **Filename**\ The file name of the document.\ Type: String ***MimeType*** (optional)\ The MIME type of the document. Analyses the FileName extension if left empty.\ Type: String #### Return Type Document ## CreateInstance Takes OfficeId, ApplicationId, ClassId, Parameters, LinkPath as input, which are used to create an instance. OfficeId, ApplicationId identify the space in which the instance is created. ClassId defines the type of the instance created. Link Path can specify a specific navigation path to the instance. Parameters represent a Dictionary which is a list of Key-Value-Pairs. (see Dictionary) #### Syntax ``` CreateInstance ( OfficeId , ApplicationId , ClassId [, Parameters] [, LinkPath] ) ``` #### Parameters ***OfficeId***\ This ID identifies the Workspace / Office in which the instance is created.\ Type: Guid ***ApplicationId***\ This ID identifies the Application in which the instance is created.\ Type: Guid ***ClassId***\ This ID identifies the Class of which the instance is created.\ Type: Guid ***Parameters*** (optional)\ This is a set of Key-Value-Pairs which is used as parameters for the creation of an object.\ Type: Dictionary\ ***LinkPath*** (optional)\ Navigation path to the object.\ Type: LinkPath #### Return Type Object ## CreateLinkedInstance Takes Object, LinkId, Parameters as input, which are used to create a linked instance. The LinkId is used to specify a link which was created in the Class Designer. Parameters represent a Dictionary which is a list of Key-Value-Pairs. (see Dictionary) #### Syntax ``` CreateLinkedInstance ( Object , LinkId [, Parameters] ) ``` #### Parameters ***Object***\ Object which is used as basis of the link.\ Type: Object ***LinkId***\ The ID of the Link which has been specified in the Class Designer.\ Type: Guid ***Parameters*** (optional)\ This is a set of Key-Value-Pairs which is used as parameters for the creation of an object.\ Type: Dictionary\ #### Return Type Object ## CreateLinkPath Creates a Link Path. #### Syntax ``` CreateLinkPath ( [OfficeId] [, ClassId] [, InstanceId] ) ``` #### Parameters ***OfficeId*** (optional)\ The ID of the Office of the Link Path.\ Type: Guid ***ClassId*** (optional)\ The ID of the Class of the Link Path.\ Type: Guid ***InstanceId*** (optional)\ The ID of the Instance of the Link Path.\ Type: String #### Return Type Link ## CreateSiblingInstance Creates an object having the same parent and the same type as the current object. #### Syntax ``` CreateSiblingInstance ( Object [, Parameters] ) ``` #### Parameters ***Object***\ The object a sibling created for.\ Type: Object ***Parameters*** (optional)\ This is a set of Key-Value-Pairs which is used as parameters for the creation of an object.\ Type: Dictionary\ #### Return Type Object ## DataSourceOptionEscape Escapes characters used in a data source option. #### Syntax ``` DataSourceOptionEscape ( Value ) ``` #### Parameters ***Value***\ The value that contains the characters to escape.\ Type: String #### Return Type String ## DataSourceOptionObject Represents an object used in a data source option. #### Syntax ``` DataSourceOptionObject ( Id [, Name] [, Translations] ) ``` #### Parameters **Id**\ The ID of the option object (must not be escaped).\ Type: String ***Name*** (optional)\ The name of the option object (must not be escaped). ID is used if the name is not provided.\ Type: String ***Translations*** (optional)\ The translations of the option name (texts must not be escaped).\ Type: List\ #### Return Type DataSourceOptionObject ## DataSourceOptionWriter Creates an escaped data source option string using DataSourceOptionObjects. #### Syntax ``` DataSourceOptionWriter ( Objects ) ``` #### Parameters ***Objects***\ The data source option objects to use to create the option string.\ Type: List\ #### Return Type String ## DeleteInstance Deletes an instance of an object. #### Syntax ``` DeleteInstance ( [Object] ) ``` #### Parameters ***Object*** (optional)\ The Object that will be deleted.\ Type: Object #### Return Type Void ## Deprecated!ExecuteScript Deprecated! Executes a script identified by its ID. #### Syntax ``` Deprecated!ExecuteScript ( ScriptId ) ``` #### Parameters ***ScriptId***\ ID identifying the Script which will be executed.\ Type: Guid #### Return Type Any ## Deprecated!ExecuteSection Deprecated! Executes a Template as a Section (usable in other Templates) and returns the result. #### Syntax ``` Deprecated!ExecuteSection ( TemplateId , Language [, OfficeId] [, ApplicationId] [, LinkPath] [, InstanceId] [, Parameters] ) ``` #### Parameters ***TemplateId***\ The ID of the Template to execute.\ Type: Guid ***Language***\ Not used: The Language of the Template.\ Type: Language ***OfficeId*** (optional)\ The ID of the Office to execute the Template in (used for the Instance).\ Type: Guid ***ApplicationId*** (optional)\ The ID of the Application to execute the Template in (used for the Instance).\ Type: Guid ***LinkPath*** (optional)\ The Link Path of the Instance to execute the Template with.\ Type: LinkPath ***InstanceId*** (optional)\ The ID of the Instance to execute the Template with.\ Type: Any ***Parameters*** (optional)\ The required Parameters of the Template.\ Type: Dictionary\ #### Return Type Any ## Deprecated!Lock Deprecated! Locks the execution of a group of statements. #### Syntax ``` Deprecated!Lock ( Block ) ``` #### Parameters ***Block***\ Represents the list of statements.\ Type: Any #### Return Type Void ## Dictionary Creates an empty list of key value pairs. #### Syntax ``` Dictionary ( [Entries] ) ``` #### Parameters ***Entries*** (optional)\ The Entries to set initially.\ Type: Entry #### Return Type Dictionary\ ## Download Downloads a Document. #### Syntax ``` Download ( Document ) ``` #### Parameters ***Document***\ The Document to download.\ Type: Document #### Return Type Exit ## DownloadFromInstance Downloads a Document associated with an Object. #### Syntax ``` DownloadFromInstance ( Object ) ``` #### Parameters ***Object***\ The Object with the associated Document.\ Type: Object #### Return Type Exit ## Entry Represents an Entry in a Dictionary. #### Syntax ``` Entry ( Key [, Value] ) ``` #### Parameters ***Key***\ The Key of the Entry.\ Type: Any ***Value*** (optional)\ The Value of the Entry\ Type: Any #### Return Type Entry ## ExecuteClassAction Executes an action for a specific class in a specific Office and Application, with specific parameters and LinkPath. #### Syntax ``` ExecuteClassAction ( OfficeId , ApplicationId , ClassId , ActionId [, LinkPath] [, Parameters] ) ``` #### Parameters ***OfficeId***\ This ID identifies the Workspace / Office of the class for which the action should be executed.\ Type: Guid ***ApplicationId***\ This ID identifies the Application of the class for which the action should be executed.\ Type: Guid ***ClassId***\ This ID identifies the Class for which the action should be executed.\ Type: Guid ***ActionId***\ This ID identifies the Action which will be executed.\ Type: Guid ***LinkPath*** (optional)\ Navigation path to the object. Optional and can be null.\ Type: LinkPath ***Parameters*** (optional)\ This is a set of Key-Value-Pairs which is used as parameters for a class execution.\ Type: Dictionary\ #### Return Type Any ## ExecuteClassWorkflow Executes a workflow for a specific class in a specific Office and Application, with specific parameters and LinkPath. #### Syntax ``` ExecuteClassWorkflow ( [OfficeId] [, ApplicationId] , ClassId , WorkflowId [, LinkPath] [, Parameters] ) ``` #### Parameters ***OfficeId*** (optional)\ This ID identifies the Workspace / Office of the class for which the workflow should be executed.\ Type: Guid ***ApplicationId*** (optional)\ This ID identifies the Application of the class for which the workflow should be executed.\ Type: Guid ***ClassId***\ This ID identifies the Class for which the workflow should be executed.\ Type: Guid ***WorkflowId***\ This ID identifies the Workflow which will be executed.\ Type: Guid ***LinkPath*** (optional)\ Navigation path to the object. Optional and can be null.\ Type: LinkPath ***Parameters*** (optional)\ This is a set of Key-Value-Pairs which is used as parameters for a class execution.\ Type: Dictionary\ #### Return Type Any ## ExecuteFunction Executes a Function and returns the result. #### Syntax ``` ExecuteFunction ( [FunctionId] [, Parameters] ) ``` #### Parameters ***FunctionId*** (optional)\ The ID of the Function to execute.\ Type: Guid ***Parameters*** (optional)\ The Parameters required by the Function.\ Type: Dictionary\ #### Return Type Any ## ExecuteInstanceAction Takes an object, an ActionId and Dictionary of Parameters as input and executes an action on that object. #### Syntax ``` ExecuteInstanceAction ( Object , ActionId [, Parameters] ) ``` #### Parameters ***Object***\ The object which the action is performed on.\ Type: Object ***ActionId***\ ID identifying the Action which will be executed.\ Type: Guid ***Parameters*** (optional)\ This is a set of Key-Value-Pairs which is used as parameters for an instance execution.\ Type: Dictionary\ #### Return Type Any ## ExecuteInstanceWorkflow Takes an object, an WorkflowId and Dictionary of Parameters as input and executes a workflow on that object. #### Syntax ``` ExecuteInstanceWorkflow ( Object , WorkflowId [, Parameters] ) ``` #### Parameters ***Object***\ The object which the workflow is performed on.\ Type: Any ***WorkflowId***\ ID identifying the Workflow which will be executed.\ Type: Any ***Parameters*** (optional)\ This is a set of Key-Value-Pairs which is used as parameters for an instance execution.\ Type: Any #### Return Type Any ## ExecuteSection2 Executes a Template as a Section (usable in other Templates) and returns the result. #### Syntax ``` ExecuteSection2 ( TemplateId [, TemplateDocument] [, ParentId] [, ParentDocument] [, Language] [, OfficeId] [, ApplicationId] [, LinkPath] [, InstanceId] [, Parameters] ) ``` #### Parameters **TemplateId**\ The ID of the Template to execute.\ Type: Guid ***TemplateDocument*** (optional)\ The document to use (instead of the document of the Template with the given ID).\ Type: Document ***ParentId*** (optional)\ The ID of the Parent Template to use if no parent is defined.\ Type: Guid ***ParentDocument*** (optional)\ The parent document to use (instead of the document of the Template parent or the Parent with the given ID).\ Type: Document ***Language*** (optional)\ Not used: The Language of the Template.\ Type: Language ***OfficeId*** (optional)\ The ID of the Office to execute the Template in (used for the Instance).\ Type: Guid ***ApplicationId*** (optional)\ The ID of the Application to execute the Template in (used for the Instance).\ Type: Guid ***LinkPath*** (optional)\ The Link Path of the Instance to execute the Template with.\ Type: LinkPath ***InstanceId*** (optional)\ The ID of the Instance to execute the Template with.\ Type: Any ***Parameters*** (optional)\ The required Parameters of the Template.\ Type: Dictionary\ #### Return Type Any ## ExecuteTemplate Executes a Template and returns the Document result. #### Syntax ``` ExecuteTemplate ( TemplateId [, Language] [, OfficeId] [, ApplicationId] [, LinkPath] [, InstanceId] [, Parameters] ) ``` #### Parameters ***TemplateId***\ The ID of the Template to execute.\ Type: Guid ***Language*** (optional)\ Not used: The Language of the Template.\ Type: Language ***OfficeId*** (optional)\ The ID of the Office to execute the Template in (used for the Instance).\ Type: Guid ***ApplicationId*** (optional)\ The ID of the Application to execute the Template in (used for the Instance).\ Type: Guid ***LinkPath*** (optional)\ The Link Path of the Instance to execute the Template with.\ Type: LinkPath ***InstanceId*** (optional)\ The ID of the Instance to execute the Template with.\ Type: Any ***Parameters*** (optional)\ The required Parameters of the Template.\ Type: Dictionary #### Return Type Document ## ExecuteTemplate2 Executes a Template and returns the Document result. #### Syntax ``` ExecuteTemplate2 ( TemplateId [, TemplateDocument] [, ParentId] [, ParentDocument] [, Language] [, OfficeId] [, ApplicationId] [, LinkPath] [, InstanceId] [, Parameters] ) ``` #### Parameters **TemplateId**\ The ID of the Template to execute.\ Type: Guid ***TemplateDocument*** (optional)\ The document to use (instead of the document of the Template with the given ID).\ Type: Document ***ParentId*** (optional)\ The ID of the Parent Template to use if no parent is defined.\ Type: Guid ***ParentDocument** (optional)*\ The parent document to use (instead of the document of the Template parent or the Parent with the given ID).\ Type: Document ***Language*** (optional)\ Not used: The Language of the Template.\ Type: Language ***OfficeId*** (optional)\ The ID of the Office to execute the Template in (used for the Instance).\ Type: Guid ***ApplicationId*** (optional)\ The ID of the Application to execute the Template in (used for the Instance).\ Type: Guid ***LinkPath*** (optional)\ The Link Path of the Instance to execute the Template with.\ Type: LinkPath ***InstanceId*** (optional)\ The ID of the Instance to execute the Template with.\ Type: Any ***Parameters*** (optional)\ The required Parameters of the Template.\ Type: Dictionary\ #### Return Type Document ## FinalizeDocument Finalize the document #### Syntax ``` FinalizeDocument ( Object [, FinalizedOn] [, FinalizedBy] ) ``` #### Parameters ***Object***\ Object which document will be finalized.\ Type: Object ***FinalizedOn*** (optional)\ Time when the document is finalized. Optional parameter: if not set the current time will be taken.\ Type: DateTime ***FinalizedBy*** (optional)\ The parameter specifies who is finalizing document. Optional parameter: if not set the current user will be taken.\ Type: String #### Return Type Void ## GetActionValue Returns a property value of an Action. #### Syntax ``` GetActionValue ( OfficeId , ApplicationId , ClassId , ActionKey , ActionPropertyName ) ``` #### Parameters ***OfficeId***\ The ID of the Office that contains the Action.\ Type: Guid ***ApplicationId***\ The ID of the Application that contains the Action.\ Type: Guid ***ClassId***\ The ID of the Class that contains the Action.\ Type: Guid ***ActionKey***\ The Key of the Action.\ Type: String ***ActionPropertyName***\ The Name of the Property to get the value from.\ Type: String #### Return Type Object ## GetApplicationIdByKey Gets the Application ID installed in the Office identified by the Key. #### Syntax ``` GetApplicationIdByKey ( [OfficeId] , Key ) ``` #### Parameters ***OfficeId*** (optional)\ The ID of the Office where the Application is installed.\ Type: Guid ***Key***\ The Key of the Application (or its Parent Application).\ Type: String #### Return Type Guid ## GetBosLoginValue Gets the value of a Source Login identified by the Source Key and Key of the value. #### Syntax ``` GetBosLoginValue ( BosKey , Key [, OfficeId] [, ApplicationId] ) ``` #### Parameters ***BosKey***\ The Key of the Source.\ Type: String ***Key***\ The Key of the Login value.\ Type: String ***OfficeId*** (optional)\ The ID of the Office for which the Login were created.\ Type: Guid ***ApplicationId*** (optional)\ The ID of the Application for which the Login were created.\ Type: Guid #### Return Type Object ## GetClassFields Returns fields of a class. Each field contains the following fields (which can be accessed through GetValue): Id (Guid), Key (String), InternalKey (String), Name (String), Description (String), Info (String), DataType (String), ControlType (String), IsIdentity (Boolean), IsNullable (Boolean), IsReadOnly (Boolean), IsRequired (Boolean), Length (Integer), IsVirtual (Boolean), IsMultilanguage (Boolean), DataSourceClassId (Guid), DataSourceSelectionId (Guid), DataSourceFieldId (Guid), DataSourceNameFieldId (Guid), DataSourceOption (String). #### Syntax ``` GetClassFields ( ClassID ) ``` #### Parameters **ClassId**\ The class to get the fields from.\ Type: Guid #### Return type Guid ## GetClassId Gets the ID of a Class identified Key (Model Name). #### Syntax ``` GetClassId ( OfficeId , ApplicationId , ModelName ) ``` #### Parameters ***OfficeId***\ This ID identifies the Workspace / Office which the instances are associated with.\ Type: Guid ***ApplicationId***\ This ID identifies the Application which the instances are associated with.\ Type: Guid ***ModelName***\ The Key of the Class (Model Name).\ Type: String #### Return Type Guid ## GetClassValue Gets a property value of a Class associated with a given Object. #### Syntax ``` GetClassValue ( Object , ClassFieldName ) ``` #### Parameters ***Object***\ The Object with the associated Class.\ Type: Object ***ClassFieldName***\ The Name of the Property to get.\ Type: String #### Return Type Object ## GetClassValue Gets a property value of a Class identified by ID of the Class and name of the property. #### Syntax ``` GetClassValue ( OfficeId , ApplicationId , ClassId , ClassFieldName ) ``` #### Parameters ***OfficeId***\ The ID of the Office that contains the Class.\ Type: Guid ***ApplicationId***\ The ID of the Application that contains the Class.\ Type: Guid ***ClassId***\ The ID of the Class to get the value from.\ Type: Guid ***ClassFieldName***\ The Name of the Property to get.\ Type: String #### Return Type Any ## GetCurrentInstance Gets the Object of the current context (e.g. for Instance Workflow). #### Syntax ``` GetCurrentInstance ( ) ``` #### Parameters No parameters #### Return Type Object ## GetCurrentInstances2 Gets the Objects of the current context. If the current list is filtered only filtered Objects are returned. If the current list is bulk editing mode only selected Objects are returned. #### Syntax ``` GetCurrentInstances2 ( Pagination ) ``` #### Parameters **Pagination** \ The pagination to use when getting the Objects.\ Type: Pagination #### Return Type Page \ ## GetCurrentUser Returns the current user executing the script as an object. #### Syntax ``` GetCurrentUser ( [OfficeId] ) ``` #### Parameters ***OfficeId*** (optional)\ This ID identifies the Workspace / Office which the user is working on when the code is executed.\ Type: Guid #### Return Type Object ## GetCurrentUserLanguage Returns the language of the current user executing the script. #### Syntax ``` GetCurrentUserLanguage ( [OfficeId] ) ``` #### Parameters ***OfficeId*** (optional)\ This ID identifies the Workspace / Office which the user is working on when the code is executed.\ \&#xNAN;*Type: Guid* #### Return Type Language ## GetDocument Gets the Document from a given Object. #### Syntax ``` GetDocument ( Object ) ``` #### Parameters ***Object***\ The Object to get Document from.\ Type: Object #### Return Type Document ## GetDocumentAsBase64String Gets the content of a document and returns Base64 encoded String #### Syntax ``` GetDocumentAsBase64String ( Document ) ``` #### Parameters **Document**\ The Document to get the content from.\ Type: Document #### Return Type String ## GetDocumentAsString Gets the Document XML content as a String. #### Syntax ``` GetDocumentAsString ( Document , EncodingCodePage ) ``` #### Parameters **Document**\ The Document to get the content from.\ Type: Document **EncodingCodePage**\ The Encoding of the Document.\ Type: Int #### Return Type String ## GetDocumentText Gets the text of a Word or PDF document. #### Syntax ``` GetDocumentText ( Document [, Format] ) ``` #### Parameters ***Document***\ The Document to get the text from.\ Type: Document **Format as String (optional):**\ The format of the document: Doc, Docx, Pdf. Analyses the given document if format is omitted. #### Return Type String ## GetDocumentDates Gets the creation and modification dates of a document. The dates are retrieved from the document-specific metadata (not through filesystem-specific metadata). #### Syntax ``` GetDocumentDates ( Source [, SourceFormat] ) ``` #### Parameters **Source**\ The source document to get the dates from..\ Type: Document ***SourceFormat*** (optional)\ The source format of the document. Analyses the given document if format is omitted.\ Type: String #### Return type Dictionary\ ## GetDocumentText Gets the text of a Word or PDF document. #### Syntax ``` GetDocumentText ( Document [, Format ] ) ``` #### Parameters **Document**\ The Document to get the content from.\ Type: Document ***Format*** (optional)\ The format of the document. Analyses the given document, if format is omitted.\ Type: String #### Return type String ## GetDocumentValue Gets a Document property value from a given Document. #### Syntax ``` GetDocumentValue ( Document , PropertyName ) ``` #### Parameters ***Document***\ The Document to get the property value from.\ Type: Document ***PropertyName***\ The Name of the Property value to get.\ Type: String #### Return Type Object ## GetDocumentAsByteArray Gets the Document content as a ByteArray. #### Syntax ``` ByteArray GetDocumentAsByteArray( Document Document ) ``` #### Parameters ***Document*** \ The Document to get the content from. \ Type: Document #### Return Type ByteArray ## GetEntry Takes a Dictionary and returns the value identified by a specified Key or NULL if no value exists. #### Syntax ``` GetEntry ( Dictionary , Key ) ``` #### Parameters ***Dictionary***\ The dictionary of which the entry is read.\ Type: Dictionary\ ***Key***\ The name of the field.\ Type: Any #### Return Type Any ## GetFieldName Gets field key by fieldId and classId from list of classIds, forInstance (without ModelName) and forValue (without \_\_RESOLVED). #### Syntax ``` GetFieldName ( FieldId , ClassIdList [, OfficeId] [, ApplicationId] [, ForInstance] [, ForValue] ) ``` #### Parameters ***FieldId***\ The ID of the Field to get the Name from.\ Type: Guid ***ClassIdList***\ A list of Class IDs with the Field.\ Type: List\ ***OfficeId*** (optional)\ The ID of the Office that contains the Field.\ Type: Guid ***ApplicationId*** (optional)\ The ID of the Application that contains the Field.\ Type: Guid ***ForInstance*** (optional)\ When value True is, should be got FieldName without ModelName.\ Type: Boolean ***ForValue*** (optional)\ When 'ForValue' true is, should be got value without \_\_RESOLVED construct.\ Type: Boolean #### Return Type String ## GetFieldNames Gets a list of Field Names associated with a given Object. #### Syntax ``` GetFieldNames ( Object ) ``` #### Parameters ***Object***\ The Object to get the Field Names from.\ Type: Object #### Return Type List\ ## GetFieldValue Gets the property value of a Field. #### Syntax ``` GetFieldValue ( OfficeId , ApplicationId , ClassId , FieldName , PropertyName ) ``` #### Parameters ***OfficeId***\ The ID of the Office that contains the Field.\ Type: Guid ***ApplicationId***\ The ID of the Application that contains the Field.\ Type: Guid ***ClassId***\ The ID of the Class that contains the Field.\ Type: Guid ***FieldName***\ The Key of the Field to get the property value from.\ Type: String ***PropertyName***\ The Name of the Property\ Type: String #### Return Type Any ## GetGroupRoles Returns roles for a group. Each role contains the 'Id' and 'Name' (which can be accessed through GetValue). ``` List GetGroupRoles(Guid GroupId) ``` **Parameters** * **GroupId**\ The group to filter the roles.\ Type: Guid **Return Type** List\ ## GetGroupUsers Returns users for a group. Each user contains the 'Id' and 'Name' (which can be accessed through GetValue). ``` List GetGroupUsers(Guid GroupId) ``` **Parameters** * **GroupId**\ The group to filter the users.\ Type: Guid **Return Type** List\ ## GetHtml Gets the content of a given Document as HTML. #### Syntax ``` GetHtml ( Document ) ``` #### Parameters ***Document***\ The Document to get the HTML from.\ Type: Document #### Return Type String ## GetInstance Takes OfficeId, ApplicationId, ClassId, InstanceId and LinkPath as input and returns the object identified by the InstanceId. #### Syntax ``` GetInstance ( OfficeId , ApplicationId , ClassId [, LinkPath] , InstanceId ) ``` #### Parameters ***OfficeId***\ This ID identifies the Workspace / Office which the instance is associated with.\ Type: Guid ***ApplicationId***\ This ID identifies the Application which the instance is associated with.\ Type: Guid ***ClassId***\ This ID identifies the Class of the instance.\ Type: Guid ***LinkPath*** (optional)\ Navigation path to the object.\ Type: LinkPath ***InstanceId***\ The ID of the specific instance.\ Type: Any #### Return Type Object ## GetInstances Takes OfficeId, ApplicationId, ClassId and LinkPath as input and returns a list of Objects of the given class. #### Syntax ``` GetInstances ( OfficeId , ApplicationId , ClassId [, LinkPath] ) ``` #### Parameters ***OfficeId***\ This ID identifies the Workspace / Office which the instances are associated with.\ Type: Guid ***ApplicationId***\ This ID identifies the Application which the instances are associated with.\ Type: Guid ***ClassId***\ This ID identifies the Class of the instances.\ Type: Guid ***LinkPath*** (optional)\ Navigation path to the object.\ Type: LinkPath #### Return Type List\ ## GetKeys Gets the Keys of a given Dictionary. #### Syntax ``` GetKeys ( Dictionary ) ``` #### Parameters ***Dictionary***\ The Dictionary to get the Keys from.\ Type: Dictionary\ #### Return Type List\ ## GetLanguage Takes an ID of a language as input and returns the language of that specific instance. #### Syntax ``` GetLanguage ( InstanceId ) ``` #### Parameters ***InstanceId***\ The ID of the language to get (e. g. LanguageId field of user instance).\ Type: Guid #### Return Type Language ## GetLinkedInstances Takes an Object and a LinkId as input and returns a list of all Objects which are linked to that instance. In case of a N:M relation, the function can return the lookup table or the target class. If "target=false" the N:M class is returned. If "target=true", the target class is returned. #### Syntax ``` GetLinkedInstances ( Object , LinkId [, Target] ) ``` #### Parameters ***Object***\ The object for which the linked instances will be loaded.\ Type: Object ***LinkId***\ The ID of the Link which has been specified in the Class Designer.\ Type: Guid ***Target*** (optional)\ In case of a N:M relation, the function can return the lookup table or the target class. If target=false the N:M class is returned. If target=true, the target class is returned.\ Type: Boolean #### Return Type List\ ## GetLinkId Gets the ID of a Link between a given Object and a target Class identified by a Name. #### Syntax ``` GetLinkId ( Object , ClassName , Direction [, NmClassName] ) ``` #### Parameters ***Object***\ The source Object of the Link.\ Type: Object ***ClassName***\ The Name of the target Class of the Link.\ Type: String ***Direction***\ The Direction of the Link ('None', 'Parents', 'Children').\ Type: String ***NmClassName*** (optional)\ The Name of the NM Class of the Link.\ Type: String #### Return Type Guid ## GetLinkPath Gets the Link Path of a given Object. #### Syntax ``` GetLinkPath ( Object ) ``` #### Parameters ***Object***\ The Object to get the Link Path from.\ Type: Object #### Return Type LinkPath ## GetMainInstance Gets the Main Instance by using a given Link Path. #### Syntax ``` GetMainInstance ( OfficeId , ApplicationId , LinkPath ) ``` #### Parameters ***OfficeId***\ The ID of the Office of the the Main Instance.\ Type: Guid ***ApplicationId***\ The ID of the Application of the Main Instance.\ Type: Guid ***LinkPath***\ The Link Path to use to get the Main Instance.\ Type: LinkPath #### Return Type Object ## GetOfficeGroups Returns groups for an office. Each group contains the 'Id' and 'Name' (which can be accessed through GetValue). #### Syntax ``` GetOfficeGroups( [OfficeId] ) ``` #### Parameters ***OfficeId** (optional)*\ The office to filter the groups (the current office if left empty).\ Type: Guid #### Return Type List\ ## GetOfficeLicenses Returns licenses an office has access to. #### Syntax ``` GetOfficeLicenses( [OfficeId] ) ``` #### Parameters ***OfficeId*** (optional)\ The office to filter the users (the current office if left empty).\ Type: Guid #### Return Type List\ ## GetOfficeUsers Returns users for an office. Each user contains the 'Id' and 'Name' (which can be accessed through GetValue). #### Syntax ``` GetOfficeUsers ( [OfficeId] ) ``` #### Parameters ***OfficeId*** (optional)\ The office to filter the users (the current office if left empty).\ Type: Guid #### Return Type List\ ## GetOldInstance Gets the old Object available in a triggered Workflow (Delete or Update). #### Syntax ``` GetOldInstance ( ) ``` #### Parameters No parameters #### Return Type Object ## GetRoleChildRoles Returns child roles for a role. Each role contains the 'Id' and 'Name' (which can be accessed through GetValue). #### Syntax ``` List GetRoleChildRoles( Guid RoleId, Guid [ApplicationId] ) ``` #### **Parameters** ***RoleId***\ The role to filter the roles.\ Type: Guid ***ApplicationId** (optional)*\ The application to filter the roles (current app if left empty).\ Type: Guid #### Return Type List\ ## GetRoleParentRoles Returns parent roles for a role. Each role contains the 'Id' and 'Name' (which can be accessed through GetValue). #### Syntax ``` List GetRoleParentRoles( Guid RoleId, Guid [ApplicationId] ) ``` #### Parameters ***RoleId***\ The role to filter the roles.\ Type: Guid ***ApplicationId** (optional)*\ The application to filter the roles (current app if left empty).\ Type: Guid #### Return Type List\ ## GetRoleUsers Returns users for a role. Each user contains the 'Id' and 'Name' (which can be accessed through GetValue). #### Syntax ``` List GetRoleUsers( Guid RoleId, Guid [AppId] ) ``` #### Parameters ***RoleId***\ The role to filter the users.\ Type: Guid ***AppId** (optional)*\ The app to filter the users (current app if left empty).\ Type: Guid #### Return Type List\ ## GetTargetClassId Gets the ID of the target Class of a Link. #### Syntax ``` GetTargetClassId ( Object , LinkId [, Target] ) ``` #### Parameters ***Object***\ The source Object of the Link.\ Type: Object ***LinkId***\ The ID of the Link to get the target Class from.\ Type: Guid ***Target*** (optional)\ Defines whether to get the Target or the NM Class (if a NM Link has been chosen).\ Type: Boolean #### Return Type Guid ## GetTemplates Returns all Templates of the Office and Application (each instances has a Id, Key, Name, ClassId and Type). #### Syntax ``` GetTemplates ( [OfficeId] [, ApplicationId] ) ``` #### Parameters ***OfficeId*** (optional)\ This ID identifies the Workspace / Office which the templates are associated with.\ Type: Guid ***ApplicationId*** (optional)\ This ID identifies the Application which the templates are associated with.\ Type: Guid #### Return Type List\ ## GetTemplatesByClassId Returns all Templates of the Office and Application (each instances has a Id, Key, Name, ClassId and Type) executable for a Class. #### Syntax ``` GetTemplatesByClassId ( [OfficeId] [, ApplicationId] , ClassId ) ``` #### Parameters ***OfficeId*** (optional)\ This ID identifies the Workspace / Office which the templates are associated with.\ Type: Guid ***ApplicationId*** (optional)\ This ID identifies the Application which the templates are associated with.\ Type: Guid ***ClassId***\ This ID identifies the Class for which the Templates must be executable (includes abstract Classes).\ Type: Guid #### Return Type List\ ## GetUser Takes an OfficeId, and an InstanceId as input and returns the corresponding user object. #### Syntax ``` GetUser ( OfficeId , InstanceId ) ``` #### Parameters **OfficeId**\ The ID of the office the user is associated with.\ Type: Guid **InstanceId**\ This ID which identifies the user.\ Type: Guid #### Return Type Object ## GetUser2 Takes an OfficeId, and an propertyName, and value as input and returns the corresponding user object. #### Syntax ``` GetUser2 ( OfficeId , PropertyName , Value ) ``` #### Parameters **OfficeId**\ The ID of the Office to get the User from.\ Type: Guid **PropertyName**\ The Property Name to identify the User.\ Type: String **Value**\ The Value to identify the User.\ Type: String #### Return Type Object ## GetUserFeatures Returns features a user has access to. Each feature contains the 'Id' and 'Name' (which can be accessed through [GetValue](#getvalue)). #### Syntax ``` List GetUserFeatures( Guid [UserId], Guid [OfficeId] ) ``` #### Parameters ***UserId** (optional)*\ The user to filter the features (the current user if left empty).\ Type: Guid ***OfficeId** (optional)*\ The office to filter the features (the current office if left empty).\ Type: Guid #### Return type List\ ## GetUserGroups Returns groups for an user. Each group contains the 'Id' and 'Name' (which can be accessed through GetValue). #### Syntax ``` List GetUserGroups( Guid [UserId], Guid [OfficeId] ) ``` #### Parameters ***UserId** (optional)*\ The user to filter the groups (the current user if left empty).\ Type: Guid ***OfficeId** (optional)*\ The office to filter the groups (the current office if left empty).\ Type: Guid #### Return Type List\ ## GetUserRoles Returns roles for an user. Each role contains the 'Id' and 'Name' (which can be accessed through GetValue). #### Syntax ``` List GetUserRoles( Guid [UserId], Guid [AppId] ) ``` **Parameters** ***UserId** (optional)*\ The user to filter the roles (the current user if left empty).\ Type: Guid ***AppId** (optional)*\ The app to filter the roles (the current app if left empty).\ Type: Guid **Return Type** List\ ## GetValue Return the value of the given Field of an Object. #### Syntax ``` GetValue ( Object , Field ) ``` #### Parameters ***Object***\ The object which contains the value.\ Type: Object ***Field***\ The name of the field which identifies the value.\ Type: String #### Return Type Any ## GetValues Returns the values of the given fields of an object separated by a given String. #### Syntax ``` GetValues ( Object , FieldNameList , Separator ) ``` #### Parameters ***Object***\ The Object to get the Field Values from.\ Type: Object ***FieldNameList***\ A list of Field Names to get the values from.\ Type: List\ ***Separator***\ The Separator of the values.\ Type: String #### Return Type List\ ## HasEntry Checks whether the given Dictionary has an entry identified by a key. #### Syntax ``` HasEntry ( Dictionary , Key ) ``` #### Parameters **Dictionary**\ The dictionary to check whether an entry identified by a key exists.\ Type: Dictionary\ **Key**\ The key to identify the entry.\ Type: Any #### Return Type Boolean ## IdentityTable Increases an Identity value and returns the result. #### Syntax ``` IdentityTable ( OfficeId , ApplicationId [, LinkPath] , SelectionId [, Parameters] , Field ) ``` #### Parameters ***OfficeId***\ The ID of the Office where the Identity Table can be accessed.\ Type: Guid ***ApplicationId***\ The ID of the Application where the Identity Table can be accessed.\ Type: Guid ***LinkPath*** (optional)\ Navigation path to the object. Optional and can be null.\ Type: LinkPath ***SelectionId***\ The ID of the Selection which is used to get an Identity Object.\ Type: Guid ***Parameters*** (optional)\ The Parameters of the Selection.\ Type: Dictionary\ ***Field***\ The Key of the Field where the Identity value is stored.\ Type: String #### Return Type Int ## Input Represents a request for input. #### Syntax ``` Input ( Name , Order , Key , Description , DataType , DefaultValue [, DataSourceClassId] [, DataSourceController] , DataSourceOption [, DataSourceFieldId] , ControlType [, Length] ) ``` #### Parameters ***Name***\ Name which will be displayed.\ Type: String ***Order***\ Order Element\ Type: Int ***Key***\ The key which is used as internal reference.\ Type: String ***Description***\ Description of the Input.\ Type: String ***DataType***\ The Data type of the Input\ Type: String ***DefaultValue***\ Default\ Type: String ***DataSourceClassId*** (optional)\ Specifies the class of the input.\ Type: Guid ***DataSourceController*** (optional)\ Specifies the controller of the input.\ Type: Guid ***DataSourceOption***\ Represent predefined choices.\ Type: String ***DataSourceFieldId*** (optional)\ The ID of the Field for the a Data Source (must be set with DataSourceClassId).\ Type: Guid ***ControlType***\ The Type of the Control to display to get the Input.\ Type: String ***Length*** (optional)\ The maximum Length of the Input.\ Type: Int #### Return Type Exit ## Inputs Represents a request for multiple inputs. #### Syntax ``` Inputs ( [Name] [, Description] , Parameters [, Validate] ) ``` #### Parameters ***Name*** (optional)\ The Name of the Input request (will be displayed to the User).\ Type: String ***Description*** (optional)\ The Description of the Input request (will be displayed to the User).\ Type: String **Parameters**\ The Parameters to request.\ Type: List\ ***Validate*** (optional)\ A validation callback that validates the given input. \ Type: Dictionary\ #### Return Type Exit ## Layout Represents a Field for a Selection. #### Syntax ``` Layout ( FieldId , SortType [, Title] ) ``` #### Parameters ***FieldId***\ The ID of the Field.\ Type: Guid ***SortType***\ The sorting direction for the Field ('None', 'Ascending', 'Descending').\ Type: String ***Title*** (optional)\ The alias used for the Field.\ Type: String #### Return Type Layout ## LinkInstances Link a main-instance (target) to another main-instance (source). The created link not saved! Make sure to execute save on source instance. #### Syntax ``` LinkInstances ( SourceInstance , TargetInstance , LinkServiceType ) ``` #### Parameters ***SourceInstance***\ the source instance\ Type: Object ***TargetInstance***\ the target instance\ Type: Object ***LinkServiceType***\ type of the link\ Type: Guid #### Return Type Any ## List Creates an empty list. #### Syntax ``` List ( [Items] ) ``` #### Parameters ***Items*** (optional)\ The initial Items for the list.\ Type: Any #### Return Type List\ ## LoadNew Loads a given Object new. #### Syntax ``` LoadNew ( Object [, LayoutId] ) ``` #### Parameters ***Object***\ The Object to load new.\ Type: Any ***LayoutId*** (optional)\ The ID of the Layout for the newly loaded Object.\ Type: Guid #### Return Type Exit ## Message Displays a Message to the User. #### Syntax ``` Message ( Message ) ``` #### Parameters ***Message***\ The Message to display.\ Type: String #### Return Type Exit ## MultiSelectDefaultValue Builds the MultiSelect default value. This should be used with the DefaultValue of a Parameter. #### Syntax ``` MultiSelectDefaultValue (Values) ``` #### Parameters **Values**\ The values to use as a default value.\ Type: List\ #### Return type String ## MultiSelectOptions Builds the MultiSelect options. This should be used with the Options of a Parameter. #### Syntax ``` MultiSelectOptions ( [Columns] [, UseDropdownAfter] ) ``` #### Parameters ***Columns*** (optional)\ The Columns count for the MultiSelect Input.\ Type: Int ***UseDropdownAfter*** (optional)\ If the number of items within a column is greater than the provided value, the control will be displayed as a dropdown. If not provided, the control will never display as a dropdown.\ Type: Int #### Return type Options ## ObjectDefaultValue Builds the Object default value. This should be used with the DefaultValue of a Parameter. #### Syntax ``` String ObjectDefaultValue( Dictionary Object ) ``` #### Parameters ***Object***\ The object data to use as a default value.\ *Type: Dictionary\* **Return Type**\ String ## ObjectOptions Builds the Object options. This should be used with the Options of a Parameter. #### Syntax ``` Options ObjectOptions( List Fields ) ``` #### Parameters ***Fields***\ The fields configuration to edit the object.\ *Type: List\* **Return Type**\ Options ## Open Opens a given Object. #### Syntax ``` Open ( Object [, LayoutId] ) ``` #### Parameters ***Object***\ The Object to open.\ Type: Object ***LayoutId*** (optional)\ The ID of the Layout to open the Object with.\ Type: Guid #### Return Type Exit ## PackZip Packs Documents in a ZIP archive and returns the result as a Document. #### Syntax ``` PackZip ( Name , Entries ) ``` #### Parameters ***Name***\ The Name of the archive.\ Type: String ***Entries***\ The Documents to zip; a Dictionary where the Key is the path in the archive.\ Type: Dictionary\ #### Return Type Document ## Pagination Represents a pagination to use when getting Objects. #### Syntax ``` Pagination ( Take ) ``` #### Parameters **Take**\ The amount of Objects to take.\ Type: Int #### Return Type Pagination ## Parameter Represents a Parameter to request as an Input (used with Inputs). #### Syntax ``` Parameter ( Key , DataType , Name [, Description] [, IsRequired] [, DefaultValue] [, DataSourceClassId] [, DataSourceFieldId] [, DataSourceControllerId] [, DataSourceOption] [, DataSourceSelectionId] [, DataSourceSelectionKeyFieldId] [, DataSourceSelectionNameFieldId] [, DataSourceSelectionParameters] [, ControlType] [, Length] [, Options] ) ``` #### Parameters **Key**\ The Key of the Input (identifies the value after the request).\ Type: String **DataType**\ The Type of the Data to request.\ Type: String **Name**\ The Name of the Input to display.\ Type: String ***Description*** (optional)\ The Description of the Input to display.\ Type: String ***IsRequired*** (optional)\ Defines whether the User has to Input a value.\ Type: Boolean ***DefaultValue*** (optional)\ The Default Value of the Input.\ Type: String ***DataSourceClassId*** (optional)\ The ID of the Class to choose a value from.\ Type: Guid ***DataSourceFieldId*** (optional)\ The ID of the Field to choose a value from (in combination with DataSourceClassId).\ Type: Guid ***DataSourceControllerId*** (optional)\ The ID of the Controller used to choose a value from.\ Type: Guid ***DataSourceOption*** (optional)\ A String representation of a list to choose a value from.\ Type: String ***DataSourceSelectionId*** (optional)\ The ID of the Selection used to choose a value from.\ Type: Guid ***DataSourceSelectionKeyFieldId*** (optional)\ The ID of the field to identify a value (in combination with DataSourceSelectionId).\ Type: Guid ***DataSourceSelectionNameFieldId*** (optional)\ The ID of the field to display a value (in combination with DataSourceSelectionId).\ Type: Guid ***DataSourceSelectionParameters*** (optional)\ The parameters to use for the Selection as default values.\ Type: Dictionary\ ***ControlType*** (optional)\ The Type of Control to display (TextBox, ComboBox, Label, EditComboBox, AddComboBox, MultiSelect, CheckBox, Calendar, DatePicker, TimePicker, Password, TextArea, Email, Phone, Adress, Slider, Upload, UploadMultiple, Url, HtmlEditor, MarkdownEditor, Table, Object).\ Type: String ***Length*** (optional)\ The maximum Length of the Input.\ Type: Int ***Options*** (optional)\ Additional configuration for this parameter\ Type: Options #### Return Type Parameter ## Parameter2 Represents a Parameter to request as an Input with dynamic keys (used with Inputs). #### Syntax ``` Parameter Parameter2( String Key, String DataType, String Name, String [Description], Boolean [IsRequired], String [DefaultValue], Guid [DataSourceClassId], Guid [DataSourceFieldId], Guid [DataSourceControllerId], String [DataSourceOption], Guid [DataSourceSelectionId], Guid [DataSourceSelectionKeyFieldId], Guid [DataSourceSelectionNameFieldId], Dictionary [DataSourceSelectionParameters], String [ControlType], Int [Length], Options [Options] ) ``` **Parameters** **Key** \ The Key of the Input (identifies the value after the request). \ \&#xNAN;*Type: String* **DataType**\ The Type of the Data to request (String, Boolean, File, Integer, DateTime, Date, Time).\ \&#xNAN;*Type: String* **Name**\ The Name of the Input to display.\ \&#xNAN;*Type: String* ***Description*** (optional)\ The Description of the Input to display.\ \&#xNAN;*Type: String* ***IsRequired*** (optional)\ Defines whether the User has to Input a value.\ \&#xNAN;*Type: Boolean* ***DefaultValue*** (optional)\ The Default Value of the Input.\ \&#xNAN;*Type: String* ***DataSourceClassId*** (optional)\ The ID of the Class to choose a value from.\ \&#xNAN;*Type: Guid* ***DataSourceFieldId*** (optional)\ The ID of the Field to choose a value from (in combination with DataSourceClassId).\ \&#xNAN;*Type: Guid* ***DataSourceControllerId*** (optional)\ The ID of the Controller used to choose a value from.\ \&#xNAN;*Type: Guid* ***DataSourceOption*** (optional)\ A String representation of a list to choose a value from.\ \&#xNAN;*Type: String* ***DataSourceSelectionId*** (optional)\ The ID of the Selection used to choose a value from.\ Type: Guid ***DataSourceSelectionKeyFieldId*** (optional)\ The ID of the field to identify a value (in combination with DataSourceSelectionId).\ Type: Guid ***DataSourceSelectionNameFieldId*** (optional)\ The ID of the field to display a value (in combination with DataSourceSelectionId).\ Type: Guid ***DataSourceSelectionParameters*** (optional)\ The parameters to use for the Selection as default values.\ Type: Dictionary\ ***ControlType*** (optional)\ The Type of Control to display (TextBox, ComboBox, Label, EditComboBox, AddComboBox, MultiSelect, CheckBox, Calendar, DatePicker, TimePicker, Password, TextArea, Table, Email, Phone, Adress, Slider, Upload, UploadMultiple, Url, HtmlEditor, MarkdownEditor, Object).\ \&#xNAN;*Type: String* ***Length*** (optional)\ The maximum Length of the Input.\ \&#xNAN;*Type: Int* ***Options** (optional)*\ Additional configuration for this parameter\ \&#xNAN;*Type: Options* **Return Type** Parameter ## ReduceLinkPath Reduces the LinkPath by one step. #### Syntax ``` ReduceLinkPath ( LinkPath ) ``` #### Parameters ***LinkPath***\ The link which is to be reduced.\ Type: LinkPath #### Return Type LinkPath ## Refresh Refreshes a given Object. #### Syntax ``` Refresh ( Object [, LayoutId] ) ``` #### Parameters ***Object***\ The Object to refresh.\ Type: Object ***LayoutId*** (optional)\ The ID of the Layout to refresh the Object with.\ Type: Guid #### Return Type Exit ## Reload Reloads a given Object #### Syntax ``` Reload ( Object [, LayoutId] ) ``` #### Parameters ***Object***\ The Object to reload.\ Type: Object ***LayoutId*** (optional)\ The ID of the Layout to reload the Object with.\ Type: Guid #### Return Type Exit ## RemoveUserFromLicense Removes a user from a license or license item. Throws an error if the license or license item does not support user assignments. #### Syntax ``` RemoveUserFromLicense ( LicenseId [, ItemId] , OfficeId, UserId ) ``` #### Parameters **LicenseId**\ The ID of the license the user should get removed from.\ Type: Guid ***ItemId*** (optional)\ The ID of the license item the user should get removed from.\ Type: Guid **OfficeId**\ The office to filter the features (the current office if left empty).\ Type: Guid **UserId**\ The ID of the user to remove assign the license from.\ Type: Guid #### Return Type Void ## RunSelection Runs a selection in a specific office and application, identified by a SelectionId with certain Parameters and optional LinkPath. RunSelection returns a list of objects. #### Syntax ``` RunSelection ( OfficeId , ApplicationId , SelectionId , Parameters [, LinkPath] ) ``` #### Parameters ***OfficeId***\ The ID of the office the selection will be associated with.\ Type: Guid ***ApplicationId***\ The ID of the application the selection will be associated with.\ Type: Guid ***SelectionId***\ The ID of the selection which will be executed.\ Type: Guid ***Parameters***\ The parameters used for the selection.\ Type: Dictionary\ ***LinkPath*** (optional)\ Navigation path to the object.\ Type: LinkPath #### Return Type List\ ## RunSelection Executes a Selection and returns the result. #### Syntax ``` RunSelection ( Selection [, InstanceId] ) ``` #### Parameters ***Selection***\ The Selection to execute.\ Type: Selection ***InstanceId*** (optional)\ The ID of the Instance to use as a context for the Selection.\ Type: Any #### Return Type List\ ## SaveInstance Takes an object as an input and saves that instance to disk. #### Syntax ``` SaveInstance ( Object ) ``` #### Parameters ***Object***\ Object which will be saved to disk.\ Type: Object #### Return Type Void ## Selection Represents a Selection for later execution. #### Syntax ``` Selection ( [SourceId] [, LinkId] , Layouts , Conditions ) ``` #### Parameters ***SourceId*** (optional)\ The ID of the Source Class.\ Type: Guid ***LinkId*** (optional)\ The ID of the Link of a Context where to execute the Selection in.\ Type: Guid ***Layouts***\ The Fields to request when executing the Selection.\ Type: List\ ***Conditions***\ The Condition used to filter when executing the Selection.\ Type: List\ #### Return Type Selection ## SetEntry Sets a Value of an entry with the given Key of a Dictionary. #### Syntax ``` SetEntry ( Dictionary , Key [, Value] ) ``` #### Parameters ***Dictionary***\ The dictionary for which the entry is set.\ Type: Dictionary\ ***Key***\ The key for which the entry is set.\ Type: Any ***Value*** (optional)\ The value which is set.\ Type: Any #### Return Type Dictionary\ ## SetValue Changes the value of a Field in an Object. #### Syntax ``` SetValue ( Object , Field , Value ) ``` #### Parameters ***Object***\ Object which the value is set to.\ Type: Object ***Field***\ The name of the field to set.\ Type: String ***Value***\ Value which is set.\ Type: Any #### Return Type Void ## StatusFeedback Sends feedback on the status of the executing script to the user. Can be used for checking result of a condition, switch, providing result values and similar. #### Syntax ``` StatusFeedback ( Message [, Level] ) ``` #### Parameters **Message**\ The message to be shown to the user\ Type: String ***Level** (optional)*\ The level of the feedback: Debug, Loading, Info (default), Error\ Type: Any #### Return Type Void ## TableDefaultValue Builds the Table default value. This should be used with the DefaultValue of a Parameter. **Syntax** ``` String TableDefaultValue( List> Table ) ``` #### Parameters **Table**\ The table data to use as a default value.\ Type: List\> **Return Type**\ String ## TableOptions Builds the Table options. This should be used with the Options of a Parameter. **Syntax** ``` TableOptions ( Columns [, DisableAddingRows] [, DisableDeletingRows] [, DisableSortingRows ] ) ``` #### Parameters **Columns**\ The columns configuration to edit the table.\ Type: List\ ***DisableAddingRows*** (optional)\ The table configuration to restrict adding rows.\ Type: Boolean ***DisableDeletingRows*** (optional)\ The table configuration to restrict deleting rows.\ Type: Boolean ***DisableSortingRows*** (optional)\ The table configuration to restrict sorting rows.\ Type: Boolean **Return Type**\ Options ## UnpackZip Unpacks a given ZIP archive and returns the content as a Dictionary. #### Syntax ``` UnpackZip ( Archive ) ``` #### Parameters ***Archive***\ The Document to unpack.\ Type: Document #### Return Type Dictionary {% hint style="info" %} Combination of this UnpackZip action with [GetDocumentValue ](#getdocumentvalue)action (Document \, PropertyName *ModificationTime*, PropertyName *MimeType*) gives you the possibility to retrieve modification time and mime type of the individual zip files/content.. {% endhint %} ## UploadDocument Uploads a Document to a given Object. #### Syntax ``` UploadDocument ( Object , Document ) ``` #### Parameters ***Object***\ The Object to upload the Document to.\ Type: Object ***Document***\ The Document to upload.\ Type: Document #### Return Type Void ## Variable Provides a container with a name, which can be used to store and reference all kind of values and Objects. #### Syntax ``` Variable ( Name [, Expression] ) ``` #### Parameters ***Name***\ Name of the variable.\ Type: String ***Expression*** (optional)\ Value of the variable.\ Type: Any #### Return Type Any ## Variable2 Provides a container with a dynamic name, which can be used to store and reference all kind of values and Objects. #### Syntax ``` Any Variable2( String Name, Any [Expression] ) ``` **Parameters** * **Name**\ Name of the variable.\ Type String * **Expression** (optional)\ Value of the variable.\ Type Any **Return Type** Any --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.tivity.one/building-an-application/execution/scripting/functions/system-actions.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.