Creating a Mobile Project
In this section you create a Mobile Project. Mobile projects are configured to use JavaScript Data Objects (JSDO). The Mobile project type with its built-in JSDO simplifies the process of exposing OpenEdge services as REST services. The Mobile Project can also be used to create Mobile apps but since this workshop does not cover Mobile app creation, you will remove the option to create an app in one of the steps below.
Create the sports project
1. Right-click in Project Explorer and select New->OpenEdge Project. Create the new project named Sports, select the Mobile Project type configuration.
2. Leave Express setup unchecked and click Next:
3. Accept the default settings for AVM and layout options, and click Next:
4. Select the oepas1 server if it is not checked, check the box to Publish changes immediately, then click Next:
5. The Service name and relative URI are automatically generated. You are creating a Mobile service to use REST, so make sure that Create a Mobile service is checked for the SportsService, and that oepas1 is selected as the server. Then click Next:
6. You are not creating a mobile app with this project, just the REST service, so uncheck the box for that option. Then click Next:
7. You do not need to change the PROPATH. Accept the default settings and click Next:
8. The project will be using the Sports database that you added to the Developer Studio environment.
Check the box on the Sports database connection line and click Next.
9. The last screen configures the way that services will be stored and part of how they will be called.
Click Finish without making any changes to this screen.
10. Developer Studio creates your Sports project with everything you will need to create and deploy REST services on the Pacific Application Server for OpenEdge:
11. Start the oepas1 server by right-clicking on oepas1 in the Servers view and choosing Start:
12. At the bottom right corner of the PAS for OE screen, you will see that the app server is being started.
Do not wait for publish to complete. We will verify if the oepas1 application server started properly.
Creating a Business Entity to Expose Data
In this section you will create a Business Entity for the Customer table of the Sports database. Later you will expose this Business Entity via your REST service.
13. Right-click on the AppServer folder in the Sports project and select New and then Business Entity:
14. Enter the Business entity name Customer. Accept all of the other suggested default settings and click Next.
15. In the top section of the Select schema file screen, you decide which operations to make available to the REST services. Select CRUD, which stands for “Create, Read, Update, and Delete”.
In the second section, you select either a database table or an include file that represents the
ProDataSet that you wish to enable for REST. For this workshop example, check Select database table and choose the table named Customer.
Click Finish.
Compile the Service Class File
16. Developer Studio creates a new class file called Customer.cls in the AppServer node. This file includes methods for the CRUD operations that will be available to REST. These methods can be modified by inserting custom ABL code if desired but for this workshop, just accept the default code.
17. Compile the class code file: Right-click in the editor and choose Compile.
Select the Resources to Make Available
18. In the next steps, you will make the new class file available to the REST server in PAS for OE. In the Project Explorer, expand the Defined Services node. Right-click on SportsService and choose Edit:
19. Accept the default of /SportsService and click Next:
20. In the Resources section you can choose which procedures to make available to REST. Check Customer.cls by clicking on the box next to it. Also on this screen, under Sample URI, you will see the actual URI that will be used to call this REST service.
21. Click Finish.
Deploying the REST service
22. A few seconds after pressing Finish on the last step, you will see a message that the oepas1 server is publishing.
23. Wait until the oepas1 server status is Started and Synchronized and the services have been Published:
24. NOTE: If your system has trouble completing the synchronization/publish after a few minutes, right-click on oepas1 and choose Clean to clean the environment and re-deploy the services. This process will take a little while to complete.
Testing the Service in the Browser (JSDO Service)
25. Open the Google Chrome browser . 26. To view all customers:
click on the Customer Service under the Basic Backend bookmark,
Or enter this URL: http://localhost:8810/Sports/rest/SportsService/Customer
If you see the above screen after you press enter on the URL, you have successfully made the Customer table available as a REST service.
27. In Developer Studio, publishing the REST service includes the creation of a JSDO catalog. This catalog documents the service in JSON format. To view the catalog, expand the WebContent folder in your project and open SportsService.json. The JSDO catalog provides the schema of the data that is being passed during REST operations.
The catalog can be accessed by using this URL in a browser:
http://localhost:8810/Sports/static/mobile/SportsService.json
The JSDO catalog will need to be retrieved by the calling services. You will reference the catalog URI when you create Telerik samples later in this workshop.