SyncHier
Use this command to synchronize symbol hierarchies between the Data Server repository and those of other systems. This command generates scripts that when applied, can modify a Longview hierarchy to mirror that of a third-party system or vice-versa.
Note: Symbol maintenance must be turned off before executing this command.
Syntax:
SYNCHIER DimName InFile Direction ExecMode DeleteToParent
where:
- DimName is a dimension containing the symbols of the hierarchy to be synchronized.
- InFile is the name of an ASCII input file containing symbol information and parent/child relationships. Any line beginning with an asterisk ( * ) is ignored as a comment. Assuming that the symbol already exists in the target hierarchy, any parameter left unassigned is left unchanged; however, if the symbol does not exist in the target hierarchy (and hence will need to be created), all fields must be included.
- One entry must exist representing the root symbol whereby the hierarchical structure below this root symbol is synchronized between the source and target systems. The root symbol must already exist in the source and target hierarchies.
Each line in the file has the following structure:
Parent{SymName{Weight{Desc{Type{RollUps{ChildSortOption{BalanceType[{Priority]
where:
- Parent is the parent symbol for the symbol being defined. There must exist exactly one entry that defines the root symbol. For this entry, this parameter will be left blank.
- SymName is the name of the symbol being defined.
- Weight is the mathematical effect of the child symbol on its parent. If the value of the child symbol will be added, specify +. If the value of the child symbol will be subtracted, specify -. If there is no mathematical effect, specify 0.
- Desc is the description of the symbol in the default language of the server.
- Type specifies the way the symbol rolls up to its parent symbol, and must be one of the following:
Value Description Standard
To add the symbol into the parent (for example, monthly expenses added into annual expenses).
Carryforward
When the parent value equals the value of the cell immediately preceding it (for example, cash balance as a running year-to-date, where the year-end amount equals the amount for December).
Static
When the child value has no effect on the parent value — for example, for price symbols. (The parents of such symbols are used only to group symbols, not to aggregate their values.) Static symbols do not roll up in any direction, and override any assigned weights.
- RollUps designates the rollup type and is one of: None|Auto|Dynamic, with the following combinations:
Rollups Virtual parent Receive Rollups Description NONE
FALSE
FALSE
This setting turns Rollups OFF.
AUTO
FALSE
TRUE
This is the typical configuration for Standard parents.
DYNAMIC
TRUE
TRUE
This is the typical configuration for Virtual parents.
Note: Virtual = TRUE while Rollups = FALSE is an invalid combination and therefore is not available.
- ChildSortOption is one of the following:
Value Description Ascending
Sorts the child symbols in ascending order.
Descending
Sorts the child symbols in descending order.
Manual
Allows manual sorting of child symbols.
- BalanceType is one of: Credit|Debit|Neither. Credit and Debit are only used for the Accounts dimension and indicate whether the account is a credit account or a debit account. All other dimensions use Neither.
- Priority is a number that designates a symbol's position in the hierarchy relative to its parent. Symbols are listed under their parent in order of ascending priority, with zeros falling at the bottom of the list.
- Direction specifies where the destination hierarchy resides and can be one of the following:
Value Description In
Designates that your Longview system is the destination hierarchy to be synchronized with another system.
Out
Designates that the other system's hierarchy is the target to be synchronized with the Longview hierarchy.
-
ExecMode specifies whether or not the process should be simulated or actually implemented when run and can be one of the following:
Value Description Execute
Implements the instructions and commits the designated changes to the destination hierarchy. Note that the changes are only committed when the Direction is set to In (for example, when a Longview hierarchy is the destination). Longview does not have the ability to initiate or implement changes on a third-party system, but only to generate scripts which a third-party vendor could use to accomplish the synchronization.
Simulate
Generates an ASCII output file for each type of command and will be given a name in the form: InFile_commandType.ext where InFile is input file name parameter (not including the file extension), .ext is the file extension of InFile, and commandType is one of Add, AddPC, Edit, Delete, Detatch, Assign, or Switch; for example:
"infile_Add.txt"
- DeleteToParent specifies how deleted symbols are to be handled. The following may be specified for the DeleteToParent parameter.
- The word DELETE to signify that the symbol should be completely removed from the database.
- The name of a symbol where deleted symbols should be attached. The specified symbol must already exist, already be a parent symbol, and not be part of the hierarchy being synchronized.
Syntax example - Command:
SYNCHIER Accounts Symbols.txt In Execute Delete
Syntax example - Input file entry (root):
Input file entry (root): {AYR11{{Actuals 2011{CarryForward{Auto{Manual{Neither>
Syntax example - Input file entry (non-root):
Input file entry (non-root):
AYR11{A11Q1{+{Actuals 2011 Q1{ Standard {Auto{Manual{Neither{1
A11Q1{A1101{+{Actuals Jan 2011{Standard{Auto{Manual{Neither{1
A11Q2{A1102{+{Actuals Feb 2011{Standard{Auto{Manual{Neither{2
A11Q3{A1103{+{Actuals Mar 2011{CarryForward {Auto{Manual{Neither{3
See also