ワークフロー・サービス

5 ワークフロー・サービス

この章では、Oracle WebCenter Content Serverワークフローを使用およびカスタマイズする際に使用可能なサービス、およびIdcHomeDir/resources/core/templates/ディレクトリのworkflow.htmファイルに格納される他のサービスについて説明します。

この章の内容は、次のとおりです。

5.1 ワークフロー・サービスについて

WebCenter Contentサービスの内容およびサービスの使用方法に関する情報は、「サービスの使用」で説明されています。基本的なサービスの構造、属性、アクションおよびサービスの例に関する情報は、「サービスのカスタマイズ」で説明されています。現在のサービスをカスタマイズするか、新しいサービスを作成する前に、この情報に精通しておく必要があります

特定のワークフロー・サービスの場所は、各サービス内にリスト表示されています。

ノート:

最も一般的に使用されるサービスには、より広範囲な説明があります。

ノート:

すべてのサービスには、少なくとも1つの必須パラメータがあります。IdcServiceパラメータはサービス名をその引数として取ります。他のパラメータが必要な場合は、サービスの説明に記載されています。

一般的なサービス・エントリを次に示します。

GET_WORKFLOW
WorkflowService 40 null null null!csWfRetrieveInfoError(dWfName)
5:QworkflowDocuments:WfDocuments:0:!csWfRetrieveInfoError(dWfName)
3:getWorkflowStepAliasesInfo::0:null
3:getWorkflowDesignInfo::0:null
3:getWorkflowDocumentInfo:WfDocuments:0:null

この例の説明:

1行目にはサービス名(GET_WORKFLOW)を指定します。
2行目にはサービスの属性を指定します。
- サービス・クラス: WorkflowService
- アクセス・レベル: 40
- テンプレート: null
- サービス・タイプ: null
- 通知された件名: null
- エラー・メッセージとエラー・メッセージで使用されるパラメータ: 情報取得のエラー
エントリのこの他の部分では、各行に1つずつサービスのアクションを指定します。
- アクション・タイプ: たとえば、5は「キャッシュ問合せの選択」です。これは、データベースから情報を取得して後で使用するために保存する問合せを指定します。
- アクション名: たとえば、QworkflowDocuments
- アクション・パラメータ: たとえば、WfDocuments。パラメータを指定しない場合は、2つのコロン(::)を指定します。
- アクションの制御マスク: たとえば、0はエラーを無視することを意味します。制御マスクを指定しない場合は、2つのコロン(::)または0を指定します。
- アクションのエラー・メッセージ、またはメッセージがない場合はnull。

サービス・アクションの各要素はコロン(:)で区切ります。

ノート:

サービスの属性とアクションの詳細は、「サービスのカスタマイズ」を参照してください。

5.2 ドキュメント・サービスと一般サービス(ワークフロー)

ドキュメント・サービスは、ドキュメントを管理および操作するために使用されるサービスで、ドキュメントに関する情報を提供します。一般サービスは通常またはデフォルトのサービスです。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

この項では、次のサービスについて説明します。

5.2.1 ADD_PROBLEMREPORT

コンテンツ・アイテムに問題レポートを追加するサービス。これは、ステージング・ワークフローで使用されるContent Publisher関連のサービスです。

最も発生しがちなエラーは、パラメータに不整合があること、システムがコンテンツ・アイテムに問題レポートを追加できないこと、またはコンテンツ・アイテムがシステムに存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dDocName: コンテンツ・アイテムの識別子(コンテンツID)。
dID: 生成済のコンテンツ・アイテムのリビジョンID。
dPrCaption: 問題レポートのキャプション。
dPrSeverity: Critical、Moderate、Minorなどの、問題レポートの重大度。このオプションは問題レポートがワークフロー・プロセス内で処理される方法に影響は及ぼしません。
dPrState: Open、Closed、Fixedなどの、問題レポートの状態。

ノート:

コンテンツID (dDocName)と内部のコンテンツ・アイテム・リビジョン識別子(dID)を混同しないでください。dIDは、コンテンツ・アイテムの特定のレンディションへの、生成済の参照です。

例

IdcService=ADD_PROBLEMREPORT
dPrCaption=Problem report for this content.
dDocName=PublicDoc1_ia3c488971
dID=67
dPrState=OPEN
dPrSeverity=MINOR

5.2.2 ADD_PROBLEMREPORT

コンテンツ・アイテムに問題レポートを追加するサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dDocName: コンテンツ・アイテムの識別子(コンテンツID)。
dID: 生成済のコンテンツ・アイテムのリビジョンID。
dPrCaption: 問題レポートのキャプション。
dPrSeverity: Critical、Moderate、Minorなどの、問題レポートの重大度。このオプションは問題レポートがワークフロー・プロセス内で処理される方法に影響は及ぼしません。
dPrState: Open、Closed、Fixedなどの、問題レポートの状態。

ノート:

コンテンツID (dDocName)と内部のコンテンツ・アイテム・リビジョン識別子(dID)を混同しないでください。dID値は、コンテンツ・アイテムの特定のレンディションへの、生成済の参照です。

例

IdcService=ADD_PROBLEMREPORT
dPrCaption=Problem report for this content.
dDocName=PublicDoc1_ia3c488971
dID=67
dPrState=OPEN
dPrSeverity=MINOR

5.2.3 DELETE_PROBLEMREPORT

既存の問題レポートを削除するサービス。最も発生しがちなエラーは、パラメータに不整合があること、またはコンテンツ・アイテムがシステムに存在しないことです。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dPrID: 問題レポートID。

例

IdcService=DELETE_PROBLEMREPORT
dPrID=1

5.2.4 GET_CRITERIA_WORKFLOWS_FOR_GROUP

特定のセキュリティ・グループの基準ワークフローおよびワークフロー・ステップのリストを返すサービス。

WorkflowsForGroupおよびWorkflowStepsForGroup結果セットを返します。

WorkflowsForGroupでは、このグループに対するすべてのワークフローがリストされます(dWfID、dWfName)。
WorkflowStepsForGroupでは、このグループに対するすべてのワークフローのすべてのステップがリストされます(dWfID、dWfName、dWfStepID、dWfStepName)。
最も発生しがちなエラーは、セキュリティ・グループが存在しないか、ユーザーがセキュリティ・チェックに失敗することです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

例

IdcCommandコマンド・ファイル・フォーマット:

# Retrieves criteria workflow information
IdcService=GET_CRITERIA_WORKFLOWS_FOR_GROUP
dSecurityGroup=Public

HDA形式:

@Properties LocalData
IdcService=GET_CRITERIA_WORKFLOWS_FOR_GROUP
dSecurityGroup=Public
@end

5.2.5 GET_DOCUMENT_PROBLEMREPORTS

特定のコンテンツ・アイテムに関するすべての問題レポートを返すサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dDocName: コンテンツ・アイテムのコンテンツID。

例

IdcService=GET_DOCUMENT_PROBLEMREPORTS
dDocName=security_000015

5.2.6 GET_PROBLEMREPORTS_SEARCH_FORM

問題レポート検索フォームを返すサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.2.7 GET_PROBLEMREPORTS_SEARCH_RESULTS

「問題レポート」検索ページで指定された検索条件に一致する問題レポートのリストを返すサービス。検索条件は、問題レポートの表で指定される列のいずれかにすることができます。

使用される検索条件は、問題レポートの表で指定される列のいずれかをとることができます。このサービスは名前/値のペアで渡され、次にデータベース問合せのWHERE句に変換されます。

問題レポートのデータソースは(resource.htm fileで指定される)は、名前/値のペアで生成されるWHERE句とともに問合せの構築に使用されます。この問合せの結果はプレゼンテーション用に渡されます。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

オプションのサービス・パラメータ

