AEM Forms Workspace JSON オブジェクトの詳細

注意

AEM 6.4 の拡張サポートは終了し、このドキュメントは更新されなくなりました。 詳細は、 技術サポート期間. サポートされているバージョンを見つける ここ.

AEM Forms Workspace で使用される JSON オブジェクトを以下に示します。

  1. カテゴリ

    カテゴリは、ワークスペースの「開始プロセス」タブに表示されます。 これらのカテゴリは、スタートポイントを分類するために使用されます。

プロパティ クライアントのみ コメント
name F カテゴリ名
id F カテゴリ ID
説明
 F カテゴリの説明
parentOid
 F 親カテゴリの oid を含む
startPointsList
 T カテゴリに存在するすべての開始点のリストが含まれます
categoryList T カテゴリの直接の子カテゴリのリストが含まれます
メモ

すべてのスタートポイントとお気に入りは、クライアント側で定義されるカテゴリです。 お気に入りのカテゴリには、ユーザーがお気に入りに登録したすべての開始点が含まれます。 すべての開始点カテゴリには、すべての開始点が含まれます。

  1. 開始点

    開始点は、起動時にワークスペースからプロセスを開始するために使用されます。

    プロパティ クライアントのみ コメント
    categoryId F スタートポイントが属するカテゴリの ID が含まれます。
    description F スタートポイントの説明が含まれます。
    name 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 タスクの現在の割り当てに関する詳細が含まれます。
deadline
 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 を指定すると、タスクが Workspace に表示されます。
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 タスクのサービスのタイトルが含まれます。
status
 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 の場合、ルートアクションは Workspace に表示されます。
showACLActions
 T true の場合、forward、consult、share などのアクションが Workspace に表示されます。
supportsOffline
 T true の場合、フォームはオフラインにできます。 これは、PDF フォームに対してのみ使用されます。
supportsSave
 T true の場合、ユーザーはタスクを保存できます。
readerSubmitOptions
 T このオブジェクトには、PDF フォームに送信ボタンがない場合に Reader で PDF フォームを送信するためのオプションが含まれています。
isDefaultImage
 T プロセスに対してイメージが指定されているかどうかを示します。 プロセスに画像が関連付けられていない場合は true 、それ以外の場合は false です。
historyTaskList
 T タスクの詳細の「履歴」タブで使用されるタスクのリストが含まれます。
isOwner
 T ログインしたユーザーがタスクの所有者である場合は True です。
availableCommands
 T タスクに対して実行できるすべてのアクションが含まれます。
availableCommands.directCommands
 T タスクで使用可能なすべてのルートアクションが含まれます。
availableCommands.taskACLCommands
 T タスクに対して forward、share、consult などのコマンドが含まれます。
availableCommands.otherCommands
 T ロック、ロック解除、放棄、返却、要求などの使用可能なコマンドが含まれます。
processInstanceInfo
 T タスクのプロセスインスタンスに関する情報が含まれます。
processVariables
 T
 プロセス変数（存在する場合）のオブジェクトの配列が含まれます。
pendingTasks
 T タスクのプロセスインスタンスの保留中のタスクのリストが含まれます。
userActions
 T これはオブジェクトの配列です。 各オブジェクトには、ルートに関する詳細と、対応する確認メッセージ（存在する場合）が含まれます。
dataUrl
 T タスクのフォームのデータの URL です。
externalAppConfig
 T これは、サードパーティのアプリケーションフォームの設定です。
送信済み
 T タスクが送信された場合は True です。
attachments
 T タスクの添付ファイルのリスト。
割り当て
 T タスクの割り当てのリスト。

  1. フィルター

    フィルターは基本的にユーザーまたはグループのキューです。 タスクがユーザーまたはグループに割り当てられると、対応するキューにタスクが追加されます。

プロパティ クライアントのみ コメント
isDefault
F キューがログインユーザーのデフォルトのキューの場合は true、そうでない場合は false です。
name
 F キューの所有者の名前。
qid F キューの ID。
type F キューのタイプが含まれます。
0 — ユーザーキュー。
1.共有キュー.
2.グループキュー。
クエリ T フィルターに関連付けられたクエリが含まれます。 このクエリは、完全なタスクリストからタスクを検索するために使用されます。
タスク T フィルターに属するすべてのタスクのリストが含まれます。

  1. 不在

    不在スケジュールを管理し、不在時に割り当てられたタスクのフローを制御できます。

プロパティ
 クライアントのみ
 コメント
dateRanges
 F ユーザーの不在スケジュールの配列オブジェクトが含まれます。 各スケジュールオブジェクトには、startDate フィールドにスケジュールの開始日、endDate フィールドにスケジュールの終了日が含まれます。スケジュールの endDate が null の場合は、ユーザーが不在スケジュールの終了日をスケジュールしていないことを意味します。
isNoPrimaryDesignate
 F ユーザーが不在の場合に主な指定がない場合は true です。
isOutOfOffice
 F ユーザーが不在の場合は true です。
outOfOfficeDesignate
 F ユーザーによってプライマリ指定として割り当てられたユーザーの詳細が含まれます。
processSpecificDesignates
 F プロセス固有の不在時の指定用のオブジェクトの配列が含まれます。 各プロセス固有の指定のオブジェクトには、processName （プロセスの名前）、 isNotDesignated （ユーザーが対応するプロセスに割り当てられていない場合は true）、および userDesignated （ユーザーが割り当てられていない場合はヌルで、割り当てられている場合は対応するプロセスに割り当てられたユーザーの詳細）が含まれます。
プロセス
 T ユーザーが使用できるすべてのプロセスのリストが含まれます。
initialOutOfOfficeSettings
 T 最初に取得されたユーザーの不在時の初期設定が含まれます。
outOfOfficeSettings
 T 変更された不在時の設定が含まれます。
userSearchHistory
 T このリストには、ログインしたユーザーが日付まで検索したユーザーのリストが含まれます。

  1. プロセスインスタンス

    プロセスインスタンスは、プロセスが workspace または workbench を介して呼び出されると作成されます。

プロパティ クライアントのみ コメント
説明
 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 プロセス変数のオブジェクトの配列。 各プロセス変数オブジェクトは、name（プロセス変数の名前）、value（プロセス変数の値）、type（プロセス変数のタイプ）を含みます。
tasklist
 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 true の場合は、タスクを問い合わせることができます。
canForward
 F true の場合は、タスクを転送できます。
canShare
 F true の場合は、タスクを共有できます。

  1. タスクの添付ファイル

    タスクに添付ファイルを追加できます。 添付ファイルのタイプは添付ファイルとメモにすることができます。 次に、attachment オブジェクトのプロパティを示します。

プロパティ クライアントのみ コメント
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。
type
 F タイプは、ファイルの場合は attachment で、メモの場合は note です。
formattedCreationDate
 T ユーザーの UI 設定に応じて添付ファイルの作成日が含まれます。
formattedDescription
 T 書式付き添付ファイルの説明。 AEM Forms Workspace の添付ファイルの説明に存在する特殊文字を表示するために使用します。
formattedFileName
 T 書式付き添付ファイル名。 AEM Forms Workspace の添付ファイル名に存在する特殊文字を表示するために使用されます。 これはメモ用です。

  1. User

    次に、user オブジェクトのプロパティを示します。

プロパティ クライアントのみ コメント
住所
 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 ユーザーの連絡先番号。
telephoneNumber
 F ユーザーの連絡先番号。
userid
 F ユーザーのログイン ID。

このページ