Plans User Interface

The Plans Page

The plans page allows you to list plans, view plan details, create plans, and edit plans. This page also contains controls for filtering the component list and selecting sort criteria. There are blue wedge shaped arrows over several of the columns on the plans page that allow you to select the column to sort the list by and in either ascending or descending order. When one of the arrows is clicked it selects that column by which to sort, sorts the list in either ascending or descending order (depending on which arrow was clicked), and changes the arrow to white . The white arrow indicates which column was used for the sort and in which order (ascending or descending).

Path

Allows you to specify where to look for or store plans. Click on change path to specify a different path.

Show

Allows you to list either plans or components. If you select components, the HTML user interface displays the components page as though you had click on the components option in the left-hand navigation menu.

You can also narrow the list by selecting a category from the category pull down menu.

(Check Box)

Marks a plan for inclusion when one of the actions are clicked in the Actions for Checked plans area. When clicked, Actions for Checked plans will either delete or categorize a plan.

Plan

A user definable text string that names the plan object. By default, the plans are listed in alphabetical order by plan name. You can change the sort order between ascending and descending by clicking on one of the sort icons that is in the plans header area.

Version

Displays the revision number of the plan. Each time a plan is modified, its version number is incremented.

You can sort the plan list by version number by clicking on one of the sort icons in the header area for this column. Clicking this icon toggles the order between ascending and descending.

Description

An optional user defined text string that describes the plan object. This attribute is not used by the provisioning software but can provide meaningful information to the user.

Action

Links that take you to other plan related pages to either find a specific plan, create a new plan, view more information about a plan, or view the run history for a plan.

Actions for Checked Plans

From this area you can either delete or apply categories to the checked plan(s).

The Plans Details Page

The Plans Details page allows you to view a Plan's information and attributes. This page includes information and attributes information, and also contains buttons that allow you to run, edit, and delete a plan.

Plan

The name of the plan.

Version

Displays the revision number of the plan.

Checked In

Displays the date and time when the plan was checked in. That is, created or modified.

Checked In By

Displays the user ID of the one who checked in the plan. This provides an audit trail when trying to troubleshoot problems or inconsistencies.

Category

A user definable object that is used to filter the plan list. Categories are created using the categories page accessed from the Administrative page. Categories are then applied to a plan from the plans page. Categories can also be created by clicking in the “Apply Categories . . .” link.

Description

An optional user defined text string that describes the plan object. This attribute is not used by the provisioning software but can provide meaningful information to the user.

Buttons

By clicking one of these buttons you initiate one of the following functions.

Run

Runs the plan.

Advanced Edit

Allows you to edit the XML code for the plan.

Delete

Removes the plan from the database. If there is more than one version then the provisioning software asks if you want to delete just this version or all versions.

Done

Takes you to the plans page.

Download

Allows you to save the XML code to a text file. Between this function and the Replace Definition With File function the provisioning software allows you to use other text editors to create and modify the XML code for plans.

The Plans Advanced Edit Page

The Plan Advanced Edit page allows you to change what a plan does by changing the XML code of a plan.

Plan

Allows you to change the name of the plan.

Version

Displays the revision number of the plan. This will increment when the plan is checked in. This cannot be changed by the user.

Checked In

This will reflect a new time and date when the plan is checked in. This cannot be changed by the user.

Checked In By

This will reflect the user ID of the one who checks in the plan providing an audit trail. This cannot be changed by the user.

Category

Displays the category for the plan. Categories can be assigned or changed at from the plans page by clicking in the “Apply Categories . . .” link.

Edit The Plan Definition

This is a text field that displays the XML code defining what the plan does. You can make any desired changes directly into this text field.

Replace Definition With File:

This is a text field that allows you to replace the XML code in the plan definition field with that of a text file. Either type in the name of the file, including the path, into the text field or use the browse button to locate a file. Initiate this feature by clicking on the Replace link just to the right of the browse button.

Buttons

By clicking one of these buttons you initiate one of the following functions.

Check in

Allows you to check in the plan using its current name.

Check in as

Allows you to check in the plan using a new name.

Cancel

Takes you to the plans page without saving any changes.