CopyGroupJournals

This function runs the Copy Group Journals command on the Financial Consolidation Server.

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

Declaration:

Function CopyGroupJournals(xmlConnectionInfo As String, language As String, year As String, period As String, scenario As String, group As String, consolidationStages, targetYear As String, targetPeriod As String, targetScenario As String, targetGroup As String, cancelTargetJournals As Boolean, journalTypeToCopy As Long) As Long

Parameters:

Parameters Description
xmlConnectionInfo Connection information
language Language in which output is shown
year The source year
period The source period
scenario The source scenario
group The subgroup to copy
consolidationStages List of consolidation stages
targetYear The target year
targetPeriod The target period
targetScenario The target scenario
targetGroup The target group
cancelTargetJournals Indicates whether existing journals in the target are cancelled before the journals from the source are copied.
journalTypeToCopy

Defines the type of journals that must be copied:

  • 1: Automatic Journals
  • 2: Manual Journals
  • 3: All Journals

Return value:

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