Understand the CloudBees Analytics data model

24 minute readData analytics

This section describes the CloudBees Analytics data model. It comprises several interrelated schemas that are externalized as report object types.

Data model overview

For CloudBees Analytics comprised of CloudBees CD/RO data, the following data model applies:

The data in each type is sourced as described in the below table. Select an object type for complete details about its structure.

For CloudBees Analytics comprised of CloudBees CI-only data:

Report type Object name Description

build

For events related CloudBees CI builds starting and finishing. It is used on the Workload Insights dashboard.

controller_event

For events related to CloudBees CI controllers starting and for the configuration on a controller being updated. It is used on the Workload Insights dashboard.

ci_license

For events related to current CloudBees CI licenses. Used by the License usage report.

ci_plugin

For events related to plugins being installed, uninstalled, or otherwise modified on CloudBees CI controllers. This data is used on the Plugin Usage dashboard.

ci_plugin_usage

For events related to plugins being used in various ways in CloudBees CI. It is used on the Plugin Usage dashboard.

ci_queue_event

For events related to activity in the build queue in CloudBees CI, such as new jobs entering the queue, queued jobs starting, or queued jobs being cancelled. It is used on the Workload Insights dashboard.

ci_user_login

For events related to CloudBees CI user logins. This data is used by the License usage report.

If CloudBees CD/RO is installed, these additional report types are available:

Report type Object name Description

EC-Jenkins plugin

Data derived directly from the Build plugin with contributions from the BuildCommit and Quality plugins.

EC-Jenkins plugin

Data derived directly from the plugin.

ECSCM-Git plugin

Data derived from BuildCommit plugin.

EC-JIRA plugin

Data derived directly from the plugin.

CloudBees CD/RO

Data derived from directly from CloudBees CD/RO.

EC-JIRA plugin

Data derived directly from the plugin with contributions from release and project data.

EC-FeatureFlags plugin

Data derived directly from the plugin.

EC-ServiceNow plugin

Data derived directly from the plugin.

Job

CloudBees CD/RO

Data derived from directly from CloudBees CD/RO.

CloudBees CD/RO

Data derived from directly from CloudBees CD/RO, with contributions from Deployment.

EC-ALM plugin

Data derived directly from the plugin.

CloudBees CD/RO

Feature, Defect, Incident, PipelineRun, Deployment, Quality, and Build report object types contribute to data in this object

Report object type reference for CloudBees CD/RO-only data

These report types are available when the data is sourced from CloudBees CD/RO.

Build

  • Object type: Build

  • Report object name: build

  • Description: Build data from Jenkins or CloudBees CD/RO.

Attribute Display Name Type Description

baseDrilldownUrl

Base Drilldown URL

STRING

Base URL used to construct the full URL for drilling down from a widget into an external build system such as Jenkins. For example, https://10.200.1.171:8080/job/CrossWing.

buildNumber

Build Number

STRING

Unique build number or identifier assigned to the build by the build system.

buildStatus

Build Status

STRING

Current status of the build: SUCCESS, FAILURE, UNSTABLE (Jenkins only), NOT_BUILT, ABORTED, or WARNING.

duration

Duration

NUMBER

Duration of the build in milliseconds.

endTime

End Time

DATETIME

End date and time for the build. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

launchedBy

Launched By

STRING

User or process that launched the build.

pluginConfiguration

Plugin Configuration

STRING

Name of the plugin configuration if the data was populated through EC-Jenkins.

pluginName

Plugin Name

STRING

Name of the plugin if the data was populated through a plugin such as EC-Jenkins. For example, EC-Jenkins.

projectName

Build System Project Name

STRING

Name of the project in the build system. For example, the Jenkins project name for Jenkins builds, the CloudBees CD/RO project name for polling builds, or the build project name in TFS.

releaseName

Release Name

STRING

Name of the CloudBees CI release to which the build belongs.

releaseProjectName

Release Project Name

STRING

Name of the project containing the release to which the build belongs.

releaseUri

Release URI

STRING

Partial URL that can be used along with baseDrilldownUrl to construct the drill-down URL to navigate to builds associated with the current release. The continuous integration system must allow such URLs. For Jenkins, CloudBees Analytics does not use this field, because Jenkins does not provide this ability.

You can drill down only into the builds of a specific project in Jenkins.

source

Build System Type

STRING

Name of the continuous integration system. For example, Jenkins.

sourceUrl

Build URL

STRING

URL for the build record. For example, https://10.200.1.171:8080/job/CrossWing.

startTime

Start Time

DATETIME

Starting date and time for the build. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

tags

Tags

STRING

Tags or labels associated with the build.

timestamp

Timestamp

DATETIME

Date and time that the build completed. The system uses this field to determine the time-based index for storing the build record by year. For example, builds that completed in 2017 are stored in the index ef-build-2017.

The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

jobName

Job Name

STRING

Name of the job. For CloudBees CI builds, this is set using the name of the job started by CloudBees CD/RO to run the build. It is not used for Jenkins builds.

Build commit

  • Object type: Build Commit

  • Report object name: build_commit

  • Description: Source code changesets included in builds done by CloudBees CD/RO or Jenkins continuous integration system.

Attribute Display Name Type Description

buildUrl

Build URL

STRING

URL for the build record. For example, https://10.200.1.171:8080/job/CrossWing.

