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複写ノードでの案件複写先ノード情報の生成
HwfGetGsTakeOverDataGroupmax Integrated Desktop引き継ぎ情報ファイルからの情報取得×
HwfSetGsTakeOverData引き継ぎ情報ファイルの生成×
HwfSetGsApResultGroupmax Integrated Desktop起動,後処理ユーザプログラム処理結果の登録×
HwfDownLoadFileExサーバのファイル更新日付のチェックとダウンロード×※2
HwfGetNodeNameFromCopyInf複写先ノード情報からの複写先ノード名称の取得
HwfGetDeliverKey配布キーの取得
HwfDrawRoute案件の経路表示×
HwfChangePasswdパスワードの変更
HwfSetNewPasswdパスワード有効期限切れ状態でのパスワードの変更

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

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

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

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