dPrSeverity: Critical、Moderate、Minorなどの、問題レポートの重大度。このオプションは問題レポートがワークフロー・プロセス内で処理される方法に影響は及ぼしません。
dPrAuthor: 問題レポートの作成者。
dPrCaption: 問題レポートのキャプション。
dPrState: Open、Closed、Fixedなどの、問題レポートの状態。
dDocTitle: コンテンツ・アイテムのタイトル。
dDocName: コンテンツ・アイテムのコンテンツID。
dPrjDescription: プロジェクトの説明。

5.2.8 GET_UPDATE_PROBLEMREPORT_FORM

問題レポートの更新フォームを返すサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dPrID: 問題レポートID。

例

IdcService=GET_UPDATE_PROBLEMREPORT_FORM
dPrID=1

5.2.9 GET_WORKFLOWDOCUMENTS

特定のワークフローにあるコンテンツ・アイテムのリビジョンのリストを返すサービス。

このサービスは、ワークフローのすべてのコンテンツ・アイテムのリストを提供し、ワークフローにあるコンテンツ・アイテムのステータス(状態とステップ)を追跡するためにシステム・サーバーによって更新されます。

最も発生しがちなエラーは、ワークフロー名が存在しないことです。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

IdcService: GET_WORKFLOWDOCUMENTSに設定する必要があります。
dWfName: ワークフロー名。

例

IdcService=GET_WORKFLOWDOCUMENTS
dWfName=mktg_review

5.2.10 GET_WORKFLOWS_FOR_ALL

すべてのワークフローおよびそのステップに関する情報を戻すためにワークフロー・アプレットで使用されるサービス。

サービス・クラス: サービス(一般サービス)

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.2.11 LOAD_WORKFLOW_QUEUE

アクションを要求するワークフローにコンテンツ・アイテムのリストが含まれる、ユーザーのパーソナライズ・データを返すサービス。データは、DomainHome/ucm/cs/data/users/profilesディレクトリにあるwf_in_queue.hdaファイルから取得されます。

これは、リモート・アプリケーション・サービスであることを意図しています。それは、関連した表示テンプレートを使用しない生データ・サービスであるためです。

サービス・クラス: ユーザー・サービス

アクセス・レベル: 読取り、スクリプト作成可能(33)

場所: IdcHomeDir/resources/core/tables/std_services.htm

結果

結果セット: WorkflowInQueue

使用

その他: SoapCustom:Wsdl:Workflow:Services

5.2.12 NOTIFY_CONTRIBUTOR

指定されたコンテンツ・アイテムに関する問題レポートをコントリビュータに通知するサービス。最も発生しがちなエラーは、コンテンツ・アイテムがシステムに存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dID: 生成済のコンテンツ・アイテムのリビジョンID。

例

IdcService=NOTIFY_CONTRIBUTOR
dID=55

5.2.13 PROBLEMREPORT_INFO

問題レポートに関するすべての情報を返すサービス。問題レポートの情報は、ファイル・システムおよびデータベース内にあります。このサービスにより、ユーザーに(コンテキストで使用される場合)「問題レポート情報」ページが表示されます。これにより、ユーザー・インタフェースからユーザーが問題レポートを再送信、削除または更新できるようになります。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dPrID: 問題レポートの一意のID。

例

IdcService=PROBLEMREPORT_INFO
dPrID=1

5.2.14 RESEND_PROBLEMREPORT

アクティビティに関して通知対象のすべての関心あるユーザーに電子メールを再送信するサービス。このサービスは「問題レポート」ページからアクセスできます。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dPrID: 問題レポートID。

例

IdcService=RESEND_PROBLEMREPORT
dPrID=1

5.2.15 REVIEW_WORKFLOW_DOC

ユーザーがワークフロー内のドキュメントをレビューできるようにするページを生成するサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dID: 生成済のコンテンツ・アイテムのリビジョンID。

5.2.16 UPDATE_PROBLEMREPORT

問題レポート情報を更新するサービス。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dPrID: 問題レポートID。
dPrState: Open、Closed、Fixedなどの、問題レポートの状態。

オプションのサービス・パラメータ

dPrCaption: 問題レポートのキャプション。
dPrSeverity: Critical、Moderate、Minorなどの、問題レポートの重大度。このオプションは問題レポートがワークフロー・プロセス内で処理される方法に影響は及ぼしません。
prMessage: 問題レポートのメッセージ。

例

IdcCommandコマンド・ファイル・フォーマット:
```
IdcService=UPDATE_PROBLEMREPORT
dPrID=1
dPrState=OPEN
```

任意のパラメータを持つHDAファイル形式:

@Properties LocalData
IdcService=UPDATE_PROBLEMREPORT
dPrID=1
dPrState=OPEN
prMessage=Description is stored in hda file.
dPrCaption=change this caption
dPrSeverity=SERIOUS
@end

5.2.17 WORKFLOW_CHECKIN_SUB

コンテンツ・アイテムがすでに存在し、ワークフロー内にある場合に、そのコンテンツ・アイテムをチェックインするサブサービス。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.2.18 WORKFLOW_EDIT_REV

実行されるワークフロー・チェックのタイプを決定するために、WORKFLOW_CHECKIN_SUBサブサービスで使用されるサブサービス。このサービスは、ワークフローのリビジョンを適切に編集します。ワークフロー設計が評価されると、WORKFLOW_EDIT_REVとWORKFLOW_NEW_REVのいずれを使用するかが決定されます。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.2.19 WORKFLOW_NEW_REV

実行されるワークフロー・チェックインのタイプを決定するために、WORKFLOW_CHECKINサービスで使用されるサブサービス。このサービスは、ワークフロー・ドキュメントの新しいリビジョンを作成します。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.2.20 WORKFLOW_REJECT_FORM

却下されたワークフローのリビジョンの却下フォームを返すサービス。このサービスは、レビューアがワークフロー・ステップのコンテンツを却下した場合(レビューアが「却下」をクリックした場合)に実行されます。

このサービスは通常、JavaScriptを使用して値を割り当てるブラウザ環境で実行されます。ブラウザ環境で渡されるパラメータを、次のサブセクションに示します。

サービス・クラス: ドキュメント・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dID: 生成済のコンテンツ・アイテムのリビジョンID。
dWfName: ワークフロー名。

例

IdcService=WORKFLOW_REJECT_FORM
dWfName=mktg_review
dID=44

5.3 ワークフロー・テンプレート・サービス

ワークフロー・テンプレート・サービスは、ワークフロー・テンプレートの管理または変更に使用されます。ここにリストされるすべてのサービスは、ワークフロー・テンプレート・サービスのサービス・クラスを持ちます。この項では、次のサービスについて説明します。

5.3.1 ADD_WF_TEMPLATE

新しいワークフロー・テンプレートを作成するサービス。最も発生しがちなエラーは、ワークフロー・テンプレート名が一意でないこと、またはシステムがワークフロー・テンプレート・リストを取得できないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dWfTemplateName: ワークフロー・テンプレート名。
dWfTemplateDescription: ワークフロー・テンプレートの説明。

例

IdcService=ADD_WF_TEMPLATE
dWfTemplateName=mark_temp
dWfTemplateDescription=marketing template

5.3.2 DELETE_WF_TEMPLATE

既存のワークフロー・テンプレートを削除するサービス。最も発生しがちなエラーは、システムがワークフロー・テンプレートを取得できないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dWfTemplateName: ワークフロー・テンプレート名。

例

IdcService=DELETE_WF_TEMPLATE
dWfTemplateName=wf_template_10

5.3.3 EDIT_WF_TEMPLATE

