Privileges Required to Use Job Definitions
To use Job Definitions ( JobDefinition
), you need one of the following:
scheduler-administrator
orredwood-administrator
rolescheduler-job-administrator
role- Object, system or Partition-level permissions
The sections below will reference the Object-level permissions you need, however, equivalent system or Partition-level permissions are also valid.
Using Job Definitions
The following privilege ranks are available on Job Definitions:
- Create - allows you to create a Job Definition on the level the privilege was granted (system, Partition), you have no further privileges through this rank, you automatically get All privilege rank on Job Definitions you create.
- View - allows you to view a process Job Definition on the level the privilege was granted (system, Partition), you have no further privileges through this rank.
- View Processes - allows you to view a process on the level the privilege was granted (system, Partition), you have no further privileges through this rank.
- Run - allows you to submit a process on the level the privilege was granted (system, Partition), you have no further privileges through this rank.
- Submit View - allows you to submit and view a process on the level the privilege was granted (system, Partition), you have no further privileges through this rank.
- Edit - allows you to create, view, and edit a Job Definition and process as well as submit, edit, and view a process on the level the privilege was granted (system, Partition).
- Edit Processes - allows you to view, submit and edit a process on the level the privilege was granted (system, Partition).
- Delete - allows you to create, view, and delete a Job Definition and submit, view, and edit a process on the level the privilege was granted (system, Partition).
- All - full control over a Job Definition on the level the privilege was granted (system, Partition).
You always need View privileges on the Partition of the Job Definition.
Job Definitions can reference the following Objects, you need at least View privileges on these Objects as well as their Partition(s) when you want to create/edit/delete a Job Definition that references them:
- Folder.
- Credential.
- Event.
- Format.
- Definition Type.
- Library.
- Lock.
- Queue.
- Advanced Schedule.
- Time Window.
Built-in Roles
- The
scheduler-administrator
orredwood-administrator
built-in role provides full access to Job Definitions. - The
scheduler-viewer
built-in role provides read-only access to Job Definitions.
Creating Job Definitions
You need one of the following privilege ranks to be able to create Job Definitions:
- Create - allows you to create Job Definitions on the level the privilege was granted (system, Partition), you have no further privileges through this rank, you automatically get All privilege rank on Job Definitions you create.
- Edit - allows you to create, view, and edit all Job Definitions on the level the privilege was granted (system, Partition).
- Delete - allows you to create, view, and delete all Job Definitions on the level the privilege was granted (system, Partition).
- All - full control over all Job Definitions on the level the privilege was granted (system, Partition).
Job Definitions can reference the following Objects, you need at least View privileges on these Objects and their Partition(s) when you want to create a Job Definition that references them:
- Folder.
- Credential.
- Credential Protocol.
- Event.
- Format.
- Definition Type
- Library.
- Lock.
- Query Filter - used in parameter constraints.
- Queue.
- Resource.
- Advanced Schedule.
- Time Window.
Submitting Job Definitions
To successfully submit a Job Definition, you must have one of the following privileges:
- Run - privilege rank on the Job Definition on the level the privilege was granted (system, Partition, Object).
- Submit View - privilege rank on the Job Definition on the level the privilege was granted (system, Partition, Object).
- All - privilege rank on the Job Definition on the level the privilege was granted (system, Partition, Object).
As well as the following privileges
- View Jobs - privilege rank on the Queue where the process is supposed to run, or on Queue in the Queue's Partition or on Queue system-wide
- View - privilege rank on the Job Server that serves the Queue and where the process is going to run, or on Job Server that serves the Queue and where the process is going to run in its Partition or system-wide
You also require View privileges on the Partition of the Job Definition, of the Queue, and of the Job Server where the process is going to run.
Optionally, if you want to use a library, Advanced Schedule and/or Time Window, you will need View privileges on them and their Partition, as well. If the Job Definition has a default Advanced Schedule, a default Time Window, or uses a library (in parameters or in the code) you will require View privileges on the Objects or you will not be able to submit the Job Definition or restart the process.
Job Definitions can reference the following Objects, you need at least View privileges on these Objects and their Partition(s) when you want to submit a Job Definition that references them:
- Credential.
- Event.
- Lock.
Editing Job Definitions
To successfully edit a Job Definition, you must have one the following privileges:
- Edit - privilege rank on the Job Definition on the level the privilege was granted (system, Partition).
- Delete - privilege rank on the Job Definition on the level the privilege was granted (system, Partition).
- All - privilege rank on the Job Definition on the level the privilege was granted (system, Partition).
You also require View privileges on the Partition of the Job Definition.
Job Definitions can reference the following Objects, you need at least View privileges on these Objects and their Partition(s) when you want to edit a Job Definition that references them:
- Folder.
- Credential.
- Credential Protocol.
- Event.
- Format.
- Definition Type
- Library.
- Lock.
- Query Filter - used in parameter constraints.
- Queue.
- Resource.
- Advanced Schedule.
- Time Window.
See Also
- Privileges Required to Use Folders
- Privileges Required to Use Event Definitions
- Privileges Required to Use Formats
- Privileges Required to Use Credentials
- Privileges Required to Use Credential Protocols
- Privileges Required to Use Libraries
- Privileges Required to Use Locks
- Privileges Required to Use Job Servers
- Privileges Required to Use Query Filters
- Privileges Required to Use Queues
- Privileges Required to Use Reports
- Privileges Required to Use Resources
- Privileges Required to Use Advanced Schedules
- Privileges Required to Use Time Windows
- Privileges Required to Use Objects