System Administration
Page Columns H
Use this page to
- Configure Columns for Exporting
- Add a Control Type to a Column
- Link to a Page Using Buttons and Images
- Add a Toolbar Button
- Set Column Control Status
- Set a Column's Format
- Set Default Field Value for a Column
- Add an HTML Area to a Column
- Enable Dynamic Image
- Add a Label
- Add a tab
- Set Spanning Properties
- Enable File Upload and Download
- Add List Boxes and Combo Boxes
- Add a Watermark
- Add a Tooltip
- Enable Electronic Signature
- Assign Column Properties
- Link to a Report from a Page
- Include all Page Details in Reports
- Set Required Fields
- Create Chart Drill Down
- Add Validate and PreFinish Events to Content WebApp Pages.
There are three ways to access this page:
- Select Admin > WebApps in the Navigation pane, and click Pages for a WebApp. Locate the page and click Column Properties.
- Navigate to the page in the WebApp where the column property is to be applied. Click Change Settings on the Site Toolbar, click Design, then click Column Properties.
- Navigate to the page in the WebApp where the column property is to be applied, right-click the column heading, and click Add or Edit (Control Name) if the column property already exists.
Field |
Description |
COLUMN |
Displays either:
|
VIEW TYPE |
Displays the context in which the control appears as configured. All Views can be used in most cases. However, column properties can be applied to other views as needed. For example, a field can be a Combo Box on the Horizontal View, but can be a display only field on the Vertical View. In this case, set the field as a Combo Box for the View Type of All Views. Add another record for the field and select a View Type of Vertical, and set the CONTROL STATUS to Disabled. |
CONTROL |
Displays the behavior of columns within a page. By default, all controls are text boxes but can be overridden by assigning a column property. A column can have one control per view. Refer to Add a Control Type to a Column for more information. NOTE: The types of controls available for a column depend on that column's page's page type. Refer to View the Controls Available for a Page Type for more information. |
LIST SOURCE |
Displays the source of the data when the Control Type is Combo Box or List Box. The value can either be a SQL object (Table or View) or a List Data Provider plugin. Refer to Add List Boxes and Combo Boxes for more information. |
LINK TO PAGE |
Displays the Page Name/ID the Stewardship Tier navigates to when a page link is performed. This option can be set for control types:
Refer to Link to a Page Using Buttons and Images for more information. |
CONTROL STATUS |
Displays whether the column should be enabled (displayed), disabled (display only), or hidden in the associated View Type. Control Status can be overridden using Page properties, UserControlView, PageControlView or DataControlViews. Refer to Set a Column Control Status for more information. |
Help |
Click to open the Catalog Phrase Translations (Page Specific) page to set up help text for this column for a specific catalog. The translation displays when a user hovers over the column header. |
Page Columns V
NOTE: The fields that display on the Vertical View of this page depend on the control type of the selected column.
Page Columns V: Label Control Type
Use this page to Add a Label.
Field |
Description |
Column |
Displays the text that appears on the Label. |
View Type |
Displays the type that uses the control. |
Control |
Displays Label. |
Basic Properties |
|
Collapse |
If enabled, a plus or minus sign displays next to the label. The user can click it to expand or collapse the display of the fields under that label's section. |
Page Columns V: tab Control Type
Use this page to Add a Label.
Field |
Description |
Column |
Displays the name of the tab. |
View Type |
Displays the type that uses the control. |
Control |
Displays tab. |
Basic Properties |
|
Collapse |
If enabled, a plus or minus sign displays next to the label. The user can click it to expand or collapse the display of the fields under that label's section. |
Page Columns V: All Other Control Types
This page contains the following tabs:
- General
- Excel
- Advanced Properties
- Enable/Disable Control
- Deprecated Properties
- Spanning Properties
- Relational
General
Field |
Description |
Column Description |
|
Column |
Displays the name of the column from the view or table associated with the page. |
View Type |
Displays the context in which the control appears as configured. All Views can be used in most cases. However, column properties can be applied to other views as needed. For example, a field can be a Combo Box on the Horizontal View, but can be a display only field on the Vertical View. In this case, set the field as a Combo Box for the View Type of All Views. Add another record for the field and select a View Type of Vertical, and set the CONTROL STATUS to Disabled. |
Control Status |
Displays whether the column should be enabled (displayed), disabled (display only), or hidden in the associated View Type. Refer to Set a Column Control Status for more information. |
Control |
Displays the behavior of columns within a page. By default, all controls are text boxes but can be overridden by assigning a column property. A column can have one control per view. Refer to Assign a Control Type to a Column for more information. |
Basic Properties |
|
Image ID |
Displays the name of the image used for the button or image. This field displays for the controls:
|
Link to Page ID |
Displays the name of the page that opens when the user clicks the control. Refer to Link to a Page using Buttons and Images for more information. This field displays for the controls:
|
Required |
Displays the requirement level on a column by adding a page validation view. The requirement levels are:
If the field value contains NOT NULL in the table (such as a key), columns automatically defaults to Required (Hard). Refer to Set Required Fields for more information. This field displays for the controls:
|
Default |
Provides defaults for page columns during record insert. Defaults may also be set by a Defaults View at the page level. Refer to Set the Default Field Value for a Column for more information. This option is available for these controls:
|
Checkbox Format ID |
Displays the format. Options are:
NOTE: A check box using this format allows the values ‘X’ for checked and ‘!’ for unchecked. The ‘!’ is a special character used in an SAP BDC that tells the program there is no data in the field (i.e., the field should be ignored). This is useful when doing an update to existing data in SAP and the data must not change unless it has been modified.
NOTE: A check box using this format allows the values ‘X’ for checked and ‘ ‘ for unchecked.
NOTE: A check box using this format allows the values ‘Y’ for checked and ‘N’ for unchecked. NOTE: If the data type of the table column in SQL is set to bit, the Stewardship Tier assumes the field is a checkbox and appropriately populate the data with a 1 or 0. NOTE: If one of these formats is chosen for the checkbox, the data type of the table column in SQL must be set to a character of length 1. The user will receive a hard error while entering data on the page if one of these checkbox formats is selected and the data type of the field is bit or another non-character format. NOTE: This option is available for Check Box only. |
Watermark Text |
Displays static text to use as a placeholder watermark when the control is empty. Refer to Add a Watermark for more information. This field displays for the controls:
|
Format |
Displays a format for the selected control specified by the page Designer. Options vary for each control. Column database type should be taken into consideration when selecting Numeric and DateTime formats. Refer to Set a Column’s Format for more information. This field displays for the controls:
|
Move To Toolbar |
Displays the toolbar location. The only option is Page. This field displays for the Toolbar control only. |
Basic List Properties NOTE: The fields in this section display for List Box and Combo Box controls only. |
|
List Source |
Displays the source of the data when the Control Type is Combo Box or List Box. The value can either be a SQL object (Table or View) or a List Data Provider plugin. Refer to Add List Boxes and Combo Boxes for more information. |
List Value Field |
Displays the name of the field that stores the value. In most cases, List Value Field is the primary key stored in the table Refer to Add List Boxes and Combo Boxes for more information. |
List Display Field |
Displays the option visible in the List Box or Combo Box. Refer to Add List Boxes and Combo Boxes for more information. |
Basic List Properties NOTE: The fields in this section display for the File control only. Refer to Enable File Upload/Download for more information. |
|
File Path |
Displays the path name to upload files to and to store files for download NOTE: The files are usually stored in a folder with the same name as the Stewardship Tier WebApp ID (GUID). Use the forward slash / within and at the end of the path. The forward slash at the end of the path denotes a folder. For example, if /NWEmployees is used, it is treated as a file name. /NWEmployees/employee/ is treated as a folder. NOTE: The folder UserArea is created by Stewardship Tier and should always be the first folder name in the path. The English folder is required and must be added by the user. The WebApp ID sets the path to the WebApp. Other folders or sub folders can be used but the English folder is used as the default. |
File Path Type |
Displays the path type. Options are:
|
File Direction |
Displays whether the file can be uploaded only, downloaded only, or both uploaded and downloaded. |
File Data Source Field |
Displays the data source with a Data Source Type of Local File, and used with File Path Type set to Data Source. Path is a required field on a Local Path type Data Source and contains the location where these uploaded files will be placed. |
NOTE: The fields in this section display for the Numeric control only. |
|
Numeric Scale |
Displays the number of decimal places to display after the decimal separator. |
Display Thousands Separator |
If enabled, a number uses the current user’s locale to display a number such as 4213.22 as 4,213.22 given that English – United States is selected in the Currency Locale ID List Box. |
Currency Locale ID |
Displays the locale used for formatting currency. |
Total |
If enabled, a totals column recalculates when records are added, deleted, or modified. |
Advanced Properties
Field |
Description |
Header Image ID |
Displays the image to appear in the header row for this column. This field displays for these controls:
|
Header Image |
Displays a depiction of header image chosen. This field displays for these controls:
|
Dynamic Image |
If enabled, the Image specified displays in the contents of the query. Using the power of the conditional "IF" statement in the query, the image may vary according to value of data for each row. If not enabled, the image specified does not display. This field displays for these controls:
|
Hover View |
Displays the name of the view created in SQL that populates the hover view for the column. This value can be set at the page level as well. The Hover View can be populated with additional technical information about the selected record. This field displays for these controls:
|
Dynamic Link Type |
Displays the dynamic link method the control uses when the image is clicked. Options are:
This field displays for these controls:
|
Dynamic Link Column |
Displays the column in view to use as dynamic link criteria. Dynamic Links may be used to navigate to WebApp pages outside of the current WebApp. This field displays for these controls:
|
Link To Page ID |
Displays the Stewardship Tier page name navigated to when page link is executed. Value list only contains pages in the current WebApp. Dynamic Links may be used to navigate to WebApp pages outside of the current WebApp. This field displays for these controls:
|
Link to Method |
Displays whether the page that is accessed from the control overlays the existing page or opens in a separate page. This field displays for these controls:
|
Runtime Data Source ID |
Displays the field name that contains a GUID that corresponds to the Data Source to join against for the view/table specified in the List Table column. The Stewardship Tier looks for that field's value in the following order.
This field displays for these controls:
|
Key |
If enabled, the selected column name is a primary key. The Stewardship Tier only passes Primary Keys when linking to other pages. If the page data source is a view, a control must be added indicating the Key. If disabled, the selected column name is not a primary key. This field displays for these controls:
|
Allow Space |
If enabled, a required column is allowed to have space(s) as a valid entry. If disabled, a required column is not allowed to have space(s) as a valid entry. This field displays for these controls:
|
Require Signature |
If enabled, a panel appears requiring the current session UserID and Password to save changes. Applies to both record Insert and Update. The panel will not appear if logged in as an Anonymous user. Requires auditing to be enabled for the underlying page table and column. If not enabled, changes are automatically saved without the UserID and Password of the current user. Refer to Enable Audit Trail and Electronic Signature for more information. This field displays for these controls:
|
Wrap |
If enabled, the text associated with the label for the check box wraps. This field displays for the Check Box control only. |
Show In Navigation |
If checked, this column displays in the failed records Bulk Execution results. By default, only the first column on the page displays in these results.
Refer to View Bulk Execution Results for more information. |
Translate |
If enabled, the cell values are translated. Translations are dependent on catalog entries for the selected session Language. Refer to Manage Catalogs for more information. If disabled, the cell values are not translated. This field displays for these controls:
|
NOTE: The fields in this section display for the Text Area control type only. |
|
Binding Field Names |
Displays a comma-separated list of columns used to filter data on a linked page. By default, when linking form one page to another, the Stewardship Tier sends the key fields to the linked page. However, it the key fields are different between linked pages or additional fields are required, use this field to indicate the columns. For instance, a user clicks a button on a page listing country records to access a page listing the selected country’s regions. If both pages do not have the country field with the same name, the field on the linked page must be added here to include as part of the binding criteria. Otherwise, the region page displays regions for all countries. |
Shared Field Names |
Displays a comma-separated list of columns used to send data to a linked page. Shared Fields tell the Stewardship Tier to send the data from a column that is not normally passed and allow it to be used on a subsequent page. For example, to filter a Region list box on a page by the Country field that was entered on a previous page, add the Country field as a shared field on the link between pages. It is then available for use in the list box Where Clause on the Region page. If you were to include Country as a Shared Field and not a Binding Field, you would see regions for all countries after clicking the link, but any list boxes with a Country filter would only show regions filtered by the country shared from the previous page. |
NOTE: The fields in this section display for the Toolbar control type only. |
|
Consider Valid |
If enabled, the boaStatus column is used to determine whether the toolbar button is active or dimmed. Refer to Use boaStatus to Set a Toolbar Button’s Control Status for more information. |
Allow Multi Row Action |
If enabled, a user can select multiple records on the Horizontal View and click the toolbar button to perform the action related to the toolbar button on multiple records at once. |
NOTE: The fields in this section display for the Image control type only. |
|
Report Follows Link |
If enabled, generates a report for the current Dynamic page for the Horizontal or Vertical Views. Refer to Include all Page Details in Reports for more information. |
Link to Report |
If enabled, when a user clicks the image, the page to access opens in a read-only format. By default, page links render data using the normal Horizontal or Vertical View with add/edit/delete capability. Link to Report provides a mechanism to report data as read-only without having to modify defaulted page properties. Refer to Link to a Report from a Page for more information. |
Advanced List Properties NOTE: The fields in this section display for List Box and Combo Box controls only. |
|
List Where Clause |
Displays the Where Clause used to restrict the values that display in a List Box or Combo Box. Refer to Set a Dynamic List Box and Enable List Where Clause for more information. |
List Order By |
Displays the column that sets the sort for values in the List Box or Combo Box. By default, like pages, List Boxes are sorted based on the primary key. Use List Order By to sort select options in a List Box based on another field. NOTE: When a field name is entered in List 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, ProductName desc. Separate entries by a comma. |
List Unique |
if enabled, displays List Box or Combo Box values not previously selected in another record on the page. If the record has already been added, the List Unique property removes it from the List Box, leaving only the records that have not been selected. |
List Filter |
If enabled, the Filter icon displays next to the Combo Box, indicating a filter is enabled. The Combo Box Filters are designed to reduce the number of items displayed in the value field or the descriptive field. NOTE: This field displays for the Combo Box control only. |
List Allow Insert |
Displays an option that sets the behavior of the List Box or Combo Box when the value stored in the field is known. As the user types in the List Box, matching values display. Options for List Allow Insert are:
NOTE: The current user must have security to add new records to the page associated with the list. |
List Allow Insert Page ID |
Displays the name of the page that displays when a user clicks a link that displays below the List Box that allows them to add a new record. Used in conjunction with List Allow Insert. This feature permits additional values not available in the list to be added to the associated list. If both are enabled, clicking the link opens a window containing the page associated with the list. Enter the new options in the fields and the value is available in the List Box when adding new records. |
List Selection Field |
Displays the name of the field that contains descriptive text that displays in a List Box or a Combo Box when in add or edit mode. Refer to Add a List Selection Field for more information. |
List Control View |
Displays the name of the view used to select columns from the table to restrict the number of values in the List Box or Combo Box. |
Widget Scripting NOTE: This section displays if the user sets the ShowBetaOptions equal to 1 in the CranSoft database in the Param table. Refer to Add Validate and PreFinish Events to Content WebApp Pages for more information about using these fields. |
|
Widget Function |
Displays the name of the Widget Function to call. This field should contain validationdialogcaller if a user has added a Validate or PreFinish event to a Content WebApp page. |
Pass to Widget Function |
If checked, the user has added a Validate or PreFinish event to a Content WebApp page. |
Widget Function Key |
Displays the Widget Function Key, copied from the CranSoft database, in the PageColumn table. In the current delivered product only the Master Data Management Validate and PreFinish buttons have this value. |
Excel
NOTE: This tab displays if Excel Integration is enabled. Refer to Enable Excel Integration for more information
It displays for these control types:
- Text Box
- Check Box
- Text Area
- List Box,
- Numeric
- Combo Box
- DateTime
- HTML Area
Field |
Description |
Excel Foreground Color |
Displays the foreground color to use on Excel template header rows. |
Excel Background Color |
Displays the background color to use on Excel template header rows. |
Deprecated Properties
NOTE: This tab does not display for the Toolbar control.
Field |
Description |
Wrap |
If enabled, the text associated with the label for the check box wraps. This field displays for the control types:
|
Control Function |
This field is not used. |
Enable/Disable Control
Use this tab to Set Column Control Status.
NOTE: This tab does not display for the Toolbar control.
Field |
Description |
Consider Valid |
If checked, the boaStatus column is used to determine whether the control is enabled or disabled. If unchecked, and the Control Status Field on the Enable/Disable tab displays another column in the view, this column’s value (NULL/0, 1, or 2) determines the Control Status of this column for a given row. If unchecked and the Control Status Field is blank, the control status field is not set using either of these methods. Control Status can also be set as a column property. Refer to Set Column Control Status for more information. |
Control Status Field |
Displays the name of the column in the view whose value (NULL/0, 1, or 2) determines the Control Status of this column for a given row. Refer to Set Column Control Status for more information. |
Spanning Properties
Use this tab to Set Spanning Properties.
Field |
Description |
Column Span |
Displays the number of display columns that this column extends through. For example, if the Column Span is 2, the selected column displays its contents over two columns instead of one. |
Row Span |
Displays the number of display rows that this column extends through. |
Line Break |
If enabled, a new display row is created after the selected column. If disabled, a new display row is not created after the selected column and subsequent controls stay on the current row. |
Relational
NOTE: This tab does not display for a Check Box, File, or Toolbar control.
Use this tab to:
Field |
Description |
Watermark View |
Displays the view that defines what text should appear for each record when the field is empty as an informational watermark. This field displays for the controls:
|
Watermark Binding Field Names |
Displays the fields to bind page data against watermark view with. This field displays for the controls:
|
Translate Watermark |
If enabled, the watermark value is run through system translation. If disabled, the watermark value is not translated. This field displays for the controls:
|
Data Tooltip View |
Displays the name of the view that contains the tooltip. Before creating a tooltip, the user mist write a view with the suffix Dtv for each column that requires a tooltip and alias the column as boatooltip in the view. This field displays for the controls:
|
Data Tooltip Binding Field Names |
Displays the comma-delimited list of field names to bind against to return tooltip data. For instance, if you wanted the page to display a different tooltip depending on data from a previously populated field, you could use that field here as a binding column allowing it to select the proper data to display. This field displays for the controls:
|
Translate Tooltip |
If enabled, the tooltip value is run through system translation. If disabled, the watermark value is not translated. This field displays for the controls:
|