AEM Forms workspace JSON object description aem-forms-workspace-json-object-description

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

User

CAUTION

AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

JSON objects used in AEM Forms workspace are described below.

Category

Categories are present in the start process tab of the workspace. These categories are used to classify the startpoints.

Property

Client Only

Comments

name

Category name

Category ID

description

Category description

parentOid

Contains oid of parent category

startPointsList

Contains list of all startpoints present in a category

categoryList

Contains list of direct child categories of a category

NOTE

All Startpoints and Favorites are categories which are defined on client side. Favorite category contains all startpoints which are marked by the user as favorite. All Startpoints category contains all startpoints.

Startpoint

Startpoint is used to start a process from the workspace when invoked.

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3
Property	Client Only	Comments
categoryId	F	It contains id of the category to which startpoint belongs.
description	F	It contains description for a startpoint.
name	F	It contains name of the startpoint.
serializedImageTicket	F	It contains image ticket corresponding to the startpoint. This image ticket is used in imageUrl field of startpoint, to get image for startpoint from the server.
serviceName	F	It contains name of the service for startpoint.
startpointId	F	It contains id of startpoint.
isFavorite	T	Denotes whether startpoint is favorite or not. True if startpoint is favorite else false.
isDefaultImage	T	Denotes whether there is an image specified for process or not. True if there is no image associated with process else false.
task	T	It contains task created when startpoint is invoked.
imageUrl	T	It contains url of the image corresponding to the startpoint.

Task

Tasks are assigned to users/group and include a user interface–a form or a Guide (deprecated)–that can be populated with data. When users are assigned a task, they are provided with the form or Guide to complete and submit.

Property

Client Only

Comments

classOfTask

Class of task is 'LC8' when task is lc8 task else 'Standard'.

completeTime

It contains the time stamp when task is completed.

consultGroupId

It contains ID of a group to which task can be consulted. It is set during the process designing.

createTime

It contains the time stamp when task is created.

creationId

It contains the id of the user who created the task.

currentAssignment

It contains details about current assignment of task.

deadline

It contains the time stamp that when a task will reach its deadline.

description

It contains description of the task.

displayName

It contains display name of the task.

forwardGroupId

It contains ID of a group to which task can be forwarded. It is set during the process designing.

instructions

It contains instructions for a task.

isLocked

True if task is locked.

isMustOpenToComplete

True if task form must be opened to complete the task.

isOpenFullScreen

If true, on opening the task, form takes complete screen first time.

isRouteSelectionRequired

If true, route must be selected to complete the task.

isShowAttachments

Attachments are shown if it is true.

isStartTask

If true, task is created from start point.

isVisible

True if task is visible in workspace.

nextReminder

Time stamp for the next reminder.

priority

It contains priority of task.
1 = Highest priority
2 = High Priority
3 = Normal Priority
4 = Low Priority
5 = Lowest Priority

processInstanceId

Id of the process instance of which task is part.

processInstanceStatus

Status of task's process instance.

reminderCount

It contains count of reminders for the task.

routeList

It contains list of routes associated with task. User can complete the task by selecting any one of the route from route list.

selectedRoute

It contains name of the route selected when task was completed.

serializedImageTicket

It contains image ticket corresponding to task. This image ticket is used in imageUrl field of task, to get image for task from the server.

serviceName

It contains name of the service for task.

serviceTitle

It contains title of the service for task.

status

1 = Created (Task is created from start point.)
2 = Created and Saved (Task is created from start point and saved.)
3 = Assigned (Task is assigned to the user after process has been started.)
4 = Assigned and Saved (Task is assigned and saved.)
100 = Completed (Task is completed.)
101 = Deadlined (Task has reached the deadline.)
102 = Terminated

stepName

It contains name of the task set during process designing.

summaryUrl

It contains task summary url.

taskACL

It is access control list for a task.

taskId

Id of a task.

updateTime

Time stamp when task was last updated.

formUrl

It contains url of form for a task.

taskFormType

It contains task form type. Using this field, task is rendered on client as pdf for, swf form etc.

showDirectActions

If true, route actions are visible in workspace.

showACLActions

If true, actions like forward, consult, share are visible in workspace.

supportsOffline

If true, form can be taken offline. This is for pdf forms only.

supportsSave

If true, user can save task.

readerSubmitOptions

This object contains options which are used to submit pdf forms via reader in case when pdf form contains no submit button.

isDefaultImage

Denotes whether there is an image specified for process or not. True if there is no image associated with process else false.

historyTaskList

It contains list of tasks which are used in history tab of task details.

isOwner

True if logged in user is owner of task.

availableCommands

It contains all actions that can be taken on task.

availableCommands.directCommands

It contains all route actions that are available for a task.

availableCommands.taskACLCommands

It contains commands like forward, share and consult if available for a task.

availableCommands.otherCommands

It contains commands like lock, unlock, abandon, return, claim, and so on as available.

processInstanceInfo

It contains information about task's process instance.

processVariables

It contains array of objects of process variables if present.

pendingTasks

It contains list of pending tasks for the task's process instance.

userActions

It is array of objects. Each object contains details about route and its corresponding confirmation message if present.

dataUrl

It is url for the data of the form of a task.

externalAppConfig

This is configuration for third-party application forms.

submitted

True if task is submitted.

attachments

List of attachment for a task.

assignments

List of assignments of a task.

Filter

Filter is basically queue of user or group. When a task is assigned to user/group, the task is added in corresponding queue.

Property

Client Only

Comments

isDefault

True if queue is default queue of the logged in user, else false.

name

Name of the owner of the queue.

qid

Id of the queue.

type

It contains type of the queue.
0 - User queue.
1. Shared Queue.
2. Group Queue.

query

This contains query associated with a filter. This query is used to search tasks from complete tasklist.

tasks

It contains list of all tasks that belongs to a filter.

Out-of-Office

You can manage your out-of-office schedule and control the flow of tasks assigned to you in your absence.

Property

Client Only

Comments

dateRanges

It contains array objects of out-of-office schedules of a user. In each schedule object, startDate field contains schedule's start date andendDate field contains schedule's end date. If endDate is null in schedule, it implies that user has not scheduled the end date of out-of-office schedule.

isNoPrimaryDesignate

True if there is no primary designate in case if user is out-of-office.

isOutOfOffice

True if user is out-of-office.

outOfOfficeDesignate

It contains details of user who is assigned as primary designate by user.

processSpecificDesignates

It contains array of objects for process-specific out-of-office designate. In each process-specific designate object, processName contains the name of the process, isNotDesignated is true if no user is assigned for corresponding process, and userDesignated is null if no user assigned else details of the user assigned for corresponding process.

processes

It contains a list of all processes that are available to the user.

initialOutOfOfficeSettings

It contains initial out-of-office settings of user which are fetched initially.

outOfOfficeSettings

It contains modified out-of-office settings.

userSearchHistory

It contains list of users which are searched by logged in user till date.

Process Instance

A process instance is created when a process is invoked via workspace or workbench.

Property

Client Only

Comments

description

Description of process instance

initiator

Name of initiator of a process instance.

initiatorId

ID of initiator of process instance.

processCompleteTime

Time stamp when process completed.

processInstanceId

ID of process instance.

processInstanceStatus

0 = Initiated
1 = Running
2 = Complete
3 = Completing
4 = Terminated
5 = Terminating
6 = Suspended
7 = Suspending
8 = Unsuspending

processName

Name of the process.

processStartTime

Time stamp when process started.

processVariables

Array of objects of process variables. Each process variable object contains name which is name of process variable, value which is value of process variable and type which is type of process variable.

tasklist

Tasks generated by this process instance.

Process Name

Property

Client Only

Comments

processMajorVersion

Major version of a process.

processMinorVersion

Minor version of a process.

processName

Name of the process.

processTitle

Title of the process.

processInstanceList

List of process instances for this process.

Task Assignment Object

Task assignment object contains information about the assignment of task. Following are the properties of task’s assignment.

Property

Client Only

Comments

assignmentCreateTime

Time stamp when this assignment of a task is created.

assignmentType

0 = Initial Assignment
1 = Forward (Task has been forwarded to current owner of task.)
2 = Returned (Task has been returned to current owner of task by previous owner of task.)
3 = Claimed (Task has been claimed by current owner of task.)
4 = Escalation (Task has been assigned to current owner of task after escalation.)
5 = Administrator Assigned (Task has been assigned by administrator to current owner of task.)
6 = Consulted ( Task has been consulted to current owner of task.)

assignmentUpdateTime

Time stamp when this assignment of a task is updated.

queueId

ID of Queue of current owner of task.

queueOwner

Name of current owner of task.

queueOwnerId

ID of current owner of task.

Task ACL Object

Task ACL object contains information about permissions like forward, share, consult etc. of a task. Following are the properties of task’s ACL.

Property

Client Only

Comments

canAddAttachments

If true, attachments can be added to task.

canAddNotes

If true, notes can be added to task.

canClaim

If true, task can be claimed.

canConsult

If true, task can be consulted.

canForward

If true, task can be forwarded.

canShare

If true, task can be shared.

Task Attachment

Attachments can be added to a task. Attachment can be of type attachment and note. Following are the properties of attachment object.

Property

Client Only

Comments

creationDate

Time stamp when attachment created.

creatorId

ID of user who added the attachment.

creatorName

Name of the user who added the attachment.

description

Description of the attachment.

fileName

Name of attachment.

ID of attachment.

lastModifiedDate

Time stamp when attachment last modified.

noteExtended

If true, note is an extended (long) note.

permissions

Permissions associated with an attachment. allowRead field is for read permission, allowWrite is for write permission, allowDelete is for delete permission.

size

Size of the attachment in bytes.

taskId

ID of task to which attachment is added.

type

Type is attachment for files and Type is note for notes.

formattedCreationDate

It contains attachment creation date according to user's UI settings.

formattedDescription

Formatted Attachment description. Used to display special characters present in attachment description in AEM Forms workspace.

formattedFileName

Formatted Attachment Name. Used to display special characters present in attachment name in AEM Forms workspace. This is for notes only.

User

Following are the properties of user object.

Property

Client Only

Comments

address

Address of the user.

commonName

Common name of the user.

description

Description of the user.

directGroupMemberships

List of user’s group.

displayName

Display name of the user.

Email ID of the user.

isOutOfOffice

True if user is out-of-office.

lastName

Last name of the user.

firstName

First name of the user.

oid

ID of the user.

org

Name of organization of the user.

postalAddress

Postal address of the user.

telephone

Contact number of the user.

telephoneNumber

Contact number of the user.

userid

recommendation-more-help

a6ebf046-2b8b-4543-bd46-42a0d77792da