Automation task item attributes

Main: General

Attribute name

Description

Name

Name of the Automation task item.

Status

Status of the Automation task item. The item status can be either Active or Disabled.

At least one action (either Send email report or Install/Uninstall package) must be configured for the Automation task item before the item can be activated.

Only active Automation task items deploy packages and send scheduled reports by email.

Type

When you create a new from the Automation task view the type is Automation task by default. However, there can be other values depending on the automated item. The possible values for the Type: 

Automation task
Custom Quality Index indicator
History data collector
Dynamic asset group updater

Description

Enter here a free description of the item.

  

Main: Scoping

Attribute name

Description

Select report

Select one of the existing report builder reports here.

When selecting the report, administrators see all created reports, and editors with report builder permission see all reports that they have created by themselves plus all the reports that other users have shared with them. In other words, editors don't see other users' personal reports.

Notice that you may have to re-save Report builder reports that have been created in earlier Miradore Management Suite version than 4.4.0 before the reports can be used with automation tasks.

If there is no suitable report available, you can create more custom reports with Report builder. For more information, please read How to create reports using Report builder.

In the Reporting settings section, you can configure Miradore Management Suite to send the selected report by email to the specified recipients.

In the Actions section, you can configure scheduled package deployments for the asset configuration items that are listed in a Report builder report. Notice that this option is only available for reports which list asset configuration items.

Did you know?

Automation tasks column in the Saved reports view shows how many Automation task items are bound to each Report builder report.

Main: Schedule settings


 

Attribute name

Description

Schedule time(s)

This field defines the time(s) when the Automation task is scheduled to run on the selected days. If you enter multiple times, make sure to separate them with a comma.

For example, 08:00, 17:00

Notice that Automation Engine runs every 15 minutes by default. This means that, if the defined time is, for example 12:07, the scheduled report will be sent at 12:15 when the Automation Engine runs for the next time.

Also notice that this field uses Miradore server's local time zone. The server's time zone is shown in parentheses in the field tooltip.

Start date

In case of recurring schedule, this field is used to set the date when the schedule starts. Starting from that date, the schedule will be followed weekly or monthly as defined in the Schedule settings.
    
In case of non-recurring schedule, this field can be used to define a specific date when the Automation task should run.
  
Separate multiple dates with a comma.

Recurring

This field defines whether the schedule is recurring or not. A recurring schedule is repeated regularly as defined in the other fields.
  
Once means that the schedule is not recurring. In this case, the Automation task is only performed one time as specified in the start date(s) field.

Weekly schedule recurs every week, on the selected weekdays.

Monthly schedule recurs monthly on the selected day(s) of the selected month(s).

Delay days This field defines the number of days the monthly recurring task will be postponed from the selected day.

Schedule

This field displays the calculated schedule for the Automation task item.

Main: Collected history series

Attribute name

Description

The automation task "Miradore built-in history data collector" collects and stores historical data about the managed environment to be used in dashboard widgets for reporting purposes.

There are some built-in history data collectors in Miradore Management Suite which mostly gather numeric history data about the number of active configuration items in the environment, but on top of that, Miradore Management Suite also generates a history data collector based on each quality index reports. Users can also create custom history data collectors in the dashboard widget wizard when creating history charts.

The historical data will be stored in the database for two years before the data gets automatically deleted by inventory maintenance system task.

Name

Name of the history data collector collecting the data series.

Click on the name to see which widgets are using this history data series. You can also see the effective filters and function used to collect the data.

Only user-made history data collectors can be removed.

Built-in

This field shows whether the history data collector is a built-in data collector of added by users.

Item

This field shows the configuration item about which the history data collector is gathering history data.

Type

Type of the history data.

# of widgets

Number of dashboard widgets using this data collector as a data source.

Main: Reporting settings

Attribute name

Description

Send email report

This field defines whether the report (defined in Select report field) is sent by email to the recipients (defined in Recipients field) according to the schedule (defined in Schedule settings table).

For more information, please read Scheduling reports for automatic email delivery.

Send if report is empty

This field defines whether the report (defined in Select report field) is sent by email to the recipients (defined in Recipients field) although the report would be empty. If the field value is "No" the report will not be send when there isn't any rows in the report.

