ILM

Use the ILM script function to control the Information Lifecycle Management (ILM) functionality. You can query whether the AE database is partitioned with ILM or whether ILM is active. You can also start or stop ILM, switch out a partition, or delete a partition.

This page includes the following:

General Syntax

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

Parameters

Parameter	Description
Action	Action to take. See the sections below for details.
Parameter (Optional)	Additional definitions that accompany the corresponding Action parameter.

Installation

Syntax

ILM (INSTALLED)

Parameter	Description	Format	Allowed Values	Default Value
INSTALLED	Queries whether the AE database has been partitioned with ILM.	n.a.	n.a.	n.a.

Return Codes

Y — Partitioning with ILM is installed
N — The AE database is not partitioned

Examples

: SET &ILM# = ILM (INSTALLED)

Status

Syntax

ILM (ACTIVE)

Parameter	Description
ACTIVE	(MS SQL Server only) Queries whether ILM is active.

Return Codes

Y — ILM is active; new partitions are created and data is switched out
N — ILM is not active; the partition is not changed and no data is switched out

Examples

: SET &ILM# = ILM (ACTIVE)

Start and Stop

Syntax

ILM (START)

ILM (STOP)

Parameter	Description
START	Activates ILM. (MS SQL Server only): If ILM is active, new partitions are created and data is switched out. If ILM is not active, the partition is not changed and no data is switched out.
STOP	Deactivates ILM.

Parameter

Description

START

Activates ILM. (MS SQL Server only):

If ILM is active, new partitions are created and data is switched out.
If ILM is not active, the partition is not changed and no data is switched out.

STOP

Deactivates ILM.

Return Codes

Returns "0" after a successful start or stop, or the corresponding error number if an error has occurred.

Examples

The following example deactivates ILM.

: SET &ILM# = ILM (STOP)

Switch-Out

Syntax

ILM (SWITCHOUT [, Check])

Parameter	Description	Allowed Values	Default Value
SWITCHOUT	(MS SQL Server only) Switches out the oldest partition.	n.a.	n.a.
Check (Optional)	Defines whether a check should be made before data is switched out.	CHECK — The system checks whether the relevant partition includes data records of active tasks before switching out data. No switch-out takes place if the partition includes active tasks. NOCHECK — Data is switched out without a prior check.	CHECK

Return Codes

Returns "0" if the data switch-out was successful, or the corresponding error number if an error has occurred.

Important Considerations

This script function triggers a data switch-out but does not wait until it is complete.
The number of online partitions specified by the administrator in the ONLINE_PARTITIONS of UC_ILM_SETTINGS variable is irrelevant. For example, if four partitions are online, you can use this script function multiple times to reduce the online partitions to three, two, or one.
You cannot switch out data of the current partition. At least one partition must remain online.
Switching out data of a partition that includes data records of active tasks will result in data loss.
Contact the Support team if you want to perform forced switch-outs that involve active tasks.

Examples

The following example switches out the oldest partition using the default CHECK behavior.

: SET &ILM# = ILM (SWITCHOUT)

Check

Syntax

ILM (CHECK, Partition number)

Parameter	Description	Format
CHECK	Checks whether the specified partition includes active objects.	n.a.
Partition number	Number of the partition to check.	Script literal or script variable

Return Codes

Returns "0" if the specified partition does not include any active objects.

Examples

The following example checks partition 25.

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

Deleting a Partition

Syntax

ILM (DROP, Partition [, Check])

Parameter	Description	Format	Allowed Values	Default Value
DROP	Deletes the specified partition. Note: You can only drop a partition without losing data if it does not include data records of active tasks.	n.a.	n.a.	n.a.
Partition	Name or number of the partition to delete. Important! 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 [ODBC] INI file section of the Automation Engine is used. This user requires the corresponding authorizations.	Script literal or script variable	n.a.	n.a.
Check (Optional, Oracle databases only)	Defines whether a check should be made before the partition is deleted.	n.a.	CHECK — The system checks whether the relevant partition includes active tasks before deleting it. No deletion takes place if the partition includes active tasks. Note: This parameter is not relevant for MS SQL Server, as only staging tables can be deleted there — and these are already checked when switched out. NOCHECK — The partition is deleted without a prior check.	CHECK

Parameter

Description

Format

Allowed Values

Default Value

DROP

Deletes the specified partition.

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

n.a.

Partition

Name or number of the partition to delete.

Important! 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 [ODBC] INI file section of the Automation Engine is used. This user requires the corresponding authorizations.

Script literal or script variable

n.a.

Check

(Optional, Oracle databases only)

Defines whether a check should be made before the partition is deleted.

n.a.

CHECK — The system checks whether the relevant partition includes active tasks before deleting it. No deletion takes place if the partition includes active tasks. Note: This parameter is not relevant for MS SQL Server, as only staging tables can be deleted there — and these are already checked when switched out.
NOCHECK — The partition is deleted without a prior check.

CHECK

Return Codes

Returns "0" if the specified partition has been deleted successfully.

Examples

The following example deletes partition 25.

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