Skip to main content

# Parameter Sets

Parameters Sets are a grouping mechanism for certain properties. A Parameter Set can be applied to a Dynamic Group or a Static Group of Systems.

The properties available for grouping are: Monitoring Parameters, Check Execution, Check Notification, and Monitoring Exception Parameters.

As you can easily see, there may be situations where a certain system belongs to more than one group. If you have the same property defined in two different Parameters Sets sharing a common subset of a system, you have to prioritize the Parameters Sets in order to decide which one is finally effective.

Furthermore, for every Parameter Set, you can define if the definition of a property in a Parameter Set can or cannot be overridden on a per-system level. If cannot, you can define a consistent set of properties throughout a class of the system. But even if you allow overriding, you can re-apply the properties at any time.

Parameters Sets can be scheduled. So, for example, it's possible to have different values for Monitoring Parameters of different periods of time. You may use schedules or service hours to define the validity period of a Parameter Set.

tip

Please prioritize Parameters Sets carefully if they are scheduled.

The properties available for grouping are: Monitoring Parameters, Check Execution, Check Notification, and Monitoring Exception Parameters.

As you can easily see, there may be situations where a certain system belongs to more than one group. If you have the same property defined in two different Parameters Sets sharing a common subset of a system, you have to prioritize the Parameters Sets in order to decide which one is finally effective.

Furthermore, for every Parameter Set, you can define if the definition of a property in a Parameter Set can or cannot be overridden on a per-system level. If cannot, you can define a consistent set of properties throughout a class of the system. But even if you allow overriding, you can re-apply the properties at any time.

Parameters Sets can be scheduled. So, for example, it's possible to have different values for Monitoring Parameters of different periods of time. You may use schedules or service hours to define the validity period of a Parameter Set.

tip

Please prioritize Parameters Sets carefully if they are scheduled.

## Maintaining Parameter Sets​

### Defining Parameter Sets​

The definition of a Parameter Set is performed in several steps:

- First, you have to define the Parameter Set itself including the scope, i.e. you can define an ad-hoc System Selectors or choose an existing one.
- In a second step, you can restrict the validity period of the Parameter Set. By default, it's valid 7x24h, but you may restrict it to certain Service Hours or Schedules.
- In a thirds step, you assign Monitoring Parameters or Monitoring Exception Parameters to the defined set.
- Finally, you have to adjust the priority of the Parameter Set. In case you define the same Monitoring Parameter affecting the same System in multiple Parameter Sets, the one with the highest priority will be effective.

In order to define a parameter set, proceed as follows:

1. Select Configuration > Parameter Sets from the top-level menu. Click New.
2. Fill in a Name, select a System Type and click New in the pop-up window.
3. Switch to the Properties tab of the newly created record.
4. If you want to allow that the monitoring parameters assigned to this set can be overridden on a per-system level, check the box Allow Parameter Substitution per System.
5. Choose the systems the parameter set is applied to:
   1. You can either select an existing selector (see systems).
   2. You can define a specific ad-hoc custom selection (which is only valid for this particular parameter set). In this case, set the flag next to Define specific 'Ad-Hoc' Custom Selection and click Create. Fill in selection criteria, click Test System Selector to verify the systems, and hit the Save & Close.
6. In section Active Time Period, choose whether the parameter set is valid Always, during specific Service Hours, or during Schedules. If you choose Service Hours, click on the wrench icon, select a service hours record from the list and click OK. (See also Service Hours).
7. If you choose schedules, perform the following steps:
   1. Click New.
   2. Fill in a Name and select a Timezone value.
   3. Perform one of the following:
      - For a non-recurrent schedule: Choose the Non-recurrent tab and fill in the Start date and either an End date or a Duration.
      - For a recurrent schedule: Choose the Non-recurrent tab and fill in the Start date and either an End date or a Duration. Select a Range Start and optionally a Range End. Choose one of the following recurring options:
        - For a non-recurrent Schedule, choose the Non-recurrent tab and fill in the Start date and either an End date or a Duration.
        - For a recurrent Schedule, choose the Non-recurrent tab and fill in the Start date and either an End date or a Duration.
        - Select a Range Start and optionally a Range End.
        - Click OK.
        - Add further schedules if desired.

Range | Description
--- | ---
Daily | is effective every day or every nth day.
Weekly | is effective for selected days of every th week.
Monthly Day | is effective for a single day of every nth month, where the day of the month is given as number from 1 to 31. For values 29-31 the recurrence will fall on the last day of the month if the month has only 28, 29 or 30 days.
Monthly Weekday | is effective for a single weekday of a single week of every nth month, where the weekday may be chosen from Sunday to Saturday and the week is specified as either 1st, 2nd, 3rd, 4th or last week of the month.
Yearly Day | is effective for a single day of a single month of every year.
Yearly Weekday | is similar to Monthly Weekday, except that it's only effective for the chosen month.

1. Click Apply.

To assign monitoring parameters to the recently created set, proceed as follows:

1. Switch to the Parameters tab and choose Monitoring from the left-hand side.
2. Add, modify, or delete monitoring parameters or monitoring exception parameters.
3. Click Apply.

The parameter set is not yet active. To activate it, switch back to the Properties tab, set the Active flag, and hit the Apply again.

## Listing all Parameters Sets​

Listing all defined parameter sets is simple: select Configuration > Parameter Sets from the top-level menu.

By default parameter sets for all system types are displayed, but you can restrict the list to a certain system type using the drop-down list next to the refresh icon.

Set the Expand Parameters flag in order to have all monitoring parameters defined in the parameter set in the list view.

