Configuring actions for an action button

To configure an action on an action button

1. Log in to BMC Helix Innovation Studio  and navigate to the Workspace  tab.
2. Select the application for which you want to add an action button.
3. On the Views tab, click the name of the view definition to which you want to add an action button or create a new view. 
4. From the Palette, drag the Action button  components to the canvas in the order you want them to appear on the user interface.
5. In the Properties pane on the right side, click Component Settings , and then specify the preferences for each button on the General tab.
6. In the Actions properties section, click  Edit actions and select from the list of available actions to add one or more actions to the selected button.
   

1. Configure the action for the action types that you selected; click the appropriate action type to see configuration information: 

1. • Apply grid filter
   • Associate records
   • Close view
   • Delete records
   • Disassociate records
   • Edit Records
   • Launch process
   • Launch process designer
   • Launch URL
   • Open view
   • Refresh
   • Save
   • Set Property

To configure the Apply grid filter action

Use the Apply grid filter action to configure custom filters on a record grid for a set of records on your view. 

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Apply grid filter action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to apply the filter to the grid.
   Record grid	Click Click to build an expression to provide the record grid to which you want to apply the filter.
   Mode	Select the mode in which you want to apply the filters to the selected record grid: Begin—Begins a batch of filter updates. (Default) Append—Applies filters with an AND operator, and existing filters for the specified fields are removed. Remove—Removes existing filters if the condition matches the applied filter. Replaces previous data with new data record if a duplicate data record is found. Overwrite—Replaces all existing filters with the applied filters.  Merge— Performs one or all of the following actions: Replaces the existing filters with a range of values with the matching applied filters. Combines existing filters for the other fields of the selected record grid with the matching applied filters by using the OR operator. Adds new filters to applied filters with an AND for new fields. Clear—Removes all existing filters. End—Applies all pending filter updates executed in a batch.
   Filter	Select the filters that you want to apply to the record. Important: This property is displayed only if you select the Append, Remove, Overwrite, and Merge options from the Mode field.

3. Click Save.

The following image displays sample values for the Apply grid filter action :

To configure the Associate records action

Use the Associate records action to create associations between specified record definitions or a set of records on your view. 

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Associate records action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to associate the records.
   Record definition to associate	From the list, select the record definition you want to associate records with.  Important: After you select the record definition in this field, Association to use, Associated record node side, Associated record ID, and View for selecting or creating associated records fields are displayed.
   Association to use	From the list, select the record association you want to add or associate.
   Associated record node side	Confirm this selection. This field is automatically populated when the association is selected in the Association to use field.
   Associated record ID	Click Click to build an expression to select the ID of the associated record.
   View for selecting or creating associated records	Select the view definition from which the association is selected or created.  Important: To select records from this view, set the Output parameter of this view as Selected rows for multiple selection.

3. Click Save.

The following image displays sample values for the Associate records action:

To configure the Close view action

Use the Close view action to close the view after the required action is performed or treat the button as a cancel button. 

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Close view action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to close the view.
   Act as cancel	Use the toggle key to enable the cancel option for the action button. This action will r evert all the unsaved actions performed on the view.

3. Click Save.

The following image displays sample values for the Close view  action:

To configure the Delete records action

Use the Delete records action to delete the selected records from the specified record definition or for a set of records on your view.  

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Delete records action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to delete the records.
   Records	Click Click to build an expression to select the records from a record grid. Alternatively, you can define an expression to select the record instances or record instance IDs from a record definition.
   Record definition	From the list, select the record definition, from which you want to delete the records. Important: This selection is applied only if you select record instances or record instance IDs in the Records field.

3. Click Save.

The following image displays sample values for the Delete records action:

To configure the Disassociate records action

 Use the Disassociate records action to delete the selected records from the associations between two record definitions on your view. 

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Disassociate records action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to disassociate the records.
   Record definition to  disassociate	From the list, select the record definition from which you want to disassociate the records.  Important: After you select the record definition in this field, Association to use, Associated record node side, Associated record ID, and Records to disassociate  fields are displayed.
   Association to use	From the list, select the record association that you want to disassociate.
   Associated record node side	Confirm this selection. This field is automatically populated when the association is selected in the Association to use field.
   Associated record ID	Click Click to build an expression to select the associated record ID from which the records are to be disassociated.
   Records to disassociate	Click Click to build an expression to select the set of records to disassociate.

3. Click Save.

The following image displays sample values for the Disassociate records action:

To configure the Edit records action

Use the Edit records action to edit and save the selected records from the specified record definition or for a set of records on your view .

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Edit records action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to edit the records.
   Records	Click Click to build an expression to select the records from a record grid. Alternatively, you can define an expression to select the record instances or record instance IDs from a record definition.
   Record definition	Select the record definition from the list from which you want to edit the records.  Important: This selection applies only if you select record instances or record instance IDs in the Records field.

3. Click Save.

The following image displays sample values for the Edit records action:

To configure the Launch process action

