System Administration

Pages H

Pages V

To access this page:

  1. Select Admin > WebApps in the Navigation pane.

  2. Click Pages for a WEB APP NAME.

Field

Description

DESCRIPTION

Displays the name of the page used to identify the page in menus and lists. Any alpha-numeric string may be used.

PAGE TYPE

Displays the page type of the selected record.

  • Chart - Pages of this type display data in a visual format for easier interpretation. Some types include Line, Bar, and Pie.

  •  Dashboard - Pages of this type contain Layouts which allow the Designer to render several Chart pages at once depending on the configured layout.

  • Dynamic - Pages of this type are the standard pages of the framework that allow for configured column controls and data manipulation.

  • Header Detail - Pages of this type display two linked pages in parent and dependent panes.

  • Report - Pages of this type are used as read-only renderings of data similar to Dynamic pages. With this page type, an automatic “Reports” link is added to the applications switchboard and each report page is shown as a page link.

  • Service - Pages of this type are configured to run events on a pre-defined interval. Both unit of measurement and quantity of measurement can be defined. These run in the background.

  • Static - Pages of this type allow the Designer to embed an external resource, whether a file, .aspx page, or other web resources.

TABLE

Displays the name of the table or view where changes will be stored.

A table must be defined on all Dynamic pages.

A view can be used to update a table in another database. When using this advanced method, the key field(s) for the foreign table must be defined in Column properties.

Refer to Assign Column Properties for more information.

Column Properties

Click to display the Page Columns page where Control Properties are used to control the behavior of columns within a page. By default, all controls are text boxes, but you can override this behavior using column properties. All standard browser controls are available.

Refer to Assign Column Properties for more information.

Events

Click to display each event configured for the associated Column Property. These are available for several Control Types including Button, Text Box, Image, and Toolbar.

Page Groups

Click to display the page’s WebApp groups and their permissions on the page. This includes which Groups can view, edit, delete, and insert records.

Security Definitions

Click to display the security definitions integrated into this page. These definitions are bound on page columns and are used to restrict the availability of data through Role Security. Refer to Register Security Definitions to Components (WebApps) for more information.

Edit Page Help

Click to open the Catalog Page Help page, where the user can set the Dynamic Subtitle and Dynamic Help which appear when the page is loaded. These are defined per language.

Applications like Automate use Page Subtitle on their landing page to give a brief explanation of the application’s usage.

Pages V

Pages H

NOTE: The page type determines the fields that display on the Pages Vertical View.

Dynamic Page Type VV

Use this page to register a Dynamic page.

To access this page:

  1. Select Admin > WebApps in the Navigation pane.
  2. Click the Pages icon.
  3. Click Vertical View for a page with a Dynamic page type.

Dynamic Page Type: General tab

Field

Description

Description

Displays the page name.

Page Type

Displays the page type, in this case Dynamic.

Basic Properties

Table

Displays the name of the table where the data for the page is stored.

Horizontal View

Displays the SQL View that determines what fields from the table are to display on the Horizontal View of the page in what order.

Order By

Displays the name of the column on the Horizontal View that is the default sort on the page. The column sorts in either ascending or descending order. Sorting must be done in the DSP®, not in the SQL view.

NOTE: When a field name is entered in Order By field, the default order is ascending. To sort in descending order, enter the field name followed by a space and desc, for example, lastname desc. Separate entries by a comma.

Vertical View

Displays the SQL View that determines what fields from the table are to display on the Vertical View of the page in what order.

Horizontal Menu ID

Displays the menu that displays to the left of the page when the page is accessed. The standard menu is {component name} : Switchboard.

Vertical Menu ID

This field is not used.

Insert Method

Displays the page behavior when adding a new record. Options are:

  • Not Supported - No records can be added to the page. The Add icon on the Page toolbar does not display.
  • Horizontal Insert - Once a record is added and saved the current Horizontal View persists.
  • Horizontal Insert/Switch to Vertical - Once the record is added and saved, the Vertical View displays. The Vertical View must be saved to save any information on the Vertical View only. If the Vertical View is not saved, the data entered on the Horizontal View persists and still displays.
  • Horizontal/Switch to Vertical - Once the record is added and saved, the Vertical View displays. The Vertical View must be saved to save any information on the Horizontal and Vertical Views. If the Vertical View is not saved, the data entered on the Horizontal View is not saved.
  • Switch to Vertical Immediately - Upon adding a record, the Vertical View displays.

