The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

SWEAGLE Plugin

SWEAGLEExport: SWEAGLE Get Config

  • actionName
    Give each action a descriptive name to precede the job's output in the console.
    • Type: String
  • mdsName
    Exact name of pending metadata set for which the data should be exported
    • Type: String
  • fileLocation
    Location of file within the Jenkins workspace to save the exported data.
    • Type: String
  • exporter
    The SWEAGLE exporter to use when retrieving the config data.
    • Type: String
  • format
    Select the supported format of the file to be uploaded.
    • Type: String
  • args (optional)
    Use comma separated values for exporter variables
    • Type: String
  • markFailed (optional)
    Mark the build as "Failed" should the data export fail.
    • Type: boolean
  • showResults (optional)
    Show the results of the API call in the Jenkins job console log.
    • Type: boolean

SWEAGLESnapshot: SWEAGLE Snapshot

  • actionName
    Give each action a descriptive name to precede the job's output in the console.
    • Type: String
  • mdsName
    Exact name of pending metadata set for which the snapshot should be taken.
    • Type: String
  • description (optional)
    A description for the snapshot
    • Type: String
  • markFailed (optional)
    Mark the build as "Failed" should the snapshot fail.
    • Type: boolean
  • showResults (optional)
    Show the results of the API call in the Jenkins job console log. Warning !!! The API results of a snapshot will include the entire Metadata set.
    • Type: boolean
  • tag (optional)
    A single string as TAG for that snapshot - cannot contain spaces but can utilize Jenkins variable4s ex "release1.2.${BUILD_ID}"
    • Type: String

SWEAGLEUpload: SWEAGLE Upload

  • actionName
    Give each action a descriptive name to precede the job's output in the console.
    • Type: String
  • fileLocation
    Location of file within the Jenkins workspace.
    • Type: String
  • format
    Select the supported format of the file to be uploaded.
    • Type: String
  • nodePath
    Enter the path where the data should be uploaded. Separate the nodenames in the path with a comma. In case the nodes do not yet exist, they will be created automatically.
    • Type: String
  • allowDelete (optional)
    • Type: boolean
  • description (optional)
    A description for the snapshot
    • Type: String
  • markFailed (optional)
    Mark the build as "Failed" should the data upload fail for any reason.
    • Type: boolean
  • onlyParent (optional)

    Only Parent If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted

    • Type: boolean
  • showResults (optional)
    Show the results of the API call in the Jenkins job console log.
    • Type: boolean
  • tag (optional)
    A single string as TAG for that snapshot - cannot contain spaces but can utilize Jenkins variable4s ex "release1.2.${BUILD_ID}"
    • Type: String
  • withSnapshot (optional)

    Allow Delete If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted

    Only Parent If checked will delete any nodes and MDIs that are not part of the upload. In case the nodes are included or inherited, also the nodes and MDIs at points of inclusion will be deleted

    Store Snapshot. This controls if automatically a snapshot should be created for each of the impacted metadata sets by this data upload.

    • Type: boolean

SWEAGLEValidate: SWEAGLE Validate

  • actionName
    Give each action a descriptive name to precede the job's output in the console.
    • Type: String
  • mdsName
    The exact name of the incoming metadata set which should be validated.
    • Type: String
  • errMax (optional)
    Fail build on validate errors. Set thresholds used to determine if the build should be failed based on the number of validation errors or warnings.  Use -1 to ignore either threshold.
    • Type: int
  • markFailed (optional)
    Fail build on validate errors or if the pending data set fails to show up after all the retry attempts have completed.
    • Type: boolean
  • retryCount (optional)
    Number of retry attempts while waiting for a pending Metadata set. Combined with with Retry Interval to force a timeout after attempts have completed. Use "-1" for unlimited retries.
    • Type: int
  • retryInterval (optional)
    Number of seconds between each attempt to find a matching Metadata set for validation. Combine with with Retry Count to force a timeout after attempts have completed.
    • Type: int
  • showResults (optional)
    Show the results of the API call in the Jenkins job console log.
    • Type: boolean
  • warnMax (optional)
    Fail build on validate errors. Set thresholds used to determine if the build should be failed based on the number of validation errors or warnings.  Use -1 to ignore either threshold.
    • Type: int

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?

    


See existing feedback here.