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

AEM Forms Workspace で使用される JSON オブジェクトについて以下に説明します。

  1. カテゴリ

    カテゴリは、Workspace の「開始プロセス」タブにあります。これらのカテゴリは、スタートポイントを分類するのに使用されます。

プロパティ クライアントのみ コメント
name F カテゴリ名
id カテゴリ ID
description
カテゴリの説明
parentOid
親カテゴリの oid が含まれます
startPointsList
T カテゴリにあるすべてのスタートポイントのリストが含まれます
categoryList T カテゴリの直接の子カテゴリのリストが含まれます
メモ

「すべてのスタートポイント」および「お気に入り」は、クライアント側で定義されるカテゴリです。「お気に入り」カテゴリには、ユーザーがお気に入りのマークを付けたすべてのスタートポイントが含まれます。「すべてのスタートポイント」カテゴリには、すべてのスタートポイントが含まれます。

  1. スタートポイント

    スタートポイントは、呼び出された場合に Workspace からプロセスを開始するのに使用されます。

    プロパティ クライアントのみ コメント
    categoryId スタートポイントが属するカテゴリの ID が含まれます。
    description スタートポイントの説明が含まれます。
    名前 スタートポイントの名前が含まれます。
    serializedImageTicket スタートポイントに対応するイメージチケットが含まれます。この画像チケットは、サーバーからスタートポイントの画像を取得するために、スタートポイントの imageUrl フィールドで使用されます。
    serviceName スタートポイントのサービスの名前が含まれます。
    startpointId スタートポイントの ID が含まれます。
    isFavorite T スタートポイントがお気に入りであるかどうかを示します。スタートポイントがお気に入りである場合は true、そうでない場合は false です。
    isDefaultImage T プロセスに指定されたイメージがあるかどうかを示します。プロセスに関連付けられたイメージがない場合は true、ある場合は false です。
    タスク T スタートポイントが呼び出される際に作成されたタスクが含まれます。
    imageUrl T スタートポイントに対応するイメージの URL が含まれます。
  2. タスク

    タスクはユーザー / グループに割り当てられ、データを入力できるフォームまたは Guide (推奨されていません)のユーザーインターフェイスが含まれます。ユーザーにタスクが割り当てられると、完了して送信するためのフォームまたは Guide が提供されます。

プロパティ
クライアントのみ
コメント
classOfTask タスクが lc8 タスクの場合、タスクのクラスは「LC8」ですが、それ以外の場合は「標準」です。
completeTime
タスクが完了した時間のタイムスタンプが含まれます。
consultGroupId
タスクを問い合わせることができるグループの ID が含まれます。これは、プロセスのデザイン中に設定されます。
createTime
タスクが作成された時間のタイムスタンプが含まれます。
creationId
タスクを作成したユーザーの ID が含まれます。
currentAssignment
タスクの現在の割り当てに関する詳細が含まれます。
deadline
タスクがデッドラインに達する時間のタイムスタンプが含まれます。
説明
タスクの説明が含まれます。
displayName
タスクの表示名が含まれます。
forwardGroupId
タスクを転送することができるグループの ID が含まれます。これは、プロセスのデザイン中に設定されます。
instructions
タスクの手順が含まれます。
isLocked
タスクがロックされている場合は true です。
isMustOpenToComplete
タスクを完了するのにタスクフォームを開く必要がある場合は true です。
isOpenFullScreen
true の場合は、タスクを開くと、フォームは最初に全スクリーンで表示されます。
isRouteSelectionRequired
true の場合、タスクを完了するのにルートが選択されている必要があります。
isShowAttachments
true の場合は添付ファイルが表示されます。
isStartTask
true の場合、タスクはスタートポイントから作成されます。
isVisible
タスクが Workspace に表示されている場合は true です。
nextReminder
次のリマインダーのタイムスタンプです。
priority
タスクの優先度が含まれます。
1 = 最高の優先度
2 = 高い優先度
3 = 標準の優先度
4 = 低い優先度
5 = 最低の優先度
processInstanceId タスクの一部であるプロセスインスタンスの ID。
processInstanceStatus
タスクのプロセスインスタンスのステータス。
reminderCount
タスクのリマインダーの数が含まれます。
routeList
タスクに関連付けられたルートのリストが含まれます。ユーザーはルートリストからいずれかのルートを選択することによって、タスクを完了することができます。
selectedRoute
タスクが完了した場合に選択したルートの名前が含まれます。
serializedImageTicket
タスクに対応するイメージチケットが含まれます。このイメージチケットは、サーバーからタスクのイメージを取得するために、タスクの imageUrl フィールドで使用されます。

