Load method: AnalyticInstance class

Syntax

Load(Sync, IdleTimeOut, Message.messagename)

Description

Use the Load method to load the AnalyticInstance object executing the method into the analytic server.

If this analytic instance is already loaded, this method fails.

When the analytic instance is loaded, if there are fields in the analytic type definition that haven't been selected but are mapped to a cube or dimension, an error message is logged to the analytic server log and the analytic instance load fails.

If there is a record in the analytic type definition that has none of its fields mapped to a cube or dimension, a warning message is logged to the analytic server log.

Parameters

Parameter	Description
Sync	Specify whether the analytic instance should be run synchronously or asynchronously. This parameter takes a Boolean value: true if it should be run synchronously, false otherwise. See Running Synchronously.
IdleTimeOut	Specify, in minutes, the idle time out value. A value of 0 is an infinite time out. A value of -1 indicates that it should use the value specified in the default configuration for the analytic server. Note: When loading an analytic grid, you should always specify a value of -1. See Analytic Calculation Engine: Loading and Unloading Analytic Instances.
Message. MessageName	Specify an application message that should be sent if the analytic server crashes while the analytic instance is loaded. Note: The message is sent when the analytic server process restarts itself after crashing.

Parameter

Description

Sync

Specify whether the analytic instance should be run synchronously or asynchronously. This parameter takes a Boolean value: true if it should be run synchronously, false otherwise.

See Running Synchronously.

IdleTimeOut

Specify, in minutes, the idle time out value. A value of 0 is an infinite time out. A value of -1 indicates that it should use the value specified in the default configuration for the analytic server.

Note: When loading an analytic grid, you should always specify a value of -1.

See Analytic Calculation Engine: Loading and Unloading Analytic Instances.

Message. MessageName

Specify an application message that should be sent if the analytic server crashes while the analytic instance is loaded.

Note: The message is sent when the analytic server process restarts itself after crashing.

Returns

A string. For asynchronous loads, this string is passed to the CheckAsyncStatus method.

This method returns one of the following values:

Value	Description
%AnalyticInstance_NotLoaded	The analytic instance has not been loaded into the analytic server.
%AnalyticInstance_Loading	The analytic instance is being loaded.
%AnalyticInstance_Idle	The analytic instance is idle, that is, not currently running.
%AnalyticInstance_Busy	The analytic instance is currently running.
%AnalyticInstance_ Inaccessible	The analytic instance is currently inaccessible.
%AnalyticInstance_ Terminating	The analytic instance is currently terminating.