既存のワークフロー・テンプレートを変更するサービス。このサービスは、ワークフロー・テンプレートのステップがあるため、EDIT_WORKFLOWSTEPと似ています。ただし、このサービスでは、テンプレートの複数のステップや他の部分の編集が可能です。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dAliases: /nエスケープ・シーケンスで区切られるエイリアス・ユーザーのリスト。
たとえば: dAliases=subadmins/nservices。
dWfStepDescription: ステップの説明。
dWfStepHasWeight: 制限されたレビューア・オプションを有効にします。
1 (true)に設定し、dWfStepWeightパラメータでレビューア数を定義します。
dWfStepIsAllが有効な場合は、0 (false)に設定します。
dWfStepIsAll: すべてのレビューア・オプションを有効にします。
ワークフローが次のステップに移る前に、ステップに割り当てられているすべてのユーザーがリビジョンを承認する必要がある場合は、1 (true)に設定します。
dWfStepHasWeightが有効な場合は、0 (false)に設定します。
dWfStepName: ワークフロー・ステップ名。通常、これはレビューのタイプ(初期レビューや整理編集など)またはレビューアの職務(マネージャやコピー・エディタなど)になります。
dWfStepType: ワークフロー・ステップ・タイプ
レビューア: リビジョンを承認または拒否します。
レビューア/コントリビュータ: リビジョンを編集、承認および拒否できます。
dWfStepWeight: 制限されたレビューア・オプションのレビューア数を定義します。
レビューア数に数値を入力します。指定したユーザー数がリビジョンを承認するとすぐに、ワークフローは次のステップに移ります。
このフィールドにゼロ(0)を入力すると、リビジョンがステップに到達したときに、レビューアに通知されますが、そのステップではリビジョンの承認、拒否、編集はできません。ワークフローは自動的に次のステップに進みます。
dWfTemplateDescription: ワークフロー・テンプレートの説明。
dWfTemplateName: ワークフロー・テンプレート名。

例

次は、EDIT_WF_TEMPLATEサービス・コールの例です。

@Properties LocalData
dUser=fradiche
dWfStepIsAll=0
watchedMonikers=
blFieldTypes=StatusMessage message
monitoredTopics=appcommongui,1060430685890
dAliases=fradiche*09user*09user1*09user
monitoredSubjects=collaborations,1061386025875,config,1061386026266,metadata,
    1061386026216,metaoptlists,1061386026236,wftemplates,1061386026267,projects,
    1061386026586,users,1061386026216,workflows,1061386026296,aliases,
    1061386026266,wfscripts,1061386026266,usermetaoptlists,1061386026256,
    doctypes,1061386026216,accounts,1061386026216
refreshSubMonikers=
dWfStepID=
dWfStepHasWeight=1
wfExitScript=
wfUpdateScript=
ClientEncoding=Cp1252
dWfStepDescription=
wfUpdateScriptSummary=
dWfStepType=Reviewer
dWfID=
HasAdditionalExitCondition=0
IsTemplateScript=1
dWfStepName=s1
IsJava=1
wfExitConditionSummary=
dAliasType=user
ConditionKeys=HasAdditionalExitCondition,wfAdditionalExitCondition
dWfTemplateDescription=test
dWfTemplateName=test
blDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago
IdcService=EDIT_WF_TEMPLATE
dAlias=user1
dWfStepWeight=1
wfEntryScriptSummary=
wfExitScriptSummary=
wfEntryScript=
@end
@ResultSet WorkflowSteps
9
dWfStepName
dWfStepID
dWfID
dWfStepType
dWfStepIsAll
dWfStepWeight
dWfStepDescription
dAliases
dWfStepHasWeight
s1

Reviewer
0
1

fradiche*09user*09user1*09user
1
@end
@ResultSet WorkflowStepEvents
4
dWfStepName
wfEntryScript
wfExitScript
wfUpdateScript
s1

@end
@ResultSet UpdatedUserTopics
3
topicName
topicValue
topicTS
@end

次は、返される結果の例です。

Content-type: text/plain

Content-Length: 2446

<?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?>

@Properties LocalData
wfUpdateScript=
dUser=sysadmin
refreshSubMonikers=
refreshTopics=appcommongui,1040486396000
dWfTemplateDescription=test
dAlias=user1
wfExitConditionSummary=
monitoredSubjects=collaborations,1061386025875,config,1061386026266,metadata,
    1061386026216,metaoptlists,1061386026236,wftemplates,1061386026267,projects,
    1061386026586,users,1061386026216,workflows,1061386026296,aliases,
    1061386026266,wfscripts,1061386026266,usermetaoptlists,1061386026256,
    doctypes,1061386026216,accounts,1061386026216
wfExitScript=
ConditionKeys=HasAdditionalExitCondition,wfAdditionalExitCondition
dWfStepDescription=
dAliases=fradiche*09user*09user1*09user
dWfStepType=Reviewer
watchedMonikers=
HasAdditionalExitCondition=0
changedMonikers=
changedSubjects=
blFieldTypes=StatusMessage message
IdcService=EDIT_WF_TEMPLATE
wfExitScriptSummary=
dWfStepHasWeight=1
wfEntryScript=
wfUpdateScriptSummary=
dAliasType=user
dWfStepName=s1
dWfStepWeight=1
wfEntryScriptSummary=
dWfStepID=
refreshMonikers=
blDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago
ClientEncoding=Cp1252
IsJava=1
dWfStepIsAll=0
IsTemplateScript=1
refreshSubjects=wftemplates,1061386026272
dWfTemplateName=test
monitoredTopics=appcommongui,1060430685890
dWfID=
@end
@ResultSet WorkflowSteps
9
dWfStepName
dWfStepID
dWfID
dWfStepType
dWfStepIsAll
dWfStepWeight
dWfStepDescription
dAliases
dWfStepHasWeight
s1

Reviewer
0
1

fradiche*09user*09user1*09user
1
@end
@ResultSet WorkflowStepEvents
4
dWfStepName
wfEntryScript
wfExitScript
wfUpdateScript
s1

@end
@ResultSet UpdatedUserTopics
3
topicName
topicValue
topicTS
appcommongui
\@Properties LocalData\nblFieldTypes=\nblDateFormat=M/d{/yy} {h:mm{:ss.SSSS}
    {aa}[zzz]}!tAmerica/Chicago\n\@end\n\@ResultSet 
    UserSelectView:filter\n3\nfilterColumn\nfilterValue\nisEnabled\ndUserAuthType
    \nLOCAL\ntrue\n\@end\n\@ResultSet UserView:filter\n3\nfilterColumn
    \nfilterValue\nisEnabled\ndUserAuthType\nLOCAL\ntrue\n\@end\n\@ResultSet
    DocView:filter\n3\nfilterColumn\nfilterValue\nisEnabled\ndProcessingState
    \nM\nfalse\ndIsCheckedOut\n1\nfalse\ndStatus\nGENWWW\ntrue\ndDocTitle 
    \nCanceled:%\nfalse\ndReleaseState\nN\nfalse\nisLatestRev\n\ntrue
    \ndSecurityGroup\ntest\nfalse\ndDocType\ntest\nfalse\n\@end\n\n
1040486396000
@end
@ResultSet WfTemplates
2
dWfTemplateName
dWfTemplateDescription
collaboration_template
Basic Collaboration template
test
test
@end

5.3.4 GET_WF_TEMPLATE

特定のワークフロー・テンプレートの説明を返すサービス。最も発生しがちなエラーは、ワークフロー・テンプレート名が存在しないことです。

場所: IdcHomeDir/resources/core/templates/workflow.htm

追加の必須サービス・パラメータ

dWfTemplateName: ワークフロー・テンプレート名。

例

IdcService=GET_WF_TEMPLATE
dWfTemplateName=servicestemplate

5.3.5 GET_WF_TEMPLATES

すべてのワークフロー・テンプレートとその説明のリストを返すサービス。最も発生しがちなエラーは、ワークフロー名が存在しないことです。

サービス・クラス: ワークフロー・テンプレート・サービス

場所: IdcHomeDir/resources/core/templates/workflow.htm

