@LiteService
This HowTo introduces the @LiteService-annotation and explains how to use it correctly
@CommandGroup
Java Command Annotations – @CommandGroup Table of Contents 1. Basics 2. Properties 3. Usage Java command annotations are used for the developing Java commands in PAK. This chapter describes the functionality of the @CommandGroup annotation. It also gives an example of how you can use this annotation in your implementation. 1. Basics The @CommandGroup annotation […]
@Group
Java Command Annotations – @Group Table of Contents 1. Basics 2. Properties 3. Usage Java command annotations are used for the developing Java commands in PAK. This chapter describes the functionality of the @Group annotation. It also gives an example of how you can use this annotation in your implementation. 1. Basics The @Group annotation […]
WorkflowDocuInputExampleFormating
@workflowDocu using the <pre> tag /** * <pre> * @workflowDocu Parameter map for the Jenkins job that will be executed. * Caution: * If the build job is not parametrized, the value must be * null. * If the build job is parameterized, the parameter map must * not be null. * For a parametrized […]
WorkflowDocuOutputExample
Usage of @workflowDocu for output-variables /** * @workflowDocu The id of the build job. Can be retrieved with the * {@link StartBuildJob} command. */ @Persistent(scope = FieldScope.WRITE_ONLY) private Integer buildId; Last updated 2024-07-05 11:16:52 +0200
WorkflowDocuRequirement
Integration of @workflowDocu via the build.gradle file javadoc { source = sourceSets.main.allJava options.tags = [ ‚workflowDocu:cm:Workflow Developer Documentation:‘ ] } Last updated 2024-07-05 11:16:52 +0200
WorkflowDocuCommandLevel
Usage of @workflowDocu on command-level /** * @workflowDocu This command gets an element by its id. (1) */ @JavaCommand @CommandGroup(„Element“) public class GetElement { /** * @workflowDocu Id of the element to fetch (2) */ @Persistent private String id; […] } Last updated 2024-07-05 11:16:52 +0200
WorkflowDocuInputExample
Usage of @workflowDocu for input-variables giving an example /** * * @workflowDocu The name of the job that should be started. Build job with this * name should exist. If job does not exist, a * {@link RestClientAdapterException} exception will be thrown. * Example: Tests/job/JenkinsAdapterTestBuildJob/ (1) */ @Persistent private String jobName; Last updated 2024-07-05 11:16:52 […]
WorkflowDocuInputExampleFormat
Usage of @workflowDocu for input-variables in combination with other annotations /** * @workflowDocu The authentication type used to authenticate */ @Group(GROUP_NAME) @AllowedValues(values = „REST_BASIC“) (1) @Persistent(mandatory = false) (2) private String authType; Last updated 2024-07-05 11:16:52 +0200
@App
Java Command Annotations – @App Table of Contents 1. Basics 2. Properties 3. Usage Java command annotations are used for the developing Java commands in PAK. This chapter describes the functionality of the @App annotation. It also gives an example of how you can use this annotation in your implementation. 1. Basics The @App annotation […]