Try OpenEdge Now
skip to main content
Online Help
Data Object overview : Concepts : Terminology related to Data Object support
 

Terminology related to Data Object support

The following terms describe various components that apply to Data Object support in Progress Developer Studio for OpenEdge:
Term
Description
ABL routine
An ABL routine can be internal procedures, user-defined functions, or class methods.
Apache Tomcat
A Java container provided with OpenEdge that allows you to deploy Data Object services. When installing Progress Developer Studio for OpenEdge, Apache Tomcat is also installed and configured. The Tomcat Java container will be located in your OpenEdge installation directory at $DLC/servers/tomcat.
JavaScript Data Object (JSDO)
Progress-supported, JavaScript implementation of the open source Cloud Data Object. It provides client access to the data and operations of a single Data Object resource, so the client code can call methods on a JSDO to execute the Data Object operations on the server. The data for these operations is serialized between the Data Object Service and the client as JSON media. The JSDO uses a Data Service Catalog file to acquire the client resource's metadata from the server. For more information on the Cloud Data Object open source project, see http://clouddataobject.github.io/ and for detailed information on the JSDO, see the documentation on Progress Data Objects at https://documentation.progress.com/output/pdo/.
For more information, see:
Data Service Catalog file
A Data Service Catalog file is generated from a Business Entity class file in Progress Developer Studio for OpenEdge. It provides the definition of the resources in a Data Object service. The Data Service Catalog includes an entry for each built-in (CRUD and Submit) method and each invocation (or Invoke) method for a resource. It also includes the schema for the resource. The JSDO uses the schema information for its built-in CRUD and Submit methods. For each method, the catalog provides parameter mapping information. This information (metadata) from the catalog is used to construct the HTTP request for the operation calls made to the REST adapter.
For more information, see:
Business Entity
A Business Entity defines a resource that contains schema and operations (business logic) to work on the schema. It contains pre-defined Data Object interface annotations for the schema and operations. The Data Object interface annotated Business Entity class is exposed as a Data Object resource.
An OpenEdge Data Object uses the REST Adapter as an interface to the OpenEdge AppServer to run the Business Entity’s operations. A Business Entity follows a prescriptive programming model that works well with the JavaScript Data Object (JSDO). It can be exposed directly to a JSDO or as a separate service interface.
For information on creating Business Entity class files, see:
Data Object resource
A Business Entity or other singleton class or procedure that has a Data Object interface defining a data model (a single temp-table or ProDataSet) and Data Object operations. A Business Entity as defined by the OpenEdge Reference Architecture is an example of a resource. It is expected to define a data using logical schema along with business logic to access and update the data. It is always an abstraction from the physical database. This can also be considered the back end of a remote data object. For more information, see Defining Data Object resources.
Data Object Service
Data Object Service is the service interface for a resource. Resources within a Data Object service are accessed using a client side API. OpenEdge provides the JSDO, which provides this API for JavaScript clients. Each resource is defined in a catalog file which identifies the schema and operations supported for the resource. The Data Object Services defined for your project appear under the Defined Services node and the .json files appear under the WebContent node in your project directory in the Project Explorer view.
For more information, see Creating a Data Object Service.
Data Object Web Application (WAR)
A Data Object web application is one or more Data Object Services packaged for deployment to the Apache Tomcat Java container in a war format. For more information, see the Publishing Data Object Services and Exporting a Data Object Web Application.
OE Web Server
A web server that enables you to deploy, configure, and manage Data Object Services in additional to OE REST applications. The OE Web server application enables you to deploy and manage Data Object Services on the Web server. For more information, see Creating an OE Web Server instance.