文档AEM 6.4Forms 指南

AEM Forms工作区JSON对象描述 aem-forms-workspace-json-object-description

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

创建对象：

  • 用户
CAUTION
AEM 6.4已结束扩展支持，本文档将不再更新。 有关更多详细信息，请参阅 技术支助期. 查找支持的版本 此处.

AEM Forms工作区中使用的JSON对象如下所述。

  1. 类别

    工作区的开始流程选项卡中存在类别。 这些类别用于对起点进行分类。

属性
仅限客户端
评论
name
F
类别名称
id
F
类别ID
说明
F
类别描述
parentOid
F
包含父类别的oid
startPointsList
T
包含类别中存在的所有起点的列表
categoryList
T
包含类别的直接子类别列表
NOTE
所有“起点”和“收藏夹”都是在客户端定义的类别。 收藏夹类别包含用户标记为收藏的所有起点。 所有起点类别包含所有起点。

  1. 起点

    调用时，起点用于从工作区启动进程。

    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
    属性 仅限客户端 评论
    categoryId F 它包含起点所属类别的ID。
    说明 F 它包含起点的描述。
    name F 它包含起点的名称。
    serializedImageTicket F 它包含与起始点对应的图像票证。 此图像票证用于起始点的imageUrl字段，以从服务器获取起始点的图像。
    serviceName F 它包含起点的服务名称。
    startpointId F 它包含起始点的ID。
    isFavorite T 表示起点是否为收藏。 如果起点是收藏，则为True；否则为False。
    isDefaultImage T 指示是否指定了处理映像。 如果没有与进程else关联的图像，则为true。
    任务 T 它包含在调用起始点时创建的任务。
    imageUrl T 它包含与起始点对应的图像的URL。

  2. 任务

    任务被分配给用户/组，并包括可填充数据的用户界面(表单或指南（已弃用）)。 为用户分配任务后，他们将获得填写和提交的表单或指南。

