Reference
Description of the following Sharp objects:
Provides access to the details of a workflow item call stack element.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Returns the DataId of the CallStack item. | Int64 |
| Keyword | Returns the keyword that is used by the CallStack item. | String |
| PluginObjectGuid | Returns the ObjectGuid of the PlugIn the CallStack item references. | Guid |
| WorkflowObjectGuid | Returns the ObjectGuid of the Workflow the CallStack item references. | Guid |
Provides access to the details of a service catalog.
| P/M1) | Description | Type |
|---|---|---|
| Creator | Gets the creatoruser of the current service catalog. | CxUser |
| DataId | Gets the DataId of the current service catalog. | Int32 |
| Description | Gets the language-dependent description of the current service catalog. | String |
| FriendlyName | Gets the FriendlyName of the current service catalog. | String |
| IsDeleted | Returns True if the service catalog is deleted. | Boolean |
| Manager | Returns the manager user of the current service catalog. | CxUser |
| Name | Gets the language-dependent name of the current service catalog. | String |
| ObjectGuid | Gets the ObjectGUID of the current service catalog. | Guid |
| Owner | Gets the owneruser of the current service catalog. | CxUser |
| ServiceCatalogLifeCycle | Gets the life cycle of the current service catalog. | CxServicePortfolioLifeCycle |
| ServiceLifeCycle | Gets the service life cycle of the current service catalog. | CxServicePortfolioLifeCycle |
| ServiceTransactionLifeCycle | Gets the transaction life cycle of the current service catalog. | CxServicePortfolioLifeCycle |
| Status | Gets the status of the current service catalog. | CxServicePortfolioLifeCycleStatus |
| StatusReached | Gets the date when the current status was reached. | IsoDateTime |
Provides access to the details of a configuration item.
| P/M1) | Description | Type |
|---|---|---|
| AffectedPrincipals | Gets the affected users of the CI. | List<CxPrincipal> |
| Attachments | Gets the attached files of the CI (active attachments only). | List<CxFile> |
| Comments | Gets the comments of the current CI. | List<CxCiComment> |
| CreatedDateTime | Gets the CreationDate of the CI. | IsoDateTime |
| Creator | Gets the creatoruser of the CI. | CxPrincipal |
| DataId | Gets the DataId of the CI. | Int32 |
| Fields | Gets the attributes of the CI (case insensitive). | Dictionary<String, CxCiFieldValue> |
| Followers | Provides access to the list of users who follow the CI. | List<CxUser> |
| GeoCoordinates | Gets the geographical position of the CI. | CxCoordinates |
| IsDeleted | Gets the deleted-flag of the current CI. | Boolean |
| ObjectGuid | Gets the ObjectGUID of the CI. | Guid |
| OwnerGroup | Gets the ownergroup of the CI. | CxGroup |
| ParentCis | Gets the parent CIs of the CI. | List<CxCi> |
| RelatedCis | Gets the related CIs of the current CI. | List<CxCi> |
| Schema | Gets the schema of current CI. | CxCiSchema |
| Status | Gets the status of the current CI. | CxCiLifeCycleStatus |
| Supplier | Gets the supplier user of the CI. | CxPrincipal |
| Title | Gets the Title of the CI. | String |
| Type | Gets the type of the CI. | CxCmType |
| UniqueId | Gets the unique ID of the CI. | String |
| VisibleId | Gets the visible ID of the CI. | String |
| Zone | Gets the zone of the CI. | CxCiZone |
| Zones | Gets a list of zones of the CI. | List<CxCiZone> |
| GetFieldText(String name) | Returns the text of the specified field. If the field does not exist, NULL is returned. | String |
| GetFieldValue(String name) | Returns the value of the specified field. If the field does not exist, NULL is returned. | String |
| Url(String tab) | Gets the URL of the CI. Requires string parameter tabulator which may be empty. Currently known values for parameter are Details, AffectedPrincipals, UploadFiles, Fields, Relations, Tickets, Services, History, Comments and SLA. | Uri |
Returns the details of a single comment.
| P/M1) | Description | Type |
|---|---|---|
| CreateDateTime | Returns the creation time of the comment. | IsoDateTime |
| Text | Returns the text of the comment. | String |
| User | Returns the creator user of the comment. | CxUser |
Provides access to the details of a single CI field value.
| P/M1) | Description | Type |
|---|---|---|
| ObjectGuid | Gets the id of field value. | Guid |
| Text | Gets the field text including HTML tags. | String |
| Value | Gets the value of a field. | String |
| As<T>() | Converts the value of this property into an object of type T. Supported type: CxJson, CxCi, CxPrincipal and CxDateTime | T |
| AsList<T>() | Converts the value of this property into a list of objects of type T. Supported type: CxJson, CxCi, CxPrincipal and CxDateTime | List<T> |
Provides access to the details of a single life cycle.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Returns the DataId of life cycle. | Int32 |
| DefaultStatus | Returns the default status of the life cycle. | CxCiLifeCycleStatus |
| Description | Returns the description of the life cycle. | String |
| FriendlyName | Returns the FriendlyName of life cycle. | String |
| IsDeleted | Returns the deleted flag of the life cycle. | Boolean |
| Name | Returns the language-dependent name of current life cycle. | String |
| ObjectGuid | Returns the unique ID of life cycle. | Guid |
Provides access to the details of a single life cycle status.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Returns the DataId of life cycle status. | Int32 |
| FriendlyName | Returns the FriendlyName of life cycle status. | String |
| IconUrl | Returns the icon URL of the life cycle status. | String |
| ImportMappingId | Returns the import mapping ID of the life cycle status. | String |
| IsDeleted | Returns the deleted flag of the life cycle status. | Boolean |
| LifeCycle | Returns the life cycle of the life cycle status. | CxCiLifeCycle |
| Name | Returns the language-dependent name of current life cycle status. | String |
| ObjectGuid | Returns the unique ID of life cycle status. | Guid |
| P/M1) | Description | Type |
|---|---|---|
| DataId | Returns the DataId of CISchema. | Int32 |
| FriendlyName | Returns the FriendlyName of CISchema. | String |
| IconUrl | Returns the icon URL of current CISchema. | String |
| Name | Returns the language-dependent name of current CISchema. | String |
| ObjectGuid | Returns the unique ID of CISchema. | Guid |
| ParentSchema | Returns the parent schema of current CISchema. | CxCiSchema |
Provides access to the details of a configuration item zone.
| P/M1) | Description | Type |
|---|---|---|
| Attachments | Gets the attachments of the current CIZone (active attachments only). | List<CxFile> |
| DataId | Gets the DataId of the current CIZone. | Int32 |
| DefaultAffected | Gets the default affected principal of the current CIZone. | CxPrincipal |
| DefaultSupplier | Gets the default supplier principal of the current CIZone. | CxPrincipal |
| Description | Gets the language-dependent description of the current CIZone. | String |
| Fields | Gets the attributes of the CIZone (case insensitive). | Dictionary<String, CxCiZoneFieldValue> |
| FriendlyName | Gets the FriendlyName of the current CIZone. | String |
| IsDeleted | Gets the deleted flag of the current CIZone. | Boolean |
| Name | Gets the language-dependent name of the current CIZone. | String |
| ObjectGuid | Gets the unique ID of the current CIZone. | Guid |
| ParentZone | Gets the parent CIZone of the current CIZone. | CxCiZone |
| Schema | Gets the schema of the current CIZone. | CxCiSchema |
| Type | Gets the type of the current CIZone. | String |
| GetFieldText(String name) | Returns the text of the specified field. If the field does not exist, NULL is returned. | String |
| GetFieldValue(String name) | Returns the value of the specified field. If the field does not exist, NULL is returned. | String |
Provides access to the details of a single CI zone field value.
| P/M1) | Description | Type |
|---|---|---|
| ObjectGuid | Gets the id of CI zone field value. | Guid |
| Text | Gets the CI zone field text including HTML tags. | String |
| Value | Gets the value of a zone field. | String |
| As<T>() | Converts the value of this property into an object of type T. Supported type: CxJson, CxCi, CxPrincipal and CxDateTime | T |
| AsList<T>() | Converts the value of this property into a list of objects of type T. Supported type: CxJson, CxCi, CxPrincipal and CxDateTime | List<T> |
| P/M1) | Description | Type |
|---|---|---|
| Description | Returns the description of the clearing type. | String |
| Factor | Returns the factor of the clearing type. | Double |
| IsClearable | Returns whether the clearing type is clearable or not. | Boolean |
| Title | Returns the title of the clearing type. | String |
| P/M1) | Description | Type |
|---|---|---|
| FriendlyName | Returns the FriendlyName of CmType. | String |
| IconUrl | Returns icon URL of current CmType. | String |
| IsDeleted | Returns deleted flag of current CmType. | Boolean |
| Name | Returns the language-dependent name of current CmType. | String |
| ObjectGuid | Returns the unique ID of CmType. | Guid |
| ParentType | Returns the parent CmType if present. | CxCmType |
Provides access to the details of a single comment.
| P/M1) | Description | Type |
|---|---|---|
| CreateDateTime | Gets the creation time of the comment. | IsoDateTime |
| Text | Gets the comment text. | String |
| User | Gets the creator user of the comment. | CxUser |
Provides access to a single contract.
| P/M1) | Description | Type |
|---|---|---|
| Comments | Gets the comments of the current contract. | String |
| Customer | Gets the customer of the current contract. | String |
| Enddate | Gets the enddate of the current contract. | IsoDateTime |
| FriendlyName | Gets the FriendlyName of the current contract. | String |
| IsActive | Returns True, if the current contract is active. | Boolean |
| IsDeleted | Returns True, if the current contract is deleted. | Boolean |
| Name | Gets the language-dependent name of the current contract. | String |
| ObjectGuid | Gets the ObjectGUID of the current contract. | Guid |
| Provider | Gets the provider of the current contract. | String |
| Startdate | Gets the startdate of the current contract. | IsoDateTime |
Gets access to priority details.
| P/M1) | Description | Type |
|---|---|---|
| Description | Gets the description of the priority. | String |
| EscalationTimes | Gets all escalation times of the priority by FriendlyName (case insensitive). | Dictionary<String, CxEscalationTime> |
| FriendlyName | Gets the FriendlyName of the priority. | String |
| IsCritical | Returns True if the priority is critical. | Boolean |
| Name | Gets the name of the priority. | String |
| ObjectGuid | Gets the ObjectGUID of the priority. | Guid |
Provides access to a single contract service.
| P/M1) | Description | Type |
|---|---|---|
| Attachments | Gets the attachments of the current contract service (active attachments only). | List<CxFile> |
| Comments | Gets the comments of the current contract service. | String |
| ConsumerResponsibilities | Gets the consumer responsibilities of the current contract service. | String |
| Contract | Gets the contract of the current contract service. | CxContract |
| ContractTime | Gets the contract time of the current contract service. | CxContractTime |
| DefaultPriority | Gets the default priority of the current contract service. | CxContractPriority |
| Description | Gets the description of the current contract service. | String |
| FriendlyName | Gets the FriendlyName of the current contract service. | String |
| Isdeleted | Returns True, if the current contract service is deleted. | Boolean |
| Name | Gets the language-dependent name of the current contract service. | String |
| ObjectGuid | Gets the ObjectGUID of the current contract service. | Guid |
Provides access to the details of a single contract time.
| P/M1) | Description | Type |
|---|---|---|
| FriendlyName | Gets the FriendlyName of the current contract time. | String |
| IsDeleted | Returns True, if the current contract time is deleted. | Boolean |
| IsDynamicTimeZone | Returns True, if the current contract time is a dynamic timezone. | Boolean |
| Name | Gets the language-dependent name of the current contract time. | String |
| ObjectGuid | Gets the ObjectGUID of the current contract time. | Guid |
Gets details of geographical location.
| P/M1) | Description | Type |
|---|---|---|
| Latitude | Gets the latitude value in degrees. | Double |
| Longitude | Gets the longitude value in degrees. | Double |
Provides access to the details of a LVER costcenter.
| P/M1) | Description | Type |
|---|---|---|
| EnableTimeAccounts | Returns whether the time accounts are enabled. | Boolean |
| End | Gets the end time of the costcenter (validity). | IsoDateTime |
| Number | Returns the number of the cost center which was assigned in the project. | Int64 |
| ObjectGuid | Returns the ObjectGUID of the cost center. | Guid |
| Start | Gets the start time of the costcenter (validity). | IsoDateTime |
| Title | Gets the title of the costcenter for the current language. | String |
Provides the context to call a DataWorkflow, set parameters and get the result.
| P/M1) | Description | Type |
|---|---|---|
| Execute() | This call actually executes the workflow, and waits for the result. The returned object is a dictionary with multiple values, as a data workflow may have multiple return parameters. | Dictionary<String, String> |
| SetParameter(String name, String value) | This method can be called as many times as there are required input parameters. All parameters must be passed as strings. | CxDataWorkflow |
| UseWorkflow(Guid workflowObjectGuid) | The ObjectGuid of the workflow - find it out by using the workflow designer. | CxDataWorkflow |
| UseWorkflow(String workflowObjectGuid) | The ObjectGuid (string) of the workflow - find it out by using the workflow designer. | CxDataWorkflow |
| WithTimeout(Int32 seconds) | Timeout in seconds. This is the maximum number of seconds the context will wait for the data workflow result. | CxDataWorkflow |
| P/M1) | Description | Type |
|---|---|---|
| Date | Returns the Localized date time from a given utc date time string or a date time with utc offset information. | IsoDateTime |
| P/M1) | Description | Type |
|---|---|---|
| Execute(String ruleNameString parameterName) | Executes the dispatching rule for the parameter and returns the result depending on the configured dispatching. The rule and parameter will be selected through their name. | String |
| P/M1) | Description | Type |
|---|---|---|
| Rule | Returns the rule of the early warning alert. | CxEarlyWarnRule |
| Subscription | Returns the subscription of the early warning alert. | CxEarlyWarnSubscription |
| Tickets | Returns the tickets of the early warning alert. | List<CxTicket> |
| TriggerTicket | Returns the ticket which triggered the early warning alert. | CxTicket |
| P/M1) | Description | Type |
|---|---|---|
| FriendlyName | Returns the friendly name of the early warning rule. | String |
| Name | Returns the localized name of the early warning rule. | String |
| P/M1) | Description | Type |
|---|---|---|
| FriendlyName | Returns the friendly name of the early warning subscription. | String |
| Name | Returns the localized name of the early warning subscription. | String |
Gets details of an escalation.
| P/M1) | Description | Type |
|---|---|---|
| ContractPriority | Refers to the associated ContractPriority object. | CxContractPriority |
| Deadline | Gets the deadline in UTC time of the escalation. | IsoDateTime |
| EscalationTime | Refers to the associated EscalationTime object. | CxEscalationTime |
| IsDynamic | Returns whether it is a dynamic escalation. | Bool |
| IsPaused | Returns whether the escalation has been paused. | Bool |
| RemainingTime | Returns the time remaining until escalation. | TimeSpan |
| RemainingTimePercentage | Returns the remaining time until escalation as a percentage. | String |
| Text | Retrieves the escalation as text in local time (name of the escalation time + deadline). | String |
| TotalTime | Returns the total duration of the escalation from start to escalation. | TimeSpan |
Gets details of an escalation time.
| P/M1) | Description | Type |
|---|---|---|
| Days | Days | Int32 |
| FriendlyName | Gets the FriendlyName of the escalation time. | String |
| Hours | Hours | Int32 |
| Minutes | Minutes | Int32 |
| Name | The localized name | String |
| Seconds | Seconds | Int32 |
| Timespan | A timespan to provide total numbers (e.g. {# ... EscalationTime. | TimeSpan |
Provides access to the details of a expense.
| P/M1) | Description | Type |
|---|---|---|
| CostCenter | Returns the cost center of the expense. | CxCostCenter |
| CreationDateTime | Returns the creation date of the expense. | IsoDateTime |
| Creator | Returns the creator of the expense. | CxUser |
| DataId | Returns the unique ID of the expense in the database. | Int32 |
| Description | Returns the (external) description of the expense. | String |
| ExecutionDateTime | Returns the execution date of the expense. | IsoDateTime |
| ExpenseType | Returns the type of the expense. | CxExpenseType |
| InternalClearingType | Returns the internal clearing type of the expense. | CxClearingType |
| InternalDescription | Returns the internal description of the expense. | String |
| InternalName | Returns the internal name of the expense. | String |
| InternalTotal | Returns the internal total of the expense. | Double |
| Name | Returns the (external) name of the expense. | String |
| Project | Returns the project of the expense. | CxProject |
| Task | Returns the linked task of the expense if available. | CxTask |
| Ticket | Returns the linked ticket of the expense if available. | CxTicket |
| Total | Return the (external) total of the expense. | Double |
| Url | Returns the permanent url to the expense. | String |
Provides access to the details of a expense type.
| P/M1) | Description | Type |
|---|---|---|
| DefaultClearingType | Returns the default clearing type of the expense type. | CxClearingType |
| Title | Returns the title of the expense type. | String |
Provides access to the details of a single file.
| P/M1) | Description | Type |
|---|---|---|
| ContentLength | Gets the size of the file, in bytes. | Int64 |
| Creator | Gets the creator user of the file. | CxUser |
| DataId | Gets the DataId of the file. | Int32 |
| Filename | Gets the file name that is internally used. | String |
| FileType | Gets the type of the file. | String |
| MimeType | Gets the MimeType of the file. | String |
| ObjectGuid | Gets the ObjectGuid of the file. | Guid |
| OriginalFilename | Gets the original name of the file. It normally represents the name the file had when it was uploaded. | String |
| UploadDateTime | Gets the timestamp when the file was uploaded. | IsoDateTime |
Provides access to the details of a form.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Gets the DataId of the form (will be changed on every change in the designer). | Int32 |
| Fields | Provides access to current form values, accessed by friendlyname of the form control (useful to create form validation expressions, case insensitive). | Dictionary<String, CxFormFieldValue> |
| FriendlyName | Gets the name of the form. | String |
| ObjectGuid | Gets the unique id of the form (will be not be changed on every change in the designer). | Guid |
| Variables | Provides access to current form variables, accessed by name of the variable. Check the existence of the var before you try to access to it. The access to variables is intended to be used as list parameters only. | GenericIndexer<String, CxFormVariable> |
| GetFieldText(String name) | Returns the text of the specified field. If the field does not exist, NULL is returned. | String |
| GetFieldValue(String name) | Returns the value of the specified field. If the field does not exist, NULL is returned. | String |
Provides access to the value of a form field.
| P/M1) | Description | Type |
|---|---|---|
| LastUsed | Returns the form field (text and value) that was entered by the current user in his previous session (helpful to prefill a form). | CxFormFieldValue |
| Text | Gets the text of the field. | String |
| Value | Gets the value of the field. | String |
Provides access to the text and value part of a form variable.
| P/M1) | Description | Type |
|---|---|---|
| Text | Gets the text of the field. | String |
| Value | Gets the value of the field. | String |
Provides access to entity independent information.
| P/M1) | Description | Type |
|---|---|---|
| CurrentDateTime | Current date and time. | IsoDateTime |
| CurrentUser | Access to the current user. | CxOperatorUser |
| Get446PlattformMobilUIUrl() | Returns the Url to the configured 446 Plattform Mobil | String |
| Get446PlattformUIUrl() | Returns the Url to the configured 446 Plattform | String |
| HelpDeskLink | URL to 446 Plattform®. | String |
| KnowledgebaseStageUrl | Returns the URL to the knowledge base stage. | String |
| NewLine | Inserts a line break. | String |
| Null | NULL value. | Object |
| GetDataWorkflowContext() | Sets up the context which is required to process a data workflow. The return value can be stored in a variable for better readability, but it's not necessary: you may call all following methods directly. | CxDataWorkflow |
| MasterData(String category, String name) | Gets a string that is stored in the master data management, accessible by category name and key. Example: {# General.MasterData("myCategory", "myKey") #}. | String |
Provides access to the details of a single group.
| P/M1) | Description | Type |
|---|---|---|
| Active | Returns True, when the principal is not marked as deleted. | Boolean |
| CreatedDateTime | Gets the creation date and time of a principal. | IsoDateTime |
| CustomAttributes | Provides access to all attributes (fields) of the principal (case insensitive). | Dictionary<String, String> |
| DataId | Gets the DataId of the principal. | Int32 |
| DisplayName | Gets the display name of the principal. | String |
| FullName | Gets the FullName of the principal. | String |
| Group | If the principal is a group, then the principal is returned with Group context. Otherwise, NULL. | CxGroup |
| IsDeleted | Returns True, when the principal is marked as deleted. | Boolean |
| IsImported | Returns True, when the principal is marked as imported. | Boolean |
| IsPermissionRole | Returns True, when the group is a permission role. Otherwise, False. | Boolean |
| MainGroup | Gets the MainGroup of the principal. | CxGroup |
| MemberGroups | Provides access to the member groups of the group. | List<CxGroup> |
| MemberUsers | Provides access to the member users of the group. | List<CxUser> |
| Name | Returns the group name. | String |
| ObjectGuid | Gets the ObjectGUID of the principal. | Guid |
| ObjectType | Gets the ObjectType of the principal. | String |
| TextBuildingBlocks | Provides access to all text building blocks of the principal. Provide the FriendlyName, to have access to a particular item (case insensitive). E.g. {# ...TextBuildingBlocks["myTextName"].... #}. | Dictionary<String, CxTextBuildingBlock> |
| User | If the principal is a user, then the principal is returned with User context. Otherwise, NULL. | CxUser |
| P/M1) | Description | Type |
|---|---|---|
| JsonObject | Gets the deserialized Json object. | Object |
Provides access to the details of a knowledge base article.
| P/M1) | Description | Type |
|---|---|---|
| Categories | Returns the knowledge base categories of the knowledge base article. | List<CxKbCategory> |
| ChangedDateTime | Returns the date of the last change of the knowledge base article. | IsoDateTime |
| Content | Returns the content of the knowledge base article in the current user language. | String |
| ContentAllLanguages | Returns the content of the knowledge base article in all available languages (case insensitive). | Dictionary`2 (Dokumentation nicht umgesetzt) |
| CreationDateTime | Returns the creation date of the knowledge base article. | IsoDateTime |
| Creator | Returns the creator user of the knowledge base article. | CxUser |
| DataId | Returns the unique ID of the knowledge base article. | Int32 |
| Description | Returns the description of the knowledge base article in the current user language. | String |
| DescriptionAllLanguages | Returns the description of the knowledge base article in all available languages (case insensitive). | Dictionary`2 (Dokumentation nicht umgesetzt) |
| FullId | Returns the FullId of the knowledgebase article. | String |
| Inherit | Returns whether the knowledge base article is visible in sub-categories as well. | String |
| Keywords | Returns the keywords of the knowledge base article in the current user language. | String |
| KeywordsAllLanguages | Returns the keywords of the knowledge base article in all available languages (case insensitive). | Dictionary`2 (Dokumentation nicht umgesetzt) |
| KnowledgeOwner | Returns the knowledge owner of the knowledge base article. | CxUser |
| Modifier | Returns the user which has modified the knowledge base article last. | CxUser |
| ObjectGuid | Returns the unique ID (ObjectGuid) of the Knowledge Base article. | GUID |
| RatingAverage | Returns the average rating of the knowledge base article. | Decimal |
| RatingCount | Returns the number of ratings for this knowledge base article. | Int32 |
| ReviewDateTime | Returns the date of resubmission of the article. | IsoDateTime |
| RevisedDateTime | Returns the revision date of the knowledge base article. | IsoDateTime |
| Revisor | Returns the user who has revised the knowledge base article. | CxUser |
| Title | Returns the title of the knowledge base article. | String |
| TitleAllLanguages | Returns the title of the knowledge base article in all available languages (case insensitive). | Dictionary`2 (Dokumentation nicht umgesetzt) |
| Url | Returns the direct URL to the knowledge base article. | String |
| ValidEndDateTime | Returns the end date of the period of validity. | IsoDateTime |
| ValidStartDateTime | Returns the start date of the period of validity. | IsoDateTime |
| VisitsCount | Returns the number of persons who already viewed this knowledge base article. | Int32 |
| P/M1) | Description | Type |
|---|---|---|
| Name | Returns the localized name of the knowledge base category. | String |
| ObjectGuid | Returns the ObjectGUID of the knowledge base category. | Guid |
Gets details of an e-mail.
| P/M1) | Description | Type |
|---|---|---|
| Attachments | Provides access to the list of all file attachments of the e-mail (active attachments only). | List<CxFile> |
| Bcc | Returns every BCC address of the email. | List<CxRecipient> |
| BodyHtmlText | Returns the HTML text of the e-mail body. | String |
| BodyPlainText | Returns the plaintext of the e-mail body. | String |
| Cc | Returns every CC address of the email. Example: With the following expression it is possible to obtain a list of the corresponding e-mail addresses, separated by commas: {# string.Join(",", Mail.Cc.Select(r => r.Address))) #} | List<CxRecipient> |
| CreatedDateTime | Gets the creation date of the e-mail. | IsoDateTime |
| HeaderFields | Provides access to the header fields of the e-mail. | Dictionary<String, String> |
| IsSystemMail | Returns true if attached mail is a system generated mail. | Boolean |
| ObjectGuid | Returns the ObjectGUID of the e-mail object. | Guid |
| Outgoing | Returns True if the e-mail was sent, or False if it is an incoming e-mail. | Nullable Boolean |
| ParentMail | Returns the parent mail of the e-mail. | CxMail |
| Priority | Returns the priority of the e-mail. | Nullable Int32 |
| PriorityName | Returns the name of the priority of the e-mail. | String |
| Recipients | Returns all recipients of the e-mail. [Deprecated] | List<CxPrincipal> |
| ReferencedCases | Returns those instances, that are referenced within the subject or the body of the e-mail. | List<CxTicket> |
| ReferencedTickets | Returns those ticket, that are referenced within the subject or the body of the e-mail. | List<CxTicket> |
| SendDateTime | Returns the date time, when the e-mail was sent. | IsoDateTime |
| Sender | Returns the senders object of the e-mail. | CxUser |
| SenderEmail | Returns the senders e-mail address. | String |
| Subject | Returns the subject of the e-mail. | String |
| To | Returns every recipient address of the email. | List<CxRecipient> |
| FeedbackPageLink(String groupName, String pageName) | Generates a link to the feedback page of this e-mail, e.g. Mail.FeedbackPageLink("TXP Quality", "Very well") | String |
Provides access to a single Mail2Ticket/Case account.
| P/M1) | Description | Type |
|---|---|---|
| FriendlyName | Gets the FriendlyName of the account. | String |
| ObjectGuid | Gets the ObjectGUID of the account. | Guid |
| P/M1) | Description | Type |
|---|---|---|
| Active | Returns True, when the principal is not marked as deleted. | Boolean |
| CreatedDateTime | Gets the creation date and time of a principal. | IsoDateTime |
| CustomAttributes | Provides access to all attributes (fields) of the principal. | Dictionary<String, String> |
| DataId | Gets the DataId of the principal. | Int32 |
| Deputy | If the current user context is deputizing the current user, this property returns the deputy user of the current user context. | CxOperatorUser |
| DisplayName | Gets the display name of the principal. | String |
| ExpiryDate | Returns the expiry date of the user. | IsoDateTime |
| FullName | Gets the FullName of the principal. If used in deputy mode, it returns the string {deputy user} deputizing {deputized user}' with replaced placeholders. | String |
| Group | If the principal is a group, then the principal is returned with Group context. Otherwise, NULL. | CxGroup |
| IsAdministrator | Returns (True or False) whether the currently logged in user acts as administrator. | Boolean |
| IsDeleted | Returns True, when the principal is marked as deleted. | Boolean |
| IsDeputy | Returns (True or False) whether the currently logged in user acts as deputy. | Boolean |
| IsImported | Returns True, when the principal is marked as imported. | Boolean |
| LoginName | Gets the user login name. | String |
| MainGroup | Gets the MainGroup of the principal. | CxGroup |
| ObjectGuid | Gets the ObjectGUID of the principal. | Guid |
| ObjectType | Gets the ObjectType of the principal. | String |
| TextBuildingBlocks | Provides access to all text building blocks of the principal. Provide the FriendlyName, to have access to a particular item. E.g. {# ...TextBuildingBlocks["myTextName"].... #}. | Dictionary<String, CxTextBuildingBlock> |
| TimeZone | Returns the current timezone of the user. | String |
| User | If the principal is a user, then the principal is returned with User context. Otherwise, NULL. | CxUser |
Gets the content of a dynamic placeholder.
| P/M1) | Description | Type |
|---|---|---|
| Html | Returns the HTML content. | String |
| IsActive | Returns whether the dynamic placeholder is active or not. | Boolean |
| ObjectGuid | Returns the ObjectGUID of the dynamic placeholder. | Guid |
| PlainText | Returns the plaintext content. | String |
| Value | Returns the content. | String |
| ToString() | Returns the plaintext content. | String |
Provides access to dynamic placeholders.
| P/M1) | Description | Type |
|---|---|---|
| Item | Gets the content of a dynamic placeholder by its FriendlyName. Usage:
Any Dynamic Placeholder is accessed by its FriendlyName, case insensitive. | CxPlaceholder |
Provides access to a single principal (a user or a group).
| P/M1) | Description | Type |
|---|---|---|
| Active | Returns True, when the principal is not marked as deleted. | Boolean |
| CreatedDateTime | Gets the creation date and time of a principal. | IsoDateTime |
| CustomAttributes | Provides access to all attributes (fields) of the principal. | Dictionary<String, String> |
| DataId | Gets the DataId of the principal. | Int32 |
| DisplayName | Gets the display name of the principal. | String |
| FullName | Gets the FullName of the principal. | String |
| Group | If the principal is a group, then the principal is returned with Group context. Otherwise, NULL. | CxGroup |
| IsDeleted | Returns True, when the principal is marked as deleted. | Boolean |
| IsImported | Returns True, when the principal is marked as imported. | Boolean |
| MainGroup | Gets the MainGroup of the principal. | CxGroup |
| ObjectGuid | Gets the ObjectGUID of the principal. | Guid |
| ObjectType | Gets the ObjectType of the principal. | String |
| TextBuildingBlocks | Provides access to all text building blocks of the principal. Provide the FriendlyName, to have access to a particular item. E.g. {# ...TextBuildingBlocks["myTextName"].... #}. | Dictionary<String, CxTextBuildingBlock> |
| User | If the principal is a user, then the principal is returned with User context. Otherwise, NULL. | CxUser |
Provides access to a single process role.
| P/M1) | Description | Type |
|---|---|---|
| CreatedDateTime | Gets the creation date of the current process role. | IsoDateTime |
| Creator | Gets the creator of the current process role. | CxUser |
| DataId | Gets the DataId of the current process role. | Int32 |
| DefaultGroup | Gets the default group of the current process role. | CxGroup |
| FriendlyName | Gets the FriendlyName of the current process role. | String |
| Group | Gets the group of the current process role. | CxGroup |
| ObjectGuid | Gets the ObjectGuid of the current process role. | Guid |
| P/M1) | Description | Type |
|---|---|---|
| EndDateTime | Returns the end date of the project. | IsoDateTime |
| ObjectGuid | Returns the ObjectGUID of the project. | Guid |
| StartDateTime | Returns the start date of the project. | IsoDateTime |
| Title | Returns the title of the project. | String |
| P/M1) | Description | Type |
|---|---|---|
| Address | Returns the email address of the recipient or the underlying principal. | String |
| IsVisible | Returns True if the underlying principal is visible. | Boolean |
| PrincipalString | Returns the e-mail address or GUID of the underlying principal. | String |
| As<T>() | Converts the value of this property into an object of type T. Supported type: CxJson, CxCi, CxPrincipal and CxDateTime | T |
| AsList<T>() | Converts the value of this property into a list of objects of type T. Supported type: CxJson, CxCi, CxPrincipal and CxDateTime | List<T> |
Provides access to a single service.
| P/M1) | Description | Type |
|---|---|---|
| Catalog | Gets the catalog of the current service. | CxCatalog |
| Creator | Gets the creator of the current service. | CxUser |
| DataId | Gets the DataId of the current service. | Int32 |
| Description | Gets the language-dependent description of the current service. | String |
| Enddate | Gets the enddate of the current service. | IsoDateTime |
| EndStatus | Gets the endstatus of the current service. | CxServicePortfolioLifeCycleStatus |
| EndTriggered | Gets the endtriggered date of the current service. | IsoDateTime |
| Fields | Gets the fields of the current service (case insensitive). | Dictionary<String, CxServiceFieldValue> |
| FriendlyName | Gets the FriendlyName of the current service. | String |
| HasParent | Returns True, if the current service has a parent. | Boolean |
| HasServiceCi | Returns True, if the current service has a service CI. | Boolean |
| IsDeleted | Returns True, if the current service is deleted. | Boolean |
| IsImported | Returns True, if the current service was imported. | Boolean |
| IsStatusInherited | Returns True, if the current service status is inherited. | Boolean |
| Manager | Gets the manager group of the current service. | CxGroup |
| Name | Gets the language-dependent name of the current service. | String |
| ObjectGuid | Gets the ObjectGUID of the current service. | Guid |
| ParentServiceCategory | Gets the parent service category of the current service. | CxServiceCategory |
| Schema | Gets the schema of the current service. | CxServiceSchema |
| SduManager | Gets the service delivery unit manager of the current service. | CxGroup |
| ServiceCi | Gets the service CI of the current service. | CxCi |
| Slp | Gets the service level package of the current service. | CxSlp |
| Startdate | Gets the startdate of the current service. | IsoDateTime |
| StartStatus | Gets the startstatus of the current service. | CxServicePortfolioLifeCycleStatus |
| StartTriggered | Gets the start triggered date of the current service. | IsoDateTime |
| Status | Gets the status of the current service. | CxServicePortfolioLifeCycleStatus |
| StatusReached | Gets the status reached date of the current service. | IsoDateTime |
| GetFieldText(String name) | Returns the text of the specified field. If the field does not exist, NULL is returned. | String |
| GetFieldValue(String name) | Returns the value of the specified field. If the field does not exist, NULL is returned. | String |
Provides access to a single service category.
| P/M1) | Description | Type |
|---|---|---|
| Creator | Gets the creator of the current service category. | CxUser |
| DataId | Gets the DataId of the current service category. | Int32 |
| Description | Gets the language-dependent description of the current service category. | String |
| IsDeleted | Returns True, if the current service category is deleted. | Boolean |
| Name | Gets the language-dependent name of the current service category. | String |
| ObjectGuid | Gets the ObjectGUID of the current service category. | Guid |
| ParentServiceCategory | Gets the parent service category of the current service category. | CxServiceCategory |
| Status | Gets the status of the current service category. | CxServicePortfolioLifeCycleStatus |
Provides access to a single service field value.
| P/M1) | Description | Type |
|---|---|---|
| FriendlyName | Gets the FriendlyName of the current service field. | String |
| ObjectGuid | Gets the ObjectGuid of the current service field. | Guid |
| Text | Gets the text of the current service field. | String |
| Value | Gets the value of the current service field. | String |
Provides access to the details of a single service life cycle.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Gets the DataId of the current service life cycle. | Int32 |
| DeletedDateTime | Returns date and time, when the current service life cycle was deleted. | IsoDateTime |
| Description | Gets the language-dependent description of the current service life cycle. | String |
| FriendlyName | Gets the FriendlyName of the current service life cycle. | String |
| IsDeleted | Returns True if the current service life cycle is deleted. | Boolean |
| IsNew | Returns True if the current service life cycle is new. | Boolean |
| Name | Gets the language-dependent name of the current service life cycle. | String |
| ObjectGuid | Gets the ObjectGUID of the current service life cycle. | Guid |
| ObjectType | Returns the object type of the current service life cycle. | String |
Provides access to the details of a single service portfolio life cycle status.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Returns the DataId of the current service portfolio life cycle status. | Int32 |
| DeletedDate | Returns the date, when the current service portfolio life cycle status was deleted. | IsoDateTime |
| Description | Returns the language-dependent description of the current service portfolio life cycle status. | String |
| IconUrl | Returns the image URL of the current service portfolio life cycle status. | String |
| IsDefaultStatus | Returns True, if the current service portfolio life cycle status is the default status. | Boolean |
| IsDeleted | Returns True, if the current service portfolio life cycle status is deleted. | Boolean |
| IsStartStatus | Returns True, if the current service portfolio life cycle status is the start status. | Boolean |
| LifeCycle | Returns the life cycle of the current service portfolio life cycle status. | CxServicePortfolioLifeCycle |
| Name | Returns the language-dependent name of the current service portfolio life cycle status. | String |
| ObjectGuid | Returns the ObjectGUID of the current service portfolio life cycle status. | Guid |
| ShowIcon | Returns True, if show icon option of the current service portfolio life cycle status is enabled. | Boolean |
| StatusType | Returns the status type of the current service portfolio life cycle status. | CxServicePortfolioStatusType |
Provides access to a single service status type.
| P/M1) | Description | Type |
|---|---|---|
| FriendlyName | Gets the text value of the current service status type. | String |
| Name | Gets the language-dependent name of the current service status type. | String |
| Value | Gets the integer value of the current service status type. | Int32 |
Provides access to a single service schema.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Gets the DataId of the current service schema. | Int32 |
| DeletedDateTime | Returns date, when the current service schema was deleted. | IsoDateTime |
| Description | Gets the language-dependent description of the current service schema. | String |
| FriendlyName | Gets the FriendlyName of the current service schema. | String |
| IsDeleted | Returns True, if the current service schema is deleted. | Boolean |
| Name | Gets the language-dependent name of the current service schema. | String |
| ObjectGuid | Gets the ObjectGUID of the current service schema. | Guid |
Provides access to the details of a single service transaction.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Gets the DataId of the current service transaction. | Int32 |
| DefaultCi | Gets the default CI of the current service transaction. | CxCi |
| Description | Gets the language-dependent description of the current service transaction. | String |
| FriendlyName | Gets the FriendlyName of the current service transaction. | String |
| IsDeleted | Returns True, if the current service transaction is deleted. | Boolean |
| IsImported | Returns True, if the current service transaction was imported. | Boolean |
| IsStatusInherited | Returns True, if the inherit status flag of the current service transaction is set. | Boolean |
| Name | Gets the language-dependent name of the current service transaction. | String |
| ObjectGuid | Gets the ObjectGUID of the current service transaction. | Guid |
| ProcessRoles | Gets the process roles of the current service transaction (case insensitive). | Dictionary<String, CxProcessRole> |
| ProcessSchema | Gets the processschema of the current service transaction. | CxServiceSchema |
| SduManager | Gets the service delivery unit manager of the current service transaction. | CxGroup |
| Service | Gets the current service transaction. | CxService |
| Slp | Gets the service level package of the current service transaction. | CxSlp |
| Status | Gets the status of the current service transaction. | CxServicePortfolioLifeCycleStatus |
Provides access to a single service level package.
| P/M1) | Description | Type |
|---|---|---|
| Contract | Gets the contract of the current service level package. | CxContract |
| ContractPriority | Gets the contract priority of the current service level package. | CxContractPriority |
| ContractService | Gets the contract service of the current service level package. | CxContract |
| DataId | Gets the DataId of the current service level package. | Int32 |
| ObjectGuid | Gets the ObjectGUID of the current service level package. | Guid |
Can be used to test the SharpExpressions functionality.
| P/M1) | Description | Type |
|---|---|---|
| Hello | Returns "Hello, world!". | String |
Provides access to a text building block.
| P/M1) | Description | Type |
|---|---|---|
| HtmlText | Returns the HTML text of a text building block. | String |
| ObjectGuid | Returns the ObjectGUID of a text building block. | Guid |
| PlainText | Returns the plain text of a text building block. | String |
Provides access to the details of a single ticket.
| P/M1) | Description | Type |
|---|---|---|
| AdditionalAffectedPrincipals | Provides access to the list of additional affected principals of the ticket. | List<CxPrincipal> |
| AffectedGroup | Gets the affected group of the ticket. | CxGroup |
| AffectedUser | Gets the affected user of the ticket. | CxUser |
| Attachments | Provides access to the list of all file attachments of the ticket (active attachments only). | List<CxFile> |
| AttachmentsByCategory | Provides access to the file attachments of the ticket, grouped by category (active attachments only, case insensitive). | Dictionary<String, CxFile> |
| Cis | Returns information on CIs. | List<CxCi> |
| ClonedCases | Provides access to the list of cloned instances. | List<CxTicket> |
| ClonedTickets | Provides access to the list of cloned tickets of the ticket. | List<CxTicket> |
| Comments | Provides access to the list of comments of the ticket. | List<CxComment> |
| CompletionDateTime | Returns the estimated completion date of the ticket. | IsoDateTime |
| Container | Returns the parent container ticket or NULL. | CxTicket |
| ContainerChildren | Gets all container children. This collection is always empty if the instance is not a container. | List<CxTicket> |
| Coordinates | Returns the geographical location of the ticket. | CxCoordinates |
| CreatedDateTime | Returns the creation date of the ticket. | IsoDateTime |
| CreationMethod | Returns the creation method of the ticket. Possible return values and ticket creation from module:
| String |
| CreationMethod | Gets the Mail2Ticket account the ticket was created with, or NULL if the ticket is not created by Mail2Ticket. | CxMail2TicketAccount |
| CreatorGroup | Gets the creator group of the ticket. | CxGroup |
| CreatorUser | Gets the creator user of the ticket. | CxUser |
| CustomAttributes | Gets all attributes of a ticket (case insensitive). For example:
| Dictionary<String, String> |
| DataId | Gets the DataID of the ticket. | Int32 |
| DefaultClearingType | Gets the default cost clearing type of the ticket or NULL. | CxClearingType |
| DefaultCostCenter | Gets the default cost center of the ticket or NULL. | CxCostCenter |
| DefaultExpenseProject | Gets the default project of the ticket or NULL. | CxProject |
| DefaultExpenseType | Gets the default expense type of the ticket or NULL. | CxExpenseType |
| DirectUrlActivities | This expression returns a link as soon as there are pending workflow activities for a ticket. This link will then directly open the tab with the workflow actions of a ticket, so they can be performed. | String |
| Escalations | Returns information on escalations in connection with the attribute. In contrast to Ticket.PendingEscalations, information on already achieved or escalated escalations is returned as well (case insensitive). | Dictionary<String, CxEscalation> |
| EstimatedTimeExpense | Returns the estimated time expense of the ticket. | TimeSpan |
| Expenses | Returns linked expenses. | List<CxExpense> |
| ExternalSolution | Gets the external solution of the ticket including HTML tags. | String |
| ExternalSummary | Gets the external solution summary of the ticket. | String |
| Fields | Provides access to the ticket fields (case insensitive). | Dictionary<String, CxTicketFieldValue> |
| Followers | Provides access to the list of users who follow the ticket. | List<CxUser> |
| FullId | Gets the FullId (Ticket#) of the ticket. | String |
HasOpenSubTasks | Returns the value True, if the ticket contains further open subtasks; otherwise False. | Boolean |
HasOpenSuccessors | Returns True, if there is at least one open successor; otherwise False. | Boolean |
| HasParent | Checks whether the current ticket has a parent ticket. True if yes, False if no. | Boolean |
| HasSubTasks | Returns the value True, if the ticket contains subtasks; otherwise False. | Boolean |
| IdNumber | Returns the ticket’s number without the static prefix (e.g. 0009 instead of CR_0009). | Int32 |
| InitialCi | Gets the CI which was selected with service transaction during creation of a service portfolio ticket. | CxCi |
| InternalSolution | Gets the internal solution of the ticket. | String |
| InternalSummary | Gets the internal solution summary of the ticket. | String |
| KbArticles | Returns the number of KB articles linked to this ticket. | List<CxKbArticle> |
| LastInboundMail | Returns the last inbound mail, ordered by sent date. | CxMail |
| LastModification | Returns the date and time of the last modification of the ticket. | IsoDateTime |
| LastModifyingUser | Gets the last modifying user of the ticket. | CxUser |
| LastOutboundMail | Returns the last outbound mail, ordered by sent date. | CxMail |
| LastPendingEscalation | Returns the date and time of the last escalation of the ticket. | IsoDateTime |
| LastUserModification | Returns the date and time of the last modification of the ticket, that was caused by a user. | IsoDateTime |
| LinkedCases | Provides access to the list of the linked instances. | List<CxTicketRelation> |
| LinkedTickets | Provides access to the list of the linked tickets of the ticket. | List<CxTicketRelation> |
| Mails | Returns the attached mails. | List<CxMail> |
| MostUrgentPriority | When dealing with a container, it gets details of the most urgent priority of all container tickets. | CxContractPriority |
| NextPendingEscalation | Returns the date and time of the next escalation of the ticket. | IsoDateTime |
| ObjectGuid | Gets the ObjectGUID of the ticket. | Guid |
| OverviewHistoryAsText | Returns the content of the ticket overview history as HTML formatted text string. | String |
| OwnerGroup | Gets the owner group of the ticket. | CxGroup |
| OwnerUser | Gets the owner user of the ticket. | CxUser |
| ParentCase | Returns a possible parent instance and allows access to it. Otherwise, NULL is returned. | CxTicket |
| ParentTicket | Returns a possible parent ticket and allows access to it. Otherwise, NULL is returned. | CxTicket |
| PendingEscalations | Returns information on pending escalations (case insensitive). | Dictionary<String, CxEscalation> |
| Priority | Gets details of the ticket priority. | CxContractPriority |
| ResponsibleGroup | Gets the responsible group of the ticket. | CxGroup |
| ResponsibleUser | Gets the responsible user of the ticket. | CxUser |
| Schema | Provides access to the schema of the ticket. | CxTicketSchema |
| ServiceTransaction | Returns information on the service transaction used in the service portfolio. | CxServiceTransaction |
| StartDateTime | Returns the suggested start date of the ticket. | IsoDateTime |
| Status | Returns information on the current ticket status. | CxTicketStatus |
| SuccessorCases | Provides access to the list of successor instances. | List<CxTicket> |
| SuccessorTickets | Provides access to the list of successor tickets of the ticket. | List<CxTicket> |
| Template | Returns a TicketTemplate object that provides access to the ticket template's data if the ticket was created from a ticket template. | CxTicketTemplate |
| TicketMessageTag | Returns the specific expression to identify the ticket distinctly. | String |
| Title | Gets the ticket title. | String |
| Type | Gets the type of the ticket (Ticket, Container ticket, Container child, Template). | String |
| WorkflowActivities | Returns a list of all workflow activities of this ticket and the current user. | List<CxWorkflowActivity> |
| WxpUrl | Returns the direct Url to the ticket. | String |
| WxpUrlQueryString | Returns the query string for the URL access of the respective ticket (i.e. everything after ? without the actual address to the site). | String |
| Get446PlattformMobilUIUrl() | Returns the direct Url for the currently selected ticket to the 446 Plattform Mobil. | String |
| Get446PlattformUIUrl() | Returns the direct url for the currently selected ticket to the 446 Plattform. | String |
| GetFieldText(String name) | Returns the text of the specified field. If the field does not exist, NULL is returned. | String |
| GetFieldValue(String name) | Returns the value of the specified field. If the field does not exist, NULL is returned. | String |
| GetUrl(String tab, Boolean onlyQueryString) | Returns the direct Url to the ticket, focusing on the specified tab (Details, Fields, UploadFiles, Actions, History, Comments, Solution, Expenses, Overview, Todos). | String |
Provides access to the details of a single field.
| P/M1) | Description | Type |
|---|---|---|
| ObjectGuid | Gets the id of the field. | Guid |
| RawText | Gets the field raw text. | String |
| Text | Gets the field text including HTML tags if HTML encoding is not active on ticket schema field else HTML is encoded. | String |
| TextHtml | Gets the HTML text of a field. | String |
| Value | Gets the value of a field. | String |
| As<T>() | Converts the value of this property into an object of type T. Supported type: CxJson, CxCi, CxPrincipal and CxDateTime | T |
| AsList<T>() | Converts the value of this property into a list of objects of type T. Supported type: CxJson, CxCi, CxPrincipal and CxDateTime | List<T> |
Provides access to the linked ticket and the relation creation time.
| P/M1) | Description | Type |
|---|---|---|
| Created | The creation time of ticket relation. | IsoDateTime |
| Ticket | The linked ticket instance. | CxTicket |
Provides access to the details of a ticket schema.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Gets the data id of the schema. | Int32 |
| Description | Gets the description of the schema. | String |
| FriendlyName | Gets the FriendlyName of the schema. | String |
| IsDeleted | Returns whether the schema is deleted. | Boolean |
| LocalizedName | Gets the localized name of the schema or the friendly name if only one language is configured. | String |
| ObjectGuid | Gets the ObjectGUID of the schema. | Guid |
| ProcessRoles | Gets the process roles (case insensitive). | Dictionary 2 (documentation not implemented) |
Returns information on the current ticket status.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Returns the data id of the status. | Int32 |
| FriendlyName | Returns the FriendlyName of the current ticket status (language-independent). | String |
| IconUrl | Returns the icon URL of the current ticket status. | String |
| Name | Returns the language-dependent name of the current ticket status. | String |
| ObjectGuid | Returns a unique ID (in all databases) of the ticket status. | Guid |
| StatusType | Returns the status type of the status. | CxTicketStatusType |
Returns information about the ticket status type.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Returns the data id of the ticket status type. | Int32 |
| FriendlyName | Returns the friendly name of the ticket status type. | String |
| Name | Returns the localized name of the ticket status type. | String |
| Type | The status types equal:
| Int32 |
Returns information about the ticket template used when the ticket was created.
| P/M1) | Description | Type |
|---|---|---|
| DataId | Returns the data id of the ticket template. | Int32 |
| ObjectGuid | Returns the ObjectGuid of the ticket template. | Guid |
| FriendlyName | Returns the friendly name of the ticket template. | String |
| LocalizedName | Returns the localized name of the ticket template. | String |
| ExternalSolution | Returns the external solution specified in the template. | String |
| InternalSolution | Returns the internal solution specified in the template. | String |
| ExternalSummary | Returns the external summary of the solution specified in the template. | String |
| InternalSummary | Returns the internal summary of the solution specified in the template. | String |
| Fields | Allows access to the ticket fields (case-insensitive). | Dictionary<String, CxTicketFieldValue> |
| GetFieldText(String name) | Returns the text of the specified field. If the field does not exist, NULL is returned. | String |
| GetFieldValue(String name) | Returns the value of the specified field. If the field does not exist, NULL is returned. | String |
| P/M1) | Description | Type |
|---|---|---|
| BaseUtcOffset | Returns the base UTC offset of the timezone. | TimeSpan |
| BiasInMinutesNow | The offset to UTC time from local time now. Local = UTC + Bias. | Int32 |
| DaylightBiasInMinutes | The daylight time offset to UTC time in minutes. | Int32 |
| DaylightName | The zone's name during daylight savings time | String |
| DisplayName | The zone's display name, e.g. "(GMT) Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London" | String |
| Id | Returns the time zone identifier. | String |
| Name | Returns the time zone's name. | String |
| StandardBiasInMinutes | Returns the offset from UTC during standard time. | Int32 |
| StandardName | Returns the zone's name during standard time (not daylight savings). | String |
| SupportsDaylightSavingTime | Returns True if the timezone supports daylight saving time. | Boolean |
Provides access to the details of a single user.
| P/M1) | Description | Type |
|---|---|---|
| Active | Returns True, when the principal is not marked as deleted. | Boolean |
| CreatedDateTime | Gets the creation date and time of a principal. | IsoDateTime |
| CustomAttributes | Provides access to all attributes (fields) of the principal (case insensitive). | Dictionary<String, String> |
| DataId | Gets the DataId of the principal. | Int32 |
| DisplayName | Gets the display name of the principal. | String |
| ExpiryDate | Returns the expiry date of the user. | IsoDateTime |
| FullName | Gets the FullName of the principal. | String |
| Group | If the principal is a group, then the principal is returned with Group context. Otherwise, NULL. | CxGroup |
| IsDeleted | Returns True, when the principal is marked as deleted. | Boolean |
| IsDeputy | Returns True, when the principal is a deputy user. | Boolean |
| IsImported | Returns True, when the principal is marked as imported. | Boolean |
| LoginName | Gets the user login name. | String |
| MainGroup | Gets the MainGroup of the principal. | CxGroup |
| ObjectGuid | Gets the ObjectGUID of the principal. | Guid |
| ObjectType | Gets the ObjectType of the principal. | String |
| TextBuildingBlocks | Provides access to all text building blocks of the principal. Provide the FriendlyName, to have access to a particular item (case insensitive). E.g. {# ...TextBuildingBlocks["myTextName"].... #}. | Dictionary<String, CxTextBuildingBlock> |
| TimeZone | Returns the current timezone of the user. Example:
| CxTimeZoneInformation |
| User | If the principal is a user, then the principal is returned with User context. Otherwise, NULL. | CxUser |
Provides access to the details of a workflow activity (To-Do list item).
| P/M1) | Description | Type |
|---|---|---|
| Created | Returns the date of the creation of the activity item. | DateTime |
| DataId | Returns the data id of the activity item. | Int32 |
| FormObjectGuid | Returns the GUID of the form, if the activity item is a form activity. | Guid |
| IdDescriptive | Returns the descriptive id of the context object of the activity item. | String |
| IdUniqueForType | Returns the unique id of the context object of the activity item. | String |
| ObjectType | Returns the object type of the context object of the activity item. | String |
| Priority | Returns the priority of the activity item. | String |
| ShortText | Returns the short text of the activity item. | String |
| Subject | Returns the subject of the activity item. | String |
| TargetUser | Returns the target user object of the activity item. | CxUser |
| Text | Returns the descriptive text of the activity item. | String |
| UniqueActionName | Returns the unique name of the activity item. Format: {workflow GUID}_{installed GUID of plug-in}_{plug-in name} | String |
| WorkflowItemDataId | Returns the data ID of the workflow item. | Int32 |
Provides access to the details of a workflow item.
| P/M1) | Description | Type |
|---|---|---|
| Activity | Returns the workflow activity of the item. | CxWorkflowActivity |
| AffectedGroup | Returns information on the affected group. | CxGroup |
| AffectedUser | Returns information on the affected user. | CxUser |
| CallStack | Provides access to the elements of the CallStack. The CallStack contains subworkflow, function and error workflow calls, but not event workflows. | List<CxCallStackItem> |
| ClientObjectGuid | Returns the unique ID of the client this workflow item has been created in. | Guid |
| ConnectorObjectGuid | Returns the ObjectGUID of the connector. | Guid |
| CreatorUser | Returns information on the creator. | CxUser |
| CurrentAffiliation | During parallel thread in the workflow, where more than one workflow item exists for a single distinct referenced object, workflow items that belong together and are joined later have the same affiliation identifier. The Affiliation chain is a stack of integers. This property gives access to the current (topmost) affiliation identifier. | Int64 |
| CurrentlyStopped | Returns whether the item is stopped. | Boolean |
| CurrentUser | Returns information on the current user. | CxOperatorUser |
| DataId | Returns the ID of the item. | Int64 |
| ErrorCount | Returns the number of errors. | Int32 |
| Fields | Returns the workflow item field, accessible by field name (case insensitive). | GenericIndexer<String, CxWorkflowItemField> |
| IdDescriptive | Returns the descriptive ID of a workflow item. For a ticket: CR_00367, for example. | String |
| IdUniqueForType | Returns the unique ID for the type of the workflow item. | String |
| IsActivity | Returns True if the workflow item is an activity for the current user. | Boolean |
| IsCompleted | Returns whether a workflow item has been completed. | Boolean |
| IsErroneous | Returns whether the item has an error. | Boolean |
| IsSuspended | Returns whether the item has been suspended. | Boolean |
| IsWaitingForJoin | Returns whether the item is waiting for a join. | Boolean |
| LastActionInput | Returns the input of the last action. | String |
| LastActionResult | Returns the result of the last action. | String |
| LastException | Returns the last error of the workflow item. | String |
| LastExceptionMessage | Returns the first line of the description of the last error of the workflow item. | String |
| ObjectType | Returns the ObjectType of the workflow item (ticket, KB article, etc.). | String |
| OwnerGroup | Returns information on the owner group. | CxGroup |
| OwnerUser | Returns information on the owner. | CxUser |
| PluginObjectGuid | Returns the ObjectGUID of the plug-in the workflow item is currently in. | Guid |
| PreviousConnectorObjectGuid | Returns the ObjectGUID of the previous connector. | Guid |
| PreviousPluginObjectGuid | Returns the ObjectGUID of the plug-in the workflow item has been in previously. | Guid |
| PreviousWorkflowObjectGuid | Returns the ObjectGUID of the workflow the workflow item has been in previously. | Guid |
| ProcessSchemaDataId | Returns the data ID of the process schema the workflow item has been created with. | Int32 |
| SuspendedUntil | Returns the date, until which a workflow item has been suspended. | IsoDateTime |
| WaitingForUserActivities | Returns whether the item is waiting for user activities. | Boolean |
| WorkflowObjectGuid | Returns the ObjectGUID of the current workflow of the workflow item. | Guid |
| GetFieldText(String name) | Returns the text of the specified field. If the field does not exist, NULL is returned. | String |
| GetFieldValue(String name) | Returns the value of the specified field. If the field does not exist, NULL is returned. | String |
Represents the value of a workflow item field.
| P/M1) | Description | Type |
|---|---|---|
| AsBool | Returns the internal value of the field typed as a boolean. The internal value must be not null, and the field type must be Boolean. | Boolean |
| AsDateTime | Returns the internal value of the field typed as a DateTime. The internal value must be not null, and the field type must be DateTime. | DateTime |
| AsDecimal | Returns the internal value of the field typed as a decimal (decimal floating point number). The internal value must be not null, and the field type must be Decimal. | Decimal |
| AsDouble | Returns the internal value of the field typed as a double (doubleprecision floating point number). The internal value must be not null, and the field type must be Double. | Double |
| AsFloat | Returns the internal value of the field typed as a float (single precision floating point number). The internal value must be not null, and the field type must be float. | Single |
| AsGuid | Returns the internal value of the field typed as a Guid (uniqueidentifier). The internal value must be not null, and the field type must be Guid. | Guid |
| AsInt | Returns the internal value of the field typed as an integer. The internal value must be not null, and the field type must be Int. | Int32 |
| AsLong | Returns the internal value of the field typed as a long (large integer). The internal value must be not null, and the field type must be Long. | Int64 |
| AsTimeSpan | Returns the internal value of the field typed as a TimeSpan. The internal value must be not null, and the field type must be TimeSpan. | TimeSpan |
| InternalValue | The internal representation of the value, if the type is not Text. | String |
| Text | The content of the field. | String |
| Type | The type of the field content. | String |
| As<T>() | Converts the value of this property into an object of type T. Supported type: CxJson, CxCi, CxPrincipal and CxDateTime. | T |
| AsList<T>() | Converts the value of this property into a list of objects of type T. Supported type: CxJson, CxCi, CxPrincipal and CxDateTime. | List<T> |
| GetValueAs() | Tries to return the internal value of the field typed as specified. The internal value must be not null. | T |
| P/M1) | Description | Type |
|---|---|---|
| Day | Returns the day of the month. | Int32 |
| DayOfWeek | Returns the day of the week. | DayOfWeek |
| DayOfYear | Returns the day of the year. | Int32 |
| Hour | Returns the hours of the date time. | Int32 |
| Millisecond | Returns the milliseconds of the date time. | Int32 |
| Minute | Returns the minutes of the date time. | Int32 |
| Month | Returns the month of the date time. | Int32 |
| Second | Returns the seconds of the date time. | Int32 |
| Ticks | Returns the ticks of the date time. Note: A single tick represents one hundred nanoseconds or one ten-millionth of a second. There are 10,000 ticks in a millisecond, or 10 million ticks in a second. | Int64 |
| TimeOfDay | Returns the time of the day of the date time. | TimeSpan |
| TimeZone | Returns the time zone information. | ITimeZoneInformation |
| UtcDateTime | Returns the date time in UTC. | DateTime |
| Year | Returns the year of the date time. | Int32 |
| ZonedDateTime | Returns the date time in the specific time zone. | DateTime |
| Add(TimeSpan value) | Add a time span to the date time. | IsoDateTime |
| AddDays(Double value) | Add days to the date time. | IsoDateTime |
| AddHours(Double value) | Add hours to the date time. | IsoDateTime |
| AddMilliseconds(Double value) | Add milliseconds to the date time. | IsoDateTime |
| AddMinutes(Double value) | Add minutes to the date time. | IsoDateTime |
| AddMonths(Int32 value) | Add months to the date time. | IsoDateTime |
| AddSeconds(Double value) | Add seconds to the date time. | IsoDateTime |
| AddTicks(Int64 value) | Add ticks to the date time. | IsoDateTime |
| AddYears(Int32 value) | Add years to the date time. | IsoDateTime |
| Clone() | Creates a shallow copy (only the elements without references) of the Array. | Object |
| CompareTo(Object obj) | Compares this instance to a specified 32-bit signed integer and returns an indication of their relative values. | Int32 |
| Equals(Object obj) | Return value: True if the specified object is equal to the current object; otherwise, False. | Boolean |
| GetHashCode() | Returns a hash code for the current object. | Int32 |
| ToFileTime() | Returns the date time as windows file time. | Int64 |
| ToFileTimeUtc() | Returns the UTC date time as windows file time. | Int64 |
| ToString() | Returns a string that represents the current object. | String |
| ToString(String format, IFormatProvider formatProvider) | Returns a formatted string representing the current object (IFormatProvider to control the formatting of a particular national culture). | String |
ToString(IFormatProvider formatProvider) | Returns a formatted string representing the current object (IFormatProvider to control the formatting of a particular national culture). | String |
| ToString(String format) | Returns a formatted string representing the current object. | String |
1) Property/Method