Configure Job Protection Settings

The project owner can mark a job as private to restrict who can see it, edit it, delete its configuration, or run its build:

1. In the left navigator, click Project Administration .
2. Click Builds.
3. Click the Job Protection tab.
4. From the jobs list, select the job.

   If your project has many jobs, you may have difficulty finding the specific job you want to protect. Use the Search bar to quickly locate the job to which you want to add the restricted settings.

   If a job in the list of jobs to the left has a lock icon next to it, it has already been protected. A protected job's restrictions can still be modified, removed, or the list of authorized users and groups can still be changed.

   The Protection Settings screen is displayed.

   
   
   Description of the illustration job-protection-open.png
   

5. Select the Private option.

   
   
   Description of the illustration job-protection-private.png
   

   With just this option selected, only authorized users and groups will be able to view the Job Details page, edit the job, or manually run it. If the job is triggered in a pipeline by an unauthorized user or group, or if it is triggered by SCM or a timer, it will not be initiated.
6. Click in the Authorized Users/Groups field to display a dialog that lists the project's Groups and Users you can select from.

   Under Users, you can see a flattened list of all users that are members of the group(s) as well as ones that were added individually. For example, the dev-group members (Clara Coder, Don Developer, and Tina Testsuite) appear in the Users list, along with Alex Admin, who was added individually. From the list, select one or more groups and/or users. Don't forget to add yourself.

   
   
   Description of the illustration authorized-groups-and-users.png
   

   Note:

   Users in Oracle Cloud Application environments that have multiple VB Studio instances in different identity stripes have username strings that include the environment name, where that user has been defined. Since a unique user may have been defined for multiple environments, this format ensures that one identity can be distinguished from that user's other unique identities. This should help you select the correct user to add.

   Alex Admin was selected.
   
   Description of the illustration job-protection-private-authorized-user.png
   

7. Select the checkboxes to allow project members to manually start private jobs and/or allow commits and triggers to automatically start private jobs:

   • Select the Allow any member of the project to manually start this private job checkbox to allow any project member, not just authorized users, to manually start the job.

     
     
     Description of the illustration job-protection-private-both-checkboxes-selected.png
     

     Notice that when you select the first checkbox, VB Studio automatically selects the second checkbox, which allows commits and triggers to start the private job, and grays it out. With this setting, only authorized users and groups can view the Job Details page or edit the job, but any project member can start and run the job. In addition, SCM commits or triggers will also automatically start and run the job.

   • Select just the Allow commits and triggers to start this private job checkbox if you want SCM commits and triggers to be able to automatically run this job.

     
     
     Description of the illustration job-protection-private-allow-commits-and-triggers.png
     

     With just this checkbox selected, periodic triggers will run any job or pipeline, including private jobs set to allow commits and triggers to start the private job. However, if a pipeline includes a private job with this option selected and a non-authorized user attempts to run the pipeline manually, the private job won't run but periodic triggers and SCM commits will.

     Leave the checkbox unselected if you don't want the job to be started when it is triggered by an SCM commit or timer.

     Note:

     Best Practice:

     If you use the checkbox to enable the protected build to be triggered by an SCM commit, you need to protect the branch that the build job is tied to. If you don't do this, anyone can trigger the protected build by making a commit to trigger the build.

8. Click Save.

   The activity stream displays all changes to a job's protection status, like changing the job protection from public to private, or private to public, or changing a private job to allow commits and triggers.

You can see if a job is private from several places in the VB Studio user interface. A private job is indicated by a Lock icon:

• In the jobs list found on the Project Administration tile's Builds page's Job Protection tab, to the right of each protected job's name.

• In the Private column on the Builds page's Jobs tab.

• In the jobs shown in the the Builds page's Pipelines tab.

An unauthorized user can't run a private build job manually, or through a pipeline, or via an SCM/periodic trigger.