Groupmax Workflow - Library Version 6プログラミングガイド

[目次][用語][索引][前へ][次へ]

2.2 API関数の関数一覧

ここでは,ユーザがアプリケーションプログラムを開発するために必要なAPI関数の一覧を示します。各API関数の文法については,Groupmax Workflow - Libraryオンラインヘルプを参照してください。

表2-1にAPI関数一覧を示します。

表2-1 API関数一覧(Workflow - Library)

区分 API関数名称 機能概要 サーバ クライアント
セション操作 HwfStartUpWorkflow ワークフローシステムの利用開始 ※1
HwfStartUpWorkflowSV ワークフローシステムの利用開始 ×
HwfCleanUpWorkflow ワークフローシステムの利用終了
ユーザ操作 HwfGetUserAnd ユーザ情報の取得
HwfGetUserInfo ユーザ属性情報の取得
HwfGetUserListFromOrgan 組織下のユーザ一覧の取得
HwfGetUserListFromRole ロールに登録されているユーザ一覧の取得
HwfActUser ユーザトレーへの案件配布受付制限解除 ×※2
HwfDeactUser ユーザトレーへの案件配布受付制限 ×※2
ビジネスプロセス定義操作 HwfGetBusinessProcess ビジネスプロセス定義情報の取得
ロール操作 HwfGetRoleAnd ロール情報の取得
HwfGetRoleListFromRole 階層化ロールに登録されているロール一覧の取得
HwfGetOrganizationList 組織一覧の取得
ワーク操作 HwfGetWorkAttribute ワーク情報の取得
HwfSetWorkTerm ワークの処理期限変更 ×※2
HwfSetWorkPriority ワークの優先度変更 ×※2
HwfCancelWorkEx ワークのキャンセル
HwfGetWorkStatus ワークの状態確認
案件操作 HwfGetCaseFormSelectEx ビジネスプロセス定義に投入できる案件情報の取得
HwfGetCasePutOperation ビジネスプロセス定義開始処理ノードのユーザ処理リストの取得
HwfPutCase 文書とメモを格納した案件のビジネスプロセス定義への投入
HwfPutCaseEx 文書とメモを格納した案件のビジネスプロセス定義への投入(HwfPutCaseの拡張版)
HwfGetCaseFromRoleEx ロールトレーからユーザトレーへの案件の取り出し
HwfPutCaseFromUser ユーザトレーからロールトレーへの案件の返却
HwfTakeBackCaseEx 案件の引き戻し要求(ヒストリハンドル指定)
HwfTakeBackCaseDirect 案件の引き戻し要求(ユーザ保持情報指定)
ユーザトレー
内案件操作
HwfGetCaseSelectData 案件情報の取得
HwfGetOperation カレントノードでの案件のユーザ処理リスト取得
HwfPrefixCase 案件情報,案件内の文書,及びメモの取得
HwfSuffixCase 文書とメモを格納した案件を次ノードへ遷移
HwfRoundCaseEx 他ユーザへの案件の相談
HwfAnswerCase 他ユーザから相談された案件の回答 ×※2
HwfTrustCaseEx 他ユーザへの案件処理依頼
HwfSendBackCaseEx 案件の差し戻し要求
HwfGetBackUserHandleList 差し戻し先ユーザ一覧の取得
HwfDeleteCase 投入エラー案件の削除
HwfRecoverCase エラー案件の回復 ×※2
HwfRecoverPutErrCase 投入エラー案件の再投入 ×※2
ユーザトレー内案件属性操作 HwfGetAttributeValueByAttributeName 属性名称指定による案件のユーザ属性取得
HwfGetAttributeValueByUserDefNameEx ユーザ定義名称指定による案件のユーザ属性取得
HwfSetCase 案件への作業結果の登録
HwfSetCaseByUserDefName ユーザ定義名称指定による案件への作業結果の登録
HwfGetCaseExistUserAttrValue 案件のユーザ属性値設定情報の取得
文書,メモ操作 HwfGetCaseDocumentList 案件の添付文書,添付メモ一覧の取得
HwfGetCaseDocument 案件からの添付文書,添付メモの取得
HwfUpdateCaseDocument 案件の添付文書,添付メモの更新
GUI付き候補
者選択
HwfSelectNextUser 次ノード処理ユーザの選択 ×
HwfSelectNextUserEx 次ノード処理ユーザの選択(HwfSelectNextUserの拡張版) ×
HwfGetConsultantList 相談先ユーザ一覧の取得 ×
HwfGetTransferUserList 振り替え先ユーザ一覧の取得 ×
HwfGetBackUserListEx 差し戻し先ユーザ一覧の取得 ×
案件コメント操作 HwfEditCaseComment 案件コメントの編集 ×
ヒストリ操作 HwfPutUserDataToHistory ワークヒストリへのユーザ任意情報設定出力
HwfGetWorkHistoryEx ワークヒストリの取得(ハンドル又は案件オブジェクトID指定)
HwfGetWorkHistoryDirect ワークヒストリの取得(ユーザ保持情報指定)
HwfGetUserHistoryEx ユーザヒストリの取得
HwfGetUserHistoryDx ユーザヒストリの取得(HwfGetUserHistoryExの拡張版)
HwfDeleteUserHistoryEx ユーザヒストリの削除
オブジェクト操作 HwfGetObjectAttributeEx オブジェクト属性情報取得
HwfSelectObjectId オブジェクト識別子の検索
HwfGetAttributeByObject オブジェクト属性情報取得 ※3
案件保存
ファイル操作
HwfGetCaseSize 案件サイズの取得 ×
HwfSaveCase 案件の保存 ×
HwfGetLocalCaseAttribute 案件保存ファイルからの属性の取得 ×
HwfGetLocalCaseInfo 案件保存ファイルからの案件個別情報の取得 ×
HwfGetLocalCaseUserAttribute 案件保存ファイルからのユーザ属性の取得 ×
HwfGetLocalCaseOperation 案件保存ファイルからのユーザ処理リストの取得 ×
HwfGetLocalCaseComment 案件保存ファイルからのユーザ任意データの取得 ×
HwfGetLocalCaseDocumentList 案件保存ファイルからの文書,メモ一覧の取得 ×
HwfGetLocalCaseDocument 案件保存ファイルからの文書,メモの取得 ×
代行操作 HwfSubstitutionLogin 代行処理の開始 ×
HwfSubstitutionLogout 代行処理の終了 ×
HwfSubstitutionGetCase 代行処理者ユーザトレー内の案件情報取得 ×
HwfSubstitutionTransferUser 代行案件の振り替え先ユーザ一覧の取得 ×
HwfSubstitutionTrustCase 代行ユーザトレー内案件の他ユーザへの処理依頼 ×
HwfSetSubstitution 代行者の設定 ×
HwfGetSubstitution 代行者の取得 ×
その他の操作 HwfConvertNodeid ノードIDからノード名称への変換
HwfInitArrivedCaseList ユーザトレー内着信案件情報の初期化 ×※2
HwfGetArrivedCaseList ユーザトレー内着信案件情報の取得 ×※2
HwfTakeOperationInf 作業情報からの属性情報の取り出し
HwfCreateCopyInfEx 複写ノードでの案件複写先ノード情報の生成
HwfGetGsTakeOverData Groupmax Integrated Desktop引き継ぎ情報ファイルからの情報取得 ×
HwfSetGsTakeOverData 引き継ぎ情報ファイルの生成 ×
HwfSetGsApResult Groupmax Integrated Desktop起動,後処理ユーザプログラム処理結果の登録 ×
HwfDownLoadFileEx サーバのファイル更新日付のチェックとダウンロード ×※2
HwfGetNodeNameFromCopyInf 複写先ノード情報からの複写先ノード名称の取得
HwfGetDeliverKey 配布キーの取得
HwfDrawRoute 案件の経路表示 ×
HwfChangePasswd パスワードの変更
HwfSetNewPasswd パスワード有効期限切れ状態でのパスワードの変更

(凡例)○は使用できることを示します。×は使用できないことを示します。

注※1 AIXの場合,使用できません。

注※2 Windows NT/2000の場合,使用できます。

注※3 HI-UX/WE2版,HP-UX版,及びAIX版の場合,使用できます。