ExecuteConsolidation

This function runs the consolidation rules.

Declaration:

Function ExecuteConsolidation(xmlConnectionInfo As String, language As String, years, periods, scenarios, groups, sequence As String) As ServerMessage

Parameters:

Parameters	Description
xmlConnectionInfo	Connection information
language	Language in which output is displayed
years	A list of years to consolidate
periods	A list of periods to consolidate
scenarios	A list of scenarios to consolidate
groups	A list of groups to consolidate
sequence	The name of the sequence of consolidation rules to run

Return value:

The result of the function is a numerical value. The return value indicates whether the consolidation process has been started:

Value	Enumerator	Description
0	Succeed	The process has been started.
1	ServerIsBusy	The server is busy and the process has not been started.
2	Error	An error has happened.
3	IsExecuting	At least one of the consolidation rules in the selected sequence is already running in the same context.