5.4 ワークフロー・サービス

ワークフロー・サービスは、ワークフローの追加、トークンの追加、ワークフローの有効化または無効化を含む、ワークフローの管理に使用されるサービスです。次のリストでは、頻繁に使用されるサービスはアスタリスク(*)でマークされています。

これらのサービスはすべて、ワークフロー・サービスのサービス・クラスを持ちます。

この項では、次のサービスについて説明します。

5.4.1 ADD_WORKFLOW

新しいワークフローを作成するサービス。このサービスは「ワークフロー管理」アプレットにより実行されます。「ワークフロー管理」管理アプレットから、ワークフローおよびサブワークフローを追加、編集、有効化、無効化および削除できます。

最も発生しがちなエラーは、ワークフロー名が一意でないことです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。
dWfDescription: ワークフローの説明。
dWfType: 基本や基準などのワークフロー・タイプ。
dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。
dWfCriteriaName: ワークフロー基準フィールド。
dWfCriteriaOperator: ワークフロー基準演算子(matches)。
dWfCriteriaValue: ワークフロー基準値。

例

IdcService=ADD_WORKFLOW
dWfName=test_workflow
dSecurityGroup=Public
dWfType=Criteria
dWfCriteriaName=dDocAuthor
dWfCriteriaOperator=matches
dWfCriteriaValue=sysadmin
dWfDescription=testing workflow

5.4.2 ADD_WORKFLOW_SCRIPT

ワークフローにスクリプト・テンプレートを追加するために使用されるサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

wfScriptName: 使用されるスクリプト・テンプレートの名前。
wfScriptDescription: スクリプトに使用される説明。

5.4.3 ADD_WORKFLOW_TOKEN

ワークフローにトークンを追加するために使用されるサービス。

サービス・クラス: ワークフロー・サービス

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

wfToken: 新しいトークンを作成するために使用されるデフォルト・トークン。
wfTokenName: 追加される新しいトークンの名前。
wfTokenDescription: トークンに使用される説明。

5.4.4 ADD_WORKFLOWALIASES

ワークフロー・ステップにユーザーまたはエイリアスを追加するサービス。ユーザーを追加するには、dAliasTypeパラメータをuserに設定します。エイリアスを追加するには、dAliasTypeパラメータをaliasに設定します。最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

ノート:

エイリアスがここで定義されていません。エイリアスはすでに存在している必要があります。エイリアスは通常、UserAdminアプレットを使用して作成されます。

サービス・クラス: ワークフロー・サービス

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

aliases: エイリアス。
dAliasType: 割り当てられたエイリアスのタイプ。値はaliasまたはuserを指定できます。
dWfID: ワークフローID。
dWfName: ワークフロー名。
dWfStepID: ワークフロー・コントリビューション・ステージID。自動生成される値はデータベース表から取得できます。Content Serverシステムはそのコントリビューション・ステージのdWfStepIDを自動的に割り当てます。

例

IdcService=ADD_WORKFLOWALIASES
dWfName=mktg_review
dWfID=12
dAliasType=user
aliases=sammy
dWfStepID=26

5.4.5 ADD_WORKFLOWDOCUMENT

基本ワークフローに新しいコンテンツ・アイテムを追加するサービス。dDocNameで指定されたコンテンツ・アイテムはシステムに存在する必要はありません。

このサービスは、基本ワークフローを作成し、「コンテンツ」セクションの「新規」をクリックすることで、「ワークフロー管理」アプレットからコールされます。このサービスはADD_WORKFLOWDOCUMENT_SUBサブサービスを実行します。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。
dDocName: コンテンツ・アイテムのコンテンツID。

例

IdcService=ADD_WORKFLOWDOCUMENT
dWfName=mktg_review
dDocName=test1234

5.4.6 ADD_WORKFLOWDOCUMENT_SUB

コンテンツ・アイテムを基本ワークフローに追加するためにADD_WORKFLOWDOCUMENTSおよびADD_WORKFLOWDOCUMENTによってコールされるサブサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

5.4.7 ADD_WORKFLOWDOCUMENTS

基本ワークフローに選択したコンテンツ・アイテムを追加するサービス。追加するアイテムのリストは、dDocNameパラメータで指定されます。

このサービスは、基本ワークフローを作成し、「コンテンツ」セクションの「選択」をクリックすることで、「ワークフロー管理」アプレットからコールされます。

このサービスはADD_WORKFLOWDOCUMENT_SUBサブサービスを実行します。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。
dDocName: 追加されるコンテンツ・アイテムのコンテンツID。複数のアイテムが追加される場合は、タブ区切りリストを使用します。

例

IdcService=ADD_WORKFLOWDOCUMENTS
dWfName=mktg_review
dDocName=test_000035
dataSource=Documents
resultName=DOCUMENTS
dWfType=Basic
whereClause=dSubscriptionType='test'
dWfDirectory=public

5.4.8 ADD_WORKFLOWSTEP

新しいワークフロー・ステップを作成するサービス。

これらのパラメータは、「ワークフロー管理」アプレットを使用して、ブラウザ環境で実行できます。たとえば、dWfStepName、dWfStepDescriptionおよびdWfStepTypeのエントリは、ステップのレビュー担当者の編集画面の「ワークフロー管理」アプレットの「タイプ」ドロップダウン・リスト、「名前」エントリ、および「説明」フィールドに対応しています。
dWfStepWeightを数値に設定すると、「ワークフロー管理」アプレットの「ワークフロー・ステップ」の「レビューアの最低必要人数」オプションに関連付けられているフィールドに値を入力するのと同じになります。定義されている場合、dWfStepWeightで指定されたユーザー数がリビジョンを承認するとすぐに、ワークフローは次のステップに移ります。
dWfStepIsAllを1 (true)に設定すると、「ワークフロー管理」アプレットの「ワークフロー・ステップ」の「すべてのレビューア」オプションを有効にするのと同じになります。trueに設定した場合、ワークフローが次のステップに移る前に、ステップに割り当てられているすべてのユーザーがリビジョンを承認する必要があります。
最も発生しがちなエラーは、指定されたワークフローが存在しないか、指定されたステップが一意ではないことです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。
dWfStepName: ワークフロー・ステップ名。
dWfStepDescription: ステップの説明。
dWfStepType: ワークフロー・ステップ・タイプ
- レビューア: リビジョンを承認または拒否します。
- レビューア/コントリビュータ: リビジョンを編集、承認および拒否できます。
dWfStepIsAll:
- 1 (true): ワークフローが次のステップに移る前に、ステップに割り当てられているすべてのユーザーがリビジョンを承認する必要があります。
- 0 (false): 必要な承認数がdWfStepWeightパラメータによって指定されます。
dWfStepWeight: ワークフローが次のステップに移る前に、リビジョンを承認する必要があるレビューアの数。
- dWfStepIsAllが1 (true)の場合、このパラメータは無視されます。dWfStepIsAllが0 (false)の場合、このパラメータは有効になります。
- このパラメータを0 (ゼロ)に設定すると、リビジョンがステップに到達したときに、レビューアに通知されますが、そのステップではリビジョンの承認、却下、編集はできません。ワークフローは自動的に次のステップに進みます。

オプションのサービス・パラメータ

wfEntryScript: ステップ・エントリのスクリプト。
wfExitScript: ステップ終了スクリプト。
wfUpdateScript: ステップ更新スクリプト。

ノート:

スクリプトは、<$および$>デリミタ内に配置される必要があります。たとえば、 <$if ConditionExpression$>です。

5.4.9 CRITERIAWORKFLOW_DISABLE

基準ワークフローを無効にするサービス。最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。

例

IdcService=CRITERIAWORKFLOW_DISABLE
dWfName=mktg_review

5.4.10 CRITERIAWORKFLOW_DISABLE_SUB

基準ワークフロー内のサブワークフローを無効にするサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

