付録L.5 バージョン1との互換用AP関数

<この項の構成>
(1) 使用上の注意
(2) セション操作AP関数(互換用)
(3) ユーザ操作AP関数(互換用)
(4) ビジネスプロセス定義操作AP関数(互換用)
(5) ロール操作AP関数(互換用)
(6) ワーク操作AP関数(互換用)
(7) 案件操作AP関数(互換用)
(8) ユーザトレー内案件操作AP関数(互換用)
(9) ユーザートレー内案件属性操作AP関数(互換性)
(10) 文書,メモ操作AP関数(互換性)
(11) ヒストリ操作AP関数(互換用)
(12) オブジェクト操作AP関数(互換用)
(13) 先読み操作AP関数(互換用)
(14) トランザクション操作AP関数(互換用)
(15) その他AP関数(互換用)

(1) 使用上の注意

バージョン1との互換用API関数はバージョン1との互換性を保つために提供しています。今後のバージョンでは,使用できなくなる可能性があるため,新規にアプリケーションを作成する場合は,できるだけ使用しないことをお勧めします。

(2) セション操作AP関数(互換用)

(a) HwfLoginWorkflow(ワークフローシステムへのログイン)

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

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

#include<bwf.h>
long HwfLoginWorkflow(
 BWF_username_t   __far *username,     /* ログインユーザ名称格納領域 (I) */
 BWF_password_t   __far *password,     /* ログインパスワード格納領域 (I) */
 BWF_server_t     __far *server,      /* サーバ名称格納領域 (I) */
 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) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];             /* メッセージ区分 */
 long lBMsgNo;               /* メッセージ番号 */
 char sBInsWord[13];            /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
username
ログインするユーザのユーザ名称を格納した領域を指定します。
ユーザ名称は,サーバ側の/etc/passwdファイルに登録したもので,かつGroupmax Workflow Definerを使用して登録したユーザのユーザ名称を指定してください。
ユーザ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
password
usernameで示されるユーザのパスワードを格納した領域を指定します。
パスワードは,サーバ側の/etc/passwdファイルに登録したユーザのパスワードを指定してください。
パスワードは,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
server
サーバ名称を格納した領域を指定します。
サーバ側でログインする場合も指定する必要があります。
サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
useroid
ログインしたユーザのユーザオブジェクトIDを取得する領域を指定します。
以降,ほかのAPI関数を発行する場合はパラメタとして,このユーザオブジェクトIDを必ず指定する必要があります。
userstatus
ユーザ状態コードを取得する領域を指定します。
ユーザ状態コードの詳細を次に示します。
"act△":受付許可
"dea△":代行者配布状態
"inac":受付禁止状態
注 △は,スペースを示します。
userdistinct
ユーザ権限コードを取得する領域を指定します。
ユーザ権限コードの詳細を次に示します。
"sys△":"system"ユーザ
"wfm△":ワークフロー管理者
"gen△":一般ユーザ
注 △は,スペースを示します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数を使用したアプリケーションプログラムと,Groupmax Workflow Definer,及びGroupmax Workflow Monitorは同時に起動できません。
  • 同一クライアント上から既に次に示すAPI関数でログインした後,このAPI関数を発行した場合,戻り値はエラーリターン(BWF_ERROR)となります。
    ・HwfLoginWorkflow
    ・HwfStartUpWorkflow
  • Groupmax Workflow Serverの環境定義情報に指定した最大同時ログインユーザ数を超えてログインしようとした場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります(詳細については,マニュアル「Groupmax Workflow Version 6 システム管理者ガイド」を参照してください)。
  • ログインする前に作業ディレクトリを指定する必要があります。作業ディレクトリは環境変数「GMAXWFTMP」で指定します。作業ディレクトリはドライブ名とルートディレクトリを含むフルパス名称を指定してください。作業ディレクトリは次のディレクトリを指定してください。
  1. ドライブ名とルートディレクトリを含むフルパス名称で指定してください。
  2. ディレクトリ名の長さは128バイト以内で指定してください。
  3. 読み込み,書き込み,及び実行権限のあるディレクトリを指定してください。作業ディレクトリの指定方法はマニュアル「Groupmax Workflow - Library プログラミングガイド」の「アプリケーション開発手順」を参照してください。
  • Groupmax Workflow Serverの複数サービス機能を利用している場合,ログインする前に環境変数でサービス名を指定する必要があります。サービス名の指定方法はマニュアル「Groupmax Workflow - Library プログラミングガイド」の「アプリケーション開発手順」を参照してください。
(b) HwfLogoutWorkflow(ワークフローシステムからのログアウト)

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

