🎯 MF Context Scopes Availability

This section presents the availability of different contexts within various system scopes for merge fields. It enables quick reference to determine which contexts are accessible in specific usage scenarios.

📋 Available Context Types

• ClientContext
• DateAndTimeContext
• VariableContext
• ConstantContext
• TaskContext
• ObjectRecordContext
• UsersGroupContext
• UserContext
• UserFieldMetaContext
• UserFieldContext
• DocumentContext
• EmbeddedDocumentContext

📊 Context Availability by Scope

Context	Sequencer Actor	Document Generation
AdminContext	🟢	🟢
ClientContext	🟢	🟢
DateAndTimeContext	🟢	🟢
VariableContext	🟢	🔴
VariableDocumentContext	🟢	🔴
ConstantContext	🟢	🟢
TaskContext	🟢	🟢
ObjectRecordContext	🟢	🟢
UsersGroupContext	🟢	🟢
UserContext	🟢	🟢
UserFieldMetaContext	🟢	🟢
UserFieldContext	🟢	🟢
DocumentContext	🟢	🟢
EmbeddedDocumentContext	🔴	🟢

📝 Legend

• 🟢 = Context is available in this scope
• 🔴 = Context is not available in this scope

🧩 Default Context Components:

The DefaultScope provides the foundational set of contexts available across the system:

• AdminContext - administrative context with system information
• ClientContext - client/organization information
• DateAndTimeContext - date and time related functions and variables
• ConstantContext (prefix: constants) - system and configuration constants

This baseline set of contexts forms the foundation that other specialized scopes build upon, ensuring consistent access to essential system data.

📋 ObjectRecord-Related Contexts:

The following contexts are directly associated with ObjectRecordContext as they provide related data and metadata:

• TaskContext - task-specific information and metadata related to the current record processing
• ObjectRecordContext - core access to record data being processed
• UsersGroupContext - user group information and permissions relevant to the record
• UserContext - current user information and context in relation to the record
• UserFieldMetaContext - metadata about user-defined fields associated with the record
• UserFieldContext - access to user-defined field values for the current record
• DocumentContext - document-specific context and metadata when processing record-related documents

⚙️ SequencerActor Context Components:

The SequencerActorScope combines three types of contexts for comprehensive workflow execution:

• Default Contexts
• Record-Related Contexts - related to the record being processed in the sequence
• Additional Context: VariableContext - dynamic workflow variables and runtime data

This scope is designed for workflow execution scenarios where comprehensive access to system data, record information, and dynamic variables is essential.

📄 DocumentGeneration Context Components:

The DocumentGenerationScope combines three types of contexts for document creation:

• Default Contexts
• Record-Related Contexts - related to the record being processed in document generation
• Additional Context: EmbeddedDocumentContext - for embedding images in the generated document

This scope provides comprehensive access to both system information and record data needed for generating documents with proper administrative context.This scope provides comprehensive access to both system information and record data needed for generating documents with proper administrative context.

💡 Context Usage Patterns

Based on the scope comparison table:

Universal Contexts:

• ClientContext and DateAndTimeContext - Available in all scopes as they provide fundamental system information
• ConstantContext - Widely available across most scopes for configuration values

Specialized Contexts:

• AdminContext - Available in DefaultScope and DocumentGenerationScope for system-level operations
• VariableContext - Limited to SequencerActorScope for dynamic workflow variables
• VariableDocumentContext - Limited to SequencerActorScope for dynamic workflow variables. Represents document's merge fields data.
• ObjectRecordContext - Available in data-processing scopes (SequencerActorScope, DocumentGenerationScope)
• DocumentContext - Exclusive to DocumentGenerationScope for document-specific operations

Workflow-Specific Contexts:

• TaskContext, UserContext, UserFieldContext, UserFieldMetaContext, UsersGroupContext - Currently not used in the main scopes, likely reserved for specialized workflow or form-processing scenarios

🏗️ VariableDocumentContext

Represents document's merge fields data.:

Property	Type	Description
id	integer	Unique document ID
name	string	File name with extension
size	integer	File size in bytes
uuid	string	Download URL
mimetype	string	Type and file format
base64	string	Base64 encoded content - hidden

🎯 Accessing Document Variable Properties

{{variables.var1.id}}
{{variables.var1.name}}
{{variables.var1.size}}
{{variables.var1.uuid}}
{{variables.var1.mimetype}}
{{variables.var1.base}}