  |
GoFiler Legato Script Reference
Legato v 1.4j Application v 5.22b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The XBRLAdduntt function adds a unit record to the XBRL Model unit table.
Syntax/Parameters
Syntax
int = XBRLAddunit ( handle hXM, string properties[], [dword flags] );
Parameters
hXM
A handle to an XBRL Object obtained using the XBRLCreateObject function.
properties
A string list containing information about the concept to be added.
Return Value
Returns an int as the index of the record position for the added item or a formatted error code on failure. The last error message will contain additional textual information regarding the failure. Use the GetLastErrorMessage and GetLastError functions to retrieve error information.
Remarks
A unit can be added to the instance tables one by one using this function. The caller must create a keyed string array using the following key names:
| Key Name | Description/Comment | ||||
| Control Information: | |||||
| id | A required unique ID to reference the unit. | ||||
| Measures: | |||||
| measure_nn | Zero or mode well known measure codes. When used, the divide key names should not be provided or their fields empty. | ||||
| measure | An optional key name to set one measure. Same as measure_01. | ||||
| Divide: | |||||
| divide_numerator | Top well known measure for a ratio. when used the denominator must be provided. | ||||
| divide_denominator | Bottom well known measure for a ratio. when used the denominator must be provided. | ||||
When adding measuress, the _nn designation is from _01 to _10 (max dimensions in the model).
At the completion of adding units, the model must be post processed using the XBRLPostProcess function to sort/resort the data for reference by other functions. The post process can be performed after all data has been added to the model.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.