This field is only visible when "Send email reports = Yes".

Email subject

This field defines the subject of the email that contains the report.

You can refer to the attached report file using %FileName% variable in the subject.

Email body

This field defines the body message of the email that contains the report.

You can refer to the attached report file using %FileName% variable in the body text.

Recipients

List of email recipients to whom the report (defined in Select report field) will be sent to.

Enter one e-mail address per line.

Main: Actions

Attribute name

Description

Add install package action...

Package

This field defines the installation package that is automatically deployed to the asset configuration item(s) listed in the report (defined in Select report field). Notice that package creator may have defined restrictions for the package deployment at the Package item page.

The selected installation package is deployed to the target asset(s) according to the schedule settings.

The package selector shows only packages which are group distributable.

Reboot

This field defines whether the target asset(s) are restarted after the package installation.

Wake up client

This field defines whether a wake-up signal is sent to Miradore clients in the target assets when a new package deployment is assigned to the devices. Having the wake up enabled speeds up the package deployment process.

When the wake-up is disabled, Miradore clients get information about the awaiting package deployment only after they poll Miradore server next time, which means that, there could be a bit longer delay before the deployment actually starts. The polling interval can be defined in Miradore system settings.

Max deployments per run

This field defines the maximum number of package deployments by the Automation task per each time when the task is run.

Add uninstall package action...

Package

This field defines the uninstallation package that is automatically deployed to the asset configuration item(s) listed in the report (defined in Select report field). Notice that package creator may have defined restrictions for the package deployment at the Package item page.

The selected package is deployed to the target asset(s) according to the schedule settings.

The package selector shows only packages which are group distributable.

Reboot

This field defines whether the target asset(s) are restarted after the uninstallation package has finished.

Wake up client

This field defines whether a wake-up signal is sent to Miradore clients in the target assets when a new package deployment is assigned to the devices. Having the wake up enabled speeds up the package deployment process.

When the wake-up is disabled, Miradore clients get information about the awaiting package deployment only after they poll Miradore server next time, which means that, there could be a bit longer delay before the deployment actually starts. The polling interval can be defined in Miradore system settings.

Max deployments per run

This field defines the maximum number of package deployments by the Automation task per each time when the task is run.

Add set timestamp action...

Action

Set current time action sets a timestamp (date and time) to the Asset configuration items' custom attribute which is defined in the "Select custom attribute" field below. The attribute value is updated for all devices listed in the selected report every time when the automation task runs.

If you want the timestamp to be set only once, instead of updating it on every run, you should add an is empty type of filter to select the report. Then the Automation task won't update the custom attribute if it already has a timestamp defined.

Reset action clears the value of the Asset configuration items' custom attribute which is defined in the "Select custom attribute" field below.

The selected action is performed when the automation task is executed. The actions are applied to all asset configuration items that are listed in the automation task item's scope (in the selected report).

Read Implementing a service timer or SLA clock case example for more information.

Select custom attribute

This field defines the Asset configuration items' custom attribute that is affected by the Set current time and Reset actions.

In this field, you can only choose custom attributes whose data type is DateTime. Administrators can manage the custom attributes in "Administration > System settings > Main > Custom attributes".

If you're planning to manage the value of a custom attribute with these Set current time and Reset actions, consider making the custom attribute non-editable through user interface, because otherwise users may also modify the attribute value.

Add change status action...

New status

There are three different statuses which can be set to the asset:

  • Active - Asset is in use and online.

  • Removed - The custom inventory data of the asset is cleared from Miradore. Removed assets can be still viewed from Miradore and reactivated if needed.

  • Withdrawn from service - Asset is not in active use, but it's not yet disposed.

Detailed status

This field is defining the asset status in more details. This field can be set disabled/enabled and if it is required or not in System settings > Main > Asset management > Asset status definitions. In the system settings user can also define as many detailed statuses as required.

Status change reason

This field offers more information about the asset status change. This field can be set disabled/enabled and if it is required or not in System settings > Main > Asset management > Asset status definitions. In the system settings user can also define as many change reasons as required.

Main: Additional information

Attribute name

Description

Attachments

You may attach files into this field. About attaching files. This field is optional.

Comments

You may add comments related to this item here. This field is optional.