Table of Contents

• Usage of this Guide
  • Deprecation of ElectricFlow 6.0 Plugin SDK
  • Document Assumptions
• Overview
  • What is a Plugin
  • Plugin Types
• Plugin Concepts
  • Terminology
    • Plugin Code Layout
    • Plugin Build
    • Plugin Provisioning and Install
    • Plugin Promotion
    • Plugin Configuration
    • Plugin Agent Setup
    • Plugin Runtime Shell
    • Plugin Publish to Catalog
  • Concepts
    • Plugin Metadata
    • Plugin Versioning
    • Install and Promotion Logic
  • Architecture
    • Content
    • Install
    • Promotion
    • Procedure Structure
    • Procedure Step Execution
• Plugin Development Framework
  • Past Approaches to Plugin Development
    • History
    • Limitations of each approach
  • Why do we need a Development Framework
  • What constitutes the Development Framework
  • Current Limitations
• pdk Tool
  • Setup
  • Command Hierarchy
  • Top Level Commands
    • config
    • generate
    • build
    • showdoc
    • describe
    • debug
    • cookie-cutter
  • Generic Switches
  • Command List
    • pdk config
      • pdk config listoptions
      • pdk config show
      • pdk config setoption
    • pdk generate
      • pdk generate workspace
      • pdk generate plugin
    • pdk build
    • pdk showdoc
      • pdk showdoc pluginspec
      • pdk showdoc toolkit
    • pdk describe
    • pdk debug
      • pdk debug on
      • pdk debug off
      • pdk debug purge
      • pdk debug setverbosity
      • pdk debug check
    • pdk cookie-cutter
  • Generated Code
    • Reserved Sections
    • Regeneration after a Spec Change
      • Add a new Procedure
      • Delete a Procedure
      • Add a new input/output Procedure Parameter
      • Rename a Procedure
      • Update Procedure Parameter
      • Delete Procedure Parameter
      • Rename Procedure Parameter
      • New Configuration Parameter added/renamed/removed
      • New REST action added to Configuration
      • New REST based Auth Scheme in Configuration
      • Add checkConnection to Configuration
      • REST endpoint added to restclient Section
      • REST endpoint removed from restclient Section
      • New parameter added to restclient Section endpoint
      • Parameter removed from restclient Section endpoint
      • New devOpsInsight section added
      • New payload type added to devOpsInsight Section
      • New parameter added to devOpsInsight Section
      • Parameter removed from devOpsInsight Section
      • Payload type in devOpsInsight Section removed/renamed