機能
ワークフローシステムからログアウトします。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
 long HwfLogoutWorkflow(
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。
終端にNULL文字を付けた9バイト以内の文字列で指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(c) HwfGmLoginWorkflow(ワークフローシステムへのログイン(Groupmax連携用))

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

機能
ワークフローシステムでのユーザ管理を,GroupmaxのネームサーバであるGroupmax Addressでしていた場合に,ユーザのホームサーバであるGroupmax Workflowサーバにログインします。
従来のサーバ側での/etc/passwdファイル,Groupmax Workflow Definerによるユーザ管理方式でも,使用できます。
ユーザ管理方式が前者の場合,同一クライアントで,Groupmaxのあるアプリケーションが既にログインしていれば,ほかのGroupmaxアプリケーションを起動するときに,再度ユーザからユーザ名称,及びパスワードを指定してもらわなくても(このAPI関数のパラメタであるユーザ名称,パスワードを指定しなくても),自動的にそのユーザのホームサーバであるGroupmax Workflowサーバに対して,ログインします。
ホームサーバ
ユーザが通常,サービスを受けるGroupmax Workflowサーバを示します(Groupmax Workflowでは,ユーザ対応のホームサーバに対して,ユーザトレーを作成します。したがって,あるユーザのユーザトレーは,システム内にただ一つとなります)。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGmLoginWorkflow(
 BWF_username_t  __far *username,      /* ログインユーザ名称格納領域 (I) */
 BWF_password_t  __far *password,      /* ログインパスワード格納領域 (I) */
 unsigned long         multi_mode,     /* マルチセッションモード (I) */
 HWND                  pwnd_handle,     /* 親ウィンドウのハンドル (I) */
 BWF_server_t    __far *server,       /* サーバ名称格納領域 (O) */
 BWF_useroid_t   __far *useroid,      /* ユーザオブジェクトID取得領域 (O) */
 BWF_userstatus_t  __far *userstatus,    /* ユーザ状態コード取得領域 (O) */
 BWF_userdistinct_t __far *userdistinct,  /* ユーザ権限コード取得領域 (O) */
 unsigned long   __far *usermgrinf,     /* ユーザ管理方式情報取得領域 (O) */
 BWF_gluserinfo_t  __far *gluserinf,    /* ユーザ情報取得領域 (O) */
 BWF_errlist_t   __far *errlist       /* エラー情報取得領域 (O) */
);
typedef struct BWF_serverinfo_t{
 unsigned char servername[BWF_GL_MAXSERVERNAME];  /* サーバ名称 */
 unsigned char ipaddress[BWF_GL_MAXIPADDRESS];   /* サーバIPアドレス */
} BWF_serverinfo_t;
typedef struct BWF_svinfolist_t{
 BWF_serverinfo_t Addressinfo;    /* Groupmax Addressホームサーバ情報 */
 BWF_serverinfo_t Mailinfo;     /* Groupmax Mailホームサーバ情報 */
 BWF_serverinfo_t Infoshare0info;  /* Groupmax Document Manager #0ホームサーバ情報 */
 BWF_serverinfo_t Infoshare1info;  /* Groupmax Document Manager #1ホームサーバ情報 */
 BWF_serverinfo_t Infoshare2info;  /* Groupmax Document Manager #2ホームサーバ情報 */
 BWF_serverinfo_t Infoshare3info;  /* Groupmax Document Manager #3ホームサーバ情報 */
 BWF_serverinfo_t Infoshare4info;  /* Groupmax Document Manager #4ホームサーバ情報 */
 BWF_serverinfo_t Flowmateinfo;   /* Groupmax Workflow ホームサーバ情報 */
 BWF_serverinfo_t Appomouseinfo;   /* Groupmax Schedulerホームサーバ情報 */
} BWF_svinfolist_t;
typedef struct BWF_gluserinfo_t{
 unsigned char    userid[BWF_GL_MAXUSERID];    /* ユーザID */
 unsigned char    passwd[BWF_GL_MAXPASSWD];    /* パスワード */
 unsigned char    nickname[BWF_GL_MAXNICKNAME];  /* ニックネーム */
 unsigned char    uid[BWF_GL_MAXUID];       /* ユーザ番号(UID) */
 unsigned char    username[BWF_GL_MAXNAME];    /* ユーザ名(日本語名) */
 unsigned char    firstname[BWF_GL_MAXFIRSTNAME]; /* 英語名(名) */
 unsigned char    lastname[BWF_GL_MAXLASTNAME];  /* 英語名(姓) */
 unsigned char    post[BWF_GL_MAXPOST];      /* 役職 */
 unsigned char    org[BWF_GL_MAXORG];       /* 所属組織 */
 unsigned char    company[BWF_GL_MAXCOMPANY];   /* 所属会社 */
 BWF_svinfolist_t glserverinfo           /* サーバ情報 */
} BWF_gluserinfo_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
username
ログインするユーザのユーザ名称を格納した領域を指定します。
ユーザ名称は,次に示すユーザ管理方式対応に登録された,ユーザのユーザ名称を指定してください。
ユーザ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
  • サーバ側の/etc/passwdファイル,Groupmax Workflow Definerによるユーザ管理方式の場合
    サーバ側の/etc/passwdファイルに登録したもので,かつGroupmax Workflow Definerを使用して登録した,ユーザのユーザ名称を指定してください。
  • Groupmax Addressによるユーザ管理方式の場合
    Groupmax Addressに登録したユーザ名称を指定してください。また,Groupmaxのどれかのアプリケーションでログイン済みの場合は,省略できます(省略する場合は,ユーザ名称,パスワード共にNULLポインタを指定してください)。
password
usernameで示されるユーザのパスワードを格納した領域を指定します。
パスワードは,次に示すユーザ管理方式対応に登録された,ユーザのユーザ名称に対応するパスワードを指定してください。パスワードは,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
  • サーバ側の/etc/passwdファイル,Groupmax Workflow Definerによるユーザ管理方式の場合
    サーバ側の/etc/passwdファイルに登録したもので,かつサーバ側の/etc/passwdファイルに登録した,ユーザのパスワードを指定してください。
  • Groupmax Addressによるユーザ管理方式の場合
    Groupmax Addressに登録した,ユーザ名称に対応するパスワードを指定してください。また,Groupmaxのどれかのアプリケーションでログイン済みの場合は,省略できます(省略する場合は,ユーザ名称,パスワード共にNULLポインタを指定してください)。
multi_mode
同一ユーザ名称で,別セションによる複数ログインの使用有無を指定します。
BWF_FALSE:同一ユーザ名称で別セションによる複数ログインを使用しません。
pwnd_handle
親ウィンドウのハンドルを指定します。
server
usernameで指定したユーザのサーバ名称を取得する領域を指定します。取得できるのは,Groupmax Workflow上でのホームサーバのサーバ名称です(このAPI関数の戻り値が,正常リターンの場合だけ設定されます)。
useroid
ログインしたユーザのユーザオブジェクトIDを取得する領域を指定します。
以降,ほかのAPI関数を発行する場合は,パラメタとしてこのユーザオブジェクトIDを指定する必要があります。
userstatus
ユーザ状態コードを取得する領域を指定します。
ユーザ状態コードの詳細を次に示します。
"act△":受付許可
"dea△":代行者配布状態
"inac":受付禁止状態
注 △は,スペースを示します。
userdistinct
ユーザ権限コードを取得する領域を指定します。
ユーザ権限コードの詳細を次に示します。
"sys△":"system"ユーザ
"wfm△":ワークフロー管理者
"gen△":一般ユーザ
注 △は,スペースを示します。
usermgrinf
Groupmax Workflowでのユーザ管理方式を取得する領域を指定します。
BWF_LOCAL:サーバ側の/etc/passwdファイル,Groupmax Workflow Definerによるユーザ管理方式
BWF_GROUPADDRESS:Groupmax Addressによるユーザ管理方式
gluserinf
Groupmax Addressで管理されている,ログインしたユーザの情報を取得する領域を指定します。
なお,次に示す条件すぺてに当てはまる場合だけ,Groupmax Addressで管理されているログインしたユーザの情報が設定されます。
  • このAPI関数の戻り値が正常リターンです。
  • usermgrinfがBWF_GROUPADDRESSです。
ユーザ情報内の設定項目については,ユーザ情報内の設定項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数を使用したアプリケーションプログラムと,Groupmax Workflow Definer,及びGroupmax Workflow Monitorは同時に起動できません。
  • 同一クライアント上から既に次に示すAPI関数でログインした後,このAPI関数を発行した場合,戻り値はエラーリターン(BWF_ERROR)となります。
    ・HwfLoginWorkflow
    ・HwfStartUpWorkflow
  • このAPI関数でログインする場合は,Groupmax Workflow ClientのセットアッププログラムでGroupmax Workflowサーバのサーバ名称を指定してください。又は,windowsディレクトリ下のflowmate.iniファイルの[RunTime]セクションのIPパラメタにGroupmax Workflowサーバのサーバ名称を指定してください(指定されていない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります)。
  • このAPI関数でログインした後,ログアウトする場合は,HwfLogoutWorkflowを発行してください。
  • Groupmax Workflow Serverの環境定義情報に指定した最大同時ログインユーザ数を超えて,ログインしようとした場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります(詳細については,マニュアル「Groupmax Workflow Version 6 システム管理者ガイド」を参照してください)。
(d) ユーザ情報内の設定項目
項目内容
useridログインしたユーザのユーザID(名称)が設定されます。
passwd何も設定されません(すべてNULL文字が設定されます)。
nicknameログインしたユーザのニックネームが設定されます。
uidログインしたユーザのユーザ番号が設定されます。
usernameログインしたユーザの日本語によるユーザ名称が設定されます。
firstnameログインしたユーザの英語によるユーザのファーストネームが設定されます。
lastnameログインしたユーザの英語によるユーザのラストネームが設定されます。
postログインしたユーザの役職名が設定されます。
orgログインしたユーザが所属する組織の名称が設定されます。
companyログインしたユーザの所属する会社の名称が設定されます。
glserverinfoログインしたユーザのGroupmaxの各アプリケーションのホームサーバ情報が設定されます。Groupmaxの各アプリケーションのホームサーバ情報詳細については,Groupmaxの各アプリケーションのホームサーバ情報内の設定項目を参照してください。
(e) Groupmaxの各アプリケーションのホームサーバ情報内の設定項目
項目内容
AddressinfoログインしたユーザのGroupmax Addressのホームサーバに関する情報が設定されます。ホームサーバに関する情報については,ホームサーバ情報内の設定項目を参照してください。
MailinfoログインしたユーザのGroupmax Mailのホームサーバに関する情報が設定されます。ホームサーバに関する情報については,ホームサーバ情報内の設定項目を参照してください。
Infoshare0infoログインしたユーザのGroupmax Document Managerの0番目のホームサーバに関する情報が設定されます。ホームサーバに関する情報については,ホームサーバ情報内の設定項目を参照してください。
Infoshare1infoログインしたユーザのGroupmax Document Managerの1番目のホームサーバに関する情報が設定されます。ホームサーバに関する情報については,ホームサーバ情報内の設定項目を参照してください。
Infoshare2infoログインしたユーザのGroupmax Document Managerの2番目のホームサーバに関する情報が設定されます。ホームサーバに関する情報については,ホームサーバ情報内の設定項目を参照してください。
Infoshare3infoログインしたユーザのGroupmax Document Managerの3番目のホームサーバに関する情報が設定されます。ホームサーバに関する情報については,ホームサーバ情報内の設定項目を参照してください。
Infoshare4infoログインしたユーザのGroupmax Document Managerの4番目のホームサーバに関する情報が設定されます。ホームサーバに関する情報については,ホームサーバ情報内の設定項目を参照してください。
FlowmateinfoログインしたユーザのGroupmax Workflowのホームサーバに関する情報が設定されます。ホームサーバに関する情報については,ホームサーバ情報内の設定項目を参照してください。
AppomouseinfoログインしたユーザのGroupmax Schedulerのホームサーバに関する情報が設定されます。ホームサーバに関する情報については,ホームサーバ情報内の設定項目を参照してください。
(f) ホームサーバ情報内の設定項目
項目内容
servernameGroupmaxの各アプリケーションのホームサーバ名称が設定されます。
ipaddressGroupmaxの各アプリケーションのホームサーバのIPアドレスが,次に示す形式で設定されます。
ホームサーバのIPアドレスの形式:XXX.XXX.XXX.XXX

(3) ユーザ操作AP関数(互換用)

(a) HwfGetUser(ユーザ情報取得)

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

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

#include<bwf.h>
long HwfGetUser(
 BWF_useroid_t  __far  *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far  *server,     /* サーバ名称格納領域 (I) */
 long                  reqmode,     /* 要求種別 (I) */
 long                  idlistn,     /* オブジェクトID配列要素数 (I) */
 BWF_bpidlist_t __far *bpidlist,    /* ビジネスプロセス定義オブジェクト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 */
 BWF_useroid_t BWF_us_user_id;        /* ユーザ名 */
 char          BWF_us_user_alias_name[64];  /* ユーザ別名(ユーザ日本語名称) */
 char          BWF_us_user_name[8];      /* 作成者 */
 BWF_time_t    BWF_us_create_time;      /* 作成日時 */
 unsigned long BWF_us_case_count;       /* 案件数 */
 char          BWF_us_status_code[4];     /* ユーザ状態コード */
 BWF_oid_t     BWF_us_approval_code;     /* 印章情報オブジェクトID */
 char          BWF_us_distinction_code[4];  /* ユーザ権限コード */
} BWF_userlist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。
サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
reqmode
情報を取得するユーザに関する条件を,次に示す要求種別によって指定します。
BWF_GU_SYSTEM_MODE:すべてのユーザを対象とします。
BWF_GU_BP_MODE:bpidlistで指定したビジネスプロセス定義に属すユーザを対象とします。
BWF_GU_ROLE_MODE:roleidlistで指定したロールに属すユーザを対象とします。
reqmodeの指定によって,次に示すように以降のパラメタに情報を設定する必要があります。
reqmodebpidlistroleidlist
BWF_GU_SYSTEM_MODE××
BWF_GU_BP_MODE×
BWF_GU_ROLE_MODE×
(凡例)
○:指定が必要です。
×:指定は不要です。

idlistn
bpidlistにビジネスプロセス定義オブジェクトID,又はroleidlistにロールオブジェクトIDを設定した要素数を指定します。reqmodeでBWF_GU_SYSTEM_MODE以外を指定した場合は,必ず1以上を指定してください。
bpidlist
reqmodeでBWF_GU_BP_MODEを指定した場合に,ユーザを選択するためのビジネスプロセス定義オブジェクトIDを格納した領域を指定します(複数指定可能,HwfGetBusinessProcessなどで取得できます)。
roleidlist
reqmodeでBWF_GU_ROLE_MODEを指定した場合に,ユーザを選択するためのロールオブジェクトIDを格納した領域を指定します(複数指定可能,HwfGetRoleなどで取得できます)。
sortkey
ユーザ属性リストをソートする場合に,次に示すキーを指定します。
sortmodeにBWF_NOSORT_MODEを指定した場合は,指定する必要はありません。
BWF_SRT_US_NAME:ユーザ名
BWF_SRT_US_ALIAS_NAME:ユーザ別名(ユーザ日本語名称)
BWF_SRT_US_CREATE_NAME:作成者
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以上の値を指定してください。
total
ユーザ属性リストの取得できる全要素数(このシステムに登録されたユーザでreqmodeで指定した条件に対応するユーザ数)を取得する領域を指定します。
count
このAPI関数が取得したユーザ属性リストの要素数を取得する領域を指定します。
userlist
ユーザ属性リストを取得する領域を指定します。userlistnで指定した要素数分の領域を必ず指定してください。ユーザ属性リストに取得される項目については,ユーザ属性リスト内項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このシステムに登録されたユーザで,reqmodeで指定した条件に対応するユーザが存在しない場合は,totalは0で,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • number≧totalの場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(b) ユーザ属性リスト内項目
項目内容
BWF_us_oidユーザオブジェクトIDが設定されます。
BWF_us_user_idBWF_us_oidに対応するユーザ名称が設定されます。
BWF_us_user_alias_nameBWF_us_oidに対応するユーザ別名(ユーザ日本語名称)が設定されます。
BWF_us_user_nameBWF_us_oidに対応するユーザをシステムに登録したユーザのユーザ名称が設定されます。
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△":一般ユーザ
注 △は,スペースを示します。

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

(a) HwfGetProcessLimitTime(ビジネスプロセスでの案件処理期間取得)

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

機能
指定したビジネスプロセスでの案件処理期間を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます
構文

#include<bwf.h>
long HwfGetProcessLimitTime(
 BWF_useroid_t __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,   /* サーバ名称格納領域 (I) */
 BWF_bpid_t    __far *bpoid,   /* ビジネスプロセス定義オブジェクトID格納領域 (I) */
 unsigned long __far *limittime, /* 案件処理期間 (O) */
 BWF_errlist_t __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];        /* メッセージ区分 */
 long lBMsgNo;          /* メッセージ番号 */
 char sBInsWord[13];       /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
bpoid
案件処理期間を取得するビジネスプロセス定義オブジェクトIDを格納した領域を指定します(ビジネスプロセス定義オブジェクトIDは,HwfGetBusinessProcessなどで取得できます)。
limittime
案件投入から処理終了までの相対的な経過秒である処理期間を取得する領域を指定します(ビジネスプロセス定義で設定されていない場合,0が設定されます)。
投入日時(1970/01/01 00:00:00(GMT)からの経過秒)に,処理期間を加えることで,処理期限(1970/01/01 00:00:00(GMT)からの経過秒)が算出できます。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン

(5) ロール操作AP関数(互換用)

(a) HwfGetRole(ロール情報取得)

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

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

#include<bwf.h>
long HwfGetRole(
 BWF_useroid_t  __far *useroid,      /* ユーザオブジェクトID設定領域 (I) */
 BWF_server_t   __far *server,      /* サーバ名称設定領域 (I) */
 long                 reqmode,      /* 要求種別 (I) */
 long                 idlistn,      /* オブジェクトID配列内設定要素数 (I) */
 BWF_bpidlist_t __far *bpidlist,     /* ビジネスプロセス定義オブジェクト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];   /* 作成者 */
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
reqmode
情報を取得するロールに関する条件を,次に示す要求種別によって指定します。
BWF_GR_SYSTEM_MODE:全ロールを対象とします。
BWF_GR_BP_MODE:bpidlistに指定したビジネスプロセス定義に属すロールを対象とします。
BWF_GR_USER_MODE:useroidlistに指定したユーザが登録されたロールを対象とします。
reqmodeの指定によって,次に示すように,以降のパラメタに情報を設定する必要があります。
reqmodebpidlistuseroidlist
BWF_GR_SYSTEM_MODE××
BWF_GR_BP_MODE×
BWF_GR_USER_MODE×
(凡例)
○:指定が必要です。
×:指定は不要です。

idlistn
bpidlist,又はuseroidlistに設定したビジネスプロセス定義オブジェクトID,又はユーザオブジェクトIDを格納した要素数を指定します。reqmodeにBWF_GR_SYSTEM_MODE以外を指定した場合は,必ず1以上の値を指定してください。
bpidlist
reqmodeでBWF_GR_BP_MODEを指定した場合に,ロールを選択するためのビジネスプロセス定義オブジェクトIDを格納した領域を指定します(複数指定可能,HwfGetBusinessProcessなどで取得できます)。
useroidlist
reqmodeでBWF_GR_USER_MODEを指定した場合に,ロールを選択するためのユーザオブジェクトIDを格納した領域を指定します(複数指定可能,HwfGetUserなどで取得できます)。
sortkey
ロール属性リストをソートする場合に,次に示すキーを指定します。
sortmodeにBWF_NOSORT_MODEを指定した場合は,指定する必要はありません。
BWF_SRT_RL_NAME:ロール名
BWF_SRT_RL_CREATE_NAME:作成者
BWF_SRT_RL_CREATE_TIME:作成日時
sortmode
ロール属性リストをソートする場合のソート順を指定します。
BWF_ASCEND_MODE:昇順にソートします。
BWF_DESCEND_MODE:降順にソートします。
BWF_NOSORT_MODE:ソートしません。
number
ロール属性リストを取得する要素の先頭番号を指定します。先頭番号は0~(total-1)の範囲内で指定してください。
rolelistn
ロール属性リストを取得する要素数を指定します。必ず1以上の値を指定してください。
total
ロール属性リストの取得できる全要素数(このシステムに登録されたロールでreqmodeで指定した条件に対応するロール数)を取得する領域を指定します。
count
このAPI関数が取得したロール属性リストの要素数を取得する領域を指定します。
rolelist
ロール属性リストを取得する領域を指定します。rolelistnで指定した要素数分の領域を必ず指定してください。ロール属性リスト内に取得される項目については,ロール属性リスト内項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このシステムに登録されたロールで,reqmodeで指定した条件に対応するものが存在しない場合は,totalは0で,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • number≧totalの場合は,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(b) ロール属性リスト内項目
項目内容
BWF_rl_oidロールオブジェクトIDが設定されます。
BWF_rl_role_nameBWF_rl_oidに対応するロール名称が設定されます。
BWF_rl_create_nameBWF_rl_oidに対応するロールを登録したユーザのユーザ名称が設定されます。
BWF_rl_create_timeBWF_rl_oidに対応するロールの作成日時が設定されます。
BWF_rl_passed_case_count空き領域で,値は常に不定です。
BWF_rl_case_countBWF_rl_oidに対応するロールトレーに格納されている案件数(ルート案件+単独の一般案件)が設定されます。
BWF_rl_user_attrロールに対するユーザ属性値(コメント)が設定されます(設定されていない場合があります)。

(6) ワーク操作AP関数(互換用)

(a) HwfGetWorkAttributeSelectStatus(動作状態別ワーク情報取得)

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

機能
ビジネスプロセス定義に属するワーク属性情報(ワーク属性リスト)を,ワークの動作状態別に取得します。動作状態には,次に示す状態があります。
  • 動作可能状態
    ビジネスプロセス内で遷移できる状態です。
  • 動作中断状態
    Groupmax Workflow Monitorのワーク情報ウィンドウで,遷移状態を「一時停止」に変更した状態です。
  • キャンセル予約状態
    Groupmax Workflow Monitorのワーク情報ウィンドウで,遷移状態を「キャンセル」に変更した状態です。
  • ワーク以下案件削除状態
    Groupmax Workflow Monitorのワーク情報ウィンドウで,遷移状態を「削除」に変更した状態です。
  • 終了済み状態
    ワークが終了処理ノードに至った状態です。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetWorkAttributeSelectStatus(
 BWF_useroid_t  __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,    /* サーバ名称格納領域 (I) */
 BWF_bpid_t     __far *bpid,     /* ビジネスプロセスオブジェクトID格納領域 (I) */
 unsigned long        selectmode,  /* 動作状態選択モード (I) */
 unsigned long        sortkey,    /* ソートキー (I) */
 unsigned long        sortmode,   /* ソートモード (I) */
 unsigned long        number,    /* ワーク属性リスト取得先頭要素番号 (I) */
 unsigned long        worklistn,   /* ワーク属性リスト取得要素数 (I) */
 unsigned long  __far *total,    /* ワーク属性リスト全要素数 (O) */
 unsigned 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;        /* 案件識別子フォーマット */
 char          BWF_wk_create_name[8];     /* 作成者 */
 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;         /* ビジネスプロセス定義oid */
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
bpid
ワーク属性リストを選択するためのビジネスプロセス定義オブジェクトID(HwfGetBusinessProcessなどで取得)を格納した領域を指定します。
selectmode
取得の対象とする動作状態を指定します。
BWF_WK_STATUS_ACT:動作可能状態
BWF_WK_STATUS_SUSPEND:動作中断状態
BWF_WK_STATUS_CANCEL:キャンセル予約状態
BWF_WK_STATUS_DELETE:ワーク以下案件削除状態
BWF_WK_STATUS_SINK:終了済み状態
sortkey
ワーク属性リストをソートする場合に,次に示すキーを指定します。
sortmodeにBWF_NOSORT_MODEを指定した場合は,指定する必要はありません。
BWF_SRT_WK_USER_KEY:案件識別子フォーマット(ワークID)
BWF_SRT_WK_CREATE_NAME:作成者名
BWF_SRT_WK_CREATE_TIME:作成日時
BWF_SRT_WK_PRIORITY:優先度
sortmode
ワーク属性リストをソートする場合のソート順を指定します。
BWF_ASCEND_MODE:昇順にソートします。
BWF_DESCEND_MODE:降順にソートします。
BWF_NOSORT_MODE:ソートしません。
number
ワーク属性リストを取得する要素の先頭番号を指定します。
先頭番号は0~(total-1)の範囲内で指定してください。
worklistn
ワーク属性リストを取得する要素数を指定しします。
必ず1以上の値を指定してください。
total
ワーク属性リストの取得できる全要素数(このシステムに存在するワークでselectmodeで指定した条件に対応するワーク数)を取得する領域を指定します。
count
このAPI関数が取得したワーク属性リストの要素数を取得する領域を指定します。
worklist
ワーク属性リストを取得する領域を指定します。worklistnで指定した要素数分の領域を必ず指定してください。
ワーク属性リスト内に取得される項目については,ワーク属性リスト内項目を参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • bpidで指定したビジネスプロセス定義にselectmodeで指定した動作状態のワークが存在しない場合は,totalは0で,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • number≧totalの場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(b) ワーク属性リスト内項目
項目内容
BWF_wk_oidワークオブジェクトIDが設定されます。
BWF_wk_transaction_idワークが作成されるきっかけとなった案件オブジェクトIDと同じ値が設定されます。
BWF_wk_user_keyBWF_wk_oidに対応する案件の案件識別子フォーマット(ワークID)が設定されます。
BWF_wk_create_nameBWF_wk_oidに対応する案件を作成したユーザのユーザ名称が設定されます。
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) HwfGetCaseForm(ビジネスプロセスへ投入可能な案件情報取得)

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

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

#include<bwf.h>
long HwfGetCaseForm(
 BWF_useroid_t  __far *useroid,   /* ユーザオブジェクトID設定領域 (I) */
 BWF_server_t   __far *server,   /* サーバ名称設定領域 (I) */
 long                 reqmode,   /* 要求種別 (I) */
 BWF_useroid_t  __far *suseroid,  /* ユーザオブジェクトID設定領域 (I) */
 BWF_roleid_t   __far *roleid,   /* ロールオブジェクトID設定領域 (I) */
 long                 number,    /* フォームリスト取得先頭要素番号 (I) */
 long                 formlistn,  /* フォームリスト取得要素数 (I) */
 long           __far *total,    /* フォームリスト全要素数 (O) */
 long           __far *count,    /* 取得フォームリスト要素数 (O) */
 BWF_formlist_t __far *formlist,  /* フォームリスト取得領域 (O) */
 BWF_errlist_t  __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_formlist_t{
 BWF_bpid_t     BWF_fm_bp_oid;         /* ビジネスプロセス定義オブジェクトID */
 char           BWF_fm_bp_name[64];      /* ビジネスプロセス名称 */
 unsigned long  BWF_fm_bp_version_number;   /* ビジネスプロセス定義バージョン番号 */
 BWF_nodeno_t   BWF_fm_node_id;        /* 開始処理ノードID */
 char           BWF_fm_node_name[64];     /* 開始処理ノード名称 */
 char           BWF_fm_kind_code[2];      /* 種別コード */
 char           BWF_fm_create_condition[2];  /* 設定条件 */
 BWF_casename_t BWF_fm_case_name;       /* 案件名称 */
 char           BWF_fm_get_operation_list[256];/* 作業情報 */
} BWF_formlist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

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

suseroid
情報を選択するためのユーザオブジェクトID(HwfLoginWorkflow,HwfGetUserなどで取得)を格納した領域を指定します。
roleid
情報を選択するためのロールオブジェクトID(HwfGetRoleなどで取得)を格納した領域を指定します。
number
フォームリストを取得する要素の先頭番号を指定します。先頭番号は0~(total-1)の範囲内で指定してください。
formlistn
フォームリストを取得する要素数を指定します。
必ず1以上の値を指定してください。
total
フォームリストの取得できる全要素数(reqmodeで指定した条件に対応する情報)を取得する領域を指定します。
count
このAPI関数が取得したフォームリストの要素数を取得する領域を指定します。
formlist
フォームリストを取得する領域を指定します。
formlistnで指定した要素数分の領域を必ず指定してください。
フォームリスト内の設定項目については,フォームリスト内項目を参照してください。
errlist
このAPIがエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このシステムに登録された案件でreqmodeで指定した条件に対応するものが存在しない場合は,totalは0で,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • number≧totalの場合は,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となり,totalにこのシステムに登録された案件でreqmodeで指定した条件に対応する要素数が設定されます。
(b) HwfGetCaseFormSelect(ビジネスプロセスへ投入可能な案件情報取得)

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

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

#include<bwf.h>
long HwfGetCaseFormSelect(
 BWF_useroid_t  __far *useroid,   /* ユーザオブジェクトID設定領域 (I) */
 BWF_server_t   __far *server,   /* サーバ名称設定領域 (I) */
 long                 reqmode,   /* 要求種別 (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_formlist_t __far *formlist,  /* フォームリスト取得領域 (O) */
 BWF_errlist_t  __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_formlist_t{
 BWF_bpid_t     BWF_fm_bp_oid;         /* ビジネスプロセス定義オブジェクトID */
 char          BWF_fm_bp_name[64];       /* ビジネスプロセス名称 */
 unsigned long  BWF_fm_bp_version_number;   /* ビジネスプロセス定義バージョン番号 */
 BWF_nodeno_t   BWF_fm_node_id;        /* 開始処理ノードID */
 char           BWF_fm_node_name[64];     /* 開始処理ノード名称 */
 char           BWF_fm_kind_code[2];      /* 種別コード */
 char           BWF_fm_create_condition[2];  /* 設定条件 */
 BWF_casename_t BWF_fm_case_name;       /* 案件名称 */
 char           BWF_fm_get_operation_list[256];  /* 作業情報 */
} BWF_formlist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

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

suseroid
情報を選択するためのユーザオブジェクトID(HwfLoginWorkflow,HwfGetUserなどで取得)を格納した領域を指定します。
roleid
情報を選択するためのロールオブジェクトID(HwfGetRoleなどで取得)を格納した領域を指定します。
bpid
情報を選択するためのビジネスプロセスオブジェクトID(HwfGetBusinessProcessで取得)を格納した領域を指定します。
number
フォームリストを取得する要素の先頭番号を指定します。先頭番号は0~(total-1)の範囲内で指定してください。
formlistn
フォームリストを取得する要素数を指定します。
必ず1以上の値を指定してください。
total
フォームリストの取得できる全要素数(reqmodeで指定した条件に対応する情報)を取得する領域を指定します。
count
このAPI関数が取得したフォームリストの要素数を取得する領域を指定します。
formlist
フォームリストを取得する領域を指定します。
formlistnで指定した要素数分の領域を必ず指定してください。
フォームリスト内の設定項目については,フォームリスト内項目を参照してください。
errlist
このAPIがエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このシステムに登録された案件でreqmodeで指定した条件に対応するものが存在しない場合は,totalは0で,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • number≧totalの場合は,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となり,totalにこのシステムに登録された案件でreqmodeで指定した条件に対応する要素数が設定されます。
(c) HwfGetCaseFromRole(ロールトレーからユーザトレーへの案件の取り出し)

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

機能
ロールトレーから任意の案件,又は複数の案件をユーザトレーに取り出します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
ただし,一般ユーザは自トレーへの移動だけできます。
構文

#include<bwf.h>
long HwfGetCaseFromRole(
 BWF_useroid_t __far *useroid,   /* ユーザオブジェクトID設定領域 (I) */
 BWF_server_t  __far *server,   /* サーバ名称設定領域 (I) */
 long                reqmode,   /* 要求種別設定領域 (I) */
 BWF_caseid_t  __far *caseid,   /* 任意取り出しケースオブジェクトID設定領域 (I) */
 long                casenum,   /* 複数ケース取り出し数 (I) */
 BWF_roleid_t  __far *roleid,   /* ロールオブジェクトID設定領域 (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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
reqmode
案件の取り出し方法を指定します。
  • BWF_SELECT_OBJECT
    案件オブジェクトIDを指定して取り出します。
caseid
ロールトレーから任意に取り出したい案件の案件オブジェクトID(HwfGetCaseなどで取得)を指定します。reqmodeにBWF_SELECT_OBJECTを指定したときだけ有効です。
casenum
1を指定してください。
roleid
案件を取り出すロールのロールオブジェクトID(HwfGetRoleなどで取得)を格納した領域を指定します。
suseroid
案件をロールトレーから取り出すユーザのユーザオブジェクトID(HwfGetUserなどで取得)を格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 案件をロールトレーから取り出す場合,roleidで指定したロールが存在している必要があります。
  • 案件をロールトレーから取り出す場合,suseroidで指定したユーザはroleidで指定したロールに登録されたユーザである必要があります。
  • 案件をロールトレーから取り出す場合,caseidで指定したケースがroleidで指定したロールトレーに存在している必要があります。
  • 案件をロールトレーから取り出す場合,suseroidで指定したユーザは運用可能状態である必要があります。
(d) HwfTakeBackCase(案件の引き戻し要求)

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

機能
ユーザヒストリで指定した案件を自トレーに引き戻します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfTakeBackCase(
 BWF_useroid_t  __far *useroid,    /* ユーザオブジェクトID設定領域 (I) */
 BWF_server_t   __far *server,     /* サーバ名称設定領域 (I) */
 void           __far *userhistory,  /* 引き戻し対象ユーザヒストリ設定領域 (I) */
 long                 takemode,    /* 引き戻し実行モード (I) */
 BWF_errlist_t  __far *errlist     /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
userhistory
引き戻し対象となる案件を特定するユーザヒストリ(HwfGetHistoryで取得)1要素の先頭ポインタを指定します。
指定できるユーザヒストリは,「案件の投入」,「案件の遷移要求」によるものだけです(HwfGetHistoryを参照してください)。
takemode
引き戻し処理の実行モードを指定します。
BWF_TAKE_GRACE_MODE:引き戻し要求ノードから引き戻す案件が存在するノードの間に同報,分割,回収,待合,複写ノードが存在しない場合,引き戻しができるモードです(同報,分割,回収,待合,複写ノードが存在した場合,戻り値はエラーリターンとなります)。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 引き戻し要求対象の案件が作業中の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 引き戻し操作禁止オプションを指定して登録した拡張ビジネスプロセス定義に投入された案件のヒストリのイベントハンドル(usehistoryで指定)に対してこの関数を発行すると,戻り値はエラーリターン(BWF_ERROR)となります。
(e) HwfCreateCase(案件生成)

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

機能
ビジネスプロセス定義に投入する案件を生成します。
また,案件を生成するときに,次に示す属性を設定できます。
  • 案件名称
  • 案件識別子フォーマット(ワークID)
  • 処理期限
  • 優先度
  • ユーザ属性(文字,整数,日時の3種類で任意個数)
ユーザ属性の各種類別に設定できる数については,基本的に各種類五つずつで,六つ以上の場合は,Groupmax Workflow Definerでの案件のユーザ属性定義で指定した数となります。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfCreateCase(
 BWF_useroid_t  __far *useroid,       /* ユーザオブジェクトID設定領域   (I) */
 BWF_server_t   __far *server,       /* サーバ名称設定領域 (I) */
 BWF_casename_t __far *casename,      /* 案件名称設定領域 (I) */
 BWF_bpid_t     __far *bpid,        /* ビジネスプロセス定義オブジェクトID設定領域 (I) */
 BWF_userkey_t  __far *userkey,       /* 案件識別子フォーマット設定領域 (I) */
 BWF_time_t     __far *limit,        /* 処理期限設定領域 (I) */
 long                 priority,       /* 優先順位 (I) */
 long                 userattrlistn,    /* 設定属性情報リスト数 (I) */
 BWF_userattrlist_t __far *userattrlist,  /* 設定属性情報リスト設定領域 (I) */
 BWF_caseid_t   __far *caseid,       /* 案件オブジェクトID取得領域 (O) */
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
casename
生成する案件に設定する案件名称を格納した領域を指定します。案件名称は,HwfGetCaseFormなどを発行して取得したユーザ処理リストを基に設定してください。案件名称は,終端にNULL文字を付けた64バイト以内の文字列で指定してください。
bpid
生成する案件を登録する,ビジネスプロセス定義のビジネスプロセス定義オブジェクトID(HwfGetBusinessProcess,HwfGetCaseFormなどで取得)を格納した領域を指定します。
userkey
生成する案件に,設定する案件識別子フォーマット(ワークID)を格納した領域を指定します。
案件識別子フォーマット(ワークID)は,終端にNULL文字を付けた64バイト以内の文字列で指定してください。
limit
生成する案件に設定する処理期限を格納した領域を指定します。なお,処理期限はYYYYMMDDhhmmss形式の14バイトの文字列で,1970/01/01 10:00:00から2038/01/19 03:14:07の範囲で指定してください(文字列の終端にはNULL文字を付ける必要はありません)。
priority
生成する案件に設定する優先度を格納した領域を指定します。
BWF_URGENT:至急
BWF_NORMAL:普通
この優先度による案件の遷移制御はしません。
userattrlistn
生成する案件に設定するユーザ属性値数を指定します。ユーザ属性値数を指定しない場合は,0を指定してください(700を超えるユーザ属性値は指定できません)。
userattrlist
生成する案件に設定するユーザ属性値情報を格納した領域を指定します。文字,整数,日時の3種類の案件内ユーザ属性の構成を次に示します。
項目長さ
文字型ユーザ属性32
整数型ユーザ属性4
日時型ユーザ属性14
上記に示した構成のユーザ属性に属性値を設定する場合は,userattrlistに必要な情報を格納し,その領域を指定すると設定されます。userattrlist内の項目を次に示します。
項目内容
BWF_obj_attr_name属性値を設定するユーザ属性の属性名称を指定します。
ユーザ属性に対応する属性名称は,HwfGetCaseForm,HwfGetCaseFormSelectを発行して取得したフォームリスト内の作業情報を基に設定してください(属性名称については,HwfTakeOperationInfのパラメタとして,HwfGetCaseForm,HwfGetCaseFormSelectで取得したユーザ処理リスト指定すると簡単に取得できます)。
属性名称の終端に必ずNULL文字を付けてください。
BWF_attr_type属性値を設定するユーザ属性に対応する属性型を指定します。
ユーザ属性に対応する属性型は,HwfGetCaseForm,HwfGetCaseFormSelectを発行して取得したフォームリスト内の作業情報を基に設定してください(属性型については,HwfTakeOperationInfのパラメタとしてHwfGetCaseForm,HwfGetCaseFormSelectで取得したユーザ処理リスト指定すると簡単に取得できます)。
属性型の終端に必ずNULL文字を付けてください。
BWF_attr_valueユーザ属性に設定する属性値を指定します。
ユーザ属性に対応する属性値は,HwfGetCaseForm,HwfGetCaseFormSelectを発行して取得したフォームリスト内の作業情報を基に設定してください(属性値の一部については,HwfTakeOperationInfのパラメタとしてHwfGetCaseForm,HwfGetCaseFormSelectで取得したユーザ処理リスト指定すると簡単に取得できます)。
文字型ユーザ属性については,文字列を設定してください。
整数型ユーザ属性については,案件内ユーザ属性の構成で4バイトになっていますが,"-2147483648​"~"2147483647​"の最大11バイトまでの文字列に変換して設定してください。
日時型ユーザ属性については,limitと同じ形式で設定してください。
属性値の終端に必ずNULL文字を付けてください。
caseid
生成した案件のオブジェクトIDを取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • bpidで指定したビジネスプロセス定義は存在,かつ登録済みでないと案件は生成されません。
  • このバージョンでは,処理期限による案件の遷移制御はしません。
  • このバージョンでは,優先度による案件の遷移制御はしません。
(f) HwfPutCaseOnBusinessProcess(ビジネスプロセスの指定バージョンへの案件投入)

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

機能
指定ビジネスプロセスの指定バージョンへ案件を投入します。投入時次に示す処理をします。
  • 案件識別子フォーマット(ワークID)の一意性チェック
    指定案件と同一案件名を持ち,かつ同一案件識別子フォーマットの案件が指定したビジネスプロセス(ビジネスプロセス名称が同じ場合,バージョンは問わない)に存在する場合,案件を投入できません。
  • バージョンアップ投入
    最新バージョンのビジネスプロセスに案件を投入するとき,指定案件と異なる案件名称,かつ同一案件識別子フォーマットを持つ案件が,旧バージョンに存在する場合,旧バージョンのビジネスプロセスに案件を投入します(投入モードの指定が必要です)。
  • ルート案件投入
    同一案件識別子で,かつ案件名称が異なる複数の案件を指定ビジネスプロセスの指定バージョンへ投入します。
    また,投入に失敗した場合,次に示す処理が指定できます。
  • 案件生成後,投入までにトランザクションがコミットされていない場合,その案件を削除します。
  • 案件を投入したユーザのトレーに追加します。
  • "system"ユーザのトレーに案件を追加します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfPutCaseOnBusinessProcess(
 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,    /* 案件識別子フォーマット配列格納領域 (I) */
 char           __far *aliaskey,   /* 案件タイトル名格納領域 (I) */
 long                 putmode1,    /* 投入モード1 (I) */
 long                 putmode2,    /* 投入モード2 (I) */
 unsigned long        errmode,    /* エラー発生時の処理モード (I) */
 unsigned long  __far *putversion,  /* 投入成功バージョン番号格納領域 (O) */
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
bpname
案件を投入するビジネスプロセス名称を指定します。
ビジネスプロセス名称は,は,終端にNULL文字を付けた64バイト以内の文字列で指定してください。
ビジネスプロセス名称は,HwfGetBusinessProcess,HwfGetCaseFormなどで取得できます。
version
案件を投入するビジネスプロセスのバージョン番号を指定します。
bpnameで指定したビジネスプロセスの運用できる最新バージョンに投入する場合,BWF_ACTC_VERSIONを指定してください。
バージョン番号は,HwfGetBusinessProcess,HwfGetCaseFormなどで取得できます。
nodename
案件を投入する開始処理ノード名称を指定します。
開始処理ノード名称は,終端にNULL文字を付けた64バイト以内の文字列で指定してください。
開始処理ノード名称はHwfGetCaseFormなどで取得できます。
number
投入する案件数を指定します。1以上の値を指定してください。
2以上を指定する場合,すべての案件の案件識別子フォーマットは同一である必要があります。
caseid
投入する案件のオブジェクトIDを格納した領域を指定します。
案件のオブジェクトIDは,HwfCreateCaseで取得できます。
userkey
投入する案件の案件識別子フォーマットを変更する場合に指定します。変更の必要がない場合,パラメタにNULLポインタを指定してください。
指定した場合,caseidで指定した案件すべての案件識別子フォーマットが変更になります。案件識別子フォーマットはは,終端にNULL文字を付けた64バイト以内の文字列で指定してください。ただし,投入する案件数が複数の場合,全案件に共通する案件識別子フォーマットを指定してください。
aliaskey
投入する案件に設定する案件タイトル名を指定します。指定の必要がない場合,パラメタにNULLポインタを指定してください。ただし,同一案件識別子フォーマットを持つ案件が投入済みで,その案件に案件タイトル名が設定済みの場合,設定済みの案件タイトル名が優先されます。
案件タイトル名は,は,終端にNULL文字を付けた64バイト以内の文字列で指定してください。
putmode1
案件投入時のモードを指定します。
BWF_GRACE_MODE:bpnameで指定したビジネスプロセスに同一案件名,かつ同一案件識別子フォーマットを持つ案件が存在する場合エラーリターンします。
BWF_FORCE_MODE:versionにBWF_ACTC_VERSIONを指定した場合だけ有効です。運用できる最新バージョンのビジネスプロセス中に同一案件名,かつ同一案件識別子フォーマットを持つ案件が存在する場合でも,強制的に案件を投入します。ただし,旧バージョンに同様の案件が存在する場合エラーリターンします。
 
versionにBWF_ACTC_VERSION以外を指定した場合,BWF_GRACE_MODEで処理します。
putmode1にBWF_GRACE_MODE,BWF_FORCE_MODE以外を指定した場合,BWF_GRACE_MODEで処理します。
putmode2
複数の開始処理ノードに各々の案件を投入する場合,投入案件のメイン,サブを指定します。
BWF_MAIN_MODE:メインを指定する場合に指定します。
案件投入時,別案件名称で同一案件識別子フォーマットを持つ案件がない場合でも正常に投入します。
BWF_SUB_MODE:サブを指定する場合に指定します。
案件投入時,別案件名称で同一案件識別子フォーマットを持つ案件がない場合,エラーリターンします。
  • メイン指定
    案件投入時にワークを新規に作成します。
  • サブ指定
    案件投入時にワークを新規に作成しないで,既に存在する同一案件識別子フォーマットを持つワーク下に投入し案件を追加します。
putmode2にBWF_MAIN_MODE,BWF_SUB_MODE以外を指定した場合,BWF_MAIN_MODEで処理します。
errmode
このAPI関数がエラーリターン,かつerrlistのsBMsgKbnに"KMWMJ"が設定されていた場合の案件の処理を指定します。
BWF_ROLLBACK_MODE:このAPI関数がエラーリターンした場合,内部的にロールバックします。
案件生成後,HwfCommitTransactionなどでコミットされていない場合,案件は削除されます。
BWF_TRAY_MODE:このAPI関数がエラーリターンした場合,案件は投入したユーザのトレーに追加されます。
案件については,Groupmax Workflow Monitorを使用してキャンセルするか,このAPI関数を使用して再投入を試みることができます。
BWF_SYSTEM_TRAY_MODE:このAPI関数がエラーリターンした場合,案件は"system"ユーザのトレーに追加されます。
案件については,Groupmax Workflow Monitorを使用してキャンセルするか,このAPI関数を使用して再投入を試みることができます。
putversion
投入に成功したビジネスプロセスのバージョン番号を取得する領域を指定します。指定の必要がない場合は,NULLポインタを指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
(g) HwfGetWorkId(ビジネスプロセスへ投入する案件に設定するワークIDの取得)

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

機能
Groupmax Workflow Definerの属性定義画面で指定したワークID形式を基に,ビジネスプロセスへ投入する案件に対して,指定されたビジネスプロセスで一意なワークID(案件識別子フォーマット)を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetWorkId(
 BWF_useroid_t  __far *useroid,   /* ユーザオブジェクトID設定領域 (I) */
 BWF_server_t   __far *server,    /* サーバ名称設定領域 (I) */
 char           __far *bpname,    /* ビジネスプロセス定義名称格納領域 (I) */
 unsigned long        mode,     /* ワークID取得モード (I) */
 unsigned long  __far *result,    /* ワークID取得可否種別取得領域 (O) */
 BWF_userkey_t  __far *userkey,   /* ワークID取得領域 (O) */
 unsigned long  __far *repoption,  /* 取得ワークID更新可否種別取得領域 (O) */
 BWF_errlist_t  __far *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];   /* メッセージ区分 */
 long lBMsgNo;     /* メッセージ番号 */
 char sBInsWord[13];  /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
bpname
一意なワークID(案件識別子フォーマット)を取得するビジネスプロセスのビジネスプロセス定義名称を格納した領域を指定します。
ビジネスプロセス定義名称の長さは,63バイト以内で,終端に必ずNULL文字を付けてください。なお,ビジネスプロセス定義名称はHwfGetBusinessProcess,HwfGetCaseFormSelectExなどで取得できます。
mode
ワークID(案件識別子フォーマット)の取得モードを指定します。
BWF_WORKID_BP_COUNTER:Groupmax Workflow Definerで指定したワークID(案件識別子フォーマット)のフォーマットに対して,通番を文字列で付加し,bpnameに指定したビジネスプロセス定義で,一意なワークID(案件識別子フォーマット)を取得します。
result
bpnameに指定されたビジネスプロセスに対するGroupmax Workflow Definerの属性定義画面で,ワークIDの形式が指定されているかどうかの情報を取得する領域を指定します。
BWF_GETABLE_WORKID:ワークID取得可能(Groupmax Workflow Definerで,ワークIDの形式が指定されている)。
BWF_UNGETABLE_WORKID:ワークID取得不可能(Groupmax Workflow Definerで,ワークIDの形式が指定されていない)。
userkey
ワークID(案件識別子フォーマット)を取得する領域を指定します。
resultがBWF_GETABLE_WORKIDの場合だけ,ワークIDが設定されます。
repoption
resultがBWF_GETABLE_WORKIDの場合だけ,bpnameに指定されたビジネスプロセスに対するGroupmax Workflow Definerの属性定義画面で,「ワークIDを更新禁止にする」にチェックがされているかどうかの情報を取得する領域を指定します(resultがBWF_GETABLE_WORKID以外の場合は不定です)。
BWF_REP_WORKID:ワークID更新可能(「ワークIDを更新禁止にする」がチェックされていない)。
BWF_NONREP_WORKID:ワークID更新不可能(「ワークIDを更新禁止にする」がチェックされている)。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数は,HwfCreateCaseの前に発行して,そこで取得したワークID(案件識別子フォーマット)を,HwfCreateCaseのパラメタに指定して案件を生成してください。
  • repoptionで取得される情報については,特にユーザアプリケーションプログラム側に対してそれに伴った画面表示などを強制するものではありませんが,取得したワークID(案件識別子フォーマット)を更新することで,一意性が損なわれるおそれがありますので,一意性については更新元で管理してください。
  • このAPI関数で取得したワークID(案件識別子フォーマット)を使用しなかった,又は変更した場合,そのワークID(案件識別子フォーマット)の一意性は,このAPI関数の発行元で管理してください。
(h) フォームリスト内項目
項目内容
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_kind_codeBWF_fm_node_idに対応する開始処理ノードで行う作業の種別が設定されています。
"01":案件の生成,投入
"02":案件に文書を追加格納
"03":案件のユーザ属性に任意値設定
"04":案件のユーザ属性に候補値設定
"05":サブノードからの案件投入(案件投入時にワークを新規に作成しないで,既に存在する同一案件識別子フォーマットを持つワーク下に投入し案件を追加します)
"08":案件の任意ユーザ状態コードへ候補値設定
"09":案件の属性値を一覧表示時に出力
"10":任意データを参照
"11":アプリケーションプログラムを起動
"12":案件情報をGroupmax Document Managerへ格納(ワーク情報,案件情報,ワークヒストリ,文書,メモなどを必要に応じてGroupmax Document Managerに格納してください)
"13":案件の複写先を指定
"99":前の作業種別の継続
BWF_fm_create_conditionBWF_fm_kind_codeに対応する作業の実行条件が設定されています。
"01":必須
"02":任意
0x0000:BWF_fm_kind_codeが次に示す場合に設定されます。
  • 「案件の任意ユーザ状態コードへ候補値設定("08")」
  • 「案件の属性値を一覧表示時に出力("09")」
  • 「アプリケーションプログラムを起動("11")」
  • 「案件情報をGroupmax Document Managerへ格納("12")」
  • 「任意データを参照("10")」
  • 「前の作業種別の継続("99")」
BWF_fm_case_nameBWF_fm_kind_codeに対応する作業の対象となる案件の名称が設定されています。だたし,BWF_fm_kind_codeが次に示す場合,すべてにNULL文字が設定されます。
  • 「案件の任意ユーザ状態コードへ候補値設定("08")」
  • 「アプリケーションプログラムを起動("11")」
  • 「案件情報をGroupmax Document Managerへ格納("12")」
  • 「任意データを参照("10")」
BWF_fm_get_operation_listBWF_fm_kind_codeに対応する作業情報が設定されています。この情報はBWF_fm_kind_codeに設定された種別によって,格納形式が異なります。作業情報の格納形式を次に示します。
作業情報格納形式(案件の生成,投入(”01”))
作業情報を参照する必要はありません。
作業情報格納形式(案件に文書を追加格納(”02”))
作業情報には終端のNULL文字を含め,256バイト以内の情報が設定されます。この情報を基に,HwfCreateCaseで生成した案件に,HwfSetObjectInstanceで登録した文書を格納します。
形式
追加文書名称1,追加文書名称2,..,追加文書名称n¥0
追加文書名称
案件に追加格納する文書名称が64バイト以内の文字列として設定されます。
追加文書名称セパレータ(',')
追加文書名称が複数設定されている場合の区切りを示します。
作業情報終端文字('¥0')
作業情報の終端(NULL文字)を示します。
設定例
申込書,診断書¥0
作業情報格納形式(案件のユーザ属性に任意値設定(”03”))
作業情報には終端のNULL文字を含め,256バイト以内の情報が設定されます。
案件を生成する場合にHwfCreateCaseのパラメタとして,属性名称,属性型に対応する任意値を指定して,案件のユーザ属性に任意値を指定します。
形式
属性名称0x0aユーザ定義名称0x0a属性型0x0a¥0
属性名称
属性値を設定するユーザ属性の属性名称が設定されます。
この情報をHwfCreateCase,HwfGetCaseExistUserAttrValueのパラメタとして設定します。
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,属性型の区切りを示します。
ユーザ定義名称
案件のユーザ属性に設定する属性値の意味が設定されます。
属性型
案件のユーザ属性に設定する属性値の型が設定されます。
"01":文字型
"02":整数型
"03":日時型
この情報をHwfCreateCaseのパラメタとして設定します。
作業情報終端文字('¥0')
作業情報の終端(NULL文字)を示します。
設定例
WF_cs_attr_int_10x0a借入限度額0x0a020x0a¥0
作業情報格納形式(案件のユーザ属性に候補値設定(”04”))
作業情報を基に,案件を生成する場合にHwfCreateCaseのパラメタとして,属性名称,属性型,候補値を指定して,案件のユーザ属性に候補値を設定します。なお,作業情報内にすべての情報が格納できない場合,作業情報の先頭から255バイトで一度区切り,NULL文字で終端し,次のフォームリストの作業種別が「前の作業種別の継続("99")」である作業情報の先頭に続きである256バイト目以降の情報が設定されます。
形式
属性名称0x0aユーザ定義名称0x0a属性型0x0a候補値1,候補値2,..候補値n0x0a¥0
属性名称
属性値を設定するユーザ属性の属性名称が設定されます。
この情報をHwfCreateCaseのパラメタとして設定します。
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,属性型の区切りを示します。
ユーザ定義名称
案件のユーザ属性に設定する属性値の意味が設定されます。
属性型
案件のユーザ属性に設定する属性値の型が設定されます
"01":文字型
"02":整数型
"03":日時型
この情報をHwfCreateCaseのパラメタとして指定します。
候補値
案件のユーザ属性に設定するデータの候補値が設定されます。
この候補値のどれかをHwfCreateCaseのパラメタとして設定します。
候補値セパレータ(',')
候補値1~nの区切りを示します。
作業情報終端文字('¥0')
作業情報の終端(NULL文字)を示します。
設定例
WF_cs_attr_char_10x0a審査結果0x0a010x0aOK,NG0x0a¥0
作業情報格納形式(サブノードからの案件投入(”05”))
作業情報を参照する必要はありません。
作業情報格納形式(案件の任意ユーザ状態コードへ候補値設定(”08”))
作業情報内にすべての情報が格納できない場合,作業情報の先頭から255バイトで一度区切り,NULL文字で終端し,次のフォームリストの作業種別が「前の作業種別の継続("99")」である作業情報の先頭に続きである256バイト目以降の情報が設定されます。
形式
候補値1,候補値2,..候補値n0x0a¥0
候補値
案件のユーザ属性に設定するデータの候補値が設定されます。
候補値セパレータ(’,’)
候補値1~nの区切りを示します。
作業情報終端文字(’¥0’)
作業情報の終端を示します。
設定例
受付,保留中,完了0x0a¥0
作業情報格納形式(案件の属性値を一覧表示時に出力(”09”))
作業情報には終端のNULL文字を含め,256バイト以内の情報が設定されます。
生成した案件を投入する前に,パラメタとしてBWF_fm_create_conditionが「必須」となっているフォームリストの作業情報を基に,案件のユーザ属性に対して属性値を設定しているかをHwfGetCaseExistUserAttrValueを発行して確認してください。これによって,案件のユーザ属性に対する属性値設定漏れによる,処理開始ノード以降に存在する分岐ノードでの分岐エラー,又は誤ったノードへ案件が分岐するのを防止してください。
形式
属性名称0x0aユーザ定義名称0x0a属性型0x0a¥0
属性名称
属性値を設定するユーザ属性の属性名称が設定されます。
この情報をHwfCreateCase,HwfGetCaseExistUserAttrValueのパラメタとして設定します。
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,属性型の区切りを示します。
ユーザ定義名称
案件のユーザ属性に設定する属性値の意味が設定されます。
属性型
案件のユーザ属性に設定する属性値の型が設定されます。
"01":文字型
"02":整数型
"03":日時型
この情報をHwfCreateCaseのパラメタとして設定します。
作業情報終端文字('¥0')
作業情報の終端(NULL文字)を示します。
設定例
WF_cs_attr_int_10x0a借入限度額0x0a020x0a¥0
作業情報格納形式(任意データを参照(”10”))
作業情報は,ユーザが任意に定義した文字列データが,終端のNULL文字を含め,最大256バイトの文字列として設定されます。ユーザが自由に使ってください。
形式
ユーザ任意定義文字列¥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のパラメタとして,必要な複写先ノード名称を指定し,複写先ノード情報を生成します。
  • HwfCreateCaseで案件のユーザ属性に対して,複写先ノード情報を文字列として指定します。
なお,作業情報内にすべての情報が格納できない場合,作業情報の先頭から255バイトで一度区切り,NULL文字で終端し,次のフォームリストの作業種別が「前の作業種別の継続("99")」である作業情報の先頭に,続きである256バイト目以降の情報が設定されます。
形式
属性名称0x0aユーザ定義名称0x0a属性型0x0a 複写ノード名称0x0a候補値1,候補値2,..候補値n0x0a¥0
属性名称
属性値を設定するユーザ属性の属性名称が設定されます。
この情報をHwfCreateCaseのパラメタとして設定します。
項目セパレータ(0x0a)
属性名称,ユーザ定義名称,属性型の区切りを示します。
ユーザ定義名称
案件のユーザ属性に設定する属性値の意味が設定されます。
属性型
案件のユーザ属性に設定する属性値の型が設定されます(文字型だけが設定されます)。
"01":文字型
この情報をHwfCreateCaseのパラメタとして指定します。
複写ノード名称
複写ノードのノード名称が設定されます。
候補値
複写先ノード名称が設定されます。
この情報をHwfCreateCopyInfのパラメタとし,複写先ノード情報を取得して,その情報をHwfCreateCaseのパラメタとして指定します。
候補値セパレータ(',')
候補値1~nの区切りを示します。
作業情報終端文字(’¥0’)
作業情報の終端(NULL文字)を示します。
設定例
WF_cs_attr_char_10x0a営業複写先候補0x0a010x0a営業部複写0x0a営業1課,営業2課,営業3課0x0a¥0
作業情報格納形式(前の作業種別の継続(”99”))
前の作業種別の作業情報から継続している作業領域です。
(i) 投入モードによる処理の違い
投入モード1投入モード2投入前条件1投入前条件2バージョン番号案件投入結果
BWF_GRACE_MODEBWF_MAIN_MODE指定バージョンに同一案件名,同一案件識別子フォーマットの案件有り任意バージョン
(最新を含む)
エラーリターン
BWF_GRACE_MODEBWF_MAIN_MODE指定バージョン以外に同一案件名,同一案件識別子フォーマットの案件有り任意バージョン
(最新を含む)
エラーリターン
BWF_GRACE_MODEBWF_MAIN_MODEどのバージョンにも同一案件名,同一案件識別子フォーマットの案件無しどれかのバージョンに別案件名,同一案件識別子フォーマットの案件有り最新投入前条件2に該当するバージョンのビジネスプロセスへ投入
BWF_GRACE_MODEBWF_MAIN_MODE同上同上最新以外の任意エラーリターン
BWF_GRACE_MODEBWF_MAIN_MODE同上どのバージョンにも別案件名,同一案件識別子フォーマットの案件無し最新最新バージョンのビジネスプロセスへ投入
BWF_GRACE_MODEBWF_MAIN_MODEどのバージョンにも同一案件名,同一案件識別子フォーマットの案件無しどのバージョンにも別案件名,同一案件識別子フォーマットの案件無し最新以外の任意指定バージョンのビジネスプロセスへ投入
BWF_GRACE_MODEBWF_SUB_MODE指定バージョンに同一案件名,同一案件識別子フォーマットの案件有り任意バージョン
(最新を含む)
エラーリターン
BWF_GRACE_MODEBWF_SUB_MODE指定バージョン以外に同一案件名,同一案件識別子フォーマットの案件有り任意バージョン
(最新を含む)
エラーリターン
BWF_GRACE_MODEBWF_SUB_MODEどのバージョンにも同一案件名,同一案件識別子フォーマットの案件無しどれかのバージョンに別案件名,同一案件識別子フォーマットの案件有り最新投入前条件2に該当するバージョンのビジネスプロセスへ投入
 
 
  
 エラーリターン
最新以外の任意
BWF_GRACE_MODEBWF_SUB_MODEどのバージョンにも同一案件名,同一案件識別子フォーマットの案件無しどのバージョンにも別案件名,同一案件識別子フォーマットの案件無し任意バージョン
(最新を含む)
エラーリターン
BWF_FORCE_MODEBWF_MAIN_MODE指定バージョンに同一案件名,同一案件識別子フォーマットの案件有り最新最新バージョンのビジネスプロセスへ投入
 
  
 エラーリターン
最新以外の任意
BWF_FORCE_MODEBWF_MAIN_MODE指定バージョン以外に同一案件名,案件識別子フォーマットの案件有り任意バージョンエラーリターン
  
最新投入前条件1に該当するバージョンのビジネスプロセスへ投入
BWF_FORCE_MODEBWF_MAIN_MODEどのバージョンにも同一案件名,案件識別子フォーマットの案件無しどれかのバージョンに別案件名,同一案件識別子フォーマットの案件有り最新投入前条件2に該当するバージョンのビジネスプロセスへ投入
BWF_FORCE_MODEBWF_MAIN_MODE同上同上最新以外の任意エラーリターン
BWF_FORCE_MODEBWF_MAIN_MODEどれかのバージョンにも同一案件名,案件識別子フォーマットの案件無しどのバージョンにも別案件名,同一案件識別子フォーマットの案件無し任意バージョン
(最新を含む)
指定バージョンのビジネスプロセスへ投入
BWF_FORCE_MODEBWF_SUB_MODE指定バージョンに同一案件名,案件識別子フォーマットの案件有り最新指定バージョンのビジネスプロセスへ投入
 
  
 エラーリターン
最新以外の任意
BWF_FORCE_MODEBWF_SUB_MODE指定バージョン以外に同一案件名,案件識別子フォーマットの案件有り任意バージョンエラーリターン
  
最新投入前条件1に該当するバージョンのビジネスプロセスへ投入
BWF_FORCE_MODEBWF_SUB_MODEどのバージョンにも同一案件名,案件識別子フォーマットの案件無しどれかのバージョンに別案件名,同一案件識別子フォーマットの案件有り最新投入前条件2に該当するバージョンのビジネスプロセスへ投入
 
 
  
 エラーリターン
最新以外の任意
BWF_FORCE_MODEBWF_SUB_MODE同上どのバージョンにも別案件名,同一案件識別子フォーマットの案件無し任意バージョン
(最新を含む)
エラーリターン

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

(a) HwfGetCase(ユーザトレー,ロールトレー,ワークに存在する案件情報取得)

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

機能
ユーザトレー,ロールトレー,又はワークに存在する案件の案件情報(案件項目リスト)を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetCase(
 BWF_useroid_t  __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,  /* サーバ名称格納領域 (I) */
 long                 reqmode,  /* 要求種別 (I) */
 long                 topnum,   /* 上位案件数 (I) */
 long                 bottomnum, /* 下位案件数 (I) */
/* 上位案件用パラメタ */  
 long                 selectmode, /* 選択条件 (I) */
 BWF_useroid_t  __far *suseroid, /* ユーザオブジェクトID格納領域 (I) */
 BWF_bpid_t     __far *bpid,   /* ビジネスプロセス定義オブジェクトID格納領域 (I) */
 BWF_roleid_t   __far *roleid,  /* ロールオブジェクトID格納領域 (I) */
 BWF_workid_t   __far *workid   /* ワークオブジェクトID格納領域 (I) */
 long                 sortkey,  /* ソートキー (I) */
 long                 sortmode,  /* ソートモード (I) */
 long                 number,   /* 案件項目リスト取得先頭要素番号 (I) */
 long                 tcaselistn, /* 案件項目リスト取得要素数 (I) */
 long           __far *total,   /* 案件項目リスト全要素数 (O) */
 long           __far *tcount,  /* 取得上位案件項目リスト要素数 (O) */
/* 上位案件,下位案件両用パラメタ */  
 BWF_caselist_t __far *tcaselist, /* 上位案件項目リスト格納領域 (I/O) */
/* 下位案件用パラメタ */  
 long           __far *bcount,  /* 取得下位案件項目リスト要素数 (O) */
 BWF_caselist_t __huge *bcaselist,/* 下位案件項目リスト取得領域 (O) */
/* 上位案件,下位案件両用パラメタ */  
 BWF_errlist_t  __far *errlist  /* エラー情報取得領域 (O) */
 );
 typedef struct BWF_caselist_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;       /* 案件識別子フォーマット */
 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];   /* 処理状態コード */
 char          BWF_cs_status_code_2[4];   /* 遷移状態コード */
 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_caselist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどれかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどれかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
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
selectmode
suseroid
bpid
roleid
workid
sortkey
sortmode
number
tcaselistn
total
tcount
tcaselist○(O)○(O)○(I)
bcount
bcaselist
errlist
(凡例)
○:指定が必要です。
-:このパラメタを無視します。
○(O):出力情報取得領域の指定が必要です。
○(I):入力項目の指定が必要です。
※:selectmodeに依存します。

topnum
reqmodeがBWF_BOTTOM_CASEの場合,上位案件項目リスト(tcaselistに指定)の要素数を指定します。最大84まで指定できます。
bottomnum
下位案件項目リスト(bcaselistに指定)の要素数を指定します。
アプリケーションプログラムが,アクセスできるメモリの大きさによって,指定できる最大数は異なります。
また,reqmodeの指定によって,次のように指定するようにしてください。
reqmodeがBWF_ALL_CASEの場合,一つの上位案件に属する下位案件数を指定します。このAPI関数は取得対象の下位案件数が,tcaselistn×bottomnumを超えた場合は,このAPI関数の戻り値にはエラーリターンを返します。
reqmodeがBWF_BOTTOM_CASEの場合,上位案件項目リスト(tcaselistに指定)中の全ルート案件に属する下位案件の総数を指定します。このAPI関数は取得対象の案件がbottomnumを超えた場合は,戻り値にエラーリターンを返します。
selectmode
reqmodeで指定した条件に加えて,更に絞り込む場合のモードを指定します。
BWF_GMW_USER:suseroidで指定した,ユーザのユーザトレー内に存在する案件の案件属性リストを取得します。
BWF_GMW_USER_BP:suseroidで指定した,ユーザのユーザトレー内に存在する案件で,bpidで指定したビジネスプロセスに関連する案件の案件項目リストを取得します。
BWF_GMW_USER_BP_ROLE:suseroidで指定した,ユーザのユーザトレー内に存在する案件で,bpidで指定したビジネスプロセス,及びroleidで指定したロールに関連する案件の案件項目リストを取得します。
BWF_GMW_ROLE:roleidで指定した,ロールのロールトレー内に存在する案件の案件項目リストを取得します。
BWF_GMW_ROLE_BP:roleidで指定した,ロールのロールトレーに存在する案件で,bpidで指定したビジネスプロセスに属する案件の案件項目リストを取得します。
BWF_GMW_WORK:workidで指定した,ワーク中の案件の案件項目リストを取得します。
selectmodeの指定によって,次に示すように以降のパラメタに情報を設定する必要があります。
パラメタBWF_GMW_USERBWF_GMW_USER_BPBWF_GMW_USER_BP_ROLEBWF_GMW_ROLEBWF_GMW_ROLE_BPBWF_GMW_WORK
suseroid×××
bpid×××
roleid×××
workid×××××
(凡例)
○:指定が必要です。
×:指定は不要です。

suseroid
案件を選択するためのユーザオブジェクトID(HwfGetUserなどで取得)を格納した領域を指定します。
bpid
案件を選択するためのビジネスプロセス定義オブジェクトID(HwfGetBusinessProcess,HwfGetCaseFormなどで取得)を格納した領域を指定します。
roleid
案件を選択するためのロールオブジェクトID(HwfGetRoleなどで取得)を格納した領域を指定します。
workid
案件を選択するためのワークオブジェクトID(HwfGetCase,HwfGetWorkAttributeなどで取得)を格納した領域を指定します。
sortkey
上位案件リストをソートする場合に次に示すキーを指定します。
BWF_SRT_CASE_NAME:案件名
BWF_SRT_CASE_ALIAS_NAME:作業名
BWF_SRT_CASE_USER_KEY:案件識別子フォーマット(ワークID)
BWF_SRT_CASE_CREATE_NAME:作成者
BWF_SRT_CASE_CREATE_TIME:作成日時
BWF_SRT_CASE_ARRIVAL_TIME:到着日時
BWF_SRT_CASE_LIMIT_TIME:処理期限
BWF_SRT_CASE_BP_NAME:ビジネスプロセス定義名称
BWF_SRT_CASE_TRAY_KIND:トレー種別
BWF_SRT_CASE_PRIORITY:優先度
BWF_SRT_CASE_PROCESS_KIND:案件処理種別
sortmode
上位案件リストをソートする場合のソート順を指定します。
BWF_ASCEND_MODE:昇順にソートします。
BWF_DESCEND_MODE:降順にソートします。
BWF_NOSORT_MODE:ソートしません。
number
上位案件リストを取得する要素の先頭番号を指定します。先頭番号は0~(total-1)の範囲内で指定してください。
tcaselistn
上位案件リストを取得する要素数を指定します。必ず1以上の値を指定してください。
total
案件項目リストの取得できる全要素数(このシステムに登録された案件でreqmode,及びselectmodeで指定した条件に対応する案件数)を取得する領域を指定します。
tcount
このAPI関数が取得した,上位案件の案件項目リストの要素数を取得する領域を指定します。
tcaselist
reqmodeがBWF_ALL_CASE,又はBWF_TOP_CASEの場合,上位案件の案件項目リストを取得する領域を指定します。なお,この領域のサイズは,tcaselistnで指定した要素数分のサイズを必ず確保して指定してください。また,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内に取得される項目については,tcaselistの項目と同一ですので,tcaselistを参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このシステムに登録された案件でreqmode,selectmodeで指定した条件に対応するものが存在しない場合は,totalは0で,このAPI関数の戻り値は正常リターン(BWF_OK)となります。number≧totalの場合は,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となり,totalにこのシステムに登録された案件でreqmode,selectmodeで指定した条件に対応する案件数が設定されます。
  • このAPI関数を発行した場合,必ず対でHwfNotifyPriorityを発行してください。ただし,次の状態でHwfNotifyPriorityを発行した場合,戻り値はエラーリターン(BWF_ERROR)となりますので注意してください。
 
  • reqmodeにBWF_TOP_CASEを指定して,このAPI関数を発行した結果が正常リターン(BWF_OK),かつtcaselist内の情報がすべてルート案件の場合
  • reqmodeにBWF_TOP_CASEを指定して,このAPI関数を発行した結果が正常リターン(BWF_OK),かつtcountが0の場合
  • reqmodeにBWF_ALL_CASEを指定して,このAPI関数を発行した結果が正常リターン(BWF_OK),かつtcount,bcountが0の場合
  • reqmodeに関係なく,このAPI関数を発行した結果がエラーリターン(BWF_ERROR)の場合
  • 他ユーザのユーザトレー,又はロールトレー内の案件情報を取得する場合は,reqmodeにBWF_TOP_CASEを必ず指定してください。
  • selectmodeに,BWF_GMW_USER,BWF_GMW_USER_BP,BWF_GMW_USER_BP_ROLEを指定し,suseroidにuseroidと異なるユーザオブジェクトIDを指定した場合,このAPI関数の戻り値がエラーリターン(BWF_ERROR)となる場合があります。
(b) HwfActCase(案件に対するユーザ処理開始)

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

機能
ユーザトレー内にある案件を処理するために,指定された案件を「処理中」の状態にします。
指定できる案件はルート案件,又は単独の一般案件です。
この関数を発行しないと,案件内の文書/メモの読み出し/更新,及び案件に対する作業結果登録はできません。
また,任意の案件を「処理中」にした後,次に示すAPI関数を発行しなくても同一また,ほかのの案件を「処理中」の状態にできます。
  • HwfDeactCase
  • HwfPauseCase
  • HwfGoCase
  • HwfRoundCase
  • HwfAnswerCase
  • HwfSendBackCase
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使えます。
構文

#include<bwf.h>
long HwfActCase(
 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];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
処理を開始する案件の案件オブジェクトID(HwfGetCaseなどで取得)を格納した領域を指定します。指定できる案件は上位案件,又は単独案件です。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidで指定した案件がuseroidで指定したユーザのトレーに存在しない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • caseidで指定した案件が取消予約状態,及び動作中断状態の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 任意の案件を「処理中」にした後,同一また,ほかの案件を「処理中」の状態した場合,以前に処理中にしていた案件の状態が「処理中」のままになってしまいますが,それについてはユーザ責任の上で案件のステータス管理をしてください。
(c) HwfActCaseWithDocLock(案件に対するユーザ処理開始と文書,メモの排他)

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

機能
ユーザトレー内にある案件が「同報中」の場合,指定された案件を「処理中」の状態にし,なおかつその案件,又はその下位案件に存在する文書と,次に示すメモに対して排他をし,更新をできるようにします。
  • 画像メモ
  • 音声メモ
  • テキストメモ
  • ユーザ独自メモ
  • データメモ
また,他ユーザが既に同様の「同報中」の案件に対して,このAPI関数によって文書,メモを排他状態にしていた場合は,参照だけする「処理中」状態にもできます(案件が「同報中」の場合,対応するユーザ数だけ案件は複写され配布されますが,文書,メモに関して実体は共用されています。また,案件が「同報中」かどうかについては,HwfGetCaseなどを発行し,tcaselist内の対応する案件の「同報状態コード」を参照してください)。
任意の案件を「処理中」にした後,次に示すAPI関数を発行しなくても同一また,ほかの案件を「処理中」の状態にできます。
指定できる案件はルート案件,又は単独の一般案件です。
この関数を発行しないと,案件内の文書/メモの読み出し/更新,及び案件に対する作業結果登録はできません(ただし,文書,メモの更新については,案件に対するユーザ処理開始要求とともに排他要求をして成功した場合だけです)。
文書,メモの排他解除については,次に示すこのAPI関数を発行したユーザが次に示すAPI関数発行することで解除されます。
  • HwfGoCase
  • HwfPauseCase
  • HwfDeactCase
  • HwfRoundCase
  • HwfAnswerCase
  • HwfSendBackCase
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfActCaseWithDocLock(
 BWF_useroid_t  __far *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,    /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far *caseid,    /* 処理開始案件オブジェクトID格納領域 (I) */
 long                 act_case_mode, /* ユーザ処理開始モード (I) */
 long           __far  *lock_result, /* 文書,メモ排他結果 (O) */
 char           __far  *act_username, /* 案件処理開始ユーザ名称 (O) */
 BWF_errlist_t  __far  *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];          /* メッセージ区分 */
 long lBMsgNo;            /* メッセージ番号 */
 char sBInsWord[13];         /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は,取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
処理を開始する案件の案件オブジェクトID(HwfGetCaseなどで取得)を格納した領域を指定します。指定できる案件はルート案件,又は単独の一般案件です。
act_case_mode
案件の処理開始の実行モードを指定します。
BWF_LOCK_ACT:他ユーザが既にcaseidに指定した同様の「同報中」の案件,又はその下位案件に存在する文書,メモに対して排他状態にされていなかった場合,文書,メモを排他状態にしてユーザ処理を開始します。既に他ユーザによって,排他状態にされていた場合はエラーリターンします。
BWF_ALL_ACT:他ユーザが既にcaseidに指定した同様の「同報中」の案件,又はその下位案件に存在する文書,メモに対してこのAPI関数を発行して排他が成功したかどうかに関係なく,ユーザ処理を開始します。排他が既に他ユーザによって行われていた場合,文書,メモは「参照読み出しモード」でしか読み出せません(詳細については,HwfGetObjectInstance,及びHwfGetMemoを参照してください)。
lock_result
caseidに指定した「同報中」の案件,又はその下位案件に存在する文書,メモに対しての排他結果を取得する領域を指定します。
BWF_OK:文書,メモに対して更新ができます。
BWF_ERROR:文書,メモに対して更新はできません。
act_username
caseidに指定した「同報中」の案件,又はその下位案件に存在する文書,メモに対して,更新できるユーザのユーザ名称を取得する領域を指定します。
また,任意のユーザが先にこのAPI関数を発行してcaseidに指定した「同報中」の案件,又はその下位案件に存在する文書,メモに対して排他処理をしている最中に,他ユーザがこのAPI関数を発行した場合,タイミングによってユーザ名称を取得できない時は,"********"が設定されます(lock_resultがBWF_OKの場合,useroidに対応するユーザのユーザ名称が設定されます)。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidで指定した案件が,useroidで指定したユーザのトレーに存在しない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • caseidで指定した案件が,取消予約状態,及び動作中断状態の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • このAPI関数は,ユーザ処理を開始する案件が「同報中」の場合に使用するようにしてください(ただし,ユーザ処理を開始する案件が「通常処理」の場合,このAPI関数を発行しても,HwfActCaseを発行したことと同様になります)。
  • このAPI関数を使用して,「同報中」の案件,又はその下位案件に存在する文書,メモに対して排他をした後に,通信障害などで異常終了,又はそのままログアウトした場合は,他ユーザが同様の「同報中」の案件,又はその下位案件に存在する文書,メモに対して更新ができません(他ユーザが更新をできるようにするためには,異常回復後,又は再ログイン後,それを実行したユーザが<機能>で挙げたAPI関数を発行して,排他状態を解除してください)。
  • 任意の案件を「処理中」にした後,同一また,ほか案件を「処理中」の状態した場合,以前に処理中にしていた案件の状態が「処理中」のままになってしまいますが,それについてはユーザ責任の上で案件のステータス管理をしてください(「同報中」の案件,又はその下位案件に存在する文書,メモに対して排他をかけていた場合も,排他中のままとなり他ユーザが文書,メモを更新できなくなりますので,それについてもユーザ責任の上で排他の管理をしてください)。
  • caseidに指定した同様の「同報中」の案件に,文書もメモも存在しない場合,このAPI関数を発行しても,HwfActCaseを発行したことと同様になります(「同報中」の案件で文書,メモが存在するかどうかについては,HwfGetCaseなどで取得してください)。
  • 遷移終了後(シンク済)の案件に対し,このAPI関数を発行した場合は,文書の排他制御はしないで,rock_resultにはBWF_ERRORが設定され,またact_usernameには"********"が設定されます(遷移終了後かどうかについては,HwfGetCase,又はHwfGetCaseSelectDataで取得できます)。
(d) HwfDeactCase(案件に対するユーザ処理中止)

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

機能
現在,「処理中」のユーザトレー内の案件の処理を中止します。
指定できる案件はルート案件,又は単独の一般案件です。
また,このAPI関数を発行することによって,「処理中」にした次のものは,ロールバックします。
  • 更新した案件内に格納されている文書
  • 更新した案件内に格納されている文書に貼り付いたメモ
  • 更新した案件に貼り付いたメモ
  • 案件のユーザ属性に設定した属性値
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfDeactCase(
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は,取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
処理を中止する,案件の案件オブジェクトID(HwfGetCaseなどで取得)を格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidで指定した案件がuseroidで指定したユーザのトレーに存在しない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • このAPI関数を発行するにあたって,必ず次に示すAPI関数を順に発行していない場合,戻り値はエラーリターン(BWF_ERROR)となります。
    ・HwfGetCase,又はHwfGetCaseSelectData
    ・HwfNotifyPriority
    ・HwfActCase,又はHwfActCaseWithDocLock
(e) HwfPauseCase(案件に対するユーザ処理一時中止)

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

機能
ユーザトレー内にある「処理中」の案件の処理を一時中止して,「保留中」の状態にします。
指定できる案件はルート案件,又は単独の一般案件です。
再度,「処理中」にする場合は,HwfActCase,又はHwfActCaseWithDocLockを発行してください。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfPauseCase(
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は,取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
処理を一時中止する案件の案件オブジェクトID(HwfGetCaseなどで取得)を格納した領域を指定します。指定できる案件はルート案件,又は単独の一般案件です。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidで指定した案件がuseroidで指定したユーザのトレーに存在しない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • このAPI関数を発行するにあたって,次に示すAPI関数を順に発行していない場合,戻り値はエラーリターン(BWF_ERROR)となります。
    ・HwfGetCase,又はHwfGetCaseSelectData
    ・HwfNotifyPriority
    ・HwfActCase,又はHwfActCaseWithDocLock
(f) HwfGoCase(案件の次ノードへの遷移依頼)

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

機能
ユーザトレー内の案件を,次ノードへ遷移依頼します。
指定できる案件はルート案件,又は単独の一般案件です。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGoCase(
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は,取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
次ノードへ遷移依頼する,案件の案件オブジェクトID(HwfGetCaseなどで取得)を格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン

注意事項

(g) HwfRoundCase(他ユーザへの案件の相談)

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

機能
ユーザトレー内にある案件を他ユーザへ相談します(そのとき,案件の案件処理種別には,例外処理が設定されます)。
相談先のユーザがその案件の回答処理をすると,相談元のユーザのトレーに案件が返却されます。
また,相談されたユーザがその案件を他ユーザへ相談するという形で回付することもできます。
指定できる案件はルート(上位)案件,又は一般(単独)案件だけです。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfRoundCase(
 BWF_useroid_t __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t  __far *caseid,  /* 相談案件オブジェクトID格納領域 (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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は,取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
他ユーザへ相談するという形で,回付する案件の案件オブジェクトID(HwfGetCaseなどで取得)を格納した領域を指定します。
suseroid
案件を回付する,ユーザのユーザオブジェクトID(HwfGetUserなどで取得)を格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidで指定した案件が,useroidで指定したユーザのトレーに存在しない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • suseroidで指定したユーザが存在しない,又は運用できる状態でない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • suseroidで自ユーザを指定してこの関数を発行すると,戻り値はエラーリターン(BWF_ERROR)となります。
  • 案件のユーザ処理中にこのAPI関数を発行するにあたって,次に示すAPI関数を順に発行していない場合,戻り値はエラーリターン(BWF_ERROR)となります。
    ・HwfGetCase,又はHwfGetCaseSelectData
    ・HwfNotifyPriority(文書,メモを取得する場合だけ必要)
    ・HwfActCase,又はHwfActCaseWithDocLock
(h) HwfTrustCase(他ユーザへの案件処理依頼)

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

機能
案件を他ユーザへ処理依頼します。
指定できる案件はルート案件,又は単独の一般案件です。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfTrustCase(
 BWF_useroid_t    __far *useroid,   /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t     __far *server,   /* サーバ名称格納領域 (I) */
 long                   caseidlistn, /* 処理依頼案件数 (I) */
 BWF_caseidlist_t __far *caseidlist, /* 処理依頼案件オブジェクトID配列格納領域 (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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は,取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseidlistn
他ユーザへ処理依頼する案件の数を指定します。
caseidlist
他ユーザへ処理依頼する案件の案件オブジェクトID(HwfGetCaseなどで取得)を格納した配列領域を指定します。
suseroid
処理依頼先ユーザのユーザオブジェクトID(HwfGetUserなどで取得)を格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidlistで指定した案件は,ロールトレーからユーザトレーに移動した案件でない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • useroidで指定したユーザが一般ユーザで,caseidlistで指定した案件が,そのユーザのユーザトレーに存在しない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • suseroidで指定した処理依頼先ユーザが,運用不可状態の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • useroidで指定した処理依頼元ユーザ(一般ユーザ)と,suseroidで指定した処理依頼先ユーザが同一ロールに属するユーザでない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • caseidlistで複数の案件を指定した場合,先頭の案件から順に処理依頼をするため,戻り値がエラーリターン(BWF_ERROR)の場合であっても,一部の案件は正常に処理依頼済みとなる場合があります。
(i) HwfGetBackUserList(差し戻し候補者一覧取得)

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

機能
差し戻し先ユーザ(候補者)のユーザデータを取得します。
ビジネスプロセス内に同報,分割,回収,待合,又は複写ノードが存在した場合,案件が現在存在するノードから同報,分割,回収,待合,又は複写ノード以降の差し戻し先ユーザ(候補者)のユーザデータを取得します。
指定した案件が存在するビジネスプロセスが直列型ビジネスプロセスの場合は,現在,案件が存在するビジネスプロセス,及び同一サーバ内に登録されている連携元ビジネスプロセスでの差し戻し先ユーザ(候補者)のユーザデータを取得します。
指定した案件が存在するビジネスプロセスが階層型ビジネスプロセスの場合は,現在,案件が存在するビジネスプロセスの一つ前の上位階層のビジネスプロセスでの差し戻し先ユーザ(候補者)のユーザデータを取得します(ただし,そのビジネスプロセスが最上階層の場合を除きます)。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetBackUserList(
 BWF_useroid_t       __far  *useroid,  /* ユーザオブジェクトID設定領域 (I) */
 BWF_server_t        __far  *server,   /* サーバ名称設定領域 (I) */
 BWF_caseid_t        __far  *caseid,   /* 案件オブジェクトID設定領域 (I) */
 long                       number,   /* ユーザ情報取得開始位置 (I) */
 long                       count,    /* ユーザ情報取得数 (I) */
 long                __far  *total,   /* 全差し戻し可能ユーザ数 (O) */
 long                __far  *userlistn, /* ユーザ情報取得数 (O) */
 BWF_backuserlist_t  __far  *userlist,  /* ユーザ情報取得領域 (O) */
 BWF_errlist_t       __far  *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_backuserlist_t{
 long          BWF_bus_time;       /* 作業時間 */
 char          BWF_bus_hostname[8];   /* 処理サーバ名称 */
 BWF_bpid_t    BWF_bus_bpid;       /* ビジネスプロセス定義識別子 */
 char          BWF_bus_bpname[64];    /* ビジネスプロセス定義名称 */
 BWF_nodeno_t  BWF_bus_nodeid;      /* ノード識別子 */
 char          BWF_bus_nodename[64];   /* ノード名称 */
 BWF_useroid_t BWF_bus_useroid;     /* ユーザoid */
 BWF_useroid_t BWF_bus_username;     /* ユーザ名称 */
 char          BWF_bus_aliasname[64];  /* ユーザ別名(ユーザ日本語名称) */
 short         BWF_bus_userstatus;    /* ユーザ状態コード */
 char          BWF_bus_reserve[32];   /* 予備 */
} BWF_backuserlist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];            /* メッセージ区分 */
 long lBMsgNo;              /* メッセージ番号 */
 char sBInsWord[13];           /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は,取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
差し戻し対象となる,案件の案件オブジェクトID(HwfGetCaseなどで取得)を設定した領域を指定します。
number
取得するユーザ情報の先頭番号を指定します。先頭番号は0~(total-1)の範囲で指定してください。この範囲を超えた場合エラーリターンします。
count
取得するユーザ情報の要素数を指定します。
必ず1以上を指定してください(最大150まで指定できます)。
total
指定した案件を,差し戻しできるユーザのユーザ情報の総数を格納する領域を指定します。
userlistn
取得したユーザ情報の要素数を格納する領域を指定します。
userlist
ユーザ情報の取得領域を指定します((BWF_backuserlist_tのバイト数*count)バイト以上の領域を指定してください。ただし,64KBを超える領域は指定できません)。
次にユーザ情報に取得される項目を次に示します。
項目内容
BWF_bus_time該当ユーザが処理した時間を示します。
BWF_bus_hostname該当ユーザが処理したサーバ名称を示します。実際のサーバ名称が9バイト以上の場合は,先頭の8バイトが設定されます。
BWF_bus_bpid該当ユーザが処理したビジネスプロセス定義のオブジェクトIDを示します。
BWF_bus_bpname該当ユーザが処理したビジネスプロセス定義名称を示します。
BWF_bus_nodeid該当ユーザが処理したノードIDを示します。
BWF_bus_nodename該当ユーザが処理したノード名称を示します。
BWF_bus_useroid該当ユーザのユーザオブジェクトIDを示します。
BWF_bus_username該当ユーザのユーザ名称を示します。また,ユーザが既に削除されている場合は,すべて'*'が設定されます。
BWF_bus_aliasname該当ユーザのユーザ別名(ユーザ日本語名称)を示します。また,ユーザが既に削除されている場合は,すべて'*'が設定されます。
BWF_bus_userstatus該当ユーザの状態コードを示します。
0x0001:自動配布できる状態
0x0002:自動配布抑止状態
0x0003:運用停止状態,又はユーザが削除されている状態
BWF_bus_reserve予備の領域です。

注 「処理」とは,案件の投入,又は,案件の遷移要求を示します


errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 差し戻し対象のユーザ情報は,ワークヒストリ中で過去に該当案件を処理したユーザのものであるため,全差し戻しユーザ数は,ヒストリリストの最大取得可能数を超えることはありません。
  • 差し戻し先の候補者が存在しない場合,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • countに150を超える数を指定した場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • userlist内のBWF_bus_hostnameが,caseidで指定した案件が現在存在するビジネスプロセスが登録されたサーバと異なる場合,userlist内の次に示す項目は,BWF_bus_hostnameに設定されたサーバでの情報となります。
    ・BWF_bus_bpid
    ・BWF_bus_useroid
    ・BWF_bus_username
    ・BWF_bus_aliasname
    ・BWF_bus_userstatus
    (BWF_bus_bpid,BWF_bus_useroidを基に,HwfGetObjectAttributeを使用して情報を取得しようとした場合,HwfGetObjectAttributeの戻り値はエラーリターン(BWF_ERROR)となります)
(j) HwfSendBackCase(案件の差し戻し要求)

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

機能
指定案件を指定ユーザに差し戻します。
指定した案件が存在するビジネスプロセスが直列型ビジネスプロセスの場合は,現在,案件が存在するビジネスプロセス内で処理をしたユーザだけ,差し戻しができます。
指定した案件が存在するビジネスプロセスが直列型ビジネスプロセスの場合は,現在,案件が存在するビジネスプロセス,及び同じサーバ内に登録されている連携元ビジネスプロセスで処理したユーザに対して,差し戻しができます。
指定した案件が存在するビジネスプロセスが階層型ビジネスプロセスの場合は,現在,案件が存在するビジネスプロセスの一つ前の上位階層のビジネスプロセスで処理したユーザに対して,差し戻しができます(ただし,そのビジネスプロセスが最上階層の場合を除きます)。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使えます。
構文

#include<bwf.h>
long HwfSendBackCase(
 BWF_useroid_t      __far *useroid,  /* ユーザオブジェクトID設定領域 (I) */
 BWF_server_t       __far *server,  /* サーバ名称設定領域 (I) */
 BWF_caseid_t       __far *caseid,  /* 案件オブジェクトID設定領域 (I) */
 BWF_backuserlist_t __far *userlist, /* ユーザ情報 (I) */
 long                     sendmode,  /* 差し戻し実行モード (I) */
 BWF_errlist_t      __far *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_backuserlist_t{
 long          BWF_bus_time;     /* 作業時間 */
 char          BWF_bus_hostname[8];  /* 処理サーバ名称 */
 BWF_bpid_t    BWF_bus_bpid;     /* ビジネスプロセス定義識別子 */
 char          BWF_bus_bpname[64];  /* ビジネスプロセス定義名称 */
 BWF_nodeno_t  BWF_bus_nodeid;    /* ノード識別子 */
 char          BWF_bus_nodename[64]; /* ノード名称 */
 BWF_useroid_t BWF_bus_useroid;    /* ユーザoid */
 BWF_useroid_t BWF_bus_username;   /* ユーザ名称 */
 char          BWF_bus_aliasname[64]; /* ユーザ別名(ユーザ日本語名称) */
 short         BWF_bus_userstatus;  /* ユーザ状態コード */
 char          BWF_bus_reserve[32];  /* 予備 */
} BWF_backuserlist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];          /* メッセージ区分 */
 long lBMsgNo;            /* メッセージ番号 */
 char sBInsWord[13];         /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は,取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
差し戻し対象となる,案件の案件オブジェクトID(HwfGetCaseなどで取得)を設定した領域を指定します。
userlist
ユーザ情報の設定領域(1要素)を指定します(1要素の構造は,HwfGetBackUserListで取得したユーザ情報と同じです)。
sendmode
差し戻し処理の実行モードを指定します。
BWF_SEND_GRACE_MODE:差し戻し要求ノードから同報,分割,回収,待合,又は複写ノードまで差し戻しできるモードです。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数発行時,userlistで指定したユーザが,該当するノードに直接関連していない場合,又は,ユーザの属するロールが該当するノードと関連していない場合,そのノードに割り付けられたロールトレーに差し戻されます。
  • 現在,案件が存在するビジネスプロセスの一つ前の上位階層のビジネスプロセスで処理したユーザに対して差し戻しをする場合,要求受付と実行は非同期に行われるため,このAPI発行後,すぐに差し戻しされない場合があります。
  • 直列型ビジネスプロセスで,差し戻し先となるビジネスプロセスが要求元と同じサーバ上に存在しない場合,案件はエラートレーに遷移します。
  • 差し戻し操作禁止オプションを指定して登録した拡張ビジネスプロセス定義に投入された案件(case_idで指定)に対してこの関数を発行すると,戻り値はエラーリターン(BWF_ERROR)となります。
(k) HwfGetConsultCaseStatus(相談した案件の回答状態取得)

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

機能
HwfRoundCaseExによって,案件を他ユーザに対して相談した場合,その案件の回答状態を取得します。
また,任意のユーザが他ユーザから案件を相談された場合,案件を相談されたユーザは,相談された以外のユーザに対して,その案件を相談できます。そのとき,最終的に相談されたユーザは,直前に相談したユーザを介さずに,直接,最初に相談したユーザに対して,案件を回答できます(詳細については,HwfAnswerCaseを参照してください)。その場合,最後に相談したユーザに対して回答はされませんが,そのユーザは最終的に自分を介さずに,相談した案件が自分より以前に相談したユーザに,回答がされたかどうかの状態を取得できます。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetConsultCaseStatus(
 BWF_useroid_t  __far  *useroid,     /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far  *server,     /* サーバ名称格納領域 (I) */
 unsigned long         checkcount,    /* 回答状態チェック案件数格納領域 (I) */
 BWF_check_consult_t  __far  *checkinf, /* 回答状態チェック案件情報取得領域 (I/O) */
 BWF_errlist_t  __far  *errlist     /* エラー情報取得領域 (O) */
);
typedef struct BWF_check_consult_t {
 BWF_caseid_t  BWF_case_oid;       /* 回答状態チェック案件  */
                     /* オブジェクトID格納領域 */
 BWF_nodeno_t  BWF_cs_current_node_id;  /* 回答状態チェック案件カレントノードID */
 unsigned long BWF_answer_status;    /* 回答状態取得領域 */
} BWF_check_consult_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];     /* メッセージ区分 */
 long lBMsgNo;       /* メッセージ番号 */
 char sBInsWord[13];    /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfStartUpWorkflowで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfStartUpWorkflowで指定,又は,取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
checkcount
checkinfに指定した,回答状態チェック案件情報の要素数を指定します。
必ず,1以上を指定してください。最大400まで指定できます。
checkinf
回答状態チェック案件情報取得領域を指定します。
必ず,checkcountに指定した要素数分以上の領域を指定してください。
回答状態チェック案件情報に取得される項目を次に示します。
項目内容
BWF_case_oid回答状態をチェックする案件の案件オブジェクトIDを指定してください。案件オブジェクトIDは,HwfGetCaseSelectDataなどによって取得できます。
BWF_cs_current_node_idBWF_case_oidに指定した案件がある(カレント)ノードIDを指定してください(カレントノードIDについては,HwfGetObjectAttributeEx,HwfGetCaseSelectDataなどで取得できます)。
BWF_answer_statusBWF_case_oidに指定した案件の回答状態が格納されます。
BWF_CONSULT_CASE:相談中
BWF_ANSWER_CASE:回答済み
BWF_NOCHECK_CASE:判定不可
(BWF_case_oidで指定した案件が,現在,他ユーザで処理中のため,しばらくしてから再度,このAPI関数を発行してください)
errlist
このAPI関数がエラーリターンした,場合にエラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • checkinf内のBWF_case_oidに指定した案件が,useroidに指定したユーザが相談した案件であるかどうかのチェックはしません(useroidに指定したユーザが相談した案件でない場合,案件の回答状態は返却しますが,その値は不定です)。
  • checkinf内のBWF_case_oidに指定した案件がない場合(次にその状態を示します),回答状態は「回答済み」となります。
 
  • useroidに指定したユーザを飛び越して回答され,次ノードへ遷移した場合
  • 指定した案件が上位案件で,分割ノード以降に遷移してGroupmax Workflow Serverに削除された場合
  • Groupmax Workflow Monitorによって,削除された場合
  • 処理終了ノードに至り,保存期限が過ぎて削除された場合
  • checkinf内のBWF_case_oidに指定した案件が,useroidに指定したユーザを飛び越して最初にその案件を相談したユーザに回答された場合,回答状態は「回答済み」となります(詳細については,HwfAnswerCaseを参照してください)。
(l) 上位案件項目リスト内項目
(凡例)
有:データが設定されていた場合,そのデータに意味があります。
無:データが設定されていた場合,そのデータに意味はありません。
項目内容案件種別別意味有無
ルート単独下位
BWF_cs_oid案件オブジェクトIDが設定されます。
BWF_cs_case_nameBWF_cs_oidに対応する案件の案件名称が設定されます。
BWF_cs_case_alias_nameBWF_cs_oidに対応する案件が存在するノード名が設定されます。また,ビジネスプロセス定義で,BWF_cs_oidに対応する案件が存在するノードに作業案件名が設定されている場合は,作業案件名が設定されます。
BWF_cs_transaction_idBWF_cs_oidに対応する案件のトランザクションIDが設定されます。
BWF_cs_user_keyHwfCreateCase発行時に指定した,案件識別子フォーマット(ワークID)が設定されます。
BWF_cs_create_nameBWF_cs_oidに対応する案件を作成したユーザのユーザ名称が設定されます。ルート案件に関しては,Groupmax Workflow Serverを起動したユーザのユーザ名称が設定されます。
BWF_cs_create_user_oidBWF_cs_oidに対応する案件を作成したユーザのユーザオブジェクトIDが設定されます。
BWF_cs_create_timeBWF_cs_oidに対応する案件を作成した日時が設定されます(日時は,YYYYMMDDhhmmss形式となります)。
BWF_cs_arrival_timeBWF_cs_oidに対応する案件がBWF_cs_current_node_idに到着した日時が設定されます(日時は,YYYYMMDDhhmmss形式となります)。
BWF_cs_process_limit_timeHwfCreateCase発行時に指定した処理期限が設定されます(期限は,YYYYMMDDhhmmss形式となります)。
BWF_cs_bp_nameBWF_cs_bp_oidに対応するビジネスプロセス定義名称が設定されます。
BWF_cs_bp_oidBWF_cs_oidに対応する案件を投入した,ビジネスプロセスのビジネスプロセス定義オブジェクトIDが設定されます。
BWF_cs_bp_version_numberBWF_cs_oidに対応する案件を投入した,ビジネスプロセスのバージョン番号が設定されます。
BWF_cs_memo_object_countBWF_cs_oidに対応する案件と,その案件下に存在する文書すべてに貼り付けられたメモ数が設定されます。
BWF_cs_report_object_countBWF_cs_oidに対応する案件に格納されている文書の数が設定されます。なお,BWF_cs_case_class_kind_codeがルート案件の場合は,何も設定されません。
BWF_cs_tray_kind_codeBWF_cs_oidに対応する案件が存在するトレーの種別が設定されます。
"user":ユーザトレー
"role":ロールトレー
すべてNULL文字:制御ノード
"mang":マネージャトレー
"send":サーバ間転送トレー
BWF_cs_user_oidBWF_cs_oidに対応する案件がユーザトレー上に存在する場合,そのトレーに対応するユーザのユーザオブジェクトIDが設定されます。なお,ユーザがHwfGetCaseFromRoleを発行してロールから取り出した案件には,何も設定されていません。
BWF_cs_role_oidBWF_cs_oidに対応する案件が,存在するロールのロールオブジェクトIDが設定されます。遷移先がユーザ,又は制御ノードの場合は,すべてNULL文字が設定されます。
BWF_cs_work_oidBWF_cs_oidに対応する案件が関連するワークのワークオブジェクトIDが設定されます。
BWF_cs_case_class_kind_codeBWF_cs_oidに対応する案件の階層種別が設定されます。
"sys△":ルート案件
"gen△":一般案件(単独/下位案件)
注 △は空白を示します。
BWF_cs_up_case_oid上位にルート案件が存在する場合は,ルート案件の案件オブジェクトIDが設定されます(ルート案件,又は単独の一般案件の場合は,すべてNULL文字が設定されます)。
BWF_cs_down_case_countルート案件の場合,下位に存在する一般(下位)案件の数が設定されます。
BWF_cs_status_code_1BWF_cs_oidに対応する案件の処理状態コードが設定されます。
"move":ノード間遷移中
"wait":ユーザ処理待ち
"proc":ユーザ処理中
"resv":ユーザ処理保留中
"nop△":案件未投入状態
"movw":待合ノードでの同一案件識別子フォーマット(ワークID)案件の待ち合わせ状態
"movc":同報案件の回収中
"send":他サーバへ送信中
注 △は空白を示します。
BWF_cs_status_code_2BWF_cs_oidに対応する案件の遷移状態コードが設定されます。
"act△":動作可能状態
"can△":取消予約状態
"sup△":動作中断状態
"err△":エラー発生状態
"sink":終了状態
注 △は空白を示します。
BWF_cs_current_node_idBWF_cs_oidに対応する案件が,BWF_cs_bp_oidに示すビジネスプロセス定義上のどのノードに存在しているかが,ノードIDで設定されます。
BWF_cs_priority_codeHwfCreateCase発行時に指定した優先度が設定されます。
"com△":普通
"urg△":至急
注 △は空白を示します。
BWF_cs_process_kind_codeBWF_cs_oidに対応する案件が,BWF_cs_current_node_idに示すノードに遷移するにあたって,前ノードでどのような状態で処理されたかを示します。
"ord△":通常処理
"exc△":例外処理(相談)
"exca":例外処理(相談途中での回答)
"exa△":例外処理(回答)
"exsb":例外処理(差し戻し)
"extb":例外処理(引き戻し)
通常処理
ビジネスプロセス定義で定義された,処理の流れどおりに遷移されてきたことを示します。
例外処理
ビジネスプロセス定義で定義された,処理の流れ以外の流れで遷移してきたことを示します。
注 △は空白を示します。
BWF_cs_attr_char_1ユーザ任意の文字列データが設定できる文字型ユーザ属性で,HwfCreateCase,HwfSetCase,又はHwfSetCaseByUserDefNameで指定された情報が設定されます。文字列データは,最大31バイトまで設定され,NULL文字で終端します(初期値としては,NULL文字だけが設定されます)。
BWF_cs_attr_char_2BWF_cs_attr_char_1と同様です。
BWF_cs_attr_char_3BWF_cs_attr_char_1と同様です。
BWF_cs_attr_char_4BWF_cs_attr_char_1と同様です。
BWF_cs_attr_char_5BWF_cs_attr_char_1と同様です。
BWF_cs_attr_int_1ユーザ任意の整数データが設定できる整数型ユーザ属性で,HwfCreateCase,HwfSetCase,又はHwfSetCaseByUserDefNameで指定された情報が設定されます。整数データは,-2147483648​~2147483647​の範囲で設定されます(初期値としては,0が設定されます)。
BWF_cs_attr_int_2BWF_cs_attr_int_1と同様です。
BWF_cs_attr_int_3BWF_cs_attr_int_1と同様です。
BWF_cs_attr_int_4BWF_cs_attr_int_1と同様です。
BWF_cs_attr_int_5BWF_cs_attr_int_1と同様です。
BWF_cs_attr_time_1ユーザ任意の日時データが,設定できる日時型ユーザ属性で,HwfCreateCase,HwfSetCase,又はHwfSetCaseByUserDefNameで指定された情報が設定されます(日時は,YYYYMMDDhhmmss形式となり,初期値として"19700101090000​"が設定されています)。
BWF_cs_attr_time_2BWF_cs_attr_time_1と同様です。
BWF_cs_attr_time_3BWF_cs_attr_time_1と同様です。
BWF_cs_attr_time_4BWF_cs_attr_time_1と同様です。
BWF_cs_attr_time_5BWF_cs_attr_time_1と同様です。
BWF_cs_exattr_char_countBWF_cs_oidに対応する案件に設定できる文字型ユーザ属性の六つ目以降の数が設定されます。
BWF_cs_exattr_int_countBWF_cs_oidに対応する案件に設定できる整数型ユーザ属性の六つ目以降の数が設定されます。
BWF_cs_exattr_time_countBWF_cs_oidに対応する案件に設定できる日時型ユーザ属性の六つ目以降の数が設定されます。
BWF_cs_user_statusBWF_cs_oidに対応する案件に,ユーザが任意に設定する状態コードが設定されます。
BWF_cs_broadcast_statusBWF_cs_oidに対応する案件が同報中か,通常処理中のどちらかを示します。
すべてNULL文字:通常処理
"bdc△":同報中
"movc":回収待ち
注 △は空白を示します。
BWF_cs_except_req_user_oidBWF_cs_oidに対応する案件に対して,直前に相談/差し戻し/回答したユーザのユーザオブジェクトIDが設定されます。
BWF_cs_titleBWF_cs_work_oidに対応する,ワークに設定された案件タイトルが設定されます(タイトルはHwfPutCaseOnBpなどで案件の投入時に指定した場合だけ設定されます)。

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

(a) HwfGetExAttrValue(案件のユーザ属性値取得)

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

機能
Groupmax Workflow Definerでの案件のユーザ属性定義で指定した文字,整数,及び日時の各々の型の六つ目以降のユーザ属性値(以降,このAPI関数で記述しているユーザ属性はすべてこれに該当します)を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetExAttrValue(
 BWF_useroid_t    __far *useroid,   /* ユーザオブジェクトID設定領域 (I) */
 BWF_server_t     __far *server,   /* サーバ名称設定領域 (I) */
 BWF_caseid_t     __far *caseid,   /* 案件オブジェクトID設定領域 (I) */
 long                   exlistcharn, /* 文字列型属性値取得要求個数 (I) */
 BWF_charexlist_t __far *exlistchar, /* 文字列型属性値取得領域 (O) */
 long             __far *countchar,  /* 文字列型属性値取得個数 (O) */
 long                   exlistintn,  /* 整数型属性値の取得要求個数 (I) */
 BWF_intexlist_t  __far *exlistint,  /* 整数型属性値取得領域 (O) */
 long             __far *countint,  /* 整数型属性値取得個数 (O) */
 long                   exlisttimen, /* 日時型属性値取得要求個数 (I) */
 BWF_timeexlist_t __far *exlisttime, /* 日時型属性値取得領域 (O) */
 long             __far *counttime,  /* 日時型属性値取得個数 (O) */
 BWF_errlist_t    __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_charexlist_t{
 char BWF_exattrchar[32];       /* 文字列型ユーザ属性値 */
} BWF_charexlist_t;
typedef struct BWF_intexlist_t{
 long BWF_exattrint;         /* 整数型ユーザ属性値 */
} BWF_intexlist_t;
typedef struct BWF_timeexlist_t{
 BWF_time_t BWF_exattrtime;      /* 日付型ユーザ属性値 */
} BWF_timeexlist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
ユーザ属性を取得する,案件のオブジェクトIDを指定します。案件オブジェクトIDは,HwfGetCaseなどで取得できます。
exlistcharn
取得する文字列型ユーザ属性数を指定します。
指定する取得個数の限界値は,HwfGetObjectAttribute,HwfGetCaseなどで取得できます。該当項目については,HwfGetCaseのtcaselistを参照してください。
取得要求個数が限界値を超えた場合,限界値までの取得になります。
取得要求個数は1以上を指定してください。0を指定した場合,取得要求はないものとし,exlistcharとcountcharは無視します。
exlistchar
文字列型ユーザ属性取得領域を指定してください。この領域には,(exlistcharn)×(exlistcharのバイト数)以上を指定してください。
文字列型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_exattrchar文字列型のユーザ属性値が設定されます。ユーザ属性値は終端にNULL文字を付けた32バイト以内の文字列が設定されます。
countchar
取得した文字列型ユーザ属性値数を取得する領域を指定します。
exlistintn
取得する整数型ユーザ属性数を指定します。
指定する取得個数の限界値は,HwfGetObjectAttribute,HwfGetCaseなどで取得できます。該当項目については,HwfGetCaseのtcaselistを参照してください。
取得要求個数が限界値を超えた場合,限界値までの取得になります。
取得要求個数は1以上を指定してください。0を指定した場合,取得要求はないものとし,exlistintとcountintは無視します。
exlistint
整数型ユーザ属性取得領域を指定します。
この領域には,(exlistintn)×(exlistintのバイト数)以上を指定してください。
整数型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_exattrint整数型のユーザ属性値が設定されます。
countint
取得した整数型ユーザ属性値数を取得する領域を指定します。
exlisttimen
取得する日時型ユーザ属性数を指定します。
指定する取得個数の限界値は,HwfGetObjectAttribute,HwfGetCaseなどで取得できます。該当項目については,HwfGetCaseのtcaselistを参照してください。取得要求個数が限界値を超えた場合,限界値までの取得になります。
取得要求個数は1以上を指定してください。0を指定した場合,取得要求はないものとし,exlisttimeとcounttimeは無視します。
exlisttime
日時型ユーザ属性取得領域を指定します。この領域には,(exlisttimen)×(exlisttimeのバイト数)以上を指定してください。日時型ユーザ属性取得領域内の項目を次に示します。
項目内容
BWF_exattrtime日時型のユーザ属性値が設定されます(YYYYMMDDhhmmss形式となります)。
counttime
取得した日時型ユーザ属性値数を取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
(注)exlistcharn,exlistintn,exlisttimenが,併せて700件を超える指定はできません。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数では,Groupmax Workflow Definerでの案件のユーザ属性定義で指定した文字,整数,及び日時の各々の型の六つ目以降のユーザ属性から指定個数分の属性値を取得します。
  • 取得したユーザ属性にデータが未設定の場合は,初期値が返ります。
  • 各ユーザ属性の初期値を次に示します。
    属性種別初期値
    文字列型char32バイトすべてNULL文字
    整数型long0
    日時型BWF_time_t"19700101090000​"
  • このAPI関数の戻り値がエラーリターン(BWF_ERROR)で,エラー情報取得領域内のメッセージ番号にBWE_OUT_RANGEが設定されていた場合,各ユーザ属性の取得個数には取得可能個数を設定します。

(10) 文書,メモ操作AP関数(互換性)

(a) HwfSetObjectInstance(文書の登録)

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

機能
文書を登録します。
文書として,次に示す形態のものが登録できます。
  • ファイルとして存在するもの
  • メモリ上に存在するもの
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfSetObjectInstance(
 BWF_useroid_t __far  *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far  *server,    /* サーバ名称格納領域 (I) */
 BWF_nodeno_t  __far  *nodeno,    /* 登録ノードID格納領域 (I) */
 BWF_doctype_t __far  *doctype,    /* 文書属性情報格納領域 (I) */
 BWF_doclist_t __far  *docfile,    /* 登録文書パス,ファイル名称格納領域 (I) */
 long                 memsize,    /* 文書実体サイズ (I) */
 void          __huge *docmem,    /* 登録文書格納領域 (I) */
 BWF_oid_t     __far  *oid,      /* 登録文書オブジェクトID取得領域 (O) */
 BWF_errlist_t __far  *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_doctype_t{
 char          sBFileName[16];    /* ファイル名称 */
 char          sBDocType[4];     /* 文書種別 */
 long          lBPelsx;        /* 解像度 x方向 */
 long          lBPelsy;        /* 解像度 y方向 */
 char          chBCompression;    /* 圧縮方式 */
 unsigned long dwBBitCount;      /* 1ピクセル当たりのビット数 */
 long          lBWidth;        /* 画像データの横ピクセル数 */
 long          lBHeight;       /* 画像データの縦ピクセル数 */
 char          sBDocCmnt[BWF_CMNT_SIZE];   /* 文書実体コメント */
} BWF_doctype_t;
typedef struct BWF_doclist_t{
 char sBDoclist[512];         /* 登録文書パス名 */
} BWF_doclist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];          /* メッセージ区分 */
 long lBMsgNo;            /* メッセージ番号 */
 char sBInsWord[13];         /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
nodeno
ビジネスプロセスに投入する案件に追加する文書を登録する場合は,HwfGetCaseFormなどで取得したノードIDを格納した領域を指定します。
遷移してきた案件に追加する文書を登録する場合は,HwfGetObjectAttributeで案件の属性を取得し,カレントノードIDを格納した領域を指定します。
doctype
登録する文書に対する属性情報を設定した領域を指定します。
文書属性情報内の設定項目については,文書属性情報内項目を参照してください。
docfile
ファイルとして存在する文書を登録する場合,文書が格納されているドライブ名,ファイルのパス,及びファイル名称を格納した領域を指定します。
ドライブ名,ファイルのパス,及びファイル名称は,終端にNULL文字を付けた128バイト以内で指定してください。
メモリ上に存在する文書を登録する場合は,NULLポインタを指定してください。
memsize
メモリ上に存在する文書を登録する場合は,その文書データ長を指定します。
ファイルとして存在する文書を登録する場合,0を指定してください。
docmem
メモリ上に存在する文書を登録する場合に,登録する文書が格納されている領域を指定します。
ファイルとして存在する文書を登録する場合,NULLポインタを指定してください。
oid
登録した文書に対する文書オブジェクトIDを取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(b) HwfGetObjectInstance(案件内の文書取得)

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

機能
案件内に格納されている文書を読み出します。
そのとき,文書に貼り付いているメモの属性も取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long  HwfGetObjectInstance(
 BWF_useroid_t  __far  *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far  *server,     /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far  *caseid,     /* 案件オブジェクトID格納領域 (I) */
 long                  number,     /* 要求文書番号 (I) */
 long                  readmode,    /* 文書取得モード格納領域 (I) */
 BWF_doctype_t  __far  *doctype,     * 文書属性情報取得領域 (O) */
 unsigned long  __far  *docsize,    /* 文書サイズ取得領域 (O) */
 void           __huge **doc      /* 文書取得領域ポインタ格納領域 (O) */
 long                  memotypen,    /* メモ情報取得領域要素数 (I) */
 BWF_memotype_t __far  *memotype,    /* メモ情報取得領域 (O) */
 long           __far  *memocount,   /* メモ情報取得数 (O) */
 long           __far  *allmemocount,  /* メモ情報取得可能数 (O) */
 BWF_oid_t      __far  *oid,      /* 要求文書オブジェクトID取得領域 (O) */
 BWF_errlist_t  __far  *errlist     /* エラー情報取得領域 (O) */
);
typedef struct BWF_doctype_t{
 char          sBFileName[16];     /* ファイル名称 */
 char          sBDocType[4];      /* 文書種別 */
 long          lBPelsx;         /* 解像度 x方向 */
 long          lBPelsy;         /* 解像度 y方向 */
 char          chBCompression;     /* 圧縮方式 */
 unsigned long dwBBitCount;       /* 1ピクセル当たりのビット数  */
 long          lBWidth;         /* 画像データの横ピクセル数 */
 long          lBHeight;        /* 画像データの縦ピクセル数 */
 char          sBDocCmnt[BWF_CMNT_SIZE];/* 文書実体コメント */
} BWF_doctype_t;
typedef struct BWF_memotype_t{
 char          sBFileName[16];     /* ファイル名称 */
 char          sBMemoType[4];      /* メモ種別 */
 long          lBMemoX;         /* メモ位置 x */
 long          lBMemoY;         * メモ位置 y */
 long          lBPelsx;         /* 解像度 x */
 long          lBPelsy;         /* 解像度 y */
 char          chBCompression;     /* 圧縮方式 */
 unsigned long dwBBitCount;       /* 1ピクセル当たりのビット数 */
 long          lBWidth;         /* 原画データの横ピクセル数 */
 long          lBHeight;        /* 原画データの縦ピクセル数 */
 char          sBMarkfileName[BWF_MARK_SIZE]; /* 印章情報ファイル名称 */
 BWF_oid_t     sBObjectID;          /* メモオブジェクトID */
 char          sBMemoCmnt[BWF_CMNT_SIZE];   /* メモコメント */
} BWF_memotype_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6]; /* メッセージ区分 */
 long lBMsgNo;   /* メッセージ番号 */
 char sBInsWord[13];/* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
HwfGetCaseなどで取得した,読み出す文書が格納されている案件の案件オブジェクトIDを格納した領域を指定します。
number
読み出す文書の案件内での番号(1~n)を指定します。
案件内の文書数については,HwfGetObjectAttribute,HwfGetCaseなどで取得した情報を参照してください。
readmode
文書を読み出すときのモードを指定します。指定できるモードを次に示します。
BWF_NORMAL_READ:通常の読み込みのモード
BWF_REFER_READ:参照用読み込みのモード
デフォルト値はBWF_NORMAL_READです。また,参照用読み込みで読み込んだ文書は,削除・更新できません(なお,文書属性情報だけを取得するモードを指定した場合は,文書取得領域ポインタ格納領域にポインタが設定されないことを除いて,通常の読み込みのモードを指定した場合と同等になります)。
doctype
読み出す文書の属性情報を取得する領域を指定します。
文書属性情報内の設定項目については,文書属性情報内項目を参照してください。
docsize
読み出した文書のサイズを取得する領域を指定します。
doc
読み出した文書格納領域のポインタを取得する領域を指定します。
memotypen
メモ情報を取得する,読み出す文書に貼り付けられたメモの要素数を指定します。最大128まで指定できます。
memotype
読み出す文書に貼り付けられたメモの属性情報を取得する領域を指定します。
なお,この領域のサイズはmemotypenで指定した要素数分のサイズを必ず確保して指定してください。また,このAPI関数がエラーリターンした場合は,この領域の値は不正となっているので使用できません。
メモ属性情報内の設定項目については,メモ属性情報内項目を参照してください。
memocount
読み出す文書に貼り付けられた,メモの属性情報を取得した件数を取得する領域を指定します。また,このAPI関数がエラーリターンした場合は,この領域の値は不正となっているので使用できません。
allmemocount
読み出す文書に貼り付けられた,メモの総数を取得する領域を指定します。
oid
読み出した文書の文書オブジェクトIDを取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidに指定した案件のメモ数(案件とその案件下に存在する文書すべてに貼り付けられたメモの総数です。HwfGetCase,HwfGetObjectAttributeなどで取得できます)が129以上のとき,numberに指定した文書に貼り付いたメモのメモ属性情報をすべて取得できない場合があります。
  • memotypen<allmemocountの場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります(その場合,allmemocountで取得した値をmemotypenに設定し,memotypeにmemotypenで指定した要素数分の領域を指定して,このAPI関数を再度発行してください。又は,常にmemotypenに128を,memotypeにmemotypenで指定した要素数分の領域を指定して,このAPI関数を発行してください)。
(c) HwfGetObjectInstanceToFile(システム指定ファイルへの案件内の文書取得)

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

機能
案件内に格納されている文書を,このシステムが指定したファイルに読み出します。
そのとき,文書に貼り付いているメモの属性も取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long  HwfGetObjectInstanceToFile(
 BWF_useroid_t  __far  *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far  *server,    /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far  *caseid,    /* 案件オブジェクトID格納領域 (I) */
 long                  number,     /* 要求文書番号 (I) */
 BWF_doctype_t  __far  *doctype,    /* 文書属性情報取得領域 (O) */
 BWF_doclist_t  __far  *docfile,    /* 取得文書パス,ファイル名称格納領域 (O) */
 long                  memotypen,   /* メモ情報取得領域要素数 (I) */
 BWF_memotype_t __far  *memotype,   /* メモ情報取得領域 (O) */
 long           __far  *memocount,   /* メモ情報取得数 (O) */
 long           __far  *allmemocount, /* メモ情報取得可能数 (O) */
 BWF_oid_t      __far  *oid,      /* 要求文書オブジェクトID取得領域 (O) */
 BWF_errlist_t  __far  *errlist    /* エラー情報取得領域 (O) */
);
typedef struct BWF_doctype_t{
 char          sBFileName[16];     /* ファイル名称 */
 char          sBDocType[4];      /* 文書種別 */
 long          lBPelsx;        /* 解像度 x方向 */
 long          lBPelsy;        /* 解像度 y方向 */
 char          chBCompression;     /* 圧縮方式 */
 unsigned long dwBBitCount;      /* 1ピクセル当たりのビット数 */
 long          lBWidth;        /* 画像データの横ピクセル数 */
 long          lBHeight;        /* 画像データの縦ピクセル数 */
 char          sBDocCmnt[BWF_CMNT_SIZE];    /* 文書実体コメント */
} BWF_doctype_t;
typedef struct BWF_memotype_t{
 char          sBFileName[16]; /* ファイル名称 */
 char          sBMemoType[4]; /* メモ種別 */
 long          lBMemoX;    /* メモ位置 x */
 long          lBMemoY;    /* メモ位置 y */
 long          lBPelsx;    /* 解像度 x */
 long          lBPelsy;    /* 解像度 y */
 char          chBCompression; /* 圧縮方式 */
 unsigned long dwBBitCount;  /* 1ピクセル当たりのビット数 */
 long          lBWidth;    /* 原画データの横ピクセル数 */
 long          lBHeight;    /* 原画データの縦ピクセル数 */
 char          sBMarkfileName[BWF_MARK_SIZE];   /* 印章情報ファイル名称 */
 BWF_oid_t     sBObjectID;         /* メモオブジェクトID */
 char          sBMemoCmnt[BWF_CMNT_SIZE]; /* メモコメント */
} BWF_memotype_t;
typedef struct BWF_doclist_t{
 char sBDoclist[512];   /* 取得文書パス名 */
} BWF_doclist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];    /* メッセージ区分 */
 long lBMsgNo;      /* メッセージ番号 */
 char sBInsWord[13];   /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
HwfGetCaseなどで取得した読み出す文書が格納されている案件の案件オブジェクトIDを格納した領域を指定します。
number
読み出す文書の案件内での番号(1~n)を指定します。
案件内の文書数については,HwfGetObjectAttribute,HwfGetCaseなどで取得した情報を参照してください。
doctype
読み出す文書の属性情報を取得する領域を指定します。
文書属性情報内の設定項目については,文書属性情報内項目を参照してください。
docfile
システムが読み出した文書が格納されたファイルのパス,ファイル名を取得する領域を指定します。
memotypen
読み出す文書に貼り付けられたメモの属性情報を取得する要素数を指定します。最大128まで指定できます。
memotype
読み出す文書に貼り付けられたメモの属性情報を取得する領域を指定します。
なお,この領域のサイズはmemotypenで指定した要素数分のサイズを必ず確保して指定してください。また,このAPI関数がエラーリターンした場合は,この領域の値は不正となっているので使用できません。
メモ属性情報内の設定項目については,メモ属性情報内項目を参照してください。
memocount
読み出す文書に貼り付けられた,メモの属性情報を取得した件数を取得する領域を指定します。また,このAPI関数がエラーリターンした場合は,この領域の値は不正となっているので使用できません。
allmemocount
読み出す文書に貼り付けられた,メモの総数を取得する領域を指定します。
oid
読み出した文書の文書オブジェクトIDを取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 「同報中」の案件,及びその下位案件の既存の文書を取得する場合は,HwfActCaseWithDocLockで文書に対しての排他が成功した場合だけ,このAPI関数を発行してください(HwfActCaseWithDocLockで,文書に対しての排他ができなくても文書を取得する場合は,HwfGetObjectInstanceのreadmodeにBWF_REFER_READを指定して文書を取得してください)。
  • 文書を取得後,次に示すAPI関数を発行すると,取得したパス,ファイル名のファイルは削除されるので注意してください。
  • HwfPauseCase
  • HwfDeactCase
  • HwfGoCase
  • HwfRoundCase
  • HwfAnswerCase
  • HwfSendBackCase
  • HwfLogoutWorkflow
  • caseidに指定した案件のメモ数(案件とその案件下に存在する文書すべてに貼り付けられたメモの総数。HwfGetCase,HwfGetObjectAttributeなどで取得できます。)が129以上のとき,numberに指定した文書に貼り付いたメモのメモ属性情報をすべて取得できない場合があります。
  • memotypen<allmemocountの場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります(この場合,allmemocountで取得した値をmemotypenに設定し,memotypeにmemotypenで指定した要素数分の領域を指定して,このAPI関数を再度発行してください。又は,常にmemotypenに128を,memotypeにmemotypenで指定した要素数分の領域を指定して,このAPI関数を発行してください)。
(d) HwfDeleteObjectInstance(案件内の文書削除)

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

機能
案件内に格納されている文書を削除します。
そのとき,文書に貼り付いているメモも削除します。また,文書を削除する場合,削除する文書を事前にHwfGetObjectInstance,又はHwfGetObjectInstanceToFileを発行して読み出しておく必要があります。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfDeleteObjectInstance(
 BWF_useroid_t __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t  __far *caseid,  /* 案件オブジェクトID格納領域 (I) */
 BWF_oid_t     __far *oid,    /* 文書オブジェクト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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
HwfGetCaseなどで取得した,削除する文書が格納されている案件の案件オブジェクトIDを格納した領域を指定します。
oid
HwfGetObjectInstance,又はHwfGetObjectInstanceToFileで取得した,削除する文書の文書オブジェクトIDを格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 終了処理ノードに至った案件に格納された文書を削除しようとした場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(e) HwfUpdateObjectInstance(案件内の文書更新)

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

機能
案件内に格納されている文書を更新します。
また,文書を更新する場合,更新する文書を事前にHwfGetObjectInstance,又はHwfGetObjectInstanceToFileを発行して読み出しておく必要があります。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfUpdateObjectInstance(
 BWF_useroid_t __far  *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far  *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t  __far  *caseid,  /* 案件オブジェクトID格納領域 (I) */
 BWF_oid_t     __far  *oid,    /* 文書オブジェクトID格納領域 (I) */
 BWF_doclist_t __far  *docfile,  /* 登録文書パス,ファイル名称格納領域 (I) */
 void          __huge *docmem,  /* 更新文書格納領域 (I) */
 long                 memsize,  /* 更新文書実体サイズ (I) */
 BWF_errlist_t __far  *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_doclist_t{
 char sBDoclist[512];  /* 登録文書パス名 */
} BWF_doclist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];   /* メッセージ区分 */
 long lBMsgNo;     /* メッセージ番号 */
 char sBInsWord[13];  /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
HwfGetCaseなどで取得した,更新する文書が格納されている案件の案件オブジェクトIDを格納した領域を指定します。
oid
HwfGetObjectInstance,又はHwfGetObjectInstanceToFileで取得した,更新する文書の文書オブジェクトIDを格納した領域を指定します。
docfile
更新する文書がファイルとして存在する場合,文書が格納されているドライブ名,ファイルのパス,及びファイル名称を格納した領域を指定します。
ドライブ名,ファイルのパス,及びファイル名称は,終端にNULL文字を付けた128バイト以内で指定してください。
更新する文書がメモリ上に存在する場合は,NULLポインタを指定してください。
docmem
更新する文書がメモリ上に存在する場合は,更新する文書が格納されている領域を指定します。
更新する文書がファイルとして存在する場合,NULLポインタを指定してください。
memsize
更新する文書がメモリ上に存在する場合は,文書の実体サイズを指定します。
更新する文書がファイルとして存在する場合,0を指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(f) HwfSetObjectOnCase(案件への文書格納)

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

機能
登録した文書を案件に格納します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfSetObjectOnCase(
 BWF_useroid_t __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,  /* サーバ名称設定領域 (I) */
 BWF_caseid_t  __far *caseid,  /* 案件オブジェクトID格納領域 (I) */
 long                reqmode,  /* 文書格納モード (I) */
 long                addpage,  /* 格納文書数 (I) */
 long                oidlistn,  /* 文書オブジェクトID数 (I) */
 BWF_oidlist_t __far *oidlist,  /* 文書オブジェクト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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
文書を格納する案件の案件オブジェクトID(HwfCreateCaseなどで取得)を格納した領域を指定します。
reqmode
文書格納モードを指定します。
BWF_ADD_FIRST:案件に格納されている文書の先頭に格納します。
BWF_ADD_LAST:案件に格納されている文書の最後尾に格納します。
BWF_ADD_PAGE:案件内のaddpageで指定した文書の前に格納します。
addpage
reqmodeの指定がBWF_ADD_PAGEの場合に,どの文書の前に格納するかを文書番号で指定します。
oidlistn
oidlistに格納した文書オブジェクトIDの数を指定します。
oidlist
案件に格納する文書の文書オブジェクトID(HwfSetObjectInstanceで取得)を格納した配列の領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidで指定した案件がビジネスプロセスへの投入後,又は処理中の状態でなかった場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • caseidで指定した案件が存在しない,又は上位案件であった場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(g) HwfPutMemo(メモの貼り付け)

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

機能
次に示すものに対してメモを貼り付けます。
  • ビジネスプロセスへ投入前の案件
  • ビジネスプロセスへ投入前の案件に格納されている文書
  • ユーザトレー内に存在する案件
  • ユーザトレー内に存在する案件に格納されている文書
ユーザトレー内に存在する案件に対してメモを貼り付ける場合,案件に対してHwfActCase,又はHwfActCaseWithDocLockを発行しておく必要があります。
ユーザトレー内に存在する案件に格納されている文書にメモを貼り付ける場合,文書に対してHwfGetObjectInstance,又はHwfGetObjectInstanceToFileを発行しておく必要があります。
ビジネスプロセスに投入前の案件に対してメモを貼り付ける場合,HwfCreateCaseを発行して,案件を生成しておく必要があります。
ビジネスプロセスに投入前の案件に存在する文書に対してメモを貼り付ける場合,HwfSetObjectOnCaseを発行して,文書をビジネスプロセスに投入前の案件に格納しておく必要があります。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfPutMemo(
 BWF_useroid_t  __far  *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far  *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far  *caseid,  /* 案件オブジェクトID格納領域 (I) */
 BWF_oid_t      __far  *oid,    /* 文書オブジェクトID格納領域 (I) */
 BWF_memotype_t __far  *memotype, /* メモ属性情報格納領域 (I) */
 BWF_doclist_t  __far  *memolist, /* メモ情報パス,ファイル名称格納領域 (I) */
 long                  size,    /* メモサイズ格納領域 (I) */
 void           __huge *memo,   /* メモ実体格納領域 (I) */
 BWF_oid_t      __far  *memooid,  /* メモオブジェクトID格納領域 (O) */
 BWF_errlist_t  __far  *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_memotype_t{
 char          sBFileName[16];   /* ファイル名称 */
 char          sBMemoType[4];   /* メモ種別 */
 long          lBMemoX;  /    * メモ位置 x */
 long          lBMemoY;      /* メモ位置 y */
 long          lBPelsx;      /* 解像度 x方向 */
 long          lBPelsy;      /* 解像度 y方向 */
 char          chBCompression;   /* 圧縮方式 */
 unsigned long dwBBitCount;    /* 1ピクセル当たりのビット数 */
 long          lBWidth;      /* 画像データの横ピクセル数 */
 long          lBHeight;      /* 画像データの縦ピクセル数 */
 char          sBMarkfileName[BWF_MARK_SIZE];  /* 印章情報格納ファイル名称 */
 BWF_oid_t     memooid,      /* メモオブジェクトID */
 char          sBMemoCmnt[BWF_CMNT_SIZE];    /* メモコメント */
} BWF_memotype_t;
typedef struct BWF_doclist_t{
 char sBDoclist[512];  /* 登録文書パス名 */
} BWF_doclist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];   /* メッセージ区分 */
 long lBMsgNo;     /* メッセージ番号 */
 char sBInsWord[13];  /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
HwfGetCaseなどで取得した,メモを貼り付ける文書が格納されている案件の案件オブジェクトIDを格納した領域を指定します。
oid
HwfGetObjectInstance,HwfGetObjectInstanceToFileで取得した,メモを貼り付ける文書の文書オブジェクトIDを格納している領域を指定します。
案件に対してメモを貼り付ける場合は,NULLポインタを指定します。
memotype
貼り付けるメモの属性情報を格納した領域を指定します。
メモ属性情報内の設定項目については,メモ属性情報内項目を参照してください。
memolist
貼り付けるメモが格納されているドライブ名,ファイルのパス,及びファイル名称を格納した領域を指定します。ただし,メモ種別がBWF_CMNT_DATA,BWF_IMAG_DATA,BWF_DATA_DATAの場合,指定した値は無効となります。ドライブ名,ファイルのパス,及びファイル名称は,終端にNULL文字を付けた128バイト以内で指定してください。
貼り付けるメモがメモリ上に存在する場合は,NULLポインタを指定してください。
size
貼り付けるメモがメモリ上に存在する場合は,メモの実体サイズを指定します。ファイルとして存在するメモを貼り付ける場合,0を指定してください。
ただし,メモ種別がBWF_CMNT_DATA,又はBWF_MARK_DATAの場合,指定した値は無効となります。
また,メモ種別がBWF_DATA_DATAの場合は,1~4096バイト以内のサイズを指定してください。
memo
メモ実体が格納されている領域を指定します。
ファイルとして存在するメモを貼り付ける場合,NULLポインタを指定してください。ただし,メモ種別がBWF_CMNT_DATA,又はBWF_MARK_DATAの場合,指定した値は無効となります。
また,メモ種別がBWF_DATA_DATAの場合は,終端にNULL文字を付けた4096バイト以内の文字列で指定してください。
memooid
貼り付けたメモに対するメモオブジェクトIDを取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidで指定した案件が上位案件の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • このAPI関数は,文書へのメモの貼り付けと案件へのメモの貼り付けをサポートしていますが,メモの種類によって指定するパラメタが異なりますので,パラメタの指定には十分に注意してください。
  • 案件に対して,sBMemoTypeがBWF_MARK_DATAのメモを貼り付けることはできません。
  • メモ種別がBWF_DATA_DATAの場合,memoに指定した領域にsizeで指定した範囲にバイナリデータが存在した場合は,このAPI関数,及びHwfGetMemo,HwfGetMemoToFileの結果は保証しません。
(h) HwfGetMemo(メモの読み出し)

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

機能
案件,又は案件内に格納されている文書に貼り付けられたメモの読み出しと,対応する属性情報を取得します。
案件に貼り付けられたメモを読み出す場合,案件に対して事前にHwfActCase,又はHwfActCaseWithDocLockを発行しておく必要があります。案件内に格納されている文書に貼り付けられたメモを読み出す場合,HwfGetObjectInstance,又はHwfGetObjectInstanceToFileを発行して文書を事前に読み出しておく必要があります。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetMemo(
 BWF_useroid_t __far   *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far   *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t  __far   *caseid,  /* 案件オブジェクトID格納領域 (I) */
 BWF_oid_t     __far   *oid,    /* 文書オブジェクトID格納領域 (I) */
 BWF_oid_t     __far   *memooid,  /* メモオブジェクトID格納領域 (I) */
 long                  readmode,  /* メモ取得モード格納領域 (I) */
 BWF_memotype_t __far  *memotype, /* メモ属性情報格納領域 (O) */
 unsigned long  __far  *memosize, /* メモ実体サイズ取得領域 (O) */
 void           __huge **memo,   /* メモ実体取得領域ポインタ格納領域 (O) */
 BWF_errlist_t  __far  *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_memotype_t{
 char          sBFileName[16];  /* ファイル名称 */
 char          sBMemoType[4];  /* メモ種別 */
 long          lBMemoX;     /* メモ位置 x */
 long          lBMemoY;     /* メモ位置 y */
 long          lBPelsx;     /* 解像度 x方向 */
 long          lBPelsy;     /* 解像度 y方向 */
 char          chBCompression;  /* 圧縮方式 */
 unsigned long dwBBitCount;   /* 1ピクセル当たりのビット数 */
 long          lBWidth;     /* 画像データの横ピクセル数 */
 long          lBHeight;     /* 画像データの縦ピクセル数 */
 char          sBMarkfileName[BWF_MARK_SIZE];  /* 印章情報格納ファイル名称 */
 BWF_oid_t     sBObjectID;    /* メモオブジェクトID格納領域 */
 char          sBMemoCmnt[BWF_CMNT_SIZE];    /* メモコメント */
} BWF_memotype_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
HwfGetCaseなどで取得したメモが貼り付けられている文書が格納されている案件,又はメモが貼り付いている案件の案件オブジェクトIDを格納した領域を指定します。
oid
HwfGetObjectInstance,HwfGetObjectInstanceToFileで取得したメモが貼り付けられている文書の文書オブジェクトIDを格納している領域を指定します。案件に貼り付いているメモを取得する場合は,NULLポインタを指定してください。
memooid
HwfGetObjectInstance,HwfGetCaseInf,及びHwfGetObjectInstanceToFileで取得したメモオブジェクトIDを格納している領域を指定します。
readmode
メモを読み出すときのモードを指定します。指定できるモードを次に示します。
BWF_NORMAL_READ:通常の読み込みのモード
BWF_REFER_READ:参照用読み込みのモード
デフォルト値はBWF_NORMAL_READです。また,参照用読み込みで読み込んだメモは削除・更新できませんが,メモ種別がBWF_CMNT_DATA,BWF_MARK_DATAの場合は,削除・更新できます。
memotype
読み出すメモの属性情報を取得する領域を指定します。
メモ属性情報内の設定項目については,メモ属性情報内項目を参照してください。
memosize
読み出したメモのメモ実体サイズを取得する領域を指定します。
メモ種別がBWF_CMNT_DATA,BWF_MARK_DATAの場合,値は設定されません。
memo
読み出したメモ実体が取得される領域のポインタを格納する領域を指定します。メモ種別がBWF_CMNT_DATA,BWF_MARK_DATAの場合,値は設定されません。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数は,文書に貼り付いているメモの取得と案件に貼り付いているメモの取得をサポートしていますが,メモの種類によって指定するパラメタが異なりますのでパラメタの指定には十分に注意してください。
(i) HwfGetMemoToFile(システム指定ファイルへのメモ読み出し)

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

機能
案件,又は案件内に格納されている文書に貼り付けられたメモを,このシステムが指定したファイルに読み出し,対応する属性情報を取得します。
案件に貼り付けられたメモを読み出す場合,案件に対して事前にHwfActCase,又はHwfActCaseWithDocLockを発行しておく必要があります。
案件内に格納されている文書に貼り付けられたメモを読み出す場合,HwfGetObjectInstance,又はHwfGetObjectInstanceToFileを発行して文書を事前に読み出しておく必要があります。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetMemoToFile(
 BWF_useroid_t __far   *useroid, /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far   *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t  __far   *caseid,  /* 案件オブジェクトID格納領域 (I) */
 BWF_oid_t     __far   *oid,   /* 文書オブジェクトID格納領域 (I) */
 BWF_oid_t     __far   *memooid, /* メモオブジェクトID格納領域 (I) */
 BWF_memotype_t __far  *memotype, /* メモ属性情報格納領域 (O) */
 BWF_doclist_t  __far  *memolist, /* 取得メモパス,ファイル名称格納領域 (O) */
 BWF_errlist_t  __far  *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_memotype_t{
 char          sBFileName[16];  /* ファイル名称 */
 char          sBMemoType[4];   /* メモ種別 */
 long          lBMemoX;      /* メモ位置 x */
 long          lBMemoY;      /* メモ位置 y */
 long          lBPelsx;      /* 解像度 x方向 */
 long          lBPelsy;      /* 解像度 y方向 */
 char          chBCompression;  /* 圧縮方式 */
 unsigned long dwBBitCount;    /* 1ピクセル当たりのビット数 */
 long          lBWidth;      /* 画像データの横ピクセル数 */
 long          lBHeight;     /* 画像データの縦ピクセル数 */
 char          sBMarkfileName[BWF_MARK_SIZE];  /* 印章情報格納ファイル名称 */
 BWF_oid_t     sBObjectID;    /* メモオブジェクトID格納領域 */
 char          sBMemoCmnt[BWF_CMNT_SIZE];    /* メモコメント */
} BWF_memotype_t;
typedef struct BWF_doclist_t{
 char sBDoclist[512];  /* 取得メモパス名 */
} BWF_doclist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];   /* メッセージ区分 */
 long lBMsgNo;     /* メッセージ番号 */
 char sBInsWord[13];  /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
HwfGetCaseなどで取得したメモが貼り付けられている文書が格納されている案件,又はメモが貼り付いている案件の案件オブジェクトIDを格納した領域を指定します。
oid
HwfGetObjectInstance,HwfGetObjectInstanceToFileで取得したメモが貼り付けられている文書の文書オブジェクトIDを格納している領域を指定します。
案件に貼り付いているメモを取得する場合は,NULLポインタを指定してください。
memooid
HwfGetObjectInstance,HwfGetCaseInf,又はHwfGetObjectInstanceToFileのどれかで取得したメモオブジェクトIDを格納している領域を指定します。
memotype
読み出すメモの属性情報を取得する領域を指定します。
メモ属性情報内の設定項目については,メモ属性情報内項目を参照してください。
memolist
システムが読み出したメモが格納されたファイルのパス,ファイル名を取得する領域を指定します。
なお,メモ種別がBWF_CMNT_DATA,BWF_MARK_DATAの場合,データはそれぞれmemotype内のsBMemoCmnt,sBMarkfileNameにデータが設定され,ここには設定されません。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数は,文書に貼り付いているメモの取得と案件に貼り付いているメモの取得をサポートしていますが,メモの種類によって指定するパラメタが異なりますので,パラメタの指定には十分に注意してください。
  • 「同報中」の案件,又は下位案件の既存のメモ(メモ種別がBWF_CMNT_DATA,BWF_MARK_DATA以外の場合)を取得する場合は,HwfActCaseWithDocLockでメモに対しての排他が成功した場合だけ,このAPI関数を発行してください(HwfActCaseWithDocLockでメモに対しての排他ができなくてもメモを取得する場合は,HwfGetMemoのreadmodeにBWF_REFER_READを指定してメモを取得してください)。
  • 文書を取得後,次に示すAPI関数を発行すると,取得したパス,ファイル名のファイルは削除されるので注意してください。
  • HwfPauseCase
  • HwfDeactCase
  • HwfGoCase
  • HwfRoundCase
  • HwfAnswerCase
  • HwfSendBackCase
  • HwfLogoutWorkflow
  • memooidにメモ種別がBWF_DATA_DATAのメモオブジェクトIDを指定した場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります(メモ種別がBWF_DATA_DATAのメモを取得する場合は,HwfGetMemoで取得してください)。
(j) HwfDeleteMemo(メモの削除)

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

機能
案件,又は案件内に格納されている文書に貼り付けられたメモを削除します。
案件に貼り付けられたメモを削除する場合,案件に対して事前にHwfActCase,又はHwfActCaseWithDocLockを発行しておく必要があります。案件内に格納されている文書に貼り付けられたメモを削除する場合,HwfGetMemo,又はHwfGetMemoToFileを発行してメモを事前に読み出しておく必要があります。ただし,コメントメモと印章メモの場合は,事前にHwfGetMemo,又はHwfGetMemoToFileを発行して読み出す必要はありません。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfDeleteMemo(
 BWF_useroid_t __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,  /* サーバ名称格納領域 (I) */
 BWF_caseid_t  __far *caseid,  /* 案件オブジェクトID格納領域 (I) */
 BWF_oid_t     __far *oid,    /* 文書オブジェクトID格納領域 (I) */
 BWF_oid_t     __far *memooid,  /* メモオブジェクト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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
HwfGetCaseなどで取得した,削除するメモが貼り付いている文書が格納されている案件,又は削除するメモが貼り付いている案件の案件オブジェクトIDを格納した領域を指定します。
oid
HwfGetObjectInstance,HwfGetObjectInstanceToFileで取得した,削除するメモが貼り付いている文書の文書オブジェクトIDを格納した領域を指定します。案件に貼り付いてるメモを削除する場合は,NULLポインタを指定してください。
memooid
HwfGetObjectInstance,HwfGetObjectInstanceToFile,及びHwfGetCaseInfで取得した,削除するメモのメモオブジェクトIDを格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数は,文書に貼り付いているメモの削除と案件に貼り付いているメモの削除をサポートしていますが,メモの種類によって指定するパラメタが異なりますので,パラメタの指定には十分に注意してください。
  • 終了処理ノードに至った案件,又は案件内に格納されている文書に貼り付けられたメモを削除しようとした場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(k) HwfUpdateMemo(メモの更新)

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

機能
案件,又は案件内に格納されている文書に貼り付けられたメモを更新します。
案件に貼り付けられたメモを更新する場合,案件に対して事前にHwfActCase,又はHwfActCaseWithDocLockを発行しておく必要があります。案件内に格納されている文書に貼り付けられたメモを更新する場合,HwfGetMemo,又はHwfGetMemoToFileを発行してメモを事前に読み出しておく必要があります。ただし,コメントメモと印章メモの場合は,事前にHwfGetMemo,又はHwfGetMemoToFileを発行して読み出す必要はありません。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfUpdateMemo(
 BWF_useroid_t  __far  *useroid, /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far  *server,  /* サーバ名称格納領域  (I) */
 BWF_caseid_t   __far  *caseid  /* 案件オブジェクトID格納領域 (I) */
 BWF_oid_t      __far  *oid,   /* 文書オブジェクトID格納領域 (I) */
 BWF_oid_t      __far  *memooid, /* メモオブジェクトID格納領域 (I) */
 BWF_memotype_t __far  *memotype, /* メモ属性情報格納領域 (I) */
 BWF_doclist_t  __far  *memolist, /* メモ情報パス,ファイル名称格納領域 (I) */
 long                  size,   /* メモサイズ格納領域 (I) */
 void           __huge *memo,   /* メモ実体格納領域 (I) */
 BWF_errlist_t  __far  *errlist  /* エラー情報取得領域 (O) */
);
typedef struct BWF_memotype_t{
 char          sBFileName[16];  /* ファイル名称 */
 char          sBMemoType[4];   /* メモ種別 */
 long          lBMemoX;      /* メモ位置 x */
 long          lBMemoY;      /* メモ位置 y */
 long          lBPelsx;      /* 解像度 x方向 */
 long          lBPelsy;      /* 解像度 y方向 */
 char          chBCompression;  /* 圧縮方式 */
 unsigned long dwBBitCount;    /* 1ピクセル当たりのビット数 */
 long          lBWidth;      /* 画像データの横ピクセル数 */
 long          lBHeight;     /* 画像データの縦ピクセル数 */
 char          sBMarkfileName[BWF_MARK_SIZE];  /* 印章情報格納ファイル名称 */
 BWF_oid_t     sBObjectID;    /* メモオブジェクトID */
 char          sBMemoCmnt[BWF_CMNT_SIZE];    /* メモコメント */
} BWF_memotype_t;
typedef  struct  BWF_doclist_t{
 char sBDoclist[512];       /* 更新メモパス名 */
} BWF_doclist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];        /* メッセージ区分 */
 long lBMsgNo;          /* メッセージ番号 */
 char sBInsWord[13];       /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
HwfGetCaseなどで取得した,メモが貼り付いている案件,又は更新するメモが貼り付いている文書の文書オブジェクトIDを格納した領域を指定します。
oid
HwfGetObjectInstance,HwfGetObjectInstanceToFileで取得した,更新するメモが貼り付いている文書の文書オブジェクトIDを格納した領域を指定します。案件に貼り付いているメモを更新する場合は,NULLポインタを指定してください。
memooid
HwfGetObjectInstance,HwfGetObjectInstanceToFile,及びHwfGetCaseInfで取得した,メモオブジェクトIDを格納した領域を指定します。
memotype
更新するメモの属性情報を格納した領域を指定します。
メモの属性情報を変更しない場合は,NULLポインタを指定してください。
メモ属性情報内の設定項目については,メモ属性情報内項目を参照してください。
memolist
更新するメモが格納されているドライブ名,ファイルのパス,及びファイル名称を格納した領域を指定します。ただし,メモ種別がBWF_CMNT_DATA,BWF_MARK_DATA,BWF_DATA_DATAの場合,指定した値は無効となります。
ドライブ名,ファイルのパス,及びファイル名称は,終端にNULL文字を付けた128バイト以内で指定してください。
更新するメモがメモリ上に存在する場合は,NULLポインタを指定してください。
size
更新するメモがメモリ上に存在する場合は,メモの実体サイズを指定します。
ただし,メモ種別がBWF_CMNT_DATA,又はBWF_MARK_DATAの場合,指定した値は無効となります。
ファイルとして存在するメモを更新する場合は,0を指定してください。
また,メモ種別がBWF_DATA_DATAの場合は,1~4096バイト以内のサイズを指定してください。
memo
更新するメモがメモリ上に存在する場合は,更新するメモが格納されている領域を指定してください。ただし,メモ種別がBWF_CMNT_DATA,又はBWF_MARK_DATAの場合,指定した値は無効となります。
ファイルとして存在するメモを更新する場合は,NULLポインタを指定してください。
また,メモ種別がBWF_DATA_DATAの場合は,終端にNULL文字を付けた4096バイト以内の文字列で指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数は,文書に貼り付いているメモの取得と案件に貼り付いているメモの更新をサポートしていますが,メモの種類によって指定するパラメタが異なりますので,パラメタの指定には十分に注意してください。
  • メモ種別がBWF_DATA_DATAの場合,memoに指定した領域で,sizeに指定した範囲にバイナリデータが存在した場合は,このAPI関数,HwfGetMemo,及びHwfGetMemoToFileの結果は保証しません。
  • メモ種別を更新しようとした場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 終了処理ノードに至った案件,又は案件内に格納されている文書に貼り付けられたメモを更新しようとした場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • memoに格納したメモ実体のサイズとsizeに指定したメモ実体のサイズが異なる場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(l) HwfGetCaseInf(案件中のメモ情報取得)

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

機能
案件に貼り付けられているメモの属性情報を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。

構文

#include<bwf.h>
long HwfGetCaseInf (
 BWF_useroid_t  __far *useroid,     /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,     /* サーバ名称格納領域 (I) */
 BWF_caseid_t   __far *caseid,     /* 案件オブジェクトID格納領域 (I) */
 long                 memotypen,    /* メモ情報取得領域要素数 (I) */
 BWF_memotype_t __far *memotype,    /* メモ情報取得領域 (O) */
 long           __far *memocount,    /* メモ情報取得数 (O) */
 long           __far *allmemocount,  /* メモ情報取得可能数 (O) */
 BWF_errlist_t  __far *errlist     /* エラー情報取得領域 (O) */
);
typedef struct BWF_memotype_t{
 char          sBFileName[16];     /* ファイル名称 */
 char          sBMemoType[4];      /* メモ種別 */
 long          lBMemoX;         /* メモ位置 x */
 long          lBMemoY;         /* メモ位置 y */
 long          lBPelsx;         /* 解像度 x */
 long          lBPelsy;         /* 解像度 y */
 char          chBCompression;     /* 圧縮方式 */
 unsigned long dwBBitCount;       /* 1ピクセル当たりのビット数 */
 long          lBWidth;         /* 原画データの横ピクセル数 */
 long          lBHeight;        /* 原画データの縦ピクセル数 */
 char          sBMarkfileName[BWF_MARK_SIZE];  /* 印章情報ファイル名称 */
 BWF_oid_t     sBObjectID;       /* メモオブジェクトID */
 char          sBMemoCmnt[BWF_CMNT_SIZE];    /* メモコメント */
} BWF_memotype_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];   /* メッセージ区分 */
 long lBMsgNo;     /* メッセージ番号 */
 char sBInsWord[13];  /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
caseid
HwfGetCaseなどで取得した,情報取得対象の案件の案件オブジェクトIDを格納した領域を指定します。
memotypen
メモ情報を取得する,指定した案件に貼り付けられたメモの要素数を指定します。最大128まで指定できます。
memotype
指定した案件に貼り付けられたメモの属性情報を取得する領域を指定します。
なお,この領域のサイズは,memotypenで指定した要素数分のサイズを必ず確保して指定してください。
このAPI関数がエラーリターンした場合,この領域の値は不正となりますので使用できません。
メモ属性情報内の設定項目については,メモ属性情報内項目を参照してください。
memocount
指定した案件に貼り付けられたメモの属性情報を取得した件数を取得する領域
を指定します。このAPI関数がエラーリターンした場合,この領域の値は不正となりますので使用できません。
allmemocount
指定した案件に貼り付けられたメモの総数を取得する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • caseidに指定した案件のメモ数(案件とその案件下に存在する文書すべてに貼り付けられたメモの総数。HwfGetCase,HwfGetObjectAttributeなどで取得できます。)が129以上のとき,caseidに指定した案件に貼り付いたメモのメモ属性情報をすべて取得できない場合があります。
  • memotypen<allmemocountの場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります(その場合,allmemocountで取得した値をmemotypenに設定し,memotypeにmemotypenで指定した要素数分の領域を指定して,このAPI関数を再度発行してください。又は,常にmemotypenに128を,memotypeにmemotypenで指定した要素数分の領域を指定して,このAPI関数を発行してください)。
(m) 文書属性情報内項目
項目内容
sBFileName登録する文書のファイル名称を指定します。設定する文字列は,終端にNULL文字を付けた13バイト以内の文字列で指定してください。
sBDocType登録する文書の種別を指定します。システムでは,次に示す4タイプを用意していますが,ユーザ任意の値も指定できます(NULL文字は設定できません)。
BWF_IMAG_DATA:画像データの文書を示します。
BWF_WORD_DATA:MS-Wordの文書を示します。
BWF_EXCEL_DATA:MS-Excelの文書を示します。
BWF_ORIGINAL_DATA:上記以外のユーザ独自文書を示します。
lBPelsxsBDocTypeの指定がBWF_IMAG_DATAの場合,その画像データのx方向の解像度を指定します。ほかの文書種別の場合,指定した値は無効となります。
lBPelsysBDocTypeの指定がBWF_IMAG_DATAの場合,その画像データのy方向の解像度を指定します。ほかの文書種別の場合,指定した値は無効となります。
chBCompressionsBDocTypeの指定がBWF_IMAG_DATAの場合,その画像データの圧縮方式を指定します。システムでは,次に示す4タイプを用意していますが,ユーザ任意の値も指定できます(NULL文字は設定できません)。ただし,ほかの文書種別の場合,指定した値は無効となります。
BWF_COMPRESS_NON:非圧縮を示します。
BWF_COMPRESS_MMR:MMR方式を示します。
BWF_COMPRESS_MR:MR方式を示します。
BWF_COMPRESS_MH:MH方式を示します。
dwBBitCountsBDocTypeの指定がBWF_IMAG_DATAの場合,その画像データの1ピクセル当たりのビット数を指定します。ほかの文書種別の場合,指定した値は無効となります。
lBWidthsBDocTypeの指定がBWF_IMAG_DATAの場合,その画像データの横ピクセル数を指定します。ほかの文書種別の場合,指定した値は無効となります。
lBHeightsBDocTypeの指定がBWF_IMAG_DATAの場合,その画像データの縦ピクセル数を指定します。ほかの文書種別の場合,指定した値は無効となります。
sBDocCmnt登録する文書に対するコメントを284バイトまでの文字列として指定します。指定するコメントが284バイトに満たない場合は,空白文字などで埋めてください(NULL文字でクリアしないでください)。
(n) 文書属性情報内項目
項目内容
sBFileName文書の登録時に指定されたファイル名称が設定されます。
sBDocType文書の登録時に指定された文書種別が設定されます。システムでは,次に示す4タイプを用意していますが,ユーザ任意の値も指定できます(NULL文字は設定できません)。
BWF_IMAG_DATA:画像データの文書を示します。
BWF_WORD_DATA:MS-Wordの文書を示します。
BWF_EXCEL_DATA:MS-Excelの文書を示します。
BWF_ORIGINAL_DATA:上記以外のユーザ独自文書を示します。
lBPelsxsBDocTypeの設定がBWF_IMAG_DATAの場合,その画像データのx方向の解像度が設定されます。ほかの文書種別の場合,値は設定されません。
lBPelsysBDocTypeの設定がBWF_IMAG_DATAの場合,その画像データのy方向の解像度が設定されます。ほかの文書種別の場合,値は設定されません。
chBCompressionsBDocTypeの設定がBWF_IMAG_DATAの場合,その画像データの圧縮方式が設定されます。システムでは,次に示す4タイプを用意していますが,ユーザ任意の値も指定できます(NULL文字は設定できません)。ただし,ほかの文書種別の場合,指定した値は無効となります。
BWF_COMPRESS_NON:非圧縮を示します。
BWF_COMPRESS_MMR:MMR方式を示します。
BWF_COMPRESS_MR:MR方式を示します。
BWF_COMPRESS_MH:MH方式を示します。
dwBBitCountsBDocTypeの設定がBWF_IMAG_DATAの場合,その画像データの1ピクセル当たりのビット数が設定されます。ほかの文書種別の場合,値は設定されません。
lBWidthsBDocTypeの設定がBWF_IMAG_DATAの場合,その画像データの横ピクセル数が設定されます。ほかの文書種別の場合,値は設定されません。
lBHeightsBDocTypeの設定がBWF_IMAG_DATAの場合,その画像データの縦ピクセル数が設定されます。ほかの文書種別の場合,値は設定されません。
sBDocCmnt文書に対するコメントが284バイトまでの文字列として設定されます。
(o) メモ属性情報内項目
項目内容
sBFileNameメモの貼り付け/更新時に指定されたファイル名称が設定されます。
sBMemoTypeメモの登録/更新時に指定されたメモ種別が設定されます。
BWF_IMAG_DATA:画像メモを示します。
BWF_SOUND_DATA:音声メモを示します。
BWF_TEXT_DATA:テキストメモを示します。
BWF_MARK_DATA:印章メモを示します。
BWF_ORIGINAL_DATA:ユーザ独自メモを示します。
BWF_CMNT_DATA:コメントメモを示します。
BWF_DATA_DATA:データメモを示します。
lBMemoXメモの貼り付け/更新時に指定されたメモ位置(x方向)が設定されます。
lBMemoYメモの貼り付け/更新時に指定されたメモ位置(y方向)が設定されます。
lBPelsxsBMemoTypeの設定がBWF_IMAG_DATAの場合,その画像データのx方向の解像度が設定されます。ほかのメモ種別の場合,値は設定されません。
lBPelsysBMemoTypeの設定がBWF_IMAG_DATAの場合,その画像データのy方向の解像度が設定されます。ほかのメモ種別の場合,値は設定されません。
chBCompressionsBMemoTypeの設定がBWF_IMAG_DATAの場合,その画像データの圧縮方式が設定されます。ほかのメモ種別の場合,値は設定されません。
BWF_COMPRESS_NON:非圧縮を示します。
BWF_COMPRESS_MMR:MMR方式を示します。
BWF_COMPRESS_MR:MR方式を示します。
BWF_COMPRESS_MH:MH方式を示します。
dwBBitCountsBMemoTypeの設定がBWF_IMAG_DATAの場合,その画像データの1ピクセル当たりのビット数が設定されます。ほかのメモ種別の場合,値は設定されません。
lBWidthsBMemoTypeの設定がBWF_IMAG_DATAの場合,その画像データの横ピクセル数が設定されます。ほかのメモ種別の場合,値は設定されません。
lBHeightsBMemoTypeの設定がBWF_IMAG_DATAの場合,その画像データの縦ピクセル数が設定されます。ほかのメモ種別の場合,値は設定されません。
sBMarkfileNamesBMemoTypeの設定がBWF_MARK_DATAの場合,その印章データの格納されたファイル名称が設定されます。ほかのメモ種別の場合,値は設定されません。
sBObjectID文書に貼り付けられたメモのメモオブジェクトIDが設定されます。メモを読み出す場合は,このメモオブジェクトIDを指定する必要があります。
sBMemoCmntメモに対するコメントが284バイトまでの文字列として設定されます。
(p) メモ属性情報内項目
項目内容
sBFileName登録するメモのファイル名称を指定します。ただし,メモをメモリから登録する場合,ファイル名称はユーザの任意とします。ファイル名称は,終端にNULL文字を付けた13バイト以内の文字列で指定してください。
sBMemoType文書に貼り付けるメモの種別を指定します。システムでは,次の7タイプを用意していますが,ユーザで任意の値を設定できます。
BWF_IMAG_DATA:画像メモを示します。
BWF_SOUND_DATA:音声メモを示します。
BWF_TEXT_DATA:テキストメモを示します。
BWF_MARK_DATA:印章メモを示します。
BWF_ORIGINAL_DATA:ユーザ独自メモを示します。
BWF_CMNT_DATA:コメントメモを示します。
BWF_DATA_DATA:データメモを示します。
lBMemoX文書/案件にメモを貼り付けるx方向の座標を指定します。
lBMemoY文書/案件にメモを貼り付けるy方向の座標を指定します。
lBPelsxsBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データのx方向の解像度を指定します。ほかのメモ種別の場合,指定した値は無効となります。
lBPelsysBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データのy方向の解像度を指定します。ほかのメモ種別の場合,指定した値は無効となります。
chBCompressionsBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データの圧縮方式を指定します。システムでは,次の4タイプを用意していますが,ユーザ任意の値を設定できます。ただし,ほかのメモ種別の場合,指定した値は無効となります。
BWF_COMPRESS_NON:非圧縮を示します。
BWF_COMPRESS_MMR:MMR方式を示します。
BWF_COMPRESS_MR:MR方式を示します。
BWF_COMPRESS_MH:MH方式を示します。
dwBBitCountsBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データの1ピクセル当たりのビット数を指定します。ほかのメモ種別の場合,指定した値は無効となります。
lBWidthsBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データの横ピクセル数を指定します。ほかのメモ種別の場合,指定した値は無効となります。
lBHeightsBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データの縦ピクセル数を指定します。ほかのメモ種別の場合,指定した値は無効となります。
sBMarkfileNamesBMemoTypeの指定がBWF_MARK_DATAの場合,その印章データの格納されたファイルのファイル名称を指定します。印章データファイル名称は,終端にNULL文字を付けた13バイト以内の文字列で指定してください。
memooid指定した値は無効となります。
sBMemoCmntメモに対するコメントを284バイトまでの文字列として指定します。
(q) メモ属性情報内項目
項目内容
sBFileName更新するメモのファイル名称を指定します。ただし,メモをメモリから更新する場合,ファイル名称はユーザの任意とします。ファイル名称は,終端にNULL文字を付けた13バイト以内の文字列で指定してください。
sBMemoType更新するメモの種別を指定します。システムでは,次の7タイプを用意していますが,ユーザで任意の値を設定できます。
BWF_IMAG_DATA:画像メモを示します。
BWF_SOUND_DATA:音声メモを示します。
BWF_TEXT_DATA:テキストメモを示します。
BWF_MARK_DATA:印章メモを示します。
BWF_ORIGINAL_DATA:ユーザ独自メモを示します。
BWF_CMNT_DATA:コメントメモを示します。
BWF_DATA_DATA:データメモを示します。
lBMemoX文書に貼り付いたメモのx方向の座標を指定します。案件に貼り付いたメモの場合は,ユーザ側の使用方法に合わせて任意に指定してください。
lBMemoY文書に貼り付いたメモのy方向の座標を指定します。案件に貼り付いたメモの場合は,ユーザ側の使用方法に合わせて任意に指定してください。
lBPelsxsBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データのx方向の解像度を指定します。ほかのメモ種別の場合,指定した値は無効となります。
lBPelsysBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データのy方向の解像度を指定します。ほかのメモ種別の場合,指定した値は無効となります。
chBCompressionsBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データの圧縮方式を指定します。システムでは,次の4タイプを用意していますが,ユーザ任意の値を指定できます。ただし,ほかのメモ種別の場合,指定した値は無効となります。
BWF_COMPRESS_NON:非圧縮を示します。
BWF_COMPRESS_MMR:MMR方式を示します。
BWF_COMPRESS_MR:MR方式を示します。
BWF_COMPRESS_MH:MH方式を示します。
dwBBitCountsBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データの1ピクセル当たりのビット数を指定します。ほかのメモ種別の場合,指定した値は無効となります。
lBWidthsBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データの横ピクセル数を指定します。ほかのメモ種別の場合,指定した値は,無効となります。
lBHeightsBMemoTypeの指定がBWF_IMAG_DATAの場合,その画像データの縦ピクセル数を指定します。ほかのメモ種別の場合,指定した値は無効となります。
sBMarkfileNamesBMemoTypeの指定がBWF_MARK_DATAの場合,その印章データの格納されたファイルのファイル名称を指定します。印章データファイル名称は,終端にNULL文字を付けた13バイト以内の文字列で指定してください。
sBObjectID指定した値は無効となります。
sBMemoCmntメモに対するコメントを284バイトまでの文字列として指定します。

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

(a) HwfGetHistory(ヒストリ情報取得)

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

機能
次に示す,ヒストリ情報(ヒストリリスト)を取得します。
  • ワーク
  • ユーザ
  • ユーザが処理した案件数
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetHistory(
 BWF_useroid_t __far *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,   /* サーバ名称格納領域 (I) */
 long                reqmode,   /* 要求種別 (I) */
 long                historykind, /* 取得ヒストリ種別 (I) */
 BWF_oid_t     __far *oid,    /* ヒストリ取得オブジェクトID格納領域 (I) */
 long                number,   /* ヒストリリスト取得先頭要素番号 (I) */
 long                historylistn,/* ヒストリリスト取得要素数 (I) */
 long          __far *total,   /* ヒストリリスト全要素数  (O) */
 long          __far *count,   /* 取得ヒストリリスト要素数 (O) */
 void          __far *historylist,/* ヒストリリスト取得領域 (O) */
 BWF_errlist_t __far *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_work_historylist_t{
 char sBWork_Historylist[128];
} BWF_work_historylist_t;
typedef struct BWF_user_historylist_t{
 char sBUser_Historylist[128];
} BWF_user_historylist_t;
typedef struct BWF_case_counterlist_t{
 BWF_bpid_t    BWF_cc_business_process_oid;  /* ビジネスプロセスオブジェクトID */
 BWF_nodeno_t  BWF_cc_node_id;        /* ノードID */
 unsigned long BWF_cc_counter;        /* 処理案件数 */
 BWF_time_t    BWF_cc_reset_time;       /* リセット日時 */
} BWF_case_counterlist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];    /* メッセージ区分 */
 long lBMsgNo;      /* メッセージ番号 */
 char sBInsWord[13];   /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
reqmode
ヒストリ取得モードを指定します。
BWF_CHRON_MODE:最も古いヒストリから取得します。
BWF_CURRENT_MODE:最も新しいヒストリからさかのぼって取得します。historykindがBWF_CASE_COUNTERの場合,指定不要です。
historykind
取得するヒストリの種別を指定します。
BWF_WORK_HISTORY:ワークのヒストリを取得します。
BWF_USER_HISTORY:ユーザのヒストリを取得します。
BWF_CASE_COUNTER:ユーザが処理した案件の数を取得します。
oid
ヒストリを取得するワーク,又はユーザのオブジェクトIDを格納した領域を指定します。ワークオブジェクトID,ユーザオブジェクトIDはそれぞれHwfGetCase,HwfGetUser,HwfGetWorkAttributeなどで取得できます。
historykindは,次に示すように指定する必要があります。
historykindオブジェクト種別
BWF_WORK_HISTORYワークオブジェクトID
BWF_USER_HISTORYユーザオブジェクトID
BWF_CASE_COUNTERユーザオブジェクトID
number
ヒストリリストを取得する要素の先頭番号を指定します。
先頭番号は0~(total-1)の範囲内で指定してください。
指定したワーク/ユーザ/案件で,このAPI関数を初回に発行する場合は0を指定してください。
2回目以降は,前回指定したnumberに前回のhistorylistnの値を加えたものを指定してください。
historylistn
ヒストリリストを取得する要素数を指定します。
必ず1以上の値を指定してください。
total
ヒストリリストの取得できる全要素数(reqmode,oidで指定したものに対応するヒストリ数)を取得する領域を指定します。
count
このAPI関数が取得した,ヒストリリストの要素数を取得する領域を指定します。
historylist
historykindの指定によって,ヒストリリスト取得領域の型は,次に示す型を指定します。
historykind
BWF_WORK_HISTORYBWF_work_historylist_t
BWF_USER_HISTORYBWF_user_historylist_t
BWF_CASE_COUNTERBWF_case_counterlist_t
上記の型で示した領域に取得される項目について説明します。
BWF_work_historylist_tで取得されるヒストリの種類と形式を次に示します。
BWF_user_historylist_tで取得される,ヒストリリスト内の詳細形式を次に示します。
BWF_case_counterlist_t内に取得されるヒストリリスト内の項目を次に示します。
項目内容
BWF_cc_business_process_oiduseroidに対応するユーザが関連するビジネスプロセスのビジネスプロセスオブジェクトIDが設定されます。
BWF_cc_node_idBWF_cc_business_process_oidに対応するビジネスプロセスで,useroidに対応するユーザが関連するノードIDが設定されます。
BWF_cc_counterBWF_cc_business_process_oidに対応するビジネスプロセスのBWF_cc_node_idに対応するノードで,useroidに対応するユーザが処理した案件数が設定されます。
BWF_cc_reset_timeBWF_cc_counterに対応する案件数を前回HwfSetHistoryを発行してリセットした日時が設定されます(日時は,YYYYMMDDhhmmss形式となります)。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数を複数回連続発行して,ワーク/ユーザヒストリリストを取得する場合,途中でほかのAPI関数を発行すると,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • このAPI関数を複数回連続発行して,ユーザ処理案件数を取得する場合,途中でほかのユーザが当該ユーザに対しHwfSetHistoryを発行すると,正常にユーザ処理案件数を取得できないため注意が必要です。
  • BWF_work_historylist_t,BWF_user_historylist_tで取得されるヒストリの種類と形式の中で,BWF_name_tの型を持つ各ユーザ名称は,終端にNULL文字を持たない場合があるため注意が必要です(各ユーザ名称の内容が8バイトの場合)。
(b) HwfSetHistory(ユーザヒストリの初期化)

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

機能
ユーザのヒストリ(ユーザ処理案件数)を初期化します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者が使用できます。
一般ユーザは,自他共にユーザのヒストリ(ユーザ処理案件数)を初期化できません。
構文

#include<bwf.h>
long HwfSetHistory(
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
suseroid
ユーザヒストリ(ユーザ処理案件数)を初期化するユーザのユーザオブジェクトID(HwfGetUserなどで取得)を格納した領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • 他ユーザがHwfGetHistoryを使用し,ユーザ処理案件数を取得中に該当する関数を発行した場合(複数回に分けて取得中),ユーザ処理案件の総数が不確定となります。
(c) HwfGetWorkHistory(指定案件のワークヒストリ情報取得)

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

機能
指定した案件のワークヒストリリストだけを取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetWorkHistory(
 BWF_useroid_t __far *useroid,     /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,     /* サーバ名称格納領域 (I) */
 unsigned long       reqmode,     /* 要求種別 (I) */
 BWF_caseid_t  __far *caseoid,     /* 案件オブジェクトID格納領域 (I) */
 unsigned long        number,     /* ヒストリリスト取得先頭要素番号 (I) */
 unsigned long        historylistn,  /* ヒストリリスト取得要素数 (I) */
 unsigned long __far *total,      /* ヒストリリスト全要素数 (O) */
 unsigned long __far *count,      /* 取得ヒストリリスト要素数 (O) */
 void          __far *historylist,   /* ヒストリリスト取得領域 (O) */
 BWF_errlist_t __far *errlist     /* エラー情報取得領域 (O) */
);
typedef struct BWF_work_historylist_t{
 char sBWork_Historylist[128];
} BWF_work_historylist_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];          /* メッセージ区分 */
 long lBMsgNo;            /* メッセージ番号 */
 char sBInsWord[13];         /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
reqmode
ヒストリ取得モードを指定します。
BWF_CHRON_MODE:最も古いヒストリから取得します。
BWF_CURRENT_MODE:最も新しいヒストリから,さかのぼって取得します。
caseoid
ヒストリリストを取得する,案件のオブジェクトIDを格納した領域を指定します。案件オブジェクトIDは,HwfGetCaseなどで取得できます。
number
ヒストリリストを取得する要素の先頭番号を設定します。
先頭番号は0~(total-1)の範囲内で設定してください。
指定した案件で,このAPI関数を初回に発行する場合は,0を指定してください。
2回目以降は,前回指定したnumberに前回のhistorylistnの値を加えたものを指定してください。
historylistn
ヒストリリストを取得する要素数を指定してください。
必ず1以上の値を指定してください。
total
ヒストリリストの取得可能な全要素数(caseoidにて指定した案件に対応するヒストリ数)を取得する領域を指定します。
count
このAPI関数が取得した,ヒストリリストの要素数を取得する領域を指定します。
historylist
ワークヒストリリストを取得する領域を指定します。
historylistnで指定した要素数分の領域を必ず指定してください。
クライアントライブラリでは,ワークヒストリリスト取得領域の型はBWF_work_historylist_tです。
サーバライブラリでは,ワークヒストリリスト取得領域の型は不定のため,最低限必要な領域のサイズも一定ではありませんので,次を参照し,ワークヒストリリスト取得に十分な領域を指定してください。
ヒストリ形式1(バイト)2(バイト)4,8,16(バイト)
BWF_wh_in128128132
BWF_wh_errmove128128132
BWF_wh_consultcase128128132
BWF_wh_gocase128128132
BWF_wh_suspendcase128128132
BWF_wh_suspendwork128128132
BWF_wh_resumecase128128132
BWF_wh_resumework128128132
BWF_wh_putcase128128132
BWF_wh_cancelwork128128132
BWF_wh_roletouser128128132
BWF_wh_usertorole128128132
BWF_wh_trustcase128128132
BWF_wh_answercase128128132
BWF_wh_putusermessgae128128132
BWF_wh_connectbp_first128130132
BWF_wh_connectbp_middle128128128
BWF_wh_connectbp_last128128128
BWF_wh_gotoext_first128130132
BWF_wh_gotoext_middle128128128
BWF_wh_gotoext_last128128128
BWF_wh_sendbackcase128128132
BWF_wh_takebackcase128128132
BWF_wh_endofcase128128132
上記は,各アライメント(単位バイト)による各ワークヒストリ1要素のサイズ(単位バイト)を表します。
上記のワークヒストリリストの形式,及びこのAPI関数で取得できるワークヒストリリストの種類と形式については,HwfGetHistoryを参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数を複数回連続発行して,ワークヒストリリストを取得する場合,途中でほかのAPI関数を発行すると,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • 取得されるヒストリの種類と形式の中でBWF_name_tの型を持つ各ユーザ名称は,終端にNULL文字を持たない場合があるため,注意が必要です(各ユーザ名称の内容が8バイトの場合)。
(d) HwfDeleteUserHistory(ユーザヒストリの削除)

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

機能
指定ユーザの全ユーザヒストリ,又は任意のユーザヒストリを削除します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfDeleteUserHistory(
 BWF_useroid_t  __far *useroid,      /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t   __far *server,      /* サーバ名称格納領域 (I) */
 BWF_useroid_t  __far *deluseroid,    /* 削除対象ユーザオブジェクトID格納領域 (I) */
 unsigned long        mode,        /* ユーザヒストリ削除モード  (I) */
 BWF_delete_history_inf_t __far *history, /* 削除対象ユーザヒストリ情報格納領域 (I) */
 BWF_errlist_t  __far *errlist      /* エラー情報取得領域 (O) */
);
typedef struct BWF_delete_history_inf_t{
 unsigned char   BWF_logid;        /* ログID */
 char            BWF_reserved[3];     /* 予備領域 */
 long            BWF_time;        /* ユーザヒストリ取得時刻 */
 BWF_caseid_t    BWF_caseid;       /* 案件オブジェクトID */
 char            BWF_reserved2[112];   /* 拡張用領域 */
} BWF_delete_history_inf_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];            /* メッセージ区分 */
 long lBMsgNo;              /* メッセージ番号 */
 char sBInsWord[13];           /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
deluseroid
削除対象となるユーザヒストリのユーザオブジェクトID(HwfGetUserなどで取得)を格納した領域を指定します。
mode
ユーザヒストリの削除モードを指定します。
BWF_DELETE_ALL:deluseroidで指定した,ユーザのすべてのユーザヒストリを削除します。
BWF_DELETE_SELECT:historyで指定した,ユーザヒストリだけを削除します。
history
削除対象となる,ユーザヒストリのキーとなる項目を指定します。
削除対象ユーザヒストリ情報格納領域内項目を次に示します。
modeにBWF_DELETE_ALLを指定した場合は,指定する必要はありません。
項目内容
BWF_logid削除対象ユーザヒストリ中のログIDを指定してください。
BWF_reserved指定する必要はありません。
BWF_time削除対象ユーザヒストリ中の取得時刻(1970/01/01 00:00:00(GMT)からの経過秒)を指定してください。
BWF_caseid削除対象ユーザヒストリ中の案件オブジェクトIDを指定してください。
BWF_reserved2NULL文字を指定してください。ユーザヒストリ中の項目については,HwfGetHistoryを参照してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • historyで指定したユーザヒストリが存在しない(削除済み)場合,このAPI関数の戻り値は正常リターン(BWF_OK)となります。
  • useroidに指定したユーザが一般ユーザの場合,deluseroidに指定するユーザオブジェクトIDは,useroidと同一である必要があり,異なるユーザオブジェクトIDを指定した場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • このAPI関数でユーザヒストリを削除した場合,削除したユーザヒストリは再取得できませんので,引き戻し要求ができなくなる場合があります。
(e) HwfGetHistoryMsgCount(ワーク,ユーザヒストリからのメッセージ種別単位総数取得)

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

機能
HwfGetWorkHistory,HwfGetHistoryで取得したワーク,ユーザヒストリから各メッセージ種別単位の総数を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetHistoryMsgCount(
 char              __far *lpBHistory,    /* ヒストリリスト格納領域 (I) */
 long                     lBCount,      /* ヒストリ数 (I) */
 long                     lBKind,      /* ヒストリ種別 (I) */
 BWF_Wh_TypeList_t __far *lpBWhTypeList,   /* ワークヒストリメッセージ種別総数取得領域 (O) */
 BWF_Uh_TypeList_t __far *lpBUhTypeList,   /* ユーザヒストリメッセージ種別総数取得領域 (O) */
 BWF_errlist_t     __far *lpBErrList     /* エラー情報取得領域     (O) */
);
typedef struct BWF_Wh_TypeList_t{
 unsigned long WH_Cnt_IN;      /* 案件のノード間遷移 */
 unsigned long WH_Cnt_ERRMOVE;    /* 案件の遷移エラー */
 unsigned long WH_Cnt_CONSULTCASE;  /* 相談による案件遷移 */
 unsigned long WH_Cnt_GOCASE;    /* 案件の遷移要求 */
 unsigned long WH_Cnt_SUSPENDCASE;  /* 案件の遷移中断 */
 unsigned long WH_Cnt_SUSPENDWORK;  /* ワーク全体の遷移中断 */
 unsigned long WH_Cnt_RESUMECASE;  /* 案件の遷移再開 */
 unsigned long WH_Cnt_RESUMEWORK;  /* ワーク全体の遷移再開 */
 unsigned long WH_Cnt_PUTCASE;    /* 案件投入 */
 unsigned long WH_Cnt_CANCELWORK;  /* ワーク全体の削除 */
 unsigned long WH_Cnt_ROLETOUSER;    
               /* ロールトレーからユーザトレーへの案件取り出し */
 unsigned long WH_Cnt_USERTOROLE;    
               /* ユーザトレーからロールトレーへの案件返却 */
 unsigned long WH_Cnt_TRUSTCASE;    /* 他ユーザへの処理依頼 */
 unsigned long WH_Cnt_ANSWERCASE;    
               /* 相談された案件の回答による案件の遷移 */
 unsigned long WH_Cnt_PUTUSERMESSGAE;    /* ユーザ出力メッセージ */
 unsigned long WH_Cnt_CONNECTBPF;    
               /* 他ビジネスプロセス定義への案件連携(先頭) */
 unsigned long WH_Cnt_CONNECTBPM;    
               /* 他ビジネスプロセス定義への案件連携(中間) */
 unsigned long WH_Cnt_CONNECTBPL;    
               /* 他ビジネスプロセス定義への案件連携(最終) */
 unsigned long WH_Cnt_GOTOEXTF;    
               /* 他ビジネスプロセス定義への案件連携完了(先頭) */
 unsigned long WH_Cnt_GOTOEXTM;    
               /* 他ビジネスプロセス定義への案件連携完了(中間) */
 unsigned long WH_Cnt_GOTOEXTL;    
               /* 他ビジネスプロセス定義への案件連携完了(最終) */
 unsigned long WH_Cnt_SENDBACKCASE;    /* 案件の差し戻し */
 unsigned long WH_Cnt_TAKEBACKCASE;    /* 案件の引き戻し */
 unsigned long WH_Cnt_ENDOFCASE;      /* 案件の遷移終了 */
} BWF_Wh_TypeList_t;
typedef struct BWF_Uh_TypeList_t{
 unsigned long UH_Cnt_CONSULTCASE;     /* 相談による案件遷移 */
 unsigned long UH_Cnt_GOCASE;       /* 案件の遷移要求 */
 unsigned long UH_Cnt_PUTCASE;       /* 案件の投入 */
 unsigned long UH_Cnt_ANSWERCASE;     /* 相談された案件の回答による案件の遷移 */
 unsigned long UH_Cnt_SENDBACKCASE;    /* 案件の差し戻し */
 unsigned long UH_Cnt_TAKEBACKCASE;    /* 案件の引き戻し */
} BWF_Uh_TypeList_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];    /* メッセージ区分 */
 long lBMsgNo;      /* メッセージ番号 */
 char sBInsWord[13];   /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
lpBHistory
HwfGetWorkHistory,HwfGetHistoryで取得した,ヒストリリストの格納領域を指定します。
lBCount
HwfGetWorkHistory,HwfGetHistoryで取得したヒストリ数を指定します。
HwfGetWorkHistory,HwfGetHistoryで取得したヒストリ数以下で,かつ1以上であれば,正常に処理します。
ヒストリ1要素のバイト数×lBCountが,64KBを超える指定はできません。
lBKind
lpBHistoryで指定した,ヒストリの種別を指定します。
BWF_HISTORYKIND_WORK:ワークヒストリ
BWF_HISTORYKIND_USER:ユーザヒストリ
lpBWhTypeList
lpBHistoryに指定した,ワークヒストリのメッセージ種別単位の総数を取得する領域を指定します。
lBKindにBWF_HISTORYKIND_WORKを指定した場合は,必ず指定してください(lBKindにBWF_HISTORYKIND_USERを指定した場合,必ずNULLポインタを指定してください)。
この構造体の各項目は,次に示すワークヒストリのメッセージ種別単位の総数が設定されます。
WH_Cnt_IN:案件のノード間遷移
WH_Cnt_ERRMOVE:案件の遷移エラー
WH_Cnt_CONSULTCASE:相談による案件遷移
WH_Cnt_GOCASE:案件の遷移要求
WH_Cnt_SUSPENDCASE:案件の遷移中断
WH_Cnt_SUSPENDWORK:ワーク全体の遷移中断
WH_Cnt_RESUMECASE:案件の遷移再開
WH_Cnt_RESUMEWORK:ワーク全体の遷移再開
WH_Cnt_PUTCASE:案件の投入
WH_Cnt_CANCELWORK:ワーク遷移中止
WH_Cnt_ROLETOUSER:ロールトレーからユーザトレーへの案件取り出し
WH_Cnt_USERTOROLE:ユーザトレーからロールトレーへの案件返却
WH_Cnt_TRUSTCASE:他ユーザへの処理依頼
WH_Cnt_ANSWERCASE:相談された案件の回答による案件の遷移
WH_Cnt_PUTUSERMESSGAE:ユーザ出力メッセージ
WH_Cnt_CONNECTBPF:他ビジネスプロセス定義への案件連携(先頭)
WH_Cnt_CONNECTBPM:他ビジネスプロセス定義への案件連携(中間)
WH_Cnt_CONNECTBPL:他ビジネスプロセス定義への案件連携(最終)
WH_Cnt_GOTOEXTF:他ビジネスプロセス定義への案件連携完了(先頭)
WH_Cnt_GOTOEXTM:他ビジネスプロセス定義への案件連携完了(中間)
WH_Cnt_GOTOEXTL:他ビジネスプロセス定義への案件連携完了(最終)
WH_Cnt_SENDBACKCASE:案件の差し戻し
WH_Cnt_TAKEBACKCASE:案件の引き戻し
WH_Cnt_ENDOFCASE:案件遷移終了
lpBHistoryにないメッセージ種別に対しては,0が設定されます。
lpBUhTypeList
lpBHistoryに指定した,ユーザヒストリのメッセージ種別単位の総数を取得する領域を指定します。
lBKindにBWF_HISTORYKIND_USERを指定した場合は,必ず指定してください(lBKindにBWF_HISTORYKIND_WORKを指定した場合,必ずNULLポインタを指定してください)。
この構造体の各項目は,次に示すユーザヒストリのメッセージ種別単位の総数が設定されます。
UH_Cnt_CONSULTCASE:相談による案件遷移
UH_Cnt_GOCASE:案件の遷移要求
UH_Cnt_PUTCASE:案件の投入
UH_Cnt_ANSWERCASE:相談された案件の回答による案件の遷移
UH_Cnt_SENDBACKCASE:案件の差し戻し
UH_Cnt_TAKEBACKCASE:案件の引き戻し
lpBHistoryにないメッセージ種別に対しては,0が設定されます。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(f) HwfSelectHistoryMsg(ワーク,ユーザヒストリからのメッセージ種別単位取得)

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

機能
HwfGetWorkHistory,HwfGetHistoryで取得したワーク,ユーザヒストリから同一のメッセージ種別を持つヒストリだけを抽出して取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfSelectHistoryMsg(
 char          __far *lpBHistory,    /* ヒストリリスト格納領域 (I) */
 long                lBCount,      /* ヒストリ数 (I) */
 long                lBKind,       /* ヒストリメッセージ種別 (I) */
 void          __far *lpBSelectArea,   /* 同一メッセージ種別ヒストリ取得領域 (O) */
 long          __far *lpBSelectCount,  /* 同一メッセージ種別ヒストリ取得数  (O) */
 BWF_errlist_t __far *lpBErrList     /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 */
 long lBMsgNo;    /* メッセージ番号 */
 char sBInsWord[13]; /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
lpBHistory
HwfGetWorkHistory,HwfGetHistoryで取得した,ヒストリリストの格納領域を指定します。
lBCount
HwfGetWorkHistory,HwfGetHistoryで取得したヒストリ数を指定します。
HwfGetWorkHistory,HwfGetHistoryで取得したヒストリ数以下で,かつ1以上であれば,正常に処理します。
ヒストリ1要素のバイト数×lBCountが,64KBを超える指定はできません。
lBKind
lpBHistoryから抽出するメッセージ種別を指定します。
ワークヒストリのメッセージ種別を次に示します。
BWF_DWH_IN:案件のノード間遷移
BWF_DWH_ERRMOVE:案件の遷移エラー
BWF_DWH_CONSULTCASE:相談による案件遷移
BWF_DWH_GOCASE:案件の遷移要求
BWF_DWH_SUSPENDCASE:案件の遷移中断
BWF_DWH_SUSPENDWORK:ワーク全体の遷移中断
BWF_DWH_RESUMECASE:案件の遷移再開
BWF_DWH_RESUMEWORK:ワーク全体の遷移再開
BWF_DWH_PUTCASE:案件の投入
BWF_DWH_CANCELWORK:ワーク遷移中止
BWF_DWH_ROLETOUSER:ロールトレーからユーザトレーへの案件取り出し
BWF_DWH_USERTOROLE:ユーザトレーからロールトレーへの案件返却
BWF_DWH_TRUSTCASE:他ユーザへの処理依頼
BWF_DWH_ANSWERCASE:相談された案件の回答による案件の遷移
BWF_DWH_PUTUSERMESSGAE:ユーザ出力メッセージ
BWF_DWH_SENDBACKCASE:案件の差し戻し
BWF_DWH_TAKEBACKCASE:案件の引き戻し
BWF_DWH_ENDOFCASE:案件遷移終了
ユーザヒストリのメッセージ種別を次に示します。
BWF_DUH_CONSULTCASE:相談による案件遷移
BWF_DUH_GOCASE:案件の遷移要求
BWF_DUH_PUTCASE:案件の投入
BWF_DUH_ANSWERCASE:相談された案件の回答による案件の遷移
BWF_DUH_SENDBACKCASE:案件の差し戻し
BWF_DUH_TAKEBACKCASE:案件の引き戻し
lpBSelectArea
lBKindで指定したメッセージ種別のヒストリを取得する領域を指定します。指定する領域のサイズは,(ヒストリ1要素のサイズ×HwfGetHistoryMsgCountで取得したメッセージ種別単位の総数)以上としてください。
この領域は64KBを超える指定はできません。
lpBSelectCount
lpBSelectAreaに取得した,ヒストリ数を格納する領域を指定します。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数は,指定されたヒストリ中から特定のメッセージ種別を持つヒストリだけを抽出するだけであり,ヒストリの編集などはしません(抽出した特定のメッセージ種別を持つ,ヒストリのデータ型式については,HwfGetWorkHistory,又はHwfGetHistoryを参照してください)。
(g) HwfPutHistoryMsg(ワーク,ユーザヒストリからのメッセージ種別単位のテキストファイル出力)

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

機能
HwfGetWorkHistory,HwfGetHistoryで取得したワーク,ユーザヒストリから同一のメッセージ種別を持つヒストリだけをテキストファイルへ出力します。
これによって,出力されたファイルの内容を,表計算ソフトなどに取り込めます。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfPutHistoryMsg(
 BWF_useroid_t __far *lpBUseroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *lpBServer,     /* サーバ名称格納領域 (I) */
 char          __far *lpBHistory,    /* ヒストリリスト格納領域 (I) */
 long                lBCount,      /* ヒストリ数 (I) */
 long                lBLogKind,     /* ヒストリメッセージ種別 (I) */
 BWF_workid_t  __far *lpBworkid,     /* ワークオブジェクトID格納領域 (I) */
 char          __far *lpBFileName,    /* テキストファイルパス名 (I) */
 unsigned long        lpBInsertMode,   /* テキストファイル出力モード (I) */
 char          __far *lpBPunc,      /* セパレータ種別 (I) */
 BWF_errlist_t __far *lpBErrList     /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];  /* メッセージ区分 (O) */
 long lBMsgNo;    /* メッセージ番号 (O) */
 char sBInsWord[13]; /* 挿入語句 (O) */
} BWF_errlist_t;

パラメタの説明
lpBUseroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
lpBServer
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
lpBHistory
HwfGetWorkHistory,HwfGetHistoryで取得した,ヒストリリストの格納領域を指定します。
lBCount
HwfGetWorkHistory,HwfGetHistoryで取得したヒストリ数を指定します。
HwfGetWorkHistory,HwfGetHistoryで取得した,ヒストリ数以下で,かつ1以上であれば,正常に処理します。
ヒストリ1要素のバイト数×lBCountが64KBを超える指定はできません。
lBLogKind
テキストファイルに出力するメッセージ種別を指定します。
ワークヒストリのメッセージ種別を次に示します。
BWF_DWH_IN:案件のノード間遷移
BWF_DWH_ERRMOVE:案件の遷移エラー
BWF_DWH_CONSULTCASE:相談による案件遷移
BWF_DWH_GOCASE:案件の遷移要求
BWF_DWH_SUSPENDCASE:案件の遷移中断
BWF_DWH_SUSPENDWORK:ワーク全体の遷移中断
BWF_DWH_RESUMECASE:案件の遷移再開
BWF_DWH_RESUMEWORK:ワーク全体の遷移再開
BWF_DWH_PUTCASE:案件の投入
BWF_DWH_CANCELWORK:ワーク遷移中止
BWF_DWH_ROLETOUSER:ロールトレーからユーザトレーへの案件取り出し
BWF_DWH_USERTOROLE:ユーザトレーからロールトレーへの案件返却
BWF_DWH_TRUSTCASE:他ユーザへの処理依頼
BWF_DWH_ANSWERCASE:相談された案件の回答による案件の遷移
BWF_DWH_PUTUSERMESSGAE:ユーザ出力メッセージ
BWF_DWH_SENDBACKCASE:案件の差し戻し
BWF_DWH_TAKEBACKCASE:案件の引き戻し
BWF_DWH_ENDOFCASE:案件遷移終了
ユーザヒストリのメッセージ種別を次に示します。
BWF_DUH_CONSULTCASE:相談による案件遷移
BWF_DUH_GOCASE:案件の遷移要求
BWF_DUH_PUTCASE:案件の投入
BWF_DUH_ANSWERCASE:相談された案件の回答による案件の遷移
BWF_DUH_SENDBACKCASE:案件の差し戻し
BWF_DUH_TAKEBACKCASE:案件の引き戻し
lpBworkid
lBLogKindに指定したメッセージ種別がワークヒストリの場合に,lpBHistoryに格納したヒストリを,HwfGetHistoryで取得したときのワークオブジェクトIDを指定します。
HwfGetHistoryで取得したときのワークオブジェクトIDと,lpBHistoryに格納したヒストリが対応していない場合,このAPI関数の戻り値はエラーリターンとなります。
lpBFileName
lBLogKindに指定したメッセージ種別に対応するヒストリを,テキスト形式で出力するファイルのドライブ名,パス,及びファイル名称を指定します(ドライブ名,ファイルのパス,及びファイル名称は,終端にNULL文字を付けた128バイト以内の文字列で指定してください。
lpBInsertMode
ファイル出力するときの書き込みモードを指定します。
BWF_OVERWRITE_MODE:上書きモード
同一名称のファイルが既にある場合,そのファイルに上書きで出力します。ない場合は,ファイルを新規にファイルを作成して出力します。
BWF_APPEND_MODE:追加モード
同一名称のファイルが既にある場合,そのファイルの終端に出力します。ない場合は,ファイルを新規に作成して出力します。
lpBPunc
lBLogKindに指定したメッセージ種別に対応するヒストリを,テキスト形式で出力する場合,lBLogKindに指定したメッセージ種別のヒストリデータ内の各要素を区切る文字列を指定します。
区切り文字は,終端にNULL文字を付けた1バイト以上5バイト未満の文字列で指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
sBMsgKbn:メッセージ区分を格納します。
lBMsgNo:メッセージ番号を格納します。
sBInsWord:挿入語句を格納します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • ヒストリ中に,lBLogKindで指定した形式のヒストリがない場合でも,ファイルは作成されますので,必要に応じて削除してください。
  • 次に示すlpBHistory内の項目は,次のように変換されます(括弧内は最大バイト数で,変換後最大バイト数に満たない項目は,有効バイト数だけを出力します)。
     案件オブジェクトID:案件名称(64)
     ワークオブジェクトID:案件識別子フォーマット(64)
     ユーザオブジェクトID:ユーザ名称(8)
     ロールオブジェクトID:ロール名称(64)
     ビジネスプロセス定義オブジェクトID:ビジネスプロセス名称(64)
     ノードID:ノード名称(64)
    なお,上記のように変換できなかった場合は,その旨を示すメッセージ文を出力します。出力するメッセージ文と原因については,ヒストリデータ変換エラーメッセージ文と原因を参照してください。
  • ユーザヒストリデータ内に設定されているワークオブジェクトIDについては出力されません(ワークオブジェクトIDをユーザが認識できる形に変換したものが,案件識別子フォーマット(ワークID)となるためです。詳細については,HwfGetWorkHistory,又はHwfGetHistoryを参照してください)。
(h) 案件のノード間遷移

HwfGoCaseが発行され,案件が次ノードへ遷移された時点で取得されます。

typedef struct BWF_wh_in{
 unsigned char chBFormId;    /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x05) */
 long          lBTime;      /* 取得時刻(経過秒) */
 unsigned char chBKindCode;   /* 案件遷移種別    */
                 /* 通常遷移(0x01)   */
                 /* 代行遷移(0x02)   */
                 /* 差し戻し遷移(0x03) */
                 /* 引き戻し遷移(0x04) */
 BWF_caseid_t  bBCsoid;     /* 遷移案件オブジェクトID */
 BWF_nodeno_t  bBFromNodeId;   /* 遷移元ノードID */
 BWF_nodeno_t  bBToNodeId;    /* 遷移先ノードID */
 BWF_roleid_t  bBToRoleoid;   /* 遷移先ロールオブジェクトID */
 BWF_useroid_t bBToUseroid;   /* 遷移先オブジェクトID */
 unsigned char chBReserved[81]; /* 予備領域 */
} BWF_wh_in;

(i) 案件の遷移エラー

遷移エラーを起こした案件が,システム管理者のトレーに転送された時点で取得されます。

typedef struct BWF_wh_errmove{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x07) */
 long          lBTime;      /* 取得時刻(経過秒) */
 unsigned char chBErrorCode[4];  /* 遷移エラーコード */
 unsigned char chBReasonCode[4]; /* 遷移エラー理由コード */
 BWF_caseid_t  bBCsoid;      /* 遷移案件オブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* 遷移エラー発生ノードID */
 BWF_useroid_t bBAMgrUseroid;   /* 案件遷移先ユーザ */
                  /* (ワークフロー管理者)オブジェクトID */
 unsigned char chBReserved[90];  /* 予備領域 */
} BWF_wh_errmove;

(j) 相談による案件遷移

HwfRoundCaseを発行した時点で取得されます。

typedef struct BWF_wh_consultcase{
 unsigned char   chBFormId;    /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x0C) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;      /* 相談案件オブジェクトID */
 BWF_nodeno_t  bBFromNodeId;   /* 相談元ノードID */
 BWF_useroid_t chBFromUseroid;  /* 相談元ユーザオブジェクトID */
 BWF_useroid_t chBToUseroid;   /* 相談先ユーザオブジェクトID */
 unsigned char chBReserved[90];  /* 予備領域 */
} BWF_wh_consultcase;

(k) 案件の遷移要求

HwfGoCaseを発行した時点で取得されます。

typedef struct BWF_wh_gocase{
 unsigned char chBFormId;    /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x0D) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;     /* 遷移要求案件オブジェクトID */
 BWF_nodeno_t  bBFromNodeId;   /* 遷移要求元ノードID */
 BWF_roleid_t  bBFromRoleoid;  /* 遷移要求元ロールオブジェクトID */
 BWF_useroid_t bBFromUseroid;  /* 遷移要求元ユーザオブジェクトID */
 unsigned char chBReserved[90]; /* 予備領域 */
} BWF_wh_gocase;

