Adding/Editing/Deleting Automic Automation Schedulers

This topic explains how to add, configure, view, edit and delete a scheduler for Automic Automation. You have to add a new Automic Automation scheduler for each Automic Automation Client that you want to integrate into your AAI environment. This topic also explains how to view, edit and delete and Automic Automation scheduler.

You can add Automic Automation schedulers before installing the Automic Automation Connector. However, you will not be able to use them until the Connector is up and running. For more information, see Connectors for Universal Schedulers and Setting Up the Automic Connector .

Adding an Automic Automation Scheduler

Configuring a scheduler involves defining the following:

• Scheduler-specific parameters: Name, type, connector and time zone.

• Connection data to the corresponding workload automation engine.

• Intervals, periods and times that AAI will apply to retrieve data.

Automic Automation schedulers can only be created through the Web UI.

To Add an Automic Automation Scheduler

1. Go to System and click the Add Scheduler button.

2. Enter a descriptive Name that the people who will work with the data from this scheduler can easily recognize. The name must be unique in your system. The dialog to configure the scheduler is displayed.

3. Specify the following parameters:

   • If there is an Automic Automation connector registered it is listed in the Connector dropdown list below.

   • Default Time Zone

     Time zone in which the Automic Automation instance is located. For example, if an AAI installation in New York monitors an Automic Automation system in Vienna, the default time zone is Vienna's.

   • Automic System Name

     Name of the Automic system.

   • Automic Client ID

     Automic Automation Client number.

   • Automic REST API Endpoint (URL)

     Address of the server

     Format:http(s)://{host}:{port}/ae/api/{version}

     Example

     http://<AutomicServer>:8088/ae/api/v1

   • Automic REST API User

     ID of the Automic REST API user. Optionally, you can use the User ID and Department.

     Example AUTOMIC/AUTOMIC

     Note:

     Make sure that the Automic REST API User has R (Read) and S (Executions) authorizations as well as Access to Administration and Access to deactivated tasks privileges in Automic Automation. For more information, see Granting Authorizations and Granting Privileges respectively in the Automic Automation documentation.

   • Automic REST API Password

     Password of the Automic REST API user.

   • Automic Web Interface (URL)

     URL to reach the Automic Web Interface.

     Example

     http://<AutomicServer>:8080/awi/

   • Job Definition Refresh Times

     Times at which AAI will refresh the job definitions. You can select multiple times.

     Note:

     When setting this parameter, take into account that refreshing the job definitions can be a time consuming task. The job definitions are read from the underlying workload automation engine and compared to the existing ones in AAI. Choose the refreshing times accordingly.

     Typically, in a production environment, job definitions are relatively static so once or twice a day is sufficient.

   • Activate Debug Log Automic Payloads to write the REST requests and responses from the Automation Engineto the log file in JSON format.

   • Projected Start Time Period (days)

     How far forward the connector should look for planned start times.

   • Historical Data Initial Load Period (days)

     How far back the connector should look the first time it fetches information.

     Default: One day

   • Event Polling Interval (seconds)

     Specific event polling interval for a particular scheduler.

   • Automic API Read Timeout (seconds)

     Timeout for AE REST API calls.

     Default: 600 seconds

   • Job Definition Retry Delay (seconds)

     Period of time after which the REST API retries to fetch object definitions if a previous attempt failed.

     Default: 60 seconds

4. Click Save Changes. The new scheduler is added to the list of already connected systems. Initially, its status is In Progress until the scheduler is completely connected to AAI.

Viewing a Scheduler

Click an existing scheduler in the list. The dialog that is displayed provides the scheduler configuration data as you entered when adding it. For details about each field, see the Adding a Scheduler section in the documentation.

Updating the Job Definition Data

When you define a new scheduler, you specify the times at which the job definitions should be refreshed in the Job Definition Refresh Times field. You can also reload the job definitions manually at any time. Do the following:

1. In the Schedulers list click the name of the scheduler.

2. On the resulting dialog, click the Edit button to make the fields editable.

3. In the Monitoring Details tab click the Update Now button that is under Job Definitions Updated.

   The last time that this data has been updated is displayed between the label and the button. This gives accurate information about the age of the data that AAI is surfacing.

Editing a Scheduler

1. In the Schedulers list click the name of the scheduler.

2. On the resulting dialog, click the Edit button to make the fields editable.

3. This dialog provides the scheduler configuration data in two tabs, Monitoring Details and Connection Configuration, as you entered them when you added it. Makes your changes. For details about each field, see Adding a Scheduler .