文件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)

建立對象：

  • User
CAUTION
AEM 6.4已結束延伸支援，本檔案不再更新。 如需詳細資訊，請參閱 技術支援期. 尋找支援的版本 此處.

AEM Forms工作區中使用的JSON物件說明如下。

  1. 類別

    工作區的「開始進程」(start process)頁簽中存在類別。 這些類別用於分類起始點。

屬性
僅客戶端
評論
名稱
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 它包含起始點的說明。
    名稱 F 它包含起始點的名稱。
    serializedImageTicket F 它包含與起始點對應的影像票證。 此映像票證用於起始點的imageUrl欄位，以從伺服器獲取起始點的映像。
    serviceName F 它包含起始點服務的名稱。
    startpointId F 它包含起始點的id。
    isFavorite T 表示起始點是否為收藏夾。 如果起始點是收藏夾，則為true，否則為false。
    isDefaultImage T 表示是否為進程指定了映像。 如果沒有與進程相關聯的影像，則返回true；否則返回false。
    任務 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。
nextTimmer
F
下次提醒的時間戳。
優先順序
F
它包含任務的優先順序。
1 =最高優先順序
2 =高優先順序
3 =正常優先順序
4 =低優先順序
5 =最低優先順序
processInstanceId
F
任務所屬的進程實例的ID。
processInstanceStatus
F
任務的進程實例的狀態。
menternCount
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
表示是否為進程指定了映像。 如果沒有與進程相關聯的影像，則返回true；否則返回false。
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。
名稱
F
隊列所有者的名稱。
qid
F
隊列的ID。
類型
F
它包含佇列的類型。
0 — 使用者佇列。
1. 共用佇列。
2. 組隊列。
查詢
T
這包含與篩選器相關聯的查詢。 此查詢用於從完整任務清單中搜索任務。
任務
T
它包含屬於篩選器的所有任務的清單。

  1. 外部

    您可以管理離職時間表，並控制在您缺勤時分配給您的任務流。

屬性
僅客戶端
評論
dateRanges
F
它包含使用者不在辦公室的排程的陣列物件。 在每個計畫對象中， startDate欄位包含計畫的開始日期和dendDate欄位包含計畫的結束日期。 如果排程中的endDate為null，表示使用者尚未排程離職排程的結束日期。
isNoPrimaryDesignate
F
若使用者不在辦公室，則沒有主要指定值，則為true。
isOutOfOffice
F
如果使用者不在辦公室，則為true。
outOfOfficeDesignate
F
它包含被用戶指定為主要指定的用戶的詳細資訊。
processSpecificDistant
F
它包含特定於進程的離職指定的對象陣列。 在每個特定於進程的指定對象中，processName包含進程的名稱；如果未為相應進程分配用戶，則isNotDesignated為true；如果未為相應進程分配用戶的其他詳細資訊，則userDesignated為null。
流程
T
它包含用戶可用的所有進程的清單。
initialOutOfOfficeSettings
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
「類型」是檔案的附件，「類型」是注釋的注釋。
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
使用者的組織名稱。
郵遞區號
F
使用者的郵遞區號。
電話
F
用戶的聯繫電話。
電話號碼
F
用戶的聯繫電話。
userid
F
登入使用者的id。
recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da