  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Twenty-three — XBRL Functions (continued)
Overview
The XDXValidateXBRL function translates the XDX source file into the XBRL and runs all the XBRL and validation scripts. This is similar to the iXBRLValidate function.
Syntax/Parameters
Syntax
int = XDXValidateXBRL ( string source | handle hSource,
[handle hLog],
[dword options] );
Parameters
source
A string specifying a qualified filename. Or,
hSource
A handle to a Mapped Text Object.
hLog
An optional handle to a Log Object which will receive the validation results. If the value is omitted of is INVALID_HANDLE_VALUE the validation data will be added to the default output log for the script. To not add data to a log, use the NULL_HANDLE value.
options
An optional dword specifying output and processing options. If not supplied, the default value will be:
XT_ERROR_LEVEL_HIGH | XT_DISPLAY_PROGRESS
Return Value
An int as a formatted error code. Use the GetLastError function to retrieve a formatted error code and GetLastErrorMessage for additional detail.
Remarks
The XDXValidateXBRL take the source data and processes it to an XDX Transaction Log (XTL), then loads it into an XBRL Model and finally processes all the standing validations as if the data was iXBRL. This includes EFM, DEI and other extensions and appropriate for the taxonomy employed in the source file.
Options can be adjusted as follows:
| Define | Bitwise | Description | |||||
| Errors Processing | |||||||
| XDXV_ERROR_LEVEL_MASK | 0x00000003 | Error Type Mask | |||||
| XDXV_ERROR_LEVEL_LOW | 0x00000000 | Low Tolerance (everything dumped out) | |||||
| XDXV_ERROR_LEVEL_MEDIUM | 0x00000001 | Medium Tolerance | |||||
| XDXV_ERROR_LEVEL_HIGH | 0x00000002 | High Tolerance (no taxonomy, warnings) | |||||
| Options | |||||||
| XDXV_DISPLAY_PROGRESS | 0x00010000 | Use Progress Window | |||||
| XDXV_NO_LOG_WRAPPER | 0x00020000 | No Header or Summary on Log | |||||
Error levels set the threshold for reporting. For example, high will not report advisories on unreferenced units.
The XDXV_NO_LOG_WRAPPER flag will add only the body of error with the leading header for summary. This is useful if the log will be combines with other information and custom header and footer data will be added.
Related Functions
Platform Support
GoFiler Complete, GoFiler Corporate, GoXBRL
| 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.