5.4.11 CRITERIAWORKFLOW_ENABLE

基準ワークフローを有効にするサービス。最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。

例

IdcService=CRITERIAWORKFLOW_ENABLE
dWfName=mktg_review

5.4.12 DELETE_WFCONTRIBUTORS

基本ワークフローの初期ステップ(コントリビューション・ステップ)からユーザーおよびエイリアスを削除するために使用されるサービス。最も発生しがちなエラーは、パラメータに不整合があるか、指定されたワークフローまたはエイリアスが存在しないことです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

aliases: 基本ワークフローから削除されるエイリアスおよびユーザー。複数のエイリアスが削除される場合は、タブ区切りリストを使用します。
dWfName: ワークフロー名。
dWfStepID: ワークフロー・コントリビューション・ステップID。自動生成される値はデータベース表から取得できます。

例

IdcService=DELETE_WFCONTRIBUTORS
dWfName=mktg_review
dWfStepID=26
aliases=user20

5.4.13 DELETE_WORKFLOW

既存の基本ワークフローを削除するサービス。最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。

例

IdcService=DELETE_WORKFLOW
dWfName=mktg_review

5.4.14 DELETE_WORKFLOW_SCRIPT

ワークフロー・スクリプトを削除するサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

wfScriptName: 使用されるスクリプト・テンプレートの名前。
wfScriptDescription: スクリプトに使用される説明。

5.4.15 DELETE_WORKFLOW_TOKEN

ワークフロー・トークンを削除するサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

wfTokenName: 削除するトークンの名前。

5.4.16 DELETE_WORKFLOWCRITERIA

既存の基準ワークフローを削除するサービス。ワークフローがアクティブな場合、このアクションにより、このワークフロー内のすべてのコンテンツ・アイテムがワークフローを終了する旨がユーザーに通知されます。最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。

例

IdcService=DELETE_WORKFLOWCRITERIA
dWfName=mktg_review

5.4.17 DELETE_WORKFLOWDOCUMENTS

基本ワークフローからコンテンツ・アイテムを削除するサービス。このサービスは「ワークフロー管理」アプレットにより実行されます。

最も発生しがちなエラーは、指定されたワークフローが存在しないことです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: 基本ワークフロー名。
docNames: 削除されるドキュメントのコンテンツ・アイテム名。複数のアイテムが削除される場合は、タブ区切りリストを使用します。

ノート:

docNamesパラメータおよびdDocNameパラメータの両方を含めることをお薦めします。このサービスの実行には、両方のパラメータが使用されるためです。

例

次は、DELETE_WORKFLOWDOCUMENTSサービス・コールの例です。

@Properties LocalData
IdcService=DELETE_WORKFLOWDOCUMENTS
dWfName=w3
docNames=rr
dDocName=rr
@end

次は、返される結果の例です。

Content-type: text/plain

Content-Length: 931

<?hda version="6.3 dev (build-date)" jcharset=Cp1252 encoding=iso-8859-1?>

@Properties LocalData
dUser=sysadmin
blFieldTypes=xThreadParentDocName bigtext,xCollectionID int,xMailType
text,xZoomLevel int,dCompletionDate date,xTargetCompression int,xTemplateType
text,xEmailFrom bigtext,xEmailCC memo,dMessage message2,xHidden text,
xClbraAliasList memo,xWebsiteID int,StatusMessage message,xComments memo,
xEmailDate date,xWebsiteObjectType text,xCollectionInhibitUpdateMeta text,
xClbraUserList memo,xFileFormat bigtext,dReleaseDate date,xMessageID
text,dInDate date,xDiscussionType text,dCreateDate date,dOutDate
date,xDiscussionCount int,xReadOnly text
docNames=rr
refreshSubMonikers=
blDateFormat=M/d{/yyyy} {h:mm{:ss}{.SSSS} {aa}}!tAmerica/Chicago
dWfName=w3
refreshSubjects=
changedSubjects=workflows,1061386026294
dDocName=rr
refreshMonikers=
changedMonikers=
dWfDocState=INIT
IdcService=DELETE_WORKFLOWDOCUMENTS
IsJava=1
@end

5.4.18 DELETE_WORKFLOWSTEP

ワークフローから指定されたステップを削除するサービス。このサービスは、「ワークフロー」アプレットから使用されます。ユーザーはステップを選択し、「ステップの削除」ボタンをクリックします。このサービスがアプレット外で実行される場合、制御アプリケーションはワークフロー・ステップを指定する必要があります。ステップIDおよび名前はワークフロー設計情報の一部としてデータベースに格納され、使用するためにそのデータベースから取得できます。

最も発生しがちなエラーは、指定されたワークフローまたはワークフロー・ステップが存在しないか、ワークフローがアクティブなことです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。
dWfStepName: ワークフロー・ステップ名。
dWfStepID: ワークフロー・コントリビューション・ステージID。

例

IdcService=DELETE_WORKFLOWSTEP
dWfName=c2
dWfStepID=12
dWfStepName=edit

5.4.19 EDIT_WORKFLOW

既存のワークフローを変更するサービス。このサービスは「ワークフロー管理」アプレットにより実行されます。最も発生しがちなエラーは、ワークフロー名が存在しないかユーザーがセキュリティ・チェックに失敗することです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。
dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

オプションのサービス・パラメータ

dWfCriteriaName: ワークフロー基準名。
dWfCriteriaOperator: Matches、Starts、Endsなどのワークフロー基準演算子。
dWfCriteriaValue: ワークフロー基準値。
dWfDescription: ワークフローの説明。
dWfType: 基本や基準などのワークフロー・タイプ。

例

IdcCommandコマンド・ファイル・フォーマット:

IdcService=EDIT_WORKFLOW
dWfName=c2
dSecurityGroup=Public

任意のパラメータを持つHDA形式:

@Properties LocalData
IdcService=EDIT_WORKFLOW
dWfName=test_workflow
dSecurityGroup=Public
dWfType=Criteria
dWfCriteriaName=dDocAuthor
dWfCriteriaOperator=matches
dWfCriteriaValue=sysadmin
dWfDescription=testing workflow
@end

5.4.20 EDIT_WORKFLOW_SCRIPT

ワークフロー・スクリプトを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

wfScriptName: 使用されるスクリプト・テンプレートの名前。
wfScriptDescription: スクリプトに使用される説明。

5.4.21 EDIT_WORKFLOW_TOKEN

ワークフロー・トークンを編集するために使用されるサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

wfTokenName: 編集されるトークンの名前。

5.4.22 EDIT_WORKFLOWCRITERIA

既存の基準ワークフローの基準を変更するサービス。基準の編集にはプロジェクトやコラボレーション・ワークフローへのワークフローの変更またはコンテンツ・アイテムをワークフローに入れるために満たす必要があるメタデータ条件の変更が含まれる場合があります。

次の2種類の基準ワークフローが存在します: メタデータ条件を必要とするワークフローであるcriteriaおよびメタデータ条件を持たないsubworkflow。2種類のワークフローがあるので、dWfTypeは、使用される基準ワークフローのタイプを指定するための必須パラメータです。

このサービスは「ワークフロー管理」アプレットにより実行されます。最も発生しがちなエラーは、ワークフロー名が存在しないかユーザーがセキュリティ・チェックに失敗することです。

サービス・クラス: ワークフロー・サービス

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。
dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。
dWfType: ワークフロー・タイプ
dWfCriteriaName: ワークフロー基準名。
dWfCriteriaOperator: Matches、Starts、Endsなどのワークフロー基準演算子。
dWfCriteriaValue: ワークフロー基準値。

オプションのサービス・パラメータ

dWfDescription: ワークフローの説明。

例

IdcService=EDIT_WORKFLOWCRITERIA
dWfName=c2
dSecurityGroup=Public
dWfType=Criteria
dWfCriteriaName=dDocType
dWfCriteriaOperator=matches
dWfCriteriaValue=ADACCT