(l) 案件の遷移中断

案件の遷移中断要求がされた時点で取得されます。

typedef struct BWF_wh_suspendcase{
 unsigned char chBFormId;    /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x0E) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;     /* 遷移中断案件オブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* 遷移中断ノードID */
 BWF_roleid_t  bBRoleoid;    /* 遷移中断ロールオブジェクトID */
 BWF_useroid_t bBUseroid;    /* 遷移中断案件所持ユーザオブジェクトID */
 BWF_useroid_t bBExecUseroid;  /* 遷移中断実行ユーザオブジェクトID */
 unsigned char chBReserved[82]; /* 予備領域 */
} BWF_wh_suspendcase;

(m) ワーク全体の遷移中断

ワーク全体の遷移中断要求がされた時点で取得されます。

typedef struct BWF_wh_suspendwork{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x0F) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_useroid_t bBUseroid;     /* 遷移中断実行ユーザオブジェクトID */
 unsigned char chBReserved[114]; /* 予備領域 */
} BWF_wh_suspendwork;

(n) 案件の遷移再開

案件の遷移再開要求がされた時点で取得されます。

typedef struct BWF_wh_resumecase{
 unsigned char chBFormId;    /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x10) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;     /* 遷移再開案件オブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* 遷移再開ノードID */
 BWF_roleid_t  bBRoleoid;    /* 遷移再開ロールオブジェクトID */
 BWF_useroid_t bBUseroid;    /* 遷移再開案件所持ユーザオブジェクトID */
 BWF_useroid_t bBExecUseroid;  /* 遷移再開実行ユーザオブジェクトID */
 unsigned char chBReserved[82]; /* 予備領域 */
} BWF_wh_resumecase;

