This documentation supports the 23.3 version of BMC Helix Innovation Suite (AR System and BMC Helix Innovation Studio).

To view an earlier version, select the version from the Product version menu.

Configuring actions for an action button

Most BMC Helix Innovation Studio applications require basic actions on views to run business scenarios. As a developer or an application business analyst, you can add actions to an action button to perform certain tasks. You can add multiple actions to a single action button and specify the sequence in which you want the actions to be performed

The actions are executed in the specified sequence, when the specified condition is satisfied. For information about how to add an action button to your view, see Adding an action button to a view.



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 that 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.

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


To configure the Apply grid filter action

You can configure custom filters on a record grid for a set of records on your view by using the Apply grid filter action. 

  1. Add an action button to your view.
    To add an action to an action button, 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:

    PropertyDescription
    Condition

    Click Click to build an expression to create a qualification based on which you want to apply the filter to the grid.

    Record gridClick Click to build an expression to provide the record grid to which you want to apply the filter.
    Mode

    Select the mode that you want to apply the filters to the selected record grid:

      • BeginBegins a batch of filter updates.

      • (Default) AppendApplies filters with an AND operator, and existing filters for the specified fields are removed.

      • RemoveRemoves existing filters if the condition matches the applied filter. Replaces previous data with new data record if a duplicate data record is found.

      • OverwriteReplaces all existing filters with the applied filters. 

      • Merge— Performs any | 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.

      • ClearRemoves all existing filters.
      • EndApplies 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:

Seth, a developer at Apex Global wants to tailor the Leave Management application so that the HR person can notify employees if their leaves lapse in a month. Seth configures the Apply grid filter action on the Send leave notification button to filter the employees based on the leave balance and send notifications. 

Example ...


To configure the Associate records action

You can create associations between specified record definitions or a set of records on your view by using the Associate records action. 

  1. Add an action button to your view.
    To add an action to an action button, 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:

    PropertyDescription
    ConditionClick Click to build an expression to create a qualification based on which you want to associate the records. 
    Record definition to associate

    Select the record definition from the list 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

    Select the record association from the list that you want to add or associate.  

    Associated record node side

    Confirm this selection.

    This field is automatically populated when the association is selected in 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.

Important

To see the associations, create a view containing record grid in Association mode. For information about how to create a view for associating records, see Creating a view for associating records.

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

Seth, a developer at Apex Global wants to tailor the Leave Management application so that an employee can apply for leaves from the company's optional holiday list. Seth creates a view which displays the employee records and the association between employee and his applied optional leaves. Seth configures the Associate records action on the Apply optional leave button to allow employees select and associate to the optional holiday records.

Example - Associate records...


To configure the Close view action

You can configure the action button 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.
    To add an action to an action button, 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:

    PropertyDescription
    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 revert all the unsaved actions performed on the view.  

  3. Click Save.

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

To configure Delete records action

You can delete selected records from the specified record definition or for a set of records on your view by using the Delete records action.  

  1. Add an action button to your view.
    To add an action to an action button, 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:

    PropertyDescription
    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

    Select the record definition from the list, from which you want to delete 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 Delete records action:

Seth, a developer at Apex Global wants to tailor the Leave Management application so that the HR team member can delete the records of the ex-employees of the organization. Seth configures the Delete records action on the Delete button to allow HR department to delete the employee record of the selected employee ID.

Example - Delete records...



To configure the Disassociate records action

You can delete the selected records from the associations between two record definitions on your view by using the Disassociate records action. 

  1. Add an action button to your view.
    To add an action to an action button, 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:

    PropertyDescription
    ConditionClick Click to build an expression to create a qualification based on which you want to disassociate the records. 
    Record definition to disassociate

    Select the record definition from the list 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

    Select the record association from the list 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:

Seth, a developer at Apex Global wants to tailor the Leave Management application so that employee Alex can cancel applied optional leaves. Seth configures the Disassociate records action on the Cancel leaves button to allow employees to remove the optional holidays from their list of applied leaves.