• pdk-perl Libraries
  • Introduction
  • Public APIs
    • FlowPDF::ComponentManager
      • new()
        • Parameters
        • Returns
        • Usage
      • loadComponentLocal($componentName, $initParams)
        • Parameters
        • Returns
        • Usage
      • loadComponent($componentName, $initParams)
        • Parameters
        • Returns
        • Usage
      • getComponent($componentName)
        • Parameters
        • Returns
        • Usage
      • getComponentLocal($componentName)
        • Parameters
        • Returns
        • Usage
    • FlowPDF::Config
      • isParameterExists($parameterName)
        • Parameters
        • Returns
        • Usage
      • getParameter($parameterName)
        • Parameters
        • Returns
        • Usage
      • getRequiredParameter($parameterName)
        • Parameters
        • Returns
        • Usage
      • asHashRef()
        • Parameters
        • Returns
        • Exceptions
        • Usage
    • FlowPDF::StepParameters
      • isParameterExists($parameterName)
        • Parameters
        • Returns
        • Usage
      • getParameter($parameterName)
        • Parameters
        • Returns
        • Usage
      • getRequiredParameter($parameterName)
        • Parameters
        • Returns
        • Usage
      • asHashref()
        • Description
        • Parameters
        • Returns
        • Exceptions
        • Usage
    • FlowPDF::Context
      • getRuntimeParameters()
        • Parameters
        • Returns
        • Usage
      • getStepParameters()
        • Parameters
        • Returns
        • Usage
      • getConfigValues()
        • Parameters
        • Returns
        • Usage
      • newStepResult()
        • Parameters
        • Returns
        • Usage
      • newRESTClient($creationParams)
        • Parameters
        • Returns
        • Usage
      • bailOut()
        • Parameters
        • Returns
        • Exceptions
        • Usage
    • FlowPDF::Credential
      • getCredentialType()
        • Parameters:
        • Returns
        • Usage
      • getUserName()
        • Parameters
          • Returns
        • Usage
      • getSecretValue()
        • Parameters
        • Returns
      • getCredentialName()
        • Parameters
        • Returns
        • Usage
    • FlowPDF::Log
      • logInfo(@messages)
        • Parameters
        • Returns
        • Usage
      • logDebug(@messages)
        • Parameters
        • Returns
        • Usage
      • logTrace(@messages)
        • Parameters
        • Returns
        • Usage
      • logWarning(@messages)
        • Parameters
        • Returns
        • Usage
      • logError(@messages)
        • Parameters
        • Returns
        • Usage
        • logInfoDiag(@messages)
        • logWarningDiag(@messages)
        • logErrorDiag(@messages)
    • FlowPDF::Parameter
      • getName()
        • Parameters
        • Returns
        • Usage
      • getValue()
        • Parameters
        • Returns
        • Usage
      • setName($name)
        • Parameters
        • Returns
        • Usage
      • setValue($value)
        • Parameters
        • Returns
        • Usage
    • FlowPDF::StepResult
      • setJobStepOutcome($jobStepOutcome)
        • Parameters
        • Returns
        • Usage
      • setPipelineSummary($pipelineSummaryName, $pipelineSummaryText)
        • Parameters
        • Returns
        • Usage
      • setJobStepSummary($jobStepSummary)
        • Parameters
        • Returns
        • Usage
      • setJobSummary($jobSummary)
        • Parameters
        • Returns
        • Usage
      • setOutcomeProperty($propertyPath, $propertyValue)
        • Parameters
        • Returns
      • setOutputParameter($parameterName, $parameterValue)
        • Parameters
        • Returns
      • setReportUrl($reportName, $reportUrl)
        • Parameters
        • Returns
      • apply()
        • Parameters
        • Returns
        • Usage
      • flush()
        • Parameters
        • Returns
        • Usage
      • applyAndFlush()
        • Parameters
        • Returns
        • Usage
    • FlowPDF::Client::REST
      • new($parameters)
        • Parameters
        • Returns
        • Usage
      • newRequest(@parameters)
        • Parameters
        • Returns
        • Usage
      • doRequest($httpRequest)
        • Parameters
        • Returns
        • Usage
      • augmentUrlWithParams($url, $arguments)
        • Parameters
        • Returns
        • Usage
    • FlowPDF::Devel::Stacktrace
      • new()
        • Parameters
        • Returns
        • Exceptions
        • Usage
      • toString()
        • Parameters
        • Returns
        • Exceptions
        • Usage
      • clone()
        • Parameters
        • Returns
        • Exceptions
        • Usage
    • FlowPDF::Exception
      • FlowPDF::Exception::UnexpectedEmptyValue
      • FlowPDF::Exception::MissingFunctionDefinition
      • FlowPDF::Exception::MissingFunctionArgument
      • FlowPDF::Exception::WrongFunctionArgumentType
      • FlowPDF::Exception::WrongFunctionArgumentValue
      • FlowPDF::Exception::EntityDoesNotExist
      • FlowPDF::Exception::EntityAlreadyExists
      • FlowPDF::Exception::RuntimeException
      • Exception handling in FlowPDF
      • Using out-of-the-box exceptions
      • Creating your own exceptions
    • Code Snippets
      • Introduction
      • Auto-Generated Code
      • Retrieving parameter values from configuration and step
        • Using one API
        • Using two different APIs
      • Setting step results
      • Performing REST requests
      • CLI execution
      • Logging
      • Defining custom fields
