Automation Engine Script Guide > Ordered by Function > Activate Objects > AUTOFORECAST

AUTOFORECAST

Script functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,…: Calculates forecastEstimates a task's runtime on the basis of previous executions. data for future activitiesDeployment-related activities

Syntax

AUTOFORECAST()

Return code

"0" - Forecast data was successfully created

Comments

The Auto Forecast provides information about tasks that will run within a specified period of time, thereby providing a comprehensive view on future activities. Forecast data can be calculated manually in the UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."] or with the scriptA particular Automation Engine object type. function AUTOFORECAST. Forecasts are then created for all active schedules and events.

This script function only calculates forecast data for the clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type. in which it is used.

With the script statement :ON_ERROR you can determine the reaction to an error. As before, you can analyze the error with the script functions for error handling. The script will continue to be processed. It is also possible to cancel the processing of the script.

Please refer to the document "Auto Forecast" in the chapter UserInterface to get further details.

The script statement causes all open transactions of the script to be written to the AE databaseA database is an organized collection of data including relevant data structures..

Examples

The following example shows how this script function can be used.

:SET &RET# = AUTOFORECAST()

 

See also:

Script element Description

FORECAST_OBJECT

Generates a forecast for the specified objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task

FORECAST_TASK

Creates a forecast for a specified taskAn executable object that is running. Tasks are also referred to as activities.

Script Elements - Activate Objects

Auto Forecast

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by Function

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH