Table of Contents¶
- Usage of this Guide
- Overview
- Plugin Concepts
- Plugin Development Framework
- flowpdk Tool
- Setup
- Command Hierarchy
- Top Level Commands
- Generic Switches
- Command List
- 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
- flowpdf-perl Libraries
- Introduction
- Public APIs
- FlowPDF::ComponentManager
- FlowPDF::Config
- FlowPDF::StepParameters
- FlowPDF::Context
- FlowPDF::Credential
- FlowPDF::Log
- FlowPDF::Parameter
- FlowPDF::StepResult
- setJobStepOutcome($jobStepOutcome)
- setPipelineSummary($pipelineSummaryName, $pipelineSummaryText)
- setJobStepSummary($jobStepSummary)
- setJobSummary($jobSummary)
- setOutcomeProperty($propertyPath, $propertyValue)
- setOutputParameter($parameterName, $parameterValue)
- setReportUrl($reportName, $reportUrl)
- apply()
- flush()
- applyAndFlush()
- FlowPDF::Client::REST
- FlowPDF::Devel::Stacktrace
- 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
- flowpdf-groovy Libraries
- Introduction
- Groovy Public APIs
- ComponentManager
- ComponentManager(FlowPlugin plugin)
- loadComponentLocal(Class componentClass, Map<String, Object> componentInitValues, FlowPlugin plugin)
- loadComponent(Class<Component> componentClass, Map<String, Object> componentInitValues, FlowPlugin plugin)
- getComponent(Class<Component> componentClass)
- getComponentLocal(Class<Component> componentClass)
- Config
- StepParameters
- Context
- Credential
- Log
- setLogLevel(def newLogLevel)
- info(Serializable… messages)
- debug(Serializable… messages)
- trace(Serializable… messages)
- warning(Serializable… messages)
- error(Serializable… messages)
- setDefaultLogLevel(def newLogLevel)
- logInfo(Serializable… messages)
- logDebug(Serializable… messages)
- logTrace(Serializable… messages)
- logWarning(Serializable… messages)
- logError(Serializable… messages)
- Parameter
- StepResult
- setJobStepOutcome(String jobStepOutcome)
- setPipelineSummary(String pipelineSummaryName, String pipelineSummaryText)
- setJobStepSummary(String jobStepSummary)
- setJobSummary(String jobSummary)
- setOutcomeProperty(String propertyPath, String propertyValue)
- setOutputParameter(String parameterName, String parameterValue)
- setReportUrl(String reportName, String reportUrl)
- apply()
- flush()
- applyAndFlush()
- client.REST
- FlowPDF-Groovy-lib Exceptions
- Code Snippets
- ComponentManager
- Library Java documentation
- Rest Plugin Concepts
- Reporting Plugin Concepts
- Plugin Tutorials - Perl
- Introductory
- 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 6: Summary
- Advanced - Rest Plugin
- Advanced - Reporting Plugin
- Plugin Tutorials - Groovy
- Introductory - Jenkins
- Introductory - Jira
- Basic - CLI Plugin
- 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 6: Summary
- Advanced - Using external libraries
- Known Issues
- Release Notes