• pdk-groovy Libraries
  • Introduction
  • Groovy Public APIs
    • ComponentManager
      • ComponentManager(FlowPlugin plugin)
        • Parameters
        • Returns
        • Usage
      • loadComponentLocal(Class componentClass, Map<String, Object> componentInitValues, FlowPlugin plugin)
        • Parameters
        • Returns
        • Usage
      • loadComponent(Class<Component> componentClass, Map<String, Object> componentInitValues, FlowPlugin plugin)
        • Parameters
        • Returns
        • Usage
      • getComponent(Class<Component> componentClass)
        • Parameters
        • Returns
        • Usage
      • getComponentLocal(Class<Component> componentClass)
        • Parameters
        • Returns
        • Usage
    • Config
      • isParameterExists(String parameterName)
        • Parameters
        • Returns
        • Usage
      • getParameter(String parameterName)
        • Parameter
        • Returns
        • Usage
      • getCredential(String credentialName)
        • Parameters
        • Returns
        • Usage
      • getRequiredParameter(String parameterName)
        • Parameters
        • Returns
        • Usage
      • getRequiredCredential(String credentialName)
        • Parameters
        • Returns
        • Usage
      • getAsMap()
        • Parameters
        • Returns
        • Usage
    • StepParameters
      • isParameterExists(String parameterName)
        • Parameters
        • Returns
        • Usage
      • getParameter(String parameterName)
        • Parameter
        • Returns
        • Usage
      • getCredential(String credentialName)
        • Parameters:
        • Returns
        • Usage
      • getRequiredParameter(String parameterName)
        • Parameter
        • Returns
        • Usage
      • getRequiredCredential(String credentialName)
        • Parameter
        • Returns
        • Usage
      • getAsMap()
        • Parameters
        • Returns
        • Usage
    • Context
      • getRuntimeParameters()
        • Parameters
        • Returns
        • Usage
      • getStepParameters()
        • Parameters
        • Returns
        • Usage
      • getConfigValues()
        • Parameters
        • Returns
        • Usage
      • newStepResult()
        • Parameters
        • Returns
        • Usage
      • newRESTClient()
        • Parameters
        • Returns
        • Usage
    • Credential
      • getCredentialType()
        • Parameters:
        • Returns
        • Usage
      • getUserName()
        • Parameters
          • Returns
        • Usage
      • getSecretValue()
        • Parameters
        • Returns
      • getCredentialName()
        • Parameters
        • Returns
        • Usage
    • Log
      • setLogLevel(def newLogLevel)
        • Parameters
        • Returns
        • Usage
      • info(Serializable… messages)
        • Parameters
        • Returns
        • Usage
      • debug(Serializable… messages)
        • Parameters
        • Returns
        • Usage
      • trace(Serializable… messages)
        • Parameters
        • Returns
        • Usage
      • warning(Serializable… messages)
        • Parameters
        • Returns
        • Usage
      • error(Serializable… messages)
        • Parameters
        • Returns
        • Usage
      • setDefaultLogLevel(def newLogLevel)
        • Parameters
        • Returns
        • Usage
      • logInfo(Serializable… messages)
        • Parameters
        • Returns
        • Usage
      • logDebug(Serializable… messages)
        • Parameters
        • Returns
        • Usage
      • logTrace(Serializable… messages)
        • Parameters
        • Returns
        • Usage
      • logWarning(Serializable… messages)
        • Parameters
        • Returns
        • Usage
      • logError(Serializable… messages)
        • Parameters
        • Returns
        • Usage
    • Parameter
      • getName()
        • Parameters
        • Returns
        • Usage
      • getValue()
        • Parameters
        • Returns
        • Usage
      • setName(String name)
        • Parameters
        • Returns
        • Usage
      • setValue(Object value)
        • Parameters
        • Returns
        • Usage
    • StepResult
      • setJobStepOutcome(String jobStepOutcome)
        • Parameters
        • Returns
        • Usage
      • setPipelineSummary(String pipelineSummaryName, String pipelineSummaryText)
        • Parameters
        • Returns
        • Usage
      • setJobStepSummary(String jobStepSummary)
        • Parameters
        • Returns
        • Usage
      • setJobSummary(String jobSummary)
        • Parameters
        • Returns
        • Usage
      • setOutcomeProperty(String propertyPath, String propertyValue)
        • Parameters
        • Returns
      • setOutputParameter(String parameterName, String parameterValue)
        • Parameters
        • Returns
      • setReportUrl(String reportName, String reportUrl)
        • Parameters
        • Returns
      • apply()
        • Parameters
        • Returns
        • Usage
      • flush()
        • Parameters
        • Returns
        • Usage
      • applyAndFlush()
        • Parameters
        • Returns
        • Usage
    • client.REST
      • REST(Map<String, Object> params)
        • Parameters
        • Returns
        • Usage
      • newRequest(Map<String, Object> requestParameters)
        • Parameters
        • Returns
        • Usage
      • doRequest(HTTPRequest httpRequest)
        • Parameters
        • Returns
        • Usage
      • request(Map<String, Object> requestParameters)
        • Parameters
        • Returns
        • Usage
    • FlowPDF-Groovy-lib Exceptions
      • UnexpectedEmptyValue
      • UnexpectedMissingValue
      • MissingFunctionDefinition
      • MissingFunctionArgument
      • WrongFunctionArgumentType
      • WrongFunctionArgumentValue
      • EntityDoesNotExist
      • EntityAlreadyExists
      • Creating your own exceptions
    • Code Snippets
      • Introduction
      • Auto-Generated Code
      • Retrieving parameter values from configuration and step
        • Using one API
        • Using two different APIs
      • Setting step results
      • Performing REST requests
      • CLI execution
      • Logging
      • Defining custom fields
  • Library Java documentation