buildNumber

Build Number

STRING

Unique build number or identifier assigned to the build by the build system.

startTime

Start Time

DATETIME

Start date and time for the build. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569ZÂ.

endTime

End Time

DATETIME

End date and time for the build. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569ZÂ.

buildStatus

Build Status

STRING

Current status of the build: SUCCESS, FAILURE, UNSTABLE (Jenkins only), NOT_BUILT, ABORTED, or WARNING.

projectName

Build System Project Name

STRING

Name of the project in the build system. For example, the Jenkins project name for Jenkins builds, the project name for CloudBees CI builds, or the build project name in TFS.

tags

Tags

STRING

Tags or labels associated with the build.

buildSource

Build System Type

STRING

Name of the continuous integration system. For example, Jenkins.

commitDate

Commit Date

DATETIME

Date when the changeset was committed or checked into the source control system.

commitId

Commit ID

STRING

Unique identifier for the changeset in the source control management system. For example, SHA number in Git or changelist number in Perforce.

commitUrl

Commit URL

STRING

URL to the changeset in the SCM repository.

jobName

Job Name

STRING

Name of the job. For CloudBees CI builds, this is set using the name of the job started by CloudBees CD/RO to run the build. Not used for Jenkins builds.

scmRepoBranch

SCM Repository Branch

STRING

Repository branch: Specific to Git or Git-based SCMs. For example, master.

scmSource

SCM Type

STRING

Name of the source control management system. For example, Git or Perforce.

scmUrl

SCM Server URL

STRING

URL to the SCM repository or the SCM server name. For example, git://git.apache.org/zookeeper.git.

Code commit

  • Object type: Code Commit

  • Report object name: code_commit

  • Description: Code commit or changeset data from Git or GitHub source code management systems.

Attribute Display Name Type Description

pluginConfiguration

Plugin Configuration

STRING

Name of the plugin configuration if the data was populated through a plugin such as ECSCM-Git.

pluginName

Plugin Name

STRING

Name of the plugin if the data was populated through a plugin. For example, ECSCM-Git.

source

SCM Type

STRING

Name of the source control management system. For example, Git or Perforce.

sourceUrl

Commit URL

STRING

URL to the changeset in the SCM repository.

baseDrilldownUrl

BaseDrilldown Url

STRING

Base URL used to construct the full URL for drilling down from a widget into an external source control management system such as Git. For example, git://git.apache.org/zookeeper.git.

commitDate

Commit Date

DATETIME

Date when the changeset was committed or checked into the source control system.

scmUrl

SCM Server URL

STRING

URL to the SCM repository or the SCM server name. For example, git://git.apache.org/zookeeper.git.

scmRepoBranch

SCM Repository Branch

STRING

Repository branch. This is specific to Git or Git-based SCMs. For example, master.

commitId

Commit ID

STRING

Unique identifier for the changeset in the source control management system. For example, the SHA number in Git or the changelist number in Perforce.

commitAuthor

Commit Author

STRING

Changeset author name

commitAuthorId

Commit Author ID

STRING

Unique identifier for the changeset author in the source control management system. For example, top-dev@my-org.com.

commitMessage

Commit Message

STRING

Commit message provided with the commit or changeset.

codeLinesAdded

Code Line Added

NUMBER

Number of code lines added in the commit or changeset.

codeLinesUpdated

Code lines Updated

NUMBER

Number of code lines updated in the commit or changeset.

codeLinesRemoved

Code Lines Removed

NUMBER

Number of code lines deleted in the commit or changeset.

filesAdded

Files Added

NUMBER

Number of files added in the commit or changeset.

filesUpdated

File Updated

NUMBER

Number of files updated in the commit or changeset.

filesRemoved

Filed Removed

NUMBER

Number of files removed in the commit or changeset.

Defect

  • Object type: Defect

  • Report object name: defect

  • Description: Defects logged in the Atlassian JIRA defect tracking system.

Attribute Display Name Type Description

baseDrilldownUrl

Base Drilldown Url

STRING

Base URL used to construct the full URL for drilling down from a widget into a defect-tracking system such as Atlassian JIRA. For example, https://jira101.myco.com?jql=project%3DTEST%20AND%20issuetype%3DBug.

createdOn

Created On

DATETIME

Date and time that the defect was created. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

defectName

Defect Name

STRING

Name of the defect.

key

Unique Defect ID

STRING

Unique identifier for the defect in the defect tracking system.

modifiedOn

Modified On

DATETIME

Date and time that the defect was last modified. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

pluginConfiguration

Plugin Configuration

STRING

Name of the plugin configuration if the data was populated through EC-JIRA.

pluginName

Plugin Name

STRING

Name of the plugin if the data was populated through EC-JIRA. For example, EC-JIRA.

releaseName

Release Name

STRING

Name of the release containing the defect.

releaseProjectName

Release Project Name

STRING

Name of the project containing the defect.

releaseUri

Release URI

STRING

Partial URL that can be used along with baseDrilldownUrl to construct the drill-down URL to navigate to the defects associated with the current release in the project management system.

For example, for JIRA, if baseDrilldownUrl is set to https://jira101.myco.com?jql=project%3DTEST%20AND%20issuetype%3DBug, and the defects associated with the current release are assigned fixVersion value 7.5, then the release URI can be set as fixVersion=7.5 to then construct the external URL in the widget definition as ${baseDrilldownUrl}%20AND%20${releaseUri}. This is expanded when the widget is rendered in the UI to https://jira101.myco.com?jql=project%3DTEST%20AND%20issuetype%3DBug%20AND%20fixVersion=7.5 as a drill-down link.

resolution

Resolution

STRING

Current resolution of the defect. The possible values depend on the defect tracking system.

resolvedOn

Resolved On

DATETIME

Date and time that the defect was resolved. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

source

Source

STRING

Name of the defect tracking system. For example, JIRA.

sourceUrl

Source Url

STRING

URL for the defect record. For example, https://jira101.myco.com?jql=project%3DTEST%20AND%20issuetype%3DBug.

status

Status

STRING

Current status of the defect: Open, Inprogress, Resolved, or Closed.

timestamp

Timestamp

DATETIME

Date and time when the defect record was last updated. The system uses this field to determine the time-based index for storing the defect records by year. For example, defects updated in 2017 are stored in the index ef-defect-2017.

The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

type

Type

STRING

Defect type. The possible values depend on the defect tracking system. The possible value for JIRA is Bug.

Deployment

  • Object type: Deployment

  • Report object name: deployment

  • Description: Data from CloudBees CD/RO application or microservice deployments.

Attribute Display Name Type Description

applicationId

Application ID

STRING

Unique ID of the application that was deployed.

applicationName

Application Name

STRING

Name of the application.

approvedBy

Approved By

STRING

User who approved the manual step.

clusterName

Cluster Name

STRING

Name of the cluster to which the service was deployed.

comment

Comment

STRING

Comment provided when the user completed the manual step.

deploymentOutcome

Deployment Outcome

STRING

Outcome of the deployment: Success, Error, Warning, or Skipped (check the job outcome).

elapsedTime

Elapsed Time

STRING

Time taken by the deployment to complete (in milliseconds).

environmentId

Environment ID

STRING

Unique ID of the environment to which the application or service was deployed.

environmentName

Environment Name

STRING

Name of the environment.

environmentProjectName

Environment Project Name

STRING

Name of the environment project.

flowRuntimeId

Runtime ID

STRING

ID of the pipeline run that started or triggered the deployment.

flowRuntimeName

Runtime Name

STRING

Name of the pipeline run that started deployment.

flowRuntimeStateName

Runtime State Name

STRING

Name of the stage or task that started the deployment.

groupName

Group Name

STRING

Name of the group containing the task.

jobAbortStatus

Job Abort Status

STRING

Abort status if the job was aborted: ABORT or FORCEABORT.

jobAbortedBy

Job Aborted By

STRING

User who aborted the job.

jobFinish

Job Finish

DATETIME

Job completion time.

jobId

Job ID

STRING

Unique job ID.

jobName

Job Name

STRING

Name of the job.

jobOutcome

Job Outcome

STRING

Outcome of the job: Success, Error, Warning, or Skipped.

jobStart

Job Start

DATETIME

Job start time

jobStatus

Job Status

STRING

Status of the job: pending, runnable, running, or scheduled.

jobStepAbortStatus

Job Step Abort Status

STRING

Abort status of the job step: ABORT or FORCE_ABORT.

jobStepAbortedBy

Job Step Aborted By

STRING

User or project that aborted the job step.

jobStepName

Job Step Name

STRING

Name of the job step.

jobStepOutcome

Job Step Outcome

STRING

Outcome of the job step: Success, Error, Warning, or Skipped.

jobStepStatus

Job Step Status

STRING

Status of the job step: Pending, Runnable, Scheduled, Running, or Completed.

jobStepType

Job Step Type

STRING

Type of the job step.

jobType

Job Type

STRING

Type of the job: rollback (set only for rollback jobs).

launchedByUser

Launched By User

STRING

User who launched the job.

manual

Manual

BOOLEAN

Boolean flag to indicate if a step is manual.

parentTaskId

Parent Task ID

STRING

ID of parent task.

parentTaskName

Parent Task Name

STRING

Name of the parent task.

parentTaskType

Parent Task Type

STRING

Task type of the parent task.

pipelineId

Pipeline ID

STRING

ID of the pipeline containing the task that launched the job.

pipelineName

Pipeline Name

STRING

Name of the pipeline containing the task that launched the job.

pipelineRunOutcome

Pipeline Run Outcome

STRING

Outcome of the pipeline run: Success, Error, Warning, Skipped, or Aborted.

plannedEndTime

Planned End Time

DATETIME

Planned end date of the task that triggered the deployment.

plannedStartTime

Planned Start Time

DATETIME

Planned start date of the task that triggered the deployment.

pluginDisplayName

Plugin Display Name

STRING

Display name of the plugin.

pluginKey

Plugin Key

STRING

Key of the plugin.

processId

Process ID

STRING

ID of the process that launched the job.

processName

Process Name

STRING

Name of the process that launched the job.

processStepName

Process Step Name

STRING

Name of the process step in the process.

projectId

Project ID

STRING

ID of the project.

projectName

Project Name

STRING

Name of the project.

releaseId

Release ID

STRING

ID of the release to which the pipeline runs belongs.

releaseName

Release Name

STRING

Name of the release to which the pipeline run belongs.

releaseProjectName

Release Project Name

STRING

Name of the project containing the release.

reportEventType