Update Method

Displays the page behavior when editing a record. Options are:

  • Not Supported - No records can be edited. The Edit icon on the Page Toolbar does not display.
  • Horizontal Update - Once a record is edited and saved the current Horizontal View persists.
  • Horizontal Update/Switch to Vertical - Once the record is edited and saved, the Vertical View displays. The Vertical View must be saved to save any information on the Vertical View only. If the Vertical View is not saved, the data edited on the Horizontal View persists and still displays.
  • Horizontal/Switch to Vertical - Once the record is edited and saved, the Vertical View displays. The Vertical View must be saved to save any information on the Horizontal and Vertical Views. If the Vertical view is not saved, the data edited on the Horizontal View is not saved.
  • Switch to Vertical Immediately - Upon editing a record, the Vertical View displays.

Support Delete

If enabled, records on the page can be deleted. If disabled, the Delete icon does not display on the page.

Dynamic Page Type: Advanced Properties tab

Field

Description

Short Description

Displays a short description of the page for documentation purposes.

Support Persistent Insert

If checked, when a user adds a record on the page and clicks Save, the page remains in Add mode. This feature is useful when a user adds several records at once.

Support Direct Update

If checked, a user can enable or disable a check box on this page without having to edit the page (i.e., click the Edit button). This feature is useful when there is a check box(es) on the page, and updating the check box(es) is commonly the only change that a user makes on the page. Uncheck this setting if it is expected that the user will update additional information on the page.

Enable Excel Integration

If checked, Excel integration is available on the page.

Excel Integration is the ability, at the framework level, to enable end-users to import data from Excel into DSP® pages.  

Refer to Enable Excel Integration and Use Excel Integration for more information.

Maintain Page Location

If checked, when the user adds or edits a record and the page switches to Vertical View, it remains in Vertical View after the user saves the record.

If unchecked, the page returns to the Horizontal View when a record is saved, which is the standard behavior.

Support Download

If checked, the page allows a user to download data to an Excel spreadsheet, a Word document or other formats.

Use this feature depending on the type of data the page displays, for example, a metric-related page may be useful to download, while a page containing sensitive information may not.

NOTE: Exclude fields, such as images and buttons, in the downloaded file if needed. Refer to Set Column Control Status for more information.

NOTE: In a case where fields should be included on the Download page that are not visible on the Horizontal or Vertical View, hide fields using the page columns All Views view type, but then enable them on the Download for this level of control.  Refer to Enable File Upload/Download for more information.

Refresh Rate

Displays the amount of time in seconds that passes before the page is automatically refreshed. If the value is 0, the page is not automatically refreshed.

Static Source 

This field is not used.

Catalog ID

Displays the name of the catalog used for translations for this page, if needed.

Refer to Manage Catalogs for more information.

Allow Explicit Quick Link

If enabled, this page can be linked to using the Quick Links feature.

If this page requires binding to function correctly (Page Control View for example) then this setting must be disabled. Refer to Quick Links for more information.

Copy

Click to open the Copy Page page to create a copy of the selected page to use as a basis for a new page. When a page is copied, the column properties, events, validations and other settings are copied.

NOTE: This button is disabled if the page is in Edit mode. Refer to Copy a Page in a WebApp for more information.

Dynamic Page Type: Deprecated Properties tab

Field

Description

Support Full Page Update

If enabled, records on the Horizontal View of the page can be edited. If disabled, editing for a record can only be performed on the Vertical View.

Horizontal Title Bar

Displays column name of the page's underlying table or view containing the data that displays in the title bar on the Horizontal view.

Vertical Title Bar

Displays column name of the page's underlying table or view containing the data that displays in the title bar on the Vertical view.

Default Page Mode

Displays how pages are initially displayed when records can be added on the page but no records have been added yet.

Options are:

  • Display - The user must use buttons to add and edit records on the page, even if no records exist.
  • Insert - The page displays in Add mode, ready to accept data without the user having to select an Add or Edit button. The Save button is active.

Breadcrumb Alias Horizontal

Contains an alias for the horizontal view of the page that displays in the breadcrumbs.

Breadcrumb Alias Vertical

Contains an alias for the vertical view of the page that displays in the breadcrumbs.