• Rest Plugin Concepts
  • Terminology
    • Rest Plugin
    • Rest Methods
    • Rest Client
    • Rest Procedures
    • User Agent
  • Usage of rest in pluginspec.yaml
  • Usage of Authorization Schemes in pluginspec.yaml
  • Modules generated for Rest Plugins
  • Extending Generated Methods (Code Snippets)
• Reporting Plugin Concepts
  • Terminology
    • Release Command Center (RCC)
    • Release Activities
    • Stages
    • Activity Metrics
    • Data Providers
    • Data Source
    • Object Type
    • Report Object
  • Usage of Plugins in RCC
  • Usage of reporting in pluginspec.yaml
• Plugin Tutorials - Perl
  • Introductory
    • Introduction
    • The 4 Step Plugin creation Process
    • Prerequisites
      • Install and Setup Jenkins
    • Step 1 : Create Plugin Workspace
    • Step 2: Define plugin spec and generate plugin
      • Update config section of YAML
      • Update procedure section
      • Generate plugin
      • Review the auto-generated code
    • Step 3: Implement Additional logic
      • Add default config values:
      • Add necessary library imports
      • Retrieve the Jenkins CSRF Token
      • Retrieve Jenkins Job Last Build Number
      • Modify step code
      • Set Output Parameters
      • Set pipeline, job and jobstep summary
      • Review MyJenkins.pm
    • Step 4: Build, Install and Test
      • Install and Promote the plugin
      • Create a Pipeline and Configure the plugin
      • Running the pipeline
    • Summary
  • Basic - Reporting Plugin
    • Introduction
    • Prerequisites
    • Step 1 : Generate a plugin using sample spec from Github
    • Step 2 : Modify Reporting.pm
    • Step 3 : Modify SampleReporting.pm
    • Step 4 : Build, Install, Promote and Configure the Plugin
    • Step 5 : Setup RCC
    • Step 6 : Examine the Schedules created and numbers in the RCC Dashboard
    • Step 7 : Summary
  • Advanced - Rest Plugin
    • Introduction
    • Prerequisites
    • Step 1 : Generate a plugin using sample spec from Github
    • Step 2 : Build a Plugin
    • Step 3 : Apply and Test the Plugin for Checkconnection
    • Step 4 : Modify the Plugin
    • Step 5 : Apply and Test the Plugin for CreateRelease
    • Step 6: Summary
  • Advanced - Reporting Plugin
    • Introduction
    • Prerequisites
    • Step 1 : Generate plugin from scratch.
    • Step 2 : Configuring plugin specifications and generating a plugin
    • Step 3 : Writing reporting logic using FlowPDF Perl reporting ecosystem
    • Step 4 : DOIS setup and reporting check
