Get started with custom source configuration types

You can use the provided Java files to create your own external source configuration types.

Advantages of the external source configuration type architecture:

  • It is easy for Java developers to implement.
  • The source configuration types can be loaded into Deployment Automation without restarting the server and can be used immediately in Deployment Automation components.

To get started with custom source configuration type:

  1. Download the example project from the Knowledge Base. The project includes the sct-commons support files and the example .java file.

  2. Build the example project and deploy the resulting source configuration type JAR to a test Deployment Automation environment to familiarize yourself with its behavior and implementation.

  3. Download the DA_API_Help.zip file, extract its contents, and open index.html to view the Deployment Automation Javadoc API guide.

  4. Create a project for your new source configuration type using a Java IDE such as Eclipse or IntelliJ IDEA. You can use the example project as a template.

  5. Add sct-commons-1.1.0.jar to your project's classpath.

  6. Implement the CommonIntegrator interface from sct-commons-1.1.0.jar. Package the implementation of CommonIntegrator in a jar file that you name according to your naming standard. This JAR file:

    • Contains the source configuration type definitions, implemented using annotations.

    • Is the file that you load into Deployment Automation when the source configuration type is ready for use.

    For details, see CommonIntegrator interface implementation.

  7. Define the source configuration type to include in the JAR file. To ensure components function correctly, package all runtime dependencies with the JAR.

    Note: Although a single JAR can contain multiple source configuration types, we recommend including only one type per JAR. This simplifies maintenance and avoids impacting multiple types when performing tasks such as upgrades or deletions.

  8. Load the new source configuration type into a test Deployment Automation environment. Configure a component to use it and verify that the implemented functionality works as expected.

  9. Load the source configuration type into your production Deployment Automation environment and make it available to users.

  10. Ensure that administrators who need to manage custom source configuration types are assigned the appropriate server role.

Back to top

See also: