最近のアクセス：
WorkflowServer データタイプ

Server オブジェクトは、ワークフローエンジンのセッションを表します。ワークフローとやり取りし、他のオブジェクトへの入力点として機能します。

プロパティ

プロパティ タイプ アクセス 説明
Session Character 読み取り セッション
AutoCommit (非推奨) (*) Boolean 書き込み True に設定すると、トランザクションが、コミットを要求するプロパティやメソッドで制御されます。False に設定すると、アプリケーションでトランザクションが制御されます。
AutoRebuildWorklists Boolean 書き込み True に設定すると、組織の構造が変わったときに、関係のあるユーザーの作業リストがエンジンによって自動的にリビルドされます。False に設定すると、作業リストは自動的にリビルドされません。
ConnectedUser WorkflowUser 読み取り エンジンに接続しているユーザーを返します。
Error WorkflowError 読み取り エラーコード
Settings WorkflowSettings (Collection) 読み取り ワークフローサーバー設定のコレクションを返します。

(*) X バージョンの API は既定ではコミットしません。

メソッド

  • Connect
ワークフローエンジンとやり取りする有効なセッションを取得します。
Connect (user, password)
名前 タイプ 動作 説明
User Character 入力 ユーザー ID
Password Character 入力 ユーザーパスワード
 
  • Disconnect
Connect メソッドで作成した接続を終了します。
Disconnect ()
 
  • ListProcessDefinitionsOrderBy
指定したフィルタに一致するプロセス定義を指定した順番に並べたコレクションを返します。
ListDocumentDefinitionsOrderBy (filter, order): Collection (WorkflowProcessDefinition)
 
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: Name、User 入力 フィルタ
Order Numeric (WorkflowOrder.ID_ASC, WorkflowOrder.ID_DESC, WorkflowOrder.NAME_ASC, WorkflowOrder.NAME_DESC) 入力 順序
  
  • ListProcessDefinitions
指定したフィルタに一致するプロセス定義のコレクションを返します。
ListProcessDefinitions (filter): Collection (WorkflowProcessDefinition)
 
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: Name、User 入力 フィルタ
  
  • ListActivitiesOrderBy
指定したフィルタに一致するアクティビティを指定した順番に並べたコレクションを返します。
ListActivitiesOrderBy (filter, order) : Collection (WorkflowActivity)
 
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: ProcessDefinition、Name、Role、User 入力 フィルタ
Order Numeric (WorkflowOrder.ID_ASC, WorkflowOrder.ID_DESC, WorkflowOrder.NAME_ASC, WorkflowOrder.NAME_DESC) 入力 順序
例
&workflowserver = new()
&workflowserver.Connect(!"WFADMINISTRATOR", !"WFADMINISTRATOR")

&workflowerror = &workflowserver.Error
If &workflowerror.Code > 0
    msg(format(!"code:%1 %2", &workflowerror.Code, &workflowerror.Message),Status)
    return
EndIf
&ProcessDefinition = &workflowserver.GetProcessDefinitionByName(!"SampleName")
&Filter.ProcessDefinition = &ProcessDefinition
&Activities = &workflowserver.ListActivitiesOrderBy(&Filter, WorkFlowOrder.NAME_ASC) // Order by Task Name
for &Activity in &Activities
  msg(format(!"%2 %1", &Activity.Name, &Activity.Id), status)
endfor
  • GetActivityById
プロセスとアクティビティの識別子が、指定したものと同じアクティビティオブジェクトを返します。
GetActivityById (processDefinitionId, activityId) : WorkflowActivity 
名前 タイプ 動作 説明
ProcessDefinitionId Numeric 入力 プロセス定義の識別子
ActivityId Numeric 入力 アクティビティの識別子
 
  • GetActivityByName
指定した名前と同じ名前を持つ最初のアクティビティのオブジェクトを返します。
GetActivityByName (name): WorkflowActivity
名前 タイプ 動作 説明
Name Character 入力 アクティビティ名
 
  • GetBusinessEventById
指定した識別子と同じ識別子を持つビジネス イベント オブジェクトを返します。
GetBusinessEventById (id, ProcessDefinitionId): WorkflowBusinessEvent 
名前 タイプ 動作 説明
Id Numeric 入力 ビジネスイベントの識別子
ProcessDefinitionId Numeric 入力 プロセス定義の識別子
 
  • GetBusinessEventByName