Report Event Type

STRING

Type of report event:

ef_pipeline_run_completed ef_pipeline_run_gate_completed ef_pipeline_run_gate_started ef_pipeline_run_stage_completed ef_pipeline_run_stage_started ef_pipeline_run_started ef_pipeline_run_task_completed ef_pipeline_run_task_started ef_process_run_completed ef_process_run_rollback_step_completed ef_process_run_rollback_step_started ef_process_run_started ef_process_run_step_retry_completed ef_process_run_step_retry_started ef_process_run_waiting_on_manual ef_process_run_waiting_on_manual_completed

retries

Retries

NUMBER

Number of times to retry a step upon an error.

retryType

Retry Type

STRING

Type of retry: auto or manual

serviceId

Service ID

STRING

ID of the service associated with the job.

serviceName

Service Name

STRING

Name of the service associated with the job.

stageName

Stage Name

STRING

Name of the stage containing the task that launched the job.

taskName

Task Name

STRING

Name of the task that launched the job.

taskStatus

Task Status

STRING

Status of the task.

taskType

Task Type

STRING

Type of task:

APPROVAL COMMAND CONDITIONAL DEPLOYER GROUP MANUAL PIPELINE PLUGIN PROCEDURE PROCESS RELEASE UTILITY WORKFLOW

tierMapName

Tier Map Name

STRING

Name of the tier map.

waitForPlannedStart

Wait For Planned Start

BOOLEAN

Boolean flag that represents whether a task should wait for a planned start date before running.

Feature

  • Object type: Feature

  • Report object name: feature

  • Description: Features or stories tracked in the Atlassian JIRA project management tool.

Attribute Display Name Type Description

baseDrilldownUrl

Base Drilldown Url

STRING

Base URL used to construct the full URL for drilling down from a widget into a system such as JIRA. For example, https://jira101.myco.com?jql=project%3DTEST%20AND%20issuetype%3DStory.

createdOn

Created On

DATETIME

Date and time that the feature was created. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

featureName

Feature Name

STRING

Name of the feature.

featuretype

Feature Type

STRING

Type of the feature : Improvement, New Feature, or Story.

key

Unique Feature ID

STRING

Unique identifier for the feature in the project management tool.

modifiedOn

Modified On

DATETIME

Date and time that the feature was last modified. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

pluginConfiguration

Plugin Configuration

STRING

Name of the plugin configuration if the data was populated through EC-JIRA.

pluginName

Plugin Name

STRING

Name of the plugin if the data was populated through EC-JIRA. For example, EC-JIRA.

releaseName

Release Name

STRING

Name of the release containing the feature.

releaseProjectName

Release Project Name

STRING

Name of the project containing the feature.

releaseUri

Release URI

STRING

Partial URL that can be used along with baseDrilldownUrl to construct the drill-down URL to navigate to the features associated with the current release in the project management system. For example, for JIRA, if baseDrilldownUrl was set to https://jira101.myco.com?jql=project%3DTEST%20AND%20issuetype%3DStory, and if the features associated with the current release were assigned fixVersion value 7.5, then releaseUri can be set as fixVersion=7.5 to then construct the external URL in the widget definition as ${baseDrilldownUrl}%20AND%20${releaseUri}. This is expanded when the widget is rendered in the UI to https://jira101.myco.com?jql=project%3DTEST%20AND%20issuetype%3DStory%20AND%20fixVersion=7.5 as a drill-down link.

resolution

Resolution

STRING

Current resolution of the feature. Possible values include: Fixed, Duplicate, Won’t Fix, Incomplete, or Cannot Reproduce.

resolvedOn

Resolved On

DATETIME

Date and time that the feature was resolved. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

source

Source

STRING

Name of the project management tool. For example, JIRA.

sourceUrl

Source Url

STRING

URL for the feature record. For example, https://jira101.myco.com/browse/ARR-18001.

status

Status

STRING

Current status of the feature: Open, Inprogress, Resolved or Closed.

storyPoints

Story Points

NUMBER

Number of story points assigned to the feature. This can be any integer.

tags

Tags

STRING

Tags or labels associated with the feature.

timestamp

Timestamp

DATETIME

Date and time that the feature record was last updated. The system uses this field to determine the time-based index for storing the feature records by year. For example, features updated in 2017 are stored in the index ef-feature-2017.

The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

Feature flags

  • Object type: Feature Flag Report

  • Object name: feature_flag

  • Description: Data from Feature Flag Management

Attribute Display Name Type Description

Release information

releaseName

Release Name

STRING

Name of the CloudBees CD/RO release collected data relates to.

releaseProjectName

Release Project Name

STRING

Name of the CloudBees CD/RO release project collected data relates to.

Context information

applicationId

Application ID

STRING

The ID of the application from which to retrieve flags.

applicationName

Application Name

STRING

Name of the application.

environmentId

Environment ID

STRING

Unique ID of the environment to which the application was deployed.

environmentName

Environment Name

STRING

Name of the environment.

Feature flag information

name

Name

STRING

The name of the feature flag,

description

Description

STRING

The user-provided description of the feature flag.

created

Created

DATETIME

updated

Updated

DATETIME

enabled

Enabled

BOOLEAN

If true, this flag is enabled.

labels

Labels

STRING

platforms

Platforms

STRING

permanent

BOOLEAN

If true, this flag is permanent.

status

Status

STRING

enumerationValues = active,stale,inactive,setup,permanent

Event generation time

timestamp

Time Stamp

DATETIME

Usage information

numberOfUsages

Number of Usages

NUMBER

The number of feature flag usage for the last polling interval date range (by default 6 hours) or the summarized number of usages from the beginning.

Incident

  • Object type: Incident

  • Report object name: incident

  • Description: Incidents logged and managed in the ServiceNow ITSM system for post-production deployed releases.

Attribute Display Name Type Description

baseDrilldownUrl

Base Drilldown Url

STRING

Base URL used to construct the full URL for drilling down from a widget into a system such as ServiceNow. For example, https://ven02149.service-now.com/incident_list.do?sysparm_query=incident_state=6ORincident_state=7.

category

Category

STRING

Category containing the incident. The possible values depend on the ITSM system.

configurationItem

Configuration Item

STRING

Configuration item name for the incident in the ITSM system.

createdOn

Created On

DATETIME

Date and time that the incident was created. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

incidentId

Unique Incident ID

STRING

Unique ID of the incident.

modifiedOn

Modified On

DATETIME

Date and time that the incident was last modified. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

pluginConfiguration

Plugin Configuration

STRING

Name of the plugin configuration if the data was populated through EC-ServiceNow.

pluginName

Plugin Name

STRING

Name of the plugin if the data was populated through EC-ServiceNow. For example, EC-ServiceNow.

priority

Priority

STRING

Incident priority. The possible values depend on the ITSM system.

releaseName

Release Name

STRING

Name of the release for which the incident occurred.

releaseProjectName

Release Project Name

STRING

Name of the project containing the release for which the incident occurred.

releaseUri

Release URI

STRING

Partial URL that can be used along with baseDrilldownUrl to construct the drill-down URL to navigate to the incidents associated with the current release in the ITSM system. For example, for ServiceNow, if baseDrilldownUrl is set to show all resolved or closed incidents: https://ven02149.service-now.com/incident_list.do?sysparm_query=incident_state=6ORincident_state=7, and if the incidents associated with the current release belonged to the online-portal category, then the release URL can be set as category=software to construct the external URL in the widget definition as ${baseDrilldownUrl}^${releaseUri}. This is expanded when the widget is rendered in the UI to https://ven01735.service-now.com/incident_list.do?sysparm_query=incident_state=6ORincident_state=7^category=software as a drill-down link.

reportedBy

Reported By

STRING

Username of the reporter of the incident.

resolvedOn

Resolved On

DATETIME

Date and time that the incident was resolved. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

source

Source

STRING

Name of the ITSM system. For example, ServiceNow.

sourceUrl

Source URL

STRING

URL for the incident record in the source system. For example, https://ven02149.service-now.com/nav_to.do?uri=incident.do?sys_id=46ee0924a9fe198100f1cf78c198454a.

status

Status

STRING

Current status of the incident. Possible values include New, Active, Resolved, or Closed. The actual values depend on the ITSM system.

subCategory

Sob Category

STRING

Subcategory containing the incident. The possible values depend on the ITSM system.

timestamp

Timestamp

DATETIME

Date and time when the incident was last updated. The system uses this field to determine the time-based index for storing the incident records by year. For example, updated in 2017 are stored in the index ef-incident-2017.

The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

Job

  • Object type: CloudBees CD/RO Job

  • Report object name: job

  • Description: Data from CloudBees CD/RO jobs (the output associated with invoking a CloudBees CD/RO procedure or process).

Attribute Display Name Type Description

applicationId

Application ID

STRING

Unique ID of the application process for which the job was run.

applicationName

Application Name

STRING

Name of the application.

elapsedTime

Elapsed Time

STRING

Time taken by the job to complete (in milliseconds).

environmentId

Environment ID

STRING

Unique ID of the environment to which the application or service was deployed.

environmentName

Environment Name

STRING

Name of the environment.

environmentProjectName

Environment Project Name

STRING

Name of the environment project.

flowRuntimeId

Pipeline Run ID

STRING

ID of the pipeline run that started or triggered the job.

jobFinish

End Time

DATETIME

Job completion time.

jobID

Job ID

STRING

Unique job ID.

jobName

Job Name

STRING

Name of the job.

jobStart

Start Time

DATETIME

Job start time.

combinedStatus

Job Result

STRING

Set using combinedStatus. Job details are sent for completed jobs only, so possible values based on terminal combined status are Aborted, Error, Success, Warning, or Skipped.

launchedByUser

Launched By User

STRING

User who launched the job.

pipelineId

Pipeline ID

STRING

ID of the pipeline containing the task that launched the job.

projectName

Project Name

STRING

Name of the project.

releaseId

Release ID

STRING

ID of the release to which the pipeline runs belongs.

releaseName

Release Name

STRING

Name of the release to which the pipeline run belongs.

releaseProjectName

Release Project Name

STRING

Name of the project containing the release.

serviceId

Service ID

STRING

ID of the service associated with the job.

serviceName

Service Name

STRING

Name of the service associated with the job.

tags

Tags

STRING

Tags associated with the job.

Pipeline run

  • Object type: Pipeline Run

  • Report object name: pipelinerun

  • Description: Data from pipeline runs in CloudBees CD/RO such as pipeline run outcome and runtime start and end times.

