Use the Define Service Interface wizard
- Last Updated: January 16, 2024
- 2 minute read
- OpenEdge
- Version 12.8
- Documentation
After you ensure that the ABL resource meets all the requirements, you can create a Data Object interface using the Define Service Interface wizard.
Follow these steps to create a Data Object interface using the Define Service Interface wizard:
- Open Progress Developer Studio for OpenEdge.
- Right-click the ABL Web App project and then select Progress OpenEdge > Define Service Interface. The Define Service Interface wizard appears.
- In the Define Service Interface wizard:
- Select Data Object as the Definition mode.
- Select the ABL resource that needs to be annotated under Workspace resources. This populates the ABL routines section on the right with the list of ABL operations in the selected resource.
- Select the ABL operations (create, read, update, submit, etc) that need to be exposed under ABL routines.
- Optionally, select Backup selected resources.
- Click Next.
- In the Edit Annotation page:
- In the Main annotation tab:
- Ensure that singleton is selected as the Execution mode.
- Click Browse and select the schema file that is being used by the ABL resource.
- Optionally, you can edit the Resource URI. By default, the ResourceURI is the ABL resource name.
- In the CRUD Annotations tab, select the routine name in the Routine Name column for each operation that needs to be exposed. Note: If you are using the Submit operation, you must select the Before-image option. The Submit option is only applicable to the datasets selected on the Main Annotation tab. It is not applicable to temp-tables.
- In the Invoke Annotations tab:
- Ensure that the Invoke option is selected for all the ABL routines that have to be exposed as Invoke operations.
- Ensure that you de-select the Invoke option for all the operations that have been mapped to standard operations (CRUD + Submit).
- In the Field Annotations tab:
- Select the relevant temp table.
- Select the temp table field for which you want to define a semantic type.
- Select Semantic Type as the annotation.
- Select the appropriate semantic type. Note: If you choose Integer, Number, Currency, Percent, or PercentValue as the semantic type, you will have to further specify its minimum and maximum values.
- Click Apply.
- Click Finish. This annotates the class file and the operations that must be exposed.