5.4.23 EDIT_WORKFLOWSTEP

既存のワークフロー・ステップを変更するサービス。

これらのパラメータは、「ワークフロー管理」アプレットを使用して、ブラウザ環境で実行できます。たとえば、dWfStepName、dWfStepDescriptionおよびdWfStepTypeのエントリは、ステップのレビュー担当者の編集画面の「ワークフロー管理」アプレットの「タイプ」ドロップダウン・リスト、「名前」エントリ、および「説明」フィールドに対応しています。

dWfStepWeightを数値に設定すると、「ワークフロー管理」アプレットの「ワークフロー・ステップ」の「レビューアの最低必要人数」オプションに関連付けられているフィールドに値を入力するのと同じになります。定義されている場合、dWfStepWeightで指定されたユーザー数がリビジョンを承認するとすぐに、ワークフローは次のステップに移ります。

dWfStepIsAllを1 (true)に設定すると、「ワークフロー管理」アプレットの「ワークフロー・ステップ」の「すべてのレビューア」オプションを有効にするのと同じになります。trueに設定した場合、ワークフローが次のステップに移る前に、ステップに割り当てられているすべてのユーザーがリビジョンを承認する必要があります。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。
dWfStepName: ワークフロー・ステップ名。
dAliases: ステップに使用されるエイリアスおよびユーザーのタブ区切りのリスト。このパラメータの形式は、(alias/user)\t(alias/user type)\t(alias/user)\t(alias/user type)です。
dWfStepDescription: ステップの説明。
dWfStepType: ワークフロー・ステップ・タイプ
- レビューア: リビジョンを承認または拒否します。
- レビューア/コントリビュータ: リビジョンを編集、承認および拒否できます。
dWfStepIsAll:
- 1 (true): ワークフローが次のステップに移る前に、ステップに割り当てられているすべてのユーザーがリビジョンを承認する必要があります。
- 0 (false): 必要な承認数がdWfStepWeightパラメータによって指定されます。
dWfStepWeight: ワークフローが次のステップに移る前に、リビジョンを承認する必要があるレビューアの数。
- dWfStepIsAllが1 (true)の場合、このパラメータは無視されます。dWfStepIsAllが0 (false)の場合、このパラメータは有効になります。
- このパラメータを0 (ゼロ)に設定すると、リビジョンがステップに到達したときに、レビューアに通知されますが、そのステップではリビジョンの承認、却下、編集はできません。ワークフローは自動的に次のステップに進みます。

オプションのサービス・パラメータ

wfEntryScript: ステップ・エントリのスクリプト。
wfExitScript: ステップ終了スクリプト。
wfUpdateScript: ステップ更新スクリプト。

ノート:

スクリプトは、<$および$>デリミタ内に配置される必要があります。For example, <$if ConditionExpression$>

例

次の例では、表記規則\tがタブ区切リを示していることに注意してください。

IdcService=EDIT_WORKFLOWSTEP
dWfName=test_workflow
dWfStepName=edit
dWfStepType=Reviewer/Contributor
dWfStepDescription=copy edit step
dAliases=AllUsers\taliases\tsysadmin\tuser
dWfStepIsAll=0
dWfStepWeight=2
wfEntryScript=
wfExitScript=
wfUpdateScript=

5.4.24 GET_ACTIVE_WORKFLOWS

ユーザーがワークフローを選択し、ワークフロー内のすべてのドキュメントを表示可能な「アクティブなワークフロー」ページを返すサービス。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

結果

ResultSets:
- StdWorkflows (dWfName、dWfID、dWfDescription、dCompletionDate、dSecurityGroup、dWfStatus、dWfType、dIsCollaboration)
- ClbraWorkflows (StdWorkflowsと同じフィールド)
- ClbraAccessList (dClbraName、userList、aliasList)
レスポンス・テンプレート: WORKFLOW_LIST (workflow_list.htm)

使用

リソース・インクルード:
- pne_nav_management_links
- std_doc_man_pages
テンプレート:
- WORKFLOW_REJECT_FORM (reject_doc.htm)
- ALL_WORKFLOW_DOCS (workflow_all_docs_list.htm)
- WORKFLOW_DOCS (workflow_docs_list.htm)
- WORKFLOW_INFO (workflow_info.htm)
- WF_INQUEUE_LIST (workflow_queue.htm)
- WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
標準ナビゲーション: commonNav.js

5.4.25 GET_CRITERIA_WORKFLOWS_FOR_GROUP

指定されたセキュリティ・グループのワークフローを返すワークフロー・アプレットで使用されるサービス。このサービスは、返されたワークフローのステップ情報を返します。最も発生しがちなエラーは、セキュリティ・グループが存在しないか、ユーザーがセキュリティ・チェックに失敗することです。

WorkflowsForGroupおよびWorkflowStepsForGroup結果セットを返します。

WorkflowsForGroupでは、このグループに対するすべてのワークフローがリストされます(dWfID、dWfName)。
WorkflowStepsForGroupでは、このグループに対するすべてのワークフローのすべてのステップがリストされます(dWfID、dWfName、dWfStepID、dWfStepName)。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。

例

IdcCommandコマンド・ファイル・フォーマット:

# Retrieves criteria workflow information
IdcService=GET_CRITERIA_WORKFLOWS_FOR_GROUP
dSecurityGroup=Public

HDA形式:

@Properties LocalData
IdcService=GET_CRITERIA_WORKFLOWS_FOR_GROUP
dSecurityGroup=Public
@end

5.4.26 GET_WF_COMPANION_INFO

ワークフロー内のドキュメントのコンパニオン情報ファイルを返します。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dDocName: ワークフロー内のドキュメントの名前。
dWfName: ワークフロー名。

5.4.27 GET_WORKFLOW

特定のワークフローに関する情報を返すサービス。最も発生しがちなエラーは、ワークフロー名が存在しないことです。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。

例

IdcService=GET_WORKFLOW
dWfName=mktg_review

5.4.28 GET_WORKFLOW_INFO

コンテンツ・アイテムのワークフロー・ステップ情報を返すサービス。このサービスは、PNEリンクから「アクティブなワークフロー」を選択し、ワークフロー名をクリックしてから、ステップ名のリンクをクリックすることにより、ブラウザ・インタフェースで実行されます。

最も発生しがちなエラーは、コンテンツ・アイテムまたはワークフロー名が存在しないことです。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

実行される問合せ: QdocInfo、QworkflowDocument、QworkflowForID、QwfDocState、QworkflowSteps

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dID: 生成済のコンテンツ・アイテムのリビジョンID。
dWfStepID: ワークフロー・コントリビューション・ステージID。自動生成される値はデータベース表から取得できます。

結果

ResultSets:
- WorkflowSteps(指定されたワークフローのWorkflowSteps DB表のすべての行からの全フィールド)
- WorkflowSteps(現在のステップのすべてのWorkflowStepsフィールドと、dUsersおよびdHasTokensフィールド)
- DOC_INFO(指定されたリビジョンのRevisionsおよびDocMetaからのすべてのフィールド)
- WorkflowInfo(指定されたワークフローのWorkflows DB表からのすべてのフィールド)
- WorkflowState(指定されたコンテンツ・アイテムのWorkflowState DB表からのdUserNameフィールドのみ)
- WorkflowActionHistory (data\workflow\statesディレクトリの対応するHDAファイルからの結果セット)
ローカル・データ:
- AuthorAddress
- dID
- dUser
- dWfCurrentStepID
- dWfName
- dWfStepID
- RemainingStepUsers
レスポンス・テンプレート: WORKFLOW_INFO (workflow_info.htm)

使用

リソース・インクルード: clbra_wf_doc_list

例

IdcService=GET_WORKFLOW_INFO
dID=61
dWfStepID=19