Attribute Display Name Type Description

action

Manual task/step action

STRING

Action the user took to complete the manual task or step: completed or failed.

applicationName

Application Name

STRING

Name of the application.

applicationProjectName

Application Project Name

STRING

Name of the project containing the application.

approvedBy

Approved By

STRING

Name of the user who approved the stage or gate task.

approvers

Approvers

STRING

List of approvers for the stage or gate task.

elapsedTime

Elapsed Time

STRING

Time taken by the pipeline run to complete (in milliseconds).

evidence

Evidence

STRING

Evidence that the task was run.

flowRuntimeAbortStatus

Pipeline Run Abort Status

STRING

Abort status of the pipeline run if it was aborted: ABORT or FORCEABORT.

flowRuntimeAbortedBy

Pipeline Run Aborted By

STRING

User who aborted the pipeline run.

flowRuntimeCompleted

Pipeline Run Completed

BOOLEAN

Boolean flag to indicate if the pipeline run is completed.

flowRuntimeFinish

Pipeline Run Finish Time

DATETIME

Time when the pipeline run was completed.

flowRuntimeId

Pipeline Run ID

STRING

ID of the pipeline run.

flowRuntimeName

Runtime Name

STRING

Name of the pipeline run.

flowRuntimeStart

Pipeline Run Start Time

DATETIME

Time when the pipeline run started.

flowRuntimeStateAbortStatus

Task/Stage Run abort status

STRING

Abort status of a stage, task, or gate associated with the pipeline run: ABORT or FORCEABORT.

flowRuntimeStateAbortedBy

Task/Stage Run aborted by

STRING

User who aborted the stage, task, or gate in the pipeline run.

flowRuntimeStateFinish

Task/Stage Run finish time

DATETIME

Time when the stage, task, or gate finished execution in the pipeline run.

flowRuntimeStateId

Task/Stage Run ID

STRING

ID of the runtime object associated with the stage, task, or gate in the pipeline run.

flowRuntimeStateName

Runtime State Name

STRING

Name of the runtime object associated with the stage, task, or gate in the pipeline run.

flowRuntimeStateOutcome

Runtime State Outcome

STRING

Outcome of execution of the runtime object associated with the stage, task, or gate in the pipeline run: Success, Error, Warning, or Skipped.

flowRuntimeStateStart

Task/Stage Run start time

DATETIME

Time when the stage, task, or gate started execution in the pipeline run.

gateType

Gate Type

STRING

Type of gate: PRE or POST.

groupName

Group Name

STRING

Name of the group task.

manual

Manual

BOOLEAN

Boolean flag to indicate if it is a manual or an approval task.

parentTaskId

Parent Task ID

STRING

Id of parent task.

parentTaskName

Parent Task Name

STRING

Name of the parent task (either a deployer task or a group task).

parentTaskType

Parent Task Type

STRING

Type of the parent task.

pipelineId

Pipeline ID

STRING

Unique ID of the pipeline.

pipelineName

Pipeline Name

STRING

Name of the pipeline.

pipelineRunOutcome

Pipeline Run Outcome

STRING

Outcome of the pipeline run: Success, Error, Warning, or Skipped.

projectId

Project ID

STRING

ID of the project containing the pipeline run.

projectName

Project Name

STRING

Name of the project containing the pipeline run.

releaseId

Release ID

STRING

ID of the release associated with the pipeline run.

releaseName

Release Name

STRING

Name of the release associated with the pipeline run.

releaseProjectName

Release Project Name

STRING

Name of the project containing the release associated with the pipeline run.

reportEventType

Report Event Type

STRING

Type of the report event:

ef_pipeline_run_completed ef_pipeline_run_gate_completed ef_pipeline_run_gate_started ef_pipeline_run_stage_completed ef_pipeline_run_stage_started ef_pipeline_run_started ef_pipeline_run_task_completed ef_pipeline_run_task_started ef_process_run_completed ef_process_run_rollback_step_completed ef_process_run_rollback_step_started ef_process_run_started ef_process_run_step_retry_completed ef_process_run_step_retry_started ef_process_run_waiting_on_manual ef_process_run_waiting_on_manual_completed

retries

Retries

NUMBER

Number of times to retry the step after an error.

retryType

Retry Type

STRING

Type of retry: auto or manual.

serviceName

Service Name

STRING

ID of the service.

serviceProjectName

Stage Project Name

STRING

Name of the project that contains the service.

stageName

Stage name

STRING

Name of the stage that contains the task.

tags

Tags

STRING

Tags associated with a pipeline or release run.

taskName

Task Name

STRING

Name of the task.

taskStatus

Task Status

STRING

Status of the task.

taskType

Task Type

STRING

Type of task:

APPROVAL COMMAND CONDITIONAL DEPLOYER GROUP MANUAL PIPELINE PLUGIN PROCEDURE PROCESS RELEASE UTILITY WORKFLOW

plannedEndTime

Task/Stage planned end time

DATETIME

Planned end date of the task.

plannedStartTime

Task/Stage planned start time

DATETIME

Planned start date of the task.

waitForPlannedStart

Wait For Planned Start

BOOLEAN

Boolean flag indicating if a stage or task should wait for a planned start time.

Quality

  • Object type: Quality

  • Report object name: quality

  • Description: Test results obtained from Application Life System Management (HP ALM) systems or the Jenkins continuous integration system.

