NSBatchAgent - SuperOffice

Start, stop and monitor predefined batch tasks.

Constructors

NSBatchAgent()

NSBatchAgent

Initializes a new instance of the NSBatchAgent class.

Methods

DeleteBatchTask(Integer)

Deletes a batch task from the database.

Void DeleteBatchTask(Integer batchTaskId)

Returns: CRMScript.Global.Void

DeleteBatchTasks(Integer[])

Deletes batch tasks from the database.

Void DeleteBatchTasks(Integer[] batchTaskIds)

Returns: CRMScript.Global.Void

GetBatchTaskInfo(Integer)

Gets a single NSBatchTaskInfo based on ID.

NSBatchTaskInfo GetBatchTaskInfo(Integer id)

Returns: CRMScript.NetServer.NSBatchTaskInfo - A BatchTaskInfo. Example:

NSBatchAgent agent;
Integer id;
NSBatchTaskInfo res = agent.GetBatchTaskInfo(id);

GetBatchTaskInfosByAssociates(Integer[])

Gets an array of NSBatchTaskInfo for the provided associate IDs.

NSBatchTaskInfo[] GetBatchTaskInfosByAssociates(Integer[] associateIds)

Returns: CRMScript.NetServer.NSBatchTaskInfo[] - An array of BatchTaskInfo. Example:

NSBatchAgent agent;
Integer[] associateIds;
NSBatchTaskInfo[] res = agent.GetBatchTaskInfosByAssociates(associateIds);

GetBatchTaskInfosByAssociatesAndState(Integer[],Integer)

Gets an array of NSBatchTaskInfo for the provided associate IDs and batch task state.

NSBatchTaskInfo[] GetBatchTaskInfosByAssociatesAndState(Integer[] associateIds, Integer state)

Returns: CRMScript.NetServer.NSBatchTaskInfo[] - An array of BatchTaskInfo. Example:

NSBatchAgent agent;
Integer[] associateIds;
Integer state;
NSBatchTaskInfo[] res = agent.GetBatchTaskInfosByAssociatesAndState(associateIds, state);

GetBatchTaskInfosByNameAndAssociates(String,Integer[])

Gets an array of NSBatchTaskInfo for the provided associate IDs and batch task definition name.

NSBatchTaskInfo[] GetBatchTaskInfosByNameAndAssociates(String name, Integer[] associateIds)

Returns: CRMScript.NetServer.NSBatchTaskInfo[] - An array of BatchTaskInfo. Example:

NSBatchAgent agent;
String name;
Integer[] associateIds;
NSBatchTaskInfo[] res = agent.GetBatchTaskInfosByNameAndAssociates(name, associateIds);

GetBatchTaskInfosByNameAndState(String,Integer)

Gets an array of NSBatchTaskInfo with state defined by a BatchTaskState and the batchtask definition name.

NSBatchTaskInfo[] GetBatchTaskInfosByNameAndState(String name, Integer state)

Returns: CRMScript.NetServer.NSBatchTaskInfo[] - An array of BatchTaskInfo. Example:

NSBatchAgent agent;
String name;
Integer state;
NSBatchTaskInfo[] res = agent.GetBatchTaskInfosByNameAndState(name, state);

GetBatchTaskInfosByState(Integer)

Gets an array of NSBatchTaskInfo with state defined by a BatchTaskState.

NSBatchTaskInfo[] GetBatchTaskInfosByState(Integer state)

Returns: CRMScript.NetServer.NSBatchTaskInfo[] - An array of BatchTaskInfo. Example:

NSBatchAgent agent;
Integer state;
NSBatchTaskInfo[] res = agent.GetBatchTaskInfosByState(state);

StartBatchJob(NSBatchTaskInfo)

Starts a batch job based on NSBatchTaskInfo.

Integer StartBatchJob(NSBatchTaskInfo batchTaskInfo)

Returns: CRMScript.Global.Integer - The ID of the created batch job. Example:

NSBatchAgent agent;
NSBatchTaskInfo batchTaskInfo;
Integer res = agent.StartBatchJob(batchTaskInfo);

StopBatchJob(Integer)

Stops a batch job based on ID.

Bool StopBatchJob(Integer id)

Returns: CRMScript.Global.Bool - true if the job was stopped successfully. Example:

NSBatchAgent agent;
Integer id;
Bool res = agent.StopBatchJob(id);

UpdateBatchTask(NSBatchTaskInfo)

Updates information about a BatchTask.

NSBatchTaskInfo UpdateBatchTask(NSBatchTaskInfo batchTaskInfo)

Returns: CRMScript.NetServer.NSBatchTaskInfo - The updated BatchTaskInfo.

Only the following properties can be updated: State, Description, Response and Request.

Example:

NSBatchAgent agent;
NSBatchTaskInfo batchTaskInfo;
NSBatchTaskInfo res = agent.UpdateBatchTask(batchTaskInfo);

​Constructors

​NSBatchAgent()

​Methods

​DeleteBatchTask(Integer)

​DeleteBatchTasks(Integer[])

​GetBatchTaskInfo(Integer)

​GetBatchTaskInfosByAssociates(Integer[])

​GetBatchTaskInfosByAssociatesAndState(Integer[],Integer)

​GetBatchTaskInfosByNameAndAssociates(String,Integer[])

​GetBatchTaskInfosByNameAndState(String,Integer)

​GetBatchTaskInfosByState(Integer)

​StartBatchJob(NSBatchTaskInfo)

​StopBatchJob(Integer)

​UpdateBatchTask(NSBatchTaskInfo)

Constructors

NSBatchAgent()

Methods

DeleteBatchTask(Integer)

DeleteBatchTasks(Integer[])

GetBatchTaskInfo(Integer)

GetBatchTaskInfosByAssociates(Integer[])

GetBatchTaskInfosByAssociatesAndState(Integer[],Integer)

GetBatchTaskInfosByNameAndAssociates(String,Integer[])

GetBatchTaskInfosByNameAndState(String,Integer)

GetBatchTaskInfosByState(Integer)

StartBatchJob(NSBatchTaskInfo)

StopBatchJob(Integer)

UpdateBatchTask(NSBatchTaskInfo)