This is an extension for Visual Studio Code, which helps you to easily use the OData Service Generator (csdl-to-war tool) to generate an OData service (as a Java EE WAR file) from an OData CSDL file. The generated OData service can be configured to store data in a SQL database, or to use the SQL database to cache data from a backend system. The OData service can be configured with CSDL annotations for OData change tracking to support offline clients, or without change tracking to support online clients. Generated services can be deployed for production into SAP Cloud Platform (Cloud Foundry or Neo environments) or SAP Mobile Platform Server (SMP 3.1+). Apache TomEE and Eclipse Virgo are supported for local testing.
As a companion to this Visual Studio Code extension, the Mobile Backend Generator plugin for SAP Web IDE enables the generation of OData services for deployment into SAP Cloud Platform, as well as offering a graphical modeling tool for visual editing of OData CSDL models.
Command Palette Extensions
This extension provides two additional commands in the Command Palette.
MBT: New OData CSDL document (metadata)
- OData version
- Schema namespace
- Namespace alias (optional)
- Metadata file name
You can optionally use the XML Language Support by Red Hat extension which provdes support for creating and editing XML documents. When you are finished with the metadata you can use the tasks.json creator.
MBT: Create tasks.json file
- Application name
- Application version
- Database type
- Database name (optional)
- Metadata file name
- Local server path (optional)
Once the tasks.json is created, you can use Terminal → Run Task to invoke the csdl-to-war tool for generation, deployment and monitoring of the OData service. You can make changes to the the service metadata or customize previously generated code, then run the same task again to regenerate and redeploy the service. If you subsequently change your local server path, then please edit the extension's resources/extension.settings to indicate the new server path.
See csdl-to-war.html (Service Generator), cache-databases.html (Cache Databases) and mbo-migration.html (MBO Migration for customers using SMP 3.0 Mobile Business Objects).
Windows: %USERPROFILE%\.vscode\extensions\sapse.vsc-extension-mbt-X.Y.Z\resources\server-odata-sdk\docs
Linux/Mac: $HOME/.vscode/extensions/sapse.vsc-extension-mbt-X.Y.Z/resources/server-odata-sdk/docs
Local Java Documentation
Javadocs are provided for the Server OData SDK, which can be used for customization of the generated OData service.
Windows: %USERPROFILE%\.vscode\extensions\sapse.vsc-extension-mbt-X.Y.Z\resources\server-odata-sdk\javadocs
Linux/Mac: $HOME/.vscode/extensions/sapse.vsc-extension-mbt-X.Y.Z/resources/server-odata-sdk/javadocs
Before Installing the Extension
Please ensure that you have installed or viewed the following.
