Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6d

Application v 6.1b

  

 

Chapter ElevenSGML Functions (continued)

11.20.6 XBRL Model — Loading Functions

These functions support the loading of instance and/or taxonomy information to an XBRL Model or creating an empty model for later export. Several functions return an XBRL Model Object handle for use in subsequent operations.

Loading an Instance

For an instance, the normal order of operations is:

–  Load the instance and get a handle (XBRLLoadInstance)

–  Optionally add one or more instance sections (XBRLAddInstance)

–  Load the taxonomy (XBRLLoadTaxonomy)

–  Post process which links the components and checks for structural errors (XBRLPostProcess)

Loading will add certain XML and XBRL errors to the Log Object, if provided.

Loading a Taxonomy

In some cases, the programmer may want to simply load a taxonomy or schema for reference. In this case, the normal order of operations is:

–  Load the taxonomy (XBRLLoadTaxonomy)

–  Post process which links the components and checks for structural errors (XBRLPostProcess)

Loading will add certain XML and XBRL errors to the Log Object, if provided.

Creating Data

[currently partly available and in beta] To create either instance data and or taxonomy data, the normal order of operations is:

–  Create an XBRL Model (XBRLCreateObject)

–  Import any schemas or taxonomies that will be relied upon (XBRLImportTaxonomy)

–  Add taxonomy data using add functions:

–  Add Data Types (XBRLAddDataType)

–  Add Concepts (XBRLAddConcept)

–  Add Definitions (XBRLAddDefintion)

–  Add Calculations (XBRLAddCalculation)

–  Add Labels (XBRLAddLabel)

–  Add Presentations (XBRLAddPresentation)

–  Add References (XBRLAddReference)

–  Optionally add instance information using the instance add functions:

–  Add Contexts (XBRLAddContext)

–  Add Units (XBRLAddUnit)

–  Add Facts (XBRLAddFact)

–  Add Footnotes (XBRLAddFootnote)

–  Post process which links to the components and checks for structural errors (XBRLPostProcess)

–  Assemble instance and/or taxonomy elements by exporting XML segments
     (XBRLExportXMLSegment)

The order of assembly is import in that if, for example, a fact must reference a context, it must have been previously defined. XML Assemble requires successive calls to XBRLExportXMLSegment to retrieve the required items.

Functions

Platform Support

Page revised 2025-08-15