5.4.29 GET_WORKFLOW_INFO_BYNAME

ワークフローのドキュメントの名前に基づいたワークフローに関する情報を取得するために使用されるサービス。ドキュメントの履歴、ワークフローに残っているステップ、現在のワークフローのレビュー担当者をリストする、コンテンツ・アイテムの「ワークフロー情報」ページを返します。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

実行される問合せ:

QdocNameMeta
QworkflowDocument
QworkflowForID
QwfDocState
QworkflowSteps

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dDocName: アクティブなワークフロー内のドキュメントの名前。

結果

ResultSets:
- WorkflowSteps(指定されたワークフローのWorkflowSteps DB表のすべての行からの全フィールド)
- WorkflowSteps(現在のステップのすべてのWorkflowStepsフィールドと、dUsersおよびdHasTokensフィールド)
- DOC_INFO(指定されたコンテンツ・アイテムのRevisionsおよびDocMetaからのすべてのフィールド)
- WorkflowInfo(指定されたワークフローのWorkflows DB表からのすべてのフィールド)
- WorkflowState(指定されたコンテンツ・アイテムのWorkflowState DB表からのdUserNameフィールドのみ)
- WorkflowActionHistory (data\workflow\statesディレクトリの対応するHDAファイルからの結果セット)
ローカル・データ:
- AuthorAddress
- dUser
- dWfName
- dWfStepID
- RemainingStepUsers
レスポンス・テンプレート: WORKFLOW_INFO (workflow_info.htm)

使用

リソース・インクルード:
- setup_workflow_action_popups
- wf_in_queue_display
- workflow_action_popup
テンプレート:
- WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
- WORKFLOW_REVIEW_FRAMES (workflow_review_frames.htm)
その他: SoapCustom:Wsdl:Workflow:Services

5.4.30 GET_WORKFLOW_INQUEUE_LIST_EX

ワークフローに存在するコンテンツ・アイテムのリストを返し、'doMarkFavorites'、'ResultCount'、'StartRow'などのパラメータ、および'xComments'などのメタデータ・フィールドをサポートするサービス。

このサービスは、次のパラメータを入力として使用し、ワークフロー内のすべてのアイテムのリストを返します。結果は結果セット'WorkFlowInQueue'に存在します。

オプションのサービス・パラメータ

doMarkFavorites (Integer(0/1)): 設定すると、'WorkFlowInQueue'結果セットにfisFavoriteフィールドが追加されます。お気に入りフォルダにアイテムがある場合、それはお気に入りです。Frameworkfoldersでのみ使用できます。
StartRow (Integer): 返される結果の最初の行の番号。デフォルトは1です。
ResultCount (Integer): 結果セット内に返される行の最大数。デフォルトは20です。
MaxRows (Integer): ページ区切り付きで返される合計行の最大数。デフォルトは200です。
wfSortField (String): 結果セット'WorkFlowInQueue'のソートに使用されるフィールド。デフォルトは'dwfQueueLastActionTs'です。
wfSortOrder (String): 結果セット'WorkFlowInQueue'のソートに使用される順序。Asc (昇順)またはDesc (降順)を指定できます。デフォルトはDescです。

返されるデータ

StartRow (Integer): 結果セット内に返される最初の行の番号。
EndRow (Integer): 結果セット内に返される最後の行の番号。
PageNumber (Integer): 現在返されるページの番号。
WorkFlowInQueue (ResultSet): アイテムに関する情報を含む様々なメタデータ・フィールドが含まれます。これらのフィールドの一部を次に示します:
- dDocName: ワークフロー内のアイテムの名前。
- dID: ワークフロー内のアイテムのコンテンツID。
- xComments: アイテムに指定されたコメント。
- dOriginalName: チェックインされる元のファイルの名前。
- fisFavorite: ファイルがお気に入りかどうかを示します(doMarkFavoritesが'1'に設定されている場合のみ使用可能)。

5.4.31 GET_WORKFLOW_SCRIPT

ワークフロー・スクリプトを取得するために使用されるサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

wfScriptName: 使用されるスクリプト・テンプレートの名前。
wfScriptDescription: スクリプトに使用される説明。

5.4.32 GET_WORKFLOWDOCREVISIONS

特定のワークフローにあるコンテンツ・アイテムのリビジョンのリストを返すサービス。このサービスは、PNEリンクの「アクティブなワークフロー」を選択し、ワークフロー名をクリックすることにより、ブラウザ環境で実行されます。

最も発生しがちなエラーは、ワークフロー名が存在しないことです。

アクセス・レベル: 読取り、書込み、スクリプト作成可能(49)

実行される問合せ:

Qworkflow
QwfStates
QworkflowDocuments
QworkflowSteps

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。

オプションのサービス・パラメータ

dClbraName: 指定されたコラボレーション・プロジェクトのアイテムのみを含むように結果をフィルタ処理します。

結果

ResultSets:
- WorkflowSteps(指定されたワークフローのWorkflowSteps DB表のすべての行からの全フィールド、および追加フィールドdUsersとdHasTokens)
- WfDocuments(指定されたワークフローに属する各コンテンツ・アイテムに対応する行。各行にはWorkflowDocuments、RevisionsおよびDocMeta DB表からのすべてのフィールドが含まれます)
- WorkflowStates(指定されたワークフローのWorkflowStates DB表からのすべてのフィールド)
- WF_INFO(指定されたワークフローのWorkflows DB表からのすべてのフィールド)
ローカル・データ:
- clbraAccount
- dClbraName
- dUser
- dWfName
- isCollaboration
レスポンス・テンプレート:
- WORKFLOW_DOCS (workflow_docs_list.htm)

使用

リソース・インクルード:
- active_collaboration_workflows_table
- checkin_multiuploadapplet_processing_functions
- setup_active_standard_workflows_table_row
- legacy_active_collaboration_workflows_table
- legacy_active_standard_workflows_table
- wf_in_queue_display
- workflow_action_popup
- workflow_revisions_href
テンプレート:
- CONTRIBUTOR_MAIL (contributor_mail.htm)
- PROJECT_INFO (project_info.htm)
- WF_REJECT_MAIL (reject_mail.htm)
- WORKFLOW_INFO (workflow_info.htm)
- WORKFLOW_REJECT_FORM (reject_doc.htm)
- WORKFLOW_REVIEW_FORM (workflow_review_form.htm)
その他: SoapCustom:Wsdl:Workflow:Services
- リダイレクト・サービスの対象: WORKFLOW_APPROVE、WORKFLOW_EDIT_APPROVE、WORKFLOW_REJECT、WORKFLOW_CHECKIN

例

IdcService=GET_WORKFLOW
dWfName=mktg_review

5.4.33 GET_WORKFLOWS

説明、セキュリティ・グループ、ステータスおよびタイプを含むすべてのワークフローのリストを取得するサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

5.4.34 TEST_WORKFLOW_SCRIPT

ワークフロー・スクリプトの妥当性をチェックするために使用されるサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

wfScriptName: 使用されるスクリプト・テンプレートの名前。
wfScriptDescription: スクリプトに使用される説明。
dDocName: テスト・シナリオに使用されるコンテンツ・アイテム。

5.4.35 WORKFLOW_APPROVE

ワークフロー内のコンテンツ・アイテムのリビジョンを承認するサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dID: 生成済のコンテンツ・アイテムのリビジョンID。

例

IdcService=WORKFLOW_APPROVE
dID=81

5.4.36 WORKFLOW_CANCEL

基準ワークフローをキャンセルするサービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。

例

IdcService=WORKFLOW_CANCEL
dWfName=mktg_review

5.4.37 WORKFLOW_CHECKIN

ワークフロー内にあるコンテンツ・アイテムの新しいリビジョンをチェックインするサービス。最も発生しがちなエラーは、指定されたコンテンツ・アイテムまたはワークフローが存在しないことです。

