FIMS Media SOA Framework - AMWA

FIMS Media SOA Framework Phase1 (Preliminary)• List jobs in a queue• Clear a queue• Delete single job from a queue• Lock/unlock a queueThe adoption of a common interface for the status operations enables the use of common front-end tools formedia services management, and the ability to interact with running tasks from a client or workflow. Queue andJob management types provide a mechanism to query and manage the status of jobs and job queues.8.2.2.2.1 ManageJobRequestTypeThis type is part of the FIMS service common status interface and provides a mechanism to check the status ofjobs and update jobs properties, such as job priority. The manage job request uses the jobCommand to set theintent of the command (requesting status or acting on the job state).8.2.2.2.1.1 ParametersParameter Type DescriptionjobCommand JobCommandType The job command is used to determine the type of jobrequest, such as checking on the job status or performingan action on the job (e.g. pause the job). The allowed jobcommands value are enumerated on theJobCommandType.modifyJob ModifyJobType If the job command is set to "modifyJob", this elementshall be set, to provide one of the values listed inModifyJobType. If the job command is set to any othervalue, this element should not be set.jobID JobIDType The job id information for this job. It is provided with theJobIDType, where it is sufficient to set the jobGUID.8.2.2.2.1.2 Related Types8.2.2.2.1.2.1 JobCommandTypeEnumerates the allowed values for a job command:- status: request the status information for a job. It does not change the state of the job.- cancel: cancel a job- pause: pause a job. It can be restarted with resume.Private committee documentWorking Draft for review by FIMS Rev v1, Nov-16-2010 Page 57 of 89