Adding and Editing Jobstreams

{"URL":["/*.*/AddJobstream_SelectTargetJob"],"heroDescriptionIdentifier":"ice_Adding_Editing_Jobstreams_Intro","customCards":[{"id":"ice_adding_jobstreams_HowTo","title":"Selecting the Target Job","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/TERMA_DOCU/*.*/AAI%20Guides/Content/Jobstreams/Jobstreams_Adding_Editing.htm"},{"type":"link","link":"https://simlabs.aod.broadcom.com/overview-of-aai","languages":["en-us"],"title":"Hands-On Practice: Overview of AAI"},{"id":"ice_using_filters","title":"Using Filters","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/TERMA_DOCU/*.*/AAI%20Guides/Content/_Common/CommonFunctions/CF_Filters_web_interface.htm"},{"id":"ice_Adding_FirstDialog_NextSteps","title":"Next Steps","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/TERMA_DOCU/*.*/AAI%20Guides/Content/Jobstreams/Jobstreams_Adding_Editing.htm"}]}

You do not build the jobstreams in AAI. Instead, AAI creates a jobstream for you when you specify just one key, defining element of the jobstream, the target job. The target job is the last job in the process whose completion marks the final milestone and deliverable of the process. After you specify the target job, AAI uses job dependencies and historical job run data to backtrack from the target job to the beginning of the chain of events. The result is a jobstream that maps the full process and includes an SLA deadline that AAI proposes based on its analysis of historical run data from all the included jobs. This takes a few minutes, after which you have a jobstream that you can start monitoring and analyzing to get a data-driven understanding of the process, its pitfalls, and its optimization opportunities.

The steps here describe how to manually add a jobstream on the user interface when you are logged into AAI on your web browser. Alternatively, you can add jobstreams using the related CLI command, either on the command like or within a script. For information, see Jobstream Commands.

Best Practice

When you are new to AAI and especially in fresh installations, it is best to create the first jobstreams manually. Not only will this help you get a good grip of the product but it will also help you understand the available jobstream configuration options so you can make good decisions about how you implement jobstreams for the critical business processes that your workload automation supports. Once you know how to set up jobstreams to support your teams' operational processes and meet your business goals, you will be in a good position to plan an automatic, bulk jobstream creation for your targeted business processes with appropriate scripts.

Important!

If you are new to AAI, we strongly recommend the that before beginning with the implementation of AAI, you read the topics in Overview of the Business Implementation carefully. These topics provide a roadmap for the AAI business implementation and the many planning considerations for a successful rollout. these include how to start setting up your system, including creating jobstreams. After that, look through the topics in this section to see the various jobstream configuration options and how the settings you choose impact jobstream monitoring and analysis.

When you add a jobstream manually, the first thing you do is to define its target job. AAI automatically discovers the target job's upstream dependencies (its predecessors) and builds the actual jobstream. As soon as a jobstream is created, AAI starts monitoring it at runtime and performing calculations that lead to predictions. If delays occur along the way, AAI sends alerts that let users remediate the cause before the timely completion of the jobstream is jeopardized.

Note:

Only users who have the required authorizations can add or edit jobstreams.

The dialogs to add and edit jobstreams are very similar although the Edit Jobstream dialog contains more tabs. For example, SLAs can only be specified when editing a jobstream and NOT when adding it, so this tab is only available when editing. This is because the system-calculated late criterion (criterion by which a jobstream will be considered to be running late) can only be determined after the jobstream has been added and the first calculations made.

Adding/Editing a Jobstream

You can add a jobstream from several places in AAI:

  • Jobstream Definitions page

  • Jobstream Runs - Grid view

  • Jobstream Runs - Timeline view

  • Any job detail page from a job that you want to define as the target job for the jobstream

You can start editing a jobstream from several places in AAI

  • Jobstream Definitions

  • Jobstream Runs - Grid

  • Jobstream Runs - Timeline

  • Related Jobs and Jobstreams tab of a job's details page.

    Here, if jobstreams are listed for the job, you can click a jobstream name to view its details and edit its Deadlines & Rules (SLA and alert settings).

Selecting the Target Job

When you add a jobstream, the first thing you do is to define its target job. So, when you the Add New Jobstream dialog opens to Select Target Job.

  1. Use the Find Jobs where Name dropdown list and the adjacent input field to either select the target job (if you know its name) or to narrow down the list of possible candidates.

  2. Click Find to display the list of jobs that match your search criteria.

  3. Select the corresponding job. The bottom of the dialog displays the number of jobs in the jobstream as well as the number of historical runs. The latter gives you an idea of the quality of the calculations that AAI can deliver. The higher the number of historical runs, the better the quality of the calculations.

  4. Click OK.

    Note:

    After defining the target job of a jobstream, you can still change it by clicking the Edit button on the Add New Jobstream > Definitions tab.

Next Steps

After selecting the target job and clicking OK, the dialog changes to display the following tabs where you configure/modify the jobstream:

When Jobstream Edits Take Effect

Most of the changes that you can do to a jobstream go into effect straight away. Other changes, such as trimming or modifying its start job, take long because they require to rebuild the jobstream statistics. While rebuilding is in progress, if you click the Save button, AAI shows an updating pop-up. You can close the Edit Jobstream dialog to go back to the jobstream details page but the jobstream is locked for editing until the rebuilding process is finished.

The topics in this section describe how to add and edit jobstreams: