JBoss.orgCommunity Documentation

Chapter 11. DTGov Data Model

11.1. Overview
11.2. Notification Templates (DtgovEmailTemplate)
11.3. Undeployment Information (UndeploymentInformation)
11.3.1. File Copy
11.3.2. RHQ
11.3.3. JBoss CLI
11.3.4. Maven
11.4. Workflow Queries (DtgovWorkflowQuery)
11.5. Workflow Instances (DtgovWorkflowInstance)
11.6. Deployment Targets (DtgovDeploymentTarget)
11.6.1. File Copy
11.6.2. RHQ
11.6.3. JBoss CLI
11.6.4. Maven

DTGov makes use of the configured S-RAMP repository to store various internal objects as extension artifacts. This section of the guide documents this data model, providing a list of all extension artifact types, their use, and their properties. All DTGov artifacts can be modified either via the DTGov UI or by directly manipulating them using standard S-RAMP tools.

The DTGov notification service uses templates when sending notifications to users. These templates can be stored in the S-RAMP repository and queried via:

/s-ramp/ext/DtgovEmailTemplate

Each template artifact can have the following properties:

Property NameDescription

template

A logical identifier used by the Notification Service when looking up the template to use for a particular notification.

template-type

The type of template, for example subject or body.

The DTGov deployment service stores some information about the deployment in the S-RAMP repository so that it is possible to later undeploy the deployment. A list of all these undeployment artifacts can be found via:

/s-ramp/ext/UndeploymentInformation

Each undeployment artifact can have the following properties and relationships:

Property NameDescription

deploy.target

 

deploy.type

 

deploy.classifier

 
Relationship NameDescription

describesDeployment

A relationship from the UndeploymentInformation artifact that points to the deployment artifact it describes.

Additional custom properties will be added to the undeployment info artifact depending on the type of deployment:

A primary feature of DTGov is to watch the S-RAMP repository for changes and, when it detects them, trigger a new instance of a BPMN2 workflow for the artifact that caused the change. The DTGov UI provides a way to manage these queries - each one is stored in the S-RAMP repository as a DtgovWorkflowQuery, which can be quried with the following:

/s-ramp/ext/DtgovWorkflowQuery

Each workflow query artifact can have the following properties:

Property NameDescription

query

A valid S-RAMP query used to scan the repository for matching artifacts.

workflow

The ID of the BPMN2 workflow that will be triggered when an artifact matches the query.

Additionally, the workflow query is configured with a number of custom properties configured in the UI. These properties are passed to the workflow instance when it is created. Each property is stored on the DtgovWorkflowQuery as a custom property prefixed with prop..

Whenever a workflow is triggered for an artifact in the S-RAMP repository (see the Workflow Queries section above), DTGov will add an artifact to S-RAMP that represents the workflow instance. This provides a way to easily track all of the workflow instances, their state, and which S-RAMP artifact they are governing. A list of these workflow instances can be queried using the following:

/s-ramp/ext/DtgovWorkflowInstance

Each workflow query artifact can have the following properties and relationships:

Property NameDescription

workflow.processId

The ID of the workflow instance in jBPM.

workflow.numParams

The number of parameters passed to the workflow instance when it was created.

workflow.status

The current status of the process (RUNNING, ABORTED, COMPLETED).

workflow.param.*

Each parameter passed to the workflow instance is prefixed by this.

workflow.artifactId

The ID of the S-RAMP artifact being governed.

workflow.artifactName

The name of the S-RAMP artifact being governed.

Relationship NameDescription

governs

A pointer to the artifact in S-RAMP that is being governed by this workflow instance.

The DTGov deployment service is responsible for deploying an S-RAMP artifact (deployment) into a runtime environment such as JBoss EAP or Apache Tomcat. The service must be configured with at least one logical deployment target. This configuration information is managed via the DTGov user interface. Each deployment target is stored in the S-RAMP repository as a DeploymentTargetType. These target artifacts can be queries with the following:

/s-ramp/ext/DtgovDeploymentTarget

Each workflow query artifact can have the following properties:

Property NameDescription

deployment.type

The type of deployer to use (e.g. CLI, RHQ, File Copy, Maven).

deployment.classifiers

The classifier(s) to add to the artifact being deployed.

Additional properties are added to the deployment target artifact depending on its type: