Creating Data Services Server Artifacts

The following sections describe how to use Developer Studio to create artifacts for Data Services Server. For more information on the details of configuring data service artifacts, including namespaces, service groups, and data source types, see the Data Service Server documentation. For information on deploying the artifacts, see Packaging Artifacts Into Deployable Archives.

Creating a data service

A data service provides a Web service interface to data that is stored in relational databases, CSV files, Microsoft Excel sheets, Google spreadsheets, and more. You can create a new data service or import an existing data service from a data service descriptor (DBS) file.  

Creating a new data service

Follow these steps to create a new data service. Alternatively, you can import an existing data service.

1. Open the Developer Studio Dashboard (choose Developer Studio -> Open Dashboard) and click Data Service Project in the Data Services Server category.
2. Select Create New Data Service and click Next.
3. Type unique names for the project and data service.
4. Optionally, specify the service group, namespace, description, location, and working set for this data service.
5. Click Next and specify a unique ID for the data source.
6. Specify the type of data source you are creating, and then configure the properties that appear for that type.
   For details on configuring various data source types, see Creating Using Various Data Sources in the Data Services Server documentation.
7. A Maven POM file will be generated automatically for this project. If you want to customize the Maven options (such as including parent POM information in the file from another project in this workspace), click Next and specify the options.
8. Click Finish. The data service is created, and the data service is open in the editor. You can now right-click the data service in the outline and add queries, operations, additional data sources, and so on, or click the Source view to add components using XML.  

Importing a data service

Follow these steps to import an existing data service from a data service descriptor (DBS) file. Alternatively, you can create a new data service.

1. Open the Developer Studio Dashboard (choose Developer Studio -> Open Dashboard) and click Data Service Project in the Data Services Server category.
2. Select Import Data Service and click Next.
3. Specify the data service descriptor (DBS) file by typing its full pathname or clicking Browse and navigating to the file.
4. Optionally specify the location and working sets for this project. 
5. A Maven POM file will be generated automatically for this project. If you want to customize the Maven options (such as including parent POM information in the file from another project in this workspace), click Next and specify the options.
6. Click Finish. The data service is created, and the data service is open in the editor. You can now right-click the data service in the outline and add queries, operations, additional data sources, and so on, or click the Source view to add components using XML.

Creating a custom validator

An input validator allows a data service to validate the input parameters in a request and stop the execution of the request if the input doesn’t meet the required criteria. In addition to the default validators provided by Data Service Server, you can create your own custom validators by creating a Java class that implements the org.wso2.carbon.dataservices.core.validation.Validator interface. You can create a new custom validator or import an existing validator project.  

Creating a new custom validator

Follow these steps to create a new custom validator. Alternatively, you can import an existing validator project.

1. Open the Developer Studio Dashboard (choose Developer Studio -> Open Dashboard) and click Data Services Validator Project in the Data Services Server category.
2. Select Create New Data Services Validator Project and click Next.
3. Type a unique name for the project and specify the package and class name for this validator.
4. Optionally, specify the location and working set for this project.
5. A Maven POM file will be generated automatically for this project. If you want to customize the Maven options (such as including parent POM information in the file from another project in this workspace), click Next and specify the options.
6. Click Finish. The project is created, and the new validator class is open in the editor, where you can add your validation logic.  

Importing a validator project

Follow these steps to import an existing custom validator project. Alternatively, you can create a new custom validator.

1. Open the Developer Studio Dashboard (choose Developer Studio -> Open Dashboard) and click Data Services Validator Project in the Data Services Server category.
2. Select Import Project From Workspace and click Next.
3. Select the existing validator project, and optionally specify the location and working sets for the new project. 
4. A Maven POM file will be generated automatically for this project. If you want to customize the Maven options (such as including parent POM information in the file from another project in this workspace), click Next and specify the options.
5. Click Finish. The project is imported, and the validator class is open in the editor, where you can modify the validation logic as needed.