Attribute Display Name Type Description

baseDrilldownUrl

Base Drilldown Url

STRING

Base URL used to construct the full URL for drilling down from a widget into a system such as HP ALM or Jenkins. For example, https://10.200.1.210:8080/qcbin/domain.

buildNumber

Build Number

NUMBER

Number assigned to the build by the build system. This field is applicable only for test results obtained from a build. This can be any integer.

category

Category

STRING

Category for the tests. For example, unit-test for JUnit test results obtained from Jenkins by the EC-Jenkins plugin and system-test for test results from HP ALM by the EC-ALM plugin.

duration

Duration

NUMBER

Duration of the tests in milliseconds.

failedTests

Number of Failed Tests

NUMBER

Number of tests that failed. This can be any integer.

manual

Manual

BOOLEAN

Whether the tests were run manually.

pluginConfiguration

Plugin Configuration

STRING

Name of the plugin configuration if the data was populated through EC-Jenkins or EC-ALM.

pluginName

Plugin Name

STRING

Name of the plugin if the data was populated through EC-Jenkins or EC-ALM. For example, EC-Jenkins.

releaseName

Release Name

STRING

Name of the release to which the test result belongs.

releaseProjectName

Release Project Name

STRING

Name of the project containing the release to which the test result belongs.

releaseUri

Release URI

STRING

Partial URL that can be used along with baseDrilldownUrl to construct the drill-down URL to navigate to test results associated with the current release. The external system must allow such URLs. For both Jenkins and HP ALM, CloudBees Analytics does not use this field, because neither system provides this ability.

You can drill down only into the builds of a specific job in Jenkins. With HP ALM, you can drill down only into the project in HP ALM.

runId

Test Run ID

STRING

Unique ID of the test run.

skippedTests

Number of Skipped Tests

NUMBER

Number of skipped tests. This can be any integer.

source

Source

STRING

Name of the source system from which the test results were obtained. For example, Jenkins.

sourceUrl

Source Url

STRING

URL for the test result record in the source system. For example, https://10.200.1.171:8080/job/CrossWing.

status

Status

STRING

Status of the test runs. The possible values depend on the source system.

successfulTests

Number of Successful Tests

NUMBER

Number of tests that have succeeded. This can be any integer.

timestamp

Timestamp

DATETIME

Date and time that the tests completed. The system uses this field to determine the time-based index for storing the test quality record by year. For example, tests that completed in 2018 are stored in the index ef-quality-2018.

Release

  • Object type: Release

  • Report object name: release

  • Description: Data from application or microservice releases in CloudBees CD/RO, such as planned and actual start and end times.

Attribute Display Name Type Description

actualEndTime

Actual End Time

DATETIME

Actual end time for the release.

actualStartTime

Actual Start Time

DATETIME

Actual start time for the release.

plannedEndTime

Planned End Time

DATETIME

Planned end date for the release.

plannedStartTime

Planned Start Time

DATETIME

Planned start date for the release.

releaseId

Release ID

STRING

Unique ID for the release.

releaseDuration

Release Duration

NUMBER

Duration of the release in milliseconds.

releaseName

Release Name

STRING

Name of the release

releaseProjectName

Release Project Name

STRING

Name of the project containing the release.

tags

Tags

STRING

Tags associated with the release.

Report object type reference for CloudBees CI-only data

You use attributes for CloudBees Analytics report objects when creating custom reports and dashboards. The following tables list the attributes for the CloudBees Analytics report object types.

CloudBees Software Delivery Automation Build

  • Object type: build

  • Report object name: Build

  • Description: Build data from CloudBees CI.

Attribute Display Name Type Description

buildNumber

Build Number

STRING

Unique build number or identifier assigned to the build by CloudBees CI.

buildStatus

Build Status

STRING

Current status of the build: SUCCESS, FAILURE, UNSTABLE, NOT_BUILT, ABORTED, or WARNING.

ciBuildDetailName

Detail name

STRING

The full display name from the CloudBees CI job.

ciJobName

CI Job Name

STRING

The full job name from the CloudBees CI job.

controllerUrl

Controller URL

STRING

CloudBees CI controller or the CloudBees CI operations center URL.

controllerName

Controller Name

STRING

CloudBees CI controller name.

duration

Duration

NUMBER

Duration of the build in milliseconds.

endTime

End Time

DATETIME

End date and time for the build. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

queueTime

QueueTime

DATETIME

Time the job entered the queue. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

source

Build System Type

STRING

Name of the continuous integration system. For example, CloudBees CI.

startTime

Start Time

DATETIME

Starting date and time for the build. The format is ISO 8601 in UTC time. For example, 2017-01-01T11:54:58.569Z.

Controller events

  • Object type: controller_event

  • Report object name: Controller events

  • Description: Controller event data from CloudBees CI.

Attribute Display Name Type Description

controllerUrl

Controller URL

STRING

CloudBees CI controller or the CloudBees CI operations center URL.

controllerName

Controller name

STRING

CloudBees CI controller name.

eventType

Event

STRING

enumerationValues = controllerStarted.

readyAt

DATETIME

startedAt

DATETIME

timestamp

DATETIME

CloudBees CI license data

  • Object type: CloudBees CI license data

  • Report object name: ci_license

  • Description: License data from CloudBees CI.

