User`s guide

11 Functions — Alphabetical List

11-280

setJobClusterData

Set specific user data for job on generic cluster

Syntax

setJobClusterData(cluster,job,userdata)

Arguments

cluster Cluster object identifying the generic third-party cluster running the job

job Job object identifying the job for which to store data

userdata Information to store for this job

Description

setJobClusterData(cluster,job,userdata) stores data for the job job that is

running on the generic cluster cluster. You can later retrieve the information with the

function getJobClusterData. For example, it might be useful to store the third-party

scheduler’s external ID for this job, so that the function specified in GetJobStateFcn

can later query the scheduler about the state of the job. Or the stored data might be an

array with the scheduler’s ID for each task in the job.

You should call the function setJobClusterData in the submit function (identified

by the IndependentSubmitFcn or CommunicatingSubmitFcn property) and

call getJobClusterData in any of the functions identified by the properties

GetJobStateFcn, DeleteJobFcn, DeleteTaskFcn, CancelJobFcn, or

CancelTaskFcn.

For more information and examples on using these functions and properties, see

“Manage Jobs with Generic Scheduler” on page 7-34.