(o) ワーク全体の遷移再開

ワーク全体の遷移再開要求がされた時点で取得されます。

typedef struct BWF_wh_resumework{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x11) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_useroid_t bBExecUseroid;   /* 遷移再開実行ユーザオブジェクトID */
 unsigned char chBReserved[114]; /* 予備領域 */
} BWF_wh_resumework;

(p) 案件投入

HwfPutCaseOnBpなどを発行した時点で取得されます。

typedef struct BWF_wh_putcase{
 unsigned char chBFormId;    /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x12) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;     /* 投入案件オブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* 案件投入開始処理ノードID */
 BWF_roleid_t  bBRoleoid;    /* 案件投入ロールオブジェクトID */
 BWF_useroid_t bBExecUseroid;  /* 案件投入ユーザオブジェクトID */
 unsigned char chBReserved[90]; /* 予備領域 */
} BWF_wh_putcase;

(q) ワーク全体の削除

ワーク全体の削除要求がされた時点で取得されます。

typedef struct BWF_wh_cancelwork{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x14) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_useroid_t bBExecUseroid;   /* 遷移中止実行 */
                  /* ユーザオブジェクトID */
 unsigned char chBReserved[114]; /* 予備領域 */
} BWF_wh_cancelwork;

(r) ロールトレーからユーザトレーへの案件取り出し

