ILM

Script function: Controls ILM (Information Lifecycle Management) functionality.

General Syntax

ILM (Action [,Parameter [, Parameter]] )

Installation

Syntax

ILM (INSTALLED)

Syntax	Description/Format
INSTALLED	Queries whether the AE database has been partitioned with ILM.

This script function supplies the following return codes:

"Y" - Partitioning with ILM has been installed.
"N" - The AE database has not been partitioned.

Example

:SET &ILM# = ILM(INSTALLED)

Status

Syntax

ILM (ACTIVE)

Syntax	Description/Format
ACTIVE	Queries whether ILM is active.

This script function supplies the following return codes:

"Y" - ILM is active; new partitions are created and data is switched out (only MS SQL Server).
"N" - ILM is not active; the partition is not changed and no data is switched out (only MS SQL Server).

Example

:SET &ILM# = ILM(ACTIVE)

Start and Stop

Syntax

ILM (START)
ILM (STOP)

Syntax	Description/Format
START	Activates ILM.
STOP	Deactivates ILM.

If ILM is active, new partitions are created and data is switched out (only MS SQL Server).

If ILM is not active, the partition is not changed and no data is switched out (only MS SQL Server).

This script function returns the value "0" after a successful start or stop, or the corresponding error number if an error has occurred.

Example

ILM should be deactivated.

:SET &ILM# = ILM(STOP)

Switch-Out

Syntax

ILM (SWITCHOUT [, check])

Syntax	Description/Format
SWITCHOUT	Switches out the oldest partition.
Check	Setting that defines whether a check should be made before data is switched out. Allowed values: "CHECK" (default) and "NOCHECK" "CHECK" - The system checks whether the relevant partition includes data records of active tasks before it starts to switch out data. No switch-out takes place if it includes active tasks. "NOCHECK" - Data is switched out without a prior check.

Switching out data is a function that is specific to the MS SQL Server. It is not relevant for Oracle databases.

Warning! Note that this script function triggers a data switch-out but it does not wait until the switch-out has been completed.

This script function returns the value "0" if the data switch-out has been successful, or the corresponding error number if an error has occurred.

Warning! Note that the number of online partitions that is specified by the administrator (variable UC_ILM_SETTINGS, key ONLINE_PARTITIONS) is not considered.

Example

Four partitions are online. By using this script function several times, you can achieve that only three or two or only one of the partitions are or is online.

Note: You cannot switch out data of the current partition. At least one partition must be online.

Note: Note that switching out data of a partition that includes data records of active tasks will result in data loss.

Warning! Contact the Support team if you want to perform forced switch-outs that involve active tasks.

Example

A check is made before data is switched out because the default value for the second parameter is "CHECK".

:SET &ILM# = ILM(SWITCHOUT)

Check

Syntax

ILM (CHECK, Partition number)

Syntax	Description/Format
CHECK	Checks whether the specified partition includes active objects.
Partition number	Number of the partition. Format: script literal or script variable

This script function returns "0" if the specified partition does not include any active objects.

Example

Partition "25" is checked.

:SET &ILM# = ILM(CHECK, "25")

Deleting a Partition

Syntax

ILM (DROP, Partition [, Check])

Syntax	Description/Format
DROP	Deletes the specified partition.
Partition	Name or number of the partition. Format: script literal or script variable Warning! If you specify the name of an individual staging table (MS SQL Server), the ILM database user is not used for the deletion process. Instead, the database user specified in the Automation Engine's INI file section [ODBC] is used. Note that this user needs the corresponding authorizations for this purpose.
Check	Setting that defines whether a check should be made before the partition is deleted (only relevant for Oracle databases). Allowed values: "CHECK" (default value) and "NOCHECK" "CHECK" - The system checks whether the relevant partition includes active tasks before it starts to delete the partition. No deletion takes place if the partition includes active tasks. "NOCHECK" - The partition is deleted without a prior check.

The parameter Check is not relevant for the MS SQL Server. In the MS SQL Server, you can only delete staging tables. These tables are already checked when they are switched out.

Note that you can only drop a partition without losing data if it does not include data records of active tasks.

This script function returns "0" if the specified partition has been deleted successfully.

Example

Partition "25" is deleted.

:SET &ILM# = ILM(DROP, "25")

See also: