文档AEM 6.5用户指南

AEM Forms工作区JSON对象说明 aem-forms-workspace-json-object-description

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 管理员
  • 用户
  • 开发人员

下面介绍了AEM Forms工作区中使用的JSON对象。

  1. 类别

    类别显示在工作区的启动进程选项卡中。 这些类别用于对起点进行分类。

属性
仅限客户端
评论
name
周五
类别名称
id
周五
类别ID
描述
周五
类别描述
parentOid
周五
包含父类别
的oid
startPointsList
周二
包含某个类别中存在的所有起点的列表
categorylist
周二
包含类别
的直接子类别的列表
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 周五 它包含起点所属类别的ID。
    说明 周五 它包含对起点的描述。
    name 周五 它包含起点的名称。
    serializedImageTicket 周五 它包含与起点对应的图像票证。 此图像票证用在起点的imageUrl字段中，用于从服务器获取起点的图像。
    serviceName 周五 它包含起点服务的名称。
    startpointId 周五 它包含起点ID。
    isFavorite 周二 指示起点是否为常用起点。 如果起点为最喜爱则为真，否则为假。
    isDefaultImage 周二 表示是否为进程指定了图像。 如果没有与进程关联的图像，则为true，否则为false。
    任务 周二 它包含调用起点时创建的任务。
    imageUrl 周二 它包含对应于起点的图像的URL。

  2. 任务

    任务被分配给用户/组，并包括可以使用数据填充的用户界面 — 表单或指南（已弃用）。 当用户被分配任务时，将为他们提供完成和提交的表单或指南。

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

  1. 过滤器

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

属性
仅限客户端
评论
isDefault
周五
如果队列是登录用户的默认队列，则为true，否则为false。
名称
周五
队列所有者的名称。
qid
周五
队列的ID。
类型
周五
它包含队列的类型。
0 — 用户队列。
1. 共享队列。
2. 组队列。
查询
周二
这包含与筛选器关联的查询。 此查询用于从完整任务列表中搜索任务。
任务
周二
它包含属于某个筛选器的所有任务的列表。

  1. 外出

    您可以管理“不在办公室”日程安排，并在您不在时控制分配给您的任务流。

属性
仅客户端
个评论
日期范围
周五
它包含用户的外出时间表的数组对象。 在每个计划对象中，startDate字段包含计划的开始日期，而dendDate字段包含计划的结束日期。 如果计划中的endDate为null，则表示用户尚未计划外出计划的结束日期。
isNoPrimaryDecision
周五
如果用户不在办公室，则没有主指定。
isOutOfOffice
周五
如果用户不在办公室，则为True。
outOfOfficeIdentigate
周五
它包含被用户指定为主指定的用户的详细信息。
processSpecificDesignates
周五
它包含用于特定于进程的“不在办公室”指定的对象数组。 在每个特定于进程的指定对象中，processName包含进程的名称，如果没有为相应的进程分配用户，则isNotDesigned为true；如果没有为相应的进程分配用户的其他详细信息，则userDesigned为null。
进程
周二
它包含用户可用的所有进程的列表。
initialOutOfOfficeSettings
周二
它包含最初获取的用户初始外出设置。
outOfOfficeSettings
周二
它包含已修改的邮件答录机设置。
userSearchHistory
周二
它包含由登录用户搜索直到日期的用户的列表。

  1. 流程实例

    当通过工作区或工作台调用流程时，将创建一个流程实例。

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

  1. 任务分配对象

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

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

  1. 任务ACL对象

    任务ACL对象包含有关任务的转发、共享、咨询等权限的信息。 以下是任务ACL的属性。

属性
仅限客户端
评论
canAddAttachments
周五
如果为true，则可以将附件添加到任务中。
canAddNotes
周五
如果为true，则可以将备注添加到任务中。
canClaim
周五
如果为true，则表示可以声明任务。
canConsult
周五
如果为true，则可以查阅任务。
canForward
周五
如果为true，则任务可以转发。
canShare
周五
如果为true，则任务可以共享。

  1. 任务附件

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

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

  1. 用户

    以下是用户对象的属性。

属性
仅限客户端
评论
地址
周五
用户的地址。
commonName
周五
用户的公用名。
描述
周五
用户的描述。
directGroupMemberships
周五
用户组的列表。
displayName
周五
用户的显示名称。
电子邮件
周五
用户的电子邮件ID。
isOutOfOffice
周五
如果用户不在办公室，则为True。
姓氏
周五
用户的姓氏。
名字
周五
用户的名字。
oid
周五
用户的ID。
组织
周五
用户的组织名称。
postalAddress
周五
用户的邮政地址。
电话
周五
用户的联系电话。
telephoneNumber
周五
用户的联系电话。
用户ID
周五
用户的登录ID。
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2