指定した名前と同じ名前を持つ最初のビジネス イベント オブジェクトを返します。
GetBusinessEventById (name): WorkflowBusinessEvent 
名前 タイプ 動作 説明
Name Character 入力 ビジネスイベントの名前
 
  • GetBusinessEventInstanceById
指定した識別子と同じ識別子を持つビジネス イベント インスタンス オブジェクトを返します。
GetBusinessEventById (id): WorkflowBusinessEventInstance
名前 タイプ 動作 説明
Id Numeric 入力 ビジネス イベント インスタンスの識別子
 
  • GetDocumentRepository
ドキュメント リポジトリ オブジェクトを返します。
GetDocumentRepository () : WorkflowDocumentRepository
 
  • GetEventRepository
イベント リポジトリ オブジェクトを返します。
GetEventRepository () : Workflow Event Repository
 
  • GetOrganizationalModel
組織モデルオブジェクトを返します。
GetOrganizationalModel () : WorkflowOrganizationalModel
 
  • GetProcessDefinitionById
指定した識別子と同じ識別子を持つプロセス定義オブジェクトを返します。
GetProcessDefinitionById (id) : WorkflowProcessDefinition
名前 タイプ 動作 説明
Id Numeric 入力 プロセス定義の識別子
 
  • GetProcessDefinitionByName
指定した名前と同じ名前を持つ最初のプロセス定義オブジェクトを返します。
GetProcessDefinitionByName (name) : WorkflowProcessDefintion 
名前 タイプ 動作 説明
Name Character 入力 プロセス定義の名前
 
  • GetProcessInstanceById
指定した識別子と同じ識別子を持つプロセス インスタンス オブジェクトを返します。
GetProcessInstanceById (id): WorkflowProcessInstance
名前 タイプ 動作 説明
Id Numeric 入力 プロセスインスタンスの識別子
 
  • GetProcessInstanceBySubject
指定したサブジェクトと同じサブジェクトを持つ最初のプロセス インスタンス オブジェクトを返します。
GetProcessInstanceSubject (subject): WorkflowProcessInstance
名前 タイプ 動作 説明
Subject Character 入力 プロセスインスタンスのサブジェクト
 
  • GetWorkitemById
指定した識別子と同じ識別子を持つ作業項目オブジェクトを返します。
GetWorkitemById (id): WorkflowWorkitem
名前 タイプ 動作 説明
Id Numeric 入力 作業項目の識別子
 
  • ListActivities
指定したフィルタに一致するアクティビティのコレクションを返します。
ListActivities (filter) : Collection (WorkflowActivity)
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: ProcessDefinition、Name、Role、User 入力 フィルタ
 
  •  
  • ListBusinessEventInstances
指定したフィルタに一致するビジネス イベント インスタンスのコレクションを返します。
 ListBusinessEventInstances (filter) : Collection (WorkflowEventInstance)
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: User、ProcessDefinition、ProcessInstance、Subject、CreatedFrom、CreatedTo、EndedFrom、EndedTo 入力 フィルタ
 
  • ListBusinessEventInstancesOrderBy
指定したフィルタに一致するビジネス イベント インスタンスを指定した順番に並べたコレクションを返します。
 ListBusinessEventInstances (filter,order) : Collection (WorkflowEventInstance)
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: User、ProcessDefinition、ProcessInstance、Subject、CreatedFrom、CreatedTo、EndedFrom、EndedTo 入力 フィルタ
Order   入力 順序
 
  • ListBusinessEvents
指定したフィルタに一致するビジネスイベントのコレクションを返します。
 ListBusinessEvent (filter) : Collection (WorkflowEvent)
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: User、ProcessDefinition、ProcessInstance、Subject、CreatedFrom、CreatedTo、EndedFrom、EndedTo 入力 フィルタ
 
  • ListBusinessEventOrderBy
指定したフィルタに一致するビジネスイベントを指定した順番に並べたコレクションを返します。
 ListBusinessEventsOrderBy (filter,order) : Collection (WorkflowEvent)
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: User、ProcessDefinition、ProcessInstance、Subject、CreatedFrom、CreatedTo、EndedFrom、EndedTo 入力 フィルタ
Order   入力 順序
 
  • ListCalendars
指定したフィルタに一致するカレンダーのリストを返します。
ListCalendars (filter) : Collection (WorkflowCalendar)
 
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: Name、Calendar 入力 フィルタ
 
  • ListCalendarsOrderBy
指定したフィルタに一致するカレンダーを指定した順番に並べたリストを返します。
ListCalendarsOrderBy(filter,order) : Collection (WorkflowCalendar)
 
名前 タイプ 動作 説明
Filter WorkflowFilter 入力 フィルタ
Order  WorkflowFilter、有効なフィルタ: Name、Calendar 入力 順序
 
  • ListProcessInstances
指定したフィルタに一致するプロセスインスタンスのコレクションを返します。
ListProcessInstances (filter) : Collection (WorkflowProcessInstance) 
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: From、To、ProcessDefinition、User、Priority、WithWarning、Subject、State、Relevant Data 入力 フィルタ
 
  • ListProcessInstancesOrderBy
指定したフィルタに一致するプロセスインスタンスを指定した順番に並べたコレクションを返します。
ListProcessInstances (filter, order) : Collection (WorkflowProcessInstance) 
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: From、To、ProcessDefinition、User、Priority、WithWarning、Subject、State 入力 フィルタ
Order Numeric (WorkflowOrder.ID_ASC、WorkflowOrder.ID_DESC、WorkflowOrder.CREATED_ASC、WorkflowOrder.CREATED_DESC、WorkflowOrder.PRIORITY_ASC、WorkflowOrder.PRIORITY_DESC、WorkflowOrder.STATE_ASC、WorkflowOrder.STATE_DESC、WorkflowOrder.WITH_WARNING_ASC、WorkflowOrder.WITH_WARNING_DESC、WorkflowOrder.SUBJECT_ASC、WorkflowOrder.SUBJECT_DESC、WorkflowOrder.ENDED_ASC、WorkflowOrder.ENDED_DESC) 入力 順序
 
  • ListWorkitems
指定したフィルタに一致する作業項目のコレクションを返します。
ListWorkitems (filter) : Collection (WorkflowWorkitem) 
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: From、To、ProcessInstance、Subject、ProcessDefinition、Activity、User、Priority、WithWarning、State、Relevant Data 入力 フィルタ
 
  • ListWorkitemOrderBy
指定したフィルタに一致する作業項目を指定した順番に並べたコレクションを返します。
ListWorkitems (filter, order) : Collection (WorkflowWorkitem) 
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: From、To、ProcessInstance、Subject、ProcessDefinition、Activity、User、Priority、WithWarning、State 入力 フィルタ
Order Numeric (WorkflowOrder.ID_ASC、WorkflowOrder.ID_DESC、WorkflowOrder.CREATED_ASC、WorkflowOrder.CREATED_DESC、WorkflowOrder.PRIORITY_ASC、WorkflowOrder.PRIORITY_DESC、WorkflowOrder.STATE_ASC、WorkflowOrder.STATE_DESC、WorkflowOrder.WITH_WARNING_ASC、WorkflowOrder.WITH_WARNING_DESC、WorkflowOrder.SUBJECT_ASC、WorkflowOrder.SUBJECT_DESC、WorkflowOrder.ENDED_ASC、WorkflowOrder.ENDED_DESC) 入力 順序
  • ListConnectedUsers
エンジンに接続しているユーザーのうち、指定したフィルタに一致するユーザーのコレクションを返します。
ListConnectedUsers(filter) : Collection (WorkflowUser)
 
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: Name、User 入力 フィルタ
 
  • ListConnectedUsersOrderBy
エンジンに接続しているユーザーのうち、指定したフィルタに一致するユーザーを指定した順番に並べたコレクションを返します。
ListConnectedUsersOrderBy(filter,order) : Collection (WorkflowUser)
 
名前 タイプ 動作 説明
Filter WorkflowFilter、有効なフィルタ: Name、User 入力 フィルタ
Order Numeric (WorkflowOrder.USER_ASC、WorkflowOrder.USER_DESC、WorkflowOrder.NAME_ASC、WorkflowOrder.NAME_DESC ) 入力 順序
 
  • GetSettingById
このメソッドでは、指定した識別子と同じ識別子を持つワークフロー設定を返します。
GetSettingById (Id) : WorkflowSetting
名前 タイプ 動作 説明
Id WorkflowSettingId 入力 ワークフロー設定の識別子

 

参考情報



サブページ
Created: 14/09/18 03:05 by Admin Last update: 21/05/21 06:13 by Admin
カテゴリ
Powered by GXwiki 3.0