• Plugin Tutorials - Groovy
  • Introductory - Jenkins
    • Introduction
    • The 4 Step Plugin creation Process
    • Prerequisites
      • Install and Setup Jenkins
    • Step 1: Create Plugin Workspace
    • Step 2: Define plugin spec and generate plugin
      • Update configuration section of YAML
      • Update procedures section
      • Generate plugin
      • Review the auto-generated code
    • Step 3: Implement Additional logic
      • Add default config values:
      • Add necessary library imports
      • Retrieving the Jenkins CSRF Token
      • Modify GetJenkinsJob step code
      • Set Output Parameters
      • Set pipeline, job and jobStep summary
      • Review SampleJenkins.groovy
    • Step 4: Build, Install and Test
      • Install and Promote the plugin
      • Create a Pipeline and Configure the plugin
      • Running the pipeline
    • Summary
    • Used Libraries:
  • Introductory - Jira
    • Introduction
    • The 4 Step Plugin creation Process
    • Prerequisites
    • Step 1 : Create Plugin Workspace
    • Step 2: Define plugin spec and generate plugin
      • Update configuration section of YAML
      • Update procedures section
      • Generate plugin
      • Review the auto-generated code
    • Step 3: Implement Additional logic
      • Add necessary library imports
      • Add default config values:
      • Modify GetIssue step code
      • Set Output Parameters
      • Set pipeline, job and jobStep summary
      • Review SampleJira.groovy
    • Step 4: Build, Install and Test
      • Install and Promote the plugin
      • Create a Pipeline and Configure the plugin
      • Running the pipeline
    • Summary
    • Used Libraries:
  • Basic - CLI Plugin
    • Introduction
    • Prerequisites
    • Step 1 : Generate a plugin using sample spec from Github
    • Step 2 : Add the plugin procedure logic
    • Step 3 : Build, Install, and Promote the Plugin
    • Step 4 : Use Plugin to perform gradle run
    • Step 5 : Summary
  • Basic - Reporting Plugin
    • Introduction
    • Prerequisites
    • Step 1 : Generate a plugin using sample spec from Github
    • Step 2 : Modify ReportingSampleReporting.groovy
    • Step 3 : Modify SampleReporting.groovy
    • Step 4 : Build, Install, Promote and Configure the Plugin
    • Step 5 : Setup RCC
    • Step 6 : Examine the Schedules created and numbers in the RCC Dashboard
    • Step 7 : Summary
  • Advanced - Reporting Plugin
    • Introduction
    • Prerequisites
    • Step 1 : Generate plugin from scratch.
    • Step 2 : Configuring plugin specifications and generating a plugin
    • Step 3 : Writing reporting logic using FlowPDF reporting component
      • Investigating autogenerated code
      • Configuration of the Reporting component
      • Receiving issues from the JIRA server
      • Implementing the Reporting component
    • Step 4 : Review the resulting code
    • Step 5 : DOIS setup and reporting check
  • Advanced - REST Plugin
    • Introduction
    • Prerequisites
    • Step 1 : Generate a plugin using sample spec from Github
    • Step 2 : Build a Plugin
    • Step 3 : Apply and Test the Plugin for Checkconnection
    • Step 4 : Modify the Plugin
    • Step 5 : Apply and Test the Plugin for CreateRelease
    • Step 6: Summary
  • Advanced - Using external libraries
    • Introduction
    • The 4 Step Plugin creation Process
    • Prerequisites
    • Step 1 : Create Plugin Workspace
    • Step 2: Define plugin spec and generate plugin
      • Update config section of YAML
      • Update procedure section
      • Generate plugin
      • Review the auto-generated code
    • Step 3: Implement Additional logic
      • Add necessary libraries
      • Implementing AWS CloudFront API call
      • Modify step code
      • Set Output Parameters
      • Set pipeline, job and jobStep summary
      • Review SampleAWSCloudFront.groovy
    • Step 4: Build, Install and Test
      • Install and Promote the plugin
      • Create a Pipeline and Configure the plugin
      • Running the pipeline
    • Summary
• Known Issues
• Release Notes
  • Introduction
  • Releases
    • 1.0.0.1
      • June 24, 2019
        • Component Versions
        • Changelog
    • 1.0.1.2
      • July 31, 2019
        • Component Versions
        • Changelog
    • 2.0.0.1
      • October 31, 2019
        • Component Versions
        • Changelog
    • 2.1.0.2
      • February 3, 2020
        • Component Versions
        • Changelog
    • 2.2.0.3
      • April 28, 2020
        • Component Versions
        • Changelog
    • 2.3.0.4
      • June 30, 2020
        • Component Versions
        • Changelog