CopyCompanyData

This function runs the Copy Company Data command on the Financial Consolidation Server.

Note: The function runs asynchronously on the Financial Consolidation Server.

Declaration:

Function CopyCompanyData(xmlConnectionInfo As String, language As String, year As String, periods, scenario As String, companies, entryLevels, consolidationStages, targetYear As String, targetPeriods, targetScenario As String, targetCompanies, settings As Long) As Long

Parameters:

Parameters Description
xmlConnectionInfo Connection information
language Language in which output is shown
year The source year
periods The list of source periods
scenario The source scenario
companies The list of companies to include
entryLevels The list of levels for the company-specific data to include
consolidationStages The list of consolidation stages to include
targetYear The target year
targetPeriods A list of target periods
targetScenario A list of target scenarios
targetCompanies A list of target companies
settings

The settings that define which data to copy. The values must be added if you use more than one option:

  • 1: Finance Data
  • 2: Schedule Data
  • 4: Segment Data
  • 8: Company Journals
  • 16: Company Segment Journals

Return value:

The result of the function is a numerical value. The return value indicates whether the copy company data 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.