  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The XBRLAddContext function adds a context record to the XBRL Model context table.
Syntax/Parameters
Syntax
int = XBRLAddContext ( handle hXM, string properties[] );
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
Context 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 context. Some instance preparer guides require the ID to be formatted in a specific manner. | ||||
| Entity: | |||||
| entity | An identifier for the entity for which this context belongs. | ||||
| scheme | A URL specifying the scheme for the entity identifier. This is usually determined by the XBRL preparer’s guide, | ||||
| Period: | |||||
| date_a | An ISO-8610 formatted date specifying the instant date for a context or the start date for a duration. The value can also be ‘forever’, if allowed in the preparer’s guide. | ||||
| date_b | An optional ISO-8601 formatted date specifying the end of a duration or period of time. | ||||
| Dimensions: | |||||
| dimension_nn | If the context specifies a dimension. this value indicates the axis for an explicit or typed dimension. See text below for details on multiple dimensions. This value is required for both explicit and typed dimensions. The value specifies a QName for an existing taxonomy element/concept. | ||||
| member_nn | For explicit dimensions, this value specifies the member for the associated axis. The value specifies a QName for an existing taxonomy element/concept. If used, the domain should not be used. | ||||
| domain_nn | For typed dimensions, this value specifies the domain for the associated axis. The value specifies a QName for an existing taxonomy element/concept. If used, the member should not be used. | ||||
| value_nn | A value for a typed dimensions. | ||||
When adding dimensions, the _nn designation is from _01 to _10 (max dimensions in the model). The dimensions cannot have gaps. QNames are checked on add.
At the completion of adding contexts, 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.