HwfGetCaseFromRoleを発行した時点で取得されます。

typedef struct BWF_wh_roletouser{
 unsigned char chBFormId;    /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x15) */
 long          lBTime;     / * 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;     /* 遷移案件オブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* ノードID */
 BWF_roleid_t  bBFromRoleoid;  /* 遷移元ロールオブジェクトID */
 BWF_useroid_t bBToUseroid;   /* 遷移先ユーザオブジェクトID */
 BWF_useroid_t bBExecUseroid;  /* 遷移実行ユーザオブジェクトID */
 unsigned char chBReserved[82]; /* 予備領域 */
} BWF_wh_roletouser;

(s) ユーザトレーからロールトレーへの案件返却

HwfGetCaseFromRoleを発行して取得した案件を,ロールトレーに返却した時点で取得されます。

typedef struct BWF_wh_usertorole{
 unsigned char chBFormId;    /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x16) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;     /* 遷移案件オブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* ノードID */
 BWF_useroid_t bBFromUseroid;  /* 遷移元ユーザオブジェクトID */
 BWF_roleid_t  bBToRoleoid;   /* 遷移先ロールオブジェクトID */
 BWF_useroid_t bBExecUseroid;  /* 遷移実行ユーザオブジェクトID */
 unsigned char chBReserved[82]; /* 予備領域 */
} BWF_wh_usertorole;

