Semantic type annotation added to comment by PDSOE

When an include file (.i) is selected as the schema file in the Main Annotation tab of the PDS Define Service Interface wizard, Semantic Types defined in the Fields tab are not added as annotations in either the include file or the executable ABL module file (.cls). Instead, they are added as comment lines in the .cls file

Feb 14, 2019
Knowledge

Title

URL Name

Semantic-type-annotation-added-to-comment-by-PDS

Article Number

000178960

Environment

Product: OpenEdge PDSOE Version: 11.6.3, 11.6.4 OS: Windows

Question/Problem Description

When an include file (.i) is selected as the schema file in the Main Annotation tab of the PDS Define Service Interface wizard,
Semantic Types defined in the Fields tab are added as comment lines in the .cls file instead of annotations in either the include file or the executable ABL module file (.cls).

An ABL class file Customer.cls file references an include file customer.i. The include file contains DEFINE statements for temp-table(s) and/or ProDataSet(s). Customer.cls is to be exposed as a Data Object Service using the PDSOE Define Service Interface wizard.

When the customer.i include file is selected as the schema file in the Main Annotation tab, semantic types defined in the Fields tab are not added as annotations in either customer.i or Customer.cls. Instead, they are added as comment lines in the class header comments of Customer.cls. For example:

CLASS Customer INHERITS BusinessEntity:
/*------------------------------------------------------------------------------
Purpose: 
Notes: @openapi.openedge.entity.field.property (field="Phone", name="semanticType", value="PhoneNumber").
Notes: 
------------------------------------------------------------------------------*/

{"customer.i"}

Steps to Reproduce

1. Launch PDS for OE in a new workspace. 2. Create an ABL Web App project with a Sports2000 database connection. 3. Unpack the Customer.cls and customer.i files from the attached file 000074324.zip into AppServer folder of the project. 4. Right-click Customer.cls in the Project Explorer view and select Progress OpenEdge > Define Service Interface... from the context menu. 5. Keep Definition mode as "Data Object", select Customer.cls under "Workspace resources" and all its methods under "ABL routines", and click Next. 6. Check the Enable Main Annotation check box. 7. Click on Browse... button to select Schema file 8. Enter the Schema file by browsing to customer.i in the AppServer folder of project. 9. Select dsCustmer as the Schema. 10. Click the CRUD annotations tab. 11. Click the Routine Name cell for each CRUD operation and select the similarly-named method from the drop-down list. 12. Click the Field Annotation tab. 13. Select the following values: Temp Table: ttCustomer Field: Phone Annotation: Semantic Type Annotation Details> Semantic Type: PhoneNumber 14. Click Apply, then Finish. 15. Open Customer.cls in the editor and observe a new line in the comment header containing a semantic type annotation. 16. Open customer.i in the editor and note that no semantic type annotation has been added added.

Clarifying Information

When the Customer.cls is selected as the schema file, semantic types defined in the Fields tab are added as annotations in customer.i. The extra comments are not added to Customer.cls.

The expected behavior is that any ABL file type that contains a temp-table or ProDataSet definition can be used as the schema file. A file is considered to contain a schema definition if it includes another file that contains the actual DEFINE statements. Therefore, in this example either Customer.cls or customer.i should be a valid choice for the schema file.

Error Message

Defect Number

Defect PSC00350410

Enhancement Number

Cause

Semantic Type annotations are not added properly the schema file from different location is chosen.

Resolution

Upgrade to OpenEdge 11.7.0. Where field annotations are independent of Schema file selection in Main Annotation tab. Semantic Type annotations are added properly when schema file from a different location is chosen.

Workaround

If the schema is defined in an include file (.i), specify the main executable file (.cls, .p or .w) as the schema file in the Main Annotation tab of the Define Service Interface... wizard.

Notes

References to Other Documentation:

OpenEdge Service Pack 11.6.3: New Information, Chapter 2, "Data Object Services > Business Entity Updates > Field-level annotations for semantic types"
(The above document is available in the Progress Download Center (ESD), on the 11.6.3 service pack download page, for customers who have purchased an OpenEdge 11.6 license).

Progress Article:

What to use for Schema file in Define Service Interface wizard

Keyword Phrase

Last Modified Date

11/20/2020 7:04 AM

Semantic type annotation added to comment by PDSOE

Files(1)

Was this article helpful?

Was this article helpful?

Semantic type annotation added to comment by PDSOE

Information

Related Articles