Annotation syntax
- Last Updated: March 30, 2020
- 1 minute read
- OpenEdge
- Version 12.2
- Documentation
The Native Invocation annotation syntax is the constant "@openapi.openedge.export",
followed by the scoping value "FILE" for external
procedures, followed by a series of name-value pairs. The following
table describes the annotation name-value pairs.
| Name | Default value | Mandatory/ Optional | Description |
|---|---|---|---|
| type | ESB | Mandatory | Specifies the type of Open Client the procedure or function is exported to. The only type currently supported is ESB. |
| esboeFileName | For external procedures: %FILENAME%For internal procedures and functions: %FILENAME%_ %PROCNAME% | Optional | Specifies the name of the .esboe file. The extension automatically appended. There is one file per annotation.If esboeFileName is not specified, the default value is used. |
| executionMode | external | Mandatory | Specifies the procedure will run persistently or externally. Specify executionMode ="persistent" for a file's external procedure before internal procedures and functions can be annotated.executionMode="persistent" can only be specified for top-level external procedures. |
| useReturnValue | false | Optional | Specifies whether a return string is generated or not for a procedure.Specify useReturnValue="true" to generate a return string.If useReturnValue is not specified, no return string is generated. |
| writeDataSetBeforeImage | false | Optional | Specifies whether before-image data is written out when ProDataSet parameters are serialized as XML. Specify writeDataSetBeforeImage="true" to write the before-image data. Specify writeDataSetBeforeImage="false" to not write the before-image data. If no ProDataSet parameters exist, writeDataSetBeforeImage is ignored. |