このサービスはWORKFLOW_CHECKIN_SUBサブサービスを実行します。このサブサービスは、ワークフローにコンテンツ・アイテムのリビジョンをチェックインします。

アクセス・レベル: 読取り(1)

実行される問合せ: QdociInfo、Qrevisions

サブサービスのコール: WORKFLOW_CHECKIN_SUB

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dDocName: コンテンツ・アイテムの識別子(コンテンツID)。
dID: 生成済のコンテンツ・アイテムのリビジョンID。
dSecurityGroup: PublicやSecure.などのセキュリティ・グループ。
dDocAccount: コンテンツ・アイテムのアカウント。アカウントが有効化されている場合のみ必要。
primaryFile: Content Serverインスタンスから見た、ファイルの場所への絶対パス。ファイルの区切り文字としてスラッシュを使用します。

プライマリ・ファイルは、メタデータのみをチェックインするのではないかぎり、指定する必要があります。プライマリ・ファイルとともに代替ファイルが指定された場合、コンテンツ・リファイナリにより代替ファイルが変換されます。それ以外の場合、プライマリ・ファイルが変換されます。
- プライマリ・ファイルが指定されない場合、そのかわりにメタファイルを使用できます。ただし、各コンテンツ・アイテムに対して存在できるメタファイルは1つのみです(プライマリのメタファイルと代替のメタファイルは共存できません)。
- プライマリと代替の両方のファイルを指定する場合、それらの拡張子は異なっている必要があります。

オプションのサービス・パラメータ

isFinished: 却下されたコンテンツ・アイテムに対する編集が終了したことを示します。
- 1 (true): リビジョンがチェックインされ、コンテンツがレビュー・ステータスに変わります。
- 0 (false): リビジョンがチェックインされますが、承認される必要があります。
doFileCopy:
- 1 (true): ファイルはチェックイン後にハード・ドライブから削除されません。
- 0 (false): ファイルはチェックイン後にハード・ドライブから削除されます。
alternateFile
RedirectUrl

結果

ローカル・データ:
- Content Server:
  - alternateFile
  - changedSubjects
  - CurRevID
  - dAction
  - dActionDate
  - dCheckoutUser
  - dClbraName
  - dConversion
  - dCreateDate
  - dDocAccount
  - dDocAuthor
  - dDocID
  - dDocName
  - dDocTitle
  - dDocType
  - dExtension
  - dFileSize
  - dFormat
  - dID
  - dInDate
  - dIsPrimary
  - dIsWebFormat
  - dlsCheckedOut
  - doFileCopy
  - dLocation
  - dOriginalName
  - dOutDate
  - dpAction
  - dpEvent
  - dProcessingState
  - dPublishState
  - dPublishType
  - dRawDocID
  - dReleaseState
  - dRevClassID
  - dRevisionID
  - dRevLabel
  - dRevRank
  - dSecurityGroup
  - dStatus
  - dUser
  - dUserName
  - isCheckin
  - isCurRevEmpty
  - isDocProfileUsed
  - isEditMode
  - isInfoOnly
  - isNew
  - IsNotLatestRev
  - isStatusChanged
  - IsUpdate
  - IsWorkflow
  - latestID
  - oldName
  - prevID
  - prevReleaseState
  - primaryFile
  - VaultfilePath
  - WebfilePath
- ワークフロー:
  - dWfComputed
  - dWfCurrentStepID
  - dWfDirectory
  - dWfDocState
  - dWfEntry
  - dWfID
  - dWfName
  - dWfStatus
  - dWfStepID
  - dWfStepDescription
  - dWfStepIsAll
  - dWfStepName
  - dWfStepType
  - dWfStepWeight
  - dWfType
  - dWorkflowState
  - entryCount
  - wfAction
  - wfCurrentStepPrefix
  - WfEditFinished
  - wfMessage
  - wfStepCheckinType
レスポンス・テンプレート:
- REDIRECT_TEMPLATE (redirect_template.htm)
- デフォルト・リダイレクト・サービス(branched): GET_WORKFLOWDOCREVISIONSまたはGET_PORTAL_PAGE (Page=WF_INQUEUE_LIST)

例

IdcService=WORKFLOW_CHECKIN
dID=92
dDocName=test_00063
dWfID=4
dSecurityGroup=Public
dDocAccount=mainaccount
dWfType=Criteria
dWfName=mktg_review
primaryFile=c:/hello_hello.txt
dRevLabel=2
doFileCopy=1
isFinished=1

5.4.38 WORKFLOW_EDIT_APPROVE

チェックイン/チェックアウト・プロセスを経ないで、ドキュメントを承認する機能を必要とするクライアント・アプリケーションに使用される(つまり、コアContent Serverソフトウェアによって使用されない)サービス。

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

5.4.39 WORKFLOW_REJECT

ワークフロー内のコンテンツ・アイテムのリビジョンを拒否するサービス。

現在のステップのレビューアとして定義されている場合を除き、システム管理者はワークフローのコンテンツ・アイテムを承認または拒否することはできません。したがって、IdcCommandのこのサービスをユーザーsysadminとして実行する場合、sysadminがレビューアとして定義されている場合を除き、コンテンツ・アイテムを拒否することはできません。

アクセス・レベル: 読取り(1)

実行される問合せ:

QdocInfo
IworkflowDocHistory
UrevisionStatus
UworkflowDocStep
UrevisionStatus
DworkflowDocState
QwfDocInformation

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dID: 生成済のコンテンツ・アイテムのリビジョンID。
wfRejectMessage: 拒否メッセージ。

オプションのサービス・パラメータ

RedirectUrl

結果

ローカル・データ:
- Content Server:
  - changedSubjects
  - dActionDate
  - dClbraName
  - dDocAuthor
  - dDocName
  - dDocTitle
  - dExtension
  - dID
  - dPublishState
  - dReleaseState
  - dRevClassID
  - dStatus
  - dUser
  - isCurRevEmpty
  - IsWorkflow
  - prevReleaseState
- ワークフロー:
  - dAction
  - dOriginalName
  - dWfCompute
  - dWfCurrentStepID
  - dWfDirectory
  - dWfDocState
  - dWfID
  - dWfName
  - dWfStatus
  - dWfStepDescription
  - dWfStepID
  - dWfStepIsAll
  - dWfStepName
  - dWfStepType
  - dWfStepWeight
  - dWfType
  - dWorkflowState
  - entryCount
  - wfAction
  - wfCurrentStepPrefix
  - WfEditFinished
  - wfMailSubject
  - wfMailTemplate
  - wfMessage
  - wfRejectMessage
  - wfStepCheckinType
  - wfUsers
レスポンス・テンプレート:
- REDIRECT_TEMPLATE (redirect_template.htm)
- デフォルト・リダイレクト・サービス(branched): GET_WORKFLOWDOCREVISIONSまたはGET_PORTAL_PAGE (Page=WF_INQUEUE_LIST)

参照

アプレット: リポジトリ・マネージャ
テンプレート: WORKFLOW_REJECT_FORM (reject_doc.htm)
その他: SoapCustomer:Wsdl:Workflow:Services

例

IdcService=WORKFLOW_REJECT
dID=95
wfRejectMessage=Please Revise

5.4.40 WORKFLOW_START

サービス・クラス: ワークフロー・サービス

場所: IdcHomeDir/resources/core/templates/tables/workflow.htm

追加の必須サービス・パラメータ

dWfName: ワークフロー名。
dSecurityGroup: PublicやSecureなどのセキュリティ・グループ。

オプションのサービス・パラメータ

wfMessage: 「ワークフロー開始の通知」電子メールに記載されているメッセージ。

例

IdcService=WORKFLOW_START
dWfName=mktg_review
dSecurityGroup=Public
wfMessage=Please check in this content item