<< Click to Display Table of Contents >>
Scheduler
Constructor Detail
Scheduler
public Scheduler(string ip, int port)
レポートのスケジュール作業を生成して結果ファイル及びSchedulerの管理機能を実行します。
Parameters
ip：OZ Scheduler ServerがインストールされているホストPCのIPアドレス
port：Schedulerのポート番号(既定値：9521)
Method Detail
CreateTask
public string CreateTask(ServerInfo s, NameValueCollection configMap, NameValueCollection exportMap)
フォームファイルを基盤にタスクを生成して生成されたタスクIDを取得します。
CreateTaskで複数のタスクの生成時、Viewerの待機キューに関わらず、実行されるViewerの個数分のThreadとparamファイルが生成されます。
Parameters
s：OZ Serverの情報
configMap：Scheduler設定オプション（参照：NameValueCollection）
exportMap：エクスポート情報（参照：NameValueCollection）
GetTaskInfos
public ScheduledTask[] GetTaskInfos(ServerInfo s)
現在の生成されたタスクの結果物を取得します。
Parameters
s：OZ Serverの情報
GetTaskResult
public TaskResult[] GetTaskResult(ServerInfo s, string from, string to, string taskId, int rollingIndex)
ローリングされたファイルを検索して、タスクの実行結果を取得します。
Parameters:
s：OZ Serverの情報
from：タスク結果を取得開始時刻
to：タスク結果を取得終了時刻
taskId：取得するタスクID
rollingIndex：ファイルインデックス
GetTaskResults
public TaskResult[] GetTaskResults(ServerInfo s, string from, string to, string taskId)
タスク結果を取得します。
Parameters
s：OZ Serverの情報
from：タスク結果を取得開始時刻
to：タスク結果を取得終了時刻
taskId：取得するタスクID
GetTaskWaitTime
public int GetTaskWaitTime(ServerInfo s, String taskId)
タスクが待機した時間を取得します。（単位：秒）
Parameters
s：OZ Serverの情報
taskId：取得するタスクID
GetTaskWaitCount
public int GetTaskWaitCount()
実行待機中のタスクの数を取得します。
RemoveTask
public void RemoveTask(ServerInfo s, string taskId)
タスクを削除します。
Parameters
s：OZ Serverの情報
taskId：削除するタスクID
ModifyTask
public string ModifyTask(ServerInfo s, string taskId, NameValueCollection configMap, NameValueCollection exportMap)
タスク属性を変更します。
Parameters
s：属性を変更するタスクID
taskId：削除するタスクID
configMap：Scheduler設定オプション（参照：NameValueCollection）
exportMap：エクスポート情報（参照：NameValueCollection）
PauseTask
public void PauseTask(ServerInfo s, string taskId)
タスクを一時中止します。
Parameters
s：OZ Serverの情報
taskId：中止するタスクID
ResumeTask
public void ResumeTask(ServerInfo s, string taskId)
中止したタスクを再実行します。
Parameters
s：OZ Serverの情報
taskId：再実行するタスクID
Stop
public void Stop(ServerInfo s, bool forciblyStop)
Schedulerを中止します。
Parameters
s：OZ Serverの情報
forciblyStop：Schedulerを強制終了するか否か
Export
public bool Export(ServerInfo s, NameValueCollection configMap, NameValueCollection exportMap)
Viewerパラメーターをそのまま使用してエクスポートしてエクスポートの結果を返します。
Serverに設定されたSchedulerの環境設定中"ViewerType=None"ではない場合のみ使用可能です。
Parameters
s：OZ Serverの情報
configMap：Scheduler設定オプション（参照：NameValueCollection）
exportMap：エクスポート情報（参照：NameValueCollection）
MakePDF
public bool MakePDF(ServerInfo s, NameValueCollection configMap, NameValueCollection exportMap)
Schedulerの作業リストに登録せずにPDFのエクスポートのみ実行してエクスポートの結果を返します。
Serverに設定されたSchedulerの環境設定の"ViewerType=None"ではない場合のみ使用可能です。
Parameters
s：OZ Serverの情報
configMap：エクスポートのためのフォーム情報。CreatTask()と類似していますが、PDF関連情報のみ入力必須項目です（参照：NameValueCollection）
exportMap：PDFのエクスポート情報。CreatTask()と類似していますが、PDF関連情報のみ入力必須項目です（参照：NameValueCollection）
public bool Print(ServerInfo s, NameValueCollection configMap, NameValueCollection printMap)
Viewer parameterを適用してプリントして結果を返します。(実際プリント作業の結果ではなくてViewerでプリントの呼び出し結果を返します。)
“task_type=viewerTag"の場合のみ使用可能で、それ以外の値の場合に 無視します。また、Serverに設定されたSchdulerの環境設定の“ViewerType=None"ではない場合のみ使用可能です。
print APIの呼び出し時タスク作業周期オプションに関わらず即時1回のみ印刷作業を呼び出してタスクは生成せず、print APIの呼び出し時メールの転送などのパラメーターを設定してもメール関連作業は実行されないまま印刷のみ実行します。
print関数をAPIで実装する場合、Viewerパラメーターで設定したパラメーター中次のパラメーターは常に指定値で固定されて動作します。
•viewer.allowmultiframe=true
•viewer.mode=print
•viewer.printcommand=true
•viewer.showerrormessage=false
•viewer.useprogressbar=false
•print.ingnoreerror=false
•print.mode=silent
•export.confirmsave=false
•export.format=""
•information.debug=debug
Parameters
s：OZ Serverの情報
configMap：Scheduler設定オプション（参照：NameValueCollection）
printMap：エクスポート情報（参照：NameValueCollection）
GetCurrentStatus
string GetCurrentStatus()
スケジューラの使用メモリー・総メモリー・実行中のビューア数・待機中のビューア数を取得します。
GetConfiguration
public NameValueCollection GetConfiguration(ServerInfo s)
Schedulerの設定値を取得します。
Parameters
s：OZ Serverの情報
ModifyConfiguration
public void ModifyConfiguration(ServerInfo s, NameValueCollection configMap)
Schedulerの設定値を変更します。
Parameters
s：OZ Serverの情報
configMap：Scheduler設定オプション（参照：NameValueCollection）
SetReceiveTimeOut
public void SetReceiveTimeOut(int timeOut)
ソケットタイムアウトを設定します。（単位：秒）
Parameters:
timeOut：ソケットタイムアウト
Ping
public bool Ping()
Serverの起動状態を返します。
GetSchedulingInfos
public string[] GetSchedulingInfos(string path)
設定したパスにあるOZSファイルリストを取得します。(pathをファイル名で指定すると指定OZSファイル情報のみ取得し、pathをフォルダ名で指定すると指定フォルダ下の全てのOZSファイル情報を取得します。指定パスにファイルが存在しなかったり、存在しないフォルダを指定すると空き値を返します。
Parameters
path：OZSファイルリストを取得するパス。OZSファイルリストを取得するパスは/%SCH_HOME%/[path]/で指定されます。例えば、pathをsampleで設定する場合には/%SCH_HOME%/sample/にあるOZSファイルリストを取得します
ConvertSchedulingInfos
public void ConvertSchedulingInfos(string oldPath, string newPath)
ver.2.5のOZSファイルを最新バージョンに変換して保存します。
Parameters
oldPath：変換するOZSファイル名/パス。指定パスは/%SCH_HOME%/[oldPath]/です。
newPath：変換されたOZSファイルの保存パス。指定パスは/%SCH_HOME%/[newPath]/で、newPathはoldPathと異なる設定をする必要があります
AddTaskHoliday
public bool AddTaskHoliday(TaskHolidayInfo value)
タスク休日情報を追加します。
Parameters
value：タスク休日情報
ModifyTaskHoliday
public bool ModifyTaskHoliday(string old_key, TaskHolidayInfo new_value)
タスク休日情報を修正します。
Parameters
old_key：修正するタスク休日名
new_value：新規タスク休日情報
DeleteTaskHoliday
public bool DeleteTaskHoliday(string[] keys)
タスク休日情報を削除します。
Parameters
keys：削除するタスク休日名の配列
AddTaskHolidayGroup
public bool AddTaskHolidayGroup(TaskHolidayGroupInfo value)
タスク休日グループ情報を追加します。
Parameters
value：タスク休日グループ情報
ModifyTaskHolidayGroup
public bool ModifyTaskHolidayGroup(string old_key, TaskHolidayGroupInfo new_value)
タスク休日グループ情報を修正します。
Parameters
old_key：修正するタスク休日グループ名
new_value：修正するタスク休日グループ情報
DeleteTaskHolidayGroup
public bool DeleteTaskHolidayGroup(string key)
タスク休日グループ情報を削除します。
Parameters
key：削除するタスク休日グループ名
GetTaskHolidayInfos
public TaskHolidayInfos GetTaskHolidayInfos()
タスク休日情報リストを取得します。
GetTaskHolidayGroupInfos
public TaskHolidayGroupInfos GetTaskHolidayGroupInfos()
タスク休日グループ情報リストを取得します。
SaveTaskHoliday
public void SaveTaskHoliday()
タスク休日情報をXMLファイルとして保存します。
DirectExport
public DirectExportResult DirectExport(ServerInfo s, NameValueCollection configMap, NameValuecollection exportMap)
Viewerパラメーターを適用してエクスポートして結果情報を返します。
Serverに設定されたSchedulerの環境設定の"ViewerType=None"ではない場合のみ使用できます。
Parameters
s：OZ Serverの情報
configMap：Scheduler設定オプション（参照：NameValueCollection）
exportMap：エクスポート情報（参照：NameValueCollection）
DirectExportFiles
public Hashtable[] DirectExportFiles(ServerInfo s, NameValueCollection properties, NameValuecollection exportProperties, string localTempPath)
Viewerパラメーターを適用してエクスポートした結果をローカルの一時保存パスに保存し、ファイル情報を返します。
サーバーに設定されたSchedulerの環境設定の中task_typeがviewerTagで、ViewerTypeがActiveX或いはAppletの場合のみ使用できます。
Parameters
s：OZ Server情報
properties：Scheduler設定オプション（参照：NameValueCollection）
exportProperties：出力情報（参照：NameValueCollection）
localTempPath：エクスポートした結果を保存するローカルの一時保存パス
DirectExportResult
public DirectExportResult DirectExportResult(ServerInfo s, NameValueCollection properties, NameValuecollection exportProperties)
Viewerパラメーターを適用して印刷した結果情報を返します。
サーバーに設定されたSchedulerの環境設定の中task_typeがviewerTagで、ViewerTypeがActiveX或いはAppletの場合のみ使用できます。
Parameters
s：OZ Server情報
properties：Scheduler設定オプション（参照：NameValueCollection）
exportProperties：出力情報（参照：NameValueCollection）
DirectExportByteArray
public HashTable DirectExportByteArray(ServerInfo s, NameValueCollection configProperties, NameValueCollection exportProperties)
タスクを実行した後、実行結果の情報を返します。
タスクの実行結果をファイルに保存せずに、メモリにエクスポートするには、ude.classnameを設定した後、ViewerType=Applet、export_file=falseに設定してください。
サーバーに設定されたスケジューラの環境設定の"ViewerType=None"ではない場合のみ使用することができます。
Parameters
s：OZ Serverの情報
configProperties：Scheduler設定オプション（参照：NameValueCollection）
exportProperties：エクスポート情報（参照：NameValueCollection）
DirectPrint
public DirectPrintResult DirectPrint(ServerInfo s, NameValueCollection configMap, NameValuecollection printMap)
Viewerパラメーターを適用して印刷して結果情報を返します。
"task_type=viewerTag"の場合のみ使用できてそれ以外の値が入ると無視します。また、Serverに設定されたSchedulerの環境設定の“ViewerType=None"ではない場合のみ使用できます。
Parameters
s：OZ Serverの情報
configMap：Scheduler設定オプション（参照：NameValueCollection）
printMap：印刷情報。ただし、print.mode=silentでのみ実行されます（参照：NameValueCollection）
GetFile
public void GetFile(ServerInfo s, string fileName, string targetFile)
Schedulerからファイルを取得します。
Parameters
s：OZ Serverの情報
fileName：取得するファイル名
targetFile：保存するファイル名
GetTaskProperties
public void GetTaskProperites(ServerInfo s, string TaskID, NameValueCollection configMap, NameValueCollection exportMap)
タスクの属性（Schedulerでタスクを生成する時に使用される設定オプション(configMap)）とSchedulerでエクスポートされるファイルの設定オプション(exportMap)を取得します。
Parameters
s：OZ Serverの情報
taskID：属性を取得するタスクID
configMap：エクスポートのためのフォーム情報。CreatTask()と類似していますが、PDF関連情報のみ入力必須項目です（参照：NameValueCollection）
exportMap：PDFエクスポート情報。CreatTask()と類似していますが、PDF関連情報のみ入力必須項目です（参照：NameValueCollection）