serviceName
タスクのサービスの名前が含まれます。
serviceTitle
タスクのサービスのタイトルが含まれます。
status
1 = 作成済み(タスクはスタートポイントから作成されました。)
2 = 作成して保存済み(タスクはスタートポイントから作成されて保存されました。)
3 = 割り当て済み(タスクはプロセスが開始された後でユーザーに割り当てられました。)
4 = 割り当てて保存済み(タスクは割り当てられて保存されました。)
100 = 完了(タスクは完了しました。)
101 = 期限切れ(タスクはデッドラインに達しました。)
102 = 終了
stepName
プロセスのデザイン中に設定されたタスクの名前が含まれます。
summaryUrl
タスクのサマリー URL が含まれます。
taskACL
タスクのアクセス制御リストです。
taskId
タスクの ID。
updateTime
タスクが最後に更新された時間のタイムスタンプ。
formUrl
T タスクのフォームの URL が含まれます。
taskFormType
T タスクのフォームタイプが含まれます。このフィールドを使用して、タスクはクライアントで PDF フォーム、SWF フォームなどにレンダリングされます。
showDirectActions
T true の場合、ルートアクションは Workspace に表示されます。
showACLActions
T true の場合、転送、問い合わせ、共有などのアクションは Workspace に表示されます。
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 サードパーティアプリケーションフォームの設定です。
submitted
T タスクが送信された場合は true です。
attachments
T タスクの添付ファイルのリスト。
assignments
T タスクの割り当てのリスト。
  1. フィルター

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

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

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

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

    プロセスインスタンスは、プロセスが Workspace または Workbench 経由で呼び出された場合に作成されます。

プロパティ クライアントのみ コメント
説明
プロセスインスタンスの説明
initiator プロセスインスタンスのイニシエーターの名前。
initiatorId プロセスインスタンスのイニシエーターの ID.
processCompleteTime
プロセスが完了したときのタイムスタンプ。
processInstanceId
プロセスインスタンスの ID.
processInstanceStatus
0 = 起動済み
1 = 実行中
2 = 完了
3 = 完了中
4 = 終了
5 = 終了中
6 = 休止
7 = 休止中
8 = 休止解除中
processName
プロセスの名前。
processStartTime
プロセスが開始したときのタイムスタンプ。
processVariables
プロセス変数のオブジェクトの配列。各プロセス変数オブジェクトには、プロセス変数の名前、プロセス変数の値、プロセス変数の型の値を含む名前が含まれます。
tasklist
T このプロセスインスタンスによって生成されたタスク。
  1. プロセス名
プロパティ クライアントのみ コメント
processMajorVersion
プロセスのメジャーバージョン。
processMinorVersion
プロセスのマイナーバージョン。
processName
プロセスの名前。
processTitle
プロセスのタイトル。
processInstanceList
T このプロセスのプロセスインスタンスのリスト。
  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
添付ファイルを追加したユーザーの名前。
説明
添付ファイルの説明。
fileName
添付ファイルの名前。
id
添付ファイルの ID。
lastModifiedDate
添付ファイルが最後に変更されたときのタイムスタンプ。
noteExtended
true の場合はメモは拡張された(長い)メモです。
権限
添付ファイルに関連付けられた権限。allowRead フィールドは読み取り権限用、 allowWrite は書き込み権限用、 allowDelete は削除権限用です。
サイズ
添付ファイルのサイズ(バイト)。
taskId
添付ファイルが追加されたタスクの ID。
type
Type はファイルの添付ファイル、Type はメモの注記です。
formattedCreationDate
T ユーザーの UI 設定に応じて添付ファイルの作成日が含まれます。
formattedDescription
T 書式設定された添付ファイルの説明。AEM Forms Workspace の添付ファイルの説明に存在する特殊文字を表示するのに使用されます。
formattedFileName
T 書式設定された添付ファイル名。AEM Forms Workspace の添付ファイルの名前に存在する特殊文字を表示するのに使用されます。これは、メモでのみ利用できます。
  1. User

    以下にユーザーオブジェクトのプロパティを示します。

プロパティ クライアントのみ コメント
address
ユーザーのアドレス。
commonName
ユーザーの共通名。
説明
ユーザーの説明。
directGroupMemberships
ユーザーのグループのリスト。
displayName
ユーザーの表示名。
email
ユーザーの電子メール ID。
isOutOfOffice
ユーザーが不在の場合は true です。
lastName
ユーザーの姓。
firstName
ユーザーの名。
oid
ユーザーの ID。
org
ユーザーの組織の名前。
postalAddress
ユーザーの住所。
telephone
ユーザーの連絡先番号。
telephoneNumber
ユーザーの連絡先番号。
userid
ユーザーのログイン ID。

このページ