Attribute Display Name Type Description

controllerUrl

Controller URL

STRING

CloudBees CI controller or the CloudBees CI operations center URL.

controllerName

Controller name

STRING

CloudBees CI controller name.

licenseVersion

License version

STRING

Version of the CloudBees CI license.

customerName

Customer name

STRING

Name of the CloudBees CI user of the license.

organizationalUnit

Organization unit

STRING

Organizational unit.

editionDisplayName

STRING

The display name of the edition.

wildcard

BOOLEAN

Presence of true in this field indicates that this is a wildcard license that matches any instance ID.

licensedPacks

STRING

A pack of plugins (used only on old licenses).

startsAt

Start time

DATETIME

The license is valid after this date.

expiresAt

Expiry time

DATETIME

The license is valid before this date.

source

License source

Enumeration values: CloudBees CI

availableSeats

Available seats

NUMBER

Number of seats in the license.

CloudBees CI plugin

  • Object type: CloudBees CI plugin

  • Report object name: ci_plugin

  • Description: Plugin information from CloudBees CI.

Attribute Display Name Type Description

controllerUrl

Controller URL

STRING

CloudBees CI controller or the CloudBees CI operations center URL.

controllerName

Controller name

STRING

CloudBees CI controller name.

id

STRING

discription

STRING

pluginName

Plugin ID

String

The CloudBees CI plugin ID.

pluginDisplayname

Plugin name

STRING

Name of the CloudBees CI plugin.

pluginVersion

Plugin version

STRING

Version of the CloudBees CI plugin.

ts

Timestamp

Date

Date and time of plugin event.

isCAP

Is supported by CloudBees

BOOLEAN

Whether the CloudBees CI plugin is supported in the CloudBees Assurance Program (CAP).

isProprietary

Is proprietary

BOOLEAN

Whether the CloudBees CI plugin is a CloudBees proprietary plugin.

eventType

Event type

enumerationValues: install, uninstall, change

Lifecycle type of the plugin.

CloudBees CI plugin usage

  • Object type: CloudBees CI Plugin Usage

  • Report object name: ci_plugin_usage

  • Description: Plugin usage data from CloudBees CI.

Attribute Display Name Type Description

controllerUrl

Controller URL

STRING

CloudBees CI controller or the CloudBees CI operations center URL.

controllerName

Controller name

STRING

CloudBees CI controller name.

description

STRING

Description of the report.

pluginName

Plugin ID

STRING

The CloudBees CI plugin ID.

pluginDisplayName

Plugin name

STRING

The name of the CloudBees CI plugin.

pluginVersion

Plugin version

STRING

Version of the CloudBees CI plugin.

ts

Timestamp

DATETIME

Plugin event date and time.

isCAP

Is supported by CloudBees

BOOLEAN

Whether CloudBees CI plugin is supported in the CloudBees Assurance Program.

isProprietary

Is proprietary

BOOLEAN

Whether CloudBees CI plugin is proprietary.

jobFullName

Job full name

STRING

Full name of the CloudBees CI job.

buildUrl

Build URL

STRING

Relative build URL to the Jenkins root URL.

jobUrl

Job URL

STRING

Relative job URL to the Jenkins root URL.

itemFullName

Item full name

STRING

Full name of the configuration item.

dependentPlugin

Dependent plugin ID

STRING

CloudBees CI dependent plugin ID.

dependentpluginDisplayName

Dependent plugin name

STRING

Name of the dependent plugin.

dependentVersion

Dependent version

STRING

Version of the CloudBees CI dependent plugin.

usageType

Usage type

enumerationValues: pipeline, configuration, dependency

Usage type of the plugin.

CloudBees CI queue event

  • Object type: CloudBees CI Queue Event

  • Report object name: ci_queue_event

  • Description: CloudBees CI queue event data.

Attribute Display Name Type Description

controllerUrl

Controller URL

STRING

CloudBees CI controller or the CloudBees CI operations center URL.

controllerName

Controller name

STRING

CloudBees CI controller name.

eventType

Event type

STRING

enumerationValues = jobQueued, taskQueued, jobCancelled, taskCancelled, runStarted, taskStarted.

queueItemId

Queue Item ID

STRING

queueSize

Queue Size

NUMBER

The size of the queue.

timestamp

DATETIME

Date and time of the event.

queuedAt

Queued at

DATETIME

The time that the job or task was added to the queue.

startedAt

Start time

DATETIME

The time that a queued job or task left the queue and started executing.

cancelledAt

Cancelled time

DATETIME

The time that a queued job or task was cancelled.

CloudBees CI user login data

  • Object type: CloudBees CI user login data

  • Report object name: ci_user_login

  • Description: User login data from CloudBees CI.

Attribute Display Name Type Description

id

ID

STRING

controllerUrl

Controller URL

STRING

CloudBees CI controller or the CloudBees CI operations center URL.

controllerName

Controller name

STRING

CloudBees CI controller name.

userName

STRING

Name of the user.

email

Email

STRING

Email of the user, userName.

timestamp

Timestamp

DATETIME

Timestamp for this user’s login session.

category

Category

Enumeration values: login, scm.

status

Enumeration values: success, error

STRING

source

Source

Enumeration values: CloudBees CI.

eventType

Enumeration values: authenticated,loggedIn,failedToAuthenticate,failedToLogIn.