Set up preconfigured actions

Create and manage preconfigured actions to improve security and simplify workflow setup for developers by pre-populating common configuration like URLs and credentials. For background on platform configuration patterns, refer to Understanding platform configuration.

You need administrative permissions in your organization to create, update, or delete preconfigured actions. Refer to Access organizations for navigation guidance.

CloudBees Unify administrators can create action aliases of CloudBees actions with defined input values, such as URLs and credentials. These action aliases, known as preconfigured actions, improve security and simplify action set-up for developers.

For example, an administrator creates a preconfigured action to run an Octopus deployment. The administrator pre-populates the action to include the Octopus url and token values, so the developer never needs to manage or input these. The developer can then select this preconfigured action to add to their workflow, and input the remaining required space-name, release, and environment-name values specific for their deployment.

Navigate to your organization’s Configurations > Actions for all preconfigured action management tasks.

Access preconfigured actions

The Actions page displays available preconfigured actions with search and sort controls.

For a list of CloudBees-authored actions, refer to CloudBees actions.

Create a preconfigured action from a CloudBees action

To configure and save a preconfigured action with your specific inputs:

Select Create action and search for a CloudBees action.
Enter a name, description, and configure action inputs (required inputs can be left blank for users to fill later).
Select Submit.

The preconfigured action becomes available in the workflow catalog for all organization members.

Add a preconfigured action to a workflow

Once a preconfigured action is created, it can be added to any workflow.

Add a preconfigured action step using the visual tool

To add a preconfigured action to a new or existing workflow using the visual tool:

Select an organization, and then select a component.
Create or update a workflow.
Select Add step to add a step to the job.
Select Select from catalog.
Select a preconfigured action.
Select Apply selected.
Enter required inputs that are not already pre-populated. Inputs marked with an are required.
(Optional) Enter inputs that are not required.
Select Save.

Add a preconfigured action step using the code editor

To add a preconfigured action to a new or existing workflow using the code editor:

Select an organization, and then select a component.
Create or update a workflow.
Use the uses keyword to enter the name of the preconfigured action.
Use the with keyword to set any required inputs that are not already pre-populated.

In the following example, a preconfigured action named preconfigured-jenkins-action has pre-populated the required url, username, and token inputs. job-name, the remaining required input, is set in the code editor. A parameter is also entered in the code editor, which is not a required field.
```
apiVersion: automation.cloudbees.io/v1alpha1
kind: workflow
name: My automation

on:
  push:
    branches:
      - '**'

jobs:
  build:
    steps:
      - uses: my-jenkins-action
        with:
          job-name: jenkins_job_name
          parameters: '{"ENV_NAME":"DEV"}'▼
```

The with keyword overrides any preconfigured values. However, if the preconfigured value is a property that has been marked with Prevent override, attempting to override that value generates an error in the workflow.

Update a preconfigured action

To update configuration settings of a preconfigured action:

Select next to the action you want to update.
Select Edit action.
Make any desired changes.
Select Save.

The selected preconfigured action is updated accordingly.

Delete a preconfigured action

A deleted preconfigured action is completely removed from CloudBees Unify, and deletion is irreversible.

To delete a preconfigured action:

Select next to the action you want to delete.
Select Delete action.
Select Delete.

The selected preconfigured action is deleted and removed from the actions list.