Example...



To configure the Edit records action

You can edit and save the selected records from the specified record definition or for a set of records on your view by using the Edit records action.

  1. Add an action button to your view.
    To add an action to an action button, 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:

    PropertyDescription
    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:

Seth, a developer at Apex Global wants to tailor the Leave Management application so that the HR team member can change the designation of the promoted employees. Seth configures the Edit records action on the Edit button to allow HR team member to edit the selected employee records.

Example...



To configure the Launch process action

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

  1. Add an action button to your view.
    To add an action to an action button, 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:

    PropertyDescription
    Condition 

    Click Click to build an expression to create a qualification based on which you want to launch the process. 

    Process to startSelect 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

You can access a process definition from a Process designer instance within the application view by using the Launch process designer action. 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.
    To add an action to an action button,  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:

    PropertyDescription
    ConditionClick 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 elementsSelect 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:


Important

  • On the Defaults tab of the Process designer, you can view the elements that you have selected from the list. On the Manage Palette tab, you can view the elements that you have not selected.


  • You can add the elements from the Manage Palette tab of the Process designer, into your user preferences list.


Seth, a developer at Apex Global wants to tailor the Leave Management application so that HR manager Jim can create new processes for his department. To define this action behavior, Seth adds the Launch process designer action on the New HR Process button. Seth adds required set of palette elements which Jim needs to define new HR processes, in the Process designer. Seth also sets the Policy update Reminders as the default process which opens in the Process designer.

Example...


To configure the Launch URL action

You can open any internal or external URL from your application by using the Launch URL action. 

  1. Add an action button to your view.
    To add an action to an action button,  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:

    PropertyDescription
    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: 

      1. (Default) Open in a new tab 
      2. Open in the same tab
      3. Open in the parent frame
      4. Open 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

You can open another view from the current view in your application by using the Open view action. The view can be opened in a new tab or within the same tab.  

  1. Add an action button to your view.
    To add an action to an action button,  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:

    PropertyDescription
    ConditionClick Click to build an expression to create a qualification based on which you want to open a view. 
    ViewSelect 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 widthSpans 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 same tab

      • Open in 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

You can refresh the display of a specified view or a component on a view of your application by using the Refresh action.

  1. Add an action button to your view.
    To add an action to an action button,  see To configure an action on an action button.
  2. In the Edit actions window, select the Refresh action and enter the following details:

    PropertyDescription

    Condition 

    Click Click to build an expression to create a qualification based on which you want to refresh a view or a component. 
    View/ComponentClick 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

You can save and apply all the changes that you perform on the records or components of a view into your application database by using the Save action.

  1. Add an action button to your view.
    To add an action to an action button, see To configure an action on an action button.
  2. In the Edit actions window, select the Save action and enter the following details:

    PropertyDescription
    ConditionClick Click to build an expression to create a qualification based on which you want to save a view or component. 
    View/ComponentClick 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

You can define some predefined properties on buttons or components of your view by using the Set Property action. Properties such as Hidden or Disabled can be set on components and properties such as Edit state or Read state can be set on selected records instances. The Active tab index property can be set on the Tab panel. 

  1. Add an action button to your view.
    To add an action to an action button, 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:

    PropertyDescription
    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 pathClick 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:

Seth, a developer at Apex Global wants to tailor the Leave Management application so that the HR manager can view the department-wise employee list.

To define this action behavior, Seth configures two Set property actions on the Select button:

  •  Set property 1To show the hidden Tab panel containing department-wise employee list.
  •  Set property 2To activate the tab of the selected department.

Example ...



Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Patrik Stanz

    what about the "Launch behavior" "open in the full body of the window"?

    May 06, 2024 11:09
    1. MINAL DESHPANDE

      Hi Patrik,

      We are working on updating this information on this topic. 

      Thank you,

      Minal

      Jun 03, 2024 05:21