You can click on the info icon to display all monitoring parameters together with the values of a particular parameter set.

There are five tabs displayed, one for each system type, and one labeled View All System Types containing all defined parameter sets.

The parameter sets are always sorted by priority with the highest priority on top.

Empty parameter sets, i.e. the ones not containing any monitoring parameters, are displayed with a ban symbol in the Active column.

## Changing the Priority of Parameters Sets​

Select Configuration > Parameter Sets from the top-level menu.

To change the priority of parameter sets use the double-up/up/down/double-down arrow icons.

tip

As a rule of thumb, you should assign a low priority to parameter sets affecting all servers (SAP instances, SAP systems, databases) and those parameter sets being active all the time. Otherwise, other parameter sets may not be effective at all.

## Showing Monitoring Parameter Usage​

1. Select Configuration > Parameter Sets from the top-level menu.
2. To see the values of a particular monitoring parameter on all systems, click Parameter Usage.
3. Select the system Type and choose one or more monitoring parameters and move them to the right frame using the `>` (and `<`) icons.
4. Click Show Usage.

In the result list you have the option to change the sorting, and to restrict the list to those monitoring parameters modified on a per-system level.

## Overriding Parameter Set on a per-System level​

You can override monitoring parameters defined in parameter sets on a per-system level if and only if the set is defined with the Allow Parameter Substitution per System box checked.

Perform the following steps to allow parameter substitution for a parameter set:

1. Select Configuration > Parameter Sets from the top-level menu. Choose the desired parameter set and click Open.
2. Set the flag next to Allow Parameter Substitution per System.
3. Click Apply to finish.

In order to modify or substitute a monitoring parameter inherited from a parameter set on a system level, perform the following steps:

1. Select the appropriate system. Choose Systems > Servers, or Systems > SAP Instances, or Systems > SAP Systems, or Systems > Databases, or Systems > SAP BusinessObjects, or Systems > Cloud Services.
2. Click Open and switch to the Moni. Params. tab.
3. Proceed to the monitoring parameter supposed to change and click on the wrench icon next to the Value field. Confirm the warning message with OK.
4. Change the Value and click Apply.

caution

You cannot delete a monitoring parameter inherited from a parameter set on a system level. You have to set the value of this monitoring parameter back to its default instead!

## Deactivating Parameters Sets​

In some cases, it can be helpful to deactivate parameter sets.

1. Select Configuration > Parameter Sets from the top-level menu. Choose the desired parameter set from the list and click Open.
2. Clear the Active flag and click Apply button.

## Export and Import of Parameters Sets​

Parameter sets can be exported from a source Avantra installation and imported on a target Avantra installation. You can also use export and import to create backups for your parameter sets.

note

System selectors associated with a parameter set are only preserved when a system selector with the same name exists on the target Avantra installation. If no system selector with the same name can be found, the imported parameter set has an empty system selector. The same applies to Service Hours. Service Hours are only preserved when a Service Hour with the same name exists on the target system.

### Export Parameters Sets​

1. Select the parameter sets you want to export. You can select more than one parameter set.
2. Choose More > Export Parameter Sets.
3. A zip file containing the exported parameter sets is downloaded to your download folder.

### Import Parameters Sets​

1. Login on your Avantra installation where you want to import the exported parameter sets.
2. In Parameter Sets, choose More > Import Parameter Sets.
3. Upload previously exported parameter sets.
4. Click Next.
5. Select the parameter sets you want to import.
6. Click Next.
7. If a parameter set with the same name exists already, a new name is proposed. You can change the proposed name.
8. Click Next.
9. Click Import to confirm and execute the import.

## Predefined Parameters Sets​

If Avantra is installed the very first time on a new system, some predefined parameter sets are automatically created. The predefined parameter sets define typical settings for typical scenarios.

The name of the predefined parameter sets starts with TEMPLATE.

Those predefined parameter sets can be used as an example for your own parameter sets. You can copy, and or modify them to your needs. If you delete a predefined parameter set, Avantra does not recreate it again. The predefined parameter sets are not active after a fresh installation. You have to manually set them to active.

### List of predefined parameter sets​

Parameter Set name | Usage
--- | ---
TEMPLATE - Databases [General] | Template parameter set for databases in general.
TEMPLATE - Databases [Non-production] | Template parameter set specifically for non-production databases.
TEMPLATE - Databases [Standalone] | Template parameter set specifically for non SAP Tenant databases e.g. SYSTEMDB.
TEMPLATE - SAP Instances [General] | Template parameter set specifically for SAP Instances in general (ABAP & Java).
TEMPLATE - SAP Instances [Overnight] | Template parameter set specifically for SAP Instances during non-working hours to help to reduce the amount of false-positive alerts.
TEMPLATE - SAP Systems - HANA | Template parameter set specifically for SAP Systems on HANA. It also excludes some indexes and recurrent `data_backup_parameter_file`.
TEMPLATE - SAP Systems [General] | Template parameter set for all SAP Systems in General.
TEMPLATE - SAP Systems [PROD] | Template parameter set specifically for production SAP systems.
TEMPLATE - SAP Systems [QUAL] | Template parameter set specifically for QA/Quality SAP Systems
TEMPLATE - SAP Systems [Sandbox] | Template parameter set specifically for Sandbox SAP Systems
TEMPLATE - Servers - Unix | Template parameter set specifically for a Unix/Linux OS.
TEMPLATE - Servers - Windows | Template parameter set specifically servers with a Microsoft OS.
TEMPLATE - Servers [General] | Template parameter set for servers in general.