Use the Launch process action to run a predefined process within the view according to your application's business scenario. The process can run synchronously or asynchronously, in sequence to other actions on the button.  

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Launch process action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to launch the process.
   Process to start	Select the process definition from the list that you want to launch on this action button.
   Wait for process completion	Use Wait for process completion toggle key to define an output map for the selected process. If a process runs synchronously, it is possible to get output data from the process after it is completed.

3. Click Save .

The following image displays sample values for the Launch process action:

To configure the Launch process designer action

Use the Launch process designer action to access a process definition from a Process designer instance within the application view. You can use the Process designer to customize the process according to your application business scenario.  You can restrict or allow users to use only a specific set of palette elements of the Process designer, based on the permissions. 

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Launch process designer action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to launch the Process designer.
   Process definition name	Select the process definition name from the list. Alternatively, from Select , click  Edit expression to provide an expression to define the process definition name. If you do not select any process definition, the Process designer is launched in the Create New mode.
   Available palette elements	Select the Process designer elements, that you want to display in the Process designer palette when you launch the Process designer.

3. Click Save.

The following image displays sample values for the Launch process designer action:

To configure the Launch URL action

Use the Launch URL action to open any internal or external URL from your application. 

1. Add an action button to your view.
   For more information, see To configure an action on an action button .

2. In the Edit actions window, select the Launch URL action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to launch the URL.
   URL	Click Click to build an expression to specify the URL that you want to launch on clicking the action button.
   Launch behavior	Select the Launch behavior of the URL window from the options given in the list. The following launch behavior options are available:  (Default) Open in a new tab—The target attribute of the anchor tag is set as _blank and opens the URL in a new tab. Open in the same tab—The target attribute of the anchor tag is set as _self and opens the URL in the same frame as it was clicked. Open in the parent frame—The target attribute of the anchor tag is set as _parent and opens the URL in the parent frame. Open in the full body of the window—The target attribute of the anchor tag is set as _top and opens the URL in the full body of the window.

3. Click Save.

The following image displays sample values for the Launch URL action:

To configure the Open view action

Use the Open view action to open another view from the current view in your application. You can open the view in a new tab or within the same tab.  

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Open view action and enter the following details:

   Property	Description
   Condition	Click  Click to build an expression to create a qualification based on which you want to open a view.
   View	Select the view that you want to be displayed in the deployed application.
   Presentation	Select the position where you want to display the selected view. This option provides the following properties: (Default) Full width—Spans the entire width of the window. The Full width value requires you to define the Launch behavior. You can choose to open the view in a new window or in the same window. Modal (Centered, Docked left, Docked right)—Spans only a part of the window docked on the left, right, or center location. The Modal value requires you to specify the Size and Title of the view. You can choose any size ranging from extra small (450 px) to extra large (1600 px).
   Launch behavior	Select the option to open the target view that you selected. The Launch behavior field provides the following options: (Default)   Open in the same tab—The target attribute of the anchor tag is set as _self and opens the URL in the same frame as it was clicked. Open in a new tab—The target attribute of the anchor tag is set as _blank and opens the URL in a new tab. Important:  This field is displayed only if you select the Full width option in the Presentation field.
   Size	Specify the size of the target view of the deployed application. Important: This field is displayed only if you select the Centered modal, Docked left modal, or Docked right modal option in the Presentation field.
   Title	Specify the title of the target view. Important: This field is displayed only if you select the Centered modal, Docked left modal, or Docked right modal option in the Presentation field.

3. Click Save.

The following image displays sample values for the Open view action:

To configure the Refresh action

Use the Refresh action to refresh the display of a specified view or a component on a view of your application.

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Refresh action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to refresh a view or a component.
   View/Component	Click Click to build an expression to select the view or component that you want to refresh.

3. Click Save.

The following image displays sample values for the Refresh action:

To configure the Save action

Use the Save action to save and apply all the changes that you perform on the records or components of a view into your application database.

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Save action and enter the following details:

   Property	Description
   Condition	Click  Click to build an expression to create a qualification based on which you want to save a view or component.
   View/Component	Click  Click to build an expression to create an expression to select the view or component that you want to save.
   Close after save	Use the toggle key to close the view after saving.

3. Click Save.

The following image displays sample values for the Save action:

To configure the Set property action

Use the Set Property action to set some predefined properties on buttons or components of your view. You can set properties such as Hidden or Disabled on components and properties such as Edit state or Read state on the selected records instances. Additionally, you can set the Active tab index property on Tab panel components.  

1. Add an action button to your view.
   For more information, see To configure an action on an action button.

2. In the Edit actions window, select the Set property action and enter the following details:

   Property	Description
   Condition	Click Click to build an expression to create a qualification based on which you want to configure a property on your view or component.
   Property path	Click Click to build an expression to select the button or component on which you want to set the property value.
   Property value	Click Click to build an expression to select the value of the property on the selected button or component. Important: If no value is specified, the default value of the selected property is applied.

3. Click Save.

The following image displays sample values for the Set property action: