createReportObjectType

Back to index

Summary

Creates a new report object type.

reportObjectTypeName

Stringrequired

Unique name of the report object type.

colorCode

Stringoptional

The color associated with the report object type, in hexcode format #rrggbb.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

displayName

Stringoptional

Display name of report object type.

sourceType

Stringoptional

Category of the third-party tool that data for the given report object type is obtained from.

sourceTypeDescription

Stringoptional

Description of the category of the third-party tool that may be displayed on the UI.

storagePattern

Stringoptional

Storage pattern for report object type.

Possible values: "NONE", "YYYY", "YYYY_MM", "YYYY_MM_dd"

Usage

Perl

$cmdr->createReportObjectType(
  "test-reportObjectTypeName" # reportObjectTypeName
  # optionals
);▼

ectool

ectool createReportObjectType \
  "test-reportObjectTypeName" `# reportObjectTypeName` \
  # optionals▼

Examples

DSL example of a report object type definition

reportObjectType 'cust_market_stats', {
  description = 'Application features delivered as part of a release'

  reportObjectAttribute 'featureName', {
   type = 'STRING'
   required = true
  }
  reportObjectAttribute 'issues', {
   type = 'NUMBER'
   required = true
  }
reportObjectAssociation 'release', {
   sourceFields = 'releaseName, releaseProjectName'
   targetFields = 'releaseName, releaseProjectName'
   required = true
  }

  reportObjectAssociation 'application', {
   sourceFields = 'applicationName, projectName'
   targetFields = 'applicationName, applicationProjectName'
  }
}▼

Perl

$cmdr->createReportObjectType("feature", {colorCode => #ff0000});▼

ectool

ectool createReportObjectType "feature" --colorCode #ff0000▼