<< Click to Display Table of Contents >>
Scheduler
This class creates report scheduling jobs and performs the result file and scheduler management functions.
Constructor Detail
Scheduler
public Scheduler(string ip, int port)
Creates report scheduling jobs and perform result file and scheduler management functions.
Parameters:
ip - The IP address
port - The port number
Method Detail
CreateTask
public string CreateTask(ServerInfo s, NameValueCollection configMap, NameValueCollection exportMap)
Creates a scheduling task based on the form file and gets the task ID.
Parameters:
s - The OZ Server information
configMap - Configuration option used when creating task
exportMap - Configuration option of the files exported from the OZ Scheduler
GetTaskInfos
public ScheduledTask[] GetTaskInfos(ServerInfo s)
Gets the result of the currently scheduling task.
Parameters:
s - The OZ Server information
GetTaskResult
public TaskResult[] GetTaskResult(ServerInfo s, string from, string to, string taskId, int rollingIndex)
Gets the results of task execution of a rolled file.
Parameters:
s - The OZ Server information
from - The start time
to - The end time
taskId - The task ID
rollingIndex - The file index
GetTaskResults
public TaskResult[] GetTaskResults(ServerInfo s, string from, string to, string taskId)
Gets the scheduling task result.
Parameters:
s - The OZ Server information
from - The start time
to - The end time
taskId - The task ID
GetTaskWaitTime
public int GetTaskWaitTime(ServerInfo s, String taskId)
Gets the amount of time in seconds the task waited.
Parameters:
s - The OZ Server information
taskId - The task ID
GetTaskWaitCount
public int GetTaskWaitCount()
Gets the number of tasks that are waiting.
RemoveTask
public void RemoveTask(ServerInfo s, string taskId)
Deletes a scheduling task.
Parameters:
s - The OZ Server information
taskId - The task ID
ModifyTask
public string ModifyTask(ServerInfo s, string taskId, NameValueCollection configMap, NameValueCollection exportMap)
Modifies the task properties.
Parameters:
s - The OZ Server information
taskId - The task ID
configMap - The OZ Scheduler configuration option
exportMap - The export information
PauseTask
public void PauseTask(ServerInfo s, string taskId)
Pauses a task.
Parameters:
s - The OZ Server information
taskId - The task ID
ResumeTask
public void ResumeTask(ServerInfo s, string taskId)
Resumes a paused task.
Parameters:
s - The OZ Server information
taskId - The task ID
Stop
public void Stop(ServerInfo s, bool forciblyStop)
Stops the Scheduler.
Parameters:
s - The OZ Server information
forciblyStop - Whether to forcibly stop the Scheduler
Export
public bool Export(ServerInfo s, NameValueCollection configMap, NameValueCollection exportMap)
Exports by using the viewer parameter as it is and then returns the result.
Parameters:
s - The OZ Server information
configMap - The OZ Scheduler configuration option
exportMap - The export information
MakePDF
public bool MakePDF(ServerInfo s, NameValueCollection configMap, NameValueCollection exportMap)
Performs PDF exporting without registering in the OZ Scheduler’s work list and then returns the result.
Parameters:
s - The OZ Server information
configMap - The form information for export
exportMap - The PDF Export information
public bool Print(ServerInfo s, NameValueCollection configMap, NameValueCollection printMap)
Prints by applying the viewer parameter.
Parameters:
s - The OZ Server information
configMap - The OZ Scheduler configuration information
printMap - The print information
GetCurrentStatus
string GetCurrentStatus()
Gets the scheduler's used memory, total memory, number of running viewers, and number of waiting viewers.
GetConfiguration
public NameValueCollection GetConfiguration(ServerInfo s)
Gets the Scheduler configuration.
Parameters:
s - The OZ Server information
ModifyConfiguration
public void ModifyConfiguration(ServerInfo s, NameValueCollection configMap)
Updates the configuration settings of the Scheduler.
Parameters:
s - The OZ Server information
configMap - The OZ Scheduler configuration option
SetReceiveTimeOut
public void SetReceiveTimeOut(int timeOut)
Sets the socket timeout.
Parameters:
timeout - The socket timeout
Ping
public bool Ping()
Gets whether the server is running.
GetSchedulingInfos
public string[] GetSchedulingInfos(string path)
Gets the list of OZS files in the set path.
Parameters:
path - The path from which the OZS file list will be received
ConvertSchedulingInfos
public void ConvertSchedulingInfos(string oldPath, string newPath)
Converts the 2.5 version OZS file into the latest version and saves it.
Parameters:
oldPath - The OZS file name or path to update
newPath - The path to save the updated OZS file
AddTaskHoliday
public bool AddTaskHoliday(TaskHolidayInfo value)
Adds task holiday information.
Parameters:
value - The task holiday information
ModifyTaskHoliday
public bool ModifyTaskHoliday(string old_key, TaskHolidayInfo new_value)
Modifies task holiday information.
Parameters:
old_key - The task holiday name
new_value - The new task holiday information
DeleteTaskHoliday
public bool DeleteTaskHoliday(string[] keys)
Deletes task holiday information.
Parameters:
keys - The array of the task holiday name
AddTaskHolidayGroup
public bool AddTaskHolidayGroup(TaskHolidayGroupInfo value)
Adds task holiday group information.
Parameters:
value - The task holiday group information
ModifyTaskHolidayGroup
public bool ModifyTaskHolidayGroup(string old_key, TaskHolidayGroupInfo new_value)
Modifies task holiday group information.
Parameters:
old_key - The task holiday group name
new_value - The new task holiday group information
DeleteTaskHolidayGroup
public bool DeleteTaskHolidayGroup(string key)
Deletes task holiday group information.
Parameters:
key - The task holiday group name
GetTaskHolidayInfos
public TaskHolidayInfos GetTaskHolidayInfos()
Gets task holiday information list.
GetTaskHolidayGroupInfos
public TaskHolidayGroupInfos GetTaskHolidayGroupInfos()
Gets task holiday information list.
SaveTaskHoliday
public void SaveTaskHoliday()
Save the task holiday information as an xml file.
DirectExport
public DirectExportResult DirectExport(ServerInfo s, NameValueCollection configMap, NameValuecollection exportMap)
Exports by applying the export information.
Parameters:
s - The OZ Server information
configMap - The OZ Scheduler configuration option
exportMap - The export information
DirectExportFiles
public Hashtable[] DirectExportFiles(ServerInfo s, NameValueCollection properties, NameValuecollection exportProperties, string localTempPath)
Exports by applying the export information.
Parameters:
s - The OZ Server information
properties - The OZ Scheduler configuration option
exportProperties - The export information
localTempPath - local temporary path
DirectExportResult
public DirectExportResult DirectExportResult(ServerInfo s, NameValueCollection properties, NameValuecollection exportProperties)
Exports by applying the export information.
Parameters:
s - The OZ Server information
properties - The OZ Scheduler configuration option
exportProperties - The export information
DirectExportByteArray
public HashTable DirectExportByteArray(ServerInfo s, NameValueCollection configProperties, NameValueCollection exportProperties)
Exports by applying the export information.
Parameters:
s - The OZ Server information
configProperties - The OZ Scheduler configuration option
exportProperties - The export information
DirectPrint
public DirectPrintResult DirectPrint(ServerInfo s, NameValueCollection configMap, NameValuecollection printMap)
Prints by applying the export information.
Parameters:
s - The OZ Server information
configMap - The OZ Scheduler configuration option
printMap - The print information
GetFile
public void GetFile(ServerInfo s, string fileName, string targetFile)
Gets the file.
Parameters:
s - The OZ Server information
fileName - The file name
targetFile - The target file name
GetTaskProperties
public void GetTaskProperites(ServerInfo s, string TaskID, NameValueCollection configMap, NameValueCollection exportMap)
Gets the task configuration options(configMap) to apply when the scheduler creates a task and the file configuration options(exportMap) to apply when the scheduler exports a file.
Parameters:
s - The OZ Server information
taskID - The task ID
configMap - The form file information
exportMap - The export information