The Data Studio SDK provides a simple Java library to create your own Workflow steps and extend the capabilities of Data Studio.

Our SDK allows you to add functionality to Data Studio that's unique to your requirements, as well as more complex and custom data manipulation via a single Workflow step. For example, you can:

  • Connect to an external service to validate some of your data
  • Perform complicated transformations such as base64 encoding
  • Trigger external services or generate data
  • Create custom file parsers to enable the conversion of input data from a wide variety of formats into data that can be manipulated within Data Studio

Get started with the SDK

Go to our Github repository to get a skeleton project and start creating your own Workflow steps. Here, you'll find comprehensive SDK documentation, including instructions on how-to and some examples to get you started.

Once you're set up with the custom step SDK, either by adding the .jar file as a dependency to your own project or by cloning our skeleton project, you can start creating your own custom step.

You'll find more detailed usage documentation in the skeleton project readme.

Download existing sample custom steps.

The SDK also contains a test framework that allows you to test your custom step and parser at the component level.

Install custom Workflow steps

Once created, you have to deploy your custom step to Data Studio:

  1. All custom steps are added as a .jar file in the addons folder in your Data Studio installation (by default, C:\Program Files\Experian\Aperture Data Studio\addons). The next step depends on your setup:
    • If you've used our skeleton project - all your classes will be compiled to a compatible jar when you run the pre-configured build task.
    • If you've added the SDK jar to your own project - you'll need to configure your build to output a jar file.
  2. Once you've added your file, you'll need to restart the Data Studio service.

Your custom Workflow step will now need to be enabled for use in any Space you require. This can be done by a Space administrator(s), following these instructions.