Developer Guide
Sketcher is a web application that is designed to work with a CAMA system. It comes with a JavaScript API that does two things:
- Launches the Sketcher while passing sketch data for the user to work with.
- Passes updated sketch data back to the CAMA system when the user saves in the Sketcher app.
Building an integration involves three key steps:
- Getting a development environment running.
- Using the SDK to build an integration.
- Supporting the Sketch Data Schema (SDS) data interchange format.
1. Request a Development License
Each developer and end users needs a license. Contact the DCS team to request a development license to work with.
2. Integrate with Your Applications
The Sketcher software development kit (SDK) includes sample integrations in a variety of languages, including JavaScript and C# for .NET developers.
From git clone to up-and-running, you will learn how to launch the Sketcher by passing sketch data and configuration parameters.
And you will learn how to get updated sketch data and other messages back from the Sketcher app.
The Data Cloud Solutions engineering team can optionally advise you on your integration.
3. Sketch Data
DCS developed a new open JSON format called Sketch Data Schema (SDS) to facilitate data exchange between CAMA systems. Sketcher is the first in an ecosystem of tools and products that will use the common SDS format to reduce repetitive engineering work.
DCS engineers can optionally advise you on how to use SDS as a powerful native data format for your CAMA system so that sketch data lock-in becomes a thing of the past. Or if you prefer, the open JSON-Schema spec for SDS makes it low risk to keep your own internal data format for sketches, and use SDS as a data transfer format. Sketcher works in either case.
To learn more about SDS, visit the website. The latest schema is always available on that site.
Additional information can be found in the SDS source repository.