Views are the tools by which data is used in DataVoke. Some Views are designed as User interface tools, while others are made to run in the background and perform calculations and other functions.
Views can be modified by clicking on the toggle to design mode icon in the left toolbar to launch the Layout Edit Toolbar. From here you can click the edit button to open the"Edit View" screen.
Editing a View
- Title: This is the friendly name of the View and will be displayed in Tabs for navigation.
- Name: This is the official name of the view in the framework and will automatically populate with the Title.
- Hint: When hovering over the name of the view in the View Header, this will be the message that appears to give the user more information on what the view is for.
- Notes: This is a description of the view that can only be seen by those users who are tuning it.
- App Name: Within an App Category, the user can specify a name for the view that will appear on the Home/Tile Screen. Note: This setting ONLY applies to Layout view types. DO NOT use this setting for any other view types. Doing so will cause the view to not appear on the Home/Tile Screen.
- App: The user can specify an App Category for the view. A list of available App Categories appears on the left side of the Home/Tile Screen.
- Type: The user must specify a type for the view. This will either be a Data View or a Related Data View. Related Data Views listen to Data Views.
- Tags: As the designer you can place tags on your view to enable categorizing and sorting. Tags are also used when creating Packages.
- UID: This is a globally unique ID given to the view for use in SQL queries. Note that this ID can't be adjusted.
- ID: is applied through auto-numbering
Depending on the view type (i.e. Data View or Related Data View) you're working with, the settings you can apply vary widely.
The View Tuner has a total of six tabs that organize all of the settings:
- Data: Adjust the basic settings for the view
- Actions & Events: Addresses button Actions and other programmable behavior in the View
- Display & Grid: Set options for Grid and Sub-Grid view types
- Security: Specify which user groups have access to this View
- Other: Select Grouped property or Report Location
- Where Used: See a list of Views referencing your current View
With these tabs in mind, the remaining documentation for view tuning will break down the various settings shown on these tabs.
First you’ll see the Primary Record Type then a list of the included Data Properties.
- Click the Plus sign to include a property from the Primary Record Type list of properties.
- Click the Link to include a property from another Record Type based on a relationship.
- Double-click a Data Field to configure it for your View in the Edit Column Property screen.
- Click the Minus sign to remove a property from the view.
Data Behavior Options
- Suppress Initial Loading: If checked, no data will be requested from the server when the view is loaded.
- Shows Detail: For the Grid view type only, this setting will display the view as a Detail View. Detail Views are used when a user only wants to view certain columns (i.e., properties) from a particular view (think of it as a "parent view") that has several columns in it. A view that is designed to be a Detail View is created using the parent view's primary record type and tuned to listen to the "parent view". With those settings in mind, the desired columns from the parent view can be selected for the Detail View via the Display & Grid tab of the View Tuner.
- Linked To User: Only display records that are linked to the current user. The current user created or was explicitly joined to using the join action.
- Include Deleted Records: When enabled in conjunction with the Keep Deleted Records option in the System Settings, records that are deleted from a view will continue to be displayed. The properties for the record will be read only and the record code status will be set to the status specified in the Data Retention settings. Disabling this option will not delete the records, but will hide them from the view.
- View Index: The user can specify a property (from the view's associated record type) to be used as an index for the view. This option is used in conjuction with Move Record Position action.
Actions & Events
Search for an existing Action or Action Chain, also add or remove an action chain from the list.
- Double-click an Action: Opens Edit Action Chain. This is where you can tune action chains that will be added to the View.
- Click plus to add an Action or Action Chain
- Click folder to copy an Action Chain from an other view
- Click minus to remove an Action or Action Chain
- On Init: This specifies the action chain that will automatically be run when a view is initialized (before any building of form, grid, or server requests are made).
- On Open: This specifies the action chain that will automatically be run when a view is opened.
- Dbl Click (Grid): This specifies the action chain that will automatically be run when a record is double-clicked in the grid.
- Auto-Select First: For Grid, Sub-Grid, and Diagram view types, this setting will make the grid automatically select the first record in its view (which may drive other views).
- View Selection Listeners: Applicable to all view types, the user can allow the view being tuned to listen to another view by clicking the "Choose" button. Clicking this button opens a list of available views, from which the user can specify the view to listen to.
Display & Grid
- Width and Height: When defined, these fields specify the view's width and height--either in terms of pixels or in terms of percent.
- Hide Native View Close: Upon opening the view with this setting enabled, the "x" icon no longer appears. This prevents the user from by passing the logic set on the views close button.
- Ignore Status Styling: When this setting is enabled it does not allow the user to see the background or font color changes when a status is applied.
- No Record Text: The user can specify the text to be shown in the view when there are no records contained in it.
- Show Filter Bar: For Grid and Sub-Grid view types, this will enable the Filter Bar to appear when the view is opened. The Filter Bar appears above the first record in the view, and provides a way for the user to filter the records.
- Show Search Panel: For Grid and Sub-Grid view types, this will enable the Search Panel to appear when the view is opened. The Search Panel appears above the Property Header of the view, and allows the user to search for records based on the specified criteria that they enter.
- Show Grid Summary: If checked, this will add a Summary section (colored in dark gray) at the bottom of the view. From this section, the user can view the results of aggregate functions for each of the properties. To set the aggregate function to be used for a particular property (after enabling this setting), the user should navigate to the Edit Column Property by double clicking on the property you want to set the aggregate function on. Configure the Grid Summary and Summary Display settings for the choosen property.
Show Group Summary: If checked, this will add a Group Summary to the right of each grouped row in the view. This is similar in function to the Show Grid Summary setting, except that this setting is utilized specifically for grouped data. To have this work properly, the user must also set some settings via the Edit Column Property screen. This process is a bit more involved than for the Show Summary setting, so a step-by-step description of the process is explained below.
- In the Data Fields section of the Data tab, find the property that is desired to group the records by and double-click to open the Edit Column Property view. Select the Is Grouped (in grid) option. This sets the property as the one that the records will be grouped by.
- Select the Group Summary setting for the property. This specifies the aggregate function that will be run on the grouped data.
- Set the desired display format by setting it in the Summary Display field.
- Click Save Launch on the Toolbar to save the view settings and then launch the view.
- Is Selection: For Grid and Sub-Grid view types, this setting makes the view only allow selections of particular records (i.e., no editing is allowed). A "Selected" column is added as the first column in the view, which contains check boxes to select the records.
Select the groups to have access to this View.
- View is Shared: If checked, this allows the user to share the view with other users.
- View is Standard: If checked, this view will show in the DataVoke menu under a sub-menu of its label (if any).
Grouped Property: If desired, the user can specify a property to group by if they are performing an analysis on grouped data.
Report Location: Template to be populated with grid data when exported/printed. Specifying this field will enable the view to be selected for the Automate Document acton.
This is a convenient way to quickly show how tuning the selected view will affect the overall configuration.