付録L.4 AP関数リファレンス

<この項の構成>
(1) AP関数一覧
(2) セション操作API関数
(3) ユーザ操作AP関数
(4) ビジネスプロセス定義操作AP関数
(5) ロール操作AP関数
(6) ワーク操作AP関数
(7) 案件操作AP関数
(8) ユーザトレー内案件操作AP関数
(9) ユーザトレー内案件属性操作AP関数
(10) 文書メモ操作AP関数
(11) ヒストリ操作AP関数
(12) オブジェクト操作AP関数
(13) その他のAP関数

(1) AP関数一覧

HwfActUser

HwfAnswerCase

HwfCancelWorkEx

HwfChangePasswd

HwfCleanUpWorkflow

HwfConvertNodeid

HwfCreateCopyInf

HwfCreateCopyInfEx

HwfDeactUser

HwfDeleteCase

HwfDeleteUserHistoryEx

HwfDownLoadFileEx

HwfGetArrivedCaseList

HwfGetAttributeValueByAttributeName

HwfGetAttributeValueByUserDefName

HwfGetBackUserHandleList

HwfGetBusinessProcess

HwfGetCaseDocument

HwfGetCaseDocumentList

HwfGetCaseExistUserAttrValue

HwfGetCaseFormSelectEx

HwfGetCaseFromRoleEx

HwfGetCasePutOperation

HwfGetCaseSelectData

HwfGetDeliverKey

HwfGetNodeNameFromCopyInf

HwfGetObjectAttributeEx

HwfGetOperation

HwfGetOrganizationList

HwfGetRoleAnd

HwfGetRoleListFromRole

HwfGetUserAnd

HwfGetUserHistoryDx

HwfGetUserHistoryEx

HwfGetUserInfo

HwfGetUserListFromOrgan

HwfGetUserListFromRole

HwfGetWorkAttribute

HwfGetWorkHistoryDirect

HwfGetWorkHistoryEx

HwfGetWorkStatus

HwfInitArrivedCaseList

HwfPrefixCase

HwfPutCase

HwfPutCaseEx

HwfPutCaseFromUser

HwfPutUserDataToHistory

HwfRecoverCase

HwfRecoverPutErrCase

HwfRoundCaseEx

HwfSelectObjectId

HwfSendBackCaseEx

HwfSetCase

HwfSetCaseByUserDefName

HwfSetWorkPriority

HwfSetWorkTerm

HwfStartUpWorkflow

HwfStartUpWorkflowSV

HwfSuffixCase

HwfTakeBackCaseDirect

HwfTakeBackCaseEx

HwfTakeOperationInf

HwfTrustCaseEx

HwfUpdateCaseDocument

(2) セション操作API関数

(a) HwfStartUpWorkflow(ワークフローシステムの利用開始)
機能
ワークフローシステムの利用を開始します。
HwfStartUpWorkflowとHwfStartUpWorkflowSVは,プロセス内で合わせて1回だけ発行するようにしてください。
HwfStartUpWorkflowは旧バージョンとの互換用の関数です。新規にアプリケーションを作成する場合は,HwfStartUpWorkflowSV関数を使用してください。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long  HwfStartUpWorkflow(
 BWF_username_t   __far *username,    /* ログインユーザID格納領域 (I) */
 BWF_password_t   __far *password,    /* ログインパスワード格納領域 (I) */
 HWND                   hwnd,       /* 親ウィンドウのハンドル (I) */
 long                   gmax_mode,    /* Groupmaxログインモード (I) */
 long                   startup_mode,   /* スタートアップモード (I) */
 long                   shared_mode ,   /* セション共用モード (I) */
 BWF_server_t     __far *server,     /* サーバ名称格納領域 (I/O) */
 BWF_useroid_t    __far *useroid,     /* ユーザオブジェクトID取得領域 (O) */
 BWF_userstatus_t __far *userstatus,   /* 案件受付状態取得領域 (O) */
 BWF_userdistinct_t __far *userdistinct, /* ユーザ権限コード取得領域  (O) */
 BWF_errlist_t    __far *errlist,     /* エラー情報取得領域 (O) */
 void             __far *arg       /* 拡張用領域のアドレス (-) */
);

typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
username
ログインするユーザのユーザIDを格納した領域を指定してください。
ユーザIDは,Groupmax Addressに登録したユーザIDを終端にNULL文字を付けた9バイト以内の文字列で指定してください。
password
usernameで指定したユーザのパスワードを格納した領域を指定します。
パスワードは,終端にNULLを付けた9バイト以内の文字列で指定してください。
hwnd
NULLを指定してください。
gmax_mode
Groupmaxログインダイアログを使用するかどうかを指定するパラメタですが,サーバライブラリではGroupmaxログインダイアログを使用できません。
0を指定してください。
startup_mode
スタートアップモードを指定してください。
1:サーバにログインし,ユーザ認証を行います。
shared_mode
セション共用モードを指定するパラメタですが,サーバライブラリでは,セション共用ができないので,ログインするアプリケーションごとにセションを生成します。
1を指定してください。
 
非共用セションを使用するアプリケーションを複数同時に使用できます。この場合,アプリケーションごとにTCP/IPソケットを使用するため,システム全体で使用できるソケット数の上限に注意してください。また,Groupmax Workflow Serverの「1ユーザあたりの同時接続セション数」の設定値も確認してください。
server
接続先サーバ名称を格納した領域を指定します。接続先サーバ名称は,hostsファイルにあらかじめ定義しておく必要があります。このAPI関数の戻り値がBWF_OK(正常リターン)の場合,接続したサーバのサーバ名称を取得します。取得したサーバ名称は,指定した名称と同一であるとは限りません。
useroid
ログインユーザのオブジェクト識別子を取得する領域(8バイト)のアドレスを指定してください。
userstatus
usernameパラメタで指定したユーザの,案件受付状態を取得する領域を指定してください。
案件受付状態の詳細を次に示します。
act△:受付許可状態
dea△:代行者配布状態
inac:受付禁止状態
注 △は,スペースを示します。
userdistinct
usernameパラメタで指定したユーザの,ユーザ権限コードを取得する領域を指定してください。
ユーザ権限コードの詳細を次に示します。
sys△:systemユーザ
wfm△:ワークフロー管理者
gen△:一般ユーザ
注 △は,スペースを示します。
このパラメタの取得値は,Groupmax Workflow - Library 02-10以降に初めてアプリケーションを作成する場合は,意味を持ちません。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定してください。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
予備領域です。NULLポインタを指定してください。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • ログインするプロセスごとにこのAPI関数を発行してください。
  • セションはプロセス単位で管理されます。このため,あるプロセスで通信処理中に,そのプロセスの別スレッドから通信要求をすると処理不正になることがあります。マルチスレッドでアプリケーションを作成する場合,Groupmax Workflowに要求するスレッドはある時点では一つに限定されるようにしてください。
  • ワークフローユーザ定義でドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者に設定した場合でも,この関数でログインしたユーザは,一般ユーザとして扱われます。
  • ログインする前に作業ディレクトリを指定する必要があります。作業ディレクトリは環境変数「GMAXWFTMP」で指定します。作業ディレクトリの指定方法はマニュアル「Groupmax Workflow - Library プログラミングガイド」の「アプリケーション開発手順」を参照してください。
  • Groupmax Addressのパスワード有効期限管理機能を使用している場合,指定したパスワードの有効期限が切れている場合でもログイン可能です。Groupmax Addressのパスワード有効期限管理機能を使用する場合は,HwfStartUpWorkflowSV関数を使用してください。
  • Groupmax Workflow Serverの複数サービス機能を利用している場合,ログインする前に環境変数でサービス名を指定する必要があります。サービス名の指定方法はマニュアル「Groupmax Workflow - Libraryプログラミングガイド」の「アプリケーション開発手順」を参照してください。
(b) HwfStartUpWorkflowSV(ワークフローシステムの利用開始)
機能
HwfStartUpWorkflowSVは,ワークフローシステムの利用を開始するサーバライブラリ専用のAPI関数です。
HwfStartUpWorkflowとHwfStartUpWorkflowSVは,プロセス内で合わせて1回発行するようにしてください。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long  HwfStartUpWorkflowSV(
 char             __far *server_name, /* サーバ名称指定領域 (I) */
 BWF_username_t   __far *username,   /* ログインユーザID格納領域 (I) */
 long                    user_type,  /* 種別 (I) */
 BWF_password_t   __far *password,   /* ログインパスワード格納領域 (I) */
 BWF_server_t     __far *server,    /* サーバ名称取得領域 (O) */
 BWF_useroid_t    __far *useroid,   /* ユーザオブジェクトID取得領域 (O) */
 long             __far *passwd_limit, /* パスワードの有効期限 (O) */
 BWF_errlist_t    __far *errlist,   /* エラー情報取得領域 (O) */
 void             __far *arg      /* 拡張用領域のアドレス (-) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
server_name
接続先サーバ名称又はIPアドレスを指定します。サーバ名称又はIPアドレスは,終端にNULL文字を付けた文字列で指定してください。
username
ログインするユーザのユーザIDを格納した領域を指定します。
ユーザIDは,Groupmax Addressに登録したユーザIDを,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
user_type
このパラメタには,0を指定してください。
password
usernameで示されるユーザのパスワードを格納した領域を指定します。
パスワードは,Groupmax Addressに登録したユーザIDに対応するパスワードを,終端にNULLを付けた9バイト以内の文字列で指定してください。
server
ユーザのサーバ名称を取得する領域を指定します。Groupmax Workflow上でのホームサーバのサーバ名称が取得できます。なお,このパラメタは,API関数の戻り値がBWF_OK(正常リターン)の場合に設定されます。サーバ名称が15バイトを超えると,先頭の15バイトまでが格納されます。
取得したサーバ名は,PCのhostsファイルに定義されているとはかぎりません。
useroid
ログインユーザのオブジェクト識別子を取得する領域(8バイト)のアドレスを指定します。
passwd_limit
パスワードの有効期限を格納する領域を指定します。有効期限が設定されていない場合は0を返却します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • Groupmax Workflow Server - Libraryは,バージョン03-00以降でなければなりません。また,接続するGroupmax Workflow Serverのバージョンも03-00以降でなければなりません。
  • ログインするプロセスごとにこの関数を発行してください。
  • セションはプロセス単位で管理されます。このため,あるプロセスで,通信処理中にそのプロセスの別スレッドから通信要求をすると,処理不正になることがあります。マルチスレッドでアプリケーションを作成する場合,Groupmax Workflowに要求するスレッドは,ある時点では一つに限定されるようにしてください。
  • ワークフローユーザ定義でドメイン管理者,ワークフロー管理者,又はビジネスプロセス管理者に設定した場合でも,この関数でログインしたユーザは,一般ユーザとして扱われます。
  • Groupmax Addressのパスワード有効期限管理機能を使用している場合,指定したパスワードの有効期限が切れているとエラーリターンします。有効期限が切れる前にパスワードを変更しておいてください。有効期限は,passwd_limitパラメタの戻り値で取得できます。
  • 各関数の第1,第2パラメタ(useroid,server)で指定するユーザオブジェクトIDとサーバ名称は,HwfStartUpWorkflow関数だけでなく,このAPI関数でも取得できます。
  • ログインする前に作業ディレクトリを指定する必要があります。作業ディレクトリは環境変数「GMAXWFTMP」で指定します。作業ディレクトリの指定方法はマニュアル「Groupmax Workflow - Library プログラミングガイド」の「アプリケーション開発手順」を参照してください。
  • Groupmax Workflow Server複数サービス機能を利用している場合,ログインする前に環境変数でサービス名を指定する必要があります。サービス名の指定方法はマニュアル「Groupmax Workflow - Libraryプログラミングガイド」の「アプリケーション開発手順」を参照してください。
(c) HwfCleanUpWorkflow(ワークフローシステムの利用終了)
機能
ワークフローシステムの利用を終了します。Groupmax Workflow Serverとの接続を切り,セションを終了します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long  HwfCleanUpWorkflow(
 BWF_useroid_t  __far *useroid, /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,  /* サーバ名称格納領域 (I) */
 BWF_errlist_t  __far *errlist, /* エラー情報取得領域 (O) */
 void           __far *arg    /* 拡張用領域のアドレス (-) */
);

typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflow又はHwfStartUpWorkflowSVで取得したログインユーザのオブジェクト識別子を格納した領域を指定してください。
server
HwfStartUpWorkflow又はHwfStartUpWorkflowSVで取得したログインユーザのGroupmax Workflow上でのホームサーバ名称を格納した領域を指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定してください。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
予備領域です。NULLポインタを指定してください。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • この関数は必ずHwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数発行元プロセスと同じプロセスから発行してください。
  • この関数は,HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数に対応して,ワークフローシステムの使用をやめるときに必ず発行してください。

(3) ユーザ操作AP関数

(a) HwfGetUserAnd(ユーザ情報の取得)
機能
次に示す条件に対応するユーザのユーザ情報を取得します。
  1. ログインユーザのGroupmax Workflow上でのホームサーバに登録されているすべてのユーザ
  2. ログインユーザのGroupmax Workflow上でのホームサーバに登録されているユーザのうち,指定された業務ロール,又は組織ロールに関連するユーザ
  3. ログインユーザのGroupmax Workflow上でのホームサーバに登録されているユーザのうち,指定したビジネスプロセス定義のすべてのノードで指定されている業務ロールに関連するユーザ
  4. ログインユーザのGroupmax Workflow上でのホームサーバに登録されているユーザのうち,指定されたビジネスプロセス定義のすべてのノードで指定されている業務ロールに関連するユーザ,かつ指定された業務ロールに関連するユーザ
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetUserAnd(
 BWF_useroid_t  __far *useroid,   /* ユーザオブジェクトID 格納領域 (I) */
 BWF_server_t   __far *server,   /* サーバ名称格納領域 (I) */
 long                 reqmode,   /* 要求種別 (I) */
 long                 bpidlistn,  /* ビジネスプロセス定義オブジェクトID配列要素数 (I) */
 BWF_bpidlist_t __far *bpidlist,  /* ビジネスプロセス定義オブジェクトID配列格納領域 (I) */
 long                 roleidlistn,   /* ロールオブジェクトID配列要素数 (I) */
 BWF_roleidlist_t __far *roleidlist,  /* ロールオブジェクトID配列格納領域 (I) */
 long                 sortkey,   /* ソートキー (I) */
 long                 sortmode,   /* ソートモード (I) */
 long                 number,    /* ユーザ属性リスト取得先頭要素番号 (I) */
 long                 userlistn,  /* ユーザ属性リスト取得要素数 (I) */
 long           __far *total,    /* ユーザ属性リスト全要素数 (O) */
 long           __far *count,    /* 取得ユーザ属性リスト要素数 (O) */
 BWF_userlist_t __far *userlist,  /* ユーザ属性リスト取得領域 (O) */
 BWF_errlist_t  __far *errlist   /* エラー情報取得領域 (O) */
);

typedef struct BWF_userlist_t {
 BWF_useroid_t BWF_us_oid;          /* ユーザオブジェクトID (O) */
 BWF_useroid_t BWF_us_user_id;        /* ユーザID (O) */
 char          BWF_us_user_alias_name[64];  /* ユーザ別名(ユーザ日本語名称) (O) */
 char          BWF_us_user_name[8];      /* 作成者ID (O) */
 BWF_time_t    BWF_us_create_time;      /* 作成日時 (O) */
 unsigned long BWF_us_case_count;       /* 案件数 (O) */
 char          BWF_us_status_code[4];     /* 案件受付状態 (O) */
 BWF_oid_t     BWF_us_approval_code;     /* 印章情報オブジェクトID (-) */
 char          BWF_us_distinction_code[4];  /* ユーザ権限コード (O) */
} BWF_userlist_t;

typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したログインユーザのオブジェクト識別子を格納した領域を指定します。
server
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したログインユーザのGroupmax Workflow上でのホームサーバ名称を格納した領域を指定します。
reqmode
情報を取得するユーザに関する条件を,次に示す要求種別によって指定します。
BWF_GU_SYSTEM_MODE:ログインユーザのGroupmax Workflow上でのホームサーバに登録されているすべてのユーザを対象とします。
BWF_GU_BP_MODE:ログインユーザのGroupmax Workflow上でのホームサーバに登録されているユーザのうち,bpidlistパラメタで指定したビジネスプロセス定義のすべてのノードで指定されている業務ロールに関連するユーザを対象とします。
BWF_GU_ROLE_MODE:ログインユーザのGroupmax Workflow上でのホームサーバに登録されているユーザのうち,roleidlistパラメタで指定した業務ロール,又は組織ロールに関連するユーザを対象とします。
BWF_GU_BP_ROLE_MODE:ログインユーザのGroupmax Workflow上でのホームサーバに登録されているユーザのうち,bpidlistパラメタで指定したビジネスプロセス定義のすべてのノードで指定されている業務ロールに関連するユーザ,かつroleidlistパラメタで指定した業務ロールに関連するユーザを対象とします。
 
reqmodeの指定によって,次に示すように以降のパラメタに情報を設定する必要があります。
reqmodebpidlistroleidlist
BWF_GU_SYSTEM_MODE××
BWF_GU_BP_MODE×
BWF_GU_ROLE_MODE×
BWF_GU_BP_ROLE_MODE
(凡例)
○:指定が必要です。
×:指定は不要です。

bpidlistn
bpidlistにビジネスプロセス定義オブジェクトIDを設定した要素数を指定します。reqmodeでBWF_GU_BP_MODE,BWF_GU_BP_ROLE_MODEを指定した場合は,必ず1以上を指定してください。引数roleidlistnと合わせて7459まで指定できます。
bpidlist
reqmodeでBWF_GU_BP_MODE,BWF_GU_BP_ROLE_MODEを指定した場合に,対象とするビジネスプロセス定義オブジェクトIDをbpidlistnパラメタで指定した数分格納した領域を指定します。
指定されたビジネスプロセスに関連する業務ロールに含まれるユーザの情報を取得します。
roleidlistn
roleidlistにロールオブジェクトIDを設定した要素数を指定します。reqmodeでBWF_GU_ROLE_MODE,BWF_GU_BP_ROLE_MODEを指定した場合は,必ず1以上の値を指定してください。引数bpidlistnと合わせて7459まで指定できます。
roleidlist
reqmodeでBWF_GU_ROLE_MODE,BWF_GU_BP_ROLE_MODEを指定した場合に,対象とするロールオブジェクトIDをroleidlistnパラメタで指定した数分格納した領域を指定します。業務ロール,又は組織ロールのオブジェクトIDを指定することができます。
sortkey
ユーザ情報をソートして取得する場合は,次に示すキーを指定します。
sortmodeパラメタにBWF_NOSORT_MODEを指定した場合は,指定する必要はありません。
BWF_SRT_US_NAME:ユーザID
BWF_SRT_US_ALIAS_NAME:ユーザ別名(ユーザ日本語名称)
BWF_SRT_US_CREATE_NAME:作成者ID
BWF_SRT_US_CREATE_TIME:作成日時
BWF_SRT_US_STATUS_CODE:案件受付状態
BWF_SRT_US_DISTINCTION_CODE:ユーザ権限コード
sortmode
ユーザ属性リストをソートする場合のソート順を指定します。
BWF_ASCEND_MODE:昇順にソートします。
BWF_DESCEND_MODE:降順にソートします。
BWF_NOSORT_MODE:ソートしません。
number
ユーザ属性リストを取得する要素の先頭番号を指定します。
先頭番号は0~(total-1)の範囲内で指定してください。
userlistn
ユーザ属性リストを取得する要素数を指定します。1~537までの範囲内で指定してください。
total
ユーザ属性リストの取得できる全要素数(reqmodeパラメタで指定した条件に対応するユーザ数)を取得する領域を指定します。
count
このAPI関数が取得したユーザ属性リストの要素数を取得する領域を指定します。
userlist
ユーザ属性リストを取得する領域を指定します。userlistnで指定した要素数分の領域を必ず指定してください。ユーザ属性リストに取得される項目については,ユーザ属性リスト内項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • reqmodeパラメタで指定した条件に対応するユーザがいない場合は,totalは0で,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • numberパラメタで指定した値がtotalパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • reqmodeパラメタにBWF_GU_ROLE_MODEを指定する場合,ロールオブジェクトIDには業務ロール,又は組織ロールのものを指定してください。
  • reqmodeパラメタにBWF_GU_BP_ROLE_MODEを指定する場合,ロールオブジェクトIDには業務ロールを指定してください。ロールオブジェクトIDに組織ロールを指定すると取得数0で正常リターンします。
  • 階層化ロールを使用しているビジネスプロセス定義に関連するユーザの情報を取得する場合,階層化ロール下のユーザの情報は取得できません。
  • 取得するユーザ情報が多く,この関数を複数回に分けて発行する必要がある場合,この関数のソート機能を使用すると,応答時間が大幅に劣化することがあります。この場合,アプリケーション側でソート処理をしてください。
(b) HwfGetUserInfo(ユーザ属性情報の取得)
機能
ユーザのニックネーム,又はユーザIDからユーザの属性情報を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetUserInfo(
 BWF_useroid_t  __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,   /* サーバ名称格納領域           (I) */
 unsigned long         mode,    /* 処理モード                   (I) */
 char           __far *user_name, /* ユーザニックネーム又はユーザID  (I) */
 BWF_userinfo_t __far *user_info, /* ユーザ属性情報取得領域         (O) */
 BWF_errlist_t  __far *errlist,  /* エラー情報取得領域          (O) */
 void           __far *arg     /* 予備領域 (-) */
);

typedef struct BWF_userinfo_t {
 char          sUserID[8];     /* ユーザID (O) */
 char          sNickName[132];   /* ユーザニックネーム (O) */
 char          sFNAME[20];     /* ユーザ英ファーストネーム (O) */
 char          sLNAME[20];     /* ユーザ英ラストネーム (O) */
 char          sJNAME[36];     /* ユーザ日本語名 (O) */
 char          sOrg[36];      /* ユーザ所属組織略称 (O) */
 char          sPost[36];     /* ユーザ役職名称 (O) */
 char          sHostName[36];   /* ホームサーバ名称 (O) */
 char          sIPADDR[16];    /* ホームサーバipアドレス (O) */
 char          sBossName[8];    /* 上長ユーザID (O) */
 char          sBossNickName[132]; /* 上長ニックネーム (O) */
 char          sBossNameJP[36];  /* 上長日本語名 (O) */
 char          sOrgId[8];     /* ユーザ所属組織ID (O) */
 unsigned long sOrgType;      /* ユーザ所属組織の種別 (O) */
 char          sOrgJNAME[132];   /* ユーザ所属組織日本語名 (O) */
 char          sReserved[364];   /* 予備領域 (-) */
} BWF_userinfo_t;

typedef struct BWF_errlist_t{
 char sBMsgKbn[6];         /* メッセージ区分 (O) */
 long lBMsgNo;           /* メッセージ番号 (O) */
 char sBInsWord[13];        /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したログインユーザのオブジェクト識別子を格納した領域を指定します。
server
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したログインユーザのGroupmax Workflow上でのホームサーバ名称を格納した領域を指定します。
mode
処理のモードを指定してください。
0:ユーザIDからユーザの属性情報を取得します。user_nameパラメタに属性情報を取得するユーザのユーザIDを設定した領域のアドレスを指定してください。
1:ニックネームからユーザの属性情報を取得します。user_nameパラメタに属性情報を取得するユーザのニックネームを設定した領域のアドレスを指定してください。
user_name
属性情報を取得するユーザのユーザID,又はニックネームを指定してください。
modeパラメタに0を指定した場合は,終端にNULL文字を付けた9バイト以内の文字列でユーザIDを指定してください。
modeパラメタに1を指定した場合は,終端にNULL文字を付けた132バイト以内の文字列でニックネームを指定してください。
user_info
user_nameパラメタで指定したユーザの属性情報を取得する領域を指定してください。
ユーザの属性情報として取得される項目については,ユーザ属性情報項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定してください。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
予備領域です。NULLポインタを指定してください。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(c) HwfGetUserListFromOrgan(組織下のユーザ一覧の取得)
機能
指定した組織に所属するユーザ情報の一覧を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetUserListFromOrgan(
 BWF_useroid_t   __far *useroid,     /* ユーザオブジェクトID格納領域   (I) */
 BWF_server_t    __far *server,     /* サーバ名称格納領域 (I) */
 char            __far *orgid,      /* 取得するユーザ情報の所属組織ID格納領域 (I) */
 unsigned long         orgtype,     /* 取得するユーザ情報の所属組織の種別 (I) */
 char            __far *beforeuserid,  /* 直前のユーザIDの格納領域 (I) */
 BWF_bpid_t      __far *bpid,      /* ビジネスプロセス定義オブジェクトID格納領域 (I) */
 char            __far *nodename,    /* 対象条件のノード名称格納領域 (I) */
 unsigned long         userlistn,    /* 取得するユーザ情報の要素数 (I) */
 unsigned long   __far *count,      /* ユーザ情報取得要素数格納領域 (O) */
 BWF_org_user_t  __far *userlist,    /* ユーザ情報格納領域 (O) */
 BWF_errlist_t   __far *errlist,     /* エラー情報取得領域 (O) */
 void            __far *arg       /* 予備領域 (-) */
);

typedef struct BWF_org_user_t{
 char sUserId[8];    /* ユーザID (O) */
 char sNickName[132];  /* ユーザニックネーム (O) */
 char sJNAME[36];    /* ユーザ日本語名 (O) */
 char sOrg[36];     /* ユーザ所属組織略称 (O) */
 char sPost[36];     /* ユーザ役職名称 (O) */
 char reserved[264];   /* 予備領域 (-) */
} BWF_org_user_t;

typedef struct BWF_errlist_t{
 char sBMsgKbn[6];    /* メッセージ区分 (O) */
 long lBMsgNo;      /* メッセージ番号 (O) */
 char sBInsWord[13];   /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したログインユーザのオブジェクト識別子を格納した領域を指定します。
server
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したログインユーザのGroupmax Workflow上でのホームサーバ名称を格納した領域を指定します。
orgid
ユーザ情報を取得する組織の,組織IDを格納した領域を指定してください。組織IDは,終端にNULL文字を付けた9バイト以内の文字列で指定してください。組織IDはHwfGetUserInfo関数などで取得できます。
orgtype
orgidで指定した組織の種別を指定してください。
BWF_TOP_ORG:orgidで指定した組織が「最上位組織」であることを指定します。
BWF_LOW_ORG:orgidで指定した組織が「組織」であることを指定します。
beforeuserid
前回取得したユーザの続きからユーザ情報を取得する場合,前回取得した最後のユーザIDを格納した領域を指定します。ユーザIDは,終端にNULL文字を付けた9バイト以内の文字列で指定してください。ユーザ情報を先頭から取得する場合は,NULLポインタを指定してください。
bpid
ビジネスプロセス定義が配布されているサーバをGroupmax Workflow上でのホームサーバとするユーザのユーザ情報だけを取得対象とする場合,ビジネスプロセス定義オブジェクトIDを格納した領域を指定してください。ビジネスプロセス定義オブジェクトIDは,HwfGetCaseFormSelectEx関数,HwfGetCaseSelectData関数などで取得できます。
ビジネスプロセス定義のオブジェクトIDを指定しない場合は,NULLポインタを指定してください。
nodename
bpidパラメタで指定したビジネスプロセス定義オブジェクトIDに対応するビジネスプロセス定義に含まれる特定のノードで作業権限のあるユーザだけを取得対象とする場合,対象とするノード名称を指定してください。ノード名称は,終端にNULL文字を付けた64バイト以内の文字列で指定してください。ノード名称は,HwfGetCaseFormSelectEx関数,HwfGetCaseSelectData関数などで取得できます。
ノード名称を指定しない場合は,NULLポインタを指定してください。
ノード名称を指定する場合は,必ずbpidパラメタに対象とするビジネスプロセス定義オブジェクトIDを指定してください。
userlistn
取得するユーザ情報の数を指定します。1~100の範囲内で指定してください。
count
取得したユーザ情報の数を格納する領域を指定してください。
userlist
取得したユーザ情報を格納する領域を指定してください。userlistnパラメタで指定した数分の領域を必ず指定してください。ユーザ情報として取得される項目については,ユーザ情報取得項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定してください。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
予備領域です。NULLポインタを指定してください。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • orgidパラメタで指定した組織ID及びorgtypeパラメタで指定した組織種別に一致する組織がない場合,このAPI関数の戻り値は,エラーリターン(BWF_ERROR)となります。
  • countパラメタに格納された値がuserlistnパラメタで指定した値未満の場合は,ユーザ情報に続きの情報はありません。countパラメタに格納された値がuserlistnパラメタで指定した値と同じ場合は,続きのユーザ情報がある可能性があります。続きのユーザ情報を取得する場合は,beforeuseridパラメタに取得した最後のユーザIDを格納した領域を指定して,再度本API関数を発行して取得してください。
  • 他ユーザへの案件処理依頼や次ノード処理ユーザの指定などで選択できるユーザのユーザ情報を取得する場合は,bpidパラメタ及びnodenameパラメタにそれぞれビジネスプロセス定義オブジェクトID,ノード名称を指定してください。ビジネスプロセス定義オブジェクトIDとノード名称は,次に示す方法で指定してください。ただし,ノードの作業権限に組織による権限を使用している場合は,権限のないユーザも取得されますのでご注意ください。
 他ユーザへの案件処理依頼で選択できるユーザを取得する場合
HwfGetCaseSelectData関数で取得した上位案件項目リスト内のビジネスプロセス定義オブジェクトID及びノード名称を取り出してbpidパラメタ,nodenameパラメタに指定します。
 次ノード処理ユーザの指定で選択できるユーザを取得する場合
HwfGetCaseFormSelectEx関数又はHwfGetCaseSelectData関数で取得したビジネスプロセス定義オブジェクトIDをbpidパラメタに指定します。
ノード名称は,HwfGetCaseFormSelectEx関数及びHwfGetOperation関数などで取得したユーザ処理リスト内の作業情報からアプリケーションで独自に取り出して,nodenameパラメタに指定します。
 相談で選択できるユーザを取得する場合
HwfGetCaseSelectData関数で取得した上位案件項目リスト内のビジネスプロセス定義オブジェクトIDを取り出して,bpidパラメタに指定します。
ノード名称の指定は不要なので,nodenameパラメタにはNULLポインタを指定してください。
(d) HwfGetUserListFromRole(ロールに登録されているユーザ一覧の取得)
機能
指定したロール(業務ロール)に登録されているユーザ情報の一覧を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetUserListFromRole(
 BWF_useroid_t   __far *useroid,  /* ユーザオブジェクトID格納領域   (I) */
 BWF_server_t    __far *server,   /* サーバ名称格納領域 (I) */
 BWF_roleid_t    __far *roleid,   /* ロールオブジェクトID格納領域 (I) */
 BWF_bpid_t      __far *bpid,    /* ビジネスプロセス定義オブジェクトID格納領域 (I) */
 char            __far *nodename,  /* 対象条件のノード名称格納領域 (I) */
 unsigned long         number,   /* ユーザ情報取得先頭要素番号 (I) */
 unsigned long         userlistn,  /* 取得するユーザ情報の要素数 (I) */
 unsigned long   __far *total,   /* ユーザ情報全要素数格納領域    (O) */
 unsigned long   __far *count,   /* ユーザ情報取得要素数格納領域 (O) */
 BWF_userlist_in_role_t __far  *userlist,  /* ユーザ情報格納領域 (O) */
 BWF_errlist_t   __far *errlist,  /* エラー情報取得領域 (O) */
 void            __far *arg     /* 予備領域 (-) */
);

typedef struct BWF_userlist_in_role_t{
 char sUserId[8];   /* ユーザID (O) */
 char sNickName[132]; /* ユーザニックネーム (O) */
 char sUserName[36];  /* ユーザ日本語名 (O) */
 char sOrgName[36];  /* ユーザ所属組織略称 (O) */
 char sPost[36];    /* ユーザ役職名称 (O) */
 char reserved[264];  /* 予備領域 (-) */
} BWF_userlist_in_role_t;

typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したログインユーザのオブジェクト識別子を格納した領域を指定します。
server
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したログインユーザのGroupmax Workflow上でのホームサーバ名称を格納した領域を指定します。
roleid
取得対象とするロール(業務ロール)のロールオブジェクトIDを格納した領域を指定してください。ロールオブジェクトIDはHwfGetRoleAnd関数などで取得できます。
bpid
ビジネスプロセス定義が配布されているサーバをGroupmax Workflow上でのホームサーバとするユーザのユーザ情報だけを取得対象とする場合,ビジネスプロセス定義オブジェクトIDを格納した領域を指定してください。ビジネスプロセス定義オブジェクトIDは,HwfGetCaseFormSelectEx関数,HwfGetCaseSelectData関数などで取得できます。
ビジネスプロセス定義のオブジェクトIDを指定しない場合は,NULLポインタを指定してください。
nodename
bpidパラメタで指定したビジネスプロセス定義オブジェクトIDに対応するビジネスプロセス定義に含まれる特定のノードで作業権限のあるユーザだけを取得対象とする場合,対象とするノード名称を指定してください。ノード名称は,終端にNULL文字を付けた64バイト以内の文字列で指定してください。
ノード名称を指定しない場合は,NULLポインタを指定してください。
ノード名称を指定する場合は,必ずbpidパラメタに対象とするビジネスプロセス定義オブジェクトIDを指定してください。
number
ユーザ情報リストを取得する要素の先頭番号を指定してください。先頭番号は0~(total-1)の範囲内で指定してください。
userlistn
取得するユーザ情報の数を指定します。1~100の範囲内で指定してください。
total
ユーザ情報リストの全要素数を格納する領域を指定してください。
count
取得したユーザ情報の数を格納する領域を指定してください。
userlist
取得したユーザ情報を格納する領域を指定してください。userlistnパラメタで指定した数分の領域を必ず指定してください。ユーザ情報として取得される項目については,ユーザ情報取得項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定してください。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
予備領域です。NULLポインタを指定してください。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数は,業務ロールにのみ対応しています。roleidパラメタに指定されたロールオブジェクトIDのロール種別が組織ロール又は階層化ロールの場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。ロールオブジェクトIDに対応するロール種別は,HwfGetObjectAttributeEx関数で取得できます。
  • numberパラメタで指定した値がtotalパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 他ユーザへの案件処理依頼や次ノード処理ユーザの指定などで選択できるユーザのユーザ情報を取得する場合は,bpidパラメタ及びnodenameパラメタにそれぞれビジネスプロセス定義オブジェクトID,ノード名称を指定してください。ビジネスプロセス定義オブジェクトIDとノード名称は,次に示す方法で指定してください。
 他ユーザへの案件処理依頼で選択できるユーザを取得する場合
HwfGetCaseSelectData関数で取得した上位案件項目リスト内のビジネスプロセス定義オブジェクトID及びノード名称を取り出してbpidパラメタ,nodenameパラメタに指定します。
 次ノード処理ユーザの指定で選択できるユーザを取得する場合
HwfGetCaseFormSelectEx関数又はHwfGetCaseSelectData関数で取得したビジネスプロセス定義オブジェクトIDをbpidパラメタに指定します。
ノード名称は,HwfGetCaseFormSelectEx関数及びHwfGetOperation関数などで取得したユーザ処理リスト内の作業情報からアプリケーションで独自に取り出して,nodenameパラメタに指定します。
 相談で選択できるユーザを取得する場合
HwfGetCaseSelectData関数で取得した上位案件項目リスト内のビジネスプロセス定義オブジェクトIDを取り出して,bpidパラメタに指定します。
ノード名称の指定は不要なので,nodenameパラメタにはNULLポインタを指定してください。
(e) HwfActUser(ユーザトレーへの案件配布受付の制限解除)
機能
ユーザトレーの案件受付状態を代行者配布及び受付禁止から受付許可に変更します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
自分のユーザトレーの案件受付状態を代行者配布及び受付禁止から受付許可状態に変更できます。
構文

#include<bwf.h>
long HwfActUser(
 BWF_useroid_t __far *useroid,   /* ユーザオブジェクトID格納領域   (I) */
 BWF_server_t  __far *server,   /* サーバ名称格納領域 (I) */
 BWF_useroid_t __far *suseroid,  /* 案件の受付状態を変更する         */
                  /* ユーザオブジェクトID格納領域 (I) */
 BWF_errlist_t __far *errlist   /* エラー情報取得領域 (O) */
);

typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したログインユーザのオブジェクト識別子を格納した領域を指定します。
server
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したログインユーザのGroupmax Workflow上でのホームサーバ名称を格納した領域を指定します。
suseroid
案件の受付状態を変更するユーザのユーザオブジェクトID(HwfStartUpWorkflow,HwfGetUserAndなどで取得できます)を格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数を発行するユーザが一般ユーザで,useroidとsuseroidに指定したものが同一でない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • suseroidに指定したユーザがこのシステムに登録されていない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(f) HwfDeactUser(ユーザトレーへの案件配布受付の制限)
機能
ロールトレーからユーザトレーに対する案件受付状態を受付許可から代行者配布に変更します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
一般ユーザ以外は,受付許可状態となっているすべてのユーザのトレーに対して,代行者配布状態にできます。
一般ユーザは,自分のトレーが受付許可状態の場合だけ,代行者配布状態にできます。
構文

#include<bwf.h>
long HwfDeactUser(
 BWF_useroid_t __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,   /* サーバ名称格納領域 (I) */
 BWF_useroid_t __far *suseroid,  /* 案件の受付状態を変更する         */
                  /* ユーザオブジェクトID格納領域 (I) */
 BWF_errlist_t __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
suseroid
案件の受付状態を変更するユーザのユーザオブジェクトID(HwfStartUpWorkflow,HwfGetUserAndなどで取得できます)を格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数を発行するユーザが一般ユーザで,useroidとsuseroidに指定したものが同一でない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • suseroidに指定したユーザがこのシステムに登録されていない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(g) ユーザ属性リスト内項目
項目内容
BWF_us_oidユーザオブジェクトIDが設定されます。
BWF_us_user_idBWF_us_oidに対応するユーザIDが設定されます。
ユーザIDの長さが8バイト未満の場合は,終端にNULL文字を付けて格納します。
ユーザIDの長さが8バイトの場合は,終端にNULL文字を付けないで格納します。
BWF_us_user_alias_nameBWF_us_oidに対応するユーザ別名(ユーザ日本語名称)が設定されます。
BWF_us_user_nameBWF_us_oidに対応するユーザをシステムに登録したユーザのユーザIDが設定されます。
BWF_us_create_timeBWF_us_oidに対応するユーザをシステムに登録した日時が設定されます。
日時:YYYYMMDDhhmmss形式
BWF_us_case_countBWF_us_oidに対応するユーザのユーザートレー内の案件数(上位案件と単体案件の総数)が設定されます。
BWF_us_status_code案件受付状態が設定されます。
act△:受付許可状態
dea△:代行者配布状態
inac:受付禁止状態
注:△は半角スペースを示します。
BWF_us_approval_code印章情報オブジェクトIDが設定されます(このバージョンでは何も設定されません)。
BWF_us_distinction_codeBWF_us_oidに対応するユーザ権限コードが設定されます。
sys△:systemユーザ
wfm△:ワークフロー管理者
gen△:一般ユーザ
注:△は半角スペースを示します。
この取得値は,Groupmax Workflow Client - Library 02-10以降で初めてアプリケーションを作成する場合は,意味を持ちません。
YYYYMMDDhhmmss形式
項目長さ設定内容
YYYY4年の西暦4けた(例:1996,1997,.....)
MM2月の2けた(例:01,02,.....)
DD2日の2けた(例:01,02,.....)
hh2時の2けた(24時間制)(例:01,02,.....)
mm2分の2けた(例:01,02,.....)
ss2秒の2けた(例:01,02,.....)

YYYYMMDDhhmmss形式の指定範囲は,1970/01/01 10:00:00 ~ 2038/01/19 03:14:07です。


(h) ユーザ属性情報項目
項目内容
sUserIDユーザIDを格納します。
ユーザIDの長さが8バイト未満の場合は,終端にNULL文字を付けて格納します。ユーザIDが8バイトの場合は,終端にNULL文字を付けないで格納します。
sNickNameユーザのニックネームを格納します。
sFNAMEユーザのファーストネーム(英語)を格納します。
sLNAMEユーザのラスト(ファミリ)ネーム(英語)を格納します。
sJNAMEユーザの日本語名称を格納します。
sOrgユーザの所属組織略称を格納します。
sPostユーザの役職を格納します。
sHostNameユーザのGroupmax Workflow上でのホームサーバ名称を格納します。
sIPADDRGroupmax Workflow上でのホームサーバのIPアドレスを文字列形式で格納します。
sBossName上長のユーザIDを格納します。
上長のユーザIDの長さが8バイト以内の場合は,終端にNULL文字を付けて格納します。上長のユーザIDが8バイトの場合は,終端にNULL文字を付けないで格納します。
sBossNickName上長のニックネームを格納します。
sBossNameJP上長の日本語名を格納します。
sOrgIdユーザの所属組織IDを格納します。
sOrgTypeユーザの所属組織の種別を格納します。
BWF_TOP_ORG:ユーザの所属組織が「最上位組織」であることを示します。
BWF_LOW_ORG:ユーザの所属組織が「組織」であることを示します。
sOrgJNAMEユーザの所属組織の日本語名を格納します。
sReserved予備領域です。
(i) ユーザ情報取得項目(HwfGetUserListFromOrgan)
項目内容
sUserIdユーザIDを格納します。
ユーザIDの長さが8バイト未満の場合は,終端にNULL文字を付けて格納します。ユーザIDの長さが8バイトの場合は,終端にNULL文字を付けないで格納します。
sNickNamesUserIdに対応したユーザのニックネームを格納します。
sJNAMEsUserIdに対応したユーザの日本語名称を格納します。
sOrgsUserIdに対応したユーザの所属組織略称を格納します。
sPostsUserIdに対応したユーザの役職を格納します。
reserved予備領域です。 NULLを格納します。
(j) ユーザ情報取得項目(HwfGetUserListFromRole)
項目内容
sUserIdユーザIDを格納します。
ユーザIDの長さが8バイト未満の場合は,終端にNULL文字を付けて格納します。ユーザIDの長さが8バイトの場合は,終端にNULL文字を付けないで格納します。
sNickNamesUserIdに対応したユーザのニックネームを格納します。
sUserNamesUserIdに対応したユーザの日本語名称を格納します。
sOrgNamesUserIdに対応したユーザの所属組織略称を格納します。
sPostsUserIdに対応したユーザの役職を格納します。
reserved予備領域です。NULLを格納します。

(4) ビジネスプロセス定義操作AP関数

(a) HwfGetBusinessProcess(ビジネスプロセス定義情報の取得)
機能
ビジネスプロセス定義情報(ビジネスプロセス定義リスト)を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetBusinessProcess(
 BWF_useroid_t __far *useroid, /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,  /* サーバ名称格納領域 (I) */
 long               reqmode,  /* 要求種別 (I) */
 long               selectmode, /* 選択条件 (I) */
 BWF_useroid_t __far *suseroid, /* ユーザオブジェクトID格納領域 (I) */
 BWF_roleid_t  __far *roleid,  /* ロールオブジェクトID格納領域 (I) */
 long                sortkey,  /* ソートキー (I) */
 long                sortmode, /* ソートモード (I) */
 long                number,  /* ビジネスプロセス定義リスト取得先頭要素番号 (I) */
 long                bplistn,  /* ビジネスプロセス定義リスト取得要素数 (I) */
 long          __far *total,  /* ビジネスプロセス定義リスト全要素数 (O) */
 long          __far *count,  /* 取得ビジネスプロセス定義リスト要素数 (O) */
 BWF_bplist_t  __far *bplist,  /* ビジネスプロセス定義リスト取得領域 (O) */
 BWF_errlist_t __far *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_bplist_t{
 BWF_bpid_t     BWF_bp_oid;           /* ビジネスプロセス定義オブジェクトID */
 char           BWF_bp_bp_name[64];       /* ビジネスプロセス定義名 */
 char           BWF_bp_create_name[8];     /* 作成者ID */
 BWF_time_t     BWF_bp_create_time;       /* 作成日時 */
 unsigned long  BWF_bp_version_number;     /* バージョン番号 */
 unsigned long  BWF_bp_work_count;       /* ワーク数 */
 BWF_userkey_t  BWF_bp_user_key;        /* 案件識別子フォーマット */
 char           BWF_bp_define_create_name[64]; /* 定義作成者 */
 BWF_time_t     BWF_bp_define_time;       /* 定義日時 */
 char           BWF_bp_status_code[4];     /* 状態コード */
 char           BWF_bp_exec_status_code[4];   /* 運用コード */
 char           BWF_bp_except_code[4];     /* 例外処理コード */
 char           BWF_bp_comment[128];      /* コメント */
} BWF_bplist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
reqmode
情報を取得するビジネスプロセス定義に関する条件を,次に示す要求種別によって指定します。
BWF_NO_COND:条件を指定しません。
BWF_LATEST_VERSION:各ビジネスプロセス定義の最新バージョンだけを取得します。
BWF_ACT:運用可能状態のビジネスプロセス定義の情報を取得します。
BWF_WORK_EXIST:ワークがあるビジネスプロセス定義の情報を取得します。
BWF_ACT_LATEST:各ビジネスプロセス定義のうち,運用可能な中で最新バージョンの情報を取得します。
BWF_V2_LATEST:拡張ビジネスプロセス定義の最新バージョンだけを取得します。
selectmode
reqmodeで指定した条件に加えて,更に絞りこむ場合のモードを指定します。
BWF_SYSTEM_MODE:全ビジネスプロセス定義を対象とします。
BWF_USER_MODE:suseroidで指定したユーザが直接,又はそのユーザが属するロールによって関連するビジネスプロセス定義を対象とします。
BWF_USER_ONLY_MODE:suseroidで指定したユーザが直接関連するビジネスプロセス定義だけを対象とします。
BWF_USER_SRC_MODE:suseroidで指定したユーザが直接,又はそのユーザが属するロールによって開始処理ノードとして関連するビジネスプロセス定義を対象とします。
BWF_USER_ONLY_SRC_MODE:suseroidで指定したユーザが開始処理ノードとして直接関連するビジネスプロセス定義を対象とします。
BWF_ROLE_MODE:roleidで指定したロールが関連するビジネスプロセス定義を対象とします。
BWF_ROLE_SRC_MODE:roleidで指定したロールが開始処理ノードとして関連するビジネスプロセス定義を対象とします。
selectmodeの指定によって,次に示すように以降のパラメタに情報を設定する必要があります。
selectmodesuseroidroleid
BWF_SYSTEM_MODE××
BWF_USER_MODE×
BWF_USER_ONLY_MODE×
BWF_USER_SRC_MODE×
BWF_USER_ONLY_SRC_MODE×
BWF_ROLE_MODE×
BWF_ROLE_SRC_MODE×
(凡例)
○:指定が必要です。
×:指定は不要です。

suseroid
ビジネスプロセス定義を選択するためのユーザオブジェクトID(HwfGetUserAndで取得できます)を格納した領域を指定します。
roleid
ビジネスプロセス定義を選択するためのロールオブジェクトID(HwfGetRoleAndで取得できます)を格納した領域を指定します。
sortkey
ビジネスプロセス定義リストをソートする場合に,次に示すキーを指定します。sortmodeにBWF_NOSORT_MODEを指定した場合は,指定する必要はありません。
BWF_SRT_BP_NAME:ビジネスプロセス定義名
BWF_SRT_BP_CREATE_NAME:作成者ID
BWF_SRT_BP_CREATE_TIME:作成日時
BWF_SRT_BP_STATUS_CODE:状態コード
BWF_SRT_BP_EXEC_CODE:運用コード
sortmode
ビジネスプロセス定義リストをソートする場合のソート順を指定します。
BWF_ASCEND_MODE:昇順にソートします。
BWF_DESCEND_MODE:降順にソートします。
BWF_NOSORT_MODE:ソートしません。
number
ビジネスプロセス定義リストを取得する要素の先頭番号を指定します。先頭番号は0~(total-1)の範囲内で指定してください。
bplistn
ビジネスプロセス定義リストを取得する要素数を指定します。1~170までの範囲内で指定してください。
total
ビジネスプロセス定義リストの取得できる全要素数(このシステムに登録されたビジネスプロセス定義でreqmode,selectmodeで指定した条件に対応するビジネスプロセス定義数)を取得する領域を指定します。
count
このAPI関数が取得したビジネスプロセス定義リストの要素数を取得する領域を指定します。
bplist
ビジネスプロセス定義リストを取得する領域を指定します。bplistnで指定した要素数分の領域を必ず指定してください。ビジネスプロセス定義リスト内に取得される項目については,ビジネスプロセス定義リスト内項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このシステムに登録されたビジネスプロセス定義でreqmode,selectmodeで指定した条件に対応するものがない場合は,totalは0で,このAPI関数の戻り値は正常終了(BWF_OK)となります。
  • numberパラメタで指定した値がtotalパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 取得するビジネスプロセス定義情報が多く,この関数を複数回に分けて発行する必要がある場合,この関数のソートを使用すると,応答時間が大幅に劣化することがあります。この場合,アプリケーション側でソート処理をしてください。
  • reqmodeパラメタにBWF_V2_LATESTを指定しても,BWF_LATEST_VERSIONを指定した場合と同様の情報が戻ります。
(b) ビジネスプロセス定義リスト内項目
項目内容
BWF_bp_oidビジネスプロセス定義オブジェクトIDが設定されます。
BWF_bp_bp_nameBWF_bp_oidに対応するビジネスプロセス定義名称が設定されます。
BWF_bp_create_nameBWF_bp_oidに対応するビジネスプロセス定義を登録したユーザのユーザIDが設定されます。
BWF_bp_create_timeBWF_bp_oidに対応するビジネスプロセス定義を登録した日時が設定されます。
日時:YYYYMMDDhhmmss形式
BWF_bp_version_numberBWF_bp_oidに対応するビジネスプロセス定義のバージョン番号が設定されます。
BWF_bp_work_countBWF_bp_oidに対応するビジネスプロセス定義で,現在処理中のワーク数が設定されます(終了処理ノードへ遷移,又はキャンセル中のワークも含まれます)。
BWF_bp_user_keyBWF_bp_oidに対応するビジネスプロセス定義の案件識別子フォーマットが設定されます。
BWF_bp_define_create_nameBWF_bp_oidに対応するビジネスプロセス定義を作成したユーザのユーザ名称が設定されます。
BWF_bp_define_timeBWF_bp_oidに対応するビジネスプロセス定義を作成した日時が設定されます。
日時:YYYYMMDDhhmmss形式
BWF_bp_status_codeBWF_bp_oidに対応するビジネスプロセス定義の登録状態が設定されます。
ent△:登録中
cat△:登録済
del△:削除中
注 △は,スペースを示します。
BWF_bp_exec_status_codeBWF_bp_oidに対応するビジネスプロセス定義の登録状態が設定されます。
act△:運用可能状態
dea△:運用不可状態(このビジネスプロセス定義に対しては,案件の投入はできません)
actc:運用可能状態で,かつ最新バージョン
注 △は,スペースを示します。
BWF_bp_except_codeBWF_bp_oidに対応するビジネスプロセス定義で,引き戻し/差し戻しができるかどうかが設定されます。
bkok:引き戻し/差し戻しできる
bkng:引き戻し/差し戻しできない
BWF_bp_commentビジネスプロセス定義を作成したときに記述したコメントが設定されます。

(5) ロール操作AP関数

(a) HwfGetRoleAnd(ロール情報の取得)
機能
次に示す条件に対応するロールのロール情報(ロール属性リスト)を取得します。
  • ログインサーバに登録されたすべてのロール
  • 指定されたビジネスプロセスに関連するログインサーバに登録されたロール
  • 指定されたユーザが登録されたロール
  • 指定されたビジネスプロセス,かつユーザが関連するログインサーバに登録されたロール(指定されたビジネスプロセス内で,ユーザが関連するロールのロール情報を絞り込んで取得したい場合に使用してください)
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetRoleAnd(
 BWF_useroid_t  __far *useroid,     /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,     /* サーバ名称格納領域 (I) */
 long                 reqmode,     /* 要求種別 (I) */
 long                 bpidlistn,    /* ビジネスプロセス定義オブジェクトID配列内設定要素数 (I) */
 BWF_bpidlist_t __far *bpidlist,    /* ビジネスプロセス定義オブジェクトID配列格納領域 (I) */
 long                 useridlistn,   /* ユーザオブジェクトID配列内設定要素数 (I) */
 BWF_useroidlist_t __far *useroidlist, /* ユーザオブジェクトID配列格納領域 (I) */
 long                 sortkey,     /* ソートキー (I) */
 long                 sortmode,     /* ソートモード (I) */
 long                 number,      /* ロール属性リスト取得先頭要素番号 (I) */
 long                 rolelistn,    /* ロール属性リスト取得要素数 (I) */
 long           __far *total,      /* ロール属性リスト全要素数 (O) */
 long           __far *count,      /* 取得ロール属性リスト要素数 (O) */
 BWF_rolelist_t __far *rolelist,    /* ロール属性リスト取得領域 (O) */
 BWF_errlist_t  __far *errlist     /* エラー情報取得領域 (O) */
);
typedef struct BWF_rolelist_t {
 BWF_roleid_t  BWF_rl_oid;         /* オブジェクトID */
 char          BWF_rl_role_name[64];    /* ロール名 */
 char          BWF_rl_create_name[8];    /* 作成者ID */
 BWF_time_t    BWF_rl_create_time;     /* 作成日時 */
 unsigned long BWF_rl_passed_case_count;  /* 通過案件数 */
 unsigned long BWF_rl_case_count;      /* 案件数 */
 char          BWF_rl_user_attr[128];    /* ユーザ属性値 */
} BWF_rolelist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflow関数又はHwfStartUpWorkflowSV関数で指定,又は取得したサーバ名称を格納した領域を指定します。
reqmode
情報を取得するロールに関する条件を,次に示す要求種別によって指定します。
BWF_GR_SYSTEM_MODE:すべてのロールを対象とします。
BWF_GR_BP_MODE:bpidlistに指定したビジネスプロセス定義に属すロールを対象とします。
BWF_GR_USER_MODE:useroidlistに指定したユーザが登録されたロールを対象とします。
BWF_GR_BP_USER_MODE:bpidlist,useroidlistに指定したビジネスプロセス定義,かつユーザが対応するロールを対象とします。
reqmodeの指定によって,次に示すように,以降のパラメタに情報を設定する必要があります。
reqmodebpidlistuseroidlist
BWF_GR_SYSTEM_MODE××
BWF_GR_BP_MODE×
BWF_GR_USER_MODE×
BWF_GR_BP_USER_MODE
(凡例)
○:指定が必要です。
×:指定は不要です。

bpidlistn
bpidlistにビジネスプロセス定義オブジェクトIDを設定した要素数を指定します。reqmodeにBWF_GR_BP_MODE,又はBWF_GR_BP_USER_MODEを指定した場合は,必ず1以上の値を指定してください。引数useridlistnと合わせて7959以内になるように指定してください。
bpidlist
reqmodeでBWF_GR_BP_MODE,又はBWF_GR_BP_USER_MODEを指定した場合に,ロールを選択するためのビジネスプロセス定義オブジェクトIDを格納した領域を指定します(複数指定可能,HwfGetBusinessProcessなどで取得できます)。
useridlistn
useroidlistに設定したユーザオブジェクトIDを格納した要素数を指定します。reqmodeにBWF_GR_USER_MODE,BWF_GR_BP_USER_MODEを指定した場合は,必ず1以上の値を指定してください。引数bpidlistnと合わせて7959以内になるように指定してください。
useroidlist
reqmodeでBWF_GR_USER_MODE,BWF_GR_BP_USER_MODEを指定した場合に,ロールを選択するためのユーザオブジェクトIDを格納した領域を指定します(複数指定可能,HwfGetUserAndなどで取得できます)。
sortkey
ロール属性リストをソートする場合に,次に示すキーを指定します。
sortmodeにBWF_NOSORT_MODEを指定した場合は,指定する必要はありません。
BWF_SRT_RL_NAME:ロール名
BWF_SRT_RL_CREATE_NAME:作成者ID
BWF_SRT_RL_CREATE_TIME:作成日時
sortmode
ロール属性リストをソートする場合のソート順を指定します。
BWF_ASCEND_MODE:昇順にソートします。
BWF_DESCEND_MODE:降順にソートします。
BWF_NOSORT_MODE:ソートしません。
number
ロール属性リストを取得する要素の先頭番号を指定します。先頭番号は0~(total-1)の範囲内で指定してください。
rolelistn
ロール属性リストを取得する要素数を指定します。1~284までの範囲内で指定してください。
total
ロール属性リストの取得できる全要素数(このシステムに登録されたロールでreqmodeで指定した条件に対応するロール数)を取得する領域を指定します。
count
このAPI関数が取得したロール属性リストの要素数を取得する領域を指定します。
rolelist
ロール属性リストを取得する領域を指定します。rolelistnで指定した要素数分の領域を必ず指定してください。ロール属性リスト内に取得される項目については,ロール属性リスト内項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このシステムに登録されたロールでreqmodeで指定した条件に対応するものがない場合は,totalは0で,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • numberパラメタで指定した値がtotalパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • ビジネスプロセス定義に階層ロールを使用している場合,この関数ではそのビジネスプロセス定義に関連している全ロールを取得できません。
  • ユーザに関連するロールを取得する場合,階層ロールはこの関数では取得できません。
  • 取得するロール情報が多く,この関数を複数回に分けて発行する必要がある場合,この関数のソートを使用すると,応答時間が大幅に劣化することがあります。この場合,アプリケーション側でソート処理をしてください。
(b) HwfGetRoleListFromRole(階層化ロールに登録されているロール一覧の取得)
機能
階層化ロールに登録されているロール一覧を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetRoleListFromRole(
 BWF_useroid_t  __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,    /* サーバ名称格納領域 (I) */
 BWF_roleid_t   __far *roleid,    /* 階層化ロールのロールオブジェクトID格納領域 (I) */
 unsigned long         number,    /* ロール情報取得先頭要素番号 (I) */
 unsigned long         rolelistn,  /* 取得するロール情報の要素数 (I) */
 unsigned long  __far *total,    /* ロール情報全要素数格納領域 (O) */
 unsigned long  __far *count,    /* ロール情報取得要素数格納領域 (O) */
 BWF_userlist_in_role_t __far *rolelist,  /* ロール情報格納領域 (O) */
 BWF_errlist_t  __far *errlist       /* エラー情報取得領域 (O) */
 void           __far *arg         /* 予備領域 (-) */
);
typedef struct BWF_rolelist_in_role_t {
 BWF_roleid_t sRoleId;     /* ロールオブジェクトID */
 char         sRoleName[132];  /* ロール名称 */
 char         reserved[184];  /* 予備領域 */
} BWF_rolelist_in_role_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];       /* メッセージ区分 */
 long lBMsgNo;         /* メッセージ番号 */
 char sBInsWord[13];      /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
roleid
取得するロール情報の登録されている,階層化ロールのロールオブジェクトIDを格納した領域を指定します。ロールオブジェクトIDは,HwfGetRoleAndなどで取得できます。
number
ロール情報リストを取得する要素の先頭番号を指定します。先頭番号は0~(total-1)の範囲内で指定してください。
rolelistn
ロール情報リストを取得する要素数を指定します。1~100の範囲内で指定してください。
total
roleidで指定された階層化ロールに登録されている,ロール情報の全要素数を格納する領域を指定します。
count
このAPI関数で取得したロール情報リストの要素数を格納する領域を指定します。
rolelist
このAPI関数で取得したロール情報を格納する領域を指定します。rolelistnで指定した要素数分の領域を必ず指定してください。ロール情報に取得される項目については,ロール情報取得項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • roleidパラメタに指定できるのは,階層化ロールのロールオブジェクトIDだけです。そのほかのロール種別のロールオブジェクトIDを指定した場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。ロールオブジェクトIDに対応するロール種別は,HwfGetObjectAttributeEx関数で取得できます。
  • roleidパラメタで指定したロールオブジェクトIDがない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • numberパラメタで指定した値がtotalパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(c) HwfGetOrganizationList(組織一覧の取得)
機能
指定した組織の一つ下の組織情報一覧を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetOrganizationList(
 BWF_useroid_t  __far *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,     /* サーバ名称格納領域 (I) */
 char           __far *orgid,     /* 取得する組織情報の上位組織ID格納領域 (I) */
 unsigned long        orgtype,     /*取得する組織情報の上位組織の種別 (I) */
 char           __far *beforeorgid,  /* 直前の組織IDの格納領域 (I) */
 unsigned long        orglistn,    /* 取得する組織情報の要素数 (I) */
 unsigned long   __far *count,     /* 組織情報取得要素数格納領域  (O) */
 BWF_org_list_t  __far *orglist,    /* 組織情報格納領域 (O) */
 BWF_errlist_t  __far *errlist     /* エラー情報取得領域 (O) */
 void           __far *arg       /* 予備領域 (-) */
);
typedef struct BWF_org_list_t {
 char           sOrgId[8];   /* 組織ID */
 char           sCompany[8];  /* 最上位組織ID */
 char           sHighOrg[8];  /* 一つ上位の組織ID */
 char           sJNAME[132];  /* 組織の日本語名称 */
 char           sENAME[132];  /* 組織の英語名称 */
 char           sNAME[36];   /* 組織略称 */
 unsigned long  sSubOrg;    /* 下位組織有無フラグ */
 unsigned long  sOrgType;    /* 組織種別 */
 char           reserved[180]; /* 予備領域 */
} BWF_org_list_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
orgid
取得する組織情報の一つ上位の組織IDを格納した領域を指定します。組織IDは,終端にNULL文字を付けた9バイト以内の文字列で指定してください。組織IDはHwfGetUserInfoなどで取得できます。NULL文字を指定した場合は,最上位組織情報一覧を取得します。
orgtype
orgidで指定した組織の種別を指定します。
BWF_TOP_ORG:orgidで指定した組織は「最上位組織」であることを指定します。
BWF_LOW_ORG:orgidで指定した組織は「組織」であることを指定します。
orgidにNULLを指定した場合,orgtypeに指定した値は意味を持ちません。
beforeorgid
前回取得した組織の続きから組織情報を取得する場合,前回取得した最後の組織IDを格納した領域を指定します。組織IDは,終端にNULL文字を付けた9バイト以内の文字列で指定してください。組織情報を先頭から取得する場合はNULLを指定してください。
orglistn
組織情報を取得する要素数を指定します。1~50の範囲内で指定してください。
count
このAPI関数が取得した組織情報一覧の要素数を格納する領域を指定します。
orglist
このAPI関数で取得した組織情報を格納する領域を指定します。orglistnで指定した要素数分の領域を必ず指定してください。組織情報に取得される項目については,組織情報取得項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • orgidパラメタで指定した組織ID,及びorgtypeパラメタで指定した組織種別に一致する組織がない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • countパラメタに格納された値がorglistnパラメタで指定した値未満の場合,組織情報に続きの情報はありません。countパラメタに格納された値がorglistnパラメタで指定した値と同じ場合,続きの組織情報がある可能性があるので,再度このAPI関数を発行するなどして,続きの組織情報を取得してください。
(d) ロール属性リスト内項目
項目内容
BWF_rl_oidロールオブジェクトIDが設定されます。
BWF_rl_role_nameBWF_rl_oidに対応するロール名称が設定されます。
BWF_rl_create_nameBWF_rl_oidに対応するロールを登録したユーザのユーザIDが設定されます。
BWF_rl_create_timeBWF_rl_oidに対応するロールの作成日時が設定されます。
BWF_rl_passed_case_count空き領域で,値は常に不定です。
BWF_rl_case_countBWF_rl_oidに対応するロールトレーに格納されている案件数(ルート案件+単独の一般案件)が設定されます。
BWF_rl_user_attrロールに対するユーザ属性値(コメント)が設定されます(設定されていない場合があります)。
(e) ロール情報取得項目
項目内容
sRoleIdロールオブジェクトIDを格納します。
sRoleNamesRoleIdに対応したロール名称を格納します。
reservedNULLを格納します。
(f) 組織情報取得項目
項目内容
sOrgId組織IDを格納します。組織IDの長さが8バイト未満の場合は,終端にNULL文字を付けて格納します。組織IDの長さが8バイトの場合は,終端にNULL文字を付けないで格納します。
sCompanysOrgIdに対応する組織の最上位の組織IDを格納します。最上位組織IDの長さが8バイト未満の場合は,終端にNULL文字を付けて格納します。最上位組織IDの長さが8バイトの場合は,終端にNULL文字を付けないで格納します。
sHighOrgsOrgIdに対応する組織の一つ上位の組織IDを格納します。組織IDの長さが8バイト未満の場合は,終端にNULL文字を付けて格納します。組織IDの長さが8バイトの場合は,終端にNULL文字を付けないで格納します。
sJNAMEsOrgIdに対応する組織の日本語名称を格納します。
sENAMEsOrgIdに対応する組織の英語名称を格納します。
sNAMEsOrgIdに対応する組織の略称を格納します。
sSubOrgsOrgIdに対応する組織の下位組織有無情報を格納します。
BWF_SUB_ORG_YES:
sOrgIdに対応する組織に下位組織があることを示します。
BWF_SUB_ORG_NO:
sOrgIdに対応する組織に下位組織がないことを示します。
sOrgTypesOrgIdに対応する組織の種別を格納します。
BWF_TOP_ORG:
sOrgIdに対応する組織が「最上位組織」であることを示します。
BWF_LOW_ORG:
sOrgIdに対応する組織が「組織」であることを示します。
reservedNULLを格納します。

(6) ワーク操作AP関数

(a) HwfGetWorkAttribute(ワーク情報の取得)
機能
ビジネスプロセス定義に属するワークで,ログインサーバにあるものの属性情報(ワーク属性リスト)を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetWorkAttribute(
 BWF_useroid_t  __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,   /* サーバ名称格納領域 (I) */
 BWF_bpid_t     __far *bpid,    /* ビジネスプロセス定義オブジェクトID格納領域 (I) */
 long                 sortkey,   /* ソートキー (I) */
 long                 sortmode,   /* ソートモード (I) */
 long                 number,    /* ワーク属性リスト取得先頭要素番号 (I) */
 long                 worklistn,  /* ワーク属性リスト取得要素数 (I) */
 long           __far *total,    /* ワーク属性リスト全要素数 (O) */
 long           __far *count,    /* 取得ワーク属性リスト要素数 (O) */
 BWF_worklist_t __far *worklist,  /* ワーク属性リスト取得領域 (O) */
 BWF_errlist_t  __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_worklist_t{
 BWF_workid_t  BWF_wk_oid;          /* オブジェクトID */
 char          BWF_wk_transaction_id[8];   /* トランザクションID */
 BWF_userkey_t BWF_wk_user_key;        /* ワークID(案件識別子フォーマット) */
 char          BWF_wk_create_name[8];     /* 作成者ID */
 BWF_time_t    BWF_wk_create_time;      /* 作成日時 */
 BWF_time_t    BWF_wk_process_limit_time;   /* 処理期限 */
 char          BWF_wk_priority_code[4];    /* 優先度 */
 BWF_bpid_t    BWF_wk_bp_oid;         /* ビジネスプロセス定義オブジェクトID */
 unsigned long BWF_wk_case_count;       /* 案件数 */
 char          BWF_wk_status_code[4];     /* 状態コード */
 unsigned long BWF_wk_history_level;     /* ヒストリ取得レベル */
 unsigned long BWF_wk_manager_history_max;  /* ヒストリ取得MAX値 */
 char          BWF_wk_title[64];       /* 案件タイトル */
} BWF_worklist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
bpid
ワーク属性リストを選択するためのビジネスプロセス定義オブジェクトID(HwfGetBusinessProcessなどで取得できます)を格納した領域を指定します。
sortkey
ワーク属性リストをソートする場合に,次に示すキーを指定します。
sortmodeにBWF_NOSORT_MODEを指定した場合は,指定する必要はありません。
BWF_SRT_WK_USER_KEY:ワークID(案件識別子フォーマット)
BWF_SRT_WK_CREATE_NAME:作成者ID
BWF_SRT_WK_CREATE_TIME:作成日時
BWF_SRT_WK_STATUS_CODE:状態コード
BWF_SRT_WK_PRIORITY:優先度
sortmode
ワーク属性リストをソートする場合のソート順を指定します。
BWF_ASCEND_MODE:昇順にソートします。
BWF_DESCEND_MODE:降順にソートします。
BWF_NOSORT_MODE:ソートしません。
number
ワーク属性リストを取得する要素の先頭番号を指定します。
先頭番号は0~(total-1)の範囲内で指定してください。
worklistn
ワーク属性リストを取得する要素数を指定してください。
1~315までの範囲内で指定してください。
total
ワーク属性リストの取得できる全要素数を取得する領域を指定します。
count
このAPI関数が取得したワーク属性リストの要素数を取得する領域を指定します。
worklist
ワーク属性リストを取得する領域を指定します。worklistnで指定した要素数分の領域を必ず指定してください。
ワーク属性リスト内に取得される項目については,ワーク属性リスト内項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • bpidで指定したビジネスプロセス定義にワークがない場合,totalは0で,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • numberパラメタで指定した値がtotalパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 取得するワーク情報が多く,この関数を複数回に分けて発行する必要がある場合,この関数のソートを使用すると,応答時間が大幅に劣化することがあります。この場合,アプリケーション側でソート処理をしてください。
(b) HwfSetWorkTerm(ワークの処理期限変更)
機能
ビジネスプロセスにある,指定したワーク下のすべての案件の処理期限を変更します。ただし,処理期限を変更できるのは,自分が投入した案件だけです。また,指定したワーク下の案件が「処理中」の場合は,「処理中」以外になるまで変更されません。
この関数は,拡張ビジネスプロセス定義で指定したビジネスプロセス登録サーバをホームサーバとするユーザが発行した場合に有効になります。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfSetWorkTerm(
 BWF_useroid_t __far *useroid, /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,  /* サーバ名称格納領域 (I) */
 BWF_workid_t  __far *workid,  /* ワークオブジェクトID格納領域 (I) */
 BWF_time_t    __far *limit,  /* 変更処理期限 (I) */
 BWF_errlist_t __far *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
workid
HwfGetCaseSelectDataで取得した,処理期限を変更するワークのオブジェクトIDを格納した領域を指定します。
limit
変更する処理期限(日時)を格納した領域を指定します。
日時はYYYYMMDDhhmmss形式の14バイトの文字列で,指定できる範囲は1970年1月1日 10:00:00 から2038年1月19日 03:14:07までです。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(c) HwfSetWorkPriority(ワークの優先度変更)
機能
ビジネスプロセスにある,指定したワーク下のすべての案件の優先度を変更します。ただし,優先度を変更できるのは,自分が投入した案件だけです。また,指定したワーク下の案件が「処理中」の場合は,「処理中」以外になるまで変更されません。
この関数は,拡張ビジネスプロセス定義で指定したビジネスプロセス登録サーバをホームサーバとするユーザが発行した場合に有効となります。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfSetWorkPriority(
 BWF_useroid_t __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,  /* サーバ名称格納領域 (I) */
 BWF_workid_t  __far *workid,  /* ワークオブジェクトID格納領域 (I) */
 long                priority,  /* 優先度 (I) */
 BWF_errlist_t __far *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
workid
HwfGetCaseSelectData,HwfGetWorkAttributeなどで取得した,優先度を変更するワークのオブジェクトIDを格納した領域を指定します。
priority
変更する優先度を格納した領域を指定します。
BWF_URGENT:至急
BWF_NORMAL:普通
ただし,この優先順位による案件の遷移制御はしません。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(d) HwfCancelWorkEx(ワークのキャンセル)
機能
HwfCancelWorkEx関数は,引数bpname,bptype,workidで指定される実行中のワークをキャンセル,及び削除します。実体は削除しないで残し,後でワーク削除ユティリティで削除することもできます。
キャンセルを要求できるのは,自分が投入した案件です。
拡張ビジネスプロセス定義では,対象とするビジネスプロセス定義のビジネスプロセス登録サーバが停止していると要求はエラーになります。
階層型ビジネスプロセス連携をしている場合は,1階層目のビジネスプロセス定義でだけ要求できます。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfCancelWorkEx(
 BWF_useroid_t __far *useroid ,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server ,    /* サーバ名称格納領域 (I) */
 char          __far *bpname ,    /* ビジネスプロセス定義名称 (I) */
 long                bptype ,     /* ビジネスプロセス定義の種別 (I) */
 char          __far *workid ,    /* ワークID(案件識別子フォーマット) (I) */
 long                delete_mode ,  /* 削除モード (I) */
 BWF_errlist_t __far *errlist,    /* エラー情報取得領域 (O) */
 void          __far *arg       /* 拡張用領域のアドレス */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
bpname
キャンセルするワークのビジネスプロセス定義の名称を指定します。終端に必ずNULL文字を付けてください。
bptype
bpnameパラメタで指定したビジネスプロセス定義の種別を指定します。
0:ビジネスプロセス定義
1:拡張ビジネスプロセス定義
workid
キャンセルするワークのワークID(案件識別子フォーマット)を指定します。終端に必ずNULL文字を付けてください。
delete_mode
キャンセルしたワークの削除モードを指定します。次の値のどれかになります。
0:ワーク,案件,文書,メモすべてをキャンセル済み状態として残しておきます。この状態ではGroupmax Workflow Monitorから属性情報や履歴を参照できます。
後でGroupmax Workflow Monitor,又はワーク削除ユティリティを使用して削除できます。
保留中,処理中の案件がある場合はキャンセルできません。
1:ワーク,案件,文書,メモすべてを直ちに削除します。
保留中,処理中の案件がある場合はキャンセルできません。
2:ワーク,案件,文書,メモすべてをキャンセル済み状態として残しておきます。
保留中の案件があってもキャンセルします。処理中の案件がある場合はキャンセルできません。
3:ワーク,案件,文書,メモすべてを直ちに削除します。
保留中の案件があってもキャンセルします。処理中の案件がある場合はキャンセルできません。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • ワーク下に処理中の案件がある場合は,実行しないでエラーリターンします。強制的にキャンセルする場合はGroupmax Workflow Monitorを使用してください。
  • 拡張ビジネスプロセス定義では,ビジネスプロセス登録サーバに接続して処理するため,時間がかかることがあります。また,ビジネスプロセス登録サーバが停止している場合,エラーリターンします。
  • ユーザヒストリから案件を取得してキャンセルする場合,既に削除されていることがあります。
  • キャンセル操作禁止オプションを指定して登録した拡張ビジネスプロセス定義に対してこの関数を発行すると,戻り値はエラーリターン(BWF_ERROR)となります。
(e) HwfGetWorkStatus(ワークの状態の確認)
機能
HwfGetWorkStatusは,パラメタbpname,bptype,workidで指定されるワークの最新の処理状態を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetWorkStatus(
 BWF_useroid_t    __far *useroid ,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t     __far *server ,    /* サーバ名称格納領域 (I) */
 long                   mode ,      /* 処理モード (I) */
 char             __far *bpname ,    /* ビジネスプロセス定義名称 (I) */
 long                   bptype ,     /* ビジネスプロセス定義の種別 (I) */
 char             __far *workid ,    /* ワークID(案件識別子フォーマット) (I) */
 BWF_workstatus_t __far *workstatus ,  /* ワーク状態取得領域 (O) */
 BWF_errlist_t    __far *errlist ,    /* エラー情報取得領域 (O) */
 void             __far *arg       /* 拡張用領域のアドレス */
);
typedef struct BWF_workstatus_t {  /* ワーク状態取得領域 */
 char           title[64] ;     /* 案件タイトル */
 char           status[4] ;     /* ワーク動作状態 */
 char           priority[4] ;    /* ワーク優先度 */
 BWF_time_t     limit ;       /* ワーク処理期限 */
 BWF_time_t     puttime ;      /* ワーク投入日時 */
 char           comment[256] ;   /* コメント */
 char           reserved[64] ;   /* 予備領域 */
} BWF_workstatus_t;
typedef struct BWF_errlist_t {  /*エラー情報取得領域 */
 char           sBMsgKbn[6] ;  /* メッセージ区分 */
 long           lBMsgNo ;    /* メッセージ番号 */
 char           sBInsWord[13] ; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
mode
処理のモードを指定します。
0:ワークに関するシステム状態を取得します。
bpname
情報を取得するワークのビジネスプロセス定義の名称を指定します。終端に必ずNULL文字を付けてください。
bptype
bpnameで指定したビジネスプロセス定義の種別を指定します。
0:ビジネスプロセス定義
1:拡張ビジネスプロセス定義
なお,名称に重複がない場合は,このパラメタの指定は無視されます。
workid
情報を取得するワークのワークID(案件識別子フォーマット)を指定します。終端に必ずNULL文字を付けてください。
workstatus
ワークの最新の状態を取得します。
title:案件のタイトルを格納します。
status:ワークの状態を格納します。ワークの状態を次に示します。
 act△:動作中
 sup△:サスペンド中
 can△:キャンセル
 can2:キャンセル,削除処理中
 sink :終了済み
  注 △はスペースを示します。
priority:ワークの優先度を格納します。ワークの優先度を次に示します。
 com△:普通
 urg△:至急
  注 △はスペースを示します。
limit:ワークの処理期限をYYYYMMDDhhmmss形式で格納します。puttime:ワークの投入日付を格納します。
comment:使用しません。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 拡張ビジネスプロセス定義では,ビジネスプロセス登録サーバに接続して処理するため,時間がかかることがあります。また,ビジネスプロセス登録サーバが停止している場合,エラーリターンします。
(f) ワーク属性リスト内項目
項目内容
BWF_wk_oidワークオブジェクトIDが設定されます。
BWF_wk_transaction_idワークが作成されるきっかけとなった案件オブジェクトIDと同じ値が設定されます。
BWF_wk_user_keyBWF_wk_oidに対応する案件のワークID(案件識別子フォーマット)が設定されます。
BWF_wk_create_nameBWF_wk_oidに対応する案件を作成したユーザのユーザIDが設定されます。
BWF_wk_create_timeBWF_wk_oidに対応するワークを作成した日時が設定されます(形式は,YYYYMMDDhhmmss形式となります)。
BWF_wk_process_limit_timeBWF_wk_oidに対応するワーク下にある案件の最も古い日時が設定されます(形式は,YYYYMMDDhhmmss形式となります)。
BWF_wk_priority_codeBWF_wk_oidに対応するワーク下の案件のどれかに至急が設定されていれば至急が設定され,すべてに普通が設定されていれば普通が設定されます。
com△:普通
urg△:至急
注 △はスペースを示します。
BWF_wk_bp_oidBWF_wk_oidに対応するワークがあるビジネスプロセス定義のビジネスプロセス定義オブジェクトIDが設定されます。
BWF_wk_case_countBWF_wk_oidに対応するワーク下にある案件の個数(ルート案件+単独の一般案件)が設定されます。
BWF_wk_status_codeBWF_wk_oidに対応する案件の動作状態が設定されます。
act△:動作可能状態
sup△:動作中断状態
can△:キャンセル予約状態
can2:ワーク以下案件削除状態
sink:終了済み状態
注 △はスペースを示します。
BWF_wk_history_levelBWF_wk_oidに対応するワークのヒストリ取得レベルが設定されます。
1:ヒストリを取得します。
0:ヒストリを取得しません。
BWF_wk_manager_history_maxワークヒストリの最大取得数が設定されます。
BWF_wk_titleBWF_wk_oidに対応するワークに設定された案件タイトルが設定されます(案件タイトルはHwfPutCase,HwfSimplePutCaseなどで,案件の投入時に指定した場合だけ設定されます)。

(7) 案件操作AP関数

(a) HwfGetCaseFormSelectEx(ビジネスプロセス定義へ投入できる案件情報の取得)
機能
ユーザが直接,又はそのユーザが属するロールが関連する指定されたビジネスプロセス定義の開始処理ノードに投入できる案件情報(フォームリスト)を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetCaseFormSelectEx(
 BWF_useroid_t  __far  *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far  *server,   /* サーバ名称格納領域 (I) */
 long                  reqmode,   /* 要求種別 (I) */
 long                  domainmode, /* 対象ビジネスプロセス定義種別 (I) */
 BWF_useroid_t  __far  *suseroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_roleid_t   __far  *roleid,   /* ロールオブジェクトID格納領域  (I) */
 BWF_bpid_t     __far  *bpid,    /* ビジネスプロセス定義オブジェクトID格納領域 (I) */
 long                  number,   /* フォームリスト取得先頭要素番号 (I) */
 long                  formlistn,  /* フォームリスト取得要素数 (I) */
 long           __far  *total,   /* フォームリスト全要素数 (O) */
 long           __far  *count,   /* 取得フォームリスト要素数 (O) */
 BWF_formlistex_t  __far *formlist, /* フォームリスト取得領域 (I/O) */
 BWF_errlist_t  __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_formlistex_t{
 BWF_bpid_t     BWF_fm_bp_oid;        /* ビジネスプロセス定義オブジェクトID (O) */
 char           BWF_fm_bp_name[64];     /* ビジネスプロセス定義名称 (O) */
 unsigned long  BWF_fm_bp_version_number;  /* ビジネスプロセス定義バージョン番号 (O) */
 BWF_nodeno_t BWF_fm_node_id;        /* 開始処理ノードID (O) */
 char         BWF_fm_node_name[64];     /* 開始処理ノード名称 (O) */
 char         BWF_fm_workid_numbering[4];  /* 自動採番機能 (O) */
 char         BWF_fm_default_limit[4];    /* デフォルト処理期限(日数) (O) */
 long         BWF_fm_bp_type;        /* ビジネスプロセス定義種別 (O) */
 long         BWF_fm_opnumber;        /* ユーザ処理リスト取得先頭要素番号 (I)*/
 long         BWF_fm_oplistn;        /* ユーザ処理リスト要求数 (I) */
 long         BWF_fm_total_oplistn;     /* ユーザ処理リスト総数 (O) */
 long         BWF_fm_get_oplistn;      /* ユーザ処理リスト取得数 (O) */
 BWF_oplist_t __far *BWF_fm_get_oplist;   /* ユーザ処理リスト格納領域 (O) */
 char         reserved[64];         /* 予備領域 */
} BWF_formlistex_t;
typedef struct BWF_oplist_t{
 char           BWF_ol_kind_code[2];      /* 種別コード */
 char           BWF_ol_create_condition[2];   /* 設定条件 */
 BWF_casename_t BWF_ol_case_name;        /* 案件名称 */
 char           BWF_ol_get_operation_list[256]; /* 作業情報 */
} BWF_oplist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];   /* メッセージ区分 */
 long lBMsgNo;     /* メッセージ番号 */
 char sBInsWord[13];  /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
reqmode
情報を取得する条件を,次に示す要求種別によって指定します。
BWF_USER_SRC_MODE:ユーザが直接,又はそのユーザが属するロールが開始処理ノードとして関連するビジネスプロセス定義を対象とします。
BWF_USER_ONLY_SRC_MODE:ユーザが開始処理ノードとして直接関連するビジネスプロセス定義を対象とします。
BWF_ROLE_SRC_MODE:ロールが開始処理ノードとして関連するビジネスプロセス定義を対象とします。
BWF_BP_SRC_MODE:指定されたビジネスプロセス定義を対象とします。
BWF_BP_USER_SRC_MODE:指定されたビジネスプロセス定義で,指定されたユーザが直接,又はそのユーザが属するロールが開始処理ノードとして関連するソースノードを対象とします。
reqmodeの指定によって,次に示すように,以降のパラメタに情報を設定する必要があります。
reqmodesuseroidroleidbpid
BWF_USER_SRC_MODE××
BWF_USER_ONLY_SRC_MODE××
BWF_ROLE_SRC_MODE××
BWF_BP_SRC_MODE××
BWF_BP_USER_SRC_MODE×
(凡例)
○:指定が必要です。
×:NULLを指定してください。

domainmode
対象とするビジネスプロセス定義の種別を指定します。
0:運用可能な最新バージョンのビジネスプロセス定義を対象とします。
同一名称のビジネスプロセス定義と拡張ビジネスプロセス定義が存在する場合,拡張ビジネスプロセス定義を対象とします。
1:登録されている全ビジネスプロセス定義を対象とします。
2:運用可能な最新バージョンのビジネスプロセス定義を対象とします。
同一名称のビジネスプロセス定義と拡張ビジネスプロセス定義が存在する場合,双方の運用可能な最新バージョンのビジネスプロセス定義を取得します。
suseroid
情報を選択するためのユーザオブジェクトID(HwfStartUpWorkflow,HwfGetUserAndなどで取得)を格納した領域を指定します。
roleid
情報を選択するためのロールオブジェクトID(HwfGetRoleAndなどで取得)を格納した領域を指定します。
bpid
情報を選択するためのビジネスプロセス定義オブジェクトID(HwfGetBusinessProcessで取得)を格納した領域を指定します。
number
フォームリストを取得する要素の先頭番号を指定します。先頭番号は0~(total-1)の範囲内で指定してください。
formlistn
フォームリストを取得する要素数を指定します。
必ず1以上の値を指定してください。フォームリストを取得する要素数の上限値は注意事項を参照してください。
total
フォームリストの取得可能な全要素数(reqmodeで指定した条件に対応する情報)を取得する領域を指定します。
count
このAPI関数が取得したフォームリストの要素数を取得する領域を指定します。
formlist
フォームリストを取得する領域を指定します。
formlistnで指定した要素数分の領域を必ず指定してください。フォームリスト内の設定項目についてはフォームリスト内項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このシステムに登録された案件でreqmodeで指定した条件に対応するものがない場合は,totalは0でこのAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • numberパラメタで指定した値がtotalパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となり,totalにこのシステムに登録された案件でreqmodeで指定した条件に対応する要素数が設定されます。
  • (244×formlistn)+(324×(フォームリスト内項目のBWF_fm_oplistnに指定した値の合計))が65535を超えない範囲で指定してください。
例1
ユーザ処理リストを指定しない場合は次のようになります。
244×formlistn ≦ 65535 ・・・・formlistn=268まで指定できます。
例2
フォームリストごとにユーザ処理リストを1個ずつ取得する場合は次のようになります。
(244×formlistn)+(324×(formlistn×1)) ≦ 65535・・・formlistn=115まで指定できます。
例3
フォームリストごとにユーザ処理リストを10個ずつ取得する場合は次のようになります。
(244×formlistn)+(324×(formlistn×10)) ≦ 65535・・・formlistn=18まで指定できます。
例4
フォームリストを1件だけ取得する場合は次のようになります。
(244×1)+(324×(1×BWF_fm_oplistn)) ≦ 65535・・BWF_fm_oplistn=201まで指定できます。
(b) HwfGetCasePutOperation(ビジネスプロセス定義開始処理ノードのユーザ処理リストの取得)
機能
指定されたビジネスプロセス定義の開始処理ノードのユーザ処理リストを取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetCasePutOperation(
 BWF_useroid_t    __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t     __far *server,   /* サーバ名称格納領域 (I) */
 long                   reqmode,   /* 要求種別 (I) */
 long                   bptype,   /* 対象ビジネスプロセス定義種別 (I) */
 char             __far *bpname,   /* 対象ビジネスプロセス定義名称 (I) */
 long                   version,   /* 対象ビジネスプロセス定義バージョン (I) */
 BWF_useroid_t    __far *suseroid,  /* ユーザオブジェクトID格納領域 (I) */
 long                   number,   /* フォームリスト取得先頭要素番号 (I) */
 long                   formlistn,  /* フォームリスト取得要素数 (I) */
 long             __far *total,   /* フォームリスト全要素数 (O) */
 long             __far *count,   /* 取得フォームリスト要素数 (O) */
 BWF_formlistex_t __far *formlist,  /* フォームリスト取得領域 (I/O) */
 BWF_errlist_t    __far *errlist,  /* エラー情報取得領域 (O) */
 void             __far *arg     /* 予備領域 */
);
typedef struct BWF_formlistex_t{
 BWF_bpid_t    BWF_fm_bp_oid;        /* ビジネスプロセス定義オブジェクトID (O) */
 char          BWF_fm_bp_name[64];      /* ビジネスプロセス定義名称     (O) */
 unsigned long BWF_fm_bp_version_number;  /* ビジネスプロセス定義バージョン番号 (O) */
 BWF_nodeno_t  BWF_fm_node_id;       /* 開始処理ノードID(O) */
 char          BWF_fm_node_name[64];    /* 開始処理ノード名称 (O) */
 char          BWF_fm_workid_numbering[4]; /* 自動採番機能 (O) */
 char          BWF_fm_default_limit[4];   /* デフォルト処理期限(日数) (O) */
 long          BWF_fm_bp_type;       /* ビジネスプロセス定義種別 (O) */
 long          BWF_fm_opnumber;       /* ユーザ処理リスト取得先頭要素番号 (I)*/
 long          BWF_fm_oplistn;       /* ユーザ処理リスト要求数 (I) */
 long          BWF_fm_total_oplistn;    /* ユーザ処理リスト総数 (O) */
 long          BWF_fm_get_oplistn;     /* ユーザ処理リスト取得数 (O) */
 BWF_oplist_t __far *BWF_fm_get_oplist;   /* ユーザ処理リスト格納領域 (I/O) */
 char          reserved[64];        /* 予備領域 */
} BWF_formlistex_t;
typedef struct BWF_oplist_t{
 char           BWF_ol_kind_code[2];       /* 種別コード */
 char           BWF_ol_create_condition[2];   /* 設定条件 */
 BWF_casename_t BWF_ol_case_name;        /* 案件名称 */
 char           BWF_ol_get_operation_list[256]; /* 作業情報 */
} BWF_oplist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
reqmode
情報を取得する条件を,次に示す要求種別によって指定します。
BWF_BP_SRC_MODE:指定されたビジネスプロセス定義を対象とします。
BWF_BP_USER_SRC_MODE:指定されたビジネスプロセス定義で,指定されたユーザが投入できるソースノードを対象とします。
bptype
対象とするビジネスプロセス定義の種別を指定します。
0:ビジネスプロセス定義
1:拡張ビジネスプロセス定義
bpname
ユーザ処理リストを取得するビジネスプロセス定義の名称を格納した領域を指定します。
version
ビジネスプロセス定義のバージョンを指定します。0を指定すると,最新バージョンのビジネスプロセス定義の情報を取得します。
suseroid
reqmodeパラメタにBWF_BP_USER_SRC_MODEを指定した場合,情報を選択するためのユーザオブジェクトID(HwfStartUpWorkflow,HwfGetUserAndなどで取得できます)を格納した領域を指定します。
reqmodeパラメタにBWF_BP_SRC_MODEを指定した場合は,NULLを指定してください。
number
フォームリストを取得する要素の先頭番号を指定します。先頭番号は0~(total-1)の範囲内で指定してください。
formlistn
フォームリストを取得する要素数を指定します。必ず1以上の値を指定してください。フォームリストを取得する要素数の上限値は注意事項を参照してください。
total
フォームリストの取得できる全要素数(reqmodeで指定した条件に対応する情報)を取得する領域を指定します。
count
このAPI関数が取得したフォームリストの要素数を取得する領域を指定します。
formlist
フォームリストを取得する領域を指定します。
formlistnで指定した要素数分の領域を必ず指定してください。フォームリスト内の設定項目については,フォームリスト内項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このシステムに登録された案件でreqmodeで指定した条件に対応するものがない場合は,totalには0が設定され,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • numberパラメタで指定した値がtotalパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となり,totalには,このシステムに登録されている案件のうちreqmodeで指定した条件に対応する要素数が設定されます。
  • (244×formlistn)+(324×(フォームリスト内項目のBWF_fm_oplistnに指定した値の合計))が65535を超えない範囲で指定してください。
例1
ユーザ処理リストを指定しない場合は次のようになります。
244×formlistn ≦ 65535 ・・・・formlistn=268まで指定できます。
例2
フォームリストごとにユーザ処理リストを1個ずつ取得する場合は次のようになります。
(244×formlistn)+(324×(formlistn×1)) ≦ 65535・・・formlistn=115まで指定できます。
例3
フォームリストごとにユーザ処理リストを10個ずつ取得する場合は次のようになります。
(244×formlistn)+(324×(formlistn×10)) ≦ 65535・・・formlistn=18まで指定できます。
例4
フォームリストを1件だけ取得する場合は次のようになります。
(244×1)+(324×(1×BWF_fm_oplistn)) ≦ 65535・・BWF_fm_oplistn=201まで指定できます。
(c) HwfSimplePutCase(文書とメモを格納した案件をビジネスプロセス定義に投入(機能限定版))
機能
案件にユーザ属性を設定し,文書とメモを添付した後,指定したビジネスプロセス定義に案件を投入します。
この関数は,HwfPutCase関数に比べて次に示す制限事項があります。
  • 投入ノードが複数ある場合サブモードで投入することはできません。
  • 添付するメモの種別にGroupmax Integrated Desktop本文を指定できません。Groupmax Integrated Desktopと併用する場合は注意してください。
  • 次ノード処理ユーザを指定できません。次ノード処理ユーザの設定が必須の案件は投入できません。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include <bwf.h>
long HwfSimplePutCase (
 BWF_useroid_t  __far *useroid,       /* ユーザオブジェクトID格納領域 (I)*/
 BWF_server_t   __far *server,        /* サーバ名称格納領域 (I) */
 char           __far *bpname,        /* ビジネスプロセス定義名称 (I) */
 unsigned long  __far *bp_version_number,  /* バージョン番号 (I) */
 char           __far *nodename,       /* ノード名称 (I) */
 HWND                 pwnd_handle,      /* 親ウィンドウのハンドル (I) */
 BWF_userkey_t  __far *userkey,       /* ワークID(案件識別子フォーマット) (I) */
 char           __far *title,        /* 案件タイトル名 (I) */
 char           __far *limit,        /* 処理期限 (I) */
 long                 priority,       /* 優先順位 (I) */
 long                 caseinflistn,     /* 投入案件情報リスト要素数 (I) */
 BWF_putcaseinf_t  __far *caseinflist,    /* 投入案件情報リスト (I) */
 BWF_userkey_t        *out_userkey,     /* 設定ワークID(案件識別子フォーマット) (O) */
 BWF_errlist_t  __far *errlist        /* エラー情報取得領域 (O) */
);
typedef struct BWF_putcaseinf_t{        /* 投入案件情報 */
 BWF_casename_t               casename;    /* 案件名 (I) */
 long                         userattrlistn;  /* ユーザ属性リスト数 (I) */
 BWF_end_userattrlist_t __far *userattrlist;  /* ユーザ属性リスト (I) */
 long                         docfilelistn;  /* 文書数 (I) */
 BWF_filelist_t         __far *docfilelist;  /* 文書ファイル名称リスト (I) */
 long                         memofilelistn;  /* メモ数 (I) */
 BWF_filelist_t         __far *memofilelist;  /* メモファイル名称リスト (I) */
}BWF_putcaseinf_t ;
typedef struct BWF_end_userattrlist_t {  /* エンドユーザ属性 */
 char  BWF_user_defname[64];       /* ユーザ定義名称 (I) */
 char  BWF_user_attr_value[32];      /* 設定ユーザ属性 (I) */
}BWF_end_userattrlist_t;
typedef struct  BWF_filelist_t {      /* ファイル名称リスト */
 char  sBDoclist[512];          /* フルパス+ファイル名称 (I) */
 char  sBDoctype[4];           /* ファイル種別 *(I) /
} BWF_filelist_t;
typedef struct  BWF_errlist_t {      /* エラー情報取得領域 */
 char  sBMsgKbn[6];            /* メッセージ区分 (O) */
 long  lBMsgNo;              /* メッセージ番号 (O) */
 char  sBInsWord[13];           /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
bpname
案件を投入するビジネスプロセス定義名称を格納した領域を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
bp_version_number
案件を投入するビジネスプロセス定義のバージョン番号を格納した領域を指定します。0を指定すると最新版のビジネスプロセス定義に案件を投入します。
nodename
ノード名称を格納した領域を指定します。投入ノードが一つしかないビジネスプロセス定義に案件を投入する場合,このパラメタは省略できます。省略するときはこのパラメタにNULLを指定します。
終端にNULL文字を付けた64バイト以内の文字列を指定します。
pwnd_handle
親ウィンドウのハンドルを格納した領域を指定します。
userkey
ワークID(案件識別子フォーマット)を格納した領域を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
ビジネスプロセス定義にワークID(案件識別子フォーマット)の自動採番機能が定義されている場合,このパラメタの指定値は無視されることがあります。実際に投入されたワークID(案件識別子フォーマット)は,HwfGetUserHistoryEx関数で確認してください。
title
案件タイトル名を格納した領域を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
limit
処理期限を格納した領域を指定します。処理期限はYYYYMMDDhhmmss形式の14バイト文字列です。
NULLを指定したときは,投入時間にビジネスプロセス定義に指定されたデフォルト処理期限を加えた日時が設定されます。ビジネスプロセス定義にデフォルト処理期限が指定されていない場合は,30日後を案件の処理期限とします。
priority
優先順位を指定します。次に示す値以外を指定したとき,優先順位はBWF_NORMALとなります。
BWF_NORMAL:普通
BWF_URGENT:至急
caseinflistn
投入案件情報リスト(caseinflist)の要素数を指定します。1以上の値を指定してください。
caseinflist
caseinflistnに指定した数分の投入案件情報リストの要素を指定します。投入案件情報リストの要素については,投入案件情報リスト内項目を参照してください。
out_userkey
ビジネスプロセス定義に投入した案件に設定したワークID(案件識別子フォーマット)が出力されます。
Groupmax Workflow Definerで「ワークIDを指定しない」モードを選択して登録したビジネスプロセス定義に対して投入した場合は,NULL文字が戻ります。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン,又は警告発生。
注意事項
  • 投入モードは,BWF_GRACE_MODEとBWF_MAIN_MODE固定です。
  • 案件に文書を登録するときの文書種別(sBDocType)は,BWF_ORIGINAL_DATAです。
  • 案件にメモファイルとして登録するときの種別(sBDocType)は,BWF_ORIGINAL_DATAです。
  • 指定した名称のビジネスプロセス定義が,ビジネスプロセス定義と拡張ビジネスプロセス定義のどちらにもある場合,拡張ビジネスプロセス定義に投入します。
  • ソースノードに複数の案件が定義されている場合,すべての案件を案件情報リストに指定しないとエラーになります。
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
(d) HwfPutCase(文書とメモを格納した案件をビジネスプロセス定義に投入)
機能
案件にユーザ属性を設定し,文書とメモを添付した後,指定したビジネスプロセス定義に案件を投入します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include <bwf.h>
long HwfPutCase (
 long                      mode,        /* 処理モード (I) */
 char                __far *bpname,       /* ビジネスプロセス定義名称 (I) */
 BWF_bptype_t        __far *bptype,       /* ビジネスプロセス定義種別 (I) */
 unsigned long       __far *bp_version_number, /* バージョン番号 (I) */
 char                __far *nodename,      /* ノード名称 (I) */
 HWND                      pwnd_handle,     /* 親ウィンドウのハンドル (I) */
 BWF_userkey_t       __far *userkey,      /* ワークID(案件識別子フォーマット) (I) */
 char                __far *title,       /* 案件タイトル名 (I) */
 BWF_time_t          __far *limit,       /* 処理期限 (I) */
 long                      priority,      /* 優先順位 (I) */
 long                      putmode,       /* 投入処理モード (I) */
 long                      nextusern,      /* 次ノード処理ユーザ情報数 (I) */
 BWF_nextuser_t      __far *nextuser,      /* 次ノード処理ユーザ情報 (I) */
 long                      caseinflistn,    /* 投入案件情報リスト要素数 (I) */
 BWF_putcaseinfex_t  __far *caseinflist,    /* 投入案件情報リスト (I) */
 BWF_userkey_t             *out_userkey,    /* 設定ワークID(案件識別子フォーマット) (O) */
 BWF_errlist_t       __far *errlist       /* エラー情報取得領域 (O) */
);

typedef struct  BWF_nextuser_t{           /* 次ノード処理ユーザ情報 */
 char  casename[64];                /* ケース名称 (I) */
 char  attributename[64];              /* ユーザ定義属性名称 (I) */
 char  nickname[132];               /* 処理ユーザのニックネーム (I) */
}BWF_nextuser_t ;

typedef struct  BWF_putcaseinfex_t{         /* 投入案件情報 */
 BWF_casename_t                casename;      /* 案件名 (I) */
 long                          userattrlistn;   /* ユーザ属性リスト数 (I) */
 BWF_end_userattrlist_t  __far *userattrlist;   /* ユーザ属性リスト (I) */
 long                          docfilelistn;    /* 文書数 (I) */
 BWF_docupdateex_t       __far *docfilelist;    /* 文書ファイル名称リスト (I) */
 long                          datamemofilelistn; /* メモ数 (I) */
 BWF_docupdateex_t       __far *datamemofilelist; /* メモファイル名称リスト (I) */
 char                          reserved[32];    /* 予備領域 (I) */
}BWF_putcaseinfex_t ;

typedef struct BWF_end_userattrlist_t {     /* エンドユーザ属性 */
 char                 BWF_user_defname[64];   /* ユーザ定義名称 (I) */
 char                 BWF_user_attr_value[32]; /* 設定ユーザ属性 (I) */
}BWF_end_userattrlist_t;

typedef struct BWF_docupdateex_t {   /* 文書/メモ更新情報 */
 char             type;        /* 更新種別を指定する (-) */
                    /* A:添付 D:削除 U:更新   */
 char             memotype;      /* メモ種別を指定する            (I) */
                    /* F:ファイル D:データ               */
                    /* S:Groupmax Integrated Desktop本文 */
 char             reserved1[2];    /* 予備領域 (-) */
 BWF_oid_t        file_id;       /* 文書/メモファイル識別子 (-) */
 char             outfilename[512];  /* フルパスファイル名称 (I) */
 char             oldname[256];    /* ファイル登録名称 (-) */
 char             reserved[64];    /* 予備領域 (-) */
}BWF_docupdateex_t;

typedef struct  BWF_errlist_t {     /* エラー情報取得領域 */
 char         sBMsgKbn[6];       /* メッセージ区分 (O) */
 long         lBMsgNo;         /* メッセージ番号 (O) */
 char         sBInsWord[13];      /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
mode
処理モードを指定します。必ず0を指定してください。
0:サーバと接続済みの場合指定します。
bpname
案件を投入するビジネスプロセス定義名称を格納した領域を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
bptype
案件を投入するビジネスプロセス定義の種別を格納した領域を指定します。
0:ビジネスプロセス定義
1:拡張ビジネスプロセス定義
bp_version_number
案件を投入するビジネスプロセス定義のバージョン番号を格納した領域を指定します。0を指定すると最新版のビジネスプロセス定義に案件を投入します。
nodename
ノード名称を格納した領域を指定します。投入ノードが一つしかないビジネスプロセス定義に案件を投入する場合,このパラメタは省略できます。省略するときはこのパラメタにNULLを指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
pwnd_handle
親ウィンドウのハンドルを格納した領域を指定します。
userkey
ワークID(案件識別子フォーマット)を格納した領域を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。ビジネスプロセス定義にワークID(案件識別子フォーマット)の自動採番機能が定義されている場合,このパラメタの指定値は無視されることがあります。実際に投入されたワークID(案件識別子フォーマット)は,out_userkeyパラメタの出力値,又はHwfGetUserHistoryEx関数で確認してください。
また,putmodeでサブモード投入を指定する場合は,待ち合わせ対象となる案件と同一のワークID(案件識別子フォーマット)を必ず指定してください。
title
案件タイトル名を格納した領域を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
limit
処理期限を格納した領域を指定します。処理期限は,YYYYMMDDhhmmss形式の14バイト文字列です。
NULLを指定したときは,投入時間にビジネスプロセス定義に指定されたデフォルト処理期限を加えた日時が設定されます。ビジネスプロセス定義にデフォルト処理期限が指定されていない場合は,30日後を案件の処理期限とします。
priority
優先順位を指定します。次に示す値以外を指定したとき,優先順位はBWF_NORMALとなります。
BWF_NORMAL:普通
BWF_URGENT:至急
putmode
投入処理のモードを指定します。
0:メインモードで投入します。既に同一ワークID(案件識別子フォーマット)で投入されている場合,ワークID(案件識別子フォーマット)重複でエラーリターンします。
1:サブモードで投入します。同一ワークID(案件識別子フォーマット)で待ち合わせ対象となる案件が先に投入されていない場合,エラーリターンします。
nextusern
nextuserで指定する次ノードの処理ユーザ数を指定します。
nextuser
次ノードの処理ユーザをBWF_nextuser_t構造体で指定します。指定しない場合はNULLを指定してください。BMF_nextuser_t構造体については,次ノード処理ユーザ情報を参照してください。
caseinflistn
投入案件情報リスト(caseinflist)の要素数を指定します。1以上の値を指定してください。
caseinflist
caseinflistnに指定した数分の投入案件情報リストの要素を指定します。投入案件情報リストの要素については,投入案件情報リスト内項目を参照してください。
out_userkey
ビジネスプロセス定義に投入した案件に設定したワークID(案件識別子フォーマット)が出力されます。
Groupmax Workflow Definerで「ワークIDを指定しない」モードを選択して登録したビジネスプロセス定義に対して投入した場合は,NULL文字が戻ります。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン,又は警告発生
注意事項
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
  • 総データ転送量が64000バイトを超えない範囲で使用してください。
    総データ転送量は次の計算式で求めることができます。
総データ転送量=332
+ 指定したビジネスプロセス定義名称長(※1)
+ 指定したノード名称長(※1)
+ 指定したワークID長(※1)
+ 指定した案件タイトル長(※1)
+ 次ノード処理ユーザ情報転送量総和
+ 案件転送量総和
次ノード処理ユーザ情報転送量総和は,次ノード処理ユーザリストに指定した,1次ノード処理ユーザ情報転送量の合計です。
1次ノード処理ユーザ情報転送量=48
+ 案件名称長(※1)
+ ユーザ定義名称長(※1)
+ 処理ユーザのニックネーム長(※1)
案件転送量総和は,案件ごとの1案件当たりの転送量の合計です。
1案件当たりの転送量=76
+ 案件名称長(※1)
+ 案件ごとのユーザ処理リスト情報転送量総和
+ 案件ごとの指定文書情報転送量総和
+ 案件ごとの指定メモ情報転送量総和
案件ごとのユーザ処理リスト情報転送量総和は,案件ごとの1ユーザ処理リスト情報転送量の合計です。
1ユーザ処理リスト情報転送量=32
+ ユーザ処理リストに指定したユーザ定義名称長(※1)
+ 設定ユーザ属性長(※1)
案件ごとの指定文書情報転送量総和は,案件ごとの1文書情報転送量の合計です。
1文書情報転送量=24
案件ごとの指定メモ情報転送量総和は,案件ごとの1メモ情報転送量の合計です。
メモ種別がD以外のメモの1メモ情報転送量=84
メモ種別がDのメモの1メモ情報転送量=84+(↑指定したデータメモのサイズ÷4095↑×8)(※2)
注※1
ビジネスプロセス定義名称長・ノード名称長・ワークID長・案件タイトル長・案件名称長・ユーザ定義名称長
処理ユーザのニックネーム長・設定ユーザ属性長は,¥0を含めた長さを基本長とし,基本長が4バイトの倍数になるように補正されます。例えば,"abcd¥0"の場合,実長は5になります。4の倍数に補正されるため,実長5の文字列長は8になります。
注※2
↑↑は小数点以下切り上げを示します。
(e) HwfPutCaseEx(文書とメモを格納した条件をビジネスプロセス定義に投入)
機能
案件にユーザ属性を設定し,文書とメモを添付した後,指定したビジネスプロセス定義に案件を投入します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include <bwf.h>
long HwfPutCaseEx (
 long                       mode,         /* 処理モード (I) */
 char                __far *bpname,        /* ビジネスプロセス定義名称 (I) */
 BWF_bptype_t        __far *bptype,        /* ビジネスプロセス定義種別 (I) */
 unsigned long       __far *bp_version_number,  /* バージョン番号 (I) */
 char                __far *nodename,       /* ノード名称 (I) */
 HWND                       pwnd_handle,     /* 親ウィンドウのハンドル (I) */
 BWF_userkey_t       __far *userkey,       /* ワークID(案件識別子フォーマット) (I) */
 char                __far *title,        /* 案件タイトル名 (I) */
 BWF_time_t          __far *limit,        /* 処理期限 (I) */
 long                       priority,       /* 優先順位 (I) */
 long                       putmode,       /* 投入処理モード (I) */
 long                       nextusern,      /* 次ノード処理ユーザ情報数 (I) */
 BWF_nextuser_t      __far *nextuser,       /* 次ノード処理ユーザ情報 (I) */
 long                       caseinflistn,     /* 投入案件情報リスト要素数 (I) */
 BWF_putcaseinfex_t  __far *caseinflist,     /* 投入案件情報リスト (I) */
 BWF_putresultinf_t        *putresult,      /* 投入案件結果情報取得領域 (O) */
 char                __far *reserve,       /* 予備領域 (-) */
 BWF_errlist_t       __far *errlist        /* エラー情報取得領域 (O) */
);

typedef struct  BWF_nextuser_t{          /* 次ノード処理ユーザ情報 */
 char  casename[64];               /* ケース名称 (I) */
 char  attributename[64];             /* ユーザ定義属性名称 (I) */
 char  nickname[132];               /* 処理ユーザのニックネーム (I) */
}BWF_nextuser_t ;

typedef struct  BWF_putcaseinfex_t{         /* 投入案件情報 */
BWF_casename_t                  casename;      /* 案件名 (I) */
 long                            userattrlistn;   /* ユーザ属性リスト数 (I) */
 BWF_end_userattrlist_t  __far  *userattrlist;   /* ユーザ属性リスト (I) */
 long                            docfilelistn;   /* 文書数 (I) */
 BWF_docupdateex_t       __far  *docfilelist;    /* 文書ファイル名称リスト (I) */
 long                            datamemofilelistn; /* メモ数 (I) */
 BWF_docupdateex_t       __far  *datamemofilelist; /* メモファイル名称リスト (I) */
 char                            reserved[32];   /* 予備領域 (I) */
}BWF_putcaseinfex_t ;

typedef struct    BWF_end_userattrlist_t {  /* エンドユーザ属性 */
 char            BWF_user_defname[64];    /* ユーザ定義名称 (I) */
 char            BWF_user_attr_value[32];  /* 設定ユーザ属性 (I) */
}BWF_end_userattrlist_t;

typedef struct  BWF_docupdateex_t {      /* 文書/メモ更新情報 */
 char       type;              /* 更新種別を指定する (-) */
                       /* A:添付 D:削除 U:更新 */
 char       memotype;            /* メモ種別を指定する(I) */
                       /* F:ファイル D:データ */
                       /* S:Groupmax Integrated Desktop本文 */
 char       reserved1[2];          /* 予備領域 (-) */
 BWF_oid_t  file_id;             /* 文書/メモファイル識別子 (-) */
 char       outfilename[512];        /* フルパスファイル名称 (I) */
 char       oldname[256];          /* ファイル登録名称 (-) */
 char       reserved[64];          /* 予備領域 (-) */
}BWF_docupdateex_t;

typedef struct  BWF_putresultinf_t {  /* 投入案件結果情報 (O) */
 long            bp_version_number;  /* 投入バージョン番号 (O) */
 BWF_userkey_t   userkey;       /* 設定ワークID(案件識別子フォーマット) (O) */
 char            put_server_id[8];   /* 投入サーバID (O) */
 char            reserved[52];     /* 予備領域 (-) */
} BWF_putresultinf_t;

typedef struct  BWF_errlist_t {     /* エラー情報取得領域 */
 char            sBMsgKbn[6];     /* メッセージ区分 (O) */
 long            lBMsgNo;       /* メッセージ番号 (O) */
 char            sBInsWord[13];    /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
mode
処理モードを指定します。
0:サーバと接続済みの場合に指定します。
bpname
案件を投入するビジネスプロセス定義名称を格納した領域を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
bptype
案件を投入するビジネスプロセス定義の種別を格納した領域を指定します。
0:ビジネスプロセス定義
1:拡張ビジネスプロセス定義
bp_version_number
案件を投入するビジネスプロセス定義のバージョン番号を格納した領域を指定します。0を指定すると最新版のビジネスプロセス定義に案件を投入します。
nodename
ノード名称を格納した領域を指定します。投入ノードが一つしかないビジネスプロセス定義に案件を投入する場合,この引数は省略できます。省略するときはこの引数にNULLを指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
pwnd_handle
親ウィンドウのハンドルを格納した領域を指定します。
userkey
ワークID(案件識別子フォーマット)を格納した領域を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
ビジネスプロセス定義にワークID(案件識別子フォーマット)の自動採番機能が定義されている場合,このパラメタの指定値は無視されることがあります。実際に投入されたワークID(案件識別子フォーマット)は,putresult構造体のuserkeyで確認してください。また,putmodeでサブモード投入を指定する場合は,待ち合わせ対象となる案件と同一のワークID(案件識別子フォーマット)を必ず指定してください。
title
案件タイトル名を格納した領域を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
limit
処理期限を格納した領域を指定します。処理期限は,YYYYMMDDhhmmss形式の14バイト文字列です。
NULLを指定したときは,投入時間にビジネスプロセス定義に指定されたデフォルト処理期限を加えた日時が設定されます。ビジネスプロセス定義にデフォルト処理期限が指定されていない場合は,30日後を案件の処理期限とします。
priority
優先順位を指定します。
BWF_NORMAL:普通
BWF_URGENT:至急
putmode
投入処理のモードを指定します。
0:メインモードで投入します。既に同一ワークID(案件識別子フォーマット)で投入されている場合,ワークID(案件識別子フォーマット)重複でエラーリターンします。
1:サブモードで投入します。同一ワークID(案件識別子フォーマット)で待ち合わせ対象となる案件が先に投入されていない場合,エラーリターンします。
nextusern
nextuserで指定する次ノードの処理ユーザ数を指定します。
nextuser
次ノードの処理ユーザをBWF_nextuser_t構造体で指定します。指定しない場合はNULLを指定してください。
BWF_nextuser_t構造体については,次ノード処理ユーザ情報を参照してください。
caseinflistn
投入案件情報リスト(caseinflist)の要素数を指定します。1以上の値を指定してください。
caseinflist
caseinflistnに指定した数分の投入案件情報リストの要素を指定します。投入案件情報リストの要素については,投入案件情報リスト内項目を参照してください。
putresult
ビジネスプロセス定義に投入した案件の情報が出力されます。投入した案件の情報については,投入案件結果情報項目を参照してください。
reserve
予備領域です。NULL文字を指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 添付できるデータオブジェクト,及び Desktopメモは案件につき各一つ以下です。
  • データオブジェクトは同報中にサイズを変更しないでください。
  • ロングファイル名称で文書,メモを登録した場合,Desktop(16bit版),バージョン1,02-00,又は02-10以降でバージョン1との互換関数を使用して文書,メモを参照すると,以下の規則でファイル名称を変換します。
  • ファイル名:先頭から8バイトを抽出します。拡張子:先頭から3バイトを抽出します。また半角の[,],;,+,=,及び,は,~に変換します。
  • Groupmax Workflow Serverのバージョンが02-10のときにロングファイル名称で登録した文書,メモは,それぞれ”wfdoc.dat”,”wfmemo.dat”という名称に変換して取得されます。
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
  • 総データ転送量が64000バイトを超えない範囲で使用してください。
    総データ転送量は次の計算式で求めることができます。
総データ転送量=332
+ 指定したビジネスプロセス定義名称長(※1)
+ 指定したノード名称長(※1)
+ 指定したワークID長(※1)
+ 指定した案件タイトル長(※1)
+ 次ノード処理ユーザ情報転送量総和
+ 案件転送量総和
次ノード処理ユーザ情報転送量総和は,次ノード処理ユーザリストに指定した,1次ノード処理ユーザ情報転送量の合計です。
1次ノード処理ユーザ情報転送量=48
+ 案件名称長(※1)
+ ユーザ定義名称長(※1)
+ 処理ユーザのニックネーム長(※1)
案件転送量総和は,案件ごとの1案件当たりの転送量の合計です。
1案件当たりの転送量=76
+ 案件名称長(※1)
+ 案件ごとのユーザ処理リスト情報転送量総和
+ 案件ごとの指定文書情報転送量総和
+ 案件ごとの指定メモ情報転送量総和
案件ごとのユーザ処理リスト情報転送量総和は,案件ごとの1ユーザ処理リスト情報転送量の合計です。
1ユーザ処理リスト情報転送量=32
+ ユーザ処理リストに指定したユーザ定義名称長(※1)
+ 設定ユーザ属性長(※1)
案件ごとの指定文書情報転送量総和は,案件ごとの1文書情報転送量の合計です。
1文書情報転送量=24
案件ごとの指定メモ情報転送量総和は,案件ごとの1メモ情報転送量の合計です。
メモ種別がD以外のメモの1メモ情報転送量=84
メモ種別がDのメモの1メモ情報転送量=84+(↑指定したデータメモのサイズ÷4095↑×8)(※2)
注※1
ビジネスプロセス定義名称長・ノード名称長・ワークID長・案件タイトル長・案件名称長・ユーザ定義名称長
処理ユーザのニックネーム長・設定ユーザ属性長は,¥0を含めた長さを基本長とし,基本長が4バイトの倍数になるように補正されます。例えば,"abcd¥0"の場合,実長は5になります。4の倍数に補正されるため,実長5の文字列長は8になります。
注※2
↑↑は小数点以下切り上げを示します。
(f) HwfGetCaseFromRoleEx(ロールトレーからユーザトレーへの案件の取り出し)
機能
ロールトレーから任意の案件をユーザトレーに取り出します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetCaseFromRoleEx(
 BWF_useroid_t  __far  *useroid,  /* ユーザオブジェクトID格納領域  (I) */
 BWF_server_t   __far  *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far  *caseid,  /* 任意取り出し案件オブジェクトID格納領域 (I) */
 long                  casenum,  /* 複数案件取り出し数 (I) */
 char           __far  *nickname, /* 案件取り出しユーザニックネーム格納領域 (I) */
 BWF_errlist_t  __far  *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
ロールトレーから任意に取り出したい案件の案件オブジェクトIDを指定します。casenumで指定する数だけ指定してください。案件に複数の下位案件がある場合は,上位案件オブジェクトIDを指定してください。案件オブジェクトIDは,HwfGetCaseSelectDataなどで取得できます。
casenum
ロールトレーから取り出したい案件の数を指定します。1~500までの範囲内で指定してください。
nickname
案件をロールトレーから取り出すユーザのGroupmax Addressで管理するニックネームを格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 案件をロールトレーから取り出す場合,caseidで指定した案件はロールトレーになければなりません。
  • 案件をロールトレーから取り出す場合,nicknameで指定したユーザはcaseidで指定した案件があるロールに登録されたユーザでなければなりません。
  • 案件をロールトレーから取り出す場合,nicknameで指定したユーザは運用可能状態でなければなりません。
  • 複数の案件を一括して取り出す場合は,指定する案件がすべて同じロールに存在しなければなりません。異なるロールに存在する案件を同時に指定した場合はエラーリターンします。
(g) HwfPutCaseFromUser(ユーザトレーからロールトレーへの案件の返却)
機能
ユーザトレーにある案件をロールトレーに返却します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfPutCaseFromUser(
 BWF_useroid_t  __far *useroid,  /* ユーザオブジェクトID格納領域   (I) */
 BWF_server_t   __far *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far *caseid,  /* 返却案件オブジェクトID格納領域 (I) */
 BWF_errlist_t  __far *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
ロールトレーに返却するuseroidで指定したユーザのユーザトレー内にある案件の案件オブジェクトIDを格納した領域を指定します。案件に複数の下位案件がある場合は,上位案件オブジェクトIDを指定してください。
ロールトレーから,HwfGetCaseFromRoleExを発行して取り出した案件以外はロールトレーに返却できません。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • Groupmax Workflow Definerで,caseid対応のノード名に対する作業机の設定で,「自動配布を行う」を指定した場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。caseid対応のノード名は,HwfGetObjectAttributeEx,HwfGetCaseSelectDataなどで取得できます。
(h) HwfTakeBackCaseEx(案件の引き戻し要求)
機能
ユーザヒストリで指定した案件を自トレーに引き戻します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfTakeBackCaseEx(
 BWF_useroid_t  __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,   /* サーバ名称格納領域 (I) */
 unsigned long        takehdl,   /* 引き戻し対象ハンドル (I) */
 BWF_errlist_t  __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char  sBMsgKbn[6];  /* メッセージ区分 */
 long  lBMsgNo;    /* メッセージ番号 */
 char  sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
takehdl
引き戻し対象とするユーザヒストリのイベントのハンドルを指定してください。ユーザハンドルのイベントハンドルは,HwfGetUserHistoryExで取得できます。
指定できるユーザヒストリは,「案件の投入」,「案件発信」によるものだけです。ユーザヒストリの詳細については,HwfGetUserHistoryExを参照してください。
なお,ハンドルはHwfGetUserHistoryExで取得した後,ユーザヒストリにイベントを出力する関数(HwfSimplePutCase,HwfPutCase,HwfPrefixCase,HwfSimpleGoCase,HwfAnswerCase,HwfRoundCaseEx,HwfTrustCaseEx,HwfTakeBackCaseEx,HwfSendBackCaseExなど)を発行するまで有効です。また,セション共用を使用する場合,ほかのアプリケーションがこれらの関数を発行してもハンドルは無効となります。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 引き戻し要求対象の案件が,引き戻し要求ノードの次の処理ノードにあり,かつ作業していない場合にだけ引き戻しができます。引き戻し要求対象の案件が次の処理ノードより先に遷移している場合や遷移中,相談中,又は作業中の場合は,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 同報,分割,回収,待合,統合,及び複写ノードのどれかを含むビジネスプロセス定義中で引き戻し要求を出した場合,次のような実行結果となります。
    引き戻し要求ノードから引き戻す案件があるノードの間に同報,分割,回収,待合,統合,及び複写ノードがない場合,引き戻しができます。同報,分割,回収,待合,統合,及び複写ノードがあった場合,戻り値はエラーリターン(BWF_ERROR)となります。
    (例)

    [図データ]

    処理ノード3のユーザは,処理ノード4の案件を引き戻せますが,処理ノード1(又は2)のユーザは,処理ノード3の案件は引き戻せません。
  • ビジネスプロセス定義間連携を行っている場合は,引き戻し要求の案件があるビジネスプロセス定義内でだけ引き戻しができます。ビジネスプロセス定義間をまたがっての引き戻し(例:連携先から連携元への引き戻しなど)はできません。
  • 引き戻し操作禁止オプションを指定して登録した拡張ビジネスプロセス定義に投入された案件(takehdl.パラメタで指定)に対してこの関数を発行すると,戻り値はエラーリターン(BWF_ERROR)となります。
(i) HwfTakeBackCaseDirect(案件引き戻し)
機能
案件投入時及び遷移時に取得した情報を使用して,以前に操作した案件を自トレーに引き戻します。
ユーザヒストリから引き戻し案件の情報を取得する場合は,HwfTakeBackCaseEx(案件の引き戻し要求)を使用してください。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>

long HwfTakeBackCaseDirect(
 BWF_useroid_t              __far *useroid,    /* ユーザオブジェクト ID 格納領域 (I) */
 BWF_server_t               __far *server,     /* サーバ名称格納領域 (I) */
BWF_takebackcasedirect_t   __far *takebackcaseinf, /* 引き戻し案件情報 (I) */
 BWF_errlist_t              __far *errlist     /* エラー情報取得領域 (O) */
 void                       __far *arg       /* 拡張用領域のアドレス (-) */
);
typedef struct BWF_takebackcasedirect_t {
 char                 mode[4];    /* 処理モード (I) */
 BWF_caseid_t         caseoid;    /* 案件オブジェクトID (I) */
 char                 serverid[8];  /* 予備領域 (I) */
 char                 nodename[64]; /* ノード名 (I) */
 char                 bpname[64];  /* ビジネスプロセス定義名 (I) */
 unsigned long        bpver;     /* ビジネスプロセス定義バージョン番号 (I) */
 char                 bptype[4];   /* ビジネスプロセス定義種別 (I) */
 char                 workid[64];  /* ワークID(案件識別子フォーマット) (I) */
 char                 reserve[100]; /* 予備領域 (-) */
} BWF_takebackcasedirect_t;

typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
takebackcaseinf
引き戻し対象案件の情報を指定します。引き戻し対象案件の情報については,引き戻し案件情報項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
予備領域です。NULLポインタを指定してください。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • マルチサーバ構成で,案件投入作業の引き戻しの場合,投入した案件が投入エラー,又は投入中の場合,このAPI関数はエラーリターンします。
  • 投入エラー又は投入中の案件に対してこのAPIを発行すると,不正な案件を引き戻すことがあります。投入が正常に終了したことを確認して,このAPIを発行してください。
  • 自分が処理をした案件以外を指定した場合はこのAPIはエラーリターンします。
  • 引き戻し要求対象の案件が,引き戻し要求ノードの次の処理ノードにあり,かつ作業していない場合にだけ引き戻しができます。引き戻し要求対象の案件が次の処理ノードより先に遷移している場合や遷移中,相談中,又は作業中の場合は,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 同報,分割,回収,待合,統合,及び複写ノードのどれかを含むビジネスプロセス定義中で引き戻し要求を出した場合,次のような実行結果となります。
    引き戻し要求ノードから引き戻す案件があるノードの間に同報,分割,回収,待合,統合,及び複写ノードがない場合,引き戻しができます。同報,分割,回収,待合,統合,及び複写ノードがあった場合,戻り値はエラーリターン(BWF_ERROR)となります。
    (例)

    [図データ]

    処理ノード3のユーザは,処理ノード4の案件を引き戻せますが,処理ノード1(又は2)のユーザは,処理ノード3の案件は引き戻せません。
  • ビジネスプロセス定義間連携をしている場合は,引き戻し要求の案件があるビジネスプロセス定義内でだけ引き戻しができます。ビジネスプロセス定義間をまたがっての引き戻し(例:連携先から連携元への引き戻しなど)はできません。
  • 引き戻し操作禁止オプションを指定して登録した拡張ビジネスプロセス定義に投入された案件に対してこの関数を発行すると,戻り値はエラーリターン(BWF_ERROR)となります。
(j) フォームリスト内項目
項目内容
BWF_fm_bp_oidビジネスプロセス定義オブジェクトIDが設定されます。
BWF_fm_bp_nameBWF_fm_bp_oidに対応するビジネスプロセス定義名称が設定されます。
BWF_fm_bp_version_numberBWF_fm_bp_oidに対応するビジネスプロセス定義のバージョン番号が設定されます。
BWF_fm_node_idBWF_fm_bp_oidに対応するビジネスプロセス定義の開始処理ノードのノードIDが設定されます。
BWF_fm_node_nameBWF_fm_bp_oidに対応するビジネスプロセス定義の開始処理ノードのノード名称が設定されます。
BWF_fm_workid_numberingワークIDの自動採番が定義されているかどうかが設定されます。
AMAN:自動採番機能付き(ユーザによる変更不可)
AOP△:自動採番機能付き(ユーザによる変更可)
SYS△:システム値
M△△△:自動採番機能なし
BWF_fm_default_limitデフォルトの処理期限が日数で設定されます。
BWF_fm_bp_typeビジネスプロセス定義の種別が設定されます。
0:ビジネスプロセス定義
1:拡張ビジネスプロセス定義
BWF_fm_opnumber取得するユーザ処理リストの先頭要素番号を指定します。先頭番号は0~(BWF_fm_total_oplistn-1)の範囲内で設定してください。
BWF_fm_oplistn取得するユーザ処理リストの要素数を指定します。0以下の値を指定するとユーザ処理リストは設定しません。取得するユーザ処理リストの要素数の上限値はこの関数の注意事項を参照してください。
BWF_fm_total_oplistn定義されているユーザ処理リストの総数を設定します。
BWF_fm_get_oplistn取得できたユーザ処理リストの数を設定します。
BWF_fm_get_oplistユーザ処理リストを格納する領域の先頭アドレスを指定します。BWF_fm_oplistn分格納できる領域がない場合の動作は保証できません。ユーザ処理リストの設定項目については,ユーザ処理リスト内項目を参照してください。
(k) ファイル名の注意事項

Version 5までは,案件に添付する文書ファイル名に使用できる文字コードに,次のようなWorkflowによる制限がありました。

Version 5までの添付ファイル名称に使用できる文字コード

半角コード
半角コードのコード番号0x20~0x7E又は0xA1~0xDFの範囲のコード。ただし,半角スペース,「/」,「¥」,「?」,「"」,「<」,「>」,「*」,「|」,「:」を除く。
全角コード
シフトJISコードのコード番号において,2バイトコードの先頭1バイトの値が0x81~0x9F又は0xE0~0xEFのどちらかの範囲に含まれ,なおかつ,後ろ1バイトの値が0x40~0x7E又は0x80~0xFCのどちらかの範囲に含まれる全角コード。ただし,全角スペースを除く。

06-00以降は,上記のWorkflowによるファイル名に使用できる文字コードの制限を解除することができます。この制限を解除することによりOS上で作成できるファイル名のファイルを扱えるようになるため,これまで使用できなかった半角スペースや全角スペースなどの文字が添付文書ファイル名に使用できるようになります。そのためにはGroupmax Workflow Serverによる環境設定が必要です。詳しくは「Groupmax Workflow Version 6 システム管理者ガイド」の環境設定ユティリティの「添付文書ファイル名称チェック」を参照してください。

Groupmax Workflow Serverの環境設定「添付文書ファイル名称チェック」の指定が有効になる関数を次に示します。

「添付文書ファイル名称チェック」の指定が有効になる関数一覧

「添付文書ファイル名称チェック」を"no"に指定した場合の注意事項

Version 5まで添付ファイル名称に使用できなかった文字コードを含むファイル名で登録した文書やメモを参照するときに次のものを使用した場合,そのファイル名は「ファイル名称変換規則」に示すように変換されます。

「ファイル名称変換規則」

Version 5までの添付ファイル名称に使用できる文字コード以外の半角コードは「~」(1バイト)に,全角コードは「~~」(2バイト)にそれぞれ変換されます。

(l) 次ノード処理ユーザ情報
項目内容
casename設定する案件の名称を指定してください。
attributename設定する案件の属性名称をGroupmax Workflow Definerで定義した任意の名称で格納します。
nickname次ノードで処理依頼するユーザのGroupmax Address管理のニックネームを格納します。
(m) ユーザ処理リスト内項目
項目内容
BWF_ol_kind_codecaseidに対応する案件に対して実行する作業の種別が設定されています。
01:案件の生成,投入
02:案件に文書を追加格納
03:案件のユーザ属性に任意値設定
04:案件のユーザ属性に候補値設定
05:サブノードからの案件投入
08:案件の任意ユーザ状態コードへ候補値設定
09:案件の属性値を一覧表示時に出力
10:任意データを参照
11:アプリケーションプログラムを起動
12:案件情報をGroupmax Document Managerへ格納(ワーク情報,案件情報,ワークヒストリ,文書,メモなどを必要に応じて,Groupmax Document Managerに格納してください)
13:案件の複写先を指定
14:案件の作業者を指定
15:配布キーの指定
99:前の作業種別の継続
BWF_ol_create_conditionBWF_ol_kind_codeに対応する,作業の実行条件が設定されています。
01:必須
02:任意
0x0000:BWF_ol_kind_codeが次の場合に設定されます。
案件の任意ユーザ状態コードへ候補値設定(08)
  • 案件の属性値を一覧表示時に出力(09)
  • アプリケーションプログラムを起動(11)
  • 案件情報をGroupmax Document Managerへ格納(12)
  • 任意データを参照(10)
  • 前の作業種別の継続(99)
BWF_ol_case_nameBWF_ol_kind_codeに対応する,作業の対象となる案件の名称が設定されています。ただし,BWF_ol_kind_codeが次の場合,すべてにNULL文字が設定されます。
  • 案件の任意ユーザ状態コードへ候補値設定(08)
  • アプリケーションプログラムを起動(11)
  • 案件情報をGroupmax Document Managerへ格納(12)
  • 任意データを参照(10)
BWF_ol_get_operation_listBWF_ol_kind_codeに対応する作業の情報が設定されています。この情報はBWF_ol_kind_codeに設定された種別によって,格納形式が異なります。作業情報の格納形式を次に示します。
作業情報格納形式(案件の生成,投入(”01”))
作業情報を参照する必要はありません。
作業情報格納形式(案件に文書を追加格納(”02”))
作業情報には,終端文字を含め,256バイト以内の情報が設定されます。この情報を基に,ユーザトレー内にある案件にHwfUpdateCaseDocument,HwfSuffixCase,又はHwfSimpleGoCaseで登録した文書を格納します。
形式
追加文書名称1,追加文書名称2,,..,追加文書名称n¥0
追加文書名称
案件に追加格納する文書名称が,64バイト以内の文字列として設定されます。
追加文書名称セパレータ(’,’)
追加文書名称が,複数設定されている場合の区切りを示します。
作業情報終端文字(’¥0’)
作業情報の終端を示します。
設定例
申込書,診断書¥0
作業情報格納形式(案件のユーザ属性に任意値設定(”03”))
作業情報には,終端文字を含め256バイト以内の情報が設定されます。
ユーザトレー内にある案件にHwfPrefixCase,又はHwfSimplePreCaseでユーザ処理を開始し,案件のユーザ属性に対して,HwfSetCaseのパラメタとして,属性名称,属性型に対応する任意値を指定,又はHwfSetCaseByUserDefNameのパラメタとして,ユーザ定義名称,属性型,属性型に対応する任意値を指定して,案件のユーザ属性に任意値を指定します。
形式
属性名称0x0aユーザ定義名称0x0a属性型0x0a¥0
属性名称
属性値を設定するユーザ属性の属性名称が設定されます。この情報をHwfSetCase,又はHwfGetCaseExistUserAttrValueのパラメタとして設定します。
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,又は属性型の区切りを示します。
ユーザ定義名称
案件のユーザ属性に設定する属性値の意味が設定されます。この情報をHwfSetCaseByUserDefNameのパラメタとして指定します。
属性型
案件のユーザ属性に設定する属性値の型を示します。
01:文字型
02:整数型
03:日時型
この情報をHwfSetCase,又はHwfSetCaseByUserDefNameのパラメタとして設定します。
作業情報終端文字(’¥0’)
作業情報の終端を示します。
設定例
WF_cs_attr_char_10x0a審査結果0x0a010x0a¥0
作業情報格納形式(案件のユーザ属性に候補値設定(”04”))
この作業情報を基に,ユーザトレー内にある案件をHwfPrefixCase,又はHwfSimpleGoCaseでユーザ処理を開始します。この後HwfSetCaseのパラメタとして,属性名称,属性型,候補値を指定,又はHwfSetCaseByUserDefNameのパラメタとして,ユーザ定義名称,属性型,候補値を指定して,案件のユーザ属性に任意値を設定します。なお,作業情報内に,すべての情報が格納できない場合,作業情報の先頭から255バイトで一度区切り,NULL文字で終端し,次のフォームリストの作業種別が「前の作業種別の継続(”99”)」である作業情報の先頭に,続きである256バイト目以降の情報が設定されます。
形式
属性名称0x0aユーザ定義名称0x0a属性型0x0a候補値1,候補値2,..候補値n0x0a¥0
属性名称
属性値を設定するユーザ属性の属性名称が設定されます。この情報をHwfSetCaseのパラメタとして設定します。
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,属性型の区切りを示します。
ユーザ定義名称
案件のユーザ属性に設定する属性値の意味が設定されます。
この情報をHwfSetCaseByUserDefNameのパラメタとして指定します。
属性型
案件のユーザ属性に設定する属性値の型を示します。
01:文字型
02:整数型
03:日時型
この情報をHwfSetCase,又はHwfSetCaseByUserDefNameのパラメタとして指定します。
候補値
案件のユーザ属性に設定するデータの候補値が設定されます。
HwfSetCase,又はHwfSetCaseByUserDefNameのパラメタとして設定します。
候補値セパレータ(’,’)
候補値1~nの区切りを示します。
作業情報終端文字(’¥0’)
作業情報の終端を示します。
設定例
WF_cs_attr_char_10x0a審査結果0x0a010x0aOK,NG0x0a¥0
作業情報格納形式(サブノードからの案件投入(”05”))
作業情報を参照する必要はありません。
作業情報格納形式(案件の任意ユーザ状態コードへ候補値設定(”08”))
作業情報内にすべての情報が格納できない場合,作業情報の先頭から255バイトで一度区切り,NULL文字で終端し,次のフォームリストの作業種別が「前の作業種別の継続(”99”)」である作業情報の先頭に,続きである256バイト目以降の情報が設定されます。
形式
候補値1,候補値2,..候補値n0x0a¥0
候補値
案件のユーザ属性に設定するデータの候補値が設定されます。
候補値セパレータ(’,’)
候補値1~nの区切りを示します。
作業情報終端文字(’¥0’)
作業情報の終端を示します。
設定例
受付,保留中,完了0x0a¥0
作業情報格納形式(案件の属性値を一覧表示時に出力(”09”))
作業情報は,終端文字を含め256バイト以内の情報が設定されます。
ユーザトレー内にある案件をHwfPrefixCase,又はHwfSimpleGoCaseでユーザ処理を開始し,次ノードへの遷移要求をする前に,HwfSetCase,又は,HwfSetCaseByUserDefNameで,BWF_ol_create_conditionが「必須」となっているユーザ処理リストの作業情報を基に,案件のユーザ属性に対して属性値を設定しているかを,HwfGetCaseExistUserAttrValueを発行して確認してください。これによって,案件のユーザ属性に対する属性値設定漏れによる,次ノード以降にある分岐ノードでの分岐エラー,又は誤ったノードへ案件が分岐するのを防止してください。
形式
属性名称0x0aユーザ定義名称0x0a属性型0x0a¥0
属性名称
属性値を設定するユーザ属性の属性名称が設定されます。この情報をHwfSetCase,又はHwfGetCaseExistUserAttrValueのパラメタとして設定します。
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,又は属性型の区切りを示します。
ユーザ定義名称
案件のユーザ属性に設定する属性値の意味が設定されます。この情報をHwfSetCaseByUserDefNameのパラメタとして指定します。
属性型
案件のユーザ属性に設定する属性値の型を示します。
01:文字型
02:整数型
03:日時型
この情報をHwfSetCase,又はHwfSetCaseByUserDefNameのパラメタとして設定します。
作業情報終端文字(’¥0’)
作業情報の終端を示します。
設定例
WF_cs_attr_char_10x0a審査結果0x0a010x0a¥0
作業情報格納形式(任意データを参照(”10”))
作業情報は,ユーザが任意に定義した文字列データが,終端のNULL文字を含め,最大256バイトの文字列として設定されます。ユーザが自由に使ってください。
形式
ユーザ任意定義文字列¥0
ユーザ任意定義文字列
自由に参照できます。
作業情報終端文字(’¥0’)
作業情報の終端を示します。
作業情報格納形式(アプリケーションプログラムを起動(”11”))
作業情報を基に指定されたアプリケーションプログラムを起動してください。なお,作業情報内にすべての情報が格納できない場合,作業情報の先頭から255バイトで一度区切り,NULL文字で終端し,次のフォームリストの作業種別が「前の作業種別の継続(”99”)」である作業情報の先頭に,続きである256バイト目以降の情報が設定されます)。
形式
アプリケーションプログラム実行種別0x0a案件処理方法0x0aアプリケーションプログラムファイル名称,パラメタ0x0a取り込みファイル名称0x0a¥0
アプリケーションプログラム実行種別
アプリケーションプログラムを実行するタイミングを示します。
01:案件投入処理
02:案件処理
03:案件前処理
04:案件後処理
05:案件送付処理
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,属性型の区切りを示します。
案件処理方法:案件の処理方法を示します。
01:単一
02:一括
アプリケーションプログラムファイル名称,パラメタ
起動させるアプリケーションプログラムが格納されたファイル名称と,パラメタが設定されます。
取り込みファイル名称
サーバ側から取り込むファイル名称が設定されます。取り込むファイル名称が複数ある場合,それぞれのファイル名称は','で区切られています。
作業情報終端文字(’¥0’)
作業情報の終端(NULL文字)を示します。
設定例
010x0a010x0aUP.EXE0x0aFILE.TXT0x0a¥0
案件情報をGroupmax Document Managerへ格納(”12”)
作業情報を参照する必要はありません。
作業情報格納形式(案件の複写先を指定(”13”))
この作業情報を基に,次の手順で案件のユーザ属性に対して,複写先ノードを指定します。
  • 複写先ノード名称をすべて取り出します。又は,HwfTakeOperationInfによって作業情報内に設定されている複写先ノード名称を取り出します。
  • HwfCreateCopyInfのパラメタとして,必要な複写先ノード名称を指定し,複写先ノード情報を生成します。
  • HwfSetCase,又は,HwfSetCaseByUserDefNameで,案件のユーザ属性に対して,複写先ノード情報を文字列として指定します。
なお,作業情報内にすべての情報が格納できない場合,作業情報の先頭から255バイトで一度区切り,NULL文字で終端し,次のフォームリストの作業種別が「前の作業種別の継続(”99”)」である作業情報の先頭に,続きである256バイト目以降の情報が設定されます。
形式
属性名称0x0aユーザ定義名称0x0a属性型0x0a複写ノード名称0x0a候補値1,候補値2,..候補値n0x0a¥0
属性名称
属性値を設定するユーザ属性の属性名称が設定されます。
この情報をHwfSetCaseのパラメタとして設定します。
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,属性型の区切りを示します。
ユーザ定義名称
案件のユーザ属性に設定する属性値の意味が設定されます。
この情報をHwfSetCaseByUserDefNameのパラメタとして指定します。
属性型
案件のユーザ属性に設定する属性値の型が設定されます(文字型だけが設定されます)。
01:文字型
この情報をHwfSetCase,又はHwfSetCaseByUserDefNameのパラメタとして指定します。
複写ノード名称
複写ノードのノード名称が設定されます。
候補値
複写先ノード名称が設定されます。
この情報をHwfCreateCopyInfのパラメタとし,複写先ノード情報を取得して,その情報をHwfSetCase,又はHwfSetCaseByUserDefNameのパラメタとして指定します。
候補値セパレータ(’,’)
候補値1~nの区切りを示します。
作業情報終端文字(’¥0’)
作業情報の終端(NULL文字)を示します。
設定例
WF_cs_attr_char_10x0a営業複写先候補0x0a010x0a営業部複写0x0a営業1課,営業2課,営業3課0x0a¥0
作業情報格納形式(案件の作業者を指定(”14”))
次の手順で案件の作業者を指定します。
  • HwfSelectNextUserで案件の作業者を選択します。
  • HwfSuffixCaseで,選択した作業者を案件に設定します(HwfSelectNextUserで設定するモードを使用する場合はこの操作は必要ありません)。
  • 投入処理の場合は,HwfPutCaseで選択した作業者を案件に設定します。
形式
属性名称0x0aユーザ定義名称0x0a属性型0x0a複写ノード名称0x0a¥0
属性名称
属性値を設定するユーザ属性の属性名称が設定されます。
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,属性型の区切りを示します。
ユーザ定義名称
案件のユーザ属性に設定する属性値の意味が設定されます。
属性型
案件のユーザ属性に設定する属性値の型が設定されます(文字型だけが設定されます)。
01:文字型
ノード名称
作業者を指定するノードのノード名称が設定されます。
作業情報格納形式(配布キーを指定(”15”))
次に示す手順で自動配布時の配布キーを指定します。
  • 配布キーの候補値をHwfGetDeliverKeyで取得します(この作業種別ではユーザ処理リスト内に候補値は設定されていません。必ずHwfGetDeliverKeyを使用してください)。
  • HwfSetCase,又はHwfSetCaseByUserDefNameで案件のユーザ属性に対して配布キーを設定します。
形式
属性名称0x0aユーザ定義名称0x0a属性型0x0a複写ノード名称0x0a¥0
属性名称
属性値を設定するユーザ属性の属性名称が設定されます。
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,属性型の区切りを示します。
ユーザ定義名称
案件のユーザ属性に設定する属性値の意味が設定されます。
属性型
案件のユーザ属性に設定する属性値の型が設定されます。
01:文字型
02:整数型
03:日時型
ノード名称
配布キーを指定するノードのノード名称が設定されます。
作業情報格納形式(前の作業種別の継続(”99”))
前の作業種別の作業情報から継続している作業領域です。
(n) 投入案件情報リスト内項目(HwfSimplePutCase)
項目内容
casename作成する案件名を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
userattrlistnエンドユーザ属性リストの要素数を指定します。0以下の値を指定するとエンドユーザ属性リスト(userattrlist)に指定した値は無効になります。
userattrlistエンドユーザ属性リストを指定します。エンドユーザ属性リストの要素には,設定するユーザ属性を指定します。userattrlistn≦0なら,指定した値は無効となります。userattrlistn>0で,かつuserattrlistn>(userattrlistの要素数)の場合,この関数の動作は保証できません。
エンドユーザ属性リストの要素については,エンドユーザ属性リスト内項目を参照してください。
docfilelistn案件に格納する文書数を指定します。0以下の値を指定すると文書ファイル名称リスト(docfilelist)に指定した値は無効になります。
docfilelist案件に格納する文書に対応するファイルの完全パスとファイル名称を格納する領域を指定します。
docfilelistn≦0なら,指定した値は無効となります。docfilelistn>0で,かつdocfilelistn>(docfilelistの要素数)が一致しない場合,この関数の動作は保証できません。
文書のファイル名称については,文書,又はメモファイル名称リスト内項目を参照してください。
memofilelistn案件に格納するメモ数を指定します。0以下の値を指定するとメモファイル名称リスト(memofilelist)に指定した値は無効になります。
memofilelist案件に格納するメモに対応するファイルの完全パスとファイル名称を格納する領域を指定します。
memofilelistn≦0なら,指定した値は無効となります。memofilelistn>0でなく,かつmemofilelistn>(memofilelistの要素数)が一致しない場合,この関数の動作は保証できません。
メモのファイル名称については,文書,又はメモファイル名称リスト内項目を参照してください。
(o) 投入案件情報リスト内項目(HwfPutCase)
項目内容
casename作成する案件名を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
userattrlistnエンドユーザ属性リストの要素数を指定します。0以下の値を指定するとエンドユーザ属性リスト(userattrlist)に指定した値は無効になります。
userattrlistエンドユーザ属性リストを指定します。エンドユーザ属性リストの要素には,設定するユーザ属性を指定します。userattrlistn≦0なら,指定した値は無効となります。userattrlistn>0で,かつuserattrlistn>(userattrlistの要素数)の場合,この関数の動作は保証できません。
エンドユーザ属性リストの要素については,エンドユーザ属性リスト内項目を参照してください。
docfilelistn案件に格納する文書数を指定します。0以下の値を指定すると文書ファイル名称リスト(docfilelist)に指定した値は無効になります。
docfilelist案件に格納する文書に対応するファイルの完全パスとファイル名称を格納する領域を指定します。
docfilelistn≦0なら,指定した値は無効となります。
docfilelistn>0で,かつdocfilelistn>(docfilelistの要素数)の場合,この関数の動作は保証できません。
文書のファイル名称については,文書,又はメモファイル名称リスト内項目を参照してください。
datamemofilelistn案件に格納するメモ数を指定します。0以下の値を指定するとメモファイル名称リスト(datamemofilelist)に指定した値は無効になります。
datamemofilelist案件に格納するメモに対応するファイルの完全パスとファイル名称を格納する領域を指定します。
datamemofilelistn≦0なら,指定した値は無効となります。
datamemofilelistn>0で,かつdatamemofilelistn>(datamemofilelistの要素数)の場合,この関数の動作は保証できません。
メモのファイル名称については,文書,又はメモファイル名称リスト内項目を参照してください。
reserved予備領域です,NULL文字を指定してください。
(p) 投入案件情報リスト内項目(HwfPutCaseEx)
項目内容
casename作成する案件名を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
userattrlistnエンドユーザ属性リストの要素数を指定します。0以下の値を指定するとエンドユーザ属性リスト(userattrlist)に指定した値は無効になります。
userattrlistエンドユーザ属性リストを指定します。エンドユーザ属性リストの要素には,設定するユーザ属性を指定します。userattrlistn≦0なら,指定した値は無効となります。userattrlistn>0で,かつuserattrlistn>(userattrlistの要素数)の場合,この関数の動作は保証できません。
エンドユーザ属性リストの要素については,エンドユーザ属性リスト内項目を参照してください。
docfilelistn案件に格納する文書数を指定します。0以下の値を指定すると文書ファイル名称リスト(docfilelist)に指定した値は無効になります。
docfilelist案件に格納する文書に対応するファイルの完全パスとファイル名称を格納する領域を指定します。
docfilelistn≦0なら,指定した値は無効となります。
docfilelistn>0で,かつdocfilelistn>(docfilelistの要素数)の場合,この関数の動作は保証できません。
文書のファイル名称については,文書,又はメモファイル名称リスト内項目を参照してください。
datamemofilelistn案件に格納するメモ数を指定します。0以下の値を指定するとメモファイル名称リスト(datamemofilelist)に指定した値は無効になります。
datamemofilelist案件に格納するメモに対応するファイルの完全パスとファイル名称を格納する領域を指定します。
datamemofilelistn≦0なら,指定した値は無効となります。
datamemofilelistn>0で,かつdatamemofilelistn>(datamemofilelistの要素数)の場合,この関数の動作は保証できません。
メモのファイル名称については,文書,又はメモファイル名称リスト内項目を参照してください。
reserved予備領域です,NULL文字を指定してください。
(q) 投入案件結果情報項目(HwfPutCaseEx)
項目内容
bp_version_number投入したビジネスプロセス定義のバージョン番号が出力されます。
userkey投入した案件に設定したワークID(案件識別子フォーマット)が出力されます。
put_server_idNULL文字が出力されます。
reserved予備領域です。
(r) エンドユーザ属性リスト内項目(HwfSimplePutCase)
項目内容
BWF_user_defnameユーザ定義名称を指定します。終端にNULL文字を付けた64バイト以内の文字列を指定します。
BWF_user_attr_value設定する属性値を指定します。終端にNULL文字を付けた32バイト以内の文字列を指定します。
ユーザ属性には,文字,整数,及び日時の3種類があります。
それぞれ,以下の形式で設定してください。
  • 文字型ユーザ属性:
    終端にNULL文字を付けた32バイト以内の文字列を設定してください。
  • 整数型ユーザ属性:
    終端がNULL文字で,-2,147,483,647~2,147,483,647の範囲の最大11バイトまでの文字列に変換して設定してください。
  • 日時型ユーザ属性:
    終端がNULL文字で,YYYYMMDDhhmmss形式の14バイトの文字列に変換して設定してください。
(s) エンドユーザ属性リスト内項目
項目内容
BWF_user_defnameユーザ定義名称を指定します。
終端にNULL文字を付けた64バイト以内の文字列を指定します。
BWF_user_attr_value設定する属性値を指定します。
終端にNULL文字を付けた32バイト以内の文字列を指定します。
ユーザ属性には,文字,整数,及び日時の3種類があります。
それぞれ,以下の形式で設定してください。
  • 文字型ユーザ属性:
    終端にNULL文字を付けた32バイト以内の文字列を設定してください。
  • 整数型ユーザ属性:
    終端がNULL文字で,-2,147,483,647~2,147,483,647の範囲の最大11バイトまでの文字列に変換して設定してください。
  • 日時型ユーザ属性:
    終端がNULL文字で,YYYYMMDDhhmmss形式の14バイトの文字列に変換して設定してください。
(t) エンドユーザ属性リスト内項目(HwfPutCaseEx)
項目内容
BWF_user_defnameユーザ定義名称を指定します。
終端にNULL文字を付けた64バイト以内の文字列を指定します。
BWF_user_attr_value設定する属性値を指定します。
終端にNULL文字を付けた32バイト以内の文字列を指定します。
ユーザ属性には,文字,整数,及び日時の3種類があります。
それぞれ,以下の形式で設定してください。
  • 文字型ユーザ属性:
    終端にNULL文字を付けた32バイト以内の文字列を設定してください。
  • 整数型ユーザ属性:
    終端がNULL文字で,-2,147,483,647~2,147,483,647の範囲の最大11バイトまでの文字列に変換して設定してください。
  • 日時型ユーザ属性:
    終端がNULL文字で,YYYYMMDDhhmmss形式の14バイトの文字列に変換して設定してください。
(u) 文書,又はメモファイル名称リスト内項目(HwfSimplePutCase)
項目内容
sBDoclist文書,又はメモに対応するファイルの完全パスとファイル名称を格納します。終端にNULL文字を付けた512バイト以内の文字列を指定します。
(例) ”C:¥FLOWMATE¥DOC¥DOC.TXT”
sBDoctypeメモを添付する場合の種別を指定します。
”file”:
ファイルとして添付します。
NULL(0x00000000​):
データオブジェクトとして添付します。
データオブジェクトはデータベースで管理されるため,回復対象となりますが,ジャーナルが増えるので注意が必要です。
データオブジェクトのデータ形式を次に示します。
  • 終端にNULL文字を付けた32キロバイト以下の文字列形式で指定してください。
  • 案件中に一つ以下でなければなりません。
  • 同報中にサイズを変更しないでください。
文書を添付する場合は,この種別は使用しません。すべてファイルとして添付します。
注意事項

(v) 文書,又はメモファイル名称リスト内項目(HwfPutCase)
項目内容
type文書,メモ更新種別を指定します。この関数では指定する必要はありません。
memotypeメモの種別を指定します。
F:メモとしてファイルを添付します。
D:データオブジェクトとして添付します。
データオブジェクトはデータベースで管理されるため,回復対象となりますが,ジャーナルが増えるので注意が必要です。データオブジェクトのデータ形式は次のようにしてください。
  • 終端にNULL文字を付けた32キロバイトまでの文字列形式で指定してください。
  • 案件中に一つ以下でなければなりません。
S:Groupmax Integrated Desktopの本文に表示されるメモとして添付します。この種別のメモは案件内で一つでなければなりません。
reserved1予備領域です。NULL文字を指定してください。
file_id文書,メモの識別子を指定します。この関数では指定する必要はありません。
outfilename文書,又はメモに対応するファイルの完全パスとファイル名称を格納します。終端にNULL文字を付けた512バイト以内の文字列を指定します。
(例)”C:¥FLOWMATE¥DOC¥DOC.TXT”
oldnameoutfilenameのうち,ファイル名称だけを指定します。この関数では指定する必要はありません。
reserved予備領域です。NULL文字を指定してください。
注1
データオブジェクトは,同報中にサイズを変更しないでください。
注2
ロングファイル名称で登録した文書やメモを参照するときに,Groupmax Desktop(16bit版),Groupmax Workflow - Library バージョン1から02-00まで,又はGroupmax Workflow - Library 02-10以降でバージョン1との互換用関数を使用すると,そのファイル名称は次のように変換されます。
・ファイル名は,先頭から8バイトが抽出されます。
・拡張子は,先頭から3バイトが抽出されます。
・半角の[,],;,+,=,及び,は,~に変換されます。
また,Groupmax Workflow Serverのバージョン02-10で,ロングファイル名称で登録した文書,メモは,それぞれ"wfdoc.dat","wfmemo.dat"という名称に変換されます。
注3
06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
詳しくはファイル名の注意事項を参照してください。

(w) 文書,又はメモファイル名称リスト内項目(HwfPutCaseEx)
項目内容
type文書,メモ更新種別を指定します。この関数では指定する必要はありません。
memotypeメモの種別を指定します。
F:メモとしてファイルを添付します。
D:データオブジェクトとして添付します。
データオブジェクトはデータベースで管理されるため,回復対象となりますが,ジャーナルが増えるので注意が必要です。データオブジェクトのデータ形式は次のようにしてください。
  • 終端にNULL文字を付けた32キロバイトまでの文字列形式で指定してください。
  • 案件中に一つ以下でなければなりません。
S:Groupmax Integrated Desktopの本文に表示されるメモとして添付します。この種別のメモは案件内で一つでなければなりません。
reserved1予備領域です。NULL文字を指定してください。
file_id文書,メモの識別子を指定します。この関数では指定する必要はありません。
outfilename文書,又はメモに対応するファイルの完全パスとファイル名称を格納します。終端にNULL文字を付けた512バイト以内の文字列を指定します。
(例)”C:¥FLOWMATE¥DOC¥DOC.TXT”
oldnameoutfilenameのうち,ファイル名称だけを指定します。この関数では指定する必要はありません。
reserved予備領域です。NULL文字を指定してください。
注1
データオブジェクトは,同報中にサイズを変更しないでください。
注2
Groupmax Workflow - Library バージョン1から02-00まで,又はGroupmax Workflow - Library 02-10以降でバージョン1との互換用関数を使用すると,そのファイル名称は次のように変換されます。
・ファイル名は,先頭から8バイトが抽出されます。
・拡張子は,先頭から3バイトが抽出されます。
・半角の[,],;,+,=,及び,は,~に変換されます。
また,Groupmax Workflow Serverのバージョン02-10で,ロングファイル名称で登録した文書,メモは,それぞれ"wfdoc.dat","wfmemo.dat"という名称に変換されます。
注3
06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
詳しくはファイル名の注意事項を参照してください。

(x) 引き戻し案件情報項目(HwfTakeBackCaseDirect)
項目内容
mode引き戻す作業の種別を指定します。
"put△":案件投入作業の引き戻し
"go△△":案件遷移作業の引き戻し
注 △は半角スペース
caseoid引き戻す案件のオブジェクトIDを指定してください。
  • 拡張ビジネスプロセス定義の案件の場合は,ビジネスプロセス定義の登録サーバ上での案件オブジェクトIDを指定してください。
    ビジネスプロセス定義の登録サーバ上での案件オブジェクトIDは,案件処理時にHwfGetCaseSelectData()で取得してください。
  • ビジネスプロセス定義の案件の場合は,接続先サーバ上での案件オブジェクトIDを指定してください。
    modeで"put△"を指定した場合は,8バイトのNULL文字を指定してください。
serveridこのパラメタは予備領域です。8バイトのNULL文字を指定してください。
nodename引き戻し先のノード名称(作業名)を指定してください。
bpname引き戻しを行う案件のビジネスプロセス定義名称を指定してください。
bpver引き戻しを行う案件のビジネスプロセス定義のバージョン番号を指定してください。
bptype引き戻しを行う案件のビジネスプロセス定義の種別を指定してください。
"ind△":拡張ビジネスプロセス定義
"":ビジネスプロセス定義(4バイトのNULL文字を指定)
注 △は半角スペース
workid引き戻しを行う案件のワークIDを指定してください。
reserve予備領域です。NULL文字を指定してください。

(8) ユーザトレー内案件操作AP関数

(a) HwfGetCaseSelectData(案件情報の取得)
機能
ユーザトレー,ロールトレー,ワーク,ビジネスプロセス定義にある案件の案件情報(案件項目リスト)を取得します。
その場合,次に示す方法で取得できます。
  • 案件情報内の任意の項目だけを取得できます。
  • 任意で指定した上位案件情報の項目が持つ属性値の指定範囲を指定することによって,対応する属性値を持つ案件の案件情報を絞り込んで取得できます(絞り込み条件については,任意に指定した案件情報の項目であれば,複数指定できます)。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetCaseSelectData(
 BWF_useroid_t  __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,    /* サーバ名称格納領域  (I) */
 unsigned long        reqmode,    /* 要求種別 (I) */
 unsigned long        topnum,    /* 上位案件数 (I) */
 unsigned long        bottomnum,   /* 下位案件数 (I) */
                    /* 上位案件用パラメタ */
 unsigned long  __far *selectparam, /*取得要求パラメタ (I) */
 unsigned long        selectparamn, /*取得要求パラメタ数 (I) */
 unsigned long        getmode,    /* 取得対象 (I) */
 BWF_oid_t      __far *getmodeid,  /* 取得対象オブジェクトID (I) */
 BWF_select_t   __far *selectmode,  /* 選択条件 (I) */
 unsigned long        selectmoden,  /* 選択条件数 (I) */
 unsigned long        sortkey,    /* ソートキー (I) */
 unsigned long        sortmode,   /* ソートモード (I) */
 unsigned long        number,    /* 案件項目リスト取得先頭要素番号 (I) */
 unsigned long        tcaselistn,  /* 案件項目リスト取得要素数 (I) */
 unsigned long  __far *total,    /* 案件項目リスト全要素数 (O) */
 unsigned long  __far *tcount,    /* 取得上位案件項目リスト要素数 (O) */
                   /* 上位案件,下位案件両用パラメタ */
 void          __huge *tcaselist,  /* 上位案件項目リスト格納領域 (I/O) */
                   /* 下位案件用パラメタ */
 unsigned long  __far *bcount,    /* 取得下位案件項目リスト要素数 (O) */
 void          __huge *bcaselist,  /* 下位案件項目リスト取得領域   (O) */
                   /* 上位案件,下位案件両用パラメタ */
 BWF_errlist_t  __far *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_select_t{
 unsigned long BWF_attr_name;      /* 属性名称 */
 unsigned long BWF_attr_operator;    /* 比較演算子   */
 BWF_oid_t     BWF_attr_value_oid;    /* 属性の条件値 */
 char          BWF_attr_value_char[64]; /* 属性の条件値 */
 long          BWF_attr_value_long;   /* 属性の条件値 */
 unsigned long BWF_attr_value_ulong;   /* 属性の条件値 */
 BWF_time_t    BWF_attr_value_time;   /* 属性の条件値 */
} BWF_select_t;
typedef struct    BWF_caselistall_t{
 BWF_caseid_t  BWF_cs_oid;         /* 案件オブジェクトID */
 char          BWF_cs_case_name[64];    /* 案件名称 */
 char          BWF_cs_case_alias_name[64]; /* 作業案件名 */
 char          BWF_cs_transaction_id[8];  /* トランザクションID */
 BWF_userkey_t BWF_cs_user_key;       /* ワークID(案件識別子フォーマット) */
 char          BWF_cs_create_name[8];    /* 作成者 */
 BWF_useroid_t BWF_cs_create_user_oid;   /* 作成者ユーザオブジェクトID */
 BWF_time_t    BWF_cs_create_time;     /* 作成日時 */
 BWF_time_t    BWF_cs_arrival_time;     /* 到着日時 */
 BWF_time_t    BWF_cs_process_limit_time;  /* 処理期限 */
 char          BWF_cs_bp_name[64];     /* ビジネスプロセス定義名称 */
 BWF_bpid_t    BWF_cs_bp_oid;        /* ビジネスプロセス定義オブジェクトID */
 unsigned long BWF_cs_bp_version_number;  /* ビジネスプロセス定義バージョン番号 */
 unsigned long BWF_cs_memo_object_count;  /* メモオブジェクト数 */
 unsigned long BWF_cs_report_object_count; /* 文書オブジェクト数 */
 char          BWF_cs_tray_kind_code[4];  /* トレー種別 */
 BWF_useroid_t BWF_cs_user_oid;       /* ユーザオブジェクトID */
 BWF_roleid_t  BWF_cs_role_oid;       /* ロールオブジェクトID */
 BWF_workid_t  BWF_cs_work_oid;       /* ワークオブジェクトID */
 char          BWF_cs_case_class_kind_code[4];  /* 階層種別 */
 BWF_caseid_t  BWF_cs_up_case_oid;     /* 上位案件オブジェクトID */
 unsigned long BWF_cs_down_case_count;   /* 下位案件数 */
 char          BWF_cs_status_code_1[4];   /* 状態コード1 */
 char          BWF_cs_status_code_2[4];   /* 状態コード2 */
 BWF_nodeno_t  BWF_cs_current_node_id;   /* カレントノードID*/
 char          BWF_cs_priority_code[4];   /* 優先度 */
 char          BWF_cs_process_kind_code[4]; /* 案件処理種別 */
 char          BWF_cs_attr_char_1[32];   /* ユーザ属性1 */
 char          BWF_cs_attr_char_2[32];   /* ユーザ属性2 */
 char          BWF_cs_attr_char_3[32];   /* ユーザ属性3 */
 char          BWF_cs_attr_char_4[32];   /* ユーザ属性4 */
 char          BWF_cs_attr_char_5[32];   /* ユーザ属性5 */
 long          BWF_cs_attr_int_1;      /* ユーザ属性6 */
 long          BWF_cs_attr_int_2;      /* ユーザ属性7 */
 long          BWF_cs_attr_int_3;      /* ユーザ属性8 */
 long          BWF_cs_attr_int_4;      /* ユーザ属性9 */
 long          BWF_cs_attr_int_5;      /* ユーザ属性10 */
 BWF_time_t    BWF_cs_attr_time_1;     /* ユーザ属性11 */
 BWF_time_t    BWF_cs_attr_time_2;     /* ユーザ属性12 */
 BWF_time_t    BWF_cs_attr_time_3;     /* ユーザ属性13 */
 BWF_time_t    BWF_cs_attr_time_4;     /* ユーザ属性14 */
 BWF_time_t    BWF_cs_attr_time_5;     /* ユーザ属性15 */
 unsigned long BWF_cs_exattr_char_count;  /* 文字型拡張ユーザ属性数 */
 unsigned long BWF_cs_exattr_int_count;   /* 整数型拡張ユーザ属性数 */
 unsigned long BWF_cs_exattr_time_count;  /* 日付型拡張ユーザ属性数 */
 char          BWF_cs_user_status[16];   /* 任意ユーザ状態コード */
 char          BWF_cs_broadcast_status[4]; /* 同報状態コード */
 BWF_useroid_t BWF_cs_except_req_user_oid; /* 例外要求元ユーザオブジェクトID */
 char          BWF_cs_title[64];      /* 案件タイトル */
 BWF_useroid_t BWF_cs_client_oid;      /* 代行元ユーザオブジェクトID */
 BWF_time_t    BWF_cs_tray_arrival_time;  /* トレー到着日時 */
} BWF_caselistall_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
reqmode
情報を取得する案件のレベルを指定します。
BWF_ALL_CASE:上位案件,単独案件,及び下位案件に関する情報を取得します。
BWF_TOP_CASE:上位案件,及び単独案件に関する情報を取得します。
BWF_BOTTOM_CASE:上位案件の案件項目リストを基に,下位案件に関する情報を取得します。そのため,このレベルを指定する場合は,BWF_ALL_CASE,又はBWF_TOP_CASEを指定して上位案件の案件項目リストを取得しておく必要があります。
 
reqmodeの指定によって,次に示すように,以降のパラメタに情報を設定する必要があります。
パラメタBWF_ALL_CASEBWF_TOP_CASEBWF_BOTTOM_CASE
topnum
bottomnum
selectparam
selectparamn
getmode
selectmode
selectmoden
sortkey
sortmode
number
tcaselistn
total
tcount
tcaselist○(O)○(O)○(I)
bcount
bcaselist
errlist
(凡例)
○:指定が必要です。
-:該当するパラメタを無視します。
○(O):出力情報取得領域の指定が必要です。
○(I):入力項目の指定が必要です。

topnum
reqmodeが,BWF_BOTTOM_CASEの場合,上位案件項目リスト(tcaselistに指定)の要素数を指定します。
bottomnum
下位案件項目リスト(bcaselistに指定)の要素数を指定します。
アプリケーションプログラムが,アクセス可能なメモリの大きさによって,指定可能な最大数は異なります。
また,reqmodeの指定によって,次に示すように指定するようにしてください。
reqmodeがBWF_ALL_CASEの場合,一つの上位案件に属する下位案件数を指定します。取得対象の下位案件数が,tcaselistn×bottomnumを超えた場合は,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
reqmodeがBWF_BOTTOM_CASEの場合,上位案件項目リスト(tcaselistに指定)中の全ルート案件に属する下位案件の総数を指定します。取得対象の案件がbottomnumを超えた場合は,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
selectparam
取得する案件情報の案件情報項目識別子を指定します。案件情報の案件情報項目識別子を指定した情報だけ取得できます。案件情報項目識別子は,配列で複数指定でき,ここに指定した順番に連続して,上位,及び単独案件はtcaselistに,下位案件はbcaselistに取得します。
取得できる案件情報については,取得案件情報項目を参照してください。
なお,BWF_ALL_PARAMETERを指定すると,取得案件情報項目の項番1~51までの案件情報を取得できます。
BWF_ALL_PARAMETERを指定する場合は,ほかの案件情報項目識別子と合わせて指定しないようにしてください。
 
引数reqmodeに,BWF_BOTTOM_CASEを指定する場合
引数tcaselistに指定する上位案件項目リストを取得したときに引数selectparamに指定した案件情報項目識別子と同じ値を指定してください。このとき,BWF_CASE_OID(案件オブジェクトID)を必ず指定してください。また,BWF_CASE_OIDを複数指定しないでください。
selectparamn
selectparamの案件情報項目識別子の数を指定します。
getmode
案件情報の取得対象を指定します。
BWF_USER_ONLY_MODEV2:ユーザが処理する案件を対象とします。getmodeidに対象となるユーザオブジェクトID(HwfGetUserAndなどで取得)を指定してください。
BWF_USER_MODEV2:ユーザと,そのユーザが関連するロールの案件を対象とします。getmodeidに対象となるユーザオブジェクトID(HwfGetUserAndなどで取得)を指定してください。
対象ユーザが登録されているロールの数が多くなると,性能が劣化しますので,御注意ください。
BWF_ROLE_MODEV2:ロールの案件を対象とします。getmodeidに対象となるロールオブジェクトID(HwfGetRoleAndなどで取得)を指定してください。
BWF_BP_MODE:ビジネスプロセス定義の案件を対象とします。getmodeidに対象となるビジネスプロセス定義ID(HwfGetBusinessProcessなどで取得)を指定してください。
指定したビジネスプロセス定義の案件が増加すると,性能が劣化しますので,御注意ください。
マルチサーバ構成の場合,ログインユーザのホームサーバに存在する案件以外は取得できません。
他人のトレー内の案件も対象となるため,実際に案件が配布されているユーザが案件処理を行う時にロックエラーが発生し,一時的に当該案件の処理ができなくなる事がありますのでご注意ください。
BWF_WORK_MODE:ワークの案件を対象とします。getmodeidに対象となるワークオブジェクトID(HwfGetWorkAttributeなどで取得)を指定してください。
他人のトレー内の案件も対象となるため,実際に案件が配布されているユーザが案件処理を行う時にロックエラーが発生し,一時的に当該案件の処理ができなくなる事がありますのでご注意ください。
 
以下は互換のために残されているモードです。なお,他ユーザのトレー中の案件を参照する場合は,必ず上記のBWF_USER_ONLY_MODEV2,BWF_USER_MODEV2を使用してください。
BWF_USER_ONLY_MODE:ユーザが処理する案件を対象とします。getmodeidに対象となるユーザオブジェクトID(HwfGetUserAndなどで取得)を指定してください。
BWF_USER_MODE:ユーザと,そのユーザが関連するロールの案件を対象とします。getmodeidに対象となるユーザオブジェクトID(HwfGetUserAndなどで取得)を指定してください。
BWF_ROLE_MODE:ロールの案件を対象とします。getmodeidに対象となるロールオブジェクトID(HwfGetRoleAndなどで取得)を指定してください。
getmodeid
getmodeで指定した,取得対象となるオブジェクトIDを指定します。
selectmode
getmodeで指定した,取得対象の上位,及び単独案件情報を絞り込む場合のモードを指定します。
比較対象となる属性値は,BWF_attr_nameに指定した案件情報項目識別子に対応する属性型を設定します(BWF_attr_value_oid,BWF_attr_value_char,BWF_attr_value_time,BWF_attr_value_long,BWF_attr_value_ulongのうち,属性型に対応する項目にだけ値を設定してください)。
絞り込みを行わない場合は,NULLポインタを指定します。
比較対象となる属性値については,選択条件内項目を参照してください。
selectmoden
getmodeで指定した取得対象を,絞り込む場合のモードの数を指定します。
sortkey
上位,及び単独案件リストをソートする場合に,案件情報項目識別子を指定します。
sortmode
上位,及び単独案件リストをソートする場合のソート順を指定します。BWF_NOSORT_MODEを指定した場合は,sortkeyの内容は無視します。
BWF_ASCEND_MODE:昇順にソートします。
BWF_DESCEND_MODE:降順にソートします。
BWF_NOSORT_MODE:ソートしません。
number
上位,及び単独案件リストを取得する要素の先頭番号を指定します。先頭番号は,0~(total-1)の範囲内で設定してください。
tcaselistn
上位,及び単独案件リストを取得する要素数を指定してください。必ず1以上の値を指定してください(reqmodeがBWF_BOTTOM_CASEの場合,指定不要です)。
total
案件項目リストの取得できる全要素数(このシステムに登録された案件でreqmode,selectmodeで指定した条件に対応する上位案件と単独案件の総数)を取得する領域を指定します。
tcount
このAPI関数が取得した,案件項目リストの要素数(上位案件と単独案件の和)を取得する領域を指定してください。
tcaselist
reqmodeがBWF_ALL_CASE,又はBWF_TOP_CASEの場合
上位,及び単独案件の案件項目リストを取得する領域を指定してください。なお,この領域のサイズはtcaselistnで指定した要素数分のサイズを,必ず確保して指定してください。tcaselist内に取得される項目は,selectparamに指定した案件情報項目識別子の順に,各項目のサイズで連続して取得されます。
案件項目リストのデータ型は,selectparamの順に従って,各アプリケーションで定義してください。ただし,selectparamにBWF_ALL_PARAMETERを指定した場合だけ,データ型にBWF_caselistall_tを使用できます。
selectparamの指定によって上位案件項目リスト内に取得される各項目については,上位案件項目リスト内項目を参照してください。
 
reqmodeがBWF_BOTTOM_CASEの場合
前回,引数reqmodeにBWF_ALL_CASE,又はBWF_TOP_CASEを指定して取得した上位案件項目リストの領域を指定してください。
bcount
このAPI関数が取得した,下位案件の案件項目リストの要素数を取得する領域を指定してください。
bcaselist
下位案件の案件項目リストを取得する領域を指定してください。なお,領域のサイズはreqmodeの指定によって,次に示すとおり必ず確保してください。
  • reqmodeがBWF_ALL_CASEの場合
    (tcaselistn×bottomnum)要素数分のサイズの領域を確保してください。
  • reqmodeがBWF_BOTTOM_CASEの場合
    bottomnum要素数分のサイズ領域を確保してください。
bcaselist内に取得される項目は,selectparamに指定した案件情報項目識別子の順に各項目のサイズで連続して取得されます。
案件項目リストのデータ型は,selectparamの順に従って,各アプリケーションで定義してください。ただし,selectparamにBWF_ALL_PARAMETERを指定した場合だけ,データ型にBWF_caselistall_tを使用できます。
なお,取得される各項目については,tcaselistの項目と同一のため,tcaselistを参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このシステムに登録された案件でreqmode,selectmodeで指定した条件に対応するものがない場合は,totalは0で,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • numberパラメタで指定した値がtotalパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となり,totalにこのシステムに登録された案件でreqmode,selectmodeで指定した条件に対応する案件数が設定されます。
  • 他ユーザのユーザトレー,又はロールトレー内の案件情報を取得する場合は,reqmodeにBWF_TOP_CASEを必ず指定してください。
  • sortkeyには,selectparamで指定した案件情報項目識別子を指定してください。selectparamで指定した以外の案件情報項目識別子をsortkeyに指定した場合,ソートの結果を確認する方法はありません。
  • selectmodeで,BWF_attr_nameに指定した案件情報項目識別子の属性型に対応する項目以外に比較対象となる属性値を設定した場合,その結果は保証できません。
  • getmodeに,BWF_GMW_USER,BWF_GMW_USER_BP,BWF_GMW_USER_BP_ROLEのどれかを指定し,selectmodeに次に示す指定をした場合,このAPI関数の戻り値がエラーリターン(BWF_ERROR)となる場合があります。
    ・BWF_attr_nameにBWF_user_oidを指定
    ・BWF_attr_operatorにBWF_NE_ATTR_OPERATORを指定
    ・BWF_attr_value_oidにuseroidを指定
  • ロールトレーを参照する場合,関数発行者に作業権限がない案件は取得できません。
  • 拡張ビジネスプロセス定義の案件を対象とする場合,取得対象となるのは,ログインサーバにある案件です。
  • 取得情報のプロパティはHwfSubstitutionGetCaseを発行した場合に変更されます。この場合,再度HwfGetCaseSelectDataを発行してください。
  • 取得する案件情報が多く,この関数を複数回に分けて発行する必要がある場合,この関数のソートを使用すると,応答時間が大幅に劣化することがあります。この場合,アプリケーション側でソート処理をしてください。
  • この関数で取得できるユーザ属性は,BWF_ATTR_CHAR_1~5,BWF_ATTR_INT_1~5,及びBWF_ATTR_TIME_1~5です。これ以外の属性の情報を取得する場合は,HwfGetAttributeValueByAttributeName()やHwfGetAttributeValueByUserDefName()を使用してください。ユーザ属性は,Groupmax Workflow Definerで登録した順序で取得されます。
(b) HwfGetOperation(カレントノードでの案件のユーザ処理リスト取得)
機能
ユーザトレー内の案件がカレントノードで,案件のユーザ属性に登録する作業結果の基となる作業情報(ユーザ処理リスト)を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使えます。
構文

#include<bwf.h>
long HwfGetOperation(
 BWF_useroid_t __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,   /* サーバ名称格納領域 (I) */
 BWF_caseid_t  __far *caseid,   /* 案件オブジェクトID格納領域 (I) */
 long                number,   /* ユーザ処理リスト取得先頭要素番号 (I) */
 long                oplistn,   /* ユーザ処理リスト取得要素数 (I) */
 long __far          *total,   /* ユーザ処理リスト全要素数 (O) */
 long __far          *count,   /* 取得ユーザ処理リスト要素数 (O) */
 BWF_oplist_t  __far *oplist,   /* ユーザ処理リスト取得領域 (O) */
 BWF_errlist_t __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_oplist_t{
 char           BWF_ol_kind_code[2];       /* 種別コード */
 char           BWF_ol_create_condition[2];   /* 設定条件 */
 BWF_casename_t BWF_ol_case_name;        /* 案件名称 */
 char           BWF_ol_get_operation_list[256]; /* 作業情報 */
} BWF_oplist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
ユーザ処理リスト取得対象となる,案件オブジェクトID(HwfGetCaseSelectDataなどで取得)を指定します。
下位案件がある場合,上位案件を指定すると,案件全体に対するユーザ処理リストを取得できます。
下位案件を指定すると,指定した下位案件に対するユーザ処理リストだけを取得します。
number
ユーザ処理リストを取得する要素の先頭番号を設定します。先頭番号は0~(total-1)の範囲内で指定してください。
oplistn
ユーザ処理リストを取得する要素数を指定します。1~202までの範囲内で指定してください。
total
指定したcaseidから,取得できるユーザ処理リスト総数を取得する領域を指定します。
count
取得したユーザ処理リスト数を取得する領域を指定します。
oplist
ユーザ処理リストを取得する領域を指定します。oplistnで指定した要素数分の領域を必ず指定してください。ユーザ処理リスト内の取得される項目については,ユーザ処理リスト内項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(c) HwfSimplePreCase(案件情報,案件内の文書,及びメモの取得(機能限定版))
機能
案件オブジェクトIDで指定された案件の情報を取得します。また,案件内の文書とメモをこのシステムが指定したファイルに読み出します。
この関数は,HwfPrefixCase関数に比べて次に示す制限があります。
  • 案件開始処理モード,添付ファイル取得モード及び案件例外処理コメント表示モードの各モードを指定できません。
  • 文書及びメモの添付ファイルはロングファイル名称に対応していません。8.3形式のファイル名だけを利用できます。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include <bwf.h>
long HwfSimplePreCase(
 BWF_useroid_t  __far *useroid,      /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,      /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far *caseoid,      /* 案件オブジェクトID (I) */
 HWND           pwnd_handle,       /* 親ウィンドウのハンドル (I) */
 long           downcaselistn,      /* 案件情報リスト領域数 (I) */
 long           __far *case_total,    /* 存在下位案件総数 (O) */
 char           __far *nodename,     /* ノード名称 (O) */
 BWF_userkey_t  __far *userkey,      /* ワークID(案件識別子フォーマット) (O) */
 char           __far *bpname,      /* ビジネスプロセス定義名称 (O) */
 char           __far *priority_code,   /* 案件の優先度 (O) */
 char           __far *prcssknd_code,   /* 案件の処理状態 (O) */
 char           __far *title,       /* 案件タイトル (O) */
 BWF_workid_t   __far *workoid,      /* ワークオブジェクトID (O) */
 BWF_downcaseinf_t  __far *downcaselist, /* 案件情報リスト (I/O) */
 BWF_errlist_t  __far *errlist      /* エラー情報取得領域 (O) */
};
typedef struct BWF_downcaseinf_t {     /* 案件情報 */
 BWF_casename_t casename;         /* 案件名 (O) */
 BWF_caseid_t   caseoid;         /* 案件オブジェクトID (O) */
 long           casetype;         /* 案件種別 0:単独案件,1:下位案件 (O) */
 long           number_oplist;      /* 取得ユーザ処理リスト番号 (I) */
 long           oplistn;         /* ユーザ処理リスト領域数 (I) */
 long           docfilelistn;       /* 格納文書ファイル情報領域数 (I) */
 long           memofilelistn;      /* 格納メモファイル情報領域数 (I) */
 long           oplist_total;       /* ユーザ処理リスト総数  (O) */
 long           get_oplistn;       /* 取得ユーザ処理リスト数 (O) */
 BWF_oplist_t  __far *get_oplist;     /* 取得ユーザ処理リスト (O) */
 long           docfile_total;      /* 格納文書総数 (O) */
 long           get_docfilelistn;     /* 取得格納文書ファイル数 (O) */
 BWF_outfilelist_t *get_docfilelist;   /* 格納文書ファイル情報格納領 (O) */
 long           memofile_total;      /* 格納メモ総数 (O) */
 long           get_memofilelistn;    /* 取得格納メモファイル数 (O) */
 BWF_outfilelist_t *get_memofilelist;   /* 格納メモファイル情報格納領域 (O) */
}BWF_downcaseinf_t;
typedef struct BWF_outfilelist_t {   /* 文書/メモファイル情報 */
 char         outfilename[512];    /* フルパスファイル名称 (O) */
 char         oldname[16];       /* ファイル登録名称 (O) */
 char         filetype[4];       /* ファイル種別 (O) */
}BWF_outfilelist_t;
typedef struct      BWF_oplist_t{
 char BWF_ol_kind_code[2];       /* 種別コード (O) */
 char BWF_ol_create_condition[2];   /* 設定条件 (O) */
 BWF_casename_t BWF_ol_case_name;   /* 案件名 (O) */
 char BWF_ol_get_operation_list[256]; /* 作業情報 (O) */
} BWF_oplist_t;
typedef struct  BWF_errlist_t {  /*エラー情報取得領域 */
 char          sBMsgKbn[6];    /* メッセージ区分 (O) */
 long          lBMsgNo;      /* メッセージ番号 (O) */
 char          sBInsWord[13];   /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseoid
この関数で処理する案件の案件オブジェクトIDを格納した領域を指定します。案件に複数の下位案件がある場合は,上位案件オブジェクトIDを指定してください。Groupmax Integrated Desktop連携のアプリケーションの場合,NULLを指定するとGroupmax Integrated Desktopから引き継いだ案件オブジェクトIDを仮定します。
pwnd_handle
親ウィンドウのハンドルを指定します。
downcaselistn
案件情報リストの要素数を指定します。1以上の数値を指定します。単独案件の案件情報を取得するときは1を指定します。
case_total
caseoidで入力した案件にある下位案件数を出力します。単体案件の場合は0が格納されます。
nodename
caseoidで入力した案件があるノード名称を出力します。終端にNULL文字を付けた64バイト以内の文字列を出力します。
userkey
caseoidで入力した案件のワークID(案件識別子フォーマット)を出力します。
bpname
caseoidで入力した案件があるビジネスプロセス定義の名称を出力します。終端にNULL文字を付けた64バイト以内の文字列を出力します。
priority_code
caseoidで入力した案件の優先度を出力します。終端にNULL文字を付けた5バイトの文字列を出力します。
com△:普通を示します。
urg△:至急を示します。
注 △はスペースを示します。
prcssknd_code
案件の処理状態を出力します。終端にNULL文字を付けた5バイトの文字列を出力します。
ord△:通常処理
exc△:例外処理(相談)
exca:例外処理(相談途中での回答)
exa△:例外処理(回答)
exsb:例外処理(差し戻し)
extb:例外処理(引き戻し)
注 △はスペースを示します。
title
案件タイトルを出力します。終端にNULL文字を付けた64バイト以内の文字列を出力します。
workoid
ワークオブジェクトIDを出力します。
downcaselist
案件情報リストを格納した領域を入力/出力します。caseoidで入力した案件の案件情報を格納する領域です。下位案件がない案件(単独案件)の場合も1要素分の領域を確保してください。
案件情報リストについては,案件情報リスト要素の項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • HwfSimplePreCaseで案件処理を開始した場合は,HwfSimpleGoCaseで終了してください。HwfSimpleGoCaseを発行する前に再びHwfSimplePreCaseを発行した場合は,関数発行シーケンスエラーになります。
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
(d) HwfPrefixCase(案件情報,案件内の文書,及びメモの取得)
機能
案件オブジェクトIDで指定された案件の情報を取得します。また,案件内の文書とメモをこのシステムが指定したファイルに読み出します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include <bwf.h>
long HwfPrefixCase(
 BWF_caseid_t   __far *caseoid,        /* 案件オブジェクトID (I) */
 HWND                 pwnd_handle,       /* 親ウィンドウのハンドル (I) */
 long                 act_mode,        /* 案件処理開始モード (I) */
 long                 file_get_mode,      /* 添付ファイル取得モード (I) */
 long                 oplist_file_get_mode,  /* ユーザ処理用ファイル取得モード (I) */
 long                 comment_display_mode,  /* 案件コメント表示モード (I) */
 long                 downcaselistn,      /* 案件情報リスト領域数 (I) */
 long           __far *case_total,       /* 存在案件総数 (O) */
 char           __far *nodename,        /* ノード名称 (O) */
 BWF_userkey_t  __far *userkey,        /* ワークID(案件識別子フォーマット) (O) */
 char           __far *bpname,         /* ビジネスプロセス定義名称 (O) */
 char           __far *priority_code,     /* 案件の優先度 (O) */
 char           __far *prcssknd_code,     /* 案件の処理状態 (O) */
 char           __far *title,         /* 案件タイトル (O) */
 BWF_workid_t   __far *workoid,        /* ワークオブジェクトID (O) */
 BWF_downcaseinfex_t  __far *downcaselistex,  /* 案件情報リスト (I/O) */
 BWF_errlist_t  __far *errlist         /* エラー情報取得領域 (O) */
};
typedef struct BWF_downcaseinfex_t {  /* 案件情報 */
 BWF_casename_t casename;       /* 案件名 (O) */
 BWF_caseid_t   caseoid;        /* 案件オブジェクトID (O) */
 long           casetype;       /* 案件種別 0:単独案件 1:下位案件 (O) */
 long           number_oplist;     /* 取得ユーザ処理リスト番号 (I) */
 long           oplistn;        /* ユーザ処理リスト領域数 (I) */
 long           docfilelistn;     /* 格納文書ファイル情報領域数 (I) */
 long           datamemofilelistn;   /* 格納メモファイル情報領域数 (I) */
 long           oplist_total;     /* ユーザ処理リスト総数 (O) */
 long           get_oplistn;      /* 取得ユーザ処理リスト数 (O) */
 BWF_oplist_t  __far *get_oplist;   /* 取得ユーザ処理リスト (O) */
 long           docfile_total;     /* 格納文書総数 (O) */
 long           get_docfilelistn;   /* 取得格納文書ファイル数 (O) */
 BWF_outfilelistex_t *get_docfilelist; /* 格納文書ファイル情報格納領域 (O) */
 long           datamemofile_total;  /* 格納メモ総数 (O) */
 long           get_datamemofilelistn; /* 取得格納メモファイル数  (O) */
 BWF_outfilelistex_t *get_datamemofilelist;  
                    /* 格納メモファイル情報格納領域 (O) */
 char           lock[4];        /* 文書ロック取得結果 (O)*/
                    /* OK:成功,NG:失敗 */
 char           reserved[64] ;     /* 予備領域 (-) */
}BWF_downcaseinfex_t;
typedef struct BWF_outfilelistex_t {  /* 文書/メモファイル情報 */
 char           memotype;       /* メモ種別 */
          /* F:ファイル D:データ S:Groupmax Integrated Desktop本文 */
 char           reserved1[3];     /* 予備領域 */
 BWF_oid_t      file_id;        /* 文書/メモファイル識別子 */
 char           outfilename[512];   /* フルパスファイル名称 */
 char           filename[256];     /* ファイル登録名称 */
 unsigned long  datamemon;       /* データメモページ数 */
 char           reserved[64] ;     /* 予備領域 */
}BWF_outfilelistex_t;
typedef struct    BWF_oplist_t{
 char            BWF_ol_kind_code[2];       /* 種別コード */
 char            BWF_ol_create_condition[2];   /* 設定条件 */
 BWF_casename_t  BWF_ol_case_name;        /* 案件名 */
 char            BWF_ol_get_operation_list[256]; /* 作業情報 */
} BWF_oplist_t;
typedef struct  BWF_errlist_t {  /*エラー情報取得領域 */
 char          sBMsgKbn[6];    /* メッセージ区分 */
 long          lBMsgNo;      /* メッセージ番号 */
 char          sBInsWord[13];   /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
caseoid
この関数で処理する案件の案件オブジェクトIDを格納した領域を指定します。案件に複数の下位案件がある場合は,上位案件オブジェクトIDを指定してください。
案件オブジェクトIDは,HwfGetCaseSelectData,又はHwfGetGsTakeOverDataで取得できます。
pwnd_handle
親ウィンドウのハンドルを指定します。
act_mode
案件処理の開始モードを指定します。
0:この関数の発行ではまだ案件処理は開始しません。
この場合は,HwfPrefixCaseを案件処理開始モードで再発行する必要があります。
1:この関数の発行で案件処理を開始します。同報中の案件の場合は文書ロックに失敗した場合は参照モードで案件処理を開始します。ロックの取得結果はBWF_downcaseinfex_t構造体のlockで確認してください。
2:この関数の発行で案件処理を開始します。
同報中の案件の場合,文書ロックに失敗したときはエラーリターンします。
file_get_mode
添付ファイルの取得モードを指定します。
0:添付された文書,メモの実体はこの関数では取得しません。
この場合,この関数の出力結果,又はHwfGetCaseDocumentListで添付文書,メモ一覧参照後,必要なものだけ取得できます。
1:添付された文書,メモ実体をこの関数で取得します。ただし,この関数で指定するBWF_downcaseinfex_t構造体中のget_docfilelist,get_datamemofilelistに取得できた文書,メモ情報に含まれた文書,メモだけを取得対象とします。
oplist_file_get_mode
ユーザ処理リストで指定された作業用ファイルの取得モードを指定します。
0:作業用のファイルをこの関数では取得しません。
comment_display_mode
0を指定してください。
downcaselistn
案件情報リストの要素数を指定します。1以上の数値を指定します。単独案件の案件情報を取得するときは1を指定します。
case_total
caseoidで入力した案件にある取得可能な案件情報数を出力します。
nodename
caseoidで入力した案件があるノード名称を出力します。終端にNULL文字を付けた64バイト以内の文字列を出力します。
userkey
caseoidで入力した案件のワークID(案件識別子フォーマット)を出力します。
bpname
caseoidで入力した案件があるビジネスプロセス定義の名称を出力します。終端にNULL文字を付けた64バイト以内の文字列を出力します。
priority_code
caseoidで入力した案件の優先度を出力します。終端にNULL文字を付けた5バイトの文字列を出力します。
com△:普通を示します。
urg△:至急を示します。
 注 △はスペースを示します。
prcssknd_code
案件の処理状態を出力します。終端にNULL文字を付けた5バイトの文字列を出力します。
ord△:通常処理
exc△:例外処理(相談)
exca:例外処理(相談途中での回答)
exa△:例外処理(回答)
exsb:例外処理(差し戻し)
extb:例外処理(引き戻し)
 注 △はスペースを示します。
通常処理
ビジネスプロセス定義で定義された処理の流れどおりに遷移されてきたことを示します。
例外処理
ビジネスプロセス定義で定義された処理の流れ以外の流れで遷移してきたことを示します。
title
案件タイトルを出力します。終端にNULL文字を付けた64バイト以内の文字列を出力します。
workoid
ワークオブジェクトIDを出力します。
downcaselist
案件情報リストを格納した領域を入力/出力します。caseoidで入力した案件の案件情報を格納する領域です。下位案件がない案件(単独案件)の場合も1要素分の領域を確保してください。
案件情報リストについては,案件情報リスト要素の項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
  • 総データ転送量が64000バイトを超えない範囲で使用してください。
    総データ転送量は次の計算式で求めることができます。

    総データ転送量 = 224 + 案件転送量総和

     
    案件転送量総和は,取得した案件ごとの1案件当たりの転送量の合計です。

    1案件当たりの転送量 = 224 + 取得ユーザ処理リスト転送量総和
                 + 取得文書情報転送量総和 + 取得メモ情報転送量総和
                 + 取得データメモ情報転送量総和

     
    取得ユーザ処理リスト転送量総和は,取得した案件ごとの1ユーザ処理リスト転送量の合計です。

    1ユーザ処理リスト転送量 = 328 + ケース名称長(※1)

     
    取得文書情報転送量総和は,取得した案件ごとの1取得文書情報転送量の合計です。

    1取得文書情報転送量 = 80 + 取得文書名称長(※1)

     
    取得メモ情報転送量総和は,取得した案件ごとの1取得メモ情報転送量の合計です。

    1取得メモ情報転送量 = 80 + 取得メモ名称長(※1)

     
    取得データメモ情報転送量総和は,取得した案件ごとの1取得データメモ情報転送量の合計です。

    1取得データメモ情報転送量 = 44 × ↑取得データメモサイズ ÷4095↑(※2)

    注※1
    文字列の長さは,¥0を含めた長さを基本長とします。基本長が4バイトの倍数になるように自動的に補正されます。例えば,"abcd¥0"の場合,実長は5になります。4の倍数に補正されるため,実長5の文字列長は8になります。
    Groupmax Workflowの規則に従った長さに補正した値を計算式に使用する項目には,次の三つがあります。
    ・ケース名称長
    ・取得メモ名称長
    ・取得文書名称長
    注※2
    ↑↑は小数点以下切り上げを示します。

(e) HwfSimpleGoCase(文書とメモを格納した案件を次ノードへ遷移(機能制限版))
機能
案件に対してユーザ属性設定と添付ファイル更新をした後,次ノードへの遷移処理,又は保留処理をします。
この関数は,HwfSuffixCase関数に比べて次に示す制限があります。
  • 案件の処理期限を変更できません。
  • 案件の優先度を変更できません。
  • 文書及びメモの添付ファイルにロングファイル名称を指定できません。
  • HwfSimplePreCase関数で取得した文書及びメモの添付ファイルは移動できません。移動したファイル又は新しいファイルを更新添付ファイルとして指定するとエラーとなります。
  • 添付するメモの種別にGroupmax Integrated Desktop本文を指定できません。Groupmax Integrated Desktopと併用する場合は注意してください。
  • 次ノード処理ユーザを指定できません。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include <bwf.h>
long HwfSimpleGoCase(
 BWF_useroid_t    __far *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t     __far *server,    /* サーバ名称格納領域 (I) */
 BWF_caseid_t     __far *caseoid,    /* 案件オブジェクトID (I) */
 HWND                   pwnd_handle,  /* 親ウィンドウのハンドル (I) */
 long                   mode,      /* 遷移モード (I) */
 long                   caseinflistn,  /* 遷移案件情報リスト数 (I) */
 BWF_gocaseinf_t  __far *caseinflist,  /* 遷移案件情報リスト (I) */
 BWF_errlist_t    __far *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_gocaseinf_t{          /* 遷移案件情報 */
 BWF_casename_t   casename;           /* 案件名 (I) */
 long             userattrlistn;         /* エンドユーザ属性リスト数 (I) */
 BWF_end_userattrlist_t  __far *userattrlist;  /* エンドユーザ属性リスト (I) */
 long             update_docfilen;        /* 文書更新情報リスト要素数 (I) */
 BWF_update_t  __far *update_docfile;      /* 文書更新情報リスト (I) */
 long                update_memofilen;      /* メモ更新情報リスト要素数 (I) */
 BWF_update_t  __far *update_memofile;      /* メモ更新情報リスト (I) */
}BWF_gocaseinf_t;
typedef struct BWF_end_userattrlist_t {      /* エンドユーザ属性 */
 char                 BWF_user_defname[64];   /* ユーザ定義名称 (I) */
 char                 BWF_user_attr_value[32];  /* 設定ユーザ属性 (I) */
}BWF_end_userattrlist_t;
typedef struct BWF_update_t {     /* 文書/メモ更新情報 */
 char             type;        /* 更新種別を指定する (I) */
  /* A:添付 D:削除 U:更新 */
 char             outfilename[512];  /* フルパスファイル名称 (I) */
 char             oldname[16];    /* ファイル登録名称 (I) */
 char             filetype[4];    /* ファイル種別 (I) */
}BWF_update_t;
typedef struct  BWF_errlist_t {    /* エラー情報取得領域 */
 char              sBMsgKbn[6];    /* メッセージ区分 (O) */
 long              lBMsgNo;      /* メッセージ番号 (O) */
 char              sBInsWord[13];   /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseoid
次ノードへ遷移させる案件の案件オブジェクトIDを指定します。案件に複数の下位案件がある場合は,上位案件オブジェクトIDを指定してください。NULLを入力するとGroupmax Desktop,及びGroupmax Integrated Desktopからの引継情報を格納したファイルGSTODK.DATから案件オブジェクトIDを取得します。ファイルGSTODK.DATに複数の案件オブジェクトIDが格納されている場合は,格納されている案件オブジェクトIDのうち,ファイルの先頭に最も近いものを処理対象とします。
pwnd_handle
親ウィンドウのハンドルを指定します。
mode
遷移のモード(0:保留,1:遷移,2:取り消し)を指定します。保留の場合もユーザ属性設定と文書とメモの更新をします。
0:案件処理を保留します。
指定したユーザ属性の設定・文書とメモの更新はします。
1:案件を次ノードへ遷移します。
指定したユーザ属性の設定・文書とメモの更新をします。案件が他ユーザから相談された案件のときは一つ前の相談者に回答します。
2:案件処理を取り消します。
指定されたユーザ属性の設定・添付ファイルの更新はしません。
また,遷移案件情報リスト数には0を,遷移案件情報リストにはNULLを指定してください。
上記以外の値を指定するとエラーとなります。
caseinflistn
入力する案件情報リストの要素数を指定します。0以下の値を指定すると案件情報リスト(caseinflist)の値は無効になります。
caseinflist
案件情報リストを設定した領域を指定します。caseinflistnが0以下の値なら,指定した値は無効となります。caseinflistnとcaseinflistの要素数は一致させてください。caseinflistn>0で,かつcaseinflistn>(caseinflistの要素数)の場合,この関数の動作は保証できません。
遷移案件情報リストについては,遷移案件情報リスト要素の項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン,又は警告発生
注意事項
  • このAPI関数を使用して文書,メモを更新,又は削除する場合,事前にHwfSimplePreCaseが発行されていないとエラーリターンします。
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
(f) HwfSuffixCase(文書とメモを格納した案件を次ノードへ遷移)
機能
案件に対してユーザ属性設定と添付ファイル更新をした後,次ノードへの遷移処理,又は保留処理をします。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include <bwf.h>
long HwfSuffixCase(
 HWND                     pwnd_handle,  /* 親ウィンドウのハンドル (I) */
 long                     caseinfexn,  /* 遷移案件数 (I) */
 BWF_gocaseinfex_t  __far *caseinfex,  /* 遷移案件情報リスト (I) */
 BWF_errlist_t      __far *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_gocaseexinf_t{     /* 遷移案件情報  */
 BWF_caseid_t  __far *caseoid;      /* 案件オブジェクトID (I) */
 long                mode;        /* 遷移モード (I) */
 long                nextusern;      /* 次ノード処理ユーザ情報数 (I) */
 BWF_nextuser_t      *nextuser;      /* 次ノード処理ユーザ情報 (I) */
 long          __far *priority;      /* 優先度 (I) */
 BWF_time_t    __far *limit;       /* 処理期限 (I) */
 long                caseinflistn;    /* 遷移案件情報リスト数 (I) */
 BWF_suffixcaseinf_t  __far *caseinflist; /* 遷移案件情報リスト (I) */
 char                reserved[32];    /* 予備領域 (-) */
}BWF_gocaseinfex_t;
typedef struct BWF_suffixcaseinf_t{        /* 遷移案件情報 */
 BWF_casename_t   casename;           /* 案件名 (I) */
 long             userattrlistn;         /* エンドユーザ属性リスト数 (I) */
 BWF_end_userattrlist_t  __far *userattrlist;  /* エンドユーザ属性リスト (I) */
 long             update_docfilen;        /* 文書更新情報リスト要素数 (I) */
 BWF_docupdateex_t  __far *update_docfile;    /* 文書更新情報リスト (I) */
 long             update_memofilen;       /* メモ更新情報リスト要素数 (I) */
 BWF_docupdateex_t  __far *update_memofile;   /* メモ更新情報リスト (I) */
 char             reserved[32];         /* 予備領域 (-) */
}BWF_suffixcaseinf_t;
typedef struct BWF_end_userattrlist_t {      /* エンドユーザ属性 */
 char                 BWF_user_defname[64];   /* ユーザ定義名称 (I) */
 char                 BWF_user_attr_value[32];  /* 設定ユーザ属性 (I) */
}BWF_end_userattrlist_t;
typedef struct BWF_docupdateex_t {  /* 文書/メモ更新情報 */
 char             type;       /* 更新種別を指定する (I) */
                   /* A:添付D:削除U:更新 (I) */
 char             memotype;     /* メモ種別を指定する (I) */
  /* F:ファイル D:データ S:Groupmax Integrated Desktop本文 (I) */
 char             reserved1[2];   /* 予備領域 (I) */
 BWF_oid_t        file_id;      /* 文書/メモファイル識別子 (I) */
 char             outfilename[512]; /* フルパスファイル名称 (I) */
 char             oldname[256];   /* ファイル登録名称 (I) */
 char             reserved[64] ;   /* 予備領域 (-) */
}BWF_docupdateex_t;
typedef struct  BWF_nextuser_t {     /* 次処理ユーザ指定領域 */
 char              casename[64] ;    /* 案件名称 (I) */
 char              attributename[64] ; /* ユーザ定義属性名称 (I) */
 char              nickname[132] ;   /* 処理ユーザのニックネーム (I) */
} BWF_nextuser_t;
typedef struct  BWF_errlist_t {     /*エラー情報取得領域 */
 char              sBMsgKbn[6];     /* メッセージ区分 (O) */
 long              lBMsgNo;       /* メッセージ番号 (O) */
 char              sBInsWord[13];    /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
pwnd_handle
親ウィンドウのハンドルを指定します。
caseinfexn
入力する案件情報リストの要素数を指定します。1以上の値を指定してください。
caseinfex
案件情報リストを設定した領域を指定します。
案件情報リストについては,遷移案件情報リスト要素内の項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン,又は警告発生
注意事項
  • 複数の案件を指定してこの関数を発行した場合,指定された順番に案件処理を行います。途中でエラーが発生した場合,エラーが発生した案件より前に指定されている案件は,正常に遷移されます。エラーが発生した案件より後に指定された案件は,処理を行わないで,エラーリターンで関数は終了します。
    そのため,エラー要因を取り除いた後に,この関数を再度発行する場合は,遷移させたい案件情報を再取得し,遷移が行われなかったことを確認した後に発行してください。
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
  • 総データ転送量が64000バイトを超えない範囲で使用してください。
    総データ転送量は次の計算式で求めることができます。

    総データ転送量=140 + 案件転送量総和

     
    案件転送量総和は,指定した案件ごとの1案件当たりの転送量の合計です。

    1案件当たりの転送量=次ノードユーザ処理リスト転送量総和 + 遷移案件ケース情報転送量総和 + 124

     
    次ノードユーザ処理リスト転送量総和は,1次ノードユーザ処理リスト転送量を次ノード処理ユーザ数分を求めた合計です。

    1次ノードユーザ処理リスト転送量=ケース名称長 + ユーザ定義属性名称長 + ニックネーム長 + 48

     
    遷移案件ケース情報転送量総和は,1遷移案件ケース情報転送量を遷移案件ケース情報数分求めた合計です。

    1遷移案件ケース情報転送量=ケース名称長 + ユーザ属性リスト転送量 + 文書更新情報リスト転送量 + メモ更新情報リスト転送量 + 76

     
    ユーザ属性リスト転送量は,1ユーザ属性リスト転送量をユーザ属性リスト数の分求めた合計です。

    1ユーザ属性リスト転送量=ユーザ定義名称長 + 設定ユーザ属性値長 + 32

     
    文書更新情報リスト転送量は,1文書更新情報リスト転送量を文書更新情報リスト数の分だけ求めた合計です。

    1文書更新情報リスト転送量=44 × 文書更新情報リスト数

     
    メモ更新情報リスト転送量は,1メモ更新情報リスト転送量をメモ更新情報リスト数分求めた合計です。

    1メモ更新情報リスト転送量=108 + [8 × [ ↑データメモサイズ ÷4095↑ ] + 16 ](※2)(※3)

注※1
文字列の長さは,¥0を含めた長さを基本長とします。基本長が4バイトの倍数になるように自動的に補正されます。例えば,"abcd¥0"の場合,実長は5になります。4の倍数に補正されるため,実長5の文字列長は8になります。
Groupmax Workflowの規則に従った長さに補正した値を計算式に使用する項目には,次の四つがあります。
  • ケース名称
  • ユーザ定義属性名称
  • ニックネーム
  • 設定ユーザ属性値
注※2
[ ]は,データメモを追加・更新する場合だけ計算が必要です。削除の場合,計算する必要はありません。
注※3
↑↑は小数点以下切り上げを示します。
(g) HwfRoundCaseEx(他ユーザへの案件の相談)
機能
ユーザトレー内にある案件を他ユーザへ相談します(そのとき,案件の案件処理種別には,例外処理が設定されます)。
相談先のユーザがその案件の回答処理をすると,相談元のユーザのトレーに案件が返却されます。また,相談されたユーザがその案件を他ユーザへ相談することもできます。
指定できる案件はルート(上位)案件,又は一般(単独)案件だけです。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfRoundCaseEx(
 BWF_useroid_t  __far *useroid,  /* ユーザオブジェクトID格納領域  (I) */
 BWF_server_t   __far *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far *caseid,  /* 相談案件オブジェクトID格納領域 (I) */
 char           __far *nickname, /* 相談者先ユーザニックネーム格納領域 (I) */
 BWF_errlist_t  __far *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
他ユーザへ相談するという形で回付する案件の案件オブジェクトIDを格納した領域を指定します。案件に複数の下位案件がある場合は,上位案件オブジェクトIDを指定してください。
nickname
案件を回付するユーザのGroupmax Addressで管理するニックネーム(相談先ユーザのニックネームはHwfGetConsultantListなどで取得できます)を格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidで指定した案件が,useroidで指定したユーザのトレーにない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • nicknameで指定したユーザがいない,又は運用可能状態でない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • HwfStartUpWorkflowでログインしたサーバ以外に登録されている,受付禁止状態のユーザに相談を行うと,API関数は正常リターン(BWF_OK)しますが,案件は遷移エラーとなってエラートレーに遷移します。
  • nicknameに自ユーザを指定してこの関数を発行すると,戻り値はエラーリターン(BWF_ERROR)となります。
(h) HwfAnswerCase(他ユーザから相談された案件の回答)
機能
他ユーザから相談された案件を,相談元のユーザへ回答します。
回答方法には,次の二つの方法があります。
  • 相談された案件を,直前に相談した相談元ユーザへ返却します。
  • 相談された案件が他のユーザに相談されていた場合,最初にその案件を相談した相談元ユーザに返却します。
なお,相談された案件の回答ができるのは,案件の案件処理種別が例外処理(相談)となっているものだけです。
また,相談元のユーザに返却する場合,相談元のユーザが運用不可状態でも返却できます。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfAnswerCase(
 BWF_useroid_t __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,   /* サーバ名称格納領域 (I) */
 long                answermode, /* 回答処理モード (I) */
 BWF_useroid_t __far *auseroid,  /* 回答先ユーザオブジェクトID格納領域 (I) */
 BWF_caseid_t  __far *caseid,   /* 返却案件オブジェクトID格納領域 (I) */
 BWF_errlist_t __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
answermode
相談された案件の回答処理方法を指定します。
BWF_ANSWER_TO_ROOT:相談された案件が他ユーザに相談されていた場合,caseidに指定した案件を最初に相談した相談元ユーザに回答します(相談された案件が他ユーザに相談されていない場合,結果はBWF_ANSWER_TO_BEFOREを指定した時と,同様になります)。
BWF_ANSWER_TO_BEFORE:相談された案件が他ユーザに相談されていた場合,caseidに指定した案件を直前に相談した相談元ユーザに回答します。
auseroid
NULLポインタを指定します。
caseid
返却する案件の案件オブジェクトID(HwfGetCaseSelectDataなどで取得できます)を格納した領域を指定します。案件に複数の下位案件がある場合は,上位案件オブジェクトIDを指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidで指定した案件が,useroidで指定したユーザのトレーにない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • caseidで指定した案件が,他ユーザから相談された案件でない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 相談された案件が他ユーザに相談されていた場合,案件を最初に相談した相談元ユーザが削除されていれば,useroidで指定したユーザが登録されているロールのトレーに案件は追加されます。
(i) HwfTrustCaseEx(他ユーザへの案件処理依頼)
機能
案件を他ユーザへ処理依頼します。
指定可能な案件はルート案件,又は単独案件です。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfTrustCaseEx(
 BWF_useroid_t     __far  *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t      __far  *server,    /* サーバ名称格納領域 (I) */
 long                     caseidlistn,  /* 処理依頼案件数 (I) */
 BWF_caseidlist_t  __far  *caseidlist,  /* 処理依頼案件オブジェクトID配列格納領域 (I) */
 char              __far  *nickname,   /* 処理依頼先ユーザニックネーム格納領域 (I) */
 BWF_errlist_t     __far  *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseidlistn
他ユーザへ処理依頼する案件の数を指定します。1~500までの範囲内で指定してください。
caseidlist
他ユーザへ処理依頼する案件の案件オブジェクトID(HwfGetCaseSelectDataなどで取得できます)を格納した配列領域を指定します。案件に複数の下位案件がある場合は,上位案件オブジェクトIDを指定してください。
nickname
処理依頼先ユーザのGroupmax Addressで管理するニックネームを格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidlistで指定した案件が,そのユーザのユーザトレーにない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • nicknameで指定した処理依頼先ユーザが,運用不可状態の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • HwfStartUpWorkflowでログインしたサーバ以外に登録されている,受付禁止状態のユーザに処理依頼を行うと,API関数は正常リターン(BWF_OK)しますが,案件は遷移エラーとなってエラートレーに遷移します。
(j) HwfSendBackCaseEx(案件の差し戻し要求)
機能
指定案件を指定ユーザに差し戻します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfSendBackCaseEx(
 BWF_useroid_t  __far *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,    /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far *caseid,    /* 案件オブジェクトID格納領域 (I) */
 unsigned long        backuserhdl,  /* 差し戻し先ユーザハンドル (I) */
 BWF_errlist_t  __far *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
差し戻し対象となる案件の案件オブジェクトID(HwfGetCaseSelectDataなどで取得できます)を設定した領域を指定します。案件に複数の下位案件がある場合は,上位案件オブジェクトIDを指定してください。
backuserhdl
差し戻し先ユーザに対するハンドルを指定します。ハンドルはHwfGetBackUserHandleList関数で取得してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
拡張ビジネスプロセス定義以外でサーバ間連携を行っている場合の処理は,次に示すようになります。
  • 指定した案件があるビジネスプロセス定義が直列型ビジネスプロセス定義の場合は,現在,案件があるビジネスプロセス定義内で処理をしたユーザだけ,差し戻しできます。
  • 指定した案件があるビジネスプロセス定義が階層型ビジネスプロセス定義の場合は,現在,案件があるビジネスプロセス定義の一つ前の上位階層のビジネスプロセス定義で処理したユーザに対して,差し戻しできます(ただし,そのビジネスプロセス定義が最上階層の場合を除きます)。
同報,分割,回収,待合,複写ノードのどれかを含むビジネスプロセス定義中で差し戻し要求を出す場合,次に示す制限があります。
  • 差し戻し要求ノードから同報,分割,回収,待合,複写ノードまで差し戻しをします。
    (例)

    [図データ]

    処理ノード4から差し戻し対象となるのは,処理ノード3となります。処理ノード1(又は処理ノード2)へは差し戻しできません。
 
  • 現在,案件があるビジネスプロセス定義の一つ前の上位階層のビジネスプロセス定義で処理したユーザに対して差し戻しをする場合,要求受付と実行は非同期に行われるため,このAPI発行後,すぐに差し戻しされない場合があります。
  • 直列型ビジネスプロセス定義で,差し戻し先となるビジネスプロセス定義が要求元と同一サーバ上にない場合,案件はエラートレーに遷移します。
  • 差し戻し操作禁止オプションを指定して登録した拡張ビジネスプロセス定義に投入された案件(caseidで指定)に対してこの関数を発行すると,戻り値はエラーリターン(BWF_ERROR)となります。
(k) HwfGetBackUserHandleList(差し戻し先ユーザ一覧の取得)
機能
引数case_idで指定したユーザトレーにある案件の差し戻し候補者一覧を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetBackUserHandleList(
 BWF_useroid_t  __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,  /* サーバ名称格納領域           (I) */
 BWF_caseid_t   __far *case_id,  /* 差戻し案件の識別子           (I) */
 unsigned long        number   /* 差し戻しリスト取得開始位置   (I) */
 unsigned long        count    /* 差し戻しリスト取得要求数     (I) */
 unsigned long  __far *total   /* 差し戻しリスト総数           (O) */
 unsigned long  __far *userlistn /* 取得した差し戻しリスト数     (O) */
 BWF_backuser_t __far *userlist  /* 差し戻しリスト取得領域       (O) */
 BWF_errlist_t  __far *errlist  /* エラー情報取得領域 (O) */
 void           __far *arg    /* 拡張用領域のアドレス */
);
typedef struct BWF_backuser_t{
 long  backuserhdl;    /* ハンドル          */
 long  time;       /* 作業時刻          */
 char  node_name[64];   /* ノード名          */
 char  user_id[8];    /* ユーザID          */
 char  nick_name[132];  /* ニックネーム      */
 char  user_name[36];   /* ユーザ名(日本語)  */
 char  org_name[36];   /* 組織略称          */
 char  post[36];     /* 役職              */
 char  reserved[64];   /* 予備領域          */
} BWF_backuser_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];    /* メッセージ区分 */
 long lBMsgNo;      /* メッセージ番号 */
 char sBInsWord[13];   /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
case_id
差し戻しする案件の識別子を格納している領域のアドレスを指定します。案件に複数の下位案件がある場合は,上位案件識別子を指定してください。
number
引数case_idで指定したケースの差し戻し候補者全体から取得する先頭ユーザの要素番号(0~差し戻し可能なユーザ数-1)を指定します。
count
取得する差し戻し候補者の数(0~50)を指定します。
total
差し戻し可能なユーザ数を格納する領域のアドレスを指定します。
userlistn
取得した差し戻し候補者のユーザ情報数を格納する領域のアドレスを指定します。
userlist
差し戻し候補者リストを格納する領域を指定します。
backuserhdl:差し戻し候補者を識別するためのハンドルが格納されます。このハンドルは差し戻し(HwfSendBackCaseEx)をするときに必要です。
time:作業時刻が格納されます。時刻は,1970/01/01 00:00:00(GMT)からの経過秒が設定されます。
node_name:ノード名が,終端にNULL文字を含む文字列で格納されます。
user_id:ユーザのユーザIDが,終端にNULL文字を含む9バイト未満の文字列で格納されます。
nick_name:ユーザのニックネームが,終端にNULL文字を含む最大132バイトの文字列で格納されます。
user_name:ユーザの日本語名が,終端にNULL文字を含む最大36バイトの文字列で格納されます。
org_name:ユーザの所属する組織の組織略称が,終端にNULL文字を含む最大36バイトの文字列で格納されます。
post:ユーザの役職が,終端にNULL文字を含む最大36バイトの文字列で格納されます。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • この関数で取得する差し戻しリストには,差し戻しできるすべてのユーザが格納されます。
  • 差し戻し操作禁止オプションを指定して登録した拡張ビジネスプロセス定義に投入された案件(case_idで指定)に対してこの関数を発行すると,戻り値はエラーリターン(BWF_ERROR)となります。
(l) HwfDeleteCase(投入エラー案件の削除)
機能
自ユーザトレーにある投入エラーの案件を削除します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfDeleteCase(
 BWF_useroid_t  __far  *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far  *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far  *caseid,  /* 削除する案件識別子格納領域 (I) */
 BWF_errlist_t  __far  *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
自ユーザトレーから削除したい投入エラー案件の案件オブジェクトID(HwfGetCaseSelectDataなどで取得)を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • この関数は,投入エラーの案件だけ削除できます。遷移エラーの案件を削除する場合は,HwfCancelWorkExを使用してください。投入エラー案件を再度投入するにはHwfRecoverPutErrCaseを使用してください。
  • この関数では,自ユーザトレーにある案件だけ削除できます。
(m) HwfRecoverCase(エラー案件の回復)
機能
自ユーザトレーにある復帰可能なエラー案件を回復します。
自ユーザトレーにある復帰可能なエラー案件に対して,再度遷移依頼を試みます。
この関数の発行前にエラー原因を取り除いてください。例えば,ユーザ属性設定不正による分岐エラーであれば,HwfSetCaseByUserDefNameでユーザ属性を再設定するなどの処置が必要です。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfRecoverCase(
 BWF_useroid_t    __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t     __far *server,  /* サーバ名称格納領域  (I) */
 BWF_caseid_t     __far *caseid,  /* 回復案件オブジェクトID格納領域 (I) */
 BWF_errlist_t    __far *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
回復する案件のオブジェクトIDを格納した領域を指定します。案件に複数の下位案件がある場合は,上位案件オブジェクトIDを指定してください。
案件のオブジェクトIDは,HwfGetCaseSelectDataなどで取得できます。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数発行前にエラー要因を取り除いていないと,このAPI関数で正常リターンしても後で再びエラー案件として配布されます。
  • このAPI関数では,自ユーザトレーにある復帰可能なエラー案件だけ処理できます。その他の案件である場合は,エラーリターンします。復帰不可能な案件,又は復帰する必要のない案件はHwfCancelWorkExで削除できます。
(n) HwfRecoverPutErrCase(投入エラー案件の再投入)
機能
自ユーザトレーにある投入エラーの案件を再度投入します。
自ユーザトレーにある投入エラーの案件を,指定ビジネスプロセス定義の指定バージョンへ再度投入を試みます。一般には,復帰可能な投入エラーは,ワークID(案件識別子フォーマット)の不正であるため,ワークID(案件識別子フォーマット)を訂正して投入することになります。投入時には,次の処理をします。
  • ワークID(案件識別子フォーマット)の一意性チェック
    指定案件と同一案件名を持ち,かつ同一ワークID(案件識別子フォーマット)の案件が指定したビジネスプロセス定義(ビジネスプロセス定義名称が同一であれば,バージョンは問わない)にある場合,案件を投入できません。
  • バージョンアップ投入
    最新バージョンのビジネスプロセス定義に案件を投入するとき,指定案件と異なる案件名称,かつ同一のワークID(案件識別子フォーマット)を持つ案件が旧バージョンにある場合,旧バージョンのビジネスプロセス定義に案件を投入します(投入モードの指定が必要です)。
  • ルート案件投入
    同一ワークID(案件識別子フォーマット)で,かつ案件名称が異なる複数の案件を,指定ビジネスプロセス定義の指定バージョンへ投入します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfRecoverPutErrCase(
 BWF_useroid_t    __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t     __far *server,    /* サーバ名称格納領域 (I) */
 char             __far *bpname,    /* ビジネスプロセス定義名称格納領域 (I) */
 unsigned long          version,    /* バージョン番号格納領域 (I) */
 char             __far *nodename,   /* 投入ノード名称格納領域 (I) */
 long                   number,    /* 投入案件数格納領域 (I) */
 BWF_caseidlist_t __far *caseid,    /* 投入案件オブジェクトID配列格納領域 (I) */
 BWF_userkey_t    __far *userkey,   /* ワークID(案件識別子フォーマット) */
                    /* 配列格納領域                 (I) */
 char             __far *aliaskey,   /* 案件タイトル名格納領域 (I) */
 long                   putmode2,   /* 投入モード2 (I) */
 unsigned long    __far *putversion,  /* 投入成功バージョン番号格納領域 (O) */
 BWF_errlist_t    __far *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char  sBMsgKbn[6];  /* メッセージ区分 */
 long  lBMsgNo;    /* メッセージ番号 */
 char  sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
bpname
案件を投入するビジネスプロセス定義名称を指定します。
ビジネスプロセス定義名称は,終端にNULL文字を付けた64バイト以内の文字列で指定してください。
ビジネスプロセス定義名称は,HwfGetBusinessProcess,HwfGetCaseFormSelectExなどで取得できます。
version
案件を投入するビジネスプロセス定義のバージョン番号を指定します。
bpnameで指定したビジネスプロセス定義を運用できる最新バージョンに投入する場合,BWF_ACTC_VERSIONを指定してください。
バージョン番号は,HwfGetBusinessProcess,HwfGetCaseFormSelectExなどで取得できます。
nodename
案件を投入する開始処理ノード名称を指定します。
開始処理ノード名称の長さは,終端にNULL文字を付けた64バイト以内の文字列で指定してください。
開始処理ノード名称は,HwfGetCaseFormSelectExなどで取得できます。
number
投入する案件数を指定します。
1以上を指定してください。2以上を指定する場合,すべての案件のワークID(案件識別子フォーマット)は,同一である必要があります。
caseid
投入する案件のオブジェクトIDを格納した領域を指定します。
案件のオブジェクトIDは,HwfGetCaseSelectDataで取得できます。
userkey
投入する案件のワークID(案件識別子フォーマット)を変更する場合に指定します。変更の必要がない場合,パラメタにNULLポインタを指定してください。
指定した場合,caseidで指定した案件すべてのワークID(案件識別子フォーマット)が変更になります。ワークID(案件識別子フォーマット)は,終端にNULL文字を付けた64バイト以内の文字列で指定してください。ただし,投入する案件数が複数の場合,全案件に共通するワークID(案件識別子フォーマット)を指定してください。
aliaskey
投入する案件に設定する案件タイトル名を指定します。
指定の必要がない場合,パラメタにNULLポインタを指定してください。ただし,同一のワークID(案件識別子フォーマット)を持つ案件が投入済みで,その案件に案件タイトル名が設定済みの場合,設定済みの案件タイトル名が優先されます。
案件タイトル名は,終端にNULL文字を付けた64バイト以内の文字列で指定してください。
putmode2
複数の開始処理ノードに各々案件を投入する場合,投入案件のメイン,サブ指定をします。
BWF_MAIN_MODE:メインを指定する場合に指定します。
案件投入時,別案件名称で同一のワークID(案件識別子フォーマット)を持つ案件がない場合でも正常に投入します。
BWF_SUB_MODE:サブを指定する場合に指定します。
案件投入時,別案件名称で同一のワークID(案件識別子フォーマット)を持つ案件がない場合,エラーリターンします。
BWF_DEFAULT_MODE:メインかサブかを,指定されたビジネスプロセス定義名称とノード名称から取得します。
メイン指定
 案件投入時にワークを新規に作成します。
サブ指定
 案件投入時にワークを新規に作成しないで,既にある同一ワークID(案件識別子フォーマット)を持つワーク下に投入し,案件を追加します。
 
putmode2に,BWF_MAIN_MODE,BWF_SUB_MODE,BWF_DEFAULT_MODE以外を指定した場合,BWF_MAIN_MODEで処理します。
putversion
投入に成功した,ビジネスプロセス定義のバージョン番号を取得する領域を指定します。必要ない場合は,NULLポインタを指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数の戻り値がエラーリターン(BWF_ERROR)の場合,案件は投入したユーザのトレーに残ります(この案件は,このAPI関数を使用して再投入を試みることができます)。
  • このAPI関数では,自ユーザトレーにある投入エラー案件の処理だけができます。その他の案件である場合は,エラーリターンします。再投入の必要がない場合,HwfDeleteCaseで削除できます。
  • ソースノードに複数のケースが定義されている場合,すべてのケースを指定してください。すべてのケースが指定されていない場合は,このAPI関数はエラーリターン(BWF_ERROR)します。
(o) 取得案件情報項目
項番案件情報項目識別子項目名型(サイズ)備考
1BWF_CASE_OID案件オブジェクトIDBWF_caseid_tオブジェクトID型
2BWF_CASE_NAME案件名称char[64]char型
3BWF_CASE_ALIAS_NAMEノード名char[64]char型
4BWF_TRANSACTION_IDトランザクションIDchar[8]char型
5BWF_USER_KEYワークID(案件識別子フォーマット)BWF_userkey_tchar型
6BWF_CREATE_NAME作成者char[8]char型
7BWF_CREATE_USER_OID作成者ユーザオブジェクトIDBWF_useroid_tオブジェクトID型
8BWF_CREATE_TIME作成日時(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
9BWF_ARRIVAL_TIME到着日時(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
10BWF_PROCESS_LIMIT_TIME処理期限(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
11BWF_BP_NAMEビジネスプロセス定義名称char[64]char型
12BWF_BP_OIDビジネスプロセス定義オブジェクトIDBWF_bpid_tオブジェクトID型
13BWF_BP_VERSION_NUMBERビジネスプロセス定義バージョン番号unsigned longunsigned long型
14BWF_MEMO_OBJECT_COUNTメモ数unsigned longunsigned long型
15BWF_REPORT_OBJECT_COUNT文書数unsigned longunsigned long型
16BWF_TRAY_KIND_CODEトレー種別char[4]char型
17BWF_USER_OIDユーザオブジェクトIDBWF_useroid_tオブジェクトID型
18BWF_ROLE_OIDロールオブジェクトIDBWF_roleid_tオブジェクトID型
19BWF_WORK_OIDワークオブジェクトIDBWF_workid_tオブジェクトID型
20BWF_CASE_CLASS_KIND_CODE階層種別char[4]char型
21BWF_UP_CASE_OID上位案件オブジェクトIDBWF_caseid_tオブジェクトID型
22BWF_DOWN_CASE_COUNT下位案件数unsigned longunsigned long型
23BWF_STATUS_CODE_1処理状態コードchar[4]char型
24BWF_STATUS_CODE_2遷移状態コードchar[4]char型
25BWF_CURRENT_NODE_IDカレントノードIDBWF_nodeno_tオブジェクトID型
26BWF_PRIORITY_CODE優先度char[4]char型
27BWF_PROCESS_KIND_CODE案件処理種別char[4]char型
28BWF_ATTR_CHAR_1ユーザ属性1char[32]char型
29BWF_ATTR_CHAR_2ユーザ属性2char[32]char型
30BWF_ATTR_CHAR_3ユーザ属性3char[32]char型
31BWF_ATTR_CHAR_4ユーザ属性4char[32]char型
32BWF_ATTR_CHAR_5ユーザ属性5char[32]char型
33BWF_ATTR_INT_1ユーザ属性6longlong型
34BWF_ATTR_INT_2ユーザ属性7longlong型
35BWF_ATTR_INT_3ユーザ属性8longlong型
36BWF_ATTR_INT_4ユーザ属性9longlong型
37BWF_ATTR_INT_5ユーザ属性10longlong型
38BWF_ATTR_TIME_1ユーザ属性11(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
39BWF_ATTR_TIME_2ユーザ属性12(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
40BWF_ATTR_TIME_3ユーザ属性13(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
41BWF_ATTR_TIME_4ユーザ属性14(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
42BWF_ATTR_TIME_5ユーザ属性15(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
43BWF_EXATTR_CHAR_COUNT文字型ユーザ属性数(六つ目以降の数)unsigned longunsigned long型
44BWF_EXATTR_INT_COUNT整数型ユーザ属性数(六つ目以降の数)unsigned longunsigned long型
45BWF_EXATTR_TIME_COUNT日時型ユーザ属性数(六つ目以降の数)unsigned longunsigned long型
46BWF_USER_STATUS任意ユーザ状態コードchar[16]char型
47BWF_BROADCAST_STATUS同報状態コードchar[4]char型
48BWF_EXCEPT_REQ_USER_OID例外要求元ユーザオブジェクトIDBWF_useroid_tオブジェクトID型
49BWF_TITLE案件タイトルchar[64]char型
50BWF_CLIENT_OID代行元ユーザオブジェクトIDBWF_useroid_tオブジェクトID型
51BWF_TRAY_ARRIVAL_TIMEトレー到着日時(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
52BWF_ROLE_NAMEロール名称char[64]char型
53BWF_OPLISTN_COUNTこのノードでのユーザ処理リスト数unsigned
long
unsigned
long型
54BWF_CASE_SIZE_SIMPLE_TYPE案件保存ファイルサイズ(簡易形式)unsigned
long
unsigned
long型
55BWF_AD_REQUESTER_NKNAME投入者Groupmax Addressニックネームchar[132]char型
56BWF_AD_REQUESTER_NAME投入者Groupmax Address日本語名char[36]char型
57BWF_AD_REQUESTER_SECTION投入者Groupmax Address所属組織略称char[36]char型
58BWF_AD_REQUESTER_POST投入者Groupmax Address役職char[36]char型
59BWF_AD_EXCEPT_REQ_NKNAME例外処理要求者
Groupmax Address
ニックネーム
char[132]char型
60BWF_AD_EXCEPT_REQ_NAME例外処理要求者
Groupmax Address
日本語名
char[36]char型
61BWF_AD_EXCEPT_REQ_SECTION例外処理要求者
Groupmax Address
所属組織略称
char[36]char型
62BWF_AD_EXCEPT_REQ_POST例外処理要求者
Groupmax Address役職
char[36]char型
63BWF_AD_CLIENT_NKNAME代行元Groupmax Addressニックネームchar[132]char型
64BWF_AD_CLIENT_NAME代行元Groupmax Address日本語名char[36]char型
65BWF_AD_CLIENT_SECTION代行元Groupmax Address所属組織略称char[36]char型
66BWF_AD_CLIENT_POST代行元Groupmax Address役職char[36]char型
67BWF_CS_ERROR_CODEエラーコードchar[8]char型
68BWF_CS_ERROR_RECOVER_LEVEL復帰可否レベルchar[4]char型
69BWF_CS_BP_TYPEビジネスプロセス定義種別char[4]char型
70BWF_SOURCE_CASE_OID登録サーバ上の案件オブジェクトIDBWF_case_tオブジェクトID型
(p) 選択条件内項目
項目内容
BWF_attr_name絞り込む対象とする案件情報項目識別子を指定します。
取得案件情報項目の項番1~51が指定できます。
BWF_attr_operator属性値との比較の演算子を,次に示すキーで指定します。
BWF_EQ_ATTR_OPERATOR:等しい
BWF_NE_ATTR_OPERATOR:等しくない
BWF_GT_ATTR_OPERATOR:より大きい
BWF_GE_ATTR_OPERATOR:以上
BWF_LT_ATTR_OPERATOR:未満
BWF_LE_ATTR_OPERATOR:以下
BWF_attr_value_oidオブジェクトID型の属性値を指定します。
BWF_attr_value_charchar型の属性値を指定します(終端にNULL文字を付けた,最大64バイトの文字列を指定してください)。
BWF_attr_value_longlong型の属性値を指定します(-2147483648​~2147483647​までの整数を指定してください)。
BWF_attr_value_ulongunsigned long型の属性値を指定します(0~4294967295​までの整数を指定してください)。
BWF_attr_value_timeBWF_time_t型の属性値を指定します(YYYYMMDDhhmmss形式で,指定してください)。
(q) 上位案件項目リスト内項目
(凡例)
有:データが設定されていた場合,そのデータに意味があります。
無:データが設定されていた場合,そのデータに意味はありません。
案件情報項目識別子内容案件種別別意味有無
ルート単独下位
BWF_CASE_OID案件オブジェクトIDが設定されます。
BWF_CASE_NAMEBWF_CASE_OIDに対応する案件の案件名称が設定されます。
BWF_CASE_ALIAS_NAMEBWF_CASE_OIDに対応する案件があるノード名が設定されます。また,ビジネスプロセス定義でBWF_CASE_OIDに対応する案件があるノードに,作業案件名が設定されている場合は,作業案件名が設定されます。
BWF_TRANSACTION_IDBWF_CASE_OIDに対応する案件のトランザクションIDが設定されます。
BWF_USER_KEYHwfPutCase発行時に指定した,ワークID(案件識別子フォーマット)が設定されます。
BWF_CREATE_NAMEBWF_CASE_OIDに対応する案件を作成したユーザのユーザ名称が設定されます。ルート案件に関しては,Groupmax Workflow Serverを起動したユーザのユーザ名称が設定されます。
BWF_CREATE_USER_OIDBWF_CASE_OIDに対応する案件を作成したユーザのユーザオブジェクトIDが設定されます(ただし,拡張ビジネスプロセス定義の案件では,ユーザオブジェクトIDは設定されていません)。
BWF_CREATE_TIMEBWF_CASE_OIDに対応する案件を作成した日付が設定されます(日付は,YYYYMMDDhhmmss形式となります)。
BWF_ARRIVAL_TIMEBWF_CASE_OIDに対応する案件が,BWF_CURRENT_NODE_IDに,到着した日付が設定されます(日付は,YYYYMMDDhhmmss形式となります)。
BWF_PROCESS_LIMIT_TIMEHwfPutCase発行時に指定した処理期限が設定されます(期限は,YYYYMMDDhhmmss形式となります)。
BWF_BP_NAMEBWF_BP_OIDに対応するビジネスプロセス定義名称が設定されます。
BWF_BP_OIDBWF_CASE_OIDに対応する案件を投入した,ビジネスプロセス定義のビジネスプロセス定義オブジェクトIDが設定されます。
BWF_BP_VERSION_NUMBERBWF_CASE_OIDに対応する案件を投入した,ビジネスプロセス定義のバージョン番号が設定されます。
BWF_MEMO_OBJECT_COUNTBWF_CASE_OIDに対応する案件と,その案件下にある文書すべてに貼り付けられたメモ数が設定されます。
BWF_REPORT_OBJECT_COUNTBWF_CASE_OIDに対応する案件に格納されている文書の数が設定されます。なお,BWF_CASE_CLASS_KIND_CODEがルート案件の場合は,何も設定されません。
BWF_TRAY_KIND_CODEBWF_CASE_OIDに対応する案件があるトレーの種別が設定されます。
user:ユーザトレー
role:ロールトレー
すべてNULL文字:制御ノード
mang:マネージャトレー
send:サーバ間転送トレー
inwf:ドメイン間連携トレー
BWF_USER_OIDBWF_CASE_OIDに対応する案件がユーザトレー上にある場合,そのトレーに対応するユーザのユーザオブジェクトIDが設定されます。
BWF_ROLE_OIDBWF_CASE_OIDに対応する案件があるロールのロールオブジェクトIDが設定されます。遷移先がユーザ又は,制御ノードの場合は,すべてNULL文字が設定されます。
BWF_WORK_OIDBWF_CASE_OIDに対応する案件が関連するワークのワークオブジェクトIDが設定されます。
BWF_CASE_CLASS_KIND_CODEBWF_CASE_OIDに対応する案件の階層種別が設定されます。
sys△:ルート案件
gen△:一般案件(単独/下位案件)
注 △はスペースを示します。
BWF_UP_CASE_OID上位にルート案件がある場合は,ルート案件の案件オブジェクトIDが設定されます(ルート案件又は,単独の一般案件の場合は,すべてNULL文字が設定されます)。
BWF_DOWN_CASE_COUNTルート案件の場合,下位にある一般(下位)案件の数が設定されます。
BWF_STATUS_CODE_1BWF_CASE_OIDに対応する案件の処理状態コードが設定されます。
move:ノード間遷移中
wait:ユーザ処理待ち
proc:ユーザ処理中
resv:ユーザ処理保留中
nop△:案件未投入状態
movw:待合ノードでの同一ワークID(案件識別子フォーマット)案件の待ち合わせ状態
movc:同報案件の回収中
send:他サーバへ送信中
inwf:ドメイン間連携中
注 △はスペースを示します。
BWF_STATUS_CODE_2BWF_CASE_OIDに対応する案件の遷移状態コードが設定されます。
act△:動作可能状態
can△:取消予約状態
sup△:動作中断状態
err△:エラー発生状態
sink:終了状態
warn:警告状態
prsk:連携先終了前状態
注 △はスペースを示します。
BWF_CURRENT_NODE_IDBWF_CASE_OIDに対応する案件が存在するノードIDが設定されます。
BWF_PRIORITY_CODEHwfPutCase発行時に指定した優先度が設定されます。
com△:普通を示します。
urg△:至急を示します。
注 △はスペースを示します。
BWF_PROCESS_KIND_CODEBWF_CASE_OIDに対応する案件が,BWF_CURRENT_NODE_IDに示すノードに遷移するにあたって,前ノードでどのような状態で処理されたかを示します。
ord△:通常処理
exc△:例外処理(相談)
exca:例外処理(相談途中での回答)
exa△:例外処理(回答)
exsb:例外処理(差し戻し)
extb:例外処理(引き戻し)
注 △はスペースを示します。
通常処理
ビジネスプロセス定義で定義された処理の流れ通りに遷移されてきたことを示します。
例外処理
ビジネスプロセス定義で定義された処理の流れ以外の流れで遷移してきたことを示します。
BWF_ATTR_CHAR_1ユーザ任意の文字列データが設定できる文字型ユーザ属性で,HwfPutCase,HwfSetCase,HwfSetCaseByUserDefNameで指定された情報が設定されます。文字列データは,最大31バイトまで設定され,NULL文字で終端します(初期値としては,NULL文字だけが設定されます)。
BWF_ATTR_CHAR_2BWF_ATTR_CHAR_1と同様です。
BWF_ATTR_CHAR_3BWF_ATTR_CHAR_1と同様です。
BWF_ATTR_CHAR_4BWF_ATTR_CHAR_1と同様です。
BWF_ATTR_CHAR_5BWF_ATTR_CHAR_1と同様です。
BWF_ATTR_INT_1ユーザ任意の整数データが設定できる整数型ユーザ属性で,HwfPutCase,HwfSetCase,HwfSetCaseByUserDefNameで指定された情報が設定されます。整数データは,-2147483647​~2147483647​の範囲で設定されます(初期値として,0が設定されます)。
BWF_ATTR_INT_2BWF_ATTR_INT_1と同様です。
BWF_ATTR_INT_3BWF_ATTR_INT_1と同様です。
BWF_ATTR_INT_4BWF_ATTR_INT_1と同様です。
BWF_ATTR_INT_5BWF_ATTR_INT_1と同様です。
BWF_ATTR_TIME_1ユーザ任意の日時データが設定できる日時型ユーザ属性で,HwfPutCase,HwfSetCase,HwfSetCaseByUserDefNameで指定された情報が設定されます(日付は,YYYYMMDDhhmmss形式となり,初期値として”19700101090000​”が設定されています)。
BWF_ATTR_TIME_2BWF_ATTR_TIME_1と同様です。
BWF_ATTR_TIME_3BWF_ATTR_TIME_1と同様です。
BWF_ATTR_TIME_4BWF_ATTR_TIME_1と同様です。
BWF_ATTR_TIME_5BWF_ATTR_TIME_1と同様です。
BWF_EXATTR_CHAR_COUNTBWF_CASE_OIDに対応する,案件に設定できる文字型ユーザ属性の六つ目以降の数が,設定されます。
BWF_EXATTR_INT_COUNTBWF_CASE_OIDに対応する,案件に設定できる整数型ユーザ属性の六つ目以降の数が,設定されます。
BWF_EXATTR_TIME_COUNTBWF_CASE_OIDに対応する,案件に設定できる日時型ユーザ属性の六つ目以降の数が,設定されます。
BWF_USER_STATUSBWF_CASE_OIDに対応する,案件にユーザが任意に設定する状態コードが,設定されます(この領域に任意に状態コードを設定しても,HwfSuffixCase,HwfSimpleGoCaseを発行するとNULLクリアされます)。
BWF_BROADCAST_STATUSBWF_CASE_OIDに対応する案件が,同報中か通常処理中のどちらかを示します。
すべてNULL文字:通常処理
bdc△:同報中
movc:回収待ち
注 △はスペースを示します。
BWF_EXCEPT_REQ_USER_OIDBWF_CASE_OIDに対応する案件に対して,直前に相談/差し戻し/回答したユーザのユーザオブジェクトIDが設定されます(ただし,拡張ビジネスプロセス定義の案件では,ユーザオブジェクトIDは設定されていません)。
BWF_TITLEBWF_WORK_OIDに対応する,ワークに設定された案件タイトルが設定されます(タイトルは,HwfPutCase,HwfSimplePutCaseで案件の投入時に指定した場合だけ設定されます)。
BWF_CLIENT_OIDBWF_USER_OIDに対応する案件を投入したビジネスプロセス定義の種別が,拡張ビジネスプロセス定義の場合,すべてNULL文字が設定されます。
BWF_USER_OIDに対応する案件を投入したビジネスプロセス定義の種別が,ビジネスプロセス定義で,かつ,代行者に配布された場合,代行元のユーザオブジェクトIDが設定されます。代行者に配布されていない場合,すべてNULL文字が設定されます。
BWF_TRAY_ARRIVAL_TIMEBWF_CASE_OIDに対応する案件がトレーに到着した日付が設定されます(日付は,YYYYMMDDhhmmss形式となります)。
BWF_ROLE_NAMEBWF_ROLE_OIDに対応するロールのロール名称が設定されます。遷移先がユーザ,又は制御ノードの場合は,すべてNULL文字が設定されます。
BWF_OPLISTN_COUNTBWF_CASE_OIDに対応する案件に対して現在のノードで定義されているユーザ処理リストの数を設定します。
BWF_CASE_SIZE_SIMPLE_TYPE案件を保存する場合に必要なファイルサイズを設定します。 
BWF_AD_REQUESTER_NKNAMEGroupmax Addressで管理する案件投入者のニックネームを設定します。上位案件の場合,初期投入ユーザのニックネームが設定されます。
BWF_AD_REQUESTER_NAMEGroupmax Addressで管理する案件投入者の日本語名を設定します。上位案件の場合,初期投入ユーザの日本語名が設定されます。
BWF_AD_REQUESTER_SECTIONGroupmax Addressで管理する案件投入者の所属組織の略称を設定します。上位案件の場合,初期投入ユーザの所属組織の略称が設定されます。
BWF_AD_REQUESTER_POSTGroupmax Addressで管理する案件投入者の役職を設定します。上位案件の場合,初期投入ユーザの役職が設定されます。
BWF_AD_EXCEPT_REQ_NKNAMEGroupmax Addressで管理する例外処理要求者のニックネームを設定します。
BWF_AD_EXCEPT_REQ_NAMEGroupmax Addressで管理する例外処理要求者の日本語名を設定します。
BWF_AD_EXCEPT_REQ_SECTIONGroupmax Addressで管理する例外処理要求者の所属組織の略称を設定します。
BWF_AD_EXCEPT_REQ_POSTGroupmax Addressで管理する例外処理要求者の役職を設定します。
BWF_AD_CLIENT_NKNAMEGroupmax Addressで管理する代行元ユーザのニックネームを設定します。
BWF_AD_CLIENT_NAMEGroupmax Addressで管理する代行元ユーザの日本語名を設定します。
BWF_AD_CLIENT_SECTIONGroupmax Addressで管理する代行元ユーザの所属組織の略称を設定します。
BWF_AD_CLIENT_POSTGroupmax Addressで管理する代行元ユーザの役職を設定します。
BWF_CS_ERROR_CODEエラー案件の場合のエラーコードを設定します。BWF_STATUS_CODE_2が”err△”の場合,又はBWF_STATUS_CODE_1が”nop△”の場合だけ意味を持ちます。
エラーコードはメッセージIDと同じものが格納されます。
BWF_CS_ERROR_RECOVER_LEVELエラー案件がビジネスプロセス定義に復帰できるレベルのものかどうかを示します。
rcok:復帰できる可能性があります。
rcng:復帰できません。
NULL(0x00000000​):正常処理。
BWF_CS_BP_TYPEビジネスプロセス定義種別を設定します。
NULL:ビジネスプロセス定義
ind△:拡張ビジネスプロセス定義
注 △はスペースを示します。
BWF_SOURCE_CASE_OIDBWF_CASE_OIDに対応する案件を投入したビジネスプロセス定義の種別が,拡張ビジネスプロセス定義である場合,ビジネスプロセス登録サーバ上の案件オブジェクトIDが設定されます。
ビジネスプロセス定義の場合は,8バイトのNULL文字が設定されます。
(r) 案件情報リスト要素の項目(HwfSimplePreCase)
項目内容
casename指定した案件オブジェクトIDにある案件の案件名を出力します。
caseoid案件名(casename)に対応する案件の案件オブジェクトIDが設定されます。
casetype案件名に対応する案件の案件種別を出力します。種別を次に示します。
0:単独案件を示します。
1:下位案件を示します。
number_oplist出力するユーザ処理リストの先頭要素は,サーバ側のユーザ処理リストの何番目の要素かを入力します。
oplistn出力するユーザ処理リストの要素数を入力します。0以下の値を入力するとユーザ処理リストは出力しません。
docfilelistn出力する文書ファイル情報リストの要素数を入力します。0以下の値を入力すると文書ファイル情報リストは出力しません。
memofilelistn出力するメモファイル情報リストの要素数を入力します。0以下の値を入力するとメモファイル情報リストは出力しません。
oplist_totalユーザ処理リストの総数が出力されます。
get_oplistn出力したユーザ処理リストの要素数を出力します。
get_oplistユーザ処理リストを出力します。oplistn>0で,かつget_oplistn>oplistnの場合,この関数の動作は保証できません。
ユーザ処理リストについては,ユーザ処理リスト内項目を参照してください。
docfile_total案件オブジェクトID(caseoid)に対応する案件に格納されている総文書数を出力します。
get_docfilelistn出力した文書ファイル情報リストの要素数を出力します。
get_docfilelist文書ファイル情報リストを出力します。docfilelistn>0で,かつget_docfilelistn>docfilelistnの場合,この関数の動作は保証できません。
文書ファイル情報リストについては,文書,又はメモファイル情報リストの項目を参照してください。
memofile_total案件オブジェクトID(caseoid)に対応する案件に格納されているメモの総数を出力します。
get_memofilelistn出力したメモファイル情報リストの要素数を出力します。
get_memofilelistメモファイル情報リストを出力します。memofilelistn>0でなく,かつget_memofilelistn>memofilelistnの場合,この関数の動作は保証できません。
メモファイル情報リストについては,文書,又はメモファイル情報リストの項目を参照してください。
(s) 案件情報リスト要素の項目(HwfPrefixCase)
項目内容
casename指定した案件オブジェクトIDにある案件の案件名を出力します。
caseoid案件名(casename)に対応する案件の案件オブジェクトIDが設定されます。
casetype案件名に対応する案件の案件種別を出力します。種別を次に示します。
0:単独案件を示します。
1:下位案件を示します。
number_oplist出力するユーザ処理リストの先頭要素は,サーバ側のユーザ処理リストの何番目の要素かを入力します。
oplistn出力するユーザ処理リストの要素数を入力します。0以下の値を入力するとユーザ処理リストは出力しません。
docfilelistn出力する文書ファイル情報リストの要素数を入力します。0以下の値を入力すると文書ファイル情報リストは出力しません。
datamemofilelistn出力するメモファイル情報リストの要素数を入力します。0以下の値を入力するとメモファイル情報リストは出力しません。
oplist_totalユーザ処理リストの総数が出力されます。
get_oplistn出力したユーザ処理リストの要素数を出力します。
get_oplistユーザ処理リストを出力します。oplistn>0で,かつget_oplistn>oplistnの場合,この関数の動作は保証できません。
ユーザ処理リストについては,ユーザ処理リスト内項目を参照してください。
docfile_total案件オブジェクトID(caseoid)に対応する案件に格納されている総文書数を出力します。
get_docfilelistn出力した文書ファイル情報リストの要素数を出力します。
get_docfilelist文書ファイル情報リストを出力します。docfilelistn>0で,かつget_docfilelistn>docfilelistnの場合,この関数の動作は保証できません。
文書ファイル情報リストについては,文書,又はメモファイル情報リストを参照してください。
datamemofile_total案件オブジェクトID(caseoid)に対応する案件に格納されているメモの総数を出力します。
get_datamemofilelistn出力したメモファイル情報リストの要素数を出力します。
get_datamemofilelistメモファイル情報リストを出力します。datamemofilelistn>0でなく,かつget_datamemofilelistn>datamemofilelistnの場合,この関数の動作は保証できません。
メモファイル情報リストについては,文書,又はメモファイル情報リストを参照してください。
lock文書ロック結果を格納します。
OK△△:ロックの取得に成功しました。文書,メモの更新処理ができます。
NG△△:ロックの取得に失敗しました。文書,メモの更新処理はできません。
(t) 文書,又はメモファイル情報リストの項目(HwfSimplePreCase)
項目内容
outfilenameフルパスを指定したファイル名称。
oldnameファイルを登録したときにファイルに付けた名称。
filetypeメモの種別。
NULL(0x00000000​):データオブジェクトとして添付されたメモです。
file:ファイルとして添付されたメモです。
文書の場合は,この種別の値は不定です。
注意事項
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
(u) 文書,又はメモファイル情報リスト(HwfPrefixCase)
項目内容
memotypeメモの種別を格納します。
F:ファイルとして添付されたメモです。
D:データオブジェクトとして添付されたメモです。
S:Groupmax Integrated Desktopの本文に表示されるメモとして添付されたメモです。
file_idファイル識別子を取得します。
HwfGetCaseDocumentで後で添付された文書,メモを取得したり,HwfUpdateCaseDocumentで更新する場合,この識別子を使用します。
outfilenameフルパスを指定したファイル名称を取得します。
filenameファイルを登録したときにファイルに付けた名称を取得します。
datamemonメモの種別がDの場合,データメモのページ数を格納します。
注1
バージョン1,及び02-00で格納した文書,メモの場合,outfilenameに格納されているファイル名称はすべて"upload.dat"に変更されます。登録したときのファイル名称は,filenameに格納されます。
注2
06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
詳しくはファイル名の注意事項を参照してください。

(v) 文書,又はメモ更新情報リスト(HwfSimpleGoCase)
項目内容
type更新種別を指定します。
A:添付
D:削除
U:更新
outfilename添付・更新する文書,又はメモをフルパスで指定します。更新種別が削除の場合,指定する必要はありません。
oldnameoutfilenameのうちファイル名称だけを指定します。更新種別が削除の場合,指定する必要はありません。
filetypeメモを添付・削除・更新する場合の種別を指定します。
file:ファイルとして添付します。
NULL(0x00000000​):データオブジェクトとして添付します。
データオブジェクトのデータ形式は次のようにしてください。
  • 終端にNULL文字を付けた32キロバイト以下の文字列形式で指定してください。
  • 案件中(下位案件がある場合は,下位案件中)に一つだけ指定できます。
  • 同報中にサイズを変更しないでください。
文書を添付する場合,この種別は使用しません。すべて”file”として添付します。
注1
同報中に文書,又はメモの削除はできません。また,同報中に文書,又はメモを添付した場合,その案件が回収されるまでは同じルート内の作業机からだけ参照できます。
注2
06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
詳しくはファイル名の注意事項を参照してください。

(w) 文書,又はメモ更新情報リスト(HwfSuffixCase)
項目内容
type更新種別を指定します。
A:添付
D:削除
U:更新
memotypeメモの種別を指定します。文書では指定する必要はありません。
F:メモとしてファイルを添付します。
D:データオブジェクトとして添付します。
データオブジェクトはデータベースで管理されるため,回復対象となりますが,ジャーナルが増えるので注意が必要です。データオブジェクトのデータ形式は次のようにしてください。
  • 終端にNULL文字を付けた32キロバイト以内の文字列形式で指定してください。
  • 案件中に一つ以下でなければなりません。
S:Groupmax Integrated Desktopの本文に表示されるメモとして添付します。この種別のメモは案件内で一つでなければなりません。
file_id削除,更新する文書,メモの識別子を指定します。添付の場合は指定する必要はありません。
outfilename添付・更新する文書,又はメモをフルパスで指定します。更新種別が削除の場合,指定する必要はありません。
oldnameoutfilenameのうちファイル名称だけを指定します。更新種別が削除の場合,指定する必要はありません。
注1
同報中に文書,又はメモの削除はできません。また,同報中に文書,又はメモを添付した場合,その案件が回収されるまでは同じルート内の作業机からだけ参照できます。
注2
データオブジェクトは,同報中にサイズを変更しないでください。
注3
ロングファイル名称で登録した文書やメモを参照するときに,Groupmax Desktop(16bit版),Groupmax Workflow - Library バージョン1から02-00まで,又はGroupmax Workflow - Library 02-10以降でバージョン1との互換用関数を使用すると,そのファイル名称は次のように変換されます。
・ファイル名は,先頭から8バイトが抽出されます。
・拡張子は,先頭から3バイトが抽出されます。
・半角の[,],;,+,=,及び,は,~に変換されます。
また,Groupmax Workflow Serverのバージョンが02-10のときにロングファイル名称で登録した文書,メモは,それぞれ"wfdoc.dat","wfmemo.dat"という名称に変換されます。
注4
06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
詳しくはファイル名の注意事項を参照してください。

(x) 遷移案件情報リスト要素の項目(HwfSimpleGoCase)
項目内容
casename処理する案件名を指定します。
userattrlistn設定するユーザ属性数を指定します。0以下の値を指定するとuserattrlistの値を無視します。
userattrlist設定するユーザ属性を指定します。userattrlistn≦0なら,指定した値は無効となります。userattrlistnとcaseinflistの要素数は一致させてください。userattrlistn>0で,かつuserattrlistn>(userattrlistの要素数)の場合,この関数の動作は保証できません。
ユーザ属性については,エンドユーザ属性リスト内項目を参照してください。
update_docfilen更新する文書数を指定します。0以下の値を指定するとupdate_docfileの値を無視します。
update_docfile文書更新情報リストを指定します。update_docfilen≦0なら,指定した値は無効となります。update_docfilenとupdate_docfileの要素数は一致させてください。update_docfilen>0で,かつupdate_docfilen>(update_docfileの要素数)の場合,この関数の動作は保証できません。
文書更新情報リストについては,文書,又はメモ更新情報リストを参照してください。
update_memofilen更新するメモ数を指定します。0以下の値を指定するとupdate_memofileの値を無視します。
update_memofileメモ更新情報リストを指定します。update_memofilen≦0なら,指定した値は無効となります。update_memofilenとupdate_memofileの要素数は一致させてください。update_memofilen>0で,かつupdate_memofilen>(update_memofileの要素数)の場合,この関数の動作は保証できません。
メモ更新情報リストについては,文書,又はメモ更新情報リストを参照してください。
(y) 遷移案件情報リスト要素内の項目(HwfSuffixCase)
項目内容
caseoid次ノードへ遷移させる案件の案件オブジェクトIDを指定します。案件オブジェクトIDは,HwfGetCaseSelectData,又はHwfGetGsTakeOverDataで取得できます。案件に複数の下位案件がある場合,上位案件を指定してください。
mode遷移のモード(0:保留,1:遷移,2:取り消し)を指定します。保留の場合もユーザ属性設定と文書とメモの更新をします。
0:案件処理を保留します。指定したユーザ属性の設定・文書とメモの更新はします。
1:案件を次ノードへ遷移します。指定したユーザ属性の設定・文書とメモの更新をします。案件が他ユーザから相談された案件のときは一つ前の相談者に回答します。
2:案件処理を取り消します。指定されたユーザ属性の設定・添付ファイルの更新はしません。
また,遷移案件情報リスト数には0を,遷移案件情報リストにはNULLを指定してください。
 
遷移案件情報リスト数には0を,遷移案件情報ルートにはNULLを指定しください。
nextusernnextuserで指定する次ノードの処理ユーザ数を指定します。
0以下の値を指定すると,nextuserの値を無視します。
nextuser次ノードの処理ユーザをBWF_nextuser_t構造体で指定します。次ノード処理ユーザの情報については,次ノード処理ユーザ情報を参照してください。
priority変更する優先度を格納した領域を指定します。自分が投入した案件に対してだけ指定できます。
0:普通
1:至急
変更する必要がない場合は,NULLアドレスを指定してください。
limit変更する処理期限(日時)を格納した領域を指定します。自分が投入した案件に対してだけ指定できます。形式はYYYYMMDDhhmmss形式の14バイトの文字列となり,指定可能範囲は1970年1月1日10:00:00から2038年1月19日03:14:07までです。変更する必要がない場合は,NULLアドレスを指定してください。
caseinflistn入力する案件情報リストの要素数を指定します。0以下の値を指定すると案件情報リスト(caseinflist)の値は無効になります。
caseinflist案件詳細情報リストを設定した領域を指定します。caseinflistnが0以下の値なら,指定した値は無効となります。caseinflistnとcaseinflistの要素数は一致させてください。caseinflistn>0で,かつcaseinflistn>(caseinflistの要素数)の場合,この関数の動作は保証できません。
案件詳細情報リストについては,遷移案件詳細情報リスト要素内の項目を参照してください。
(z) 遷移案件詳細情報リスト要素内の項目(HwfSuffixCase)
項目内容
casename処理する案件名を指定します。
userattrlistn設定するユーザ属性数を指定します。
0以下の値を指定するとuserattrlistの値を無視します。
userattrlist設定するユーザ属性を指定します。
userattrlistn≦0なら,指定した値は無効となります。userattrlistnとuserattrlistの要素数は一致させてください。userattrlistn>0で,かつuserattrlistn>(userattrlistの要素数)の場合,この関数の動作は保証できません。
ユーザ属性については,エンドユーザ属性リスト内項目を参照してください。
update_docfilen更新する文書数を指定します。
0以下の値を指定するとupdate_docfileの値を無視します。
update_docfile文書更新情報リストを指定します。
update_docfilen≦0なら,指定した値は無効となります。update_docfilenとupdate_docfileの要素数は一致させてください。update_docfilen>0で,かつupdate_docfilen>(update_docfileの要素数)の場合,この関数の動作は保証できません。
文書更新情報リストについては,文書,又はメモ更新情報リストを参照してください。
update_memofilen更新するメモ数を指定します。
0以下の値を指定するとupdate_memofileの値を無視します。
update_memofileメモ更新情報リストを指定します。
update_memofilen≦0なら,指定した値は無効となります。update_memofilenとupdate_memofileの要素数は一致させてください。update_memofilen>0で,かつupdate_memofilen>(update_memofileの要素数)の場合,この関数の動作は保証できません。
メモ更新情報リストについては,文書,又はメモ更新情報リストを参照してください。

(9) ユーザトレー内案件属性操作AP関数

(a) HwfGetAttributeValueByAttributeName(属性名称指定による案件のユーザ属性取得)
機能
HwfGetCaseFormSelectEx,又はHwfGetOperationで取得した案件のユーザ属性の属性名称に対応したユーザ属性値を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetAttributeValueByAttributeName(
 BWF_useroid_t  __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,    /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far *caseid,    /* 案件オブジェクトID格納領域 (I) */
 unsigned long        listcharn,   /* 文字列型属性値取得要求個数 (I) */
 BWF_charlist_t __far *listchar,   /* 文字列型属性値取得領域 (I/O) */
 unsigned long  __far *countchar,  /* 文字列型属性値取得個数 (O) */
 unsigned long        listintn,   /* 整数型属性値の取得要求個数 (I) */
 BWF_intlist_t  __far *listint,   /* 整数型属性値取得領域 (I/O) */
 unsigned long  __far *countint,   /* 整数型属性値取得個数 (O) */
 unsigned long        listtimen,   /* 日時型属性値取得要求個数 (I) */
 BWF_timelist_t __far *listtime,   /* 日時型属性値取得領域 (I/O) */
 unsigned long  __far *counttime,  /* 日時型属性値取得個数 (O) */
 BWF_errlist_t  __far *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_charlist_t{
 char BWF_attrname[32];  /* 文字列型ユーザ属性名称格納領域 */
 char BWF_attrchar[32];  /* 文字列型ユーザ属性値取得領域   */
} BWF_charlist_t;
typedef struct BWF_intlist_t{
 char BWF_attrname[32];  /* 整数型ユーザ属性名称格納領域 */
 long BWF_attrint;     /* 整数型ユーザ属性値取得領域 */
} BWF_intlist_t;
typedef struct BWF_timelist_t{
 char BWF_attrname[32];  /* 日時型ユーザ属性名称格納領域 */
 BWF_time_t BWF_attrtime; /* 日時型ユーザ属性値取得領域 */
} BWF_timelist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];     /* メッセージ区分 */
 long lBMsgNo;       /* メッセージ番号 */
 char sBInsWord[13];    /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
ユーザ属性を取得する,案件のオブジェクトIDを指定します。単独,又は下位案件オブジェクトIDを指定してください。案件オブジェクトIDは,HwfGetCaseSelectDataなどで取得できます。
listcharn
取得する文字列型ユーザ属性数を指定します。
取得要求個数は,1以上を指定してください。0を指定した場合,取得要求はないものとし,listcharとcountcharは無視します。
listchar
文字列型ユーザ属性取得領域を指定します。
この領域には,(listcharn)×(listcharのバイト数)以上を指定してください。文字列型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_attrnameHwfGetCaseFormSelectEx,又はHwfGetOperationで取得した,案件の文字列型ユーザ属性の属性名称を指定してください(属性名称については,HwfTakeOperationInfのパラメタとして,HwfGetOperationで取得したユーザ処理リスト,又は,HwfGetCaseFormSelectExを発行して取得したフォームリストを指定することで,簡単に取得できます)。
終端には,必ずNULL文字を付けてください。
BWF_attrchar文字列型のユーザ属性値が設定されます。設定される文字列は終端にNULL文字が付けられています(NULL文字を含め,最大32バイトまで設定されます)。
countchar
取得した文字列型ユーザ属性値数を取得する領域を指定します。
listintn
取得する整数型ユーザ属性数を指定します。
取得要求個数は,1以上を指定してください。0を指定した場合,取得要求はないものとし,listintとcountintは無視します。
listint
整数型ユーザ属性取得領域を指定します。
この領域には,(listintn)×(listintのバイト数)以上を指定してください。整数型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_attrnameHwfGetCaseFormSelectEx,又はHwfGetOperationで取得した,案件の整数型ユーザ属性の属性名称を指定してください(属性名称については,HwfTakeOperationInfのパラメタとして,HwfGetOperationで取得したユーザ処理リスト,又はHwfGetCaseFormSelectExを発行して取得したフォームリストを指定することにで,簡単に取得できます)。
終端には,必ずNULL文字を付けてください。
BWF_attrint整数型のユーザ属性値が設定されます。
countint
取得した整数型ユーザ属性値数を取得する領域を指定します。
listtimen
取得する日時型ユーザ属性数を指定します。
取得要求個数は,1以上を指定してください。0を指定した場合,取得要求はないものとし,listtimeとcounttimeは無視します。
listtime
日時型ユーザ属性取得領域を指定します。この領域には,(listtimen)×(listtimeのバイト数)以上を指定してください。
日時型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_attrnameHwfGetCaseFormSelectEx,又はHwfGetOperationで取得した,案件の日時型ユーザ属性の属性名称を指定してください(属性名称については,HwfTakeOperationInfのパラメタとして,HwfGetOperationで取得したユーザ処理リスト,又はHwfGetCaseFormSelectExを発行して取得したフォームリストを指定することによって,簡単に取得できます。終端には,必ずNULL文字を付けてください。
BWF_attrtime日時型のユーザ属性値が設定されます(YYYYMMDDhhmmss形式となります)。
counttime
取得した日時型ユーザ属性値数を取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 取得したユーザ属性にデータが未設定の場合は,初期値が返ります。各ユーザ属性の初期値を次に示します。
    属性種別初期値
    文字列型char32バイトすべてNULL文字
    整数型long0
    日時型BWF_time_t"19700101090000​"
  • このAPI関数の戻り値がエラーリターン(BWF_ERROR)で,エラー情報取得領域内のメッセージ番号にBWE_OUT_RANGEが設定されていた場合,各ユーザ属性の取得個数には取得可能個数を設定します。
  • listchar,listint,listtimeのどれかに存在しないユーザ属性の属性名称が指定されていた場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • listcharn,listintn,listtimenが,合わせて700件を超える指定はできません。
  • caseidには,単体案件の場合は単体案件の案件オブジェクトIDを指定してください。下位案件がある場合は下位案件の案件オブジェクトIDを指定してください。
(b) HwfGetAttributeValueByUserDefName(ユーザ定義名称指定による案件のユーザ属性取得)

この関数は,バージョン2との互換用API関数です。

新しくアプリケーションを作成する場合は,HwfGetAttributeValueByUserDefNameExを使用してください。

機能
Groupmax Workflow Definerで指定した案件のユーザ定義名称によって,対応する案件のユーザ属性値を取得します。
案件のユーザ属性に対応するユーザ定義名称は,次の方法で取得できます。
  • HwfGetCaseFormSelectExで取得したフォームリスト,及びHwfGetOperationで取得したユーザ処理リスト内の作業情報から,HwfTakeOperationInfによって,ユーザ定義名称を含んだ属性情報を取り出します(詳細については,HwfTakeOperationInfを参照してください)。
  • HwfGetCaseFormSelectExで取得したフォームリスト,及びHwfGetOperationで取得したユーザ処理リスト内の作業情報から,アプリケーションが独自にユーザ定義名称を含んだ属性情報を取り出します(詳細については,HwfGetCaseFormSelectEx,又はHwfGetOperationを参照してください)。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetAttributeValueByUserDefName(
 BWF_useroid_t      __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t       __far *server,    /* サーバ名称格納領域 (I) */
 BWF_caseid_t       __far *caseid,    /* 案件オブジェクトID格納領域 (I) */
 unsigned long            listcharn,   /* 文字列型属性値取得要求個数 (I) */
 BWF_charattrlist_t __far *listchar,   /* 文字列型属性値取得領域 (I/O) */
 unsigned long      __far *countchar,  /* 文字列型属性値取得個数 (O) */
 unsigned long            listintn,   /* 整数型属性値の取得要求個数 (I) */
 BWF_intattrlist_t  __far *listint,   /* 整数型属性値取得領域 (I/O) */
 unsigned long      __far *countint,   /* 整数型属性値取得個数 (O) */
 unsigned long            listtimen,   /* 日時型属性値取得要求個数 (I) */
 BWF_timeattrlist_t  __far *listtime,  /* 日時型属性値取得領域 (I/O) */
 unsigned long      __far *counttime,  /* 日時型属性値取得個数 (O) */
 BWF_errlist_t      __far *errlist    /* エラー情報取得領域 (O) */
);

typedef struct BWF_charattrlist_t{
 char BWF_userdefname[64];  /* 文字列型ユーザ定義名称格納領域 (I) */
 char BWF_attrchar[32];    /* 文字列型ユーザ属性値取得領域 (O) */
} BWF_charattrlist_t;

typedef struct BWF_intattrlist_t{
 char BWF_userdefname[64];  /* 整数型ユーザ定義名称格納領域 (I) */
 long BWF_attrint;      /* 整数型ユーザ属性値取得領域 (O) */
} BWF_intattrlist_t;

typedef struct BWF_timeattrlist_t{
 char BWF_userdefname[64];  /* 日付型ユーザ定義名称格納領域 (I) */
 BWF_time_t BWF_attrtime;   /* 日付型ユーザ属性値取得領域 (O) */
} BWF_timeattrlist_t;

typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
ユーザ属性を取得する案件のオブジェクトIDを指定します。単独,又は下位案件オブジェクトIDを指定してください。案件オブジェクトIDは,HwfGetCaseSelectDataなどで取得できます。
listcharn
取得する文字列型ユーザ属性数を指定します。
取得要求個数は,1以上を指定してください。0を指定した場合,取得要求はないものとし,listcharとcountcharは無視します。
listchar
文字列型ユーザ属性取得領域を指定します。この領域には,(listcharn)×(listcharのバイト数)以上を指定してください。文字列型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_userdefnameHwfGetCaseFormSelectEx,又はHwfGetOperationで取得した案件の文字列型ユーザ属性のユーザ定義名称を指定してください。ユーザ定義名称の取得については,機能の説明内容を参照してください。終端には,必ずNULL文字を付けてください。
BWF_attrchar文字列型のユーザ属性値が設定されます。設定される文字列は終端にNULL文字が付けられています(NULL文字を含め最大32バイトまで設定されます)。
countchar
取得した文字列型ユーザ属性値数を取得する領域を指定します。
listintn
取得する整数型ユーザ属性数を指定します。
取得要求個数は,1以上を指定してください。0を指定した場合,取得要求はないものとし,listintとcountintは無視します。
listint
整数型ユーザ属性取得領域を指定します。
この領域には,(listintn)×(listintのバイト数)以上を指定してください。整数型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_userdefnameHwfGetCaseFormSelectEx,又はHwfGetOperationで取得した案件の整数型ユーザ属性のユーザ定義名称を指定してください。ユーザ定義名称の取得については,機能の説明内容を参照してください。終端には,必ずNULL文字を付けてください。
BWF_attrint整数型のユーザ属性値が設定されます。
countint
取得した整数型ユーザ属性値数を取得する領域を指定します。
listtimen
取得する日時型ユーザ属性数を指定します。
取得要求個数は,1以上を指定してください。0を指定した場合,取得要求はないものとし,listtimeとcounttimeは無視します。
listtime
日時型ユーザ属性取得領域を指定します。この領域には,(listtimen)×(listtimeのバイト数)以上を指定してください。
日時型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_userdefnameHwfGetCaseFormSelectEx,又はHwfGetOperationで取得した案件の日時型ユーザ属性のユーザ定義名称を指定してください。ユーザ定義名称の取得については,機能の説明内容を参照してください。終端には,必ずNULL文字を付けてください。
BWF_attrtime日時型のユーザ属性値が設定されます(YYYYMMDDhhmmss形式となります)。
counttime
取得した日時型ユーザ属性値数を取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 取得したユーザ属性にデータが未設定の場合は,初期値が返ります。各ユーザ属性の初期値を次に示します。
    属性種別初期値
    文字列型char32バイトすべてNULL文字
    整数型long0
    日時型BWF_time_t"19700101090000​"
  • このAPI関数の戻り値がエラーリターン(BWF_ERROR)で,エラー情報取得領域内のメッセージ番号にBWE_OUT_RANGEが設定されていた場合,各ユーザ属性の取得個数には取得可能個数を設定します。
  • listchar,listint,listtimeのどれかに存在しないユーザ属性のユーザ定義名称が指定されていた場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 文字列型ユーザ属性だけを取得する場合,listcharnに680件を超える指定をした場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 整数型ユーザ属性だけを取得する場合,listintnに700件を超える指定をした場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 日時型ユーザ属性だけを取得する場合,listtimenに700件を超える指定をした場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • listcharn,listintn,listtimenが,合わせて700件を超える指定をした場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • caseidには,単独案件の場合は単独案件の案件オブジェクトIDを指定してください。下位案件がある場合は下位案件の案件オブジェクトIDを指定してください。
(c) HwfGetAttributeValueByUserDefNameEx(ユーザ定義名称指定による案件のユーザ属性取得)
機能
Groupmax Workflow Definerで指定した案件のユーザ定義名称によって,対応する案件のユーザ属性値を取得します。
案件のユーザ属性に対応するユーザ定義名称は,次の方法で取得できます。
  • HwfGetCaseFormSelectExで取得したフォームリスト,及びHwfGetOperationで取得したユーザ処理リスト内の作業情報から,HwfTakeOperationInfによって,ユーザ定義名称を含んだ属性情報を取り出します(詳細については,HwfTakeOperationInfを参照してください)。
  • HwfGetCaseFormSelectExで取得したフォームリスト,及びHwfGetOperationで取得したユーザ処理リスト内の作業情報から,アプリケーションが独自にユーザ定義名称を含んだ属性情報を取り出します(詳細については,HwfGetCaseFormSelectEx,又はHwfGetOperationを参照してください)。
この関数はHwfGetAttributeValueByUserDefName関数に比べてサーバへの通信関数を減らし,性能を改善した関数です。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetAttributeValueByUserDefNameEx(
 BWF_useroid_t      __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t       __far *server,   /* サーバ名称格納領域 (I) */
 BWF_caseid_t       __far *caseid,   /* 案件オブジェクトID格納領域 (I) */
 unsigned long            listcharn,  /* 文字列型属性値取得要求個数 (I) */
 BWF_charattrlist_t __far *listchar,  /* 文字列型属性値取得領域 (I/O) */
 unsigned long      __far *countchar,  /* 文字列型属性値取得個数 (O) */
 unsigned long            listintn,   /* 整数型属性値の取得要求個数 (I) */
 BWF_intattrlist_t  __far *listint,   /* 整数型属性値取得領域 (I/O) */
 unsigned long      __far *countint,  /* 整数型属性値取得個数 (O) */
 unsigned long            listtimen,  /* 日時型属性値取得要求個数 (I) */
 BWF_timeattrlist_t __far *listtime,  /* 日時型属性値取得領域 (I/O) */
 unsigned long      __far *counttime,  /* 日時型属性値取得個数 (O) */
 BWF_errlist_t      __far *errlist,   /* エラー情報取得領域 (O) */
 void               __far *arg     /* 拡張用領域 (I)*/
);

typedef struct BWF_charattrlist_t{
 char BWF_userdefname[64];  /* 文字列型ユーザ定義名称格納領域 (I) */
 char BWF_attrchar[32];    /* 文字列型ユーザ属性値取得領域 (O) */
} BWF_charattrlist_t;

typedef struct BWF_intattrlist_t{
 char BWF_userdefname[64];  /* 整数型ユーザ定義名称格納領域 (I) */
 long BWF_attrint;      /* 整数型ユーザ属性値取得領域 (O) */
} BWF_intattrlist_t;

typedef struct BWF_timeattrlist_t{
 char BWF_userdefname[64];  /* 日付型ユーザ定義名称格納領域 (I) */
 BWF_time_t BWF_attrtime;   /* 日付型ユーザ属性値取得領域 (O) */
} BWF_timeattrlist_t;

typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
ユーザ属性を取得する案件のオブジェクトIDを指定します。単独,又は下位案件オブジェクトIDを指定してください。案件オブジェクトIDは,HwfGetCaseSelectDataなどで取得できます。
listcharn
取得する文字列型ユーザ属性数を指定します。
取得要求個数は,0~100の範囲で指定してください。0を指定した場合,引数listcharと引数countcharはNULLを指定してください。
listchar
文字列型ユーザ属性取得領域を指定します。この領域には,(listcharn)×(listcharのバイト数)以上を指定してください。引数listcharnに0を指定した場合,NULLを指定してください。文字列型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_userdefnameHwfGetCaseFormSelectEx,又はHwfGetOperationで取得した案件の文字列型ユーザ属性のユーザ定義名称を指定してください。ユーザ定義名称の取得については,機能の説明内容を参照してください。終端には,必ずNULL文字を付けてください。
BWF_attrchar文字列型のユーザ属性値が設定されます。設定される文字列は終端にNULL文字が付けられています(NULL文字を含め最大32バイトまで設定されます)。
countchar
取得した文字列型ユーザ属性値数を取得する領域を指定します。引数listcharnに0を指定した場合,NULLを指定してください。
listintn
取得する整数型ユーザ属性数を指定します。
取得要求個数は,0~100の範囲で指定してください。0を指定した場合,引数listintと引数countintはNULLを指定してください。
listint
整数型ユーザ属性取得領域を指定します。
この領域には,(listintn)×(listintのバイト数)以上を指定してください。引数listintnに0を指定した場合,NULLを指定してください。整数型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_userdefnameHwfGetCaseFormSelectEx,又はHwfGetOperationで取得した案件の整数型ユーザ属性のユーザ定義名称を指定してください。ユーザ定義名称の取得については,機能の説明内容を参照してください。終端には,必ずNULL文字を付けてください。
BWF_attrint整数型のユーザ属性値が設定されます。
countint
取得した整数型ユーザ属性値数を取得する領域を指定します。引数listintnに0を指定した場合,NULLを指定してください。
listtimen
取得する日時型ユーザ属性数を指定します。
取得要求個数は,0~100の範囲で指定してください。0を指定した場合,引数listtimeと引数counttimeはNULLを指定してください。
listtime
日時型ユーザ属性取得領域を指定します。この領域には,(listtimen)×(listtimeのバイト数)以上を指定してください。引数listtimenに0を指定した場合,NULLを指定してください。
日時型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_userdefnameHwfGetCaseFormSelectEx,又はHwfGetOperationで取得した案件の日時型ユーザ属性のユーザ定義名称を指定してください。ユーザ定義名称の取得については,機能の説明内容を参照してください。終端には,必ずNULL文字を付けてください。
BWF_attrtime日時型のユーザ属性値が設定されます(YYYYMMDDhhmmss形式となります)。
counttime
取得した日時型ユーザ属性値数を取得する領域を指定します。引数listtimenに0を指定した場合,NULLを指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
拡張用の領域です。このバージョンではNULLを指定してください。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 取得したユーザ属性にデータが未設定の場合は,初期値が返ります。各ユーザ属性の初期値を次に示します。
    属性種別初期値
    文字列型char32バイトすべてNULL文字
    整数型long0
    日時型BWF_time_t"19700101090000​"
  • このAPI関数の戻り値がエラーリターン(BWF_ERROR)で,エラー情報取得領域内のメッセージ番号にBWE_OUT_RANGEが設定されていた場合,各ユーザ属性の取得個数には取得可能個数を設定します。
  • listchar,listint,listtimeのどれかに存在しないユーザ属性のユーザ定義名称が指定されていた場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • caseidには,単独案件の場合は単独案件の案件オブジェクトIDを指定してください。下位案件がある場合は下位案件の案件オブジェクトIDを指定してください。
(d) HwfSetCase(案件への作業結果の登録)
機能
案件のユーザ属性に,案件の作業結果を設定します。
このAPI関数で設定した作業結果が,分岐ノードでの案件の分岐条件となります。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfSetCase(
 BWF_useroid_t      __far *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t       __far *server,    /* サーバ名称格納領域 (I) */
 BWF_caseid_t       __far *caseid,    /* 作業結果登録案件オブジェクトID格納領域 (I) */
 long                     userattrlistn, /* 設定ユーザ属性値情報リスト数 (I) */
 BWF_userattrlist_t __far *userattrlist, /* 設定ユーザ属性値情報リスト格納領域 (I) */
 BWF_errlist_t      __far *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_userattrlist_t{
 char BWF_obj_attr_name[32];  /* 属性名称 */
 char BWF_attr_type[3];     /* 属性型   */
 char BWF_attr_value[32];    /* 属性値   */
} BWF_userattrlist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句       */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
案件のユーザ属性に,作業結果を設定する案件の案件オブジェクトID(HwfGetCaseSelectDataなどで取得できます)を格納した領域を指定します。単独,又は下位案件オブジェクトIDを指定してください。
userattrlistn
案件のユーザ属性に,作業結果として設定するユーザ属性値数を指定します
(700を超えるユーザ属性値は設定できません)。
userattrlist
作業結果を設定する,案件のユーザ属性値情報を格納した領域を指定します。
文字,整数,及び日時の3種類の案件内ユーザ属性の構成を次に示します。
項目長さ
文字型ユーザ属性32
整数型ユーザ属性4
日時型ユーザ属性4
上記の構成のユーザ属性に属性値を設定する場合は,userattrlistに必要な情報を格納し,その領域を指定することによって設定されます。
userattrlist内の項目を次に示します。
項目内容
BWF_obj_attr_name属性値を設定するユーザ属性に対応する,属性名称を指定します。ユーザ属性に対応する属性名称は,HwfGetOperationを発行して取得したユーザ処理リストを基に,設定してください(属性名称については,HwfTakeOperationInfのパラメタとして,HwfGetOperationで取得したユーザ処理リスト指定することによって,簡単に取得できます)。
属性名称の終端に必ずNULL文字を付けてください。
BWF_attr_typeユーザ属性に設定する属性値の属性型を指定します。ユーザ属性に設定する属性値対応の属性型は,HwfGetOperationを発行して取得したユーザ処理リストを基に,設定してください(属性型については,HwfTakeOperationInfのパラメタとして,HwfGetOperationで取得したユーザ処理リスト指定することによって,簡単に取得できます)。
属性型の終端に必ずNULL文字を付けてください。
BWF_attr_valueユーザ属性に設定する属性値を指定します。ユーザ属性に設定する属性値は,HwfGetOperationを発行して取得したユーザ処理リストを基に,設定してください(属性値の一部については,HwfTakeOperationInfのパラメタとして,HwfGetOperationで取得したユーザ処理リスト指定することによって,簡単に取得できます)。文字型ユーザ属性については,文字列を設定してください。整数型ユーザ属性については,案件内ユーザ属性の構成では4バイトになっていますが,"-2147483647​"~"2147483647​"の最大11バイトまでの文字列に変換して設定してください。日時型ユーザ属性については,案件内ユーザ属性の構成では4バイトになっていますが,YYYYMMDDhhmmss形式の14バイトまでの文字列で設定してください。
また,属性値の終端に必ずNULL文字を付けてください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • userattrlistのBWF_obj_attr_nameに,存在しないユーザ属性の属性名称が指定されていた場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • userattrlist内のBWF_obj_attr_name,BWF_attr_typeに指定したデータの組み合わせが,HwfGetOperationを発行して取得したユーザ処理リストから直接取得,又はHwfTakeOperationInfによって取得した属性名称,属性型の組み合わせと異なる場合,このAPI関数の動作は保証しません。
  • caseidで指定した案件が,終了処理ノードに至っていた場合,useroidに指定したユーザのユーザ権限が一般ユーザだと,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • caseidには,単体案件の場合は単体案件の案件オブジェクトIDを指定してください。下位案件がある場合は下位案件の案件オブジェクトIDを指定してください。
(e) HwfSetCaseByUserDefName(ユーザ定義名称指定による案件への作業結果登録)
機能
案件のユーザ属性にGroupmax Workflow Definerで指定したユーザ定義名称によって,案件の作業結果を設定します。
案件のユーザ属性に対応するユーザ定義名称は,次の方法で取得できます。
HwfGetOperationで取得したユーザ処理リスト内の作業情報から,HwfTakeOperationInfによってユーザ定義名称を含んだ属性情報を取り出します(詳細については,HwfTakeOperationInfを参照してください)。
HwfGetOperationで取得したユーザ処理リスト内の作業情報から,ユーザアプリケーションプログラムが独自にユーザ定義名称を含んだ属性情報を取り出します(詳細については,HwfGetOperationを参照してください)。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfSetCaseByUserDefName(
 BWF_useroid_t  __far *useroid,        /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,         /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far *caseid,         /* 作業結果登録案件オブジェクトID格納領域 (I) */
 unsigned long        userattrlistn,      /* 設定ユーザ属性値情報リスト数 (I) */
 BWF_userdefattrlist_t __far *userattrlist,  /* 設定ユーザ属性値情報リスト格納領域 (I) */
 BWF_errlist_t  __far *errlist         /* エラー情報取得領域 (O) */
);
typedef struct BWF_userdefattrlist_t{
 char BWF_userdefname[64];  /* ユーザ定義名称 */
 char BWF_attr_type[3];    /* 属性型 */
 char BWF_attr_value[32];   /* 属性値 */
} BWF_userdefattrlist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
案件のユーザ属性に作業結果を設定する案件の案件オブジェクトIDを格納した領域を指定します。単独,又は下位案件オブジェクトIDを指定してください。
案件オブジェクトIDは,HwfGetCaseSelectDataなどで取得できます。
userattrlistn
案件のユーザ属性に作業結果として設定するユーザ属性値数を指定します。
userattrlist
作業結果を設定する案件のユーザ属性値情報を格納した領域を指定します。
文字,整数,及び日時の3種類の案件内ユーザ属性の構成を次に示します。
項目長さ
文字型ユーザ属性32
整数型ユーザ属性4
日時型ユーザ属性4
上記の構成のユーザ属性に属性値を設定する場合は,userattrlistに必要な情報を格納し,その領域を指定することによって設定されます。
userattrlist内の項目を次に示します。
項目内容
BWF_userdefname属性値を設定するユーザ属性に対応するユーザ定義名称を指定します。ユーザ定義名称の取得については,機能の説明内容を参照してください。ユーザ定義名称の終端に,必ずNULL文字を付けてください。
BWF_attr_typeユーザ属性に設定する属性値の属性型を指定します。ユーザ定義名称に対する型の取得については,ユーザ定義名称と同様なので,機能の説明内容を参照してください。属性型の終端に,必ずNULL文字を付けてください。
BWF_attr_valueユーザ属性に設定する属性値を指定します。ユーザ属性に設定する属性値は,HwfGetOperationを発行して取得したユーザ処理リストを基に設定してください。
文字型ユーザ属性に関しては文字列を設定してください。
整数型ユーザ属性については,案件内のユーザ属性の構成では4バイトになっていますが,"-2147483647​"~"2147483647​"の最大11バイトまでの文字列に変換して設定してください。
日時型ユーザ属性については,案件内のユーザ属性の構成では4バイトになっていますが,YYYYMMDDhhmmss形式の14バイトまでの文字列で設定してください。
また,属性値の終端に,必ずNULL文字を付けてください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidで指定した案件が,useroidで指定したユーザのトレーにない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • userattrlistのBWF_userdefnameに,存在しないユーザ属性のユーザ定義名称が指定されていた場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • userattrlistnに660件を超える指定した場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • userattrlist内のBWF_userdefname,BWF_attr_typeに指定したデータの組み合わせが,HwfGetOperationを発行して取得したユーザ処理リストから直接取得,又はHwfTakeOperationInfによって取得したユーザ定義名称,属性型の組み合わせと異なる場合,このAPI関数の動作は保証しません。
  • caseidには,単体案件の場合は単体案件の案件オブジェクトIDを指定してください。下位案件がある場合は下位案件の案件オブジェクトIDを指定してください。
(f) HwfGetCaseExistUserAttrValue(案件のユーザ属性値設定情報の取得)
機能
案件のユーザ属性に対して,カレントノードでの,属性値の設定有無に関する情報を取得します。
アプリケーションでは,この情報を基に,カレントノードでの設定が必要となっている,案件のユーザ属性への属性値の設定有無をチェックして,未設定による次ノード以降の分岐ノードでの,誤った先への分岐,及び案件の遷移エラーを防止してください。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetCaseExistUserAttrValue(
 BWF_useroid_t       __far *useroid,   /* ユーザオブジェクトID格納領域   (I) */
 BWF_server_t        __far *server,   /* サーバ名称格納領域 (I) */
 BWF_caseid_t        __far *caseid,   /* 案件オブジェクトID格納領域 (I) */
 unsigned long             userattrn,  /* ユーザ属性値設定情報取得領域数 (I) */
 BWF_exsitattrlsit_t __far *userattr,  /* ユーザ属性値設定情報取得領域 (I/O) */
 BWF_errlist_t       __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_existattrlist_t{
 char          BWF_attrname[32];  /* ユーザ属性名称 */
 unsigned char BWF_existinf    ;  /* 設定有無情報   */
} BWF_existattrlist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
ユーザ属性値設定情報を取得する,案件のオブジェクトIDを指定します。単独,又は下位案件オブジェクトIDを指定してください。案件オブジェクトIDは,HwfGetCaseSelectDataなどで取得できます。
userattrn
caseidで指定した,案件のユーザ属性値設定情報を取得する要素数を指定します。取得要素数は1以上を指定してください。取得要素数は700,又はHwfGetObjectAttributeEx,HwfGetCaseSelectDataなどで取得した,案件項目リスト内の次に示す項目の総和に,15を加えた数のどちらか小さい方まで指定できます。
  • BWF_cs_exattr_char_count
  • BWF_cs_exattr_int_count
  • BWF_cs_exattr_time_count
上記の項目の詳細については,HwfGetCaseSelectDataのtcaselistを参照してください。
userattr
ユーザ属性値設定情報を取得する領域を指定します。
ユーザ属性値設定情報に指定,又は取得される項目を次に示します。
項目内容
BWF_attrname属性値設定情報を取得する,ユーザ属性に対応する属性名称を指定します。ユーザ属性に対応する属性名称は,HwfGetOperationを発行して取得したユーザ処理リスト,又はHwfGetCaseFormSelectExを発行して取得したフォームリストを基に設定してください(属性名称については,HwfTakeOperationInfのパラメタとして,HwfGetOperationで取得したユーザ処理リスト,又はHwfGetCaseFormSelectExを発行して取得したフォームリスト指定することによって,簡単に取得できます)。
属性名称の終端には必ずNULL文字を付けてください。
BWF_existinfこのAPI関数が正常リターンした場合,BWF_attrnameに指定した属性名称に対応するユーザ属性への属性値の設定有無が設定されます。
0x00:未設定
0x01:設定済
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • userattr内のBWF_attrnameに,同一属性名称が複数指定されていた場合,結果は保証しません。
  • caseidには,単体案件の場合は単体案件の案件オブジェクトIDを指定してください。下位案件がある場合は下位案件の案件オブジェクトIDを指定してください。

(10) 文書メモ操作AP関数

(a) HwfGetCaseDocumentList(案件の添付文書,添付メモの一覧取得)
機能
HwfGetCaseDocumentListは,指定した案件から文書,メモの一覧情報を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetCaseDocumentList(
 HWND                     pwnd_handle,    /* 親ウィンドウのハンドル (I) */
 BWF_caseid_t      __far  *case_id,     /* 案件識別子のアドレス (I) */
 long                     case_doc_listn,  /* 案件情報リスト領域数 (I) */
 long              __far  *case_total,    /* 存在案件総数 (O) */
 BWF_casedocinf_t  __far  *case_doc_list,  /* 案件情報リスト (I/O) */
 BWF_errlist_t     __far  *errlist,     /* エラー情報取得領域 (O) */
 void              __far  *arg        /* 拡張用領域のアドレス (-) */
);
typedef struct BWF_casedocinf_t {         /* 案件内文書,メモ情報 */
 BWF_casename_t            casename;       /* 案件名 (O) */
 BWF_caseid_t              caseid;        /* 案件識別子 (O) */
 long                      casetype;       /* 案件種別 (O) */
 long                      docfilelistn;     /* 格納文書ファイル情報領域数 (I) */
 long                      memofilelistn;    /* 格納メモファイル情報領域数 (I) */
 long                      docfile_total;    /* 格納文書総数 (O) */
 long                      get_docfilelistn;   /* 取得格納文書ファイル数 (O) */
 BWF_outfilelistex_t __far *get_docfilelist;   /* 格納文書ファイル情報格納領域 (O) */
 long                      memofile_total;    /* 格納メモ総数 (O) */
 long                      get_memofilelistn;  /* 取得格納メモファイル数 (O) */
 BWF_outfilelistex_t __far *get_memofilelist;  /* 格納メモファイル情報格納領域 (O) */
 char                      reserved[32];     /* 予備領域 (-) */
}BWF_casedocinf_t;
typedef struct  BWF_outfilelistex_t { /* 文書/メモファイル情報 */
 char          memotype;   /* メモ種別 (O) */
                /* F:ファイル D:データ S:Groupmax Integrated Desktop本文 */
 char          reserved1[3];     /* 予備領域 (-) */
 BWF_oid_t     file_id;        /* 文書/メモファイル識別子 (O) */
 char          outfilename[512];   /* フルパスファイル名称 (-) */
 char          filename[256];     /* ファイル登録名称 (O) */
 unsigned long datamemon;       /* データメモページ数 (O) */
 char          reserved[64];     /* 予備領域 (-) */
}BWF_outfilelistex_t;
typedef struct  BWF_errlist_t {    /* エラー情報取得領域 */
 char          sBMsgKbn[6];      /* メッセージ区分 (O) */
 long          lBMsgNo;        /* メッセージ番号 (O) */
 char          sBInsWord[13];     /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
pwnd_handle
親ウィンドウのハンドルを指定します。
case_id
取得する案件の識別子を指定します。案件に複数の下位案件がある場合は,上位案件を指定してください。
case_doc_listn
case_doc_listパラメタで指定した案件情報領域に格納できる総数を指定します。
case_total
case_idで指定した案件にある案件総数を格納します。
case_doc_list
案件情報取得領域を指定します。sizeof(BWF_casedocinf_t)×case_doc_listnのサイズが必要です。案件情報項目については,案件内文書,メモ情報の項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • HwfSimplePreCase,HwfPrefixCaseで一度に全文書,メモを取得することが処理のオーバヘッドとなる場合,HwfSimplePreCase,HwfPrefixCaseでは取得しないで,この関数,及びHwfGetCaseDocument関数で必要に応じて必要なファイルだけを取得できます。
  • データメモの1ページが1メモオブジェクトになります。
  • 単体案件の場合,HwfEditCaseCommentで添付した案件例外処理コメントはファイル名称”BWFCSCMT”のメモとして取得されます。
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
  • 総データ転送量が64000バイトを超えない範囲で使用してください。
    総データ転送量は次の式で求めることができます。

    総データ転送量=76+(案件数×148)+ a + b

    a:取得する文書の(文書名称長+48)の合計
    b:取得するメモの(メモ名称長+48)の合計
    注※ 文書名称長・メモ名称長は,¥0を含めた長さを基本長とし,基本長が4バイトの倍数になるように補正されます。例えば,"abcd¥0"の場合,実長は5になります。4の倍数に補正されるため,実長5の文字列長は8になります。
例1
単体案件に文書が2個(文書1の名称:1234567.12,文書2の名称:1234.12),メモが1個(メモ1の名称:1234567890.12)添付されている場合に,上記案件の文書とメモの情報を取得する場合の転送量は次のようになります。

総データ転送量=76+(1×148)+((12+48)+(8+48))+(16+48)
       =404バイト

例2
上位案件を指定し,下位に案件が2個(下位A,下位B)あり,下位Aに文書が2個(文書1の名称:1234567.12,文書2の名称:1234.12),メモが1個(メモ1の名称:1234567890.12)添付されおり,下位Bに文書が1個(文書1の名称:1234567.12),メモが1個(メモ1の名称:1234567890.12)添付されている場合に,上記案件の文書とメモの情報を取得する場合の転送量は次のようになります。

総データ転送量=76+(2×148)+((12+48)+(8+48)+(12+48))+((16+48)+(16+48))
       =676バイト

(b) HwfGetCaseDocument(案件からの添付文書,添付メモの取得)
機能
HwfGetCaseDocumentは,指定した文書,メモ実体を案件から取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetCaseDocument (
 HWND                    pwnd_handle,    /* 親ウィンドウのハンドル (I) */
 BWF_caseid_t      __far *case_id,     /* 案件識別子のアドレス (I) */
 long                    case_doc_listn,  /* 案件情報リスト領域数 (I) */
 BWF_casedocinf_t  __far *case_doc_list,  /* 案件情報リスト (I/O) */
 BWF_errlist_t     __far *errlist,     /* エラー情報取得領域 (O) */
 void              __far *arg        /* 拡張用領域のアドレス (-) */
);
typedef struct BWF_casedocinf_t {       /* 案件内文書,メモ情報 */
 BWF_casename_t            casename;     /* 案件名 (-) */
 BWF_caseid_t              caseid;      /* 案件識別子 (I) */
 long                      casetype;     /* 案件種別 (-) */
 long                      docfilelistn;   /* 格納文書ファイル情報領域数 (I) */
 long                      memofilelistn;   /* 格納メモファイル情報領域数 (I) */
 long                      docfile_total;   /* 格納文書総数 (-) */
 long                      get_docfilelistn; /* 取得格納文書ファイル数 (-) */
 BWF_outfilelistex_t __far *get_docfilelist; /* 格納文書ファイル情報格納領域 (I/O) */
 long                      memofile_total;  /* 格納メモ総数 (-) */
 long                      get_memofilelistn; /* 取得格納メモファイル数 (-) */
 BWF_outfilelistex_t __far *get_memofilelist; /* 格納メモファイル情報格納領域 (I/O) */
 char                      reserved[32];   /* 予備領域 (-) */
}BWF_casedocinf_t;
typedef struct BWF_outfilelistex_t {  /* 文書/メモファイル情報 */
 char           memotype;  /* メモ種別 (I) */
               /* F:ファイル D:データ S:Groupmax Integrated Desktop本文 */
 char           reserved1[3];     /* 予備領域 (-) */
 BWF_oid_t      file_id;        /* 文書/メモファイル識別子 (I) */
 char           outfilename[512];   /* フルパスファイル名称 (O) */
 char           filename[256];     /* ファイル登録名称 (O) */
 unsigned long  datamemon;       /* データメモページ数 (-) */
 char           reserved[64];     /* 予備領域 (-) */
}BWF_outfilelistex_t;
typedef struct  BWF_errlist_t {     /* エラー情報取得領域 */
 char                sBMsgKbn[6];   /* メッセージ区分 (O) */
 long                lBMsgNo;     /* メッセージ番号 (O) */
 char                sBInsWord[13];  /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
pwnd_handle
親ウィンドウのハンドルを指定します。
case_id
取得する案件の識別子を指定します。案件に複数の下位案件がある場合は,上位案件を指定してください。
case_doc_listn
case_doc_listパラメタで指定した案件情報数を指定します。
case_doc_list
案件情報取得領域を指定します。sizeof(BWF_casedocinf_t)×case_doc_listnのサイズが必要です。案件情報項目については案件内文書,メモ情報の項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
  • 総データ転送量が64000バイトを超えない範囲で使用してください。
    総データ転送量は次の式で求めることができます。

 総データ転送量=100+(案件数×52)+(取得する文書の合計数×304)
           +(取得するメモの合計数×304)

例1
単体案件に文書が2個(文書1の名称:1234567.12,文書2の名称:1234.12),メモが1個(メモ1の名称:1234567890.12)添付されている場合に,上記案件の文書とメモの情報を取得する場合の転送量は次のようになります。

総データ転送量=100+(1×52)+(2×304)+(1×304)= 1064バイト

例2
上位案件を指定し,下位に案件が2個(下位A,下位B)あり,下位Aに文書が2個(文書1の名称:1234567.12,文書2の名称:1234.12),メモが1個(メモ1の名称:1234567890.12)添付されおり,下位Bに文書が1個(文書1の名称:1234567.12),メモが1個(メモ1の名称:1234567890.12)添付されている場合に,上記案件の文書とメモの情報を取得する場合の転送量は次のようになります。
総データ転送量=100+(2×52)+(3×304)+(2×304)= 1724バイト
(c)  HwfUpdateCaseDocument(案件の添付文書,添付メモの更新)
機能
HwfUpdateCaseDocumentは,指定した文書,メモ実体を案件に追加,更新,削除します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfUpdateCaseDocument (
 HWND                       pwnd_handle,    /* 親ウィンドウのハンドル (I) */
 BWF_caseid_t        __far  *case_id,     /* 案件識別子のアドレス (I) */
 long                       case_doc_listn,  /* 案件情報リスト領域数 (I) */
 BWF_casedocinfex_t  __far  *case_doc_list,  /* 案件情報リスト (I) */
 BWF_errlist_t       __far  *errlist,     /* エラー情報取得領域 (O) */
 void                __far  *arg        /* 拡張用領域のアドレス (-) */
);
typedef struct BWF_casedocinfex_t {       /* 案件内文書,メモ情報 */
 BWF_casename_t           casename;       /* 案件名 (-) */
 BWF_caseid_t             caseid;        /* 案件識別子 (I) */
 long                     casetype;       /* 案件種別 (-) */
 long                     docfilelistn;     /* 格納文書ファイル情報領域数 (I) */
 long                     memofilelistn;    /* 格納メモファイル情報領域数 (I) */
 long                     docfile_total;    /* 格納文書総数 (-) */
 long                     get_docfilelistn;   /* 取得格納文書ファイル数 (-) */
 BWF_docupdateex_t __far  *get_docfilelist;   /* 格納文書ファイル情報格納領域 (I) */
 long                     memofile_total;    /* 格納メモ総数 (-) */
 long                     get_memofilelistn;  /* 取得格納メモファイル数 (-) */
 BWF_docupdateex_t __far  *get_memofilelist;  /* 格納メモファイル情報格納領域 (I) */
 char                     reserved[32];     /* 予備領域 (-) */
}BWF_casedocinfex_t;
typedef struct BWF_docupdateex_t {  /* 文書/メモ更新情報  */
 char       type;     /* 更新種別を指定する (I) */
              /* A:添付 D:削除 U更新  */
 char       memotype;   /* メモ種別 (I) */
              /* F:ファイル D:データ S:Groupmax Integrated Desktop本文 */
 char       reserved1[2];      /* 予備領域 (-) */
 BWF_oid_t  file_id;         /* 文書/メモファイル識別子 (I) */
 char       outfilename[512];    /* フルパスファイル名称 (I) */
 char       oldname[256];      /* ファイル登録名称 (I) */
 char       reserved[64];      /* 予備領域 (-) */
}BWF_docupdateex_t;
typedef struct  BWF_errlist_t {  /*エラー情報取得領域 */
 char  sBMsgKbn[6];        /* メッセージ区分 (O) */
 long  lBMsgNo;          /* メッセージ番号 (O) */
 char  sBInsWord[13];       /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
pwnd_handle
親ウィンドウのハンドルを指定します。
case_id
案件の識別子を指定します。案件に複数の下位案件がある場合は,上位案件を指定してください。
case_doc_listn
case_doc_listパラメタで指定した案件情報数を指定します。
case_doc_list
案件情報取得領域を指定します。sizeof(BWF_casedocinfex_t)×case_doc_listnのサイズが必要です。案件情報項目については案件内文書,メモ情報の項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
  • 総データ通信量が64000バイトを超えない範囲で使用してください。
    総データ転送量は次の式で求めることができます。

 総データ通信量=100 +(40×指定案件数)+(292×指定文書数の合計)
           +(304×指定メモ数の合計)

例1
単体案件に文書が2個(文書1の名称:1234567.12,文書2の名称:1234.12)メモが1個(メモ1の名称:1234567890.12)添付されている場合に,上記案件の文書とメモの情報を取得する場合の通信量は次のようになります。

総データ通信量=100+(1×40)+(2×292)+(1×304)= 1028バイト

例2
上位案件を指定し,下位に案件が2個(下位A,下位B)あり下位Aに文書が2個(文書1の名称:1234567.12,文書2の名称:1234.12)メモが1個(メモ1の名称:1234567890.12)添付されおり,下位Bに文書が1個(文書1の名称:1234567.12)メモが1個(メモ1の名称:1234567890.12)添付されている場合に,上記案件の文書とメモの情報を取得する場合の通信量は次のようになります。

総データ通信量=100+(2×40)+(3×292)+(2×304)= 1664バイト

(d) 案件内文書,メモ情報の項目(HwfGetCaseDocumentList)
項目内容
casename指定した案件オブジェクトIDにある案件の案件名称を設定します。
caseid案件名称(casename)に対応する案件の案件オブジェクトIDが設定されます。
casetype案件の種別を格納します。
0:単体案件
1:階層案件
docfilelistnget_docfilelistで指定した領域に格納できる添付文書情報の数を指定します。
memofilelistnget_memofilelistで指定した領域に格納できる添付メモ情報の数を指定します。
docfile_total案件内にある添付文書情報の総数を格納します。
get_docfilelistn取得した添付文書情報の総数を格納します。
get_docfilelist取得した添付文書情報を格納します。添付文書の詳細については,文書,又はメモファイル情報リストを参照してください。
memofile_total案件内にある添付メモ情報の総数を格納します。
get_memofilelistn取得した添付メモ情報の総数を格納します。
get_memofilelist取得した添付メモ情報を格納します。添付メモの詳細については,文書,又はメモファイル情報リストを参照してください。
(e) 文書,又はメモファイル情報リスト(HwfGetCaseDocumentList)
項目内容
memotypeメモの種別を格納します。文書の場合の値は不定です。
F:ファイルとして添付されたメモです。
D:データオブジェクトとして添付されたメモです。
S:Groupmax Integrated Desktopの本文に表示されるメモとして添付されたメモです。
file_id添付ファイルの識別子を格納します。後でHwfGetCaseDocumentで添付ファイルを取得する場合に使用します。
outfilenameこの関数では使用しません。
filenameファイル名称を格納します。
datamemonメモの種別がDの場合,データメモのページ数を格納します。
注意事項
  • 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
    詳しくはファイル名の注意事項を参照してください。
(f) 案件内文書,メモ情報の項目(HwfGetCaseDocument)
項目内容
casename案件名称を指定します(この関数では使用しません)。
caseid案件の識別子を指定します。
casetype案件の種別を格納します(この関数では使用しません)。
docfilelistnget_docfilelistで指定した領域に格納する添付文書の総数を指定します。
memofilelistnget_memofilelistで指定した領域に格納する添付メモ情報の総数を指定します。
docfile_total案件内にある添付文書情報の総数を格納します(この関数では使用しません)。
get_docfilelistn取得した添付文書情報の総数を格納します(この関数では使用しません)。
get_docfilelist取得する添付文書を指定します。添付文書の詳細については,文書,又はメモファイル情報リストを参照してください。
memofile_total案件内にある添付メモ情報の総数を格納します(この関数では使用しません)。
get_memofilelistn取得した添付メモ情報の総数を格納します(この関数では使用しません)。
get_memofilelist取得する添付メモを指定します。添付メモの詳細については,文書,又はメモファイル情報リストを参照してください。
(g) 文書,又はメモファイル情報リスト(HwfGetCaseDocument)
項目内容
memotypeメモの種別を指定します。文書の場合は指定する必要はありません。
F:ファイルとして添付されたメモです。
D:データオブジェクトとして添付されたメモです。
S:Groupmax Integrated Desktopの本文に表示されるメモとして添付されたメモです。
fileid取得する添付ファイルの識別子を指定します。
outfilename取得したファイルの取得先をフルパスで格納します。
filenameoutfilenameのうち,ファイル名称を格納します。
datamemonメモの種別がDの場合,データメモのページ数を指定します(この関数では使用しません)。

注1 バージョン1,及び02-00で格納した文書,メモの場合,outfilenameに格納されているファイル名称はすべて"upload.dat"に変更されます。登録したときのファイル名称は,filenameに格納されます。

注2 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
詳しくはファイル名の注意事項を参照してください。

(h) 案件内文書,メモ情報の項目(HwfUpdateCaseDocument)
項目内容
casename案件名称(この関数では使用しません)。
caseid案件の識別子を指定します。
casetype案件の種別(この関数では使用しません)。
docfilelistnget_docfilelistで指定した更新する添付文書の総数を指定します。
memofilelistnget_memofilelistで指定した更新する添付メモ情報の総数を指定します。
docfile_total案件内にある添付文書情報の総数(この関数では使用しません)。
get_docfilelistn取得した添付文書情報の総数(この関数では使用しません)。
get_docfilelist更新する添付文書を指定します。添付文書の詳細については,文書,又はメモファイル情報リストを参照してください。
memofile_total案件内にある添付メモ情報の総数(この関数では使用しません)。
get_memofilelistn取得した添付メモ情報の総数(この関数では使用しません)。
get_memofilelist取得する添付メモを指定します。添付メモの詳細については,文書,又はメモファイル情報リストを参照してください。
reserved予備領域です。このバージョンではNULL文字で埋めてください。
(i) 文書,又はメモファイル情報リスト(HwfUpdateCaseDocument)
項目内容
type更新種別を指定します。
A:添付
D:削除
U:更新
memotypeメモ種別を指定します。文書では指定する必要はありません。
F:ファイルとして添付します。
D:データオブジェクトとして添付します。データオブジェクトはサーバで障害回復の対象となりますが,次の制限があります。
  • 終端にNULL文字を付けた32キロバイト以下の文字列形式で指定してください。
  • 案件中に一つだけ指定できます。
S:Groupmax Integrated Desktopの本文に表示されるメモとして添付します。この種別は案件に一つだけ指定できます。
reserved1予備領域です。このバージョンではNULL文字で埋めてください。
file_id更新する添付文書,又は添付メモの識別子を指定します。追加の場合は指定する必要はありません。
outfilename更新する文書,又はメモをフルパスで指定します。削除の場合は指定する必要はありません。
oldnameoutfilenameのうち,ファイル名称だけを指定します。削除の場合は指定する必要はありません。
reserved予備領域です。このバージョンではNULL文字で埋めてください。

注1 同報中に文書,又はメモの削除はできません。また,同報中に文書,又はメモを添付した場合,その案件が回収されるまでは同じルート内の作業机からだけ参照できます。

注2 データオブジェクトは,同報中にサイズを変更しないでください。

注3 ロングファイル名称で登録した文書やメモを参照するときに,Groupmax Desktop(16bit版),Groupmax Workflow - Library バージョン1から02-00まで,又はGroupmax Workflow - Library 02-10以降でバージョン1との互換用関数を使用すると,そのファイル名称は次のように変換されます。

また,Groupmax Workflow Serverのバージョンが02-10のときにロングファイル名称で登録した文書,メモは,それぞれ"wfdoc.dat","wfmemo.dat"という名称に変換されます。

注4 06-00から添付ファイルのファイル名に使用できる文字の制限を解除することができます。
詳しくはファイル名の注意事項を参照してください。

(11) ヒストリ操作AP関数

(a) HwfPutUserDataToHistory(ワークヒストリへのユーザ任意情報設定出力)
機能
ユーザ任意のデータを,ワークヒストリとして出力します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfPutUserDataToHistory(
 BWF_useroid_t __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,   /* サーバ名称格納領域 (I) */
 char          __far *userdata,  /* ユーザ任意情報格納領域 (I) */
 long                objectkind, /* オブジェクト種別 (I) */
 BWF_oid_t     __far *oid,    /* オブジェクト識別子 (I) */
 BWF_errlist_t __far *errlist   /* エラー情報取得領域  (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
userdata
ワークヒストリとして出力する,ユーザデータの格納領域を指定します。ここで指定できるユーザデータは文字列型だけで,終端の'¥0'を含め97バイト以内です。97バイトを超えるデータ,及び終端に'¥0'のないユーザデータについては,データの出力を保証できません。
objectkind
ユーザデータが対象とするオブジェクトの種別を指定します。
BWF_WORK_OBJECT:ユーザデータがワーク全体に関するものである場合
BWF_CASE_OBJECT:ユーザデータが一部の案件に対するものである場合
オブジェクトの種別は,このAPI関数発行直前に実行した処理によって,指定が異なります。このAPI関数では,直前に実行した処理とオブジェクト種別の対応関係に関し,整合性のチェックはしません。
oid
objectkindによって,ワークオブジェクトID,又は案件オブジェクトIDを指定します。オブジェクトの種別とoidの対応を次に示します。
objectkindoid
BWF_WORK_OBJECTワークオブジェクトID
BWF_CASE_OBJECT案件オブジェクトID
ワークオブジェクトIDは,HwfGetCaseSelectData,HwfGetWorkAttributeなどで取得できます。また,案件オブジェクトIDは,HwfGetCaseSelectDataなどで取得できます。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(b) HwfGetWorkHistoryEx(ワークヒストリの取得)
機能
HwfGetWorkHistoryEx関数は,パラメタcaseoidで指定した案件のワークヒストリ,又はHwfGetUserHistoryEx関数で取得したハンドルに対応する案件のワークヒストリを取得します。パラメタtypeで,取得する履歴種別を指定できます。また,パラメタitemで,取得する項目と取得する項目の順を指定できます。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetWorkHistoryEx(
 BWF_useroid_t  __far  *useroid,    /* ユーザオブジェクトID格納領域 (I)*/
 BWF_server_t   __far  *server,    /* サーバ名称格納領域 (I)*/
 unsigned long         req_mode ,   /* 要求種別 (I)*/
 BWF_caseid_t   __far  *caseoid ,   /* 案件オブジェクトID格納領域 (I)*/
 long                  historyhdl ,  /* 取得ヒストリのハンドル (I)*/
 unsigned long         historymode ,  /* ヒストリ取得モード (I)*/
 unsigned long         number,     /* ヒストリリスト取得先頭要素番号 (I)*/
 unsigned long         type_count ,  /* 取得ヒストリ種別数 (I)*/
 unsigned long  __far  *type ,     /* 取得ヒストリ種別の配列 (I)*/
 unsigned long         item_count ,  /* 取得ヒストリ項目数 (I)*/
 unsigned long  __far  *item ,     /* 取得ヒストリ項目の配列 (I)*/
 unsigned long  __far  *total,     /* ヒストリリスト全要素数 (O)*/
 unsigned long  __far  *count,     /* 取得ヒストリリスト要素数 (O)*/
 void           __far  *historyarea,  /* ヒストリリスト取得領域 (O)*/
 unsigned long         area_size ,   /* ヒストリリスト取得領域のサイズ (I)*/
 BWF_errlist_t  __far  *errlist ,   /* エラー情報取得領域 (O) */
 void           __far  *arg      /* 拡張用領域のアドレス */
);
typedef struct BWF_errlist_t{
 char  sBMsgKbn[6];  /* メッセージ区分 */
 long  lBMsgNo;    /* メッセージ番号 */
 char  sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
req_mode
ヒストリ取得要求の種別を指定します。
0:ユーザトレーにある案件のワークヒストリを取得します。
この場合,caseoidに指定した案件識別子が対象となります。
1:ユーザヒストリにある処理履歴からワークヒストリを取得します。
この場合,historyhdlに指定したユーザヒストリで処理した案件が対象となります。
caseoid
ヒストリ取得対象とする案件の識別子を設定した領域を指定します。案件に複数の下位案件がある場合は,上位案件識別子を指定してください。案件の識別子は,HwfGetCaseSelectDataなどで取得できます。
req_modeで1を指定した場合はNULLを指定してください。
historyhdl
ヒストリ取得対象とするユーザヒストリのイベントのハンドルを指定してください。ユーザヒストリのイベントのハンドルは,HwfGetUserHistoryExで取得できます。
なお,ハンドルはHwfGetUserHistoryExで取得した後,ユーザヒストリにイベントを出力する関数(HwfSimplePutCase,HwfPutCase,HwfSuffixCase,HwfSimpleGoCase,HwfPutCaseOnBusinessProcess,HwfRoundCaseEx,HwfTrustCaseEx,HwfAnswerCase,HwfTakeBackCaseEx,HwfSendBackCaseExなど)を発行するまで有効です。req_modeで0を指定した場合は0を指定してください。
historymode
ワークヒストリの取得方法を指定します。次の値のどちらかになります。
BWF_CHRON_MODE:最も古いワークヒストリから取得します。
BWF_CURRENT_MODE:最も新しいワークヒストリから,さかのぼって取得します。
number
取得するワークヒストリの先頭番号(0~全ヒストリ数-1)を指定します。
HwfStartUpWorkflow()発行後,1回目のこの関数発行時は必ず0を指定してください。
type_count
ワークヒストリの取得する履歴種別の数を指定します。0~27までの範囲内で指定してください。0を指定した場合は,すべての履歴種別のワークヒストリを取得します。
type
ワークヒストリの取得する連携種別を,パラメタtype_countで指定した数だけ設定した配列の先頭アドレスを指定します。
同じ値を複数設定した場合,パラメタtype_countで指定した数より多く設定すると,エラーにならないで無視されます。
設定する項目の値は次のどれかになります。
BWF_WH_PUT_CASE:案件の投入要求
BWF_WH_GO_CASE:案件の遷移要求
BWF_WH_CONSULT:案件の相談要求
BWF_WH_ANSWARE:案件の回答要求
BWF_WH_SEND_BACK:案件の差し戻し要求
BWF_WH_TAKE_BACK:案件の引き戻し要求
BWF_WH_FROM_ROLE:ロールからの案件取得要求
BWF_WH_TO_ROLE:ロールへの案件返却要求
BWF_WH_TO_USER:他ユーザへの案件振り替え要求
BWF_WH_SUSPEND:案件の遷移中断要求
BWF_WH_RESUME:案件の遷移再開要求
BWF_WH_SUSPEND_WORK:ワークの遷移中断
BWF_WH_RESUME_WORK:ワークの遷移開始
BWF_WH_CANCEL:ワークの遷移中止(キャンセル)要求
BWF_WH_PUT_DATA:任意情報出力要求
BWF_WH_MOVE_CASE:案件の移動完了
BWF_WH_ERROR:エラー発生
BWF_WH_END_CASE:案件の遷移終了
BWF_WH_CONNECT_BP:ビジネスプロセス定義連携要求
BWF_WH_GOTO_EXT:ビジネスプロセス定義連携完了
BWF_WH_PUT_CASE_FROM_BP:他ビジネスプロセス定義からの案件投入
BWF_WH_SEND_BACK_TO_BP:他ビジネスプロセス定義への案件の差し戻し要求
BWF_WH_REMOVE_CASE:再送要求
BWF_WH_GO_FORCE:案件の強制遷移要求
BWF_WH_CONNECT_WF:他システムへ送付開始
BWF_WH_CONNECTED:他システムへ送付成功
BWF_WH_PUT_CASE_ADD_INF:他システムから投入
item_count
ワークヒストリの取得する項目数を指定します。1~28までの範囲内で指定してください。
item
ワークヒストリの取得する項目を,パラメタitem_countで指定した数だけ設定した配列の先頭アドレスを指定します。設定する項目の値は次のどれかになります。
BWF_WH_ID:作業種別
BWF_WH_TYPE:作業名
BWF_WH_DATE:処理日時
BWF_WH_NODE_NAME1:ノード名1
BWF_WH_NICK_NAME1:ニックネーム1
BWF_WH_USER_NAME1:ユーザ名1
BWF_WH_USER1:ニックネーム1(ユーザ名1)
BWF_WH_ORG_NAME1:組織略称1
BWF_WH_POST1:役職1
BWF_WH_NODE_NAME2:ノード名2
BWF_WH_NICK_NAME2:ニックネーム2
BWF_WH_USER_NAME2:ユーザ名2
BWF_WH_USER2:ニックネーム2(ユーザ名2)
BWF_WH_ORG_NAME2:組織略称2
BWF_WH_POST2:役職2
BWF_WH_NICK_NAME3:ニックネーム3
BWF_WH_USER_NAME3:ユーザ名3
BWF_WH_USER3:ニックネーム3(ユーザ名3)
BWF_WH_ORG_NAME3:組織略称3
BWF_WH_POST3:役職3
BWF_WH_INF:任意情報
BWF_WH_ERROR_CODE:エラーコード
BWF_WH_HOST_NAME2:ホスト名2
BWF_WH_BP_NAME:ビジネスプロセス定義名称
BWF_WH_BP_VERSION:ビジネスプロセス定義バージョン
BWF_WH_NODE_NAME3:ノード名3
BWF_WH_ENTRANS_NAME:窓口名
BWF_WH_WORK_ID:ワークID
total
すべてのワークヒストリの数を格納する領域のアドレスを指定します。
count
取得したワークヒストリの数を格納する領域のアドレスを指定します。
numberパラメタの指定値とcountパラメタの値の合計が,totalパラメタの値よりも小さい場合,未取得のワークヒストリがあります。
historyarea
取得するワークヒストリの格納領域のアドレスを指定します。
格納領域が不足している場合は,格納可能な情報まで格納されます。
格納されるワークヒストリの詳細については,ワークヒストリの詳細を参照してください。
area_size
パラメタhistoryareaで指定した領域の大きさを指定します。一度に取得できるサイズは32767バイトまでです。1~32767までの値を指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • typeパラメタにBWF_WH_GO_FORCEを指定した場合,案件の強制遷移要求が行われていれば,作業種別は「49」,処理名は「強制遷移」が取得されます。typeパラメタにBWF_WH_GO_FORCEを指定しないで,かつBWF_WH_GO_CASEを指定した場合,案件の強制遷移要求が行われいてれば,作業種別は「13」,処理名は「遷移指示」が取得されます。
  • HwfStartUpWorkflow()発行後,1回目のこの関数発行時にnumberパラメタに0以外を指定した場合は,正常終了しますが,ヒストリは取得できません。
    numberパラメタに1以上を指定する場合は,numberパラメタに0を設定してこの関数を発行した後,ほかのAPIを挟まないで,この関数を発行してください。ほかのAPIを発行した後でnumberパラメタに1以上の値を指定してこの関数を発行すると,メッセージ区分:KMWMJ,メッセージ番号:12470でエラーリターンすることがあります。
(c) HwfGetUserHistoryEx(ユーザヒストリの取得)
機能
HwfGetUserHistoryEx関数は,ログインしたユーザのユーザヒストリ(作業履歴)を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>long HwfGetUserHistoryEx(
BWF_useroid_t  __far *useroid,    /* ユーザオブジェクトID格納領域  (I)*/
BWF_server_t   __far *server,     /* サーバ名称格納領域 (I)*/
unsigned long        historymode ,  /* ヒストリ取得モード (I)*/
unsigned long        number,     /* ヒストリリスト取得先頭要素番号 (I)*/
unsigned long        item_count ,   /* 取得ヒストリ項目数 (I)*/
unsigned long  __far *item ,     /* 取得ヒストリ項目の配列 (I)*/
unsigned long  __far *total,     /* ヒストリリスト全要素数 (O)*/
unsigned long  __far *count,     /* 取得ヒストリリスト要素数 (O)*/
void           __far *historyarea,  /* ヒストリリスト取得領域 (O)*/
unsigned long        area_size ,   /* ヒストリリスト取得領域のサイズ (I)*/
BWF_errlist_t  __far *errlist ,    /* エラー情報取得領域 (O)*/
void           __far *arg       /* 拡張用領域のアドレス */
);
typedef struct BWF_errlist_t{
char     sBMsgKbn[6];   /* メッセージ区分 */
long     lBMsgNo;     /* メッセージ番号 */
char     sBInsWord[13];  /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
historymode
ユーザヒストリの取得方法を指定します。次の値のどちらかになります。
BWF_CHRON_MODE:最も古いユーザヒストリから取得します。
BWF_CURRENT_MODE:最も新しいユーザヒストリから,さかのぼって取得します。
number
取得するユーザヒストリの先頭番号(0~全ヒストリ数-1)を指定します。
HwfStartUpWorkflow()発行後,1回目のこの関数発行時は必ず0を指定してください。
item_count
ユーザヒストリの取得する項目数(1以上)を指定します。
item
ユーザヒストリの取得する項目をパラメタitem_countで指定した数だけ設定した配列の先頭アドレスを指定します。設定する項目の値は次のどれかになります。
BWF_UH_ID:作業種別
BWF_UH_TYPE:作業内容
BWF_UH_DATE:作業日時
BWF_UH_BP_TYPE:ビジネスプロセス定義種別
BWF_UH_BP_NAME:ビジネスプロセス定義名称
BWF_UH_BP_VERSION:ビジネスプロセス定義バージョン
BWF_UH_WORK_NAME:作業名
BWF_UH_WORK_ID:ワークID
BWF_UH_NICK_NAME:送信先ニックネーム
BWF_UH_USER_NAME:送信先ユーザ名(日本語名)
BWF_UH_ORG_NAME:送信先ユーザの組織略称
BWF_UH_POST:送信先ユーザの役職
BWF_UH_WORK_NAME2:作業名2
BWF_UH_HANDLE:ハンドル
BWF_UH_SERVER_ID:投入サーバID
BWF_UH_CASE_OID:案件オブジェクトID
ここで設定した項目だけ,設定順に取得されます。また,同じ項目を複数設定した場合は複数取得されます。各項目の内容については,ユーザヒストリの詳細を参照してください。
total
すべてのユーザヒストリの数を格納する領域のアドレスを指定します。
count
取得したユーザヒストリの数を格納する領域のアドレスを指定します。
numberパラメタの指定値とfetch_countパラメタの値の合計が,total_countパラメタの値よりも小さい場合,未取得のユーザヒストリがあります。
historyarea
取得するユーザヒストリの格納領域のアドレスを指定します。
格納領域が不足している場合は,格納可能な情報まで格納されます。
格納されるユーザヒストリの詳細については,ユーザヒストリの詳細を参照してください。
area_size
パラメタhistoryareaで指定した領域の大きさを指定します。一度に取得できるサイズは32767バイトまでです。1~32767までの値を指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 履歴情報として取得した案件に対してオブジェクト属性取得関数を発行する場合,オブジェクト実体が削除されている可能性があることを考慮してください。ヒストリは履歴として残している情報であるため,オブジェクト実体とリンクしていません。
  • HwfStartUpWorkflow()発行後,初めてこの関数を発行する場合は,numberパラメタに0を指定して,先頭のユーザヒストリから取得してください。このとき,numberパラメタに0以外を指定すると,このAPI関数は,メッセージ区分:KMWMJ,メッセージ番号:12470でエラーリターンします。
  • numberパラメタに1以上を指定する場合は,numberパラメタに0を設定してこの関数を発行した後,ほかのAPIを挟まないで,この関数を発行してください。ほかのAPIを発行した後でnumberパラメタに1以上の値を指定してこの関数を発行すると,メッセージ区分:KMWMJ,メッセージ番号:12470でエラーリターンすることがあります。
  • historymodeを指定して新規にユーザヒストリを取得する場合は,numberに0を指定して先頭のユーザヒストリから取得してください。この時,0以外を指定すると,このAPI関数は,メッセージ区分:KMWMJ,メッセージ番号:11524でエラーリターンします。
(d) HwfGetUserHistoryDx(ユーザヒストリとワーク状態の取得)
機能
ログインしたユーザのユーザヒストリ(作業履歴)と処理を行った案件の最新のワーク状態を取得します。
(この関数はHwfGetUserHistoryEx()関数で取得できる項目にHwfGetWorkStatus()関数で取得できるワークの状態に関する項目を追加した関数です。)
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetUserHistoryDx(
BWF_useroid_t   __far *useroid,     /* ユーザオブジェクトID格納領域         (I)*/
BWF_server_t    __far *server,     /* サーバ名称格納領域                   (I)*/
unsigned long          historymode ,  /* ヒストリ取得モード                   (I)*/
unsigned long          existmode ,   /* ヒストリ取得対象ワーク状態選択モード (I)*/
unsigned long          number,     /* ヒストリリスト取得先頭要素番号       (I)*/
unsigned long          type_count ,   /* 取得ヒストリ種別の数                 (I)*/
unsigned long   __far  *type ,     /* 取得ヒストリ種別の配列の先頭アドレス (I)*/
unsigned long          item_count ,   /* 取得ヒストリ項目数                   (I)*/
unsigned long   __far  *item ,     /* 取得ヒストリ項目の配列               (I)*/
unsigned long   __far  *total,     /* ヒストリリスト全要素数               (O)*/
unsigned long   __far  *count,     /* 取得ヒストリリスト要素数             (O)*/
unsigned long   __far  *endcount,    /* 取得対象となったヒストリの個数       (O)*/
void            __far  *historyarea,  /* ヒストリリスト取得領域               (O)*/
unsigned long          area_size ,   /* ヒストリリスト取得領域のサイズ       (I)*/
BWF_errlist_t   __far  *errlist ,    /* エラー情報取得領域                   (O)*/
char            __far  *reserve ,    /* 予約                                 (-)*/
void            __far  *arg       /* 拡張用領域のアドレス                 (-)*/
);

typedef struct BWF_errlist_t{
char     sBMsgKbn[6];   /* メッセージ区分 */
long     lBMsgNo;     /* メッセージ番号 */
char     sBInsWord[13];  /* 挿入語句       */
  
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
historymode
ユーザヒストリの取得方法を指定します。次の値のどちらかになります。
BWF_CHRON_MODE:ログインユーザのユーザヒストリを最も古いユーザヒストリから取得します。
BWF_CURRENT_MODE:ログインユーザのユーザヒストリを最も新しいユーザヒストリから,さかのぼって取得します。
existmode
情報を取得するヒストリを現在のワークの状態で絞り込みます。
次の値のどちらかで指定してください。
BWF_USER_HISTORY_NORMAL_MODE:ワークの有無に関わらず,すべてのユーザヒストリ(作業履歴)を取得します。
BWF_USER_HISTORY_WORK_EXIST_MODE:ユーザヒストリ(作業履歴)のなかで,ワークが存在するものだけを取得します。
number
取得するユーザヒストリの先頭番号(0~全ヒストリ数-1)を指定します。
HwfStartUpWorkflow()発行後,又はhistorymode変更後,初めてこの関数発行時は必ず0を指定してください。
type_count
ヒストリ情報を取得するユーザヒストリの種別の数を指定します。
ユーザヒストリの種別の数は,1~6の範囲で指定してください。
type
ヒストリ情報を取得するユーザヒストリの種別を引数type_countで指定した数だけ設定した配列の先頭アドレスを指定します。設定する項目の値は次のどれかになります。
同じ値を複数設定した場合や引数type_countで指定した数分より多く設定した場合は,
エラーとならず無視されます。
BWF_UH_PUT_CASE:案件投入
BWF_UH_GO_CASE:案件発信
BWF_UH_CONSULT_CASE:相談
BWF_UH_ANSWER_CASE:回答
BWF_UH_SEND_BACK_CASE:差し戻し
BWF_UH_TAKE_BACK_CASE:引き戻し
item_count
ユーザヒストリの取得する項目数(1以上)を指定します。
item
ユーザヒストリの取得する項目をパラメタitem_countで指定した数だけ設定した配列の先頭アドレスを指定します。設定する項目の値は次のどれかになります。
BWF_UH_ID:作業種別
BWF_UH_TYPE:作業内容
BWF_UH_DATE:作業日時
BWF_UH_BP_TYPE:ビジネスプロセス定義種別
BWF_UH_BP_NAME:ビジネスプロセス定義名称
BWF_UH_BP_VERSION:ビジネスプロセス定義バージョン
BWF_UH_WORK_NAME:作業名
BWF_UH_WORK_ID:ワークID
BWF_UH_NICK_NAME:送信先ニックネーム
BWF_UH_USER_NAME:送信先ユーザ名(日本語名)
BWF_UH_ORG_NAME:送信先ユーザの組織略称
BWF_UH_POST:送信先ユーザの役職
BWF_UH_WORK_NAME2:作業名2
BWF_UH_HANDLE:ハンドル
BWF_UH_PUT_STATUS:投入状態
BWF_UH_CASE_OID:案件OID
BWF_UH_SERVER_ID:サーバID
BWF_UH_WORK_TITLE:案件タイトル
BWF_UH_WORK_STATUS:ワークの状態
BWF_UH_WORK_PRIORITY:ワークの優先度
BWF_UH_WORK_LIMIT:ワークの処理期限
BWF_UH_WORK_CTIME:ワークの作成日時
BWF_UH_CURRENT_WORK_NAME:カレント作業名
ここで設定した項目だけ,設定順に取得されます。また,同じ項目を複数設定した場合は複数取得されます。
各項目の内容については,ユーザヒストリの詳細を参照してください。
total
すべてのユーザヒストリの数を格納する領域のアドレスを指定します。
existmodeパラメタにBWF_USER_HISTORY_WORK_EXIST_MODEを指定した場合も,ワークが存在するユーザヒストリ(作業履歴)の合計数ではなく,すべてのユーザヒストリ(作業履歴)の合計数が返却されます。
count
取得したユーザヒストリの数を格納する領域のアドレスを指定します。
endcount
この関数は全ユーザヒストリを引数historymodeで指定された並びで1つずつ情報を編集していきます。
引数endcountは,全ユーザヒストリ数を返却する引数totalの返却値のうち,全ユーザヒストリの先頭から何番目までの編集を終えたかを示す番号を返却します。したがって,引数numberや引数existmodeの指定値には依存しません。
引数endcountの返却値 = 引数totalの返却値 の場合,全ユーザヒストリの終わりまで編集を終えたことになります。引数endcountの返却値 < 引数totalの返却値の場合,未取得の情報が存在します。
未取得の情報を取得する場合は,引数endcountの返却値を引数numberに設定してこの関数を再度発行してください。ただし,existmodeパラメタでBWF_USER_HISTORY_WORK_EXIST_MODEが指定してあり,残りのヒストリにワークが存在しないものしかない場合やtypeパラメタで指定した種別のヒストリが存在しない場合,ヒストリは取得されません。
historyarea
取得するユーザヒストリの格納領域のアドレスを指定します。
格納領域が不足している場合は,格納可能な情報までが格納されます。
格納されるユーザヒストリの詳細については,ユーザヒストリの詳細を参照してください。
area_size
パラメタhistoryareaで指定した領域の大きさを指定します。一度に取得できるサイズは32767バイトまでです。1~32767までの値を指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
reserve
予備領域です。NULLを指定してください。
arg
予備領域です。NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 履歴情報として取得した案件オブジェクトID(item:BWF_UH_CASE_OID)は,ビジネスプロセス定義の登録サーバ上の案件オブジェクトIDであり,ユーザのホームサーバ上の案件オブジェクトIDと異なることがあります。また,この関数で取得した情報は,過去の作業内容を確認するための履歴情報であるため,当該案件がすでに削除されている場合があります。取得した案件オブジェクトIDを使用する場合はご注意ください。
  • HwfStartUpWorkflow()発行後,初めてこの関数を発行する場合は,numberに0を指定して先頭のユーザヒストリから取得してください。このとき,0以外を指定すると,このAPI関数は,メッセージ区分:KMWMJ,メッセージ番号:12470でエラーリターンします。
  • numberパラメタに1以上を指定する場合は,numberパラメタに0を設定してこの関数を発行した後,ほかのAPIを挟まないで,この関数を発行してください。ほかのAPIを発行した後でnumberパラメタに1以上の値を指定してこの関数を発行すると,メッセージ区分:KMWMJ,メッセージ番号:12470でエラーリターンすることがあります。
  • historymodeを変更して新規にユーザヒストリを取得する場合は,numberに0を指定して先頭のユーザヒストリから取得してください。このとき,0以外を指定すると,このAPI関数は,メッセージ区分:KMWMJ,メッセージ番号:11524でエラーリターンします。
(e) HwfGetWorkHistoryDirect(ワークヒストリの取得)
機能
HwfGetWorkHistoryDirect関数は,案件投入時及び遷移時に取得しておいた情報を用いて,以前に処理を行った案件のワークヒストリを取得します。
自トレー内の案件のワークヒストリ,又はHwfGetUserHistoryEx関数で取得したハンドルに対応する案件のワークヒストリを取得する場合は,HwfGetWorkHistoryExを使用してください。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetWorkHistoryDirect(
BWF_useroid_t         __far  *useroid,    /* ユーザオブジェクトID格納領域 (I)*/
BWF_server_t          __far  *server,     /* サーバ名称格納領域 (I)*/
BWF_workhistdirect_t  __far  *caseinf ,    /* 案件情報格納領域 (I)*/
unsigned long                historymode ,  /* ヒストリ取得モード (I)*/
unsigned long                number,     /* ヒストリリスト取得先頭要素番号 (I)*/
unsigned long                type_count ,   /* 取得ヒストリ種別数 (I)*/
unsigned long         __far  *type ,     /* 取得ヒストリ種別の配列 (I)*/
unsigned long                item_count ,   /* 取得ヒストリ項目数 (I)*/
unsigned long         __far  *item ,     /* 取得ヒストリ項目の配列 (I)*/
unsigned long                get_count ,   /* 取得ヒストリ要素数 (I)*/
unsigned long         __far  *total,     /* ヒストリリスト全要素数 (O)*/
unsigned long         __far  *count,     /* 取得ヒストリリスト要素数 (O)*/
void                  __far  *historyarea,  /* ヒストリリスト取得領域 (O)*/
unsigned long                area_size ,   /* ヒストリリスト取得領域のサイズ (I)*/
BWF_errlist_t         __far  *errlist ,    /* エラー情報取得領域  (O)*/
void                  __far  *arg       /* 拡張用領域のアドレス (-)*/
);

typedef struct BWF_workhistdirect_t{
char                  mode[4];     /* 作業種別 (I)*/
BWF_caseid_t          caseoid ;    /* 案件オブジェクトID格納領域 (I)*/
char                  server_id[8] ;  /* 投入サーバID (I)*/
char                  node_name[64]  /* ノード名称 (I)*/
char                  bp_name[64];   /* ビジネスプロセス定義名称 (I)*/
unsigned long          bp_version;   /* ビジネスプロセス定義バージョン (I)*/
char                  bp_type[4];   /* ビジネスプロセス定義種別 (I)*/
char                  workid[64];   /* ワークID(案件識別子フォーマット) (I)*/
char                  reserve[164];  /* 予備領域 (-)*/
} BWF_workhistdirect_t ;

typedef struct BWF_errlist_t{
char  sBMsgKbn[6];  /* メッセージ区分 */
long  lBMsgNo;    /* メッセージ番号 */
char  sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseinf
ワークヒストリを取得する案件の情報を指定します。
設定する案件の情報については,案件情報内項目を参照してください。
historymode
ワークヒストリの取得方法を指定します。次の値のどちらかになります。
BWF_CHRON_MODE:最も古いワークヒストリから取得します。
BWF_CURRENT_MODE:最も新しいワークヒストリから,さかのぼって取得します。
number
取得するワークヒストリの先頭番号(0~全ヒストリ数-1)を指定します。
HwfStartUpWorkflow()発行後,1回目のこの関数発行時は必ず0を指定してください。
type_count
ワークヒストリの取得する履歴種別の数(1以上)を指定します。
0を指定した場合は,すべての履歴種別のワークヒストリを取得します。
type
ワークヒストリの取得する連携種別を,パラメタtype_countで指定した数だけ設定した配列の先頭アドレスを指定します。
同じ値を複数設定した場合,パラメタtype_countで指定した数より多く設定すると,エラーにならないで無視されます。
設定する項目の値は次のどれかになります。
BWF_WH_PUT_CASE:案件の投入要求
BWF_WH_GO_CASE:案件の遷移要求
BWF_WH_CONSULT:案件の相談要求
BWF_WH_ANSWARE:案件の回答要求
BWF_WH_SEND_BACK:案件の差し戻し要求
BWF_WH_TAKE_BACK:案件の引き戻し要求
BWF_WH_FROM_ROLE:ロールからの案件取得要求
BWF_WH_TO_ROLE:ロールへの案件返却要求
BWF_WH_TO_USER:他ユーザへの案件振り替え要求
BWF_WH_SUSPEND:案件の遷移中断要求
BWF_WH_RESUME:案件の遷移再開要求
BWF_WH_SUSPEND_WORK:ワークの遷移中断
BWF_WH_RESUME_WORK:ワークの遷移開始
BWF_WH_CANCEL:ワークの遷移中止(キャンセル)要求
BWF_WH_PUT_DATA:任意情報出力要求
BWF_WH_MOVE_CASE:案件の移動完了
BWF_WH_ERROR:エラー発生
BWF_WH_END_CASE:案件の遷移終了
BWF_WH_CONNECT_BP:ビジネスプロセス定義連携要求
BWF_WH_GOTO_EXT:ビジネスプロセス定義連携完了
BWF_WH_PUT_CASE_FROM_BP:他ビジネスプロセス定義からの案件投入
BWF_WH_SEND_BACK_TO_BP:他ビジネスプロセス定義への案件の差し戻し要求
BWF_WH_REMOVE_CASE:再送要求
BWF_WH_GO_FORCE:案件の強制遷移要求
BWF_WH_CONNECT_WF:他システムへ送付開始
BWF_WH_CONNECTED:他システムへ送付成功
BWF_WH_PUT_CASE_ADD_INF:他システムから投入
item_count
ワークヒストリの取得する項目数(1以上)を指定します。
item
ワークヒストリの取得する項目を,パラメタitem_countで指定した数だけ設定した配列の先頭アドレスを指定します。
設定する項目の値は次のどれかになります。
BWF_WH_ID:作業種別
BWF_WH_TYPE:作業名
BWF_WH_DATE:処理日時
BWF_WH_NODE_NAME1:ノード名1
BWF_WH_NICK_NAME1:ニックネーム1
BWF_WH_USER_NAME1:ユーザ名1
BWF_WH_USER1:ニックネーム1(ユーザ名1)
BWF_WH_ORG_NAME1:組織略称1
BWF_WH_POST1:役職1
BWF_WH_NODE_NAME2:ノード名2
BWF_WH_NICK_NAME2:ニックネーム2
BWF_WH_USER_NAME2:ユーザ名2
BWF_WH_USER2:ニックネーム2(ユーザ名2)
BWF_WH_ORG_NAME2:組織略称2
BWF_WH_POST2:役職2
BWF_WH_NICK_NAME3:ニックネーム3
BWF_WH_USER_NAME3:ユーザ名3
BWF_WH_USER3:ニックネーム3(ユーザ名3)
BWF_WH_ORG_NAME3:組織略称3
BWF_WH_POST3:役職3
BWF_WH_INF:任意情報
BWF_WH_ERROR_CODE:エラーコード
BWF_WH_HOST_NAME2:ホスト名2
BWF_WH_BP_NAME:ビジネスプロセス定義名称
BWF_WH_BP_VERSION:ビジネスプロセス定義バージョン
BWF_WH_NODE_NAME3:ノード名3
BWF_WH_ENTRANS_NAME:窓口名
BWF_WH_WORK_ID:ワークID
ここで設定した項目だけ,設定順に取得されます。
また,同じ項目を複数設定した場合は,複数取得されます。
get_count
取得ヒストリ数を指定してください。0を指定した場合は,historyareaパラメタで指定したエリアに格納できる最大数のヒストリを取得します。
total
すべてのワークヒストリの数を格納する領域のアドレスを指定します。
count
取得したワークヒストリの数を格納する領域のアドレスを指定します。
numberパラメタの指定値とcountパラメタの値の合計が,totalパラメタの値よりも小さい場合,未取得のワークヒストリがあります。
historyarea
取得するワークヒストリの格納領域のアドレスを指定します。
格納領域が不足している場合は,格納可能な情報まで格納されます。
格納されるワークヒストリの詳細については,ワークヒストリの詳細を参照してください。
area_size
パラメタhistoryareaで指定した領域の大きさを指定します。一度に取得できるサイズは32767バイトまでです。
1~32767までの値を指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • typeパラメタにBWF_WH_GO_FORCEを指定した場合,案件の強制遷移要求が行われていれば,作業種別は「49」,処理名は「強制遷移」が取得されます。typeパラメタにBWF_WH_GO_FORCEを指定しないで,かつBWF_WH_GO_CASEを指定した場合,案件の強制遷移要求が行われていれば,作業種別は「13」,処理名は「遷移指示」が取得されます。
  • HwfStartUpWorkflow()発行後,最初にこの関数を発行する場合は,numberパラメタに0以外を指定した場合は,numberに0を指定して,先頭のヒストリから取得してください。このとき,0以外を指定すると,このAPI関数は,メッセージ区分:KMWMJ,メッセージ番号:12470でエラーリターンします。
  • historymodeを変更して新規にヒストリを取得する場合は,numberに0を指定して,先頭のヒストリから取得してください。このとき,0以外を指定すると,このAPI関数は,メッセージ区分:KMWMJ,メッセージ番号:11524でエラーリターンします。
  • numberパラメタに1以上の値を指定する場合は,numberに0を指定してこの関数を発行した後,ほかの関数を挟まないで,この関数を発行してください。ほかのAPIを発行した後で,numberパラメタに1以上の値を指定してこの関数を発行すると,メッセージ区分:KMWMJ,メッセージ番号:12470でエラーリターンすることがあります。
(f) HwfDeleteUserHistoryEx(ユーザヒストリの削除)
機能
指定ユーザの全ユーザヒストリ,又は任意のユーザヒストリを削除します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfDeleteUserHistoryEx(
 BWF_useroid_t  __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,    /* サーバ名称格納領域 (I) */
 long                 mode,     /* ユーザヒストリ削除モード (I) */
 long                 hdlnum,    /* 指定ハンドル数 (I) */
 long           __far *deletehdl,  /* 削除対象ハンドル (I) */
 BWF_errlist_t  __far *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
mode
ユーザヒストリの削除モードを指定します。
BWF_DELETE_ALL:ログインユーザのすべてのユーザヒストリを削除します。
BWF_DELETE_SELECT:deletehdlで指定した,ユーザヒストリだけを削除します。
hdlnum
deletehdlで指定するユーザヒストリのハンドル数を指定します。1~500の範囲内で指定してください。modeでBWF_DELETE_ALLを指定した場合は指定値は無視されます。
deletehdl
削除対象とするユーザヒストリ(HwfGetUserHistoryExで取得)のイベントのハンドルを指定してください。hdlnumで指定した数だけ配列で指定してください。
なお,ハンドルはHwfGetUserHistoryExで取得した後,ユーザヒストリにイベントを出力する関数(HwfSimplePutCase,HwfPutCase,HwfSuffixCase,HwfSimpleGoCase,HwfRoundCaseEx,HwfTrustCaseEx,HwfAnswerCase,HwfTakeBackCaseEx,HwfSendBackCaseExなど)を発行するまで有効です。modeでBWF_DELETE_ALLを指定した場合はNULLを指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数でユーザヒストリを削除した場合,削除したユーザヒストリは再取得できないので,引き戻し要求ができなくなる場合があります。
(g) ワークヒストリの詳細
説明
HwfGetWorkHistoryEx関数で取得するワークヒストリは,パラメタitemで指定した取得項目の指定順に1作業種別1文字列のCSV形式でパラメタhistoryareaの領域に格納されます。
形式
<項目値>{','<項目値>・・・}'¥0'
<項目値>::各項目の値。値中に空白が含まれる場合もあります。
  • 値中に「,」の文字を含む場合,値を「"」で囲んで格納します。
    (例)「ABC,Z」は,「"ABC,Z"」として格納されます。
  • 値中に「"」の文字を含む場合,「"」を「""」に変換して格納します。
    (例)「ABC"Z」は,「ABC""Z」に変換して格納されます。
       「ABC,"Z」は,「"ABC,""Z"」に変換して格納されます。
  • 取得した項目に値がない場合は,・・・,,・・・となります。
    (例)案件投入のヒストリをパラメタitemに次の値を指定して取得した場合
    item:BWF_WH_TYPE,BWF_WH_DATE,BWF_WH_NODE_NAME1,BWF_WH_BP_NAME,BWF_WH_BP_VERSION
    取得ヒストリ:案件投入,19960101000000,ソース1,,
パラメタitemがBWF_WH_TYPE,BWF_WH_DATE,BWF_WH_NODE_NAME1,BWF_WH_NICK_NAME1,BWF_WH_USER_NAME1,BWF_WH_NODE_NAME2,BWF_WH_NICK_NAME2,BWF_WH_USER_NAME2のときのワークヒストリ。
案件投入,19960401120532​,旅費請求,H.SUZUKI,鈴木 花子...
案件移動完了,19960401120601​,旅費請求...審査,T.YAMADA,山田 太郎
案件遷移,19960402090451​,審査,T.YAMADA,山田 太郎...
履歴種別ごとに格納される項目については,ワークヒストリの作業種別ごとの格納項目を参照してください。
ワークヒストリの各項目の内容については,ワークヒストリの項目の内容を参照してください。
(h) ワークヒストリの作業種別ごとの格納項目
(凡例)
○:取得できる情報
○元:案件の移動元の情報
○先:案件の移動先の情報
○実行:実行するユーザの情報
処理種別作業種別処理名処理日時ノ|ド名1ニックネ|ム1ユ|ザ名1ニックネ|ム1¨ユ|ザ名1組織略称1役職1ノ|ド名2ニックネ|ム2ユ|ザ名2ニックネ|ム2¨ユ|ザ名2組織略称2役職2ニックネ|ム3ユ|ザ名3ニックネ|ム3¨ユ|ザ名3組織略称3役職3任意情報エラ|コ|ドホスト名2ビジネスプロセス定義名称ビジネスプロセス定義バ|ジョンノ|ド名3窓口名ワ|クID
BWF_WH_PUT_CASE18案件投入                   
BWF_WH_GO_CASE13遷移指示                   
BWF_WH_CONSULT12相談○元○元○元○元○元○元 ○先○先○先○先○先             
BWF_WH_ANSWARE24回答○元○元○元○元○元○元 ○先○先○先○先○先             
BWF_WH_SEND_BACK32差し戻し○元○元○元○元○元○元○先○先○先○先○先○先             
BWF_WH_TAKE_BACK33引き戻し○元○元○元○元○元○元○先○先○先○先○先○先             
BWF_WH_FROM_ROLE21ロールから取得○元      ○先○先○先○先○先○実行○実行○実行○実行○実行        
BWF_WH_TO_ROLE22ロールへ返却○元○元○元○元○元○元      ○実行○実行○実行○実行○実行        
BWF_WH_TO_USER23振り替え○元○元○元○元○元○元 ○先○先○先○先○先○実行○実行○実行○実行○実行        
BWF_WH_SUSPEND14遷移中断○元○元○元○元○元○元      ○実行○実行○実行○実行○実行        
BWF_WH_RESUME16遷移再開始○元○元○元○元○元○元      ○実行○実行○実行○実行○実行        
BWF_WH_SUSPEND_WORK15ワーク遷移中断            ○実行○実行○実行○実行○実行        
BWF_WH_RESUME_WORK17ワーク遷移再開始            ○実行○実行○実行○実行○実行        
BWF_WH_CANCEL20ワーク遷移中止            ○実行○実行○実行○実行○実行        
BWF_WH_PUT_DATA25任意情報                        
BWF_WH_MOVE_CASE5遷移○元     ○先○先○先○先○先○先             
BWF_WH_ERROR7エラー発生○元      ○先○先○先○先○先             
BWF_WH_END_CASE34遷移終了                        
BWF_WH_CONNECT_BP29BP連携開始○元○元                  ○先○先○先○先  
BWF_WH_GOTO_EXT30BP連携成功○元○元                  ○先○先○先○先  
BWF_WH_PUT_CASE_FROM_BP46他BPから投入             ○元○元○元○元  
BWF_WH_SEND_BACK_TO_BP47他BPへ差し戻し○元○元○元○元○元○元             ○先○先○先○先  
BWF_WH_REMOVE_CASE48再送○元     ○先○先○先○先○先○先             
BWF_WH_GO_FORCE49強制遷移                   
BWF_WH_CONNECT_WF50他システムへ送付開始○元○元                   ○先  ○先 
BWF_WH_CONNECTED51他システムへ送付成功○元                       
BWF_WH_PUT_CASE_ADD_INF52他システムから投入                   ○元  ○元○元

注意:案件の強制遷移を行った場合,強制遷移処理を取得する指定で取得したワークヒストリは,作業種別「49」,処理名「強制遷移」となりますが,遷移指示だけを取得する指定で取得したワークヒストリは,作業種別「13」,処理名「遷移指示」となります。

(i) ワークヒストリの項目の内容
項目型,長さ内容
処理種別文字列,1~2バイト処理内容に対応した半角の数字。ワークヒストリの作業種別ごとの格納項目を参照してください。APで処理を区別したいときに使用します。今後のエンハンスで番号が追加となる可能性がありますので考慮が必要です。
処理名文字列,ワークヒストリの作業種別ごとの格納項目で示す処理名の最大長処理した内容。ワークヒストリの作業種別ごとの格納項目を参照してください。編集しないで表示したいときに使用するためのものです 。この値を処理を区別する処理に使用しないでください。区別するには処理種別の値を使用してください。また,今後のエンハンスで値が追加となる可能性がありますので考慮が必要です。
処理日時文字列,14バイト処理した日時をYYYYMMDDhhmmss形式で示します。この日時はPCで設定されているタイムゾーンによってローカル日時に変換されたものとなります。
ノード名1文字列,1~63バイト処理したノードのノード名。
ニックネーム1文字列,1~128バイト処理元のユーザのニックネーム。処理元のユーザが削除されている場合は,128バイト分'*'が設定されます。
ユーザ名1文字列,1~32バイト処理元のユーザのユーザ名(日本語名)。処理元のユーザが削除されている場合は,32バイト分'*'が設定されます。
ニックネーム1
(ユーザ名1)
文字列,1~162バイト処理元のユーザのニックネームとユーザ名。処理元のユーザが削除されている場合は,162バイト分'*'が設定されます。
組織略称1文字列,1~32バイト処理元のユーザが所属する組織の組織略称。処理元のユーザが削除されている場合は,32バイト分'*'が設定されます。
役職1文字列,1~32バイト処理元のユーザの役職。処理元のユーザが削除されている場合は,32バイト分'*'が設定されます。
ノード名2文字列,1~63バイト処理先のノードのノード名。
ニックネーム2文字列,1~128バイト処理先のユーザのニックネーム。処理先のユーザが削除されている場合は,128バイト分'*'が設定されます。
ユーザ名2文字列,1~32バイト処理先のユーザのユーザ名(日本語名)。処理先のユーザが削除されている場合は,32バイト分'*'が設定されます。
ニックネーム2(ユーザ名2)文字列,1~162バイト処理先のユーザのニックネームとユーザ名。処理先のユーザが削除されている場合は,162バイト分'*'が設定されます。
組織略称2文字列,1~32バイト処理先のユーザが所属する組織の組織略称。処理先のユーザが削除されている場合は,32バイト分'*'が設定されます。
役職2文字列,1~32バイト処理先のユーザの役職。処理先のユーザが削除されている場合は,32バイト分'*'が設定されます。
ニックネーム3文字列,1~128バイト処理実行ユーザのニックネーム。処理実行ユーザが削除されている場合は,128バイト分'*'が設定されます。
ユーザ名3文字列,1~32バイト処理実行ユーザのユーザ名(日本語名)。処理実行ユーザが削除されている場合は,32バイト分'*'が設定されます。
ニックネーム3(ユーザ名3)文字列,1~162バイト処理実行ユーザのニックネームとユーザ名。処理実行ユーザが削除されている場合は,162バイト分'*'が設定されます。
組織略称3文字列,1~32バイト処理実行ユーザが所属する組織の組織略称。処理実行ユーザが削除されている場合は,32バイト分'*'が設定されます。
役職3文字列,1~32バイト処理実行ユーザの役職。処理実行ユーザが削除されている場合は,32バイト分'*'が設定されます。
任意情報文字列,1~96バイトユーザが出力した任意の情報。
エラーコード文字列,8バイトエラー発生時のエラーのメッセージID。KDWMxxxx,又はKDWTxxxx。
ホスト名2文字列,1~63バイト転送先のサーバのホスト名。
ビジネスプロセス定義名称文字列,1~63バイト転送先のビジネスプロセス定義名称。
ビジネスプロセス定義バージョン文字列,1~8バイト転送先のビジネスプロセス定義のバージョン番号。半角の数字。投入できる最新ビジネスプロセス定義を指定して投入した案件の場合,ビジネスプロセス定義バージョンは-1を戻します。
ノード名3文字列,1~63バイト転送先のビジネスプロセス定義のノード名。
窓口名文字列,1~63バイト窓口名
ワークID文字列,1~63バイト連携先元のワークID
(j) ユーザヒストリの詳細
説明
HwfGetUserHistoryEx関数で取得するユーザヒストリは,パラメタitemで指定した取得項目の指定順に1作業種別1文字列のCSV形式でパラメタhistory_areaの領域に格納されます。
形式
<項目値>{','<項目値>・・・}'¥0'
<項目値>::各項目の値。値中に空白が含まれる場合もあります。
  • 値中に「,」の文字を含む場合,値を「"」で囲んで格納します。
    (例)「ABC,Z」は,「"ABC,Z"」として格納されます。
  • 値中に「"」の文字を含む場合,「"」を「""」に変換して格納します。
    (例)「ABC"Z」は,「ABC""Z」に変換して格納されます。
       「ABC,"Z」は,「"ABC,""Z"」に変換して格納されます。
  • 取得した項目に値がない場合は,・・・,,・・・となります。
    (例)案件投入のヒストリをパラメタitemに次の値を指定して取得した場合
    item:BWF_UH_TYPE,BWF_UH_BP_NAME,BWF_UH_NICK_NAME,BWF_UH_USER_NAME,BWF_UH_HANDLE
    取得ヒストリ:案件投入,ビジネスプロセス定義,,,1
パラメタitemがBWF_UH_TYPE,BWF_UH_DATE,BWF_UH_BP_NAME,BWF_UH_WORK_NAME,BWF_UH_WORK_ID,BWF_UH_NICK_NAME,BWF_UH_USER_NAMEのときのユーザヒストリ。
案件投入,19960401120532​,旅費精算,旅費請求,請求012,,
相談,19960402090451​,製品見積り,審査,見積り032,T.YAMADA,山田 太郎

作業種別ごとに格納される項目については,ユーザヒストリの作業種別ごとの格納項目ごとの格納項目を参照してください。

ユーザヒストリの各項目の内容については,ユーザヒストリの項目の内容を参照してください。

(k) ユーザヒストリの作業種別ごとの格納項目
作業種別作業内容作業日時ビジネスプロセス定義種別ビジネスプロセス定義名称ビジネスプロセス定義バ|ジョン作業名ワ|クID送信先ニックネ|ム送信先ユ|ザ名送信先ユ|ザの組織略称送信先ユ|ザの役職作業名2ハンドルサ|バID案件オブジェクトID
1案件投入      
2案件発信     
3相談 
4回答 
5差し戻し
6引き戻し    
(凡例)
○:値が格納されます。
空白:値は格納されません(0バイト)。

(l) ユーザヒストリの項目の内容
項目型,長さ内容
作業種別文字列,
1~2バイト
ユーザの作業した内容に対応した半角の番号。次のどれかになります。APで作業を区別したいときに使用するためのものです。今後のエンハンスで番号が追加となる可能性がありますので考慮が必要です。
  • '1'(案件投入)
  • '2'(案件発信)
  • '3'(相談)
  • '4'(回答)
  • '5'(差し戻し)
  • '6'(引き戻し)
作業内容文字列,
右記の内容の最大値長
ユーザの作業した内容によって,次のどれかになります。編集しないで表示したいときに使用するためのものです。この値を作業を区別する処理に使用しないでください。区別するには作業種別の値を使用してください。また,今後のエンハンスで値が追加となる可能性がありますので考慮が必要です。
  • 案件投入
  • 案件発信
  • 相談
  • 回答
  • 差し戻し
  • 引き戻し
注 案件発信は遷移指示を行った場合に設定されます。
作業日時文字列,
14バイト
作業した日時をYYYYMMDDhhmmss形式で示します。この日時はPCで設定されているタイムゾーンによってローカル日時に変換されたものとなります。
ビジネスプロセス
定義種別
文字列,
1バイト
作業したビジネスプロセス定義の種別。
0:ビジネスプロセス定義
1:拡張ビジネスプロセス定義
該当するビジネスプロセス定義が削除されている場合は,1バイト分'*'が設定されます。
ビジネスプロセス
定義名称
文字列,
1~63バイト
作業した案件のビジネスプロセス定義名称。
該当するビジネスプロセス定義が削除されている場合は,63バイト分'*'が設定されます。
ビジネスプロセス定義バージョン番号文字列,
1~10バイト
作業したビジネスプロセス定義のバージョン番号。
該当するビジネスプロセス定義が削除されている場合は,10バイト分'*'が設定されます。
作業名文字列,
1~63バイト
作業した案件の作業名。
該当するビジネスプロセス定義が削除されている場合は,63バイト分'*'が設定されます。
ワークID文字列,
1~63バイト
作業した案件のワークID。このワークIDを取得しないで,ワーク識別子を取得してワーク識別子からワークIDを抽出することもできます。
該当するビジネスプロセス定義が削除されている場合は,63バイト分'*'が設定されます。
送信先
ニックネーム
文字列,
1~128バイト
作業した案件の送信先のユーザのニックネームは,作業種別によって次のようになります。
  • 相談:相談先のユーザのニックネーム
  • 回答:回答先のユーザのニックネーム
  • 差し戻し:差し戻し先のユーザのニックネーム
該当するユーザが削除されている場合は,128バイト分'*'が設定されます。
送信先ユーザ名文字列,
0~32バイト
作業した案件の送信先のユーザのユーザ名(日本語名)は,作業種別によって次のようになります。
  • 相談:相談先のユーザのユーザ名
  • 回答:回答先のユーザのユーザ名
  • 差し戻し:差し戻し先のユーザのユーザ名
該当するユーザが削除されている場合は,32バイト分'*'が設定されます。
送信先ユーザの組織略称文字列,
0~32バイト
作業した案件の送信先のユーザの組織略称。
該当するユーザが削除されている場合は,32バイト分'*'が設定されます。
送信先ユーザの役職文字列,
0~32バイト
作業した案件の送信先のユーザの役職。
該当するユーザが削除されている場合は,32バイト分'*'が設定されます。
作業名2文字列,
1~63バイト
作業の種別によって次のように設定されます。
  • 差し戻し:差し戻し先作業名
  • 引き戻し:引き戻し先作業名
上記以外の作業種別の場合は,何も設定されません。該当するビジネスプロセス定義が削除されている場合は,63バイト分'*'が設定されます。
ハンドル文字列,
1~4バイト
ユーザヒストリのイベントを識別するための整数値。ユーザヒストリの削除(HwfDeleteUserHistoryEx),案件の引き戻し(HwfTakeBackCaseEx),案件の遷移履歴取得(HwfGetWorkHistoryEx)などの関数を発行するときに必要です。
サーバID文字列,
0~8バイト
シングルサーバ構成で処理したものについては,NULLが設定されます。
マルチサーバ構成で処理したものについては,ビジネスプロセス定義の登録サーバのサーバIDが設定されます。
上記のどちらの場合でも,該当するビジネスプロセス定義が削減されている場合は,8バイト分'*'が設定されます。
案件オブジェクトID文字列,
16バイト
作業した案件の案件オブジェクトIDが設定されます。
拡張ビジネスプロセス定義の場合は,処理したサーバ上の案件オブジェクトIDではなく,ビジネスプロセス定義の登録サーバ上の案件オブジェクトIDが設定されます。処理種別が案件投入の場合は,設定されません。
案件オブジェクトIDは16進数の文字列に変換して設定されます。
上記のどの場合でも,該当するビジネスプロセス定義が削除されている場合は,16バイト分'*'が設定されます。
(m) ユーザヒストリの詳細
説明
取得するユーザヒストリは,パラメタitemで指定した取得項目の指定順に1作業種別1文字列のCSV形式でパラメタhistory_areaの領域に格納されます。
形式
<項目値>{','<項目値>・・・}'¥0'
<項目値>::各項目の値。値中に空白が含まれる場合もあります。
  • 値中に「,」の文字を含む場合,値を「"」で囲んで格納します。
    (例)「ABC,Z」は,「"ABC,Z"」として格納されます。
  • 値中に「"」の文字を含む場合,「"」を「""」に変換して格納します。
    (例)「ABC"Z」は,「ABC""Z」に変換して格納されます。
       「ABC,"Z」は,「"ABC,""Z"」に変換して格納されます。
  • 取得した項目に値がない場合は,・・・,,・・・となります。
    (例)案件投入のヒストリをパラメタitemに次の値を指定して取得した場合
    item:BWF_UH_TYPE,BWF_UH_BP_NAME,BWF_UH_NICK_NAME,BWF_UH_USER_NAME,BWF_UH_HANDLE
    取得ヒストリ:案件投入,ビジネスプロセス定義,,,1
パラメタitemがBWF_UH_TYPE,BWF_UH_DATE,BWF_UH_BP_NAME,BWF_UH_WORK_NAME,BWF_UH_WORK_ID,BWF_UH_NICK_NAME,BWF_UH_USER_NAMEのときのユーザヒストリ。
案件投入,19960401120532​,旅費精算,旅費請求,請求012,,
相談,19960402090451​,製品見積り,審査,見積り032,T.YAMADA,山田 太郎
作業種別ごとに格納される項目については,ユーザヒストリの作業種別ごとの格納項目 を参照してください。
ユーザヒストリの各項目の内容については,ユーザヒストリの項目の内容を参照してください。
(n) ユーザヒストリの作業種別ごとの格納項目
(凡例)
○:値が格納されます。
空白:値は格納されません(0バイト)。
作業種別作業内容作業日時ビジネスプロセス定義種別ビジネスプロセス定義名称ビジネスプロセス定義バ|ジョン作業名ワ|クID送信先ニックネ|ム送信先ユ|ザ名送信先ユ|ザの組織略称送信先ユ|ザの役職作業2ハンドル投入状態案件OIDサ|バID案件タイトルワ|クの状態ワ|クの優先度ワ|クの処理期限ワ|クの作成日時カレント作業名
1案件投入      
2案件発信      
3相談  
4回答  
5差し戻し 
6引き戻し     
(o) ユーザヒストリの項目の内容
項目型,長さ内容
作業種別文字列,
1~2バイト
ユーザの作業した内容に対応した半角の番号。
次のどれかになります。
APで作業を区別したいときに使用するためのものです。今後のエンハンスで番号が追加となる可能性がありますので考慮が必要です。
  • '1'(案件投入)
  • '2'(案件発信)
  • '3'(相談)
  • '4'(回答)
  • '5'(差し戻し)
  • '6'(引き戻し)
作業内容文字列,右記の内容の最大値長ユーザの作業した内容によって,次のどれかになります。
編集しないで表示したいときに使用するためのものです。この値を作業を区別する処理に使用しないでください。区別するには作業種別の値を使用してください。また,今後のエンハンスで値が追加となる可能性がありますので考慮が必要です。
  • 案件投入
  • 案件発信
  • 相談
  • 回答
  • 差し戻し
  • 引き戻し
注:案件発信は遷移指示をした場合に設定されます。
作業日時文字列,14バイト作業した日時をYYYYMMDDhhmmss形式で示します。
この日時はローカル日時です。
ビジネスプロセス定義種別文字列,1バイト作業したビジネスプロセス定義の種別。
0:ビジネスプロセス定義
1:拡張ビジネスプロセス定義該当するビジネスプロセス定義が削除されている場合は,1バイト分'*'が設定されます。
ビジネスプロセス定義名称文字列,1~63バイト作業した案件のビジネスプロセス定義名称。
該当するビジネスプロセス定義が削除されている場合は,63バイト分'*'が設定されます。
ビジネスプロセス定義バージョン番号文字列,1~10バイト作業したビジネスプロセス定義のバージョン番号。
該当するビジネスプロセス定義が削除されている場合は,10バイト分'*'が設定されます。
作業名文字列,1~63バイト作業した案件の作業名。
該当するビジネスプロセス定義が削除されている場合は,63バイト分'*'が設定されます。
ワークID文字列,1~63バイト作業した案件のワークID。
該当するビジネスプロセス定義が削除されている場合は,63バイト分'*'が設定されます。
送信先ニックネーム文字列,1~128バイト作業した案件の送信先のユーザのニックネームは,作業種別によって次のようになります。
  • 相談:相談先のユーザのニックネーム
  • 回答:回答先のユーザのニックネーム
  • 差し戻し:差し戻し先のユーザのニックネーム該当するユーザが削除されている場合は,128バイト分'*'が設定されます。
送信先ユーザ名文字列,0~32バイト作業した案件の送信先のユーザのユーザ名(日本語名)は,作業種別によって次のようになります。
  • 相談:相談先のユーザのユーザ名
  • 回答:回答先のユーザのユーザ名
  • 差し戻し:差し戻し先のユーザのユーザ名該当するユーザが削除されている場合は,32バイト分'*'が設定されます。
送信先ユーザの組織略称文字列,0~32バイト作業した案件の送信先のユーザの組織略称。
該当するユーザが削除されている場合は,32バイト分'*'が設定されます。
送信先ユーザの役職文字列,0~32バイト作業した案件の送信先のユーザの役職。
該当するユーザが削除されている場合は,32バイト分'*'が設定されます。
作業名2文字列,1~63バイト作業の種別によって次のように設定されます。
  • 差し戻し:差し戻し先作業名
  • 引き戻し:引き戻し先作業名
上記以外の作業種別の場合は,何も設定されません。該当するビジネスプロセス定義が削除されている場合は,63バイト分'*'が設定されます。
ハンドル文字列,1~4バイトユーザヒストリのイベントを識別するための整数値。
ユーザヒストリの削除(HwfDeleteUserHistoryEx),案件の引き戻し(HwfTakeBackCaseEx),案件の遷移履歴取得(HwfGetWorkHistoryEx)などの関数を発行するときに必要です。
投入状態文字列,0~4バイト案件投入の作業状態が設定されます。
投入状態によって以下のどれかになります。
  • "":投入成功
  • "err":案件投入失敗
  • "proc":案件投入処理中
案件オブジェクトID文字列,16バイト作業した案件の案件オブジェクトOIDが設定されます。拡張ビジネスプロセス定義の場合は,ビジネスプロセス定義の登録サーバ上の案件オブジェクトIDが設定されます。案件オブジェクトIDは,16進の文字列に変換して設定されます。
処理種別が案件投入の場合は,設定されません。
上記のどちらの場合でも,該当するビジネスプロセス定義が削除されている場合は,16バイト分の'*'が設定されます。
この案件オブジェクトIDは8バイトに変換して,HwfTakeBackCaseDirect()関数やHwfGetWorkHistoryDirect()関数の引数として使用するためのものです。
サーバID文字列,0~8バイトシングルサーバ構成で処理したものについては,値が設定されません。
マルチサーバ構成で処理したものについては,ビジネスプロセス定義の登録サーバのサーバIDが設定されます。
上記のどちらの場合でも,該当するビジネスプロセス定義が削除されている場合は,8バイト分の'*'が設定されます。
案件タイトル文字列,1~63バイト案件タイトルを格納します。
ワークが削除されている場合は,63バイト分'*'が設定されます。(※2)
ワークの状態文字列,4バイトワークの遷移状態を格納します。
次の値のどれかになります。
  • "act△":遷移中
  • "sup△":サスペンド中
  • "can△":キャンセル
  • "can2":削除予約中
  • "sink":終了
  • "none":存在しない
  • "pute":投入失敗
※ △は半角スペース
ワークの優先度文字列,4バイトワークの優先度を格納します。次の値のどれかになります。
  • "com△":普通
  • "urg△":至急
ワークが削除されている場合は,4バイト分'*'が設定されます。(※2)
※ △は半角スペース
ワークの処理期限文字列,14バイトワークの処理期限をYYYYMMDDhhmmss形式で格納します。
この日時はローカル日時です。
ワークの作成日時文字列,14バイトワークの作成日時をYYYYMMDDhhmmss形式で格納します。
この日時はローカル日時です。
カレント作業名文字列, 0~63バイト案件が現在作業されている作業名。
ビジネスプロセス定義の登録サーバ上のワークにルートケース及びルートケースを持たない一般ケースが複数存在する場合には値は設定されません。(複数のソースノード又は分割・複写・同報ノードなどが定義されたビジネスプロセス定義である場合にこの状態になることがあります。)当ワークが削除されている場合は,63バイト分'*'が設定されます。(※2)

(※1)各項目の長さは,取得する項目の値の長さであるため,値中に , や " が含まれる場合は,返却する情報が表に示した長さの最大値を超える可能性がありますのでご注意ください。

(※2)マルチサーバ構成で引数exist_modeにBWF_USER_HISTORY_NORMAL_MODEを指定した場合でビジネスプロセス定義の登録サーバに接続失敗してワークの状態が取得できなかった場合は,ワークが削除されている場合と同様に'*'が設定されます。


(p) 案件情報内項目
項目内容
mode対象案件を処理したときの差業種別を指定します。
"put△":案件投入
"go△△":案件遷移
注 △は半角スペースを示します。
caseoid対象案件のオブジェクトIDを指定します。
拡張ビジネスプロセス定義の案件場合は,ビジネスプロセス定義の登録サーバ上での案件オブジェクトIDを指定してください。
ビジネスプロセス定義の登録サーバ上でのオブジェクトIDは,案件処理時にHwfGetCaseSelectData()で取得してください。
ビジネスプロセス定義の案件の場合は,接続先サーバ上での案件オブジェクトIDを指定してください。modeで"put△"を指定した場合は,8バイトのNULL文字を指定してください。
server_idこのパラメタは予備領域です。8バイトのNULLも地を指定してください。
node_name対象案件の処理したノード名称(作業名)を指定してください。
bp_name対象案件のビジネスプロセス定義名称を指定してください。
bp_version対象案件のビジネスプロセス定義バージョンを指定してください。
bp_type対象案件のビジネスプロセス定義の種別を指定してください。
"ind△":拡張ビジネスプロセス定義
"":ビジネスプロセス定義(4バイトのNULL文字を指定)
注 △は半角スペースを示します。
workid対象案件のワークIDを指定してください。
reserve予備領域です。NULL文字を指定してください。
(q) ワークヒストリの詳細
説明
HwfGetWorkHistoryDirect関数で取得するワークヒストリは,パラメタitemで指定した取得項目の指定順に,1作業種別1文字列のCSV形式でパラメタhistoryareaの領域に格納されます。
形式
<項目値>{','<項目値>・・・}'¥0'
<項目値>::各項目の値。値中に空白が含まれる場合もあります。
  • 値中に「,」の文字を含む場合,値を「"」で囲んで格納します。
    (例)「ABC,Z」は,「"ABC,Z"」として格納されます。
  • 値中に「"」の文字を含む場合,「"」を「""」に変換して格納します。
    (例)「ABC"Z」は,「ABC""Z」に変換して格納されます。
       「ABC,"Z」は,「"ABC,""Z"」に変換して格納されます。
  • 取得した項目に値がない場合は,・・・,,・・・となります。
    (例)案件投入のヒストリをパラメタitemに次の値を指定して取得した場合
    item:BWF_WH_TYPE,BWF_WH_DATE,BWF_WH_NODE_NAME1,BWF_WH_BP_NAME,BWF_WH_BP_VERSION
    取得ヒストリ:案件投入,19960101000000,ソース1,,
パラメタitemがBWF_WH_TYPE,BWF_WH_DATE,BWF_WH_NODE_NAME1,BWF_WH_NICK_NAME1,BWF_WH_USER_NAME1, BWF_WH_NODE_NAME2,BWF_WH_NICK_NAME2,BWF_WH_USER_NAME2のときのワークヒストリ。
案件投入,19960401120532​,旅費請求,H.SUZUKI,鈴木 花子...
案件移動完了,19960401120601​,旅費請求...審査,T.YAMADA,山田 太郎
案件遷移,19960402090451​,審査,T.YAMADA,山田 太郎...
履歴種別ごとに格納される項目については,ワークヒストリの作業種別ごとの格納項目を参照してください。
ワークヒストリの各項目の内容については,ワワークヒストリの項目の内容を参照してください。
(r) ワークヒストリの作業種別ごとの格納項目
(凡例)
○:取得できる情報
○元:案件の移動元の情報
○先:案件の移動先の情報
○実行:実行するユーザの情報
処理種別作業種別処理名処理日時ノ|ド名1ニックネ|ム1ユ|ザ名1ニックネ|ム1¨ユ|ザ名1組織略称1役職1ノ|ド名2ニックネ|ム2ユ|ザ名2ニックネ|ム2¨ユ|ザ名2組織略称2役職2ニックネ|ム3ユ|ザ名3ニックネ|ム3¨ユ|ザ名3組織略称3役職3任意情報エラ|コ|ドホスト名2ビジネスプロセス定義名称ビジネスプロセス定義バ|ジョンノ|ド名3窓口名ワ|クID
BWF_WH_PUT_CASE18案件投入                   
BWF_WH_GO_CASE13遷移指示                   
BWF_WH_CONSULT12相談○元○元○元○元○元○元 ○先○先○先○先○先             
BWF_WH_ANSWARE24回答○元○元○元○元○元○元 ○先○先○先○先○先             
BWF_WH_SEND_BACK32差し戻し○元○元○元○元○元○元○先○先○先○先○先○先             
BWF_WH_TAKE_BACK33引き戻し○元○元○元○元○元○元○先○先○先○先○先○先             
BWF_WH_FROM_ROLE21ロールから取得○元      ○先○先○先○先○先○実行○実行○実行○実行○実行        
BWF_WH_TO_ROLE22ロールへ返却○元○元○元○元○元○元      ○実行○実行○実行○実行○実行        
BWF_WH_TO_USER23振り替え○元○元○元○元○元○元 ○先○先○先○先○先○実行○実行○実行○実行○実行        
BWF_WH_SUSPEND14遷移中断○元○元○元○元○元○元      ○実行○実行○実行○実行○実行        
BWF_WH_RESUME16遷移再開始○元○元○元○元○元○元      ○実行○実行○実行○実行○実行        
BWF_WH_SUSPEND_WORK15ワーク遷移中断                         
BWF_WH_RESUME_WORK17ワーク遷移再開始            ○実行○実行○実行○実行○実行        
BWF_WH_CANCEL20ワーク遷移中止            ○実行○実行○実行○実行○実行        
BWF_WH_PUT_DATA25任意情報                        
BWF_WH_MOVE_CASE5遷移○元     ○先○先○先○先○先○先             
BWF_WH_ERROR7エラー発生○元      ○先○先○先○先○先            
BWF_WH_END_CASE34遷移終了                        
BWF_WH_CONNECT_BP29BP連携開始○元○元                  ○先○先○先○先  
BWF_WH_GOTO_EXT30BP連携成功○元○元                  ○先○先○先○先  
BWF_WH_PUT_CASE_FROM_BP46他BPから投入             ○元○元○元○元  
BWF_WH_SEND_BACK_TO_BP47他BPへ差し戻し○元○元○元○元○元○元             ○先○先○先○先  
BWF_WH_REMOVE_CASE48再送○元     ○先○先○先○先○先○先             
BWF_WH_GO_FORCE49強制遷移                   
BWF_WH_CONNECT_WF50他システムへ送付開始○元○元                   ○先  ○先 
BWF_WH_CONNECTED51他システムへ送付成功○元                       
BWF_WH_PUT_CASE_ADD_INF52他システムから投入                   ○元  ○元○元

注意:案件の強制遷移を行った場合,強制遷移処理を取得する指定で取得したワークヒストリは,作業種別「49」,処理名「強制遷移」となりますが,遷移指示だけを取得する指定で取得したワークヒストリは,作業種別「13」,処理名「遷移指示」となります。

(s) ワークヒストリの項目の内容
項目型,長さ内容
処理種別文字列,1~2バイト処理内容に対応した半角の数字。ワークヒストリの作業種別ごとの格納項目を参照してください。APで処理を区別したいときに使用します。今後のエンハンスで番号が追加となる可能性がありますので考慮が必要です。
処理名文字列,ワークヒストリの作業種別ごとの格納項目で示す処理名の最大長処理した内容。ワークヒストリの作業種別ごとの格納項目を参照してください。編集しないで表示したいときに使用するためのものです 。この値を処理を区別する処理に使用しないでください。区別するには処理種別の値を使用してください。また,今後のエンハンスで値が追加となる可能性がありますので考慮が必要です。
処理日時文字列,14バイト処理した日時をYYYYMMDDhhmmss形式で示します。この日時はPCで設定されているタイムゾーンによってローカル日時に変換されたものとなります。
ノード名1文字列,1~63バイト処理したノードのノード名。
ニックネーム1文字列,1~128バイト処理元のユーザのニックネーム。処理元のユーザが削除されている場合は,128バイト分'*'が設定されます。
ユーザ名1文字列,1~32バイト処理元のユーザのユーザ名(日本語名)。処理元のユーザが削除されている場合は,32バイト分'*'が設定されます。
ニックネーム1(ユーザ名1)文字列,1~162バイト処理元のユーザのニックネームとユーザ名。処理元のユーザが削除されている場合は,162バイト分'*'が設定されます。
組織略称1文字列,1~32バイト処理元のユーザが所属する組織の組織略称。処理元のユーザが削除されている場合は,32バイト分'*'が設定されます。
役職1文字列,1~32バイト処理元のユーザの役職。処理元のユーザが削除されている場合は,32バイト分'*'が設定されます。
ノード名2文字列,1~63バイト処理先のノードのノード名。
ニックネーム2文字列,1~128バイト処理先のユーザのニックネーム。処理先のユーザが削除されている場合は,128バイト分'*'が設定されます。
ユーザ名2文字列,1~32バイト処理先のユーザのユーザ名(日本語名)。処理先のユーザが削除されている場合は,32バイト分'*'が設定されます。
ニックネーム2(ユーザ名2)文字列,1~162バイト処理先のユーザのニックネームとユーザ名。処理先のユーザが削除されている場合は,162バイト分'*'が設定されます。
組織略称2文字列,1~32バイト処理先のユーザが所属する組織の組織略称。処理先のユーザが削除されている場合は,32バイト分'*'が設定されます。
役職2文字列,1~32バイト処理先のユーザの役職。処理先のユーザが削除されている場合は,32バイト分'*'が設定されます。
ニックネーム3文字列,1~128バイト処理実行ユーザのニックネーム。処理実行ユーザが削除されている場合は,128バイト分'*'が設定されます。
ユーザ名3文字列,1~32バイト処理実行ユーザのユーザ名(日本語名)。処理実行ユーザが削除されている場合は,32バイト分'*'が設定されます。
ニックネーム3(ユーザ名3)文字列,1~162バイト処理実行ユーザのニックネームとユーザ名。処理実行ユーザが削除されている場合は,162バイト分'*'が設定されます。
組織略称3文字列,1~32バイト処理実行ユーザが所属する組織の組織略称。処理実行ユーザが削除されている場合は,32バイト分'*'が設定されます。
役職3文字列,1~32バイト処理実行ユーザの役職。処理実行ユーザが削除されている場合は,32バイト分'*'が設定されます。
任意情報文字列,1~96バイトユーザが出力した任意の情報。
エラーコード文字列,8バイトエラー発生時のエラーのメッセージID。KDWMxxxx,又はKDWTxxxx。
ホスト名2文字列,1~63バイト転送先のサーバのホスト名。
ビジネスプロセス定義名称文字列,1~63バイト転送先のビジネスプロセス定義名称。
ビジネスプロセス定義バージョン文字列,1~8バイト転送先のビジネスプロセス定義のバージョン番号。半角の数字。投入できる最新ビジネスプロセス定義を指定して投入した案件の場合,ビジネスプロセス定義バージョンは-1を戻します。
ノード名3文字列,1~63バイト転送先のビジネスプロセス定義のノード名。
窓口名文字列,1~63バイト窓口名
ワークID文字列,1~63バイト連携先元のワークID

(12) オブジェクト操作AP関数

(a) HwfGetObjectAttributeEx(オブジェクト属性情報取得)
機能
次に示すオブジェクトの属性情報を取得します。
  • ビジネスプロセス定義
  • ワーク
  • 案件
  • ロール
  • ユーザ
オブジェクト内の任意の項目だけを取得できます。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetObjectAttributeEx(
 BWF_useroid_t __far *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,     /* サーバ名称格納領域 (I) */
 unsigned long       mode,      /* 処理モード (I) */
 unsigned long __far *selectparam,  /* 取得要求パラメタ (I) */
 unsigned long       selectparamn,  /* 取得要求パラメタ数 (I) */
 long                objectkind,   /* 属性取得オブジェクト種別 (I) */
 long                oidlistn,    /* 属性取得オブジェクトID数 (I) */
 BWF_oidlist_t __far *oidlist,    /* 属性取得オブジェクトID配列格納領域 (I) */
 void          __far *attrtable,   /* 属性情報取得領域 (O) */
 BWF_errlist_t __far *errlist     /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
mode
処理のモードを指定します。
0:指定した情報取得オブジェクトIDの中に一つでも存在しないものがあった場合,エラーリターンします。
1:指定した情報取得オブジェクトIDの中に存在しないものがあった場合,属性情報取得領域attrtableの,そのオブジェクトIDに対応する領域をNULLクリアして次のオブジェクトIDの処理をします。
selectparam
取得するオブジェクト情報のオブジェクト情報項目識別子を指定します。オブジェクト情報のオブジェクト情報項目識別子を指定した情報だけ取得できます。オブジェクト情報項目識別子は,配列で複数指定可能で,ここに指定した順番に連続してattrtable取得します。
取得できるオブジェクト情報項目を次に示します。
selectparamn
selectparamのオブジェクト情報項目識別子の数を指定します。1~700までの範囲内で指定してください。ただし,取得する属性のサイズの合計が32766バイトを超えた場合,この関数はエラーリターンします。
objectkind
属性情報を取得するオブジェクトの種別を指定します。
BWF_BP_OBJECT:ビジネスプロセス定義
BWF_WORK_OBJECT:ワーク
BWF_CASE_OBJECT:案件
BWF_ROLE_OBJECT:ロール
BWF_USER_OBJECT:ユーザ
oidlistn
属性を取得するオブジェクトのオブジェクトID数を指定します。
oidlist
属性情報を取得するオブジェクトのオブジェクトIDを格納した配列領域を指定します。oidlistに設定するオブジェクトIDは,objectkindに指定した種別によってその取得する関数が異なります。
objectkindと,該当するオブジェクトIDと,そのオブジェクトIDを取得できる主なAPI関数を次に示します。なお,異なった種別のオブジェクトIDを混在させないように注意してください。
objectkindオブジェクトID取得関数
BWF_BP_OBJECTHwfGetBusinessProcess
HwfGetWorkAttribute
HwfGetWorkAttributeSelectStatus
BWF_WORK_OBJECTHwfGetWorkAttribute
HwfGetWorkAttributeSelectStatus
BWF_CASE_OBJECTHwfGetCaseSelectData
BWF_ROLE_OBJECTHwfGetRoleAnd
BWF_USER_OBJECTHwfGetUserAnd
attrtable
attrtableに取得される項目は,selectparamに指定したオブジェクト情報項目識別子の順に,各項目のサイズで連続して取得されます。
オブジェクト項目リストのデータ型は,selectparamの順に従って,各アプリケーションで定義してください。
なお,必ずobjectkindに指定したオブジェクト種別に対応するデータ型の領域を,oidlistnに指定した要素数分以上取得して指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • oidlistに指定したオブジェクトIDと,objectkindに指定したオブジェクトの種別が対応していない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 本関数で取得できるBWF_CASE_OBJECTオブジェクト内のユーザ属性は,BWF_ATTR_CHAR_1~5,BWF_ATTR_INT_1~5,及びBWF_ATTR_TIME_1~5です。上記以外の属性の情報を取得する場合は,HwfGetAttributeValueByAttributeName()やHwfGetAttributeValueByUserDefName()を使用してください。ユーザ属性は,Groupmax Workflow Definerで登録した順序で取得されます。
(b) HwfSelectObjectId(オブジェクト識別子の検索)
機能
指定された条件に合致するオブジェクト識別子を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfSelectObjectId(
 BWF_useroid_t  __far  *useroid,   /* ユーザオブジェクトID設定領域 (I) */
 BWF_server_t   __far  *server,    /* サーバ名称設定領域 (I) */
 long                  objectkind,  /* オブジェクト種別 (I) */
 BWF_attr_cond_t __far *attrcond,   /* 属性条件 (I) */
 long                  attrcondn,   /* 属性条件の数 (I) */
 long                  attrop,    /* 条件 (I) */
 long                  number,    /* 取得するオブジェクト識別子の先頭番号 (I) */
 long                  oidlistn,   /* オブジェクト識別子リスト取得要素数 (I) */
 long            __far *total,    /* オブジェクト識別子リスト全要素数 (O) */
 long            __far *count,    /* 取得オブジェクト識別子リスト要素数 (O) */
 BWF_oid_t       __far *oidlist,   /* オブジェクト識別子リスト取得領域 (I/O) */
 BWF_errlist_t   __far *errlist,   /* エラー情報取得領域 (O) */
 void            __far *arg      /* 拡張用領域のアドレス*/
);
typedef struct BWF_attr_cond_t {
 long         BWF_attr_name;        /* 属性名称 */
 long         BWF_attr_operator;      /* 比較演算子 */
 BWF_oid_t    BWF_attr_value_oid;     /* オブジェクト型属性の条件値 */
 char         BWF_attr_value_char[128];  /* 文字列型属性の条件値 */
 long         BWF_attr_value_long;     /* 整数型属性の条件値 */
 BWF_time_t   BWF_attr_value_time;     /* 日付型属性の条件値 */
 char         reserved[64];        /* 予備領域 */
} BWF_attr_cond_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
objectkind
属性情報を検索するオブジェクトの種別を指定します。
BWF_BP_OBJECT:ビジネスプロセス定義
BWF_WORK_OBJECT:ワーク
BWF_CASE_OBJECT:案件
BWF_ROLE_OBJECT:ロール
BWF_USER_OBJECT:ユーザ
attrcond
属性検索条件を指定します。
比較対象となる属性値は,BWF_attr_nameに指定したオブジェクト属性項目識別子に対応する属性型を設定します(BWF_attr_value_oid,BWF_attr_value_char,BWF_attr_value_time,BWF_attr_value_longのうち,属性型に対応する項目にだけ値を設定してください)。
比較対象となる属性値については,属性検索条件内項目を参照してください。
attrcondn
attrcondパラメタで指定した属性条件の数を指定します。属性条件数は1~100の範囲内で設定してください。
attrop
複数の属性条件を指定した場合の論理演算子を次から指定します。
0:論理積
1:論理和
条件が1つの場合は0を指定してください。
number
条件に合うオブジェクト識別子の取得する要素の先頭番号を指定します。先頭番号は,0~(total-1)の範囲内で設定してください。
oidlistn
オブジェクト識別子リストを取得する要素数を指定します。1~4095の範囲内で設定してください。
total
オブジェクト識別子リストの取得できる全要素数を取得する領域を指定します。
count
このAPI関数が取得した,オブジェクト識別子リストの要素数を取得する領域を指定します。
oidlist
オブジェクト識別子リストを取得する領域を指定します。なお,この領域のサイズは,oidlistnで指定した要素数分のサイズを必ず確保してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
拡張用の領域を指定します。NULLを指定してください。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 取得したオブジェクトの属性値はHwfGetObjectAttributeEx関数などで取得できます。
  • 検索条件に合うオブジェクトが無い場合は,totalは0でこのAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • number≧totalの場合は,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となり,totalに検索条件に合ったオブジェクト数が設定されます。
  • ログインサーバ以外のサーバのオブジェクトは検索対象とはなりません。
  • この関数で検索案件情報項目(BWF_CASE_OBJECT)として指定できるユーザ属性は,BWF_ATTR_CHAR_1~5,BWF_ATTR_INT_1~5,及びBWF_ATTR_TIME_1~5です。ユーザ属性をキーとして検索を行う場合は,検索キーとなるユーザ属性が上記の範囲内になるように定義してください。ユーザ属性は,Groupmax Workflow Definerで登録順番を指定することができます。
(c) 取得オブジェクト情報項目(BWF_BP_OBJECT)
ビジネスプロセス定義情報項目識別子項目名型(サイズ)備考
BWF_BP_BP_OIDビジネスプロセス定義オブジェクトIDBWF_bpid_tオブジェクトID型
BWF_BP_BP_NAMEビジネスプロセス定義名称char[64]char型
BWF_BP_CREATE_NAME登録ユーザIDchar[8]char型
BWF_BP_CREATE_TIME登録日時(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_BP_BP_VERSION_NUMBERビジネスプロセス定義バージョン番号unsigned longunsigned long型
BWF_BP_WORK_COUNTビジネスプロセス定義で処理中のワーク数unsigned longunsigned long型
BWF_BP_USER_KEY案件識別子フォーマットBWF_userkey_tBWF_userkey_t型
BWF_BP_DEFINE_CREATE_NAME作成ユーザの別名char[64]char型
BWF_BP_DEFINE_TIME作成日時(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_BP_EXEC_STATUS_CODE運用状態
act△:
運用可能状態(案件が投入できる状態)
dea△:
運用不可状態(案件が投入できない状態)
actc:
運用可能状態で,かつ最新バージョン
注 △は,スペースを示します。
char[4]char型
BWF_BP_PROCESS_LIMIT_TIMEデフォルト処理期限(秒単位)unsigned longunsigned long型
BWF_BP_SINK_LIMIT_TIMEシンク後ワークの保存期間(秒単位)unsigned longunsigned long型
BWF_BP_TYPEビジネスプロセス定義種別
"":ビジネスプロセス定義
ind△:拡張ビジネスプロセス定義
注 △は,スペースを示します。
char[4]char型
BWF_BP_COMMENTビジネスプロセス定義を作成したときに記述したコメントchar[128]char型
(d) 取得オブジェクト情報項目(BWF_WORK_OBJECT)
ワーク情報項目識別子項目名型(サイズ)備考
BWF_WK_OIDワークオブジェクトIDBWF_workid_tオブジェクトID型
BWF_WK_USER_KEYワークID(案件識別子フォーマット)BWF_userkey_tBWF_userkey_t型
BWF_WK_CREATE_NAME作成ユーザIDchar[8]char型
BWF_WK_CREATE_TIME作成時間(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_WK_PROCESS_LIMIT_TIME処理期限(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_WK_PRIORITY_CODE優先度
com△:普通
urg△:至急
注 △はスペースを示します。
char[4]char型
BWF_WK_BP_OIDビジネスプロセス定義オブジェクトIDBWF_bpid_tBWF_bpid_t型
BWF_WK_CASE_COUNTワーク下にある案件の個数unsigned longunsigned long型
BWF_WK_STATUS_CODE案件の動作状態
act△:
動作可能状態
sup△:
動作中断状態
can△:
キャンセル予約状態
can2:
ワーク以下案件削除状態
sink:
終了済み状態
注 △はスペースを示します。
char[4]char型
BWF_WK_TITLE案件タイトルchar[64]char型
(e) 取得オブジェクト情報項目(BWF_USER_OBJECT)
ユーザ情報項目識別子項目名型(サイズ)備考
BWF_US_OIDユーザオブジェクトIDBWF_useroid_tオブジェクトID型
BWF_US_USER_IDユーザIDchar[8]char型
BWF_US_USER_ALIAS_NAMEユーザ別名(ユーザ日本語名称)char[64]char型
BWF_US_CREATE_NAME登録ユーザIDchar[8]char型
BWF_US_CREATE_TIME登録日時(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_US_CASE_COUNTトレー内案件数unsigned longunsigned long型
BWF_US_STATUS_CODEユーザ状態コード
act△:
受付許可状態
dea△:
代行者配布状態
inac:
受付禁止状態
注 △は,スペースを示します。
char[4]char型
BWF_US_APPROVAL_CODE印章情報オブジェクトIDBWF_oid_tBWF_oid_t型
BWF_US_DISTINCTION_CODEユーザ権限コード
sys△:
systemユーザ
wfm△:
ワークフロー管理者
gen△:
一般ユーザ
注 △は,スペースを示します。
このパラメタの取得値は,Groupmax Workflow Client - Library 02-10以降に初めてアプリケーションを作成する場合は,意味を持ちません。
char[4]char型
BWF_US_ADDRESS_NICKNAMEGroupmax Addressニックネームchar[132]char型
BWF_US_ADDRESS_JNAMEGroupmax Address日本語名char[36]char型
BWF_US_ADDRESS_SECTIONGroupmax Address組織略称char[36]char型
BWF_US_ADDRESS_POSTGroupmax Address役職名称char[36]char型
BWF_US_COMMENTコメントchar[128]char型
BWF_US_USER_ATTR_1ユーザ属性1char[64]char型
BWF_US_USER_ATTR_2ユーザ属性2char[64]char型
(f) 取得オブジェクト情報項目(BWF_ROLE_OBJECT)
ロール情報項目識別子項目名型(サイズ)備考
BWF_RL_OIDロールオブジェクトIDBWF_roleid_tオブジェクトID型
BWF_RL_ROLE_NAMEロール名称char[64]char型
BWF_RL_ROLE_TYPEロール種別
BWF_BP_ROLE_TYPE:
業務ロール
BWF_ORG_ROLE_TYPE:
組織ロール
BWF_HIER_ROLE_TYPE:
階層化ロール
BWF_V1BP_ROLE_TYPE:
V1業務ロール
BWF_ALL_USER_ROLE_TYPE:
全ユーザ参加ロール
unsigned longunsigned long型
BWF_RL_CREATE_NAME登録ユーザIDchar[8]char型
BWF_RL_CREATE_TIME登録日時(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_RL_CASE_COUNTロールトレー案件数unsigned longunsigned long型
BWF_RL_USER_ATTRユーザ属性値(コメント)char[128]char型
BWF_RL_ORG_ID組織ID
※ ロール種別が「組識ロール」の場合だけ,この値は意味を持ちます。
char[8]char型
BWF_RL_ORG_TYPE組織種別
BWF_TOP_ORG:最上位組識
BWF_LOW_ORG:組織
※ ロール種別が「組識ロール」の場合だけ,この値は意味を持ちます。
unsigned longunsigned long型
(g) 属性検索条件内項目
項目内容
BWF_attr_name検索対象とするオブジェクト属性項目識別子を指定します。
オブジェクト属性項目識別子は,次に示す検索属性項目識別子を参照してください。
BWF_attr_operator属性値との比較の演算子を次に示すキーで指定します。
BWF_EQ_ATTR_OPERATOR:等しい
BWF_NE_ATTR_OPERATOR:等しくない
BWF_GT_ATTR_OPERATOR:より大きい
BWF_GE_ATTR_OPERATOR:以上
BWF_LT_ATTR_OPERATOR:未満
BWF_LE_ATTR_OPERATOR:以下
BWF_attr_value_oidオブジェクトID型の属性値を指定します。
BWF_attr_value_charchar型の属性値を指定します(終端にNULL文字を付けた,最大128バイトの文字列を指定してください)。
BWF_attr_value_longlong型の属性値を指定します(0から2147483647​までの整数を指定してください)。
BWF_attr_value_timeBWF_time_t型の属性値を指定します(YYYYMMDDhhmmss形式で指定してください)。
(h) 検索オブジェクト情報項目(BWF_BP_OBJECT)
ビジネスプロセス定義
情報項目識別子
項目名型(サイズ)備考
BWF_BP_BP_OIDビジネスプロセス定義オブジェクトIDBWF_bpid_tオブジェクトID型
BWF_BP_BP_NAMEビジネスプロセス定義名称char[64]char型
BWF_BP_CREATE_NAME登録ユーザIDchar[8]char型
BWF_BP_CREATE_TIME登録日時BWF_time_tBWF_time_t型
BWF_BP_BP_VERSION_NUMBERビジネスプロセス定義バージョン番号unsigned longunsigned long型
BWF_BP_WORK_COUNTビジネスプロセス定義で処理中のワーク数unsigned longunsigned long型
BWF_BP_USER_KEY案件識別子フォーマットchar[64]char型
BWF_BP_DEFINE_CREATE_NAME作成ユーザの別名char[64]char型
BWF_BP_DEFINE_TIME作成日時BWF_time_tBWF_time_t型
BWF_BP_EXEC_STATUS_CODE運用状態char[4]char型
BWF_BP_PROCESS_LIMIT_TIMEデフォルト処理期限(秒単位)unsigned longunsigned long型
BWF_BP_SINK_LIMIT_TIMEシンク後ワークの保存期間(秒単位)unsigned longunsigned long型
BWF_BP_TYPEビジネスプロセス定義種別char[4]char型
BWF_BP_COMMENTビジネスプロセス定義を作成したときに記述したコメントchar[128]char型
(i) 検索オブジェクト情報項目(BWF_WORK_OBJECT)
ワーク情報項目識別子項目名型(サイズ)備考
BWF_WK_OIDワークオブジェクトIDBWF_workid_tオブジェクトID型
BWF_WK_USER_KEYワークID(案件識別子フォーマット)char[64]char型
BWF_WK_CREATE_NAME作成ユーザIDchar[8]char型
BWF_WK_CREATE_TIME作成時間(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_WK_PROCESS_LIMIT_TIME処理期限(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_WK_PRIORITY_CODE優先度char[4]char型
BWF_WK_BP_OID_tビジネスプロセス定義オブジェクトIDBWF_bpidBWF_bpid_t型
BWF_WK_CASE_COUNTワーク下にある案件の個数unsigned longunsigned long型
BWF_WK_STATUS_CODE案件の動作状態char[4]char型
BWF_WK_TITLE案件タイトルchar[64]char型
(j) 検索オブジェクト情報項目(BWF_USER_OBJECT)
ユーザ情報項目識別子項目名型(サイズ)備考
BWF_US_OIDユーザオブジェクトIDBWF_useroid_tオブジェクトID型
BWF_US_USER_IDユーザIDchar[8]char型
BWF_US_USER_ALIAS_NAMEユーザ別名(ユーザ日本語名称)char[64]char型
BWF_US_CREATE_NAME登録ユーザIDchar[8]char型
BWF_US_CREATE_TIME登録日時BWF_time_tBWF_time_t型
BWF_US_CASE_COUNTトレー内案件数unsigned longunsigned long型
BWF_US_STATUS_CODEユーザ状態コードchar[4]char型
BWF_US_APPROVAL_CODE印章情報オブジェクトIDBWF_oid_tオブジェクトID型
BWF_US_DISTINCTION_CODEユーザ権限コードchar[4]char型
BWF_US_COMMENTコメントchar[128]char型
(k) 検索オブジェクト情報項目(BWF_ROLE_OBJECT)
ロール情報項目識別子項目名型(サイズ)備考
BWF_RL_OIDロールオブジェクトIDBWF_roleid_tオブジェクトID型
BWF_RL_ROLE_NAMEロール名称char[64]char型
BWF_RL_ROLE_TYPEロール種別unsigned longunsigned long型
BWF_RL_CREATE_NAME登録ユーザIDchar[8]char型
BWF_RL_CREATE_TIME登録日時BWF_time_tBWF_time_t型
BWF_RL_ORG_ID組織IDchar[8]char型
BWF_RL_ORG_TYPE組織種別unsigned longunsigned long型
(l) 検索案件情報項目(BWF_CASE_OBJECT)
案件情報項目識別子項目名型(サイズ)備考
BWF_CASE_OID案件オブジェクトIDBWF_caseid_tオブジェクトID型
BWF_CASE_NAME案件名称char[64]char型
BWF_CASE_ALIAS_NAMEノード名char[64]char型
BWF_USER_KEYワークID(案件識別子フォーマット)BWF_userkey_tchar型
BWF_CREATE_NAME作成者char[8]char型
BWF_CREATE_USER_OID作成者ユーザオブジェクトIDBWF_useroid_tオブジェクトID型
BWF_CREATE_TIME作成日時(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_ARRIVAL_TIME到着日時(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_PROCESS_LIMIT_TIME処理期限(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_BP_NAMEビジネスプロセス定義名称char[64]char型
BWF_BP_OIDビジネスプロセス定義オブジェクトIDBWF_bpid_tオブジェクトID型
BWF_BP_VERSION_NUMBERビジネスプロセス定義バージョン番号unsigned longunsigned long型
BWF_MEMO_OBJECT_COUNTメモ数unsigned longunsigned long型
BWF_REPORT_OBJECT_COUNT文書数unsigned longunsigned long型
BWF_TRAY_KIND_CODEトレー種別char[4]char型
BWF_USER_OIDユーザオブジェクトIDBWF_useroid_tオブジェクトID型
BWF_ROLE_OIDロールオブジェクトIDBWF_roleid_tオブジェクトID型
BWF_WORK_OIDワークオブジェクトIDBWF_workid_tオブジェクトID型
BWF_CASE_CLASS_KIND_CODE階層種別char[4]char型
BWF_UP_CASE_OID上位案件オブジェクトIDBWF_caseid_tオブジェクトID型
BWF_DOWN_CASE_COUNT下位案件数unsigned longunsigned long型
BWF_STATUS_CODE_1処理状態コードchar[4]char型
BWF_STATUS_CODE_2遷移状態コードchar[4]char型
BWF_CURRENT_NODE_IDカレントノードIDBWF_nodeno_tオブジェクトID型
BWF_PRIORITY_CODE優先度char[4]char型
BWF_PROCESS_KIND_CODE案件処理種別char[4]char型
BWF_ATTR_CHAR_1ユーザ属性1char[32]char型
BWF_ATTR_CHAR_2ユーザ属性2char[32]char型
BWF_ATTR_CHAR_3ユーザ属性3char[32]char型
BWF_ATTR_CHAR_4ユーザ属性4char[32]char型
BWF_ATTR_CHAR_5ユーザ属性5char[32]char型
BWF_ATTR_INT_1ユーザ属性6longlong型
BWF_ATTR_INT_2ユーザ属性7longlong型
BWF_ATTR_INT_3ユーザ属性8longlong型
BWF_ATTR_INT_4ユーザ属性9longlong型
BWF_ATTR_INT_5ユーザ属性10longlong型
BWF_ATTR_TIME_1ユーザ属性11(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_ATTR_TIME_2ユーザ属性12(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_ATTR_TIME_3ユーザ属性13(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_ATTR_TIME_4ユーザ属性14(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_ATTR_TIME_5ユーザ属性15(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_EXATTR_CHAR_COUNT文字型ユーザ属性数(六つ目以降の数)unsigned longunsigned long型
BWF_EXATTR_INT_COUNT整数型ユーザ属性数(六つ目以降の数)unsigned longunsigned long型
BWF_EXATTR_TIME_COUNT日時型ユーザ属性数(六つ目以降の数)unsigned longunsigned long型
BWF_BROADCAST_STATUS同報状態コードchar[4]char型
BWF_EXCEPT_REQ_USER_OID例外要求元ユーザオブジェクトIDBWF_useroid_tオブジェクトID型
BWF_TITLE案件タイトルchar[64]char型
BWF_CLIENT_OID代行元ユーザオブジェクトIDBWF_useroid_tオブジェクトID型
BWF_TRAY_ARRIVAL_TIMEトレー到着日時(YYYYMMDDhhmmss形式BWF_time_tBWF_time_t型
BWF_CS_ERROR_CODEエラーコードchar[8]char型
BWF_CS_ERROR_RECOVER_LEVEL復帰可否レベルchar[4]char型
BWF_CS_BP_TYPEビジネスプロセス定義種別char[4]char型
BWF_SOURCE_CASE_OIDビジネスプロセス定義登録サーバ上の案件オブジェクトIDBWF_caseid_tオブジェクトID型

(13) その他のAP関数

(a) HwfConvertNodeid(ノードIDからノード名称への変換)
機能
ノードIDを,ユーザが認識できるノード名称に変換します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfConvertNodeid(
 BWF_useroid_t __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,   /* サーバ名称格納領域 (I) */
 BWF_nodeno_t  __far *nodeid,   /* ノードID格納領域 (I) */
 char          __far *nodename,  /* ノード名称格納領域 (O) */
 BWF_workid_t  __far *workid,   /* ワークオブジェクトID格納領域 (I) */
 BWF_errlist_t __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
nodeid
ノード名称に変換するノードIDを指定します(HwfGetCaseSelectDataなどで取得できます)。
nodename
nodeidに対応するノード名称を格納する領域を指定します(64バイト以上の格納領域を指定してください)。
workid
ワークオブジェクトIDを指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(b) HwfInitArrivedCaseList(ユーザトレー内着信案件情報の初期化)
機能

HwfGetArrivedCaseListで作成した,ユーザ対応の着信案件情報格納ファイルの次に示す情報を初期化します。ユーザ対応の着信案件情報格納ファイルがない場合は,新規に作成し,最新到着案件時刻,到着案件オブジェクトID配列エントリ数だけ以下と同様に設定し,到着案件オブジェクトID配列に関しては何も出力しません。

使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfInitArrivedCaseList(
 BWF_useroid_t  __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,   /* サーバ名称格納領域 (I) */
 BWF_errlist_t  __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(c) HwfGetArrivedCaseList(ユーザトレー内着信案件情報の取得)
機能
指定されたユーザのユーザトレーに到着した(自動配布された)単独,又は上位案件の有無を調べ,HwfInitArrivedCaseListの発行後に到着した(自動配布された)単独,又は上位案件があれば,その案件に関する情報をファイルに出力します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetArrivedCaseList(
 BWF_useroid_t __far  *useroid,     /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far  *server,      /* サーバ名称格納領域 (I) */
 unsigned long __far  *arrivedstatus,  /* 案件着信状況 (O) */
 BWF_doclist_t __far  *filename,     /* 着信案件情報格納ファイル名 (O) */
 BWF_errlist_t __far  *errlist      /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
arrivedstatus
useroidに指定したユーザのユーザトレーに到着した(自動配布された)単独,又は上位案件の存在の有無が設定されます(着信案件情報格納ファイル内の到着案件オブジェクトID配列エントリ数が0か否かで判定します)。
BWF_ARRIVED_CASE:到着案件あり(直前に発行したこのAPI関数の結果がBWF_NEW_ARRIVED_CASE,又はBWF_ARRIVED_CASEでHwfInitArrivedCaseListで初期化しないで,再度このAPI関数を発行する間までに到着した(自動配布された)案件がなかった場合に設定されます)
BWF_NEW_ARRIVED_CASE:到着案件あり(直前に発行したHwfInitArrivedCaseList,又はこのAPI関数の発行後から,このAPI関数を発行する間までに到着した(自動配布された)案件がある場合に設定されます)
BWF_NON_ARRIVED_CASE:到着案件なし
filename
useroidに指定したユーザのユーザトレーに到着した(自動配布された)単独,又は上位案件の情報が格納された着信案件情報格納ファイル名称を取得する領域を指定します。
着信案件情報格納ファイルの形式を次に示します。
項目属性長さ
(バイト)
内容
最終チェック時刻符号なし整数4直近のHwfInitArrivedCaseList,又はこのAPI関数の発行時刻が設定されます。なお,時刻については1970/01/01 00:00:00(GMT)からの経過秒として設定されます。
到着案件オブジェクト
ID配列エントリ数
符号なし整数4到着案件オブジェクトID配列に設定されている単独,又は上位案件の案件オブジェクトIDのエントリ数が設定されます。
到着案件オブジェクトID配列符号なし文字8×n(n≧0)useroidに指定したユーザのユーザトレーに到着した(自動配布された)単独,又は上位案件の案件オブジェクトIDが到着案件数分,到着時刻の昇順で設定されます。
着信案件情報格納ファイルの作成方法を次に示します。
●着信案件情報格納ファイルがある場合
  • 最終チェック時刻
    このAPI関数の発行時刻が設定されます。
  • 到着案件オブジェクトID配列エントリ数
    最終チェック時刻以降にユーザトレーに到着した(自動配布された)単独,又は上位案件(案件の到着時刻が最終チェック時刻以降のもの)があった場合,その総数を加算します。
  • 到着案件オブジェクトID配列
    最終チェック時刻以降にユーザトレーに到着した(自動配布された)単独,又は上位案件(案件の到着時刻が最終チェック時刻以降のもの)を到着時刻の昇順に並べ替えて,到着案件オブジェクトIDを既存部分の最終に追加格納します。
●着信案件情報格納ファイルがない場合
着信案件情報格納ファイルを作成し,次に示す情報を設定します(着信案件情報格納ファイルを作成した時点では,最終チェック時刻,到着案件オブジェクトID配列エントリ数共に0で初期化され,その後の処理によって,次に示す情報が設定されます)。
  • 最終チェック時刻
    このAPI関数の発行時刻が設定されます。
  • 到着案件オブジェクトID配列エントリ数
    ユーザトレー内にある単独,又は上位案件数が設定されます。
  • 到着案件オブジェクトID配列
    ユーザトレー内に単独,又は上位案件があった場合,到着時刻の昇順に並べ替えて,到着案件オブジェクトIDを格納します。
    着信案件情報格納ファイルのドライブ,パス,ファイル名を次に示します。
  • ドライブ,パス名
    windowsのディレクトリ下のflowmate.iniファイル内の[Flowmate]セクションのTmpエントリに指定されたドライブ,パス名を使用します。
  • ファイル名称
    「useroidに対応するログインユーザ名称(最大8バイト).acl」の形式でファイル名称を設定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 着信案件情報格納ファイル内の到着案件オブジェクトID配列での,案件オブジェクトIDに対応する案件の優先度等を取得する場合は,HwfGetCaseSelectDataなどで取得してください。
(d) HwfTakeOperationInf(作業情報からの属性情報の取り出し)
機能
HwfGetCaseFormSelectEx,又はHwfGetOperationで取得した,ユーザ処理リストのある1レコード内の種別コードが,次に示すコードの場合,属性情報(属性名称,ユーザ定義名称,属性型,候補値など)を取り出します(なお,ユーザ処理リスト内の次に示す種別コードに対して,「前の作業種別の継続(”99”)」の種別コードを持つものがあった場合,そのすべてを指定する必要があります。詳細については,HwfGetCaseFormSelectEx,又はHwfGetOperationを参照してください)。
  • 案件に文書を追加格納(”02”)
  • 案件のユーザ属性に任意値設定(”03”)
  • 案件のユーザ属性に候補値設定(”04”)
  • 案件の任意ユーザ状態コードへ候補値設定(”08”)
  • 案件の属性値を一覧表示時に出力(”09”)
  • 案件の複写先を指定(”13”)
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfTakeOperationInf(
 BWF_useroid_t  __far  *useroid,       /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far  *server,       /* サーバ名称格納領域  (I) */
 unsigned long         datamode,       /* 取出元情報種別 (I) */
 unsigned long         listn,        /* 取出元情報格納領域内格納数 (I) */
 void           __far  *list,        /* 取出元情報格納領域 (I) */
 unsigned long         topnum,        /* 候補値取得先頭位置格納領域 (I) */
 unsigned long         reqnum,        /* 候補値取得数格納領域 (I) */
 char           __far  *attrname,      /* 属性名称取得領域 (O) */
 char           __far  *userdefname,     /* ユーザ定義名称取得領域 (O) */
 char           __far  *attrtype,      /* 属性型取得領域 (O) */
 char           __far  *nodename,      /* 複写ノード名称 (O) */
 BWF_candidateval_t __far  *candidateval,  /* 候補値取得領域 (O) */
 unsigned long  __far  *getnum,       /* 取得候補値数取得 (O) */
 unsigned long  __far  *allnum,       /* 取得可能候補値数取得領域 (O) */
 BWF_errlist_t  __far  *errlist       /* エラー情報取得領域 (O) */
);
typedef struct BWF_candidateval_t {
 char  sBcandidatevalue[64];  /* 候補値 (O) */
} BWF_candidateval_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];   /* メッセージ区分 (O) */
 long lBMsgNo;     /* メッセージ番号 (O) */
 char sBInsWord[13];  /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
datamode
作業情報が格納されている領域のフォーマットを指定します。
BWF_OPERATIONLISTを指定してください。BWF_OPERATIONLISTは,HwfGetOperation,HwfGetCaseFormSelectExで取得したユーザ処理リストを表します。
listn
listに指定したフォームリスト,又はユーザ処理リストの要素数を指定します(取り出し対象となる種別コードを持った,フォームリスト,又はユーザ処理リストに「前の作業種別の継続(”99”)」の種別コードを持つものがあった場合,その全数を指定してください。「前の作業種別の継続(”99”)」については,HwfGetCaseFormSelectEx,又はHwfGetOperationを参照してください)。
list
datamodeにBWF_FORM_LISTを指定した場合,フォームリストを格納した領域を指定します。
datamodeにBWF_OPERATIONLISTを指定した場合,ユーザ処理リストを格納した領域を指定します。
(取り出し対象となる種別コードを持った,フォームリスト,又はユーザ処理リストに「前の作業種別の継続(”99”)」の種別コードを持つものがあった場合,そのフォームリスト,又はユーザ処理リストをすべて指定してください。「前の作業種別の継続(”99”)」については,HwfGetCaseFormSelectEx,又はHwfGetOperationを参照してください)。
topnum
listに指定したフォームリスト,又はユーザ処理リスト内の作業情報に候補値が設定されている場合,candidatevalに取り出す候補値の先頭番号を0以上の値で指定します。
reqnum
topnumに指定した候補値から,幾つ候補値をcandidatevalに取り出すかを指定します。
最大200まで指定できます。
attrname
listに指定したフォームリスト,又はユーザ処理リスト内の作業情報に属性名称が設定されている場合,属性名称を取得する領域を指定します。(必ず32バイト以上の領域を指定してください)。
その領域に,HwfSetCase,HwfGetCaseExistUserAttrValue,HwfGetAttributeValueByAttributeNameのパラメタとして指定する案件のユーザ属性に対応する属性名称が,終端にNULL文字を付けた最大32バイトの文字列で設定されます。
userdefname
listに指定したフォームリスト,又はユーザ処理リスト内の作業情報にユーザ定義名称が設定されている場合,ユーザ定義名称を取得する領域を指定します(必ず64バイト以上の領域を指定してください)。
その領域に,Groupmax Workflow Definerで指定した案件のユーザ属性に対応するユーザ定義名称が,終端にNULL文字を付けた最大64バイトの文字列で設定されます。
これを,HwfGetAttributeValueByUserDefName,HwfSetCaseByUserDefNameのパラメタとして指定します。
attrtype
listに指定したフォームリスト,又はユーザ処理リスト内の作業情報に属性型が設定されている場合,属性型を取得する領域を指定します(必ず4バイト以上の領域を指定してください)。
candidatevalに格納されている候補値の属性型が設定されます(領域の余った部分には,NULL文字が設定されます)。
01:文字型
02:数値型
03:日時型
nodename
listに指定したフォームリスト,又はユーザ処理リスト内の作業情報に複写ノード名称が指定されている場合,複写ノード名称を取得する領域を指定します(必ず64バイト以上の領域を指定してください)。
その領域に,HwfCreateCopyInf,又はHwfGetNodeNameFromCopyInfのパラメタとして指定する複写ノード名称が,終端にNULL文字を付けた最大64バイトの文字列で設定されます。
candidateval
listに指定したフォームリスト,又はユーザ処理リスト内の作業情報に候補値が設定されている場合,候補値を取得する配列領域を指定します(必ずreqnumに指定した以上の領域を指定してください)。
候補値は,attrtypeに示した属性型に関係なく,終端にNULL文字を付けた最大64バイトの文字列で設定されます。
getnum
listに指定したフォームリスト,又はユーザ処理リスト内の作業情報に候補値が設定されている場合,topnum,reqnumに指定された数に従って,candidatevalに設定した候補値の数を指定します。
allnum
listに指定したフォームリスト,又はユーザ処理リスト内の作業情報に候補値が設定されている場合,listに指定した領域内の作業情報に格納されている候補値の全数を指定します。
なお,出力パラメタであるattrname,userdefname,attrtype,nodename,candidateval,getnum,allnumはlistに指定したフォームリスト,又はユーザ処理リスト内の種別コードによって,設定される項目と設定されない項目があります(設定されない場合,文字列に関してはすべてNULL文字が,整数に関しては0が設定されますが,設定される,されないに関係なく,上記の出力パラメタは必ず指定してください)。
種別コード対応に設定される出力パラメタ項目については,種別コード対応出力パラメタ設定可否項目一覧を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • listにフォームリスト,又はユーザ処理リスト以外が指定された場合,動作は保証しません。
  • datamodeに指定された種別と,listに指定したデータの形式が対応しない場合の結果は保証しません。
  • listに指定したフォームリスト,又はユーザ処理リストに作業情報の取り出し対象となる種別コードがない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • listに取り出し対象となる種別コードを持ったフォームリスト,又はユーザ処理リストに「前の作業種別の継続(”99”)」の種別コードを持つものがあった場合,それを順序通り,かつその全数をlistnに指定しなかった場合の動作は保証しません。
  • topnumパラメタで指定した値がallnumパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。ただし,topnumパラメタの値とallnumパラメタの値が共に0の場合を除きます。
(e) HwfCreateCopyInf(複写ノードでの案件複写先ノード情報の生成)

この関数は,バージョン2との互換用API関数です。

新しくアプリケーションを作成する場合は,HwfCreateCopyInfExを使用してください。

機能
HwfGetCaseFormSelectEx,又はHwfGetOperationから取得したユーザ処理リスト内の作業情報に設定された属性名称,ユーザ定義名称,複写ノード名称のどちらかと,案件の複写先ノード名称から,指定された複写先ノード名称(Groupmax Workflow Definerで指定されたオリジナルケースの送付先ノードを除いた)に対応する案件複写先ノード情報を生成します。
フォームリスト,又はユーザ処理リスト内の作業情報に設定された属性名称,ユーザ定義名称,複写ノード名称,案件の複写先ノード名称は,次に示す方法で取得できます。
  • HwfGetCaseFormSelectEx,又はHwfGetOperationで取得したユーザ処理リスト内の作業情報から,HwfTakeOperationInfによって,属性名称,ユーザ定義名称,複写ノード名称,複写先ノード名称を取り出します。
  • HwfGetCaseFormSelectEx,又はHwfGetOperationで取得したユーザ処理リスト内の作業情報から,アプリケーションが独自に属性名称,ユーザ定義名称,複写ノード名称,案件の複写先ノード名称を取り出します。
ここで生成した情報を,HwfSetCase,又はHwfSetCaseByUserDefNameのパラメタとして指定することによって,複写ノードでの複写先を動的に指定できます。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfCreateCopyInf(
 BWF_useroid_t   __far *useroid,     /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t    __far *server,     /* サーバ名称格納領域 (I) */
 BWF_caseid_t    __far *caseid,     /* 複写先情報登録案件オブジェクトID格納領域 (I) */
 unsigned long         srchkeymode,   /* 作業情報検索キーモード (I) */
 char            __far *srchkey,     /* 作業情報検索キー格納領域 (I) */
 unsigned long         tocopynoden,   /* 複写先ノード名リスト数 (I) */
 BWF_nodename_t  __far *nodenamelist,  /* 複写先ノード名リスト格納領域 (I) */
 unsigned char   __far *tocopyinf,    /* 案件複写先情報取得領域 (O) */
 BWF_errlist_t   __far *errlist     /* エラー情報取得領域 (O) */
);
typedef struct BWF_nodename_t {
 char sBnodename[64];  /* 複写先ノード名称 */
} BWF_nodename_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
案件の案件オブジェクトIDを格納した領域を指定します。
案件オブジェクトIDは,HwfGetCaseSelectDataなどで取得できます。
srchkeymode
複写先ノード情報を取得するときに必要な作業情報を検索するためのキーのモードを指定します。
BWF_ATTRIBUTE_NAME:属性名称
BWF_USER_DEF_NAME:ユーザ定義名称
BWF_COPY_NODE_NAME:複写ノード名称
srchkey
複写先ノード情報を取得するときに必要な作業情報を検索するためのキーを格納した領域を指定します。
srchkeymodeにBWF_ATTRIBUTE_NAMEを指定した場合,終端にNULL文字を付けた32バイト以内の文字列で,属性名称を指定してください。
srchkeymodeにBWF_USER_DEF_NAMEを指定した場合,終端にNULL文字を付けた64バイト以内の文字列で,ユーザ定義名称を指定してください。
srchkeymodeにBWF_COPY_NODE_NAMEを指定した場合,終端にNULL文字を付けた64バイト以内の文字列で,複写ノード名称を指定してください(属性名称,ユーザ定義名称,複写ノード名称の取得方法については,機能を参照してください)。
tocopynoden
nodenamelistに格納した複写先ノード名称の数を指定します。
複写先ノード名称の数は,0~200の範囲で指定してください。
0を指定した場合,nodenamelistに指定した情報を無視して「Groupmax Workflow Definerで指定されたオリジナルケースの送付先ノードだけ」の案件複写先ノード情報を設定します。
nodenamelist
複写先ノード名称を配列で指定した,複写先ノード名称リスト格納領域を指定します。
sBnodename:複写先ノード名称を指定します。終端にNULL文字を付けた64バイト以内の文字列で指定してください(複写先ノード名称の取得方法については,機能を参照してください)。
tocopyinf
終端にNULL文字を付けた32バイトの複写先ノード情報を取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidに指定した案件があるノードで,HwfGetCaseFormSelectExのフォームリスト,又はHwfGetOperationのユーザ処理リストに複写ノードでの複写先ノードを指定する作業情報がない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • nodenamelistに指定した複写先ノード名称に,存在しないノード名称が一つでもあった場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(f) HwfCreateCopyInfEx(複写ノードでの案件複写先ノード情報の生成(HwfCreateCopyInfの拡張版))
機能
HwfGetCaseFormSelectEx,又はHwfGetOperationから取得したユーザ処理リスト内の作業情報に設定された属性名称,ユーザ定義名称,複写ノード名称のどちらかと,案件の複写先ノード名称から,指定された複写先ノード名称(Groupmax Workflow Definerで指定されたオリジナルケースの送付先ノードを除いた)に対応する案件複写先ノード情報を生成します。
フォームリスト,又はユーザ処理リスト内の作業情報に設定された属性名称,ユーザ定義名称,複写ノード名称,案件の複写先ノード名称は,次に示す方法で取得できます。
  • HwfGetCaseFormSelectEx,又はHwfGetOperationで取得したユーザ処理リスト内の作業情報から,HwfTakeOperationInfによって,属性名称,ユーザ定義名称,複写ノード名称,複写先ノード名称を取り出します。
  • HwfGetCaseFormSelectEx,又はHwfGetOperationで取得したユーザ処理リスト内の作業情報から,アプリケーションが独自に属性名称,ユーザ定義名称,複写ノード名称,案件の複写先ノード名称を取り出します。
ここで生成した情報を,HwfSetCase,又はHwfSetCaseByUserDefNameのパラメタとして指定することによって,複写ノードでの複写先を動的に指定できます。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfCreateCopyInfEx(
 BWF_useroid_t   __far *useroid,     /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t    __far *server,     /* サーバ名称格納領域 (I) */
 BWF_bpid_t      __far *bpid,      /* ビジネスプロセス定義オブジェクトID (I) */
 BWF_nodeno_t    __far *nodeno,     /* 処理開始ノードID (I) */
 BWF_caseid_t    __far *caseid,     /* 複写先情報登録案件オブジェクトID格納領域 (I) */
 unsigned long         srchkeymode,   /* 作業情報検索キーモード (I) */
 char            __far *srchkey,     /* 作業情報検索キー格納領域 (I) */
 unsigned long         tocopynoden,   /* 複写先ノード名リスト数 (I) */
 BWF_nodename_t  __far *nodenamelist,  /* 複写先ノード名リスト格納領域 (I) */
 unsigned char   __far *tocopyinf,    /* 案件複写先情報取得領域 (O) */
 BWF_errlist_t   __far *errlist,     /* エラー情報取得領域 (O) */
 void            __far *arg       /* 予備領域 (-) */
);
typedef struct BWF_nodename_t {
 char sBnodename[64];  /* 複写先ノード名称 */
} BWF_nodename_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
bpid
案件投入時に複写先ノードを選択する場合,投入するビジネスプロセス定義オブジェクトIDを指定します。ビジネスプロセス定義オブジェクトIDは,HwfGetCaseFormSelectExなどで取得できます。
案件投入時に複写先ノードを選択しない場合はNULLを指定してください。
nodeno
案件投入時に複写先ノードを選択する場合,投入する開始処理ノードのノードIDを指定します。開始処理ノードのノードIDは,HwfGetCaseFormSelectExなどで取得できます。
案件投入時に複写先ノードを選択しない場合はNULLを指定してください。
caseid
案件の案件オブジェクトIDを格納した領域を指定します。案件オブジェクトIDは,HwfGetCaseSelectDataなどで取得できます。
案件投入時に複写先ノードを選択する場合はNULLを指定してください。
srchkeymode
複写先ノード情報を取得するときに必要な作業情報を検索するためのキーのモードを指定します。
BWF_ATTRIBUTE_NAME:属性名称
BWF_USER_DEF_NAME:ユーザ定義名称
BWF_COPY_NODE_NAME:複写ノード名称
srchkey
複写先ノード情報を取得するときに必要な作業情報を検索するためのキーを格納した領域を指定します。
srchkeymodeにBWF_ATTRIBUTE_NAMEを指定した場合,終端にNULL文字を付けた32バイト以内の文字列で,属性名称を指定してください。
srchkeymodeにBWF_USER_DEF_NAMEを指定した場合,終端にNULL文字を付けた64バイト以内の文字列で,ユーザ定義名称を指定してください。
srchkeymodeにBWF_COPY_NODE_NAMEを指定した場合,終端にNULL文字を付けた64バイト以内の文字列で,複写ノード名称を指定してください(属性名称,ユーザ定義名称,複写ノード名称の取得方法については,機能を参照してください)。
tocopynoden
nodenamelistに格納した複写先ノード名称の数を指定します。
複写先ノード名称の数は,0~200の範囲で指定してください。
0を指定した場合,nodenamelistに指定した情報を無視して「Groupmax Workflow Definerで指定されたオリジナルケースの送付先ノードだけ」の案件複写先ノード情報を設定します。
nodenamelist
複写先ノード名称を配列で指定した,複写先ノード名称リスト格納領域を指定します。
sBnodename:複写先ノード名称を指定します。終端にNULL文字を付けた64バイト以内の文字列で指定してください(複写先ノード名称の取得方法については,機能を参照してください)。
tocopyinf
終端にNULL文字を付けた32バイトの複写先ノード情報を取得する領域を指定します。必ず32バイト以上の領域を確保してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
NULLを指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidに指定した案件があるノードで,HwfGetCaseFormSelectExのフォームリスト,又はHwfGetOperationのユーザ処理リストに複写ノードでの複写先ノードを指定する作業情報がない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • bpid及びnodenoで指定した開始処理ノードで,HwfGetCaseFormSelectExで取得したユーザ処理リストに複写ノードでの複写先ノードを指定する作業情報がない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • nodenamelistに指定した複写先ノード名称に,存在しないノード名称が一つでもあった場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(g) HwfDownLoadFileEx(サーバのファイル更新日付のチェックとダウンロード)
機能
サーバ側の指定ファイルの更新日付を確認し,クライアント側のファイルの更新日付と異なっている場合,サーバからクライアントへ,指定されたファイルをダウンロードします。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfDownLoadFileEx(
 BWF_useroid_t  __far  *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far  *server,    /* サーバ名称格納領域 (I) */
 unsigned long         mode,     /* ダウンロードモード格納領域 (I) */
 unsigned long         mode2,     /* 上書きモード格納領域 (I) */
 char           __far  *sfilename,  /* サーバ側任意ファイルパス格納領域 (I) */
 char           __far  *bpname,    /* ビジネスプロセス定義名称格納領域 (I) */
 char           __far  *cfilename,  /* クライアント側ファイルパス名称格納領域(O) */
 unsigned long  __far  *result,    /* 処理結果 (O) */
 BWF_errlist_t  __far  *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
mode
ダウンロードするサーバ側ファイルの格納ディレクトリのモードを指定します。
BWF_SERVER_CONFIG_MODE:Groupmax Workflow Serverの環境定義情報に指定したディレクトリから,sfilenameに指定されたファイルをダウンロードします。
BWF_USER_OPTION_MODE:sfilenameに指定された任意のディレクトリのファイルをダウンロードします。
mode2
日付が一致した場合の上書きモードを指定します。
BWF_GRACE_MODE:日付が一致した場合,上書きしません。
BWF_FORCE_MODE:日付が一致した場合でも上書きします。
sfilename
modeにBWF_SERVER_CONFIG_MODEを指定した場合,サーバ側のファイル名称だけを格納した領域を指定します。
modeにBWF_USER_OPTION_MODEを指定した場合,サーバ側の任意のディレクトリとファイル名称を格納した領域を指定してください。
なお,ファイル名称,又は任意のディレクトリとファイル名称の終端には必ずNULL文字を付けてください。
bpname
modeにBWF_SERVER_CONFIG_MODEを指定した場合,ダウンロードするファイルを作業ファイルとして使用するビジネスプロセス定義名称を指定します。
ただし,拡張ビジネスプロセス定義以外に対してこの関数を発行する場合は,NULLを指定してください。また,modeにBWF_USER_OPTION_MODEを指定した場合は,NULLを指定してください。
cfilename
ダウンロードしたファイルのパス名称を格納する領域を指定します。
OSごとのパスの最大値が納まる領域を指定してください。
result
処理結果を取得する領域を指定します。
0:ダウンロードした,又は上書きしました。
1:取得済みのファイルを利用しました。
errlist
このAPI関数がエラーリターンした場合,エラー情報を取得する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • ファイルのダウンロード先は,「Workflow Server - Library環境設定」の「Groupmax Workflow Server - Library環境設定のプロパティ」ダイアログの「APダウンロード先」のタブで指定されたディレクトリです。ただし,サーバの環境設定で,アプリケーションダウンロード方式に"BP"が指定されている場合は,上記ディレクトリの下にビジネスプロセス定義名のディレクトリを作成して,その下にダウンロードします。
  • BWF_SERVER_CONFIG_MODEで,拡張ビジネスプロセス定義で登録したサーバファイルを取得する場合,Groupmax Workflow DefinerでWIN32用として登録したファイルをチェックした後,非依存として登録したファイルをチェックします。どちらも登録していない場合はエラーになります。
  • 日付チェックでは,サーバ側のファイル日付が異なる場合は古くても別ファイルと判断して,ダウンロード対象とします。
  • 強制上書きモードを多用すると処理効率が悪くなります。必要ない場合は上書きしないモードを使用してください。
  • ファイル日付のチェック対象とするPC上のファイルは,前回ダウンロードしたファイルです。別ディレクトリに移動した場合は確認できませんので注意してください。
(h) HwfGetNodeNameFromCopyInf(複写先ノード情報からの複写先ノード名取得)
機能
複写先ノード情報から,複写先ノード名称を取得します。
複写先ノード情報を取得するには,次に示す方法があります。
  • HwfCreateCopyInfExで取得する。
  • 前ノードで,他ユーザが案件の文字列型ユーザ属性に設定したもの,又は案件があるノード(カレントノード)で,案件の文字列型ユーザ属性に既に設定したものを取得する(ユーザが案件の文字列型ユーザ属性に設定された,複写先ノード情報の取得方法については,パラメタの説明を参照してください)。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetNodeNameFromCopyInf(
 BWF_useroid_t __far *useroid,     /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,      /* サーバ名称格納領域 (I) */
 BWF_caseid_t  __far *caseid,      /* 複写先情報登録案件オブジェクトID格納領域 (I) */
 unsigned long       srchkeymode,    /* 作業情報検索キーモード (I) */
 char          __far *srchkey,     /* 作業情報検索キー格納領域 (I) */
 unsigned char __far *tocopyinf,    /* 案件複写先情報格納領域 (I) */
 unsigned long       topnum,      /* 複写先ノード名称取得要素数格納領域 (I) */
 unsigned long       reqnum,      /* 複写先ノード名称取得数格納領域 (I) */
 BWF_nodename_t __far *nodenamelist,  /* 複写先ノード名称リスト取得領域 (O) */
 unsigned long __far *getnum,      /* 複写先ノード名称取得数取得領域 (O) */
 unsigned long __far *allnum,      /* 複写先情報内設定複写先ノード全数取得領域 (O) */
 BWF_errlist_t __far *errlist      /* エラー情報取得領域 (O) */
);

typedef struct BWF_nodename_t {
 char sBnodename[64];  /* 複写先ノード名称 */
} BWF_nodename_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
caseid
HwfCreateCopyInfExで生成した複写先ノード情報を,案件の文字列型ユーザ属性から設定,又は取得した,案件のオブジェクトIDを格納した領域を指定します。
srchkeymode
複写先ノード名称を取得するときに必要な作業情報を検索するためのキーのモードを指定します。
BWF_ATTRIBUTE_NAME:属性名称
BWF_USER_DEF_NAME:ユーザ定義名称
BWF_COPY_NODE_NAME:複写ノード名称
srchkey
複写先ノード名称を取得するときに必要な作業情報を検索するためのキーを格納した領域を指定します。
srchkeymodeにBWF_ATTRIBUTE_NAMEを指定した場合,終端にNULL文字を付けた最大32バイトの文字列で属性名称を指定してください。
srchkeymodeにBWF_USER_DEF_NAMEを指定した場合,終端にNULL文字を付けた最大64バイトの文字列でユーザ定義名称を指定してください。
srchkeymodeにBWF_COPY_NODE_NAMEを指定した場合,終端にNULL文字を付けた最大64バイトの文字列で複写ノード名称を指定してください(属性名称,ユーザ定義名称,複写ノード名称の取得方法に関しては,HwfCreateCopyInfExを参照してください)。
tocopyinf
案件の文字列型ユーザ属性から取得,又はHwfCreateCopyInfで取得した複写先ノード情報を格納した領域を指定します。
案件の文字列型ユーザ属性に格納された複写先ノード情報を取得する場合は,次に示す手順で取得してください(caseidに指定した案件があるノードで,HwfGetOperationで取得したユーザ処理リストに,「案件の複写先を指定」の種別コードを持つものがあることが前提となります。)。
「案件の複写先を指定」の種別コードを持つユーザ処理リスト(その種別コードを持つユーザ処理リストに対する継続がある場合,すべてを指定してください)をHwfTakeOperationInfのパラメタに指定して,ユーザ処理リスト内の作業情報から,属性情報を取り出します。
HwfGetAttributeValueByAttributeName,又はHwfGetAttributeValueByUserDefNameのパラメタとして,HwfTakeOperationInfで取得した属性情報を指定して,案件の文字列型ユーザ属性に格納された複写先ノード情報を取得します。
topnum
tocopyinfに指定した複写先ノード情報から,複写先ノード名称を取得する場合の先頭要素番号を0~199の範囲で指定します。
reqnum
topnumに指定した複写先ノード名称から,幾つ複写先ノード名称をnodenamelistに取り出すかを,指定します。
最大200まで指定できます。
nodenamelist
複写先ノード情報に設定された,複写先ノード名称を取得する配列領域を指定します(必ずreqnumに指定した以上の領域を指定してください)。
複写先ノード名称は,終端にNULL文字を含む,最大64バイトの文字列で設定されます。
getnum
topnum,reqnumに指定された数に従って,nodenamelistに設定した複写先ノード名称の数を取得する領域を指定します。
allnum
nodenamelistに指定した,複写先ノード情報に設定されている複写先ノード名称の全数を取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • topnumパラメタで指定した値がallnumパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。ただし,topnumパラメタの値とallnumパラメタの値が共に0の場合を除きます。
  • HwfCreateCopyInfExで作成した案件複写先ノード情報が,「Groupmax Workflow Definerで指定されたオリジナルケースの送付先ノードだけ」の場合,このAPI関数の戻り値は正常リターン(BWF_OK)となり,getnum,allnumには0が設定されます。
(i) HwfGetDeliverKey(配布キーの取得)
機能
ユーザ処理リストに「案件の配布キーを指定(”15”)」が指定されていた場合に,配布キーの候補値を取得します。
ユーザ処理リストはHwfGetOperation,又はHwfGetCaseFormSelectExで取得できます。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long __pascal HwfGetDeliverKey(
 BWF_useroid_t       __far *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t        __far *server,     /* サーバ名称格納領域 (I) */
 unsigned long             mode,      /* 処理モード (I) */
 void                __far *domain,     /* 配布キー取得元情報 (I) */
 unsigned long             listn,      /* 取出元情報格納領域内格納数 (I) */
 BWF_oplist_t        __far *list,      /* 取出元情報格納領域 (I) */
 BWF_attributeinfo_t __far *attrinfo,    /* 属性情報取得領域   (O) */
 char                __far *nodename,    /* ノード名称格納領域   (O) */
 unsigned long             topnum,     /* 候補値取得先頭位置格納領域 (I) */
 unsigned long             reqnum,     /* 候補値取得数格納領域 (I) */
 BWF_candidateval_t  __far *candidateval,  /* 候補値取得領域       (O) */
 unsigned long       __far *getnum,     /* 取得候補値数取得     (O) */
 unsigned long       __far *allnum,     /* 取得可能候補値数取得領域 (O) */
 BWF_errlist_t       __far *errlist     /* エラー情報取得領域      (O) */
);
typedef struct BWF_candidateval_t {
 char  sBcandidatevalue[64];  /* 候補値 (O) */
} BWF_candidateval_t;
typedef struct BWF_attributeinfo_t {
 char  sAttributeName[32];  /* 属性名称 (O) */
 char  sUserDefName[64];   /* ユーザ定義名称 (O) */
 char  sAttributeType[4];   /* 属性型 (O) */
} BWF_attributeinfo_t;
typedef struct BWF_bpinfo_t {
 char  sBpName[64];  /* ビジネスプロセス定義名称 (I) */
 long  lVersion;    /* バージョン (I) */
 char  reserved[64];  /* 予備領域 (-) */
} BWF_bpinfo_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];   /* メッセージ区分 (O) */
 long lBMsgNo;     /* メッセージ番号 (O) */
 char sBInsWord[13];  /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
mode
処理のモードを指定します。
0:案件識別子から配布キー情報を取得します。自ユーザトレーの案件を処理する場合に使用します。
1:ビジネスプロセス定義情報から配布キー情報を取得します。案件投入時に使用します。
domain
処理モードに従って,次の情報を指定します。
  • 処理モード0(案件識別子を指定)の場合
    案件識別子を格納したBWF_caseid_t構造体の領域を指定します。
  • 処理モード1(ビジネスプロセス定義情報を指定)の場合
    ビジネスプロセス定義情報を格納したBWF_bpinfo_t構造体の領域を指定します。
    BWF_bpinfo_t構造体を次に示します。
    sBpName:ビジネスプロセス定義の名称を指定します。必ずNULL文字で終端してください。
    lVersion:ビジネスプロセス定義のバージョンを指定します。
listn
listパラメタで指定するユーザ処理リストの数を指定します。
list
ユーザ処理リストの先頭アドレスを指定します。
ユーザ処理リストはHwfGetOperation,又はHwfGetCaseFormSelectExで取得します。
ユーザ処理リストの先頭の作業項目は必ず取得対象とする「配布キーの取得」としてください。
attrinfo
取得した配布キーを設定する案件ユーザ属性の情報を格納する領域を指定します。
BWF_attributeinfo_t構造体を次に示します。
sAttributeName:配布キーを設定する属性名称が格納されます。
sUserDefName:配布キーを設定する属性に対して,Groupmax Workflow Definerで定義した名称が格納されます。
sAttributeType:属性型が格納されます。
 01:文字型
 02:数値型
 03:日付型
 残りの2バイトの領域にはNULL文字が設定されます。
nodename
配布キーを設定するノードのノード名称を格納する領域を指定します。必ず64バイト以上の領域を指定してください。
topnum
取得する配布キー候補値の先頭番号を指定します。
reqnum
topnumに指定した候補値から幾つ候補値を取得するか指定します。200まで指定できます。
candidateval
候補値を取得する配列領域を指定します。必ずreqnumに指定した以上の領域を指定してください。BWF_candidateval_t構造体を次に示します。
sBcandidatevalue:候補値は属性型に関係なく,終端にNULL文字を付けた64バイト以内の文字列として格納されます。
getnum
candidatevalに格納された候補値の数を取得する領域を指定します。
allnum
指定したユーザ処理リストから取得できる候補値の全数を取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • listに指定したユーザ処理リストに種別コード配布キーの指定(”15”)がない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • listにユーザ処理リスト以外の情報を指定した場合の動作は保証しません。
  • topnumパラメタで指定した値がallnumパラメタに格納された値以上の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。ただし,topnumパラメタの値とallnumパラメタの値が共に0の場合を除きます。
(j) HwfChangePasswd(パスワードの変更)
機能
パスワードを変更します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfChangePasswd(
 BWF_useroid_t  __far *useroid,     /* ユーザオブジェクトID 格納領域 (I) */
 BWF_server_t   __far *server,     /* サーバ名称格納領域 (I) */
 BWF_password_t __far *password,    /* 旧パスワード (I) */
 BWF_password_t __far *new_password,  /* 新パスワード (I) */
 BWF_errlist_t  __far *errlist,     /* エラー情報取得領域 (O) */
 void           __far *arg       /* 予備領域 (-) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は取得したサーバ名称を格納した領域を指定します。
password
現状のパスワードを指定してください。
パスワードは,Groupmax Addressに登録したユーザIDに対応するパスワードを終端にNULLを付けた9バイト以内の文字列で指定してください。
new_password
新しいパスワードを指定してください。
パスワードは,Groupmax Addressに登録したユーザIDに対応するパスワードを終端にNULLを付けた9バイト以内の文字列で指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
予備領域です。NULLを指定してください。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
新パスワードに旧パスワードと同じパスワードを設定して,この関数を発行した場合,パスワード不正としてエラーリターンします。
(k) HwfSetNewPasswd(パスワードの変更)
機能
パスワード有効期限切れ状態のユーザのパスワードを変更します。
パスワード有効期限を設定しない運用,またはパスワード有効期限内のユーザのパスワードの変更は,HwfStartUpWorkflowSV関数でGroupmax Workflow Serverに接続した後に,HwfChangePasswd関数を使用して行ってください。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfSetNewPasswd(
 char              *server_name,  /* サーバ名称指定領域 (I) */
 BWF_username_t    *username,    /* パスワード変更ユーザのユーザID格納領域(I) */
 BWF_password_t    *password,    /* 変更前パスワード格納領域 (I) */
 BWF_password_t    *newpassword,  /* 変更後パスワード格納領域 (I) */
 BWF_errlist_t     *errlist,    /* エラー情報取得領域 (O) */
 void              *arg       /* 拡張用領域のアドレス (-) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
server_name
接続先サーバ名称又はIPアドレスを指定します。サーバ名称又はIPアドレスは,終端にNULL文字を付けた256バイト以内の文字列で指定してください。
username
パスワードを変更するユーザのユーザIDを格納した領域を指定してください。
ユーザIDは,Groupmax Addressに登録したユーザIDを,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
password
usernameパラメタで指定したユーザの変更前のパスワードを格納した領域を指定してください。
パスワードは終端にNULL文字を付けた9バイト以内の文字列で指定してください。
newpassword
usernameパラメタで指定したユーザの変更後のパスワードを格納した領域を指定してください。
パスワードは終端にNULL文字を付けた9バイト以内の文字列で指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定してください。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
arg
予備領域です。NULLポインタを指定してください。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • パスワード有効期限切れ状態でないユーザを指定した場合,本関数はエラーリターンします。
  • 本関数は未ログイン状態で発行してください。ログイン済み状態で発行した場合は,エラーとなります。(ログイン中のユーザと異なるユーザIDをusernameパラメタに指定した場合もエラーリターンします。)
  • 本関数は,パスワードを変更するために,一旦Groupmax Workflow Serverに接続し,パスワードを変更した後に,Groupmax Workflow Serverとの接続を切断します。このため,通常ログイン時にしか返却されないエラーが返却されることがありますのでご注意ください。
  • 本関数でパスワードを変更した後,他の関数を発行するためには,本関数で新しく設定したパスワードを指定して,再度ログインから実行してください。
  • 新パスワードに旧パスワードと同じパスワードを設定して,本関数を発行した場合は,パスワード不正としてエラーリターンします。
(l) 種別コード対応出力パラメタ設定可否項目一覧
出力パラメタフォーム,ユーザ処理リスト内作業種別
案件に文書を追加格納
(”02”)
案件のユーザ属性に任意値設定
(”03”)
案件のユーザ属性に候補値設定
(”04”)
案件の任意ユーザ状態コードへ候補値設定
(”08”)
案件の属性値を一覧表示時に出力(”09”)案件の複写先を指定
("13")
attrname××
userdefname××
attrtype××
nodename×××××
candidateval××
getnum××
allnum××
(凡例)
〇:設定される
×:設定されない