(t) 他ユーザへの処理依頼

HwfTrustCaseを発行した時点で取得されます。

typedef struct BWF_wh_trustcase{
 unsigned char chBFormId;    /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x17) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;     /* 処理依頼案件オブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* ノードID */
 BWF_roleid_t  bBRoleoid;    /* ロールオブジェクトID */
 BWF_useroid_t chBFromUseroid;  /* 依頼元ユーザオブジェクトID */
 BWF_useroid_t chBToUserUseroid; /* 依頼先ユーザ名称 */
 BWF_useroid_t bBExecUseroid;  /* 処理依頼実行ユーザオブジェクトID */
 unsigned char chBReserved[74]; /* 予備領域 */
} BWF_wh_trustcase;

(u) 相談された案件の回答による案件の遷移

HwfAnswerCaseを発行した時点で取得されます。

typedef struct BWF_wh_answercase{
 unsigned char chBFormId;    /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x18) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;     /* 回答案件オブジェクトID */
 BWF_useroid_t chBFromUseroid;  /* 回答元ユーザオブジェクトID */
 BWF_nodeno_t  bBToNodeId;    /* 回答先ノードID */
 BWF_useroid_t chBToUserUseroid; /* 回答先ユーザオブジェクトID */
 unsigned char chBReserved[90]; /* 予備領域 */
} BWF_wh_answercase;

