Creating a New Virtual Service (REST)
To create a new virtual service (REST)
1. Open Software AG Designer and display the CloudStreams Development perspective by clicking Window > Open Perspective > Other > CloudStreams Development.
2. In the CloudStreams Governance view, right-click the CloudStreams Governance project and click New > Virtual Service (or expand the project, right-click the Virtual Services folder and click New Virtual Service).
3. In the New Virtual Service wizard, complete the following fields.
Option | Description |
Project | Click Browse and select a CloudStreams Governance project in which to create the service. |
Name | Assign a name for the service. Unlike native services, the names of virtual services cannot contain spaces or special characters except _ (underscore) and - (hyphen). Consequently, if you adopt a convention that involves using the name of the service as part of the virtual service name, then the names of the services themselves must not contain characters that are invalid in virtual service names. Note: | If you want to change the service name after it has been created, right-click the service name in the Virtual Services folder and select Rename. |
|
Version | The version is always set to 1.0. |
Service Type | Select REST. |
Description | Optional. A description for the service. This description appears when a user displays a list of services in the user interface. |
4. Click Finish.
The new virtual service is added to the CloudStreams Governance project, in the Virtual Services folder.
5. Click the new virtual service name in the CloudStreams Governance project.
The Properties view is displayed at the bottom of the editor.
6. On the Advanced page in the Properties view, click the Resource button.
7. In the REST Resources dialog box that appears, add a REST resource that the service will access by completing the following fields.
Option | Description |
Resource | Specify the name of the REST resource that the service will access. Note: | To add a REST resource to the service after the service has been created, right-click the service name and click Attach Resource. |
|
HTTP Methods | (Read-only field.) The HTTP methods that the virtual service should be allowed to perform on the REST resource (GET, POST, PUT, DELETE). You specify the HTTP methods when you configure the virtual service's Entry Step. |
Content Type | (Read-only field.) Application/xml or Application/json. |
Query String | Specify the search string as required. Any text typed in is not case sensitive. This field is used only for documentation purposes at this time. It is not included in the service's "virtual service definition" (VSD) that is deployed to CloudStreams, so this value has no impact at runtime. |
Import from | Import the schemas that the virtual service will use. Choose one of the following options. (To select multiple schemas, click the plus button to add a row.)  URL: Specify the URL of a schema and click the Add button. Optionally choose the following option: URL authentication: If you have specified a URL, and the site you want to access via the URL requires user authentication, select this option. This opens an Authentication sub-dialog in which you can enter a user name and password for authentication at the URL site. File: Click Browse to select a schema from your local file system. |
8. Click OK.
