Version 9.6	SEARCH   CONTENTS   |   PDF BOOKS   |   HOME   UP   PREV   NEXT

To add a custom action to CentraSite, perform the following high-level steps:

1. Create a custom action category.
   During this step, you specify the type of the category and details for the category. For more information, see Creating a Custom Action Category.

2. Add an action template to the custom action category.
   During this step, you specify details for the action template, upload its associated action rule (if appropriate), and select the object and event types to which this template applies. For more information, see Adding an Action Template to a Custom Action Category.

3. Add a parameter template to the action template.
   During this step, you add one or more parameter templates, and specify their input values. For more information, see Adding a Parameter Template to the Action Template.

Creating a Custom Action Category

Perform these steps to create a custom action category and save it to CentraSite.

To create a custom category

1. In CentraSite Control, go to Policies > Action Templates.

2. Click the Add Action Category button in the upper-right corner of the Policy Information panel.

3. In the Add Action Category dialog box, do the following:

   1. Specify a name for the new custom category.

      An action category name does not need to be unique within the CentraSite Registry. However, to reduce ambiguity, you should avoid giving multiple action categories the same name.

      An action category name can contain any character (including spaces).

   2. Choose the type of template that the category will contain (e.g., Design/Change-Time or Run-Time templates).

   3. Click OK.

Adding an Action Template to a Custom Action Category

Perform these steps to add an action template to a custom action category and save it to CentraSite.

To add an action template to a custom action category

1. In CentraSite Control, go to Policies > Action Templates.

2. Click Add Action Template.

3. If a custom action category does not yet exist, the Add Action Category dialog box is displayed, prompting you to create a custom action category now, as described in Creating a Custom Action Category. After you create a custom action category, the Add Action Template page is displayed, and is described in the next step.

4. In the Add Action Template page, do the following:

   In this field...	Do the following...
   Category	Select the action category for which you want to add the action template.
   Name	Enter a name for the new action template. Follow these guidelines: An action template name must be unique. An action template name can contain any character (including spaces).
   Description	Optional. Type a description for the new action template. This description appears when the user displays a list of action templates in the Policy Information panel.
   Type	No action is necessary. By default, CentraSite sets the action type to Programmatic for a design-time or change-time action, and Axiomatic for a run-time action.
   Implementation	For a programmatic action (a design-time or change-time action), specify whether the action’s rule is a Groovy script or a Java class.
   Uploaded File	For a programmatic action, click the Browse button and upload the action's rule file. For a Java rule type, upload its Java program .zip file. For a Groovy rule type, upload its .groovy script. For procedures on creating action rules, see Creating Action Rules. For procedures on uploading action rules, see Uploading Action Rules to Action Templates. Note: Alternatively, you can download the rules used by the system action templates, and modify them for use with the custom action template. For procedures, see Downloading Rules from System Action Templates.

5. In the Scope panel, do the following:

   In this field...	Specify...
   Object Types	Select the type of objects to which this action template applies.
   Event Types	Select the type of events to which this action template applies. Note: Not all event types are supported by all objects. For more information, see Supported Object Events.

6. Click Save.

   Upon saving the action template, CentraSite displays the Edit Action Template Detail page. You will use this page's Parameter Templates profile to add parameter templates for this action.

Adding a Parameter Template to the Action Template

To complete the action template, you must define its input parameters.

To add a parameter template to the action template

1. If you are beginning this procedure immediately after completing Adding an Action Template to the Action Category, skip to step 4.

2. In CentraSite Control, go to Policies > Action Templates.

3. Select the action template for which you want to define parameter templates.

4. In the Edit Action Template Detail page, select the Parameter Templates profile.

5. Click the Add Parameter Template button.

6. Define the first parameter as follows:

   In this field...	Do the following...
   Name	Enter a name for the new parameter template.
   Type	Select a data type.
   Default Value	If you want to specify a default value, type a value in this field. If the selected data type is String, Number or URL, you can specify one or multiple default values. You can specify multiple possible default data values from which to choose as follows: Select the Edit icon to the right of the Default Value field. In the Add Default Values dialog box, type a value and click Add. Repeat for as many values as you need. Click OK. Then, in the Default Value field select from the drop-down list the value you want to use as the default value. Note: If you would rather fill in required values when this template is used in a policy, leave this field blank.
   Array	Select this check box if you want the data type as an array.
   Required	Select this check box if you want the parameter template to be mandatory.

7. If you need to define additional parameters, click the Add Parameter Template button again and repeat the previous step.

8. Click Save and then Close.

   The parameter templates that you added appear under the Parameter Templates profile.

www.softwareag.com

Copyright © 2005-2014 Software AG, Darmstadt, Germany.

SEARCH   CONTENTS   |   PDF BOOKS   |   HOME   UP   PREV   NEXT