Getting Started with Custom Source Configuration Types

Custom source configuration type functionality is an extended version of the existing source configuration type functionality for Deployment Automation components. It enables Deployment Automation to connect to custom entities for artifact management using Deployment Automation components.

Some advantages of the architecture include the following:

Get started creating a custom source configuration type as follows:

  1. Download the sct-commons jar file and its associated Javadoc from Knowledgebase item S142231.
  2. Using any Java/J2EE IDE, such as Eclipse or IntelliJ IDEA, create a project for your new source configuration type.
  3. Ensure that sct-commons-1.0.0.jar is in the IDE’s current class path.
  4. Implement the CommonIntegrator interface from sct-commons-1.0.0.jar. Package the concrete implementation of CommonIntegrator in a jar file that you name according to your naming standard. This includes the source configuration type definitions, which are defined using annotations, and is the file that you will load into Deployment Automation when you are ready to use the source configuration type.

  5. Define each of the source configuration types that you want to include in this jar file. For components to work successfully, all the runtime dependencies of the jar must be packaged together.
    Note: Although it is technically more efficient to include multiple source configuration types per file, it is recommended to include only one source configuration type per file, for easier maintenance going forward. If you put multiple types per file, you cannot do things like upgrade or delete without impacting all of them.
  6. Load your new source configuration type into a test Deployment Automation system. Test it by configuring a component to use it and trying out the functionality you implemented.
  7. Make your new source configuration type available to your Deployment Automation users by loading it into your production Deployment Automation system.
  8. Ensure that those administrators who should have privileges to manage custom source configuration types are given the server role to do so.

Details are included in the subsequent sections of the documentation.

Minimum requirements: