The ExternalCodeLib element references a FormalExpression in an external code library, such as a file or GitHub. The intention is to make it possible to reference existing code libraries where the code is maintained as well as making it simpler to include longer, more complex FormalExpressions. The Library attribute provides the name of the external library, whereas ref or href provides a reference to the repository that can be used to retrieve the code. The Method attribute provides the name of the method in the file referenced for cases where multiple methods are provided in the source code file. The Version element provides the version of the external FormalExpression code referenced.
| Element Name | ExternalCodeLib |
|---|
| Parent Elements | FormalExpression |
|---|
| Element XPath(s) | - /ODM/Study/MetaDataVersion/ItemDef/RangeCheck/FormalExpression/ExternalCodeLib
- /ODM/Study/MetaDataVersion/MethodDef/FormalExpression/ExternalCodeLib
- /ODM/Study/MetaDataVersion/ConditionDef/FormalExpression/ExternalCodeLib
- /ODM/Study/MetaDataVersion/Protocol/StudyEndPoints/StudyEndPoint/FormalExpression/ExternalCodeLib
- /ODM/Study/MetaDataVersion/Protocol/StudyTargetPopulation/FormalExpression/ExternalCodeLib
|
|---|
| Element Textual Value | None |
|---|
| Attributes | Library, Method, Version, ref, href |
|---|
| Child Elements | None |
|---|
| Usage/Business Rules |
|
|---|
| Attribute | Schema Datatype or Enumeration | Usage | Definition | Business Rules |
|---|
| Library | text | Required | The name of the external library containing the FormalExpression. |
|
| Method | text | Optional | The name of the method or function that contains the FormalExpression code. |
|
| Version | text | Optional | The version of the code contained in the external library. |
|
| ref | text | Optional | Reference to a local instance (e.g. file) of the external library containing the FormalExpression code. |
|
| href | URI | Optional | URL of an external code external library such as GitHub or Bitbucket. |
|