Static Page Type VV

Use this page to Create a Static Page.

To access this page:

1. Select Admin > WebApps in the Navigation pane.

2. Click the Pages icon.

3. Click Vertical View for a page with a Static page type.

Static Page Type: General tab

Field

Description

Description

Displays the page name.

Page Type

Displays the page type, in this case Static.

Basic Properties

Static Source

Displays the text that displays on the page.

Horizontal Menu ID

Displays the name of the menu that displays in the Navigation pane when the page is accessed. The standard menu is {component name} : Switchboard.

Vertical Menu ID

This field is not used.

Static Page Type: Advanced Properties tab

Field

Description

Short Description

Displays a short description of the page for documentation purposes only.

Refresh Rate

Displays the amount of time in seconds that passes before the page is automatically refreshed. If the value is 0, the page is not automatically refreshed.

Allow Explicit Quick Link

If checked, this page can be linked to using the Quick Links feature.

If this page requires binding to function correctly (Page Control View for example) then this setting must be unchecked. Refer to Quick Links for more information.

Catalog ID

Displays the name of the catalog used for translations for this page, if needed.

Refer to Manage Catalogs for more information.

Static Source as Full Screen

This field is not used.

Copy

Click to open the Copy Page page to create a copy of the selected page to use as a basis for a new page. When a page is copied, the column properties, events, validations and other settings are copied.

NOTE: This button is disabled if the page is in Edit mode.

Refer to Copy a Page in a WebApp for more information.

Header Detail Page Type VV

Use this page to Create a Header Detail page.

To access this page:

  1. Select Admin > WebApps in the Navigation pane.
  2. Click the Pages icon.
  3. Click Vertical View for a page with a Header Detail page type.

Header Detail Page Type: General tab

Field

Description

Description

Displays the page name.

Page Type

Displays the page type, in this case Header Detail.

Default Partition

Displays how the header detail pages open by default. If the partition is horizontal, the header page displays in the upper frame and the details page displays in the lower frame. If the partition is vertical, that header and detail pages display side by side.

Frames

Click to open the Layout Frames page to set the pages that are used for the Header and Detail pages.

Horizontal Menu ID

Displays the name of the menu that displays in the Navigation pane when the page is accessed. The standard menu is {component name} : Switchboard.

Vertical Menu ID

This field is not used.

Header Detail Page Type: Advanced Properties tab

Field

Description

Short Description

Displays a short description of the page.

Allow Explicit Quick Link

If checked, this page can be linked to using the Quick Links feature.

If this page requires binding to function correctly (Page Control View for example) then this setting must be unchecked. Refer to Quick Links for more information.

Copy

Click to open the Copy Page page to create a copy of the selected page to use as a basis for a new page. When a page is copied, the column properties, events, validations and other settings are copied.

NOTE: This button is disabled if the page is in Edit mode.

Refer to Copy a Page in a WebApp for more information.

Page Title

Displays the title for the header detail page, which is the [component name]: [page name].

Mode

This field is not used.

Chart Page Type VV

Use this page to Create a Chart.

To access this page:

  1. Select Admin > WebApps in the Navigation pane.
  2. Click the Pages icon.
  3. Click Vertical View for a page with a Chart page type.

Chart Page Type: General tab

Field

Description

Description

Displays the page name.

Page Type

Displays the page type, in this case Chart.

Basic Properties

Report View

Displays the name of the SQL view upon which the chart is based.

Horizontal Menu ID

Displays the name of the menu that displays in the Navigation pane when the page is accessed. The standard menu is {component name} : Switchboard.

Vertical Menu ID

This field is not used.

Chart Type

Displays the type of chart, such as Bar or Line.

Chart Properties

Click to open the Page (Chart Properties) page to set properties for the chart page, such as the location of the legend and labels, whether data displays in a hover view and other options.

Refer to Modify a Chart for more information.

Chart Page Type: Advanced Properties tab

Field

Description

Short Description

Displays a short description of the page for documentation purposes only.

Order By

Displays the field to sort by. Sorting must be done in the DSP®, not in the SQL view.

For example, a bar chart with labels can be sorted by the field that contains the label names. The bars would appear in that order when the chart displays.

NOTE: When a field name is entered in Order By field, the default order is ascending. To sort in descending order, enter the field name followed by a space and desc, for example, lastname desc. Separate entries by a comma.