属性
仅限客户端
评论
classOfTask
F
任务类为“LC8”，而任务为“lc8”，任务为“标准”。
completeTime
F
任务完成时包含时间戳。
consultGroupId
F
它包含可咨询任务的组的ID。 在过程设计过程中设置。
createTime
F
它包含创建任务时的时间戳。
creationId
F
它包含创建任务的用户ID。
currentAssignment
F
它包含有关当前任务分配的详细信息。
截止时间
F
它包含任务到达其截止时间的时间戳。
说明
F
它包含任务的描述。
displayName
F
它包含任务的显示名称。
forwardGroupId
F
它包含可将任务转发到的组的ID。 在过程设计过程中设置。
说明
F
它包含任务的说明。
isLocked
F
如果任务已锁定，则为True。
isMustOpenToComplete
F
如果必须打开任务表单才能完成任务，则为true。
isOpenFullScreen
F
如果为true，则在打开任务时，表单会首次显示完整屏幕。
isRouteSelectionRequired
F
如果为true，则必须选择路由以完成任务。
isShowAttachments
F
如果为true，则会显示附件。
isStartTask
F
如果为true，则从起始点创建任务。
isVisible
F
如果任务在工作区中可见，则为true。
nextReminder
F
下次提醒的时间戳。
优先级
F
它包含任务的优先级。
1 =最高优先级
2 =高优先级
3 =正常优先级
4 =低优先级
5 =最低优先级
processInstanceId
F
任务所属的进程实例的ID。
processInstanceStatus
F
任务的进程实例的状态。
reminderCount
F
它包含任务的提醒计数。
routeList
F
它包含与任务关联的路由列表。 用户可以通过从路由列表中选择路由中的任意一条来完成任务。
selectedRoute
F
它包含任务完成时所选路由的名称。
serializedImageTicket
F
它包含与任务对应的图像票证。 此图像票证用于任务的imageUrl字段，用于从服务器获取任务的图像。
serviceName
F
它包含任务的服务名称。
serviceTitle
F
它包含任务的服务标题。
状态
F
1 =已创建（任务从起始点创建。）
2 =已创建并保存（任务从起始点创建并保存。）
3 =已分配（进程启动后，会将任务分配给用户。）
4 =已分配并保存（任务已分配并保存。）
100 =已完成（任务已完成。）
101 =无效（任务已到期。）
102 =终止
stepName
F
它包含在流程设计期间的任务集名称。
summaryUrl
F
它包含任务摘要url。
taskACL
F
它是任务的访问控制列表。
taskId
F
任务的ID。
updateTime
F
上次更新任务时的时间戳。
formUrl
T
它包含任务的表单URL。
taskFormType
T
它包含任务表单类型。 使用此字段，任务在客户端上以pdf格式呈现，如swf表单等。
showDirectActions
T
如果为true，则在工作区中可看到路由操作。
showACLAactions
T
如果为true，则在工作区中会显示诸如转发、查阅、共享等操作。
supportsOffline
T
如果为true，则表单可脱机。 这仅适用于pdf表单。
supportsSave
T
如果为true，则用户可以保存任务。
readerSubmitOptions
T
此对象包含用于通过阅读器提交pdf表单的选项，以防pdf表单不包含提交按钮。
isDefaultImage
T
指示是否指定了处理映像。 如果没有与进程else关联的图像，则为true。
historyTaskList
T
它包含任务详细信息历史记录选项卡中使用的任务列表。
isOwner
T
如果已登录的用户是任务的所有者，则为True。
availableCommands
T
它包含可对任务执行的所有操作。
availableCommands.directCommands
T
它包含可用于任务的所有路由操作。
availableCommands.taskACLCommands
T
它包含转发、共享和查询等命令（如果可用于任务）。
availableCommands.otherCommands
T
它包含锁定、解锁、放弃、返回、声明等可用命令。
processInstanceInfo
T
它包含有关任务的进程实例的信息。
processVariables
T
它包含进程变量对象数组（如果存在）。
pendingTasks
T
它包含任务进程实例的待处理任务列表。
userActions
T
它是对象数组。 每个对象都包含有关路由及其相应确认消息的详细信息（如果存在）。
dataUrl
T
它是任务形式数据的url。
externalAppConfig
T
这是第三方应用程序表单的配置。
已提交
T
如果提交了任务，则为true。
附件
T
任务的附件列表。
个指定任务
T
任务的分配列表。

  1. 过滤器

    过滤器基本上是用户或组的队列。 将任务分配给用户/组后，该任务会添加到相应的队列中。

属性
仅限客户端
评论
isDefault
F
如果队列是已登录用户的默认队列，则为True；否则为False。
name
F
队列所有者的名称。
qid
F
队列的ID。
类型
F
它包含队列的类型。
0 — 用户队列。
1. 共享队列。
2. 组队列。
查询
T
此变量包含与过滤器关联的查询。 此查询用于从完整任务列表中搜索任务。
任务
T
它包含属于某个过滤器的所有任务的列表。

  1. 不在办公室

    您可以管理您的离职计划，并控制在您缺勤时分配给您的任务流。

属性
仅限客户端
评论
dateRanges
F
它包含用户不在办公室的计划的数组对象。 在每个计划对象中， startDate字段包含计划的开始日期，dendDate字段包含计划的结束日期。 如果计划中的endDate为null，则意味着用户尚未计划离职计划的结束日期。
isNoPrimaryDesignate
F
如果用户不在办公室，则没有主要指定项，则为true。
isOutOfOffice
F
如果用户不在办公室，则为true。
outOfficeDesignate
F
其中包含被用户指定为主要指定的用户的详细信息。
processSpecificDisigns
F
它包含特定于进程的“不在办公室”指定对象的数组。 在每个特定于进程的指定对象中，processName包含进程的名称；如果没有为相应进程分配用户，则isNotDesignated为true；如果没有为相应进程分配用户的详细信息，则userDesignated为null。
流程
T
它包含用户可用的所有进程的列表。
initialOutOfficeSettings
T
它包含最初获取的用户的初始不在办公室设置。
outOfOfficeSettings
T
它包含已修改的“不在办公室”设置。
userSearchHistory
T
它包含登录用户在日期之前搜索的用户列表。

  1. 进程实例

    通过工作区或工作台调用进程时，会创建进程实例。

