Defining the Ribbon Button Action Types

Madhuri Dange

April 04, 2022 09:55

This topic describes each action type and how to define each type's configuration parameters.

A ribbon button in the Aptify Desktop client can use one of the following Action Types:

Generic Data Wizard Action Type
Open Form Action Type
Preview Report Action Type
Print Report Action Type
Run Entity Bulk Operation Action Type
Run Find Dialog Action Type
Run Process Flow Action Type
Run Wizard Action Type
Switch Dashboard Action Type

Generic Data Wizard Action Type

The Generic Data Wizard action type launches a specified metadata wizard. See Administering Metadata Wizards for information on metadata wizards.

Follow these steps to link a wizard to a ribbon button:

From the General tab on the Button form, select Generic Data Wizard from the Action Type drop-down field.
Select the Action Properties tab.
Enter the Target Entity for the wizard in the field provided. (Each wizard is linked to a Target Entity.)
Select an available wizard from the drop-down list based on the Target Entity you selected.
Note that only wizards with a scope of Global or Application are available for selection. Application-scoped wizards are only available if you are working with a dashboard linked to the wizard's specified application.
Click OK to save the button.

Open Form Action Type

The Open Form action type opens either a new record or an existing record in a new window.

Follow these steps to link opening a form or record to a ribbon button:

From the General tab on the Button form, select Open Form from the Action Type drop-down field.
Select the Action Properties tab.
Enter the service whose record you want to open in the Service link box.
If a specific record is to be displayed, enter that record's Name or ID in the [Service Name] record to open link box.
- Leave this field blank to specify that the button should open a new, blank form for the specified service when clicked.
If the button opens a new record, you can specify default field values to automatically populate the new record in the New Record Parameters field (for advanced users).
- To specify default parameters for new records opened by the button, use this syntax:
```
PARAMS(Field1=Value|Field2=Value)
```
  - For example, to automatically populate a new Persons record's Company field with the Company whose ID is 1, enter PARAMS (CompanyID=1)
Click OK to save the button.

Preview Report Action Type

The Preview Report action type launches an Aptify report in a new window.

Follow these steps to link launching a report to a ribbon button:

From the General Tab on the Button form, select Preview Report in the Action Type field.
Select the Action Properties tab.
In the Service field, enter the service associated with the report to display.
In the View field, enter the view that contains the records to display in the report. Only views owned by the current user can be added to this field.
Select the report to display from the Report drop-down list, which contains those reports associated with the selected service.
Click OK to save the button.

Print Report Action Type

The Print Report action type prints an Aptify report to the default printer. A window displays confirming the printing of the report.

Follow these steps to link printing a report to a ribbon button:

From the General tab on the Button form, select Print Report in the Action Type field.
Select the Action Properties tab.
In the Service field, enter the service associated with the report to print.
In the View field, enter the view that contains the records to display in the report. Only views owned by the current user can be added to this field.
Select the report to print from the Report drop-down list, which contains those reports associated with the selected service.
Click OK to save the button.

Run Entity Bulk Operation Action Type

The Run Entity Bulk Operation action type runs a specified entity bulk operation. See Administering Entity Bulk Operations for information on how to create entity bulk operations.

Follow these steps to link running an Entity Bulk Operation to a ribbon button:

From the General tab on the Button form, select Run Entity Bulk Operation in the Action Type field.
Select the Action Properties tab.
Enter a bulk operation in the Bulk Operation field.
In the View field, enter the view that contains the records on which to run the selected bulk operation.
Click OK to save the button.

Run Find Dialog Action Type

The Run Find Dialog action type launches a Find Items dialog box in a new window for the service specified on the Action Properties tab.

Follow these steps to link running the Find Items dialog to a ribbon button:

From the General tab on the Button form, select Run Find Dialog in the Action Type field.
Select the Action Properties tab.
In the Services field, enter the service in which to perform the search.
Click OK to save the button.

Run Process Flow Action Type

The Run Process Flow action type executes a process flow using the input values you specify. See Managing Process Pipelines for information on configuring and using Process Flows.

Follow these steps to link running a process flow to a ribbon button:

From the General tab on the Button form, select Run Process Flow in the Action Type field.
Select the Action Properties tab.
Enter the process flow available in Aptify to run in the Process Flow field.
- The specified process flow's input properties automatically populate the Input Map.
Specify a Source Type and Source for each Input Property in the Input Map as necessary to configure the process flow's execution logic.
Click OK to save and close the Button record.

Run Wizard Action Type

The Run Wizard action type launches a specified wizard.

Follow these steps to link launching a specific wizard to a ribbon button:

From the General tab on the Button form, select Run Wizard in the Action Type field.
Select the Action Properties tab.
In the Service field, enter the service associated with the wizard you want to run.
In the View field, enter the view that contains the records that the wizard can use during its execution. This field is not required.
Select an available wizard (associated with the selected service) from the Wizard drop-down list.
Click OK to save the button.

Switch Dashboard Action Type

The Switch Dashboard action type switches to the global Home tab or a specified application-level tab.

Follow these steps to link switching Dashboards to a ribbon button:

From the General tab on the Button form, select Switch Dashboard in the Action Type field.
Select the Action Properties tab.
Select Global Dashboard or Application Dashboard from the Dashboard Type drop-down menu.
- If you selected the Application Dashboard, then enter the application in the Application field.
Click OK to save the button.