Refresh Rate

Displays the amount of time in seconds that passes before the page is automatically refreshed. If the value is 0, the page is not automatically refreshed.

Static Source

This field is not used.

Catalog ID

Displays the name of the catalog used for translations for this page, if needed.

Refer to Manage Catalogs for more information.

Allow Explicit Quick Link

If checked, this page can be linked to using the Quick Links feature.

If this page requires binding to function correctly (Page Control View for example) then this setting must be unchecked. Refer to Quick Links for more information.

Ver Title

This field is not used.

Title Bar

This field is not used.

Copy

Click to open the Copy Page page to create a copy of the selected page to use as a basis for a new page. When a page is copied, the column properties, events, validations and other settings are copied.

NOTE: This button is disabled if the page is in Edit mode.

Refer to Copy a Page in a WebApp for more information.

Dashboard Page Type VV

Use this page to Create a Dashboard.

To access this page:

1. Select Admin > WebApps in the Navigation pane.

2. Click the Pages icon.

3. Click Vertical View for a page with a Dashboard page type.

Dashboard Page Type: General tab

Field

Description

Description

Displays the page name.

Page Type

Displays the page type, in this case Dashboard.

Layout ID

Displays the layout that is used for the dashboard. Layouts that are installed with the platform can be viewed on the Layouts page. A user can also add a layout. Refer to Create a Dashboard for more information.

Basic Properties

Horizontal Menu ID

Displays the name of the menu that displays in the Navigation pane when the page is accessed. The standard menu is {component name} : Switchboard.

Vertical Menu ID

This field is not used.

Dashboard Page Type: Advanced Properties tab

Field

Description

Short Description

Displays a short description of the page for documentation purposes only.

Catalog ID

Displays the name of the catalog used for translations for this page, if needed.

Refer to Manage Catalogs for more information.

Allow Explicit Quick Link

If checked, this page can be linked to using the Quick Links feature.

If this page requires binding to function correctly (Page Control View for example) then this setting must be unchecked. Refer to Quick Links for more information.

Ver Title

This field is not used.

Titlebar

This field is not used.

Copy

Click to open the Copy Page page to create a copy of the selected page to use as a basis for a new page. When a page is copied, the column properties, events, validations and other settings are copied.

NOTE: This button is disabled if the page is in Edit mode.

Refer to Copy a Page in a WebApp for more information.

Report Options tab

Use this page to Create Report Pages.

1. Select Admin > WebApps in the Navigation pane.

2. Click the Pages icon.

3. Click Vertical View for a page with a Report page type.

Field

Description

Support Report

If checked, the Report option is available on the Page Options drop-down for the page.

Report View

Displays the report view used for the report.

Report Groups

Click to open the Report Groups page to create report groups to organize the report. Refer to Create Report Groups for more information.

Service Page

Use this page to create a Service page.

To access this page:

1. Select Admin > WebApps in the Navigation pane.

2. Click the Pages icon.

3. Click Vertical View for a page with a Service page type.

Service Page Page Type: General tab

Field

Description

Description

Displays the page name.

Page Type

Displays the type of page, in this case, Service.

Basic Properties

Table

Displays the table where the data for the page is stored.

Horizontal View

Displays the name of the Horizontal View that contain the list of records that the service page must execute on. If there are no records in the view, the service page does not run.

Service Page Page Type: Service Properties tab

Use this page to Configure Service Pages.

Fields

Description

Queue ID

Displays the queue ID that determines which Service Queue is used during execution. This can be used to serialize certain operations or load balance.

Next Service Date

Displays the next service date and time the service page will run.

Service Qty

Displays the frequency that the service page will run and used in conjunction with the UOM (Unit of Measure) field. For example, if the Service Qty field displays 2 and the Service UOM field is Day(s) the service page runs every two days starting from the date displayed in the Next Service Date field.

Service UOM

Displays the service UOM (Unit of Measure) that is used in conjunction with the number in the Service Qty field to set the frequency that the service page will run.

Active

If checked, the service page will run. If unchecked, the service page will not run but can be activated at a later date to run again. .

Copy

Click to open the Copy Page page to create a copy of the selected page to use as a basis for a new page. When a page is copied, the column properties, events, validations and other settings are copied.

NOTE: This button is disabled if the page is in Edit mode.