Button Properties records define the properties of buttons for the Digital Dashboard, including button appearance and functionality when selected by the user. These records are only available from the Buttons sub-tab of the Properties tab of the Dashboard Parts form.
Action Properties Tab
The Action Properties tab contains the parameters required by the Action Type selected on the General tab of the Button Properties form. The parameters change based on the value selected in the Action Type field.
Generic Data Wizard Action Type Properties
The Generic Data Wizard action type launches a specified metadata wizard. See Administering Metadata Wizards for information on metadata wizards.
Target Entity
The target entity for the wizard. (Each wizard is linked to a Target Entity.)
Wizard
Displays the set of available wizards based on the specified Target Entity.
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.
Open Form Action Type Properties
Action type properties for Open Form buttons specify the service from which to open a record. The button may be configured to either open a new record or an existing one.
Service (required)
The service from which a form is opened.
Open Record
The Open Record field links to the record to be opened. This is applicable only if the button function is to open an existing record. If left blank, the button opens a new record.
New Record Parameter
Parameters for the new form are defined in the New Record Parameter field. This option is intended for advanced users and is applicable only if the button function is to open a new record for the service specified in the Service field.
Preview Report Action Type Properties
Action type properties for Preview Report buttons include the name of the report to be printed, as well as the service on which it is based.
Service (required)
The Service field stores the name of the service where the report is generated. This field links to the Entities service.
View (required)
The view specified in the View field contains all records that are included in the report to be previewed. This field links to the Views service.
Report (required)
The Report field stores the name of the report to be previewed when the button is selected.
Print Report Action Type Properties
Action type properties for Print Report buttons include the name of the report to be printed, as well as the service on which it is based.
Service (required)
The Service field designates the service from which the report is generated. This field links to the Entities service.
View (required)
The view specified in the View field contains all records to be included in the report. This field links to the Views service.
Report (required)
The Report field stores the name of the report to be printed.
Run Entity Bulk Operation Action Type Properties
Buttons which run an entity bulk operation must be configured with the name of the entity bulk operation to run and a view upon which the operation executes.
Bulk Operation (required)
The Bulk Operation field stores the name of the bulk operation to be executed when the button is selected. This field links to the Bulk Operations service.
View
The View field specifies the view that the Bulk Operation runs against.
Run Find Dialog Action Type Properties
Action type properties for Run Find Dialog buttons include the name of the service on which the Find should be based.
Service (required)
The Service field specifies the service where the Find search should be run. This field links to the Entities service.
Run Process Flow Action Type Properties
Run Process Flow buttons are linked to the process flow they execute through the Action Type Properties tab. The input properties for the process flow are specified on this tab as well.
Process Flow (required)
The Process Flow selected in this field is executed when the button defined is selected. This field is linked to the Process Flows service.
Input Properties Section
Input Properties define data that is required for the process flow to run correctly. The input parameters are inherited from the Process Flow specified in the Process Flow field.
See Configuring Process Flow Input Maps for information on configuring the Input Map for a Process Flow.
Run Wizard Action Type Properties
Run Wizard buttons provide a shortcut for the user to start a specified wizard. Action type properties for these buttons require the name of the wizard, as well as the name of the service on which the wizard is based.
Service (required)
The Service field specifies the service on which the wizard is based. This field links to the Entities service.
View
The View field designates the view within the service that should be used when the wizard is run.
Wizard (required)
The Wizard field specifies the name of the wizard started by the button defined.
Switch Dashboard Action Type Properties
The Switch Dashboard buttons give the user a shortcut for switching to another dashboard.
Dashboard Type (required)
The Dashboard Type field specifies the level of the dashboard that the user will switch to when the button is clicked. The available dashboard types are Global Dashboard and Application Dashboard.
Application
The Application field designates the Folder List application that the user will switch to when he or she clicks the button. This field is required if the user selected Application Dashboard in the Dashboard Type field.
Appearance Tab
On the Appearance tab of the Button Properties form, the display parameters are configured, including color, font, and text size.
Text Color (required)
Text Color designates the color of any text displayed on the button. The default color is black. Note that button's whose Style is System always use black as the text color (regardless of what color you select for this field).
Back Color (required)
Back Color specifies the background color for the button. The default color is gray. Note that button's whose Style is System always use gray as the back color (regardless of what color you select for this field).
Font Name (required)
Font Name specifies the font name for button text. The default font is Tahoma.
Font Size (required)
Font Size indicates the size of the font for button text. The default size is 8 points.
Style (required)
The style selected defines how the button borders are displayed. The following options are available: Flat, Popup, Standard, and System. To see how these styles differ, select one of the styles and then click the Image tab to see a sample button of the selected style.
Comments Tab
The Comments tab contains any comments relevant to the Dashboard Button record.
General Tab
The basic characteristics of a button for the digital dashboard are defined on the General tab of the Button Properties form. These characteristics include the button name, location, size, and the type of action performed when the button is selected. Button location is designated in pixels.
Name (required)
The name of the button is specified in the Name field.
Name Culture String
The localized display name for the button. The appropriate name appears that corresponds to the user's assigned Culture. See Using Localization Administration for details.
Description
The description of the button is stored in the Description field. The description appears as the button's tool tip when a user mouses over the button.
Desc Culture String
The localized description of the button. The appropriate name appears that corresponds to the user's assigned Culture. See Using Localization Administration for details. If specified, the applicable culture string appears as the button's tool tip.
Action Type (required)
The action to run when the button is selected. Additional properties for the Action Type selected are configured on the Action Type Properties tab.
The following Action Types are available:
- Open Form: Selected by default. Opens either a new record or an existing record from the service specified when the button is selected.
- Run Find Dialog: Opens the Find search dialog box for the specified service when the button is selected.
- Switch Dashboard: Use this option to switch between dashboards. When clicked, the specified dashboard loads.
- Preview Report: Allows users to preview a specified report when the button is selected.
- Print Report: Allows users to print a specified report when the button is selected.
- Run Entity Bulk Operation: Runs the entity bulk operation specified when the button is selected.
- Run Process Flow: Executes the process flow specified when the button is selected.
Location Mode (required)
Location mode defines where the button is located in the button bar of the Digital Dashboard. The standard values are:
- Automatic: Selected by default. Location of the button is determined automatically by the system.
- Manual: Location of the button is manually specified. This requires use of the Left and Top fields.
Left (required)
The Left number specifies the location of the left side of the button as the number of pixels from the left of the button bar. The default value is 0. This field is only active when the Location Mode is Manual.
Top (required)
The Top number specifies the location of the top side of the button as the number of pixels from the top of the button bar. The default value is 0. This field is only active when the Location Mode is Manual.
Size Mode (required)
Size Mode indicates how the button is sized. Sizing options are:
- Automatic: Selected by default. The button bar automatically calculates the button width and height based on button bar attributes.
- Manual: The Width and Height field values are used to calculate the size of the button.
Width (required)
The Width field specifies the width of the button in pixels. The default value is 33. This field is only active when Size Mode is set to Manual.
Height (required)
The Height field specifies the height of the button in pixels. The default value is 33. This field is only active when Size Mode is set to Manual.
Image Tab
If the button includes an image instead of just text, this is defined on the Image tab of the Button Properties record.
Image Location
The Image Location field defines the location of the image file in the Object Repository. Note that this field is only applicable when the button's Style is set to Standard.
Image Alignment (required)
Image Alignment determines the position of the image on the button. The default value is Left of Caption. The standard values are: Left Top, Left Middle, Left Bottom, Right Top, Right Middle, Right Bottom, Center Top, Center Middle, Center Bottom, Left of Caption, Right of Caption, Top of Caption, and Bottom of Caption.
Button Preview Section
The Button Preview section presents a graphical representation of the button as currently designed.