(v) ユーザ出力メッセージ

HwfPutUserDataToHistoryを発行した時点で取得されます。

typedef struct BWF_wh_putusermessgae{
 unsigned char chBFormId;      /* フォーマットID(0x01) */
 unsigned char chBLogId;      /* ログID(0x19) */
 long          lBTime;       /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;       /* 案件オブジェクトID */
 unsigned char chBUserMessage[97]; /* ユーザ出力メッセージ(最大97バイト) */
 unsigned char chBReserved[17];   /* 予備領域 */
} BWF_wh_putusermessgae;

(w) 他ビジネスプロセス定義への案件連携

案件が,他ビジネスプロセス定義へ連携する時点で取得されます。

なお,このワークヒストリは3レコードにわたって設定されます。

typedef struct BWF_wh_connectbp_first{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x1D) */
 unsigned char chBRecNo;     /* レコード通しID(0x01) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;      /* 連携案件オブジェクトID /
 BWF_nodeno_t  bBFromNodeId;   /* 案件連携元ノードID */
 char          chBBpname[64];   /* 案件連携先BP名称 */
 long          lBpversion;    /* 案件連携先BPバージョン番号 */
 unsigned char chBReserved[37];  /* 予備領域 */
} BWF_wh_connectbp_first;
typedef struct BWF_wh_connectbp_middle{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x1D) */
 unsigned char chBRecNo;     /* レコード通しID(0x02) */
 unsigned char chBConctKind;   /* 連携種別 */
                  /* 連携先部署名(0x01) */
                  /* 連携先サーバ名(0x02) */
char           chbConctName[124]; /* 連携先名称(先頭124バイト) */
} BWF_wh_connectbp_middle;
typedef struct BWF_wh_connectbp_last{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x1D) */
 unsigned char chBRecNo;     /* レコード通しID(0x03) */
 char          chToNodeName[64]; /* 連携先名称(先頭64バイト) */
 unsigned char chBReserved[61];  /* 予備領域 */
} BWF_wh_connectbp_last;

(x) 他ビジネスプロセス定義への案件連携完了

案件が,他ビジネスプロセス定義への連携が完了した時点で取得されます。

なお,このワークヒストリは3レコードにわたって設定されます。

typedef struct BWF_wh_gotoext_first{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;      /* ログID(0x1E) */
 unsigned char chBRecNo;      /* レコード通しID(0x01) */
 long          lBTime;       /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;      /* 連携案件オブジェクトID */
 BWF_nodeno_t  bBFromNodeId;    /* 案件連携元ノードID */
 char          chBBpname[64];   /* 案件連携先BP名称 */
 long          lBpversion;     /* 案件連携先BPバージョン番号 */
 unsigned char chBReserved[37];  /* 予備領域 */
} BWF_wh_gotoext_first;
typedef struct BWF_wh_connectbp_middle{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;      /* ログID(0x1E) */
 unsigned char chBRecNo;      /* レコード通しID(0x02) */
 unsigned char chBConctKind;    /* 連携種別 */
                  /* 連携先部署名(0x01) */
                  /* 連携先サーバ名(0x02) */
char           chbConctName[124]; /* 連携先名称(先頭124バイト) */
} BWF_wh_gotoext_middle;
typedef struct BWF_wh_gotoext_last{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;      /* ログID(0x1E) */
 unsigned char chBRecNo;      /* レコード通しID(0x03) */
 char          chToNodeName[64];  /* 連携先名称(先頭64バイト) */
 unsigned char chBReserved[61];  /* 予備領域 */
} BWF_wh_gotoext_last;

(y) 他ビジネスプロセス定義からの案件の投入

他ビジネスプロセス定義から案件が投入された時点で取得されます。

なお,このワークヒストリは3レコードにわたって設定されます。

typedef struct BWF_wh_putcasefrombp_first{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;      /* ログID(0x2E) */
 unsigned char chBRecNo;      /* レコード通しID(0x01) */
 long          lBTime;       /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;      /* 投入案件オブジェクトID */
 BWF_nodeno_t  bBFromNodeId;    /* 案件投入元ノードID */
 BWF_roleid_t  bBFromRoleoid;   /* 案件投入元ユーザロールオブジェクトID */
 BWF_useroid_t chBFromUseroid;   /* 案件投入元ユーザオブジェクトID */
 BWF_caseid_t  bBFromBpCsoid;   /* 投入元BPでの案件オブジェクトID */
 char          chBFromBpname[64]; /* 案件投入元BP名称 */
 long          lFromBpversion;   /* 案件投入元BPバージョン番号 */
 unsigned char chBReserved[13];  /* 予備領域 */
} BWF_wh_putcasefrombp_first;
typedef struct BWF_wh_putcasefrombp_middle{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;      /* ログID(0x2E) */
 unsigned char chBRecNo;      /* レコード通しID(0x02) */
 unsigned char chBConctKind;    /* 連携種別 */
                  /* 連携元部署名(0x01) */
                  /* 連携元サーバ名(0x02) */
char           chbConctName[124]; /* 連携元名称(先頭123バイト) */
} BWF_wh_putcasefrombp_middle;
typedef struct BWF_wh_putcasefrombp_last{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;      /* ログID(0x2E) */
 unsigned char chBRecNo;      /* レコード通しID(0x03) */
 char          chToNodeName[64];  /* 連携元ノード名称 */
 unsigned char chBReserved[61];  /* 予備領域 */
} BWF_wh_putcasefrombp_last;

