AEM Forms workspace JSON object description
Last update: June 24, 2024
- Applies to:
- Experience Manager 6.5
CREATED FOR:
- Admin
- User
- Developer
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 | F | Category name |
| id | F | Category ID |
| description | F | Category description |
| parentOid | F | Contains oid of parent category |
| startPointsList | T | Contains list of all startpoints present in a category |
| categoryList | T | Contains list of direct child categories of a category |
NOTEAll 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.
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 | F | Class of task is 'LC8' when task is lc8 task else 'Standard'. |
| completeTime | F | It contains the time stamp when task is completed. |
| consultGroupId | F | It contains ID of a group to which task can be consulted. It is set during the process designing. |
| createTime | F | It contains the time stamp when task is created. |
| creationId | F | It contains the id of the user who created the task. |
| currentAssignment | F | It contains details about current assignment of task. |
| deadline | F | It contains the time stamp that when a task will reach its deadline. |
| description | F | It contains description of the task. |
| displayName | F | It contains display name of the task. |
| forwardGroupId | F | It contains ID of a group to which task can be forwarded. It is set during the process designing. |
| instructions | F | It contains instructions for a task. |
| isLocked | F | True if task is locked. |
| isMustOpenToComplete | F | True if task form must be opened to complete the task. |
| isOpenFullScreen | F | If true, on opening the task, form takes complete screen first time. |
| isRouteSelectionRequired | F | If true, route must be selected to complete the task. |
| isShowAttachments | F | Attachments are shown if it is true. |
| isStartTask | F | If true, task is created from start point. |
| isVisible | F | True if task is visible in workspace. |
| nextReminder | F | Time stamp for the next reminder. |
| priority | F | It contains priority of task. 1 = Highest priority 2 = High Priority 3 = Normal Priority 4 = Low Priority 5 = Lowest Priority |
| processInstanceId | F | Id of the process instance of which task is part. |
| processInstanceStatus | F | Status of task's process instance. |
| reminderCount | F | It contains count of reminders for the task. |
| routeList | F | It contains list of routes associated with task. User can complete the task by selecting any one of the route from route list. |
| selectedRoute | F | It contains name of the route selected when task was completed. |
| serializedImageTicket | F | 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 | F | It contains name of the service for task. |
| serviceTitle | F | It contains title of the service for task. |
| status | F | 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 | F | It contains name of the task set during process designing. |
| summaryUrl | F | It contains task summary url. |
| taskACL | F | It is access control list for a task. |
| taskId | F | Id of a task. |
| updateTime | F | Time stamp when task was last updated. |
| formUrl | T | It contains url of form for a task. |
| taskFormType | T | It contains task form type. Using this field, task is rendered on client as pdf for, swf form, and so on. |
| showDirectActions | T | If true, route actions are visible in workspace. |
| showACLActions | T | If true, actions like forward, consult, share are visible in workspace. |
| supportsOffline | T | If true, form can be taken offline. This is for pdf forms only. |
| supportsSave | T | If true, user can save task. |
| readerSubmitOptions | T | This object contains options which are used to submit pdf forms via reader in case when pdf form contains no submit button. |
| isDefaultImage | T | Denotes whether there is an image specified for process or not. True if there is no image associated with process else false. |
| historyTaskList | T | It contains list of tasks which are used in history tab of task details. |
| isOwner | T | True if logged in user is owner of task. |
| availableCommands | T | It contains all actions that can be taken on task. |
| availableCommands.directCommands | T | It contains all route actions that are available for a task. |
| availableCommands.taskACLCommands | T | It contains commands like forward, share and consult if available for a task. |
| availableCommands.otherCommands | T | It contains commands like lock, unlock, abandon, return, claim, and so on, as available. |
| processInstanceInfo | T | It contains information about task's process instance. |
| processVariables | T | It contains array of objects of process variables if present. |
| pendingTasks | T | It contains list of pending tasks for the task's process instance. |
| userActions | T | It is array of objects. Each object contains details about route and its corresponding confirmation message if present. |
| dataUrl | T | It is url for the data of the form of a task. |
| externalAppConfig | T | This is configuration for third-party application forms. |
| submitted | T | True if task is submitted. |
| attachments | T | List of attachment for a task. |
| assignments | T | 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 | F | True if queue is default queue of the logged in user, else false. |
| name | F | Name of the owner of the queue. |
| qid | F | Id of the queue. |
| type | F | It contains type of the queue. 0 - User queue. 1. Shared Queue. 2. Group Queue. |
| query | T | This contains query associated with a filter. This query is used to search tasks from complete tasklist. |
| tasks | T | 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 | F | 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 | F | True if there is no primary designate in case if user is out-of-office. |
| isOutOfOffice | F | True if user is out-of-office. |
| outOfOfficeDesignate | F | It contains details of user who is assigned as primary designate by user. |
| processSpecificDesignates | F | 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 | T | It contains a list of all processes that are available to the user. |
| initialOutOfOfficeSettings | T | It contains initial out-of-office settings of user which are fetched initially. |
| outOfOfficeSettings | T | It contains modified out-of-office settings. |
| userSearchHistory | T | It contains a list of users that are searched by a logged in user until date. |
-
Process Instance
A process instance is created when a process is invoked via workspace or workbench.
| Property | Client Only | Comments |
| description | F | Description of process instance |
| initiator | F | Name of initiator of a process instance. |
| initiatorId | F | ID of initiator of process instance. |
| processCompleteTime | F | Time stamp when process completed. |
| processInstanceId | F | ID of process instance. |
| processInstanceStatus | F | 0 = Initiated 1 = Running 2 = Complete 3 = Completing 4 = Terminated 5 = Terminating 6 = Suspended 7 = Suspending 8 = Unsuspending |
| processName | F | Name of the process. |
| processStartTime | F | Time stamp when process started. |
| processVariables | F | 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 | T | Tasks generated by this process instance. |
- Process Name
| Property | Client Only | Comments |
| processMajorVersion | F | Major version of a process. |
| processMinorVersion | F | Minor version of a process. |
| processName | F | Name of the process. |
| processTitle | F | Title of the process. |
| processInstanceList | T | 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 | F | Time stamp when this assignment of a task is created. |
| assignmentType | F | 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 | F | Time stamp when this assignment of a task is updated. |
| queueId | F | ID of Queue of current owner of task. |
| queueOwner | F | Name of current owner of task. |
| queueOwnerId | F | ID of current owner of task. |
-
Task ACL Object
Task ACL object contains information about permissions like forward, share, consult, and so on, of a task. Following are the properties of task’s ACL.
| Property | Client Only | Comments |
| canAddAttachments | F | If true, attachments can be added to task. |
| canAddNotes | F | If true, notes can be added to task. |
| canClaim | F | If true, task can be claimed. |
| canConsult | F | If true, task can be consulted. |
| canForward | F | If true, task can be forwarded. |
| canShare | F | 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 | F | Time stamp when attachment created. |
| creatorId | F | ID of user who added the attachment. |
| creatorName | F | Name of the user who added the attachment. |
| description | F | Description of the attachment. |
| fileName | F | Name of attachment. |
| id | F | ID of attachment. |
| lastModifiedDate | F | Time stamp when attachment last modified. |
| noteExtended | F | If true, note is an extended (long) note. |
| permissions | F | Permissions associated with an attachment. allowRead field is for read permission, allowWrite is for write permission, allowDelete is for delete permission. |
| size | F | Size of the attachment in bytes. |
| taskId | F | ID of task to which attachment is added. |
| type | F | Type is attachment for files and Type is note for notes. |
| formattedCreationDate | T | It contains attachment creation date according to user's UI settings. |
| formattedDescription | T | Formatted Attachment description. Used to display special characters present in attachment description in AEM Forms workspace. |
| formattedFileName | T | 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 | F | Address of the user. |
| commonName | F | Common name of the user. |
| description | F | Description of the user. |
| directGroupMemberships | F | List of user's group. |
| displayName | F | Display name of the user. |
| F | Email ID of the user. | |
| isOutOfOffice | F | True if user is out-of-office. |
| lastName | F | Last name of the user. |
| firstName | F | First name of the user. |
| oid | F | ID of the user. |
| org | F | Name of organization of the user. |
| postalAddress | F | Postal address of the user. |
| telephone | F | Contact number of the user. |
| telephoneNumber | F | Contact number of the user. |
| userid | F | Log in id of the user. |
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2