How do I configure/add steps to a task?

Introduction

To create a new step for a configuration management task

To view steps

To edit a custom step

To delete a custom step

Introduction:

You can create, edit and delete steps for configuration management tasks on the Configuration Management page under the Steps tab.

These steps can then be applied to any number of custom configuration management tasks that you create, as well as duplicates of system configuration management tasks.

Entuity allows the saving of steps that have syntax errors, in part to allow you to save scripts as they are being developed. You can still run and schedule invalid tasks, but Entuity reports the syntax errors as run time errors in the task's history.

To create a new step for a configuration management task:

1. In the Main Menu, click Administration and then click Configuration Management.
2. Click the Steps tab, and then click New at the top of the page, or via the Overflow Menu or the right-click Context Menu.
   
   
   
   
3. The New Step window will open.
   
   
4. Enter the name and description for the step in the Name and Description fields respectively. From Entuity v21.0 P01 upwards, a step name cannot contain the following characters: |, /, \, ", *, <, >.
5. Specify the Context of the step in the Context field. If "Device" or "Port" are selected then the step can be used with device tasks and port tasks respectively. If "None" is selected, the step can be used with both device and port tasks.
6. Enter the Groovy script for the step in the Script field. You can also click the pop-out icon to open a larger text area in the center of the screen. Click Save at bottom of the pop-out window to save your changes and return to the New Step form, or click the X in the top right to return to the form without saving.
   
   
   
   
   • For help and information on using Groovy scripts with Entuity configuration management, please see this article.
7. Click OK to save the step, otherwise click Cancel.

To view steps:

1. In the Main Menu, click Administration and then click Configuration Management, then click the Steps tab.
   
   
   
   
2. Click the Steps tab. The table of steps lists all your custom and system steps, detailing the following information:
   
   

   Column Name	Column Description
   Name	unique name (case insensitive comparison) on the selected server.
   Description	optional description of the step.
   Category	if the step is system or custom.
   Context	if the step is device, port, or none. If the context is device or port, it can be used with device or port tasks respectively. If the the context is none, then it can be used with both device and port tasks.
   Tasks	number of tasks that are using this step. Hover over the number to see a list of tasks that are using this step.
   Script	the entire Groovy script.

You can select a step and click View (at the top of the page, or via the Overflow Menu or right-click Context Menu) to open a form on the right that shows the details of the step, in a manner that allows you to more easily see its script.

The form opens on the right of the page:

You can click the popout icon to open the script in a popout window:

To edit a step:

You can only edit a custom step.

1. Navigate to the Configuration Management page, and click the Steps tab.
2. Select your preferred step and click Edit at the top of the page, or via the Overflow Menu or right-click Context Menu.
3. The Edit Step form will open on the right of the page. Make your changes and click OK.

To delete a step:

You can only delete a custom step.

1. Navigate to the Configuration Management page, and click the Steps tab.
2. Select your preferred step and click Delete at the top of the page, or via the Overflow Menu or right-click Context Menu.
3. A deletion confirmation message will appear. Click Yes.