Skip to content
Emakin Documentation
$TestMode
Initializing search
Emakin Documentation
📒 User’s Guide
📒 User’s Guide
Getting started
Getting started
Accessing Emakin
User interface
User interface
Navigation panel
Navigation panel
Calendar
Cases
Direct Messages
Home page
Market
Search
Worklist
Channels
Channels
Channel Statistics
Folders
Folders
Document Folder
Top bar
Top bar
Organization chart
User profile
Other functionalities
Other functionalities
Activities
History
Delegation
Delegation
Delegating a Task
Delegating for a time period
📘 Administrator’s Guide
📘 Administrator’s Guide
Installation
Installation
Kubernetes Installation using Helm
Docker Installation
Manual Installation
System administration
System administration
Host administration
Host administration
Activity Callbacks
Database Settings
Domains
E-Mail Services
General Settings
Integrated Services
Licenses
Login Services
Other Services
Security
SMS Services
Workers
System Health Checks
Performance Metrics
SSL Termination
How to
How to
Mail Forwarding
Service accounts
Service accounts
Google Service Authentication
Office365 Service Authentication
Domain administration
Domain administration
Audit Log Search
Managing Groups
Work Item Search and Management
System Statistics Dashboard
Background jobs
Background jobs
Background Jobs Manager
Job Details
Job Types
Job Statistics
Edit domain
Edit domain
Dashboards
Scopes
How to
How to
Apply a Custom Theme Style
Change the Logo
Configure the Calendar Settings
Organization database
Organization database
Organization Database Designer
Organization Schema
Process administration
Process administration
Process Access Control List (ACL)
Process Statistics
Relationship between Folders and Process Design Permissions
Node configuration
Node configuration
Command Line Interface
Node Configuration
📗 Developer’s Guide
📗 Developer’s Guide
Process modeling
Process modeling
Process definition
Process definition
Pools
Pools
Tasks
Tasks
Prework Script
Postwork Script
Task Scheduling
Module tasks
Module tasks
Automation Module
Event Listener Module
Event Module
Mail Module
Sub Workflow Module
Actions
Routes
Roles
Templates
Variables
Opening Script
Closing Script
Termination Script
Forms
Forms
Screens
Screens
Form templates
Form templates
Data model
Data model
Web services
Web services
Script modules
Script modules
Decision models
Decision models
Decision Table
FEEL
Namespaces
Content types
Content types
Access scopes
Access scopes
Documents
Documents
Forms
Forms
Form Scripting
Form Stylesheet
Data sources
Data sources
Channel Data Source
Content Type Data Source
List Item Data Source
Schedule Data Source
Script Data Source
Security Profile Data Source
Table Data Source
Web Service Data Source
XML Data Source
XML Query Data Source
Rules
Rules
Formatting Rule
Validation Rule
Widgets
Widgets
Activity Stream
Apply Template
Bar Chart
Barcode
Button
Check Box
Check List
Color Picker
Column Chart
DataTable
DateTime Box
Decision Table
Dropdown
Duration
Expression
File
Html
Html Box
Identity Picker
Line Chart
Message
Pie Chart
Pivot Table
Progress Bar
QR Code
Query
Repeating Content
Row Content
Tabbed Content
Table Content
Tag List
Widget
Data templates
Data templates
Databases
Databases
File database
File database
Relational database
Relational database
Relational Database Query
Xml database
Xml database
XPath and XQuery
XPath and XQuery
Xpath
Xpath
Xpath functions
Xpath functions
avg
current
distinct-values
format
iif
mask
max
min
string-join
Xquery
Xquery
Advanced Features
Basic Features
Advanced features
Advanced features
Mixing Updating and Non-updating Expressions
Order and Conflicts
Primitive operations revisited
The Problem of Invisible Updates
Process examples
Process examples
Case examples
Case examples
Assigning a Tag to a Case in CRM Channel
Track User Performance with Milestones
Workflow examples
Workflow examples
Add Deadline to Task
Add Tags To Process
Assign a Task to a Group
Assign a Task To a Manager
Assign Task to an External Participant
Initiating a Workflow Anonymously
Insert Emakin Links to Forms or Reports
Populate a Dropdown with Data from a REST API
Save Your Contacts to Address Book
Scheduling a Task
Integration services
Integration services
Channel Web Hooks
Embedding Emakin Forms
Rest
Rest
Activity Stream
Decision
ExecuteModule
GetToken
GetTokenFromProvider
GetTokenFromUserInfo
GetWorkItem
GetWorklist
GetWorklistCount
InitiateByProcess
SelectAction
Trigger
Worklist Query
Scripting
Scripting
Reference
Reference
$ActiveUser
$ActiveUser
$ActivityStream
$ActivityStream
$ActivityStream.List
$ActivityStream.Post
$ActivityStream.Remove
$Cache
$Cache
$Cache.Get
$Cache.Lock
$Cache.ReleaseLock
$Cache.Set
$Cache.TryLock
$Calendar
$Calendar
$Case
$Case
$Crypto
$Crypto
$Crypto.AddCertificate
$Crypto.AddTrustedCertificate
$Crypto.AttachContentToSignature
$Crypto.AttachContentToSignatureFile
$Crypto.Decrypt
$Crypto.DetachContentFromSignature
$Crypto.Encrypt
$Crypto.FromBase64
$Crypto.GetCertificate
$Crypto.Hash
$Crypto.ListCertificates
$Crypto.MergeSignatures
$Crypto.MergeSignaturesFile
$Crypto.Sign
$Crypto.ToBase64
$Crypto.Verify
$Crypto.VerifyFile
CertificateContext
CertificateContext
CertificateContext.Filter
CertificateContext.Library
CertificateContext.Pin
CertificateFilter
CertificateFilter
CertificateFilter.CommonName
CertificateFilter.SerialNumber
Signature
Signature
Signature.Date
Signature.IsValid
Signature.Name
Signature.SerialNumber
SignatureRequest
SignatureRequest
SignatureRequest.Requests
SignatureResource
SignatureResource
SignatureResource.AddCrl
SignatureResource.Detached
SignatureResource.Digest
SignatureResource.ExternalHash
SignatureResource.Format
SignatureResource.Level
SignatureResource.Source
SignatureResource.SourceBase64
SignatureResource.SourceFile
SignatureResult
SignatureResult
SignatureResult.Certiticate
SignatureResult.CommonName
SignatureResult.Results
SignatureResult.SerialNumber
SignatureResultItem
SignatureResultItem
SignatureResultItem.Content
SignatureResultItem.Digest
SignatureResultItem.Format
SignatureResultItem.Level
VerifyResult
VerifyResult
VerifyResult.AllValid
VerifyResult.Signatures
VerifyResult.SignedContent
VerifyResult.ValidationLog
VerifyResult.Validity
$Culture
$Culture
$Database
$Database
$Database.AddData
$Database.DeleteData
$Database.Empty
$Database.EnsureData
$Database.EnsureStoreData
$Database.ExecuteNonQuery
$Database.ExecuteQuery
$Database.ExportToXml
$Database.Get
$Database.GetData
$Database.ImportFromXml
$Decisions
$Decisions
$Decisions.Parse
$Delegation
$Delegation
$Delegation.Add
$Delegation.Delete
$Delegation.List
$Documents
$Documents
$Documents.Get
$Documents.GetLastVersion
$Documents.New
$Documents.NewVersion
$Domain
$Domain
$Domain.ApplicationName
$Domain.CreateCase
$Domain.ExecuteLdapQuery
$Domain.GetCase
$Domain.GetSecurityProfiles
$Domain.GetWorkItem
$Domain.HasPermission
$Domain.HasProcess
$Domain.Initiate
$Domain.ListCases
$Domain.ListCasesForIdentity
$Domain.LogoUrl
$Domain.Name
$Domain.PostMessage
$Domain.ProcessWorkItem
$Domain.Properties
$Domain.Trigger
$Domain.Url
$Files
$Files
$Initiator
$Initiator
$Instance
$Instance
$Membership
$Membership
$Membership.Administrator
$Membership.CreateUser
$Membership.EnsureParticipant
$Membership.Everyone
$Membership.Expand
$Membership.FindIdentity
$Membership.FindManager
$Membership.FindPosition
$Membership.Get
$Membership.GetAuthenticationTicket
$Membership.GetChilds
$Membership.GetEmployeesOfManager
$Membership.GetParticipantTicket
$Membership.GetPath
$Membership.GetProperty
$Membership.IsMemberOf
$Membership.Join
$Membership.SendLogonRegistrationEMail
$Membership.UpdateUser
$Messages
$Messages
$Messages.CreateEML
$Messages.New
$Messages.ParseEML
$NewChild
$NewChild
$Priority
$Priority
$Rest
$Rest
$Services
$Services
$Templates
$Templates
$Templates.Format
$Templates.Get
$Templates.Subject
$TestMode
$TestMode
$WorkItem
$WorkItem
$Xml
$Xml
$XmlRepository
$XmlRepository
$XmlRepository.Delete
$XmlRepository.Query
$XmlRepository.QueryXml
$XmlRepository.Save
Calendar
Calendar
Calendar.Add
Calendar.AddAsync
Calendar.AddDays
Calendar.AddDaysAsync
Calendar.AddMonths
Calendar.AddMonthsAsync
Calendar.AddTimeSpan
Calendar.AddTimeSpanAsync
Calendar.AddYears
Calendar.AddYearsAsync
Calendar.ChangeTimeZone
Calendar.ChangeTimeZoneAsync
Calendar.GetDateTime
Calendar.GetDateTimeAsync
Calendar.GetHoursInDay
Calendar.GetStandardCalendar
Calendar.GetTimeZone
Calendar.GetTimeZoneAsync
Calendar.GetToday
Calendar.GetTodayAsync
Calendar.GetWeekendCalendar
Calendar.Parse
Calendar.StandardCalendar
Calendar.Subtract
Calendar.SubtractAsync
Calendar.Today
Calendar.WeekendCalendar
Case
Case
Case.AddLink
Case.AddProfile
Case.AddTag
Case.Assign
Case.AssignedAt
Case.AssignedTo
Case.ChannelId
Case.ClosedAt
Case.ContentType
Case.Copy
Case.CreatedAt
Case.CreatedBy
Case.DeadlineAt
Case.Description
Case.GetMessages
Case.GetWorkItems
Case.Id
Case.IsClosed
Case.IsDeadlined
Case.Milestones
Case.Move
Case.NextReminderDate
Case.Number
Case.Priority
Case.Profile
Case.ProfileChanged
Case.RemoveTag
Case.SentReminders
Case.Subject
Case.Tags
Case.UpdatedAt
Case.UpdatedBy
DataRow
DataRow
DataRow.Delete
DataRow.Undelete
DataRow.toJSON
DataTable
DataTable
DataTable.Add
DataTable.DeleteAll
DataTable.Each
DataTable.ImportFromXml
DataTable.Map
DataTable.RowCount
DataTable.Rows
DataTable.Save
DataTable.ToDictionary
DataTable.toJSON
DataTableDictionary
DataTableDictionary
DataTableDictionary.Ensure
DataTableDictionary.Get
DataTableDictionary.Has
DataTableDictionary.Keys
DataTableDictionary.Save
DataTableDictionary.Set
DateTimeOffset
DateTimeOffset
DateTimeOffset.getDate
DateTimeOffset.getDay
DateTimeOffset.getFullYear
DateTimeOffset.getHours
DateTimeOffset.getMilliseconds
DateTimeOffset.getMinutes
DateTimeOffset.getMonth
DateTimeOffset.getSeconds
DateTimeOffset.getTime
DateTimeOffset.getTimezoneOffset
DateTimeOffset.now
DateTimeOffset.parse
DateTimeOffset.parseWithCulture
DateTimeOffset.toDate
DateTimeOffset.toISOString
DateTimeOffset.toLocalDate
DateTimeOffset.toString
Document
Document
Document.Acl
Document.AddProfile
Document.Archive
Document.BranchId
Document.ContentType
Document.CreatedAt
Document.CreatedBy
Document.Delete
Document.Description
Document.Files
Document.Id
Document.IsReadonly
Document.Profile
Document.Publish
Document.Save
Document.SetSecurityProfile
Document.State
Document.Title
Document.Unpublish
Document.Version
FileInfo
FileInfo
FileInfo.CreateDate
FileInfo.Hash
FileInfo.Id
FileInfo.MimeType
FileInfo.Name
FileInfo.OwnerId
Files
Files
Files.AddBase64
Files.AddPDF
Files.AddString
Files.Copy
Files.Delete
Files.Download
Files.ExtractText
Files.FromBase64
Files.Get
Files.GetBase64
Files.GetDir
Files.GetDir2
Files.GetString
Files.Hash
Files.MakeDir
Files.Remove
Files.RemoveDir
Files.Replace
Files.SetBase64
Files.ToBase64
Files.UnZip
Files.Upload
Files.Zip
Identity
Identity
Identity.Domain
Identity.Id
Identity.Name
Identity.Type
Instance
Instance
Instance.AddTag
Instance.Case
Instance.Culture
Instance.End
Instance.EnhancedSecurity
Instance.Id
Instance.Initiator
Instance.InitiatorWorkItem
Instance.Number
Instance.ParentWorkItem
Instance.Priority
Instance.ProcessId
Instance.RemoveTag
Instance.Start
Instance.State
Instance.Tags
Instance.Terminate
Instance.TestMode
Message
Message
Message.Attach
Message.AttachFile
Message.AttachString
Message.Attachments
Message.BCC
Message.BCCList
Message.Body
Message.CC
Message.CCList
Message.Date
Message.DeleteAfter
Message.From
Message.GetHeader
Message.GetHeaders
Message.Id
Message.Priority
Message.ReplyTo
Message.Send
Message.SendAfter
Message.SendBefore
Message.SetHeader
Message.Signature
Message.Subject
Message.To
Message.ToList
Message.ToXml
MessageAttachment
MessageAttachment
MessageAttachment.Data
MessageAttachment.Id
MessageAttachment.MimeType
MessageAttachment.Name
MessageContact
MessageContact
MessageContact.Address
MessageContact.DisplayName
MessageHeader
MessageHeader
MessageHeader.name
MessageHeader.value
Milestone
Milestone
Milestone.Cancel
Milestone.DueAt
Milestone.Duration
Milestone.Elapsed
Milestone.Name
Milestone.Pause
Milestone.Resume
Milestone.Stage
Milestone.StartedAt
Milestone.Stop
Milestone.StoppedAt
Milestones
Milestones
Milestones.Add
Milestones.AddFrom
Milestones.Cancel
Milestones.CancelAll
Milestones.Get
Milestones.Pause
Milestones.PauseAll
Milestones.Resume
Milestones.ResumeAll
Milestones.Start
Milestones.Stop
Milestones.StopAll
Milestones.ToArray
Query
Query
Query.Columns
Query.MaxLength
Query.Order
Query.Parameters
Query.Start
Query.SubQueries
Query.TargetSchema
Query.TargetTable
Query.Where
Query.XPath
Rest
Rest
Rest.Create
RestClient
RestClient
RestClient.AddDefaultHeader
RestClient.AddDefaultParameter
RestClient.AddDefaultUrlParameter
RestClient.Authenticate
RestClient.AuthenticateBasic
RestClient.AuthenticateJwt
RestClient.AuthenticateNtlm
RestClient.EnsureAuthenticated
RestClient.IsAuthenticated
RestClient.Request
RestClient.Url
RestRequest
RestRequest
RestRequest.AddFile
RestRequest.AddFileBase64
RestRequest.AddFileBody
RestRequest.AddFileBodyBase64
RestRequest.AddHeader
RestRequest.AddObject
RestRequest.AddParameter
RestRequest.AddQueryParameter
RestRequest.AddUrlParameter
RestRequest.AddXml
RestRequest.Delete
RestRequest.DeleteAsync
RestRequest.Execute
RestRequest.ExecuteAsync
RestRequest.ExecuteJson
RestRequest.ExecuteJsonAsync
RestRequest.ExecuteString
RestRequest.ExecuteStringAsync
RestRequest.ExecuteXml
RestRequest.ExecuteXmlAsync
RestRequest.Expect
RestRequest.Get
RestRequest.GetAsync
RestRequest.Method
RestRequest.Patch
RestRequest.PatchAsync
RestRequest.Post
RestRequest.PostAsync
RestRequest.Put
RestRequest.PutAsync
RestRequest.SetFileFragment
RestResponse
RestResponse
RestResponse.Content
RestResponse.ContentType
RestResponse.GetHeader
RestResponse.StatusCode
RestResponse.ToBase64
RestResponse.ToJson
RestResponse.ToXml
RestResponse.Verify
Script
Script
Script.Assert
Script.AssertEquals
Script.AssertNotEquals
Script.FromBase64
Script.Isolated
Script.NewId
Script.ThrowIfCancelled
Script.Timeout
Script.ToBase64
WorkItem
WorkItem
WorkItem.Caption
WorkItem.CompletedBy
WorkItem.Data
WorkItem.DeadlineDate
WorkItem.End
WorkItem.Forward
WorkItem.Get
WorkItem.GetOwnerUsers
WorkItem.GetOwners
WorkItem.Id
WorkItem.Initiate
WorkItem.Instance
WorkItem.Instructions
WorkItem.IsDeadlined
WorkItem.Name
WorkItem.NextItems
WorkItem.NextReminder
WorkItem.Previous
WorkItem.Process
WorkItem.SelectedAction
WorkItem.Start
WorkItem.State
WorkItem.TaskId
WorkItem.Terminate
WorkItem.Trigger
Writer
Writer
Writer.Clone
Writer.LoadFromBase64
Writer.LoadText
Writer.SaveToBase64
Writer.Sections
BlockCollection
BlockCollection
BlockCollection.AddBlockContentControl
BlockCollection.AddParagraph
BlockCollection.AddTable
BlockCollection.AddTableOfEntries
BlockCollection.Clear
BlockCollection.Count
BlockCollection.IndexOf
BlockCollection.Remove
BlockCollection.RemoveAt
BlockCollection.ToArray
BookmarkEnd
BookmarkEnd
BookmarkEnd.Clone
BookmarkEnd.ElementType
BookmarkEnd.GetChildElements
BookmarkEnd.GetParentElements
BookmarkEnd.Name
BookmarkStart
BookmarkStart
BookmarkStart.Clone
BookmarkStart.ElementType
BookmarkStart.GetChildElements
BookmarkStart.GetParentElements
BookmarkStart.Name
Comment
Comment
Comment.Clone
Comment.ElementType
Comment.GetChildElements
Comment.GetParentElements
Field
Field
Field.CharacterFormat
Field.Clone
Field.ElementType
Field.FieldType
Field.GetChildElements
Field.GetInstructionText
Field.GetParentElements
Field.InstructionInlines
Field.IsDirty
Field.IsLocked
Field.ResultInlines
Field.Update
HeaderFooter
HeaderFooter
HeaderFooter.Blocks
HeaderFooter.Clone
HeaderFooter.ElementType
HeaderFooter.GetChildElements
HeaderFooter.GetParentElements
HeaderFooter.HeaderFooterType
HeaderFooter.IsHeader
HeaderFooterCollection
HeaderFooterCollection
HeaderFooterCollection.Add
HeaderFooterCollection.Clear
HeaderFooterCollection.Count
HeaderFooterCollection.IndexOf
HeaderFooterCollection.Remove
HeaderFooterCollection.RemoveAt
HeaderFooterCollection.ToArray
Hyperlink
Hyperlink
Hyperlink.Address
Hyperlink.Clone
Hyperlink.DisplayInlines
Hyperlink.ElementType
Hyperlink.GetChildElements
Hyperlink.GetParentElements
Hyperlink.IsBookmarkLink
Hyperlink.ScreenTip
Hyperlink.TargetFrame
InlineCollection
InlineCollection
InlineCollection.AddBookmarkEnd
InlineCollection.AddBookmarkStart
InlineCollection.AddField
InlineCollection.AddHyperlink
InlineCollection.AddInlineContentControl
InlineCollection.AddNote
InlineCollection.AddRun
InlineCollection.AddShape
InlineCollection.AddSpecialCharacter
InlineCollection.Clear
InlineCollection.Count
InlineCollection.IndexOf
InlineCollection.Remove
InlineCollection.RemoveAt
InlineCollection.ToArray
InlineContentControl
InlineContentControl
InlineContentControl.Clone
InlineContentControl.ContentControlType
InlineContentControl.ElementType
InlineContentControl.GetChildElements
InlineContentControl.GetParentElements
InlineContentControl.Inlines
Note
Note
Note.Blocks
Note.CharacterFormat
Note.Clone
Note.CustomMark
Note.ElementType
Note.GetChildElements
Note.GetParentElements
Note.NoteType
PageBorders
PageBorders
PageBorders.AlwaysDisplayInFront
PageBorders.ApplyToAllExceptFirstPage
PageSetup
PageSetup
PageSetup.Orientation
PageSetup.PageBorders
PageSetup.PageColor
Paragraph
Paragraph
Paragraph.Clone
Paragraph.ElementType
Paragraph.GetChildElements
Paragraph.GetParentElements
Paragraph.Inlines
Paragraph.ParagraphFormat
ParagraphFormat
ParagraphFormat
ParagraphFormat.Alignment
ParagraphFormat.BackgroundColor
ParagraphFormat.ClearFormatting
ParagraphFormat.KeepLinesTogether
ParagraphFormat.KeepWithNext
ParagraphFormat.LeftIndentation
ParagraphFormat.LineSpacing
ParagraphFormat.LineSpacingRule
ParagraphFormat.MirrorIndents
ParagraphFormat.NoSpaceBetweenParagraphsOfSameStyle
ParagraphFormat.PageBreakBefore
ParagraphFormat.RightIndentation
ParagraphFormat.RightToLeft
ParagraphFormat.SpaceAfter
ParagraphFormat.SpaceBefore
ParagraphFormat.SpecialIndentation
ParagraphFormat.WordWrap
Section
Section
Section.Blocks
Section.Clone
Section.ElementType
Section.GetChildElements
Section.GetParentElements
Section.HeadersFooters
Section.PageSetup
SectionCollection
SectionCollection
SectionCollection.Add
SectionCollection.Clear
SectionCollection.Count
SectionCollection.IndexOf
SectionCollection.Remove
SectionCollection.RemoveAt
SectionCollection.ToArray
Shape
Shape
Shape.Clone
Shape.ElementType
Shape.GetChildElements
Shape.GetParentElements
Shape.Hidden
Shape.MetaData
Shape.ShapeType
TableCellCollection
TableCellCollection
TableCellCollection.Add
TableCellCollection.Clear
TableCellCollection.Count
TableCellCollection.IndexOf
TableCellCollection.Remove
TableCellCollection.RemoveAt
TableCellCollection.ToArray
TableRowCollection
TableRowCollection
TableRowCollection.Add
TableRowCollection.Clear
TableRowCollection.Count
TableRowCollection.IndexOf
TableRowCollection.Remove
TableRowCollection.RemoveAt
TableRowCollection.ToArray
Xml
Xml
Xml.AddNamespace
Xml.AppendChild
Xml.Assert
Xml.Bind
Xml.CommitDeletes
Xml.Copy
Xml.Count
Xml.create
Xml.Equals
Xml.Evaluate
Xml.EvaluateBoolean
Xml.EvaluateDateTime
Xml.EvaluateNumber
Xml.Format
Xml.GetAttribute
Xml.GetParent
Xml.InnerXml
Xml.IsEmpty
Xml.Live
Xml.Load
Xml.LookupNamespaceURI
Xml.LookupPrefix
Xml.OuterXml
Xml.parse
Xml.Remove
Xml.RemoveAttribute
Xml.RemoveNamespace
Xml.Save
Xml.SelectAll
Xml.SelectSingle
Xml.SetAttribute
Xml.SetAttributeNS
Xml.SetDefaultValue
Xml.SetValue
Xml.Sum
Xml.Sync
Xml.Transform
Xml.Trigger
XmlWriter
XmlWriter
XmlWriter.Attribute
XmlWriter.CData
XmlWriter.Element
XmlWriter.EndElement
XmlWriter.StartElement
XmlWriter.ToXml
XmlWriter.Write
XmlWriter.Xml
Global
Global
global.NewId
Release notes
Release notes
Release notes - 8.6
Release notes - 8.5
Release notes - 8.0
Release notes - 7.1
Release notes - 7.0
Release notes - 6.6
Release notes - 6.5
Release notes - 6.1
Release notes - 6.0
Release notes - 5.1
Release notes - 5.0
Release notes - 4.5
Release notes - 4.4
Release notes - 4.3
Release notes - 4.2
Release notes - 4.1
Release notes - 4.0
Release notes - 3.9
Scripting
$TestMode
¶
Gets the current workflow is in test mode.
1
const $TestMode: boolean;