(z) 案件を他ビジネスプロセス定義の差し戻しユーザに送信

HwfSendBackCaseによって,他ビジネスプロセス定義のユーザへの案件の差し戻しを要求し,その案件が対応するビジネスプロセス定義の差し戻しユーザに送信された時点で取得されます。

なお,このワークヒストリは3レコードにわたって設定されます。

typedef struct BWF_wh_sendbacktobp_first{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;      /* ログID(0x2F) */
 unsigned char chBRecNo;      /* レコード通しID(0x01) */
 long          lBTime;       /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;      /* 差し戻し案件オブジェクトID */
 BWF_nodeno_t  bBFromNodeId;    /* 差し戻し元ノードID */
 BWF_roleid_t  bBFromRoleoid;   /* 差し戻し元ユーザロールオブジェクトID */
 BWF_useroid_t chBFromUseroid;   /* 差し戻し元ユーザオブジェクトID */
 char          chBToBpname[64];  /* 差し戻し先BP名称 */
 long          lFromBpversion;   /* 差し戻し先BPバージョン番号 */
 unsigned char chBReserved[21];  /* 予備領域 */
} BWF_wh_sendbacktobp_first;
typedef struct BWF_wh_sendbacktobp_middle{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;      /* ログID(0x2F) */
 unsigned char chBRecNo;      /* レコード通しID(0x02) */
 unsigned char chBConctKind;    /* 連携種別 */
                  /* 連携先部署名(0x01) */
                  /* 連携先サーバ名(0x02) */
char           chbConctName[124]; /* 連携先名称(先頭123バイト) */
} BWF_wh_sendbacktobp_middle;
typedef struct BWF_wh_sendbacktobp_last{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;      /* ログID(0x2F) */
 unsigned char chBRecNo;      /* レコード通しID(0x03) */
 char          chToNodeName[64];  /* 連携先ノード名称 */
 unsigned char chBReserved[61];  /* 予備領域 */
} BWF_wh_sendbacktobp_last;

(aa) 案件の差し戻し

HwfSendBackCaseを発行した時点で取得されます。

typedef struct BWF_wh_sendbackcase{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x20) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;      /* 差し戻し案件オブジェクトID */
 BWF_nodeno_t  bBFromNodeId;   /* 差し戻し元ノードID */
 BWF_roleid_t  bBFromRoleoid;   /* 差し戻し元ロールオブジェクトID */
 BWF_useroid_t chBFromUseroid;  /* 差し戻し元ユーザオブジェクトID */
 BWF_nodeno_t  bBToNodeId;    /* 差し戻し先ノードID */
 BWF_roleid_t  bBToRoleoid;    /* 差し戻し先ロールオブジェクトID */
 BWF_useroid_t chBToUseroid;   /* 差し戻し先ユーザオブジェクトID */
 unsigned char chBReserved[66];  /* 予備領域 */
} BWF_wh_sendbackcase;

(ab) 案件の引き戻し

HwfTakeBackCaseを発行した時点で取得されます。

typedef struct BWF_wh_takebackcase{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x21) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_caseid_t  bBCsoid;      /* 引き戻し案件オブジェクトID */
 BWF_nodeno_t  bBToNodeId;    /* 引き戻し先ノードID */
 BWF_roleid_t  bBToRoleoid;    /* 引き戻し先ロールオブジェクトID */
 BWF_useroid_t chBToUseroid;   /* 引き戻し先ユーザオブジェクトID */
 BWF_nodeno_t  bBFromNodeId;   /* 引き戻し元ノードID */
 BWF_roleid_t  bBFromRoleoid;   /* 引き戻し元ロールオブジェクトID */
 BWF_useroid_t chBFromUseroid;  /* 引き戻し元ユーザオブジェクトID */
 unsigned char chBReserved[66];  /* 予備領域 */
} BWF_wh_takebackcase;

(ac) 案件の遷移終了

案件が終了処理ノードに至った時点で取得されます。

typedef struct BWF_wh_endofcase{
 unsigned char chBFormId;     /* フォーマットID(0x01) */
 unsigned char chBLogId;     /* ログID(0x22) */
 long          lBTime;      /* 取得時刻(経過秒) */
 unsigned char chBKindCode;    /* 案件遷移終了種別コード */
                  /* 終了処理(0x01) */
 BWF_caseid_t  bBCsoid;      /* 遷移終了案件オブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* 遷移終了ノードID */
 unsigned char chBReserved[105]; /* 予備領域 */
} BWF_wh_endofcase;

(ad) 相談による案件遷移

HwfRoundCaseを発行した時点で取得されます。

typedef struct BWF_uh_consultcase{
 unsigned char chBLogId;      /* ログID(0x0C) */
 long          lBTime;       /* 取得時刻(経過秒) */
 BWF_bpid_t    bBBpoid;      /* ビジネスプロセスオブジェクトID */
 BWF_nodeno_t  bBNodeId;      /* ノードID */
 BWF_workid_t  bBWkoid;      /* ワークオブジェクトID */
 char          chBUserKey[64];   /* 案件識別子フォーマット */
 BWF_name_t    chBToUserName;   /* 相談先ユーザ名称 */
 BWF_caseid_t  bBCsoid;      /* 相談案件オブジェクトID */
 unsigned char chBReserved[19];  /* 予備領域 */
} BWF_uh_consultcase;

(ae) 案件の遷移要求

HwfGoCaseを発行した時点で取得されます。

typedef struct BWF_uh_gocase{
 unsigned char chBLogId;     /* ログID(0x0D) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_bpid_t    bBBpoid;     /* ビジネスプロセスオブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* ノードID */
 BWF_workid_t  bBWkoid;     /* ワークオブジェクトID */
 char          chBUserKey[64];  /* 案件識別子フォーマット */
 BWF_caseid_t  bBCsoid;     /* 遷移案件オブジェクトID */
 unsigned char chBReserved[27]; /* 予備領域 */
} BWF_uh_gocase;

(af) 案件の投入

HwfPutCaseOnBusinessProcessを発行した時点で取得されます。

typedef struct BWF_uh_putcase{
 unsigned char chBLogId;     /* ログID(0x12) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_bpid_t    bBBpoid;     /* ビジネスプロセスオブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* ノードID */
 BWF_workid_t  bBWkoid;     /* 投入ワークオブジェクトID */
 char          chBUserKey[64];  /* 案件識別子フォーマット */
 BWF_caseid_t  bBCsoid;     /* 投入案件オブジェクトID */
 unsigned char chBReserved[27]; /* 予備領域 */
} BWF_uh_putcase;

(ag) 相談された案件の回答による案件の遷移

HwfAnswerCaseを発行した時点で取得されます。

typedef struct BWF_uh_answercase{
 unsigned char chBLogId;     /* ログID(0x18) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_bpid_t    bBBpoid;     /* ビジネスプロセスオブジェクトID */
 BWF_nodeno_t  bBNodeId;     /* ノードID */
 BWF_workid_t  bBWkoid;     /* 回答案件のワークオブジェクトID */
 char          chBUserKey[64];  /* 案件識別子フォーマット */
 BWF_name_t    chBToUserName;  /* 回答先ユーザ名称 */
 BWF_caseid_t  bBCsoid;     /* 回答案件オブジェクトID */
 unsigned char chBReserved[19]; /* 予備領域 */
} BWF_uh_answercase;

(ah) 案件の差し戻し

HwfSendBackCaseを発行した時点で取得されます。

typedef struct BWF_uh_sendbackcase{
 unsigned char chBLogId;     /* ログID(0x20) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_bpid_t    bBFromBpoid;   /* 差し戻し元ビジネスプロセスオブジェクトID */
 BWF_nodeno_t  bBFromNodeId;   /* 差し戻し元ノードID */
 BWF_workid_t  bBWkoid;     /* 差し戻し案件のワークオブジェクトID   */
 char          chBUserKey[64];  /* 差し戻し案件の案件識別子フォーマット */
 BWF_name_t    chBToUserName;  /* 差し戻し先ユーザ名称 */
 BWF_caseid_t  bBCsoid;     /* 差し戻し案件オブジェクトID */
 BWF_nodeno_t  bBToNodeId;    /* 差し戻し先ノードID */
 unsigned char chBReserved[11]; /* 予備領域 */
} BWF_uh_sendbackcase;

(ai) 案件の引き戻し

HwfTakeBackCaseを発行した時点で取得されます。

typedef struct BWF_uh_takebackcase{
 unsigned char chBLogId;     /* ログID(0x21) */
 long          lBTime;      /* 取得時刻(経過秒) */
 BWF_bpid_t    bBFromBpoid;   /* 引き戻し元ビジネスプロセスオブジェクトID */
 BWF_nodeno_t  bBFromNodeId;   /* 引き戻し元ノードID */
 BWF_workid_t  bBWkoid;     /* 引き戻し案件のワークオブジェクトID */
 char          chBUserKey[64];  /* 引き戻し案件の案件識別子フォーマット */
 BWF_name_t    chBToUserName;  /* 引き戻し先ユーザ名称 */
 BWF_caseid_t  bBCsoid;     /* 引き戻し案件オブジェクトID */
 BWF_nodeno_t  bBToNodeId;    /* 引き戻し先ノードID */
 unsigned char chBReserved[11]; /* 予備領域 */
} BWF_uh_takebackcase;

(aj) ヒストリデータ変換エラーメッセージ文と原因
ヒストリデータ変換
エラーメッセージ文
原因
案件名称を取得できませんでしたヒストリデータ内に設定されている,案件オブジェクトIDに対応する案件がないため,案件名称を取得できません(案件オブジェクトIDに対応する案件が,既に削除されているか,同報ノードで複写されて,回収ノードで回収されているおそれがあります)。
上位案件のため,名称を取得できませんでしたヒストリデータ内に設定されている案件オブジェクトIDに対応する案件の階層種別が,ルート(上位)案件のため,案件名称が取得できません(詳細については,HwfGetWorkHistory,又はHwfGetHistoryを参照してください)。
ユーザ名称を取得できませんでしたユーザオブジェクトIDに対応するユーザが削除されているか,ワークヒストリの「案件のノード間遷移」で対応する案件の遷移するノードの配布種別が「自動配布なし」の場合,遷移先ユーザオブジェクトIDに何も設定されないため,ユーザ名称が取得できません(詳細については,HwfGetWorkHistory,又はHwfGetHistoryを参照してください)。
案件識別子フォーマットを取得できませんでしたHwfPutCaseOnBusinessProcessで,案件を投入した場合に,案件識別子フォーマット(ワークID)が指定されていないため,案件識別子フォーマット(ワークID)が取得できませんでした。
ロール名称を取得できませんでしたロールオブジェクトIDに対応するロールが削除されているか,ワークヒストリの「案件のノード間遷移」で対応する案件の遷移するノードの配布種別が「自動配布あり」の場合,遷移先ロールオブジェクトIDに何も設定されないため,ロール名称が取得できません(詳細については,HwfGetWorkHistory,又はHwfGetHistoryを参照してください)。
ビジネスプロセス定義名称を取得できませんでしたビジネスプロセスオブジェクトIDに対応するビジネスプロセスが削除されているため,ビジネスプロセス定義名称が取得できません。
ノード名称を取得できませんでしたノードIDに対応するノードが削除されているため,ノード名称が取得できません。
ユーザ任意情報を取得できませんでしたHwfPutUserDataToHistoryで,ユーザ任意情報に0バイトデータ(NULL文字だけ)が指定されたため,ユーザ任意情報が取得できませんでした。

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

(a) HwfGetObjectAttribute(オブジェクト属性情報取得)

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

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

#include<bwf.h>
long HwfGetObjectAttribute(
 BWF_useroid_t __far *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,     /* サーバ名称格納領域 (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_bplist2_t{
 BWF_bpid_t     BWF_bp_oid;          /* ビジネスプロセス定義オブジェクトID */
 char           BWF_bp_bp_name[64];      /* ビジネスプロセス定義名 */
 char           BWF_bp_create_name[8];     /* 作成者 */
 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];      /* コメント */
 unsigned long  BWF_bp_process_limit_time;   /* 案件処理期間  */
} BWF_bplist2_t;
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];    /* メッセージ区分 */
 long lBMsgNo;      /* メッセージ番号 */
 char sBInsWord[13];   /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
objectkind
属性情報を取得するオブジェクトの種別を指定します。
BWF_BP_OBJECT:ビジネスプロセス
BWF_BP2_OBJECT:ビジネスプロセス(案件処理期間を含む)
BWF_WORK_OBJECT:ワーク
BWF_CASE_OBJECT:案件
BWF_ROLE_OBJECT:ロール
BWF_USER_OBJECT:ユーザ
oidlistn
属性を取得するオブジェクトのオブジェクトID数を指定します。
oidlist
属性情報を取得するオブジェクトのオブジェクトIDを格納した配列領域を指定します。oidlistに指定するオブジェクトIDは,objectkindに指定した種別によって,その取得する関数が異なります。
objectkindと,該当するオブジェクトID,及びそのオブジェクトIDを取得できる主なAPI関数を次に示します。
objectkindオブジェクトID取得関数
BWF_BP_OBJECTHwfGetBusinessProcess
HwfGetWorkAttribute
HwfGetWorkAttributeSelectStatus
BWF_BP2_OBJECTHwfGetBusinessProcess
HwfGetWorkAttribute
HwfGetWorkAttributeSelectStatus
BWF_WORK_OBJECTHwfGetWorkAttribute
HwfGetWorkAttributeSelectStatus
BWF_CASE_OBJECTHwfGetCase
HwfGetCaseSelectData
BWF_ROLE_OBJECTHwfGetRole
HwfGetRoleAnd
BWF_USER_OBJECTHwfGetUser
HwfGetUserAnd
attrtable
objectkindの指定によって,属性情報取得領域の型は次に示す型を指定します。
objectkind
BWF_BP_OBJECTBWF_bplist_t
BWF_BP2_OBJECTBWF_bplist2_t
BWF_WORK_OBJECTBWF_worklist_t
BWF_CASE_OBJECTBWF_caselist_t
BWF_ROLE_OBJECTBWF_rolelist_t
BWF_USER_OBJECTBWF_userlist_t
上記の型で示した領域で取得される項目について次に示します。
BWF_bplist_tで取得される項目については,ビジネスプロセス定義リスト内項目を参照してください。
BWF_bplist2_tで取得される項目については,ビジネスプロセス定義リスト(案件処理期間を含む)内項目を参照してください。
BWF_worklist_tで取得される項目については,ワーク属性リスト内項目を参照してください。
BWF_caselist_tで取得される項目については,上位案件項目リスト内項目を参照してください。
BWF_rolelist_tで取得される項目については,ロール属性リスト内項目を参照してください。
BWF_userlist_tで取得される項目については,ユーザ属性リスト内項目を参照してください。
必ず,objectkindに指定したオブジェクト種別に対応するデータ型の領域をoidlistnに指定した要素数分以上取得して指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • oidlistに指定したオブジェクトIDに一つでも存在しないものが指定されていた場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • oidlistに指定したオブジェクトIDとobjectkindに指定したオブジェクトの種別が対応していない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
(b) ビジネスプロセス定義リスト(案件処理期間を含む)内項目
項目内容
BWF_bp_oidビジネスプロセス定義オブジェクトIDが設定されます。
BWF_bp_bp_nameBWF_bp_oidに対応するビジネスプロセス定義名称が設定されます。
BWF_bp_create_nameBWF_bp_oidに対応するビジネスプロセス定義を登録したユーザのユーザ名称が設定されます。
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ビジネスプロセス定義を作成したときに記述したコメントが設定されます。
BWF_bp_process_limit_timeBWF_bp_oidに対応するビジネスプロセス定義での,案件投入から処理終了までの相対的な経過秒である処理期間が設定されます(ビジネスプロセス定義で設定されていない場合,0が設定されます)。投入日時(1970/01/01 00:00:00(GMT)からの経過秒)に処理期間を加えることで,処理期限(1970/01/01 00:00:00(GMT)からの経過秒)が算出できます。

(13) 先読み操作AP関数(互換用)

(a) HwfNotifyPriority(文書/メモ(画像/音声)の先読み方法指示)

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

機能
ユーザトレー内に存在する案件に格納された文書を先読みするときの指示をします。
HwfGetCase,又はHwfGetCaseSelectDataで取得した上位(単独だけ対象)/下位案件属性リストに設定されている案件内の文書を先読みの対象として,先読み方法を指示するとともに,指定された範囲の文書の先読みもします。
ここで指定された情報を基に,HwfPreReadを発行して,文書を先読みします。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfNotifyPriority(
 BWF_useroid_t __far *useroid,     /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far *server,      /* サーバ名称格納領域 (I) */
 long                rangemode,     /* 先読み対象 (I) */
 long                rangepages,    /* 先頭からの先読み対象文書数 (I) */
 long                readmode,     /* 先読み単位 (I) */
 long                readpages,     /* 先読み文書数 (I) */
 BWF_errlist_t __far *errlist      /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];    /* メッセージ区分 */
 long lBMsgNo;      /* メッセージ番号 */
 char sBInsWord[13];   /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
rangemode
上位(単独)/下位案件属性リストに設定されている文書を先読みする場合,対象とする文書を指定します。
BWF_DEFAULT:動作パラメタファイル(WINDOWSディレクトリ下のFLOWMATE.INI)の指定に従います。
BWF_ALL_PAGES:上位(単独)/下位案件属性リストに設定されている各案件の全文書を先読み対象とします。
BWF_TOP_PAGES:上位(単独)/下位案件属性リストに設定されている各案件の先頭文書から,rangepagesで指定した文書数分を先読み対象とします。
BWF_NO_PREREAD:先読みしません。
rangepages
reqmodeにBWF_TOP_PAGESを指定した場合に,各案件で先読み対象とする文書数を先頭文書からの文書数で指定します。指定できる範囲は1~5です。
readmode
rangemodeにBWF_ALL_PAGES,又はBWF_TOP_PAGESを指定した場合に,一度に先読みする範囲を指定します。
以降,HwfNotifyPriority,及びHwfPreReadを発行した場合,ここで指定した範囲に従って文書を先読みします。
BWF_PR_ALL:各案件の先読み対象文書すべてを先読みします。
BWF_PR_PAGES:readpagesで指定した文書数を先読みします。
readpages
先読みする文書数を指定します。
reqmodeにBWF_PR_PAGESを指定した場合の先読みをする文書数を指定します。
指定できる範囲は1~2です。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • ・このAPI関数を発行する直前に必ずHwfGetCase,又はHwfGetCaseSelectDataを発行してください。また,HwfGetCase,又はHwfGetCaseSelectDataで上位(単独だけ対象)/下位案件属性リストを取得しないと,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
    なお,直前に発行したHwfGetCase,又はHwfGetCaseSelectDataの結果が次に示す状態の場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となりますので注意してください。
  • reqmodeにBWF_TOP_CASEを指定して,HwfGetCase,又はHwfGetCaseSelectDataを発行した結果が正常終了,かつtcaselist内の情報がすべてルート案件の場合。
  • reqmodeにBWF_TOP_CASEを指定して,HwfGetCase,又はHwfGetCaseSelectDataを発行した結果が正常終了,かつtcountが0の場合。
  • reqmodeにBWF_ALL_CASEを指定して,HwfGetCase,又はHwfGetCaseSelectDataを発行した結果が正常終了,かつtcount,bcountが0の場合。
  • reqmodeに関係なく,HwfGetCase,又はHwfGetCaseSelectDataを発行した結果がエラーリターンした場合。
(b) HwfPreRead(案件内文書/メモ(画像/音声)の先読み要求)

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

機能
HwfNotifyPriorityで指定した先読み方法に従い,文書/メモ(画像/音声)を先読みします。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfPreRead(
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン

(14) トランザクション操作AP関数(互換用)

(a) HwfCommitTransaction(トランザクションのコミット)

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

機能
次に示す範囲内で,案件に行った処理(案件下の文書,メモも含みます)をコミットします。
  • 案件生成(HwfCreateCase)からビジネスプロセスの指定バージョンへの案件投入(HwfPutCaseOnBusinessProcess)。
  • 案件に対するユーザ処理開始(HwfActCase),又は案件に対するユーザ処理開始と文書,メモの排他(HwfActCaseWithDocLock)から案件に対するユーザ処理中止(HwfDeactCase)。
  • 案件に対するユーザ処理開始(HwfActCase),又は案件に対するユーザ処理開始と文書,メモの排他(HwfActCaseWithDocLock)から案件に対するユーザ処理保留(HwfPauseCase)。
  • 案件に対するユーザ処理開始(HwfActCase),又は案件に対するユーザ処理開始と文書,メモの排他(HwfActCaseWithDocLock)から案件の次ノードへの遷移要求(HwfGoCase)。
  • 案件に対するユーザ処理開始(HwfActCase),又は案件に対するユーザ処理開始と文書,メモの排他(HwfActCaseWithDocLock)から他ユーザへの案件の相談(HwfRoundCase)。
  • 案件に対するユーザ処理開始(HwfActCase),又は案件に対するユーザ処理開始と文書,メモの排他(HwfActCaseWithDocLock)から他ユーザからの相談された案件の回答(HwfAnswerCase)。
  • 案件に対するユーザ処理開始(HwfActCase),又は案件に対するユーザ処理開始と文書,メモの排他(HwfActCaseWithDocLock)から案件の差戻し要求(HwfSendBackCase)。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfCommitTransaction(
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどれかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(b) HwfRollbackTransaction(トランザクションのロールバック)

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

機能

次に示す範囲内で,案件に行った処理(案件下の文書,メモも含みます)をロールバックします。

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

#include<bwf.h>
long HwfRollbackTransaction(
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。

戻り値

BWF_OK:正常リターン

BWF_ERROR:エラーリターン

注意事項
  • HwfActCase,又はHwfActCaseWithDocLock,HwfCreateCaseのどれかを発行後,次に示すAPI関数を発行するとコミットが発生します(以降,このAPI関数を発行しても,次に示すAPI関数発行後の時点までしかロールバックしないので注意してください)。
  • HwfGetUser
  • HwfGetUserAnd
  • HwfGetBusinessProcess
  • HwfGetRole
  • HwfGetRoleAnd
  • HwfGetWorkAttribute
  • HwfSetWorkTerm
  • HwfSetWorkPriority
  • HwfGetWorkAttributeSelectStatus
  • HwfGetCaseFromRole
  • HwfPutCaseFromUser
  • HwfGetCaseForm
  • HwfGetCaseFormSelect
  • HwfGetCase
  • HwfGetOperation
  • HwfGetBackUserList
  • HwfGetCaseSelectData
  • HwfSetHistory
  • HwfPutUserDataToHistory
  • HwfPutHistoryMsg
  • ・HwfGetObjectAttribute(objectkindにBWF_CASE_OBJECT以外を指定した場合)
  • HwfTakeOperationInf
  • HwfCreateCopyInf

(15) その他AP関数(互換用)

(a) HwfMemoryToFile(文書,メモ実体のファイル出力)

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

機能
HwfGetObjectInstance,HwfGetMemoによって取得した文書,メモ実体を指定されたファイルに出力します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfMemoryToFile(
 BWF_useroid_t __far  *useroid,  /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far  *server,   /* サーバ名称格納領域 (I) */
 void          __huge **instance, /* 文書,メモ取得領域ポインタ格納領域 (I) */
 unsigned long        size,    /* 文書,メモサイズ格納領域 (I) */
 BWF_doclist_t __far  *outfile,  /* 文書,メモ実体出力パス,ファイル名称格納領域 (I) */
 BWF_errlist_t __far  *errlist   /* エラー情報取得領域 (O) */
);
typedef struct BWF_errlist_t{
 char sBMsgKbn[6];   /* メッセージ区分 */
 long lBMsgNo;     /* メッセージ番号 */
 char sBInsWord[13];  /* 挿入語句 */
} BWF_errlist_t;

パラメタの説明
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
instance
HwfGetObjectInstance,及びHwfGetMemoで取得した文書,メモ実体取得領域ポインタを格納した領域を指定します。
size
HwfGetObjectInstance,及びHwfGetMemoで取得した文書,メモ実体のサイズを指定します。
outfile
HwfGetObjectInstance,及びHwfGetMemoで取得した文書,メモ実体を出力するファイルのドライブ名,ファイルのパス,及びファイル名称を格納した領域を指定します。
ドライブ名,ファイルのパス,及びファイル名称は,終端にNULL文字を付けた128バイト以内で指定してください。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を取得する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • このAPI関数を発行する場合,事前にHwfGetObjectInstance,及びHwfGetMemoを必ず発行してください。
  • instanceで指定した文書,及びメモが存在する案件に対して次に示すAPI関数発行後に,このAPI関数を発行した場合,instanceで指定した文書,メモ実体が不定になるため,戻り値はエラーリターン(BWF_ERROR)となります。
  • HwfPauseCase
  • HwfDeactCase
  • HwfGoCase
  • HwfRoundCase
  • HwfAnswerCase
  • HwfSendBackCase
  • outfileで指定したファイルが既に存在した場合は,そのファイルにHwfGetObjectInstance,及びHwfGetMemoで取得した文書,メモ実体を上書きしますので注意してください。
(b) HwfGetFileUpdateTime(サーバ側ファイルの最終更新日時取得)

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

機能
指定されたサーバ側ファイルの最終更新日時(最新日時)を取得します。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

#include<bwf.h>
long HwfGetFileUpdateTime(
 BWF_useroid_t __far  *useroid,    /* ユーザオブジェクトID格納領域 (I) */
 BWF_server_t  __far  *server,     /* サーバ名称格納領域 (I) */
 unsigned long        sdirmode,    /* サーバ側ファイルディレクトリモード格納領域 (I) */
 char          __far  *sfilename,   /* サーバ側任意ファイルパス格納領域 (I) */
 unsigned long        timemode,    /* サーバ側ファイル日時取得モード格納領域 (I) */
 void          __far  *updatetime,
                    /* サーバ側ファイル日時取得領域 (O) */
 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
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
sdirmode
サーバ側ファイルの格納ディレクトリのモードを指定します。
BWF_SERVER_CONFIG_MODE:Groupmax Workflow Serverの環境定義情報に指定した,ディレクトリに存在するsfilenameに指定されたファイルを対象とします。
BWF_USER_OPTION_MODE:sfilenameに指定された任意のディレクトリのファイルを対象とします。
sfilename
modeにBWF_SERVER_CONFIG_MODEを指定した場合,サーバ側のファイル名称だけを格納した領域を指定してください。
modeにBWF_USER_OPTION_MODEを指定した場合,サーバ側の任意のディレクトリとファイル名称を格納した領域を指定してください。
なお,ファイル名称,又は任意のディレクトリとファイル名称は,終端にNULL文字を付けてください。
timemode
sfilenameに指定された,サーバ側ファイルの最終更新日時(最新日時)をupdatetimeに取得する場合のデータ形式を指定します。
BWF_YMDHMS_MODEYYYYMMDDhhmmss形式で取得します。
BWF_TIME_MODE:1970/01/01 00:00:00(GMT)から経過秒として取得します。
updatetime
timemodeにBWF_YMDHMS_MODEを指定した場合,14バイト以上の領域を指定してください。
timemodeにBWF_TIME_MODEを指定した場合,4バイト以上の領域を指定してください(なお,余った場合,その部分にはNULL文字を設定します)。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
(c) HwfDownLoadFile(サーバからのファイルダウンロード)

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

機能
サーバからクライアントへ,指定されたファイルをダウンロードします。
使用できるユーザ
ドメイン管理者,ワークフロー運用管理者,ビジネスプロセス管理者,一般ユーザが使用できます。
構文

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

パラメタの説明
useroid
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで取得したユーザオブジェクトIDを格納した領域を指定します。
server
HwfLoginWorkflow,又はHwfGmLoginWorkflowのどちらかで指定,又は取得したサーバ名称を格納した領域を指定します。サーバ名称は,終端にNULL文字を付けた9バイト以内の文字列で指定してください。
mode
ダウンロードするサーバ側ファイルの格納ディレクトリのモードを指定します。
BWF_SERVER_CONFIG_MODE:Groupmax Workflow Serverの環境定義情報に指定したディレクトリから,sfilenameに指定されたファイルをダウンロードします。
BWF_USER_OPTION_MODE:sfilenameに指定された任意のディレクトリのファイルをダウンロードします。
sfilename
modeにBWF_SERVER_CONFIG_MODEを指定した場合,サーバ側のファイル名称だけを格納した領域を指定します。
modeにBWF_USER_OPTION_MODEを指定した場合,サーバ側の任意のディレクトリとファイル名称を格納した領域を指定します。
なお,ファイル名称,又は任意のディレクトリとファイル名称は,終端にNULL文字を付けてください。
cfilename
ダウンロードするファイルを格納する,クライアント側のファイル名称を格納した領域を指定します。
Groupmax Workflow Clientのセットアップで,「AP起動ファイルの格納ディレクトリ」で指定したディレクトリ上に,指定されたファイルを作成します(「AP起動ファイルの格納ディレクトリ」に指定されたディレクトリが存在しない場合は,自動的に生成します)。
また,NULLを指定した場合,sfilenameに指定されたファイル名称を仮定します(ただし,sfilenameに指定されたファイル名称が12バイト以上の場合,終端のNULL文字を含めないで,先頭の12バイトをファイル名称とします)。
errlist
このAPI関数がエラーリターンした場合に,エラー情報を格納する領域を指定します。
戻り値
BWF_OK:正常リターン
BWF_ERROR:エラーリターン
注意事項
  • Groupmax Workflow Clientセットアップで,「AP起動ファイルの格納ディレクトリ」が指定されていない場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • cfilenameに指定したダウンロードするファイルを格納する,クライアント側のファイル名称が不当な(8.3形式(ファイル名.拡張子)に沿っていない)場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。
  • cfilenameにNULLを指定した場合,sfilenameに指定されたファイル名称を仮定しますが,そのファイル名称が不当な(8.3形式(ファイル名.拡張子)に沿っていない)場合,このAPI関数の戻り値はエラーリターン(BWF_ERROR)となります。