属性
仅限客户端
评论
说明
F
流程实例的描述
发起者
F
进程实例的启动器名称。
initiatorId
F
进程实例的启动器ID。
processCompleteTime
F
进程完成时的时间戳。
processInstanceId
F
进程实例的ID。
processInstanceStatus
F
0 =已启动
1 =正在运行
2 =完成
3 =完成
4 =终止
5 =终止
6 =暂停
7 =暂停
8 =取消暂停
processName
F
进程的名称。
processStartTime
F
进程启动时的时间戳。
processVariables
F
进程变量对象数组。 每个进程变量对象都包含进程变量名称、进程变量值和进程变量类型。
任务列表
T
由此进程实例生成的任务。
  1. 进程名称
属性
仅限客户端
评论
processMajorVersion
F
流程的主要版本。
processMinorVersion
F
流程的次要版本。
processName
F
进程的名称。
processTitle
F
流程的标题。
processInstanceList
T
此进程的进程实例列表。

  1. 任务分配对象

    任务分配对象包含有关任务分配的信息。 以下是任务分配的属性。

属性
仅限客户端
评论
assignmentCreateTime
F
创建此任务分配时的时间戳。
assignmentType
F
0 =初始分配
1 =转发（任务已转发给当前任务所有者。）
2 =已返回（任务的先前所有者已将任务返回给当前任务所有者。）
3 =已声明（任务的当前所有者已声明任务。）
4 =呈报（呈报后已将任务分配给当前任务所有者。）
5 =已分配管理员（管理员已将任务分配给当前任务所有者。）
6 =已咨询（已咨询任务的当前所有者。）
assignmentUpdateTime
F
更新任务分配时的时间戳。
queueId
F
任务当前所有者的队列的ID。
queueOwner
F
任务的当前所有者的名称。
queueOwnerId
F
任务当前所有者的ID。

  1. 任务ACL对象

    任务ACL对象包含有关权限（如转发、共享、查阅等）的信息。 任务的一部分。 以下是任务ACL的属性。

属性
仅限客户端
评论
canAddAttachments
F
如果为true，则可以将附件添加到任务中。
canAddNotes
F
如果为true，则可向任务添加注释。
canClaim
F
如果为true，则可声明任务。
canConsult
F
如果是真的，可以咨询任务。
canForward
F
如果为true，则可以转发任务。
canShare
F
如果为true，则可以共享任务。

  1. 任务附件

    可以将附件添加到任务中。 附件可以是附件和注释类型。 以下是附件对象的属性。

属性
仅限客户端
评论
creationDate
F
创建附件时的时间戳。
creatorId
F
添加附件的用户ID。
creatorName
F
添加附件的用户的名称。
说明
F
附件的描述。
fileName
F
附件的名称。
id
F
附件的ID。
lastModifiedDate
F
上次修改附件时的时间戳。
noteExtended
F
如果为true，则注释为扩展（长）注释。
权限
F
与附件关联的权限。 allowRead字段用于读取权限，allowWrite用于写入权限，allowDelete用于删除权限。
大小
F
附件的大小（以字节为单位）。
taskId
F
添加了附件的任务的ID。
类型
F
“类型”(Type)是文件的附件，“类型”(Type)是注释的注释。
formattedCreationDate
T
它包含根据用户UI设置创建附件的日期。
formattedDescription
T
带格式的附件描述。 用于在AEM Forms工作区中显示附件描述中存在的特殊字符。
formattedFileName
T
带格式的附件名称。 用于在AEM Forms工作区中显示附件名称中存在的特殊字符。 这仅供参考。

  1. 用户

    以下是用户对象的属性。

属性
仅限客户端
评论
地址
F
用户的地址。
commonName
F
用户的通用名称。
说明
F
用户的描述。
directGroupMemberships
F
用户群组的列表。
displayName
F
用户的显示名称。
email
F
用户的电子邮件ID。
isOutOfOffice
F
如果用户不在办公室，则为true。
lastName
F
用户的姓氏。
firstName
F
用户的名字。
oid
F
用户的ID。
org
F
用户的组织名称。
postalAddress
F
用户的邮政地址。
电话
F
用户的联系电话。
电话号码
F
用户的联系电话。
userid
F
登录用户的id。
recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da