Multipart

Show allHide all

Displays multiple menu items as a single page.

Each displayed menu item, a.k.a. part is defined by a link of type 'Multipart'. The same link may be used multiple times and may utlilize data supplied from the SQL as passing fields.

Parts are layouted in a table like manner. Each part occupies a number of cells in the layout table. The height of rows and widths of columns in the table can be specified or computed automatically.

SQL

SQL Call: Retrieve parts to display (mandatory)

Retrieves a list of parts to display along with meta data describing column and row dimensions.

When rows or column dimensions are not fully specified the component will try to utilize the entire browser window to display the parts. If this is not possible due to the minimum dimensions specified occupy more space than available scrollbars will appear in the browser window.

If the contents of a part occupy more space than specified scrollbars will appear around the contents of the part. No scrollbars will appear around the header of a part, so make sure the minimum width specified is enough to display the entire header for a part.

May modify database: No

Resultset: Column specifications (optional)

Specifies the widths of columns in the component. This result set is optional and columns may be used without being defined here. Columns not defined in this result set will be given the minimum width required to display all parts occupying the column without scrollbars.
Table count: repeated zero or one time
Row count: zero or more rows

Columns

Col mandatory int
Column number (First column is column one)
Width mandatory string
Specifies the width of the row.
Possible value Description
<min>- The column will receive a final width no less than <min>.
<min>-<max> The column is guaranteed to receive a final width somewhere between the <min> and <max> specification.
<width> The width in pixels
null or empty The width of the column will be the minimum required to display the contents of all parts occupying the column without scrollbars.

Resultset: Row specifications (optional)

Specifies the heights of rows in the component. This result set is optional and rows may be used without being defined here. Rows not defined in this result set will be given the minimum height required to display all parts occupying the row without scrollbars.
Table count: repeated zero or one time
Row count: zero or more rows

Columns

Height mandatory string
Specifies the height of the row
Possible value Description
<height> The height in pixels
<min>- The row will receive a final height no less than <min>.
<min>-<max> The row is guaranteed to receive a final height somewhere between the <min> and <max> specification.
null or empty The height of the row will be the minimum required to display the contents of all parts occupying the row without scrollbars.
Row mandatory int
Row number

Resultset: Part specification

Specifies the parts to display in the component.
Table count: repeated one or more times
Row count: zero or more rows

Columns

LinkAlias optional string
Alias of the link to display. The link must have the multipart menu item as its from menu item and be of type 'Multipart'.

You may also use this column to specify a tag that begins with 'aliaspart_'. When you do this you can select the link to display from the UI.
LinkID optional any
Deprecated. Use LinkAlias instead.

ID of the link to display. The link must have the multipart menu item as its from menu item and be of type 'Multipart'.

You may also use this column to specify a tag that begins with 'part_'. When you do this you can select the link to display from the UI.
HasHeading optional bit
Specifies whether to display the heading for the menu item in the part
Title optional string
Replaces the menu item title in the part's header.
TitlePhraseID optional int
Language phrase that replaces the menu item title in the part's header.
IconID optional int
Replaces the menu item icon in the part's header.
Col mandatory int
Column number to begin display the part
ColSpan optional int
Number of columnsto display the part in
Row mandatory int
Row number to begin display the part
RowSpan optional int
Number of rows to display the part in
SmallScreenSortOrder optional int
The order in which the parts will be displayed on small screens.
Default: If omitted, parts are ordered first by column and then by row.
<xxx> optional string
All other columns can be referred to as column values in the passing fields of the link specified.

SQL Call: Validate parameters

Allows you to validate the parameters supplied by the user before any other SQL is run in the component. This call is only made if the component has visible parameters, the SQL is a stored procedure, and 'Validate parameters' is checked.

May modify database: No

Parameters

@Force bit
Set to 1 if the last call to validate parameters used admin_force and the user clicked OK in the OK/Cancel dialog.
@ValidateParams bit
Set to 1 when this call is made.

InfoSQL

SQL Call: InfoSQL

SQL that can have several resultsets that are displayed at top of component.

May modify database: No

Parameters

@IsParameterPage bit
Will be set to 1 when the call is made for the parameter page.

Resultset: Main title

Specifies the main title.
Table count: repeated exactly once
Row count: exactly one row

Columns

maintitle optional string
The main title.

Resultset: Box (optional)

Defines one or more boxes to display.
Table count: repeated zero or more times
Row count: one or more rows

Columns

Title optional string
The title of the box.
TitleIcon optional string
The name of a system icon to display next to the box title.
TitleIconId optional int
Deprecated. Use TitleIcon instead.

Displays an icon next to the box title.
TitleIconBadgeId optional int
Deprecated. Avoid using badge icons.

Override menu item badge.
ColumnSpan optional int
Specifies the column span for the box. If this is above one the box will be displayed on a separate row.
BoxLink optional string
Displays the link with the specified alias in the title row of the box.

Columns named PassingField_<xxx> will not be shown in the box and can be referenced from the link as a Column value with name <xxx>.

Only one BoxLink per box can be used.
LinkId optional int
Deprecated. Use TopLink/BoxLink instead.

Displays the specified link among the top links and in the title row of the box. The link will only appear in the title row if no ordinary columns lie before it in the resultset.

Columns named PassingField_<xxx> will not be shown in the box and can be referenced from the link as a Column value with name <xxx>.

Only one of TopLink, LinkId, MenuItem and MenuItemId can be used at the same time.

Multiple LinkId columns may appear in a single resultset.
TopLink optional string
Displays the link with the specified alias among the top links.

Multiple TopLink columns may appear in a single resultset.
IsPrimaryTopLink optional bit
Used in conjunction with "TopLink" to mark it as a primary link. Only one link may be marked as primary.
MenuItem optional string
Recommended to use TopLink/BoxLink instead for better tracking of links.

Displays a link to the menu item with this alias among the top links and in the title row of the box. The link will only appear in the title row if no ordinary columns lie before it in the resultset.

Only one of TopLink, LinkId, MenuItem and MenuItemId can be used at the same time.

Multiple MenuItem columns may appear in a single resultset.
MenuItemId optional int
Deprecated. Use TopLink/BoxLink instead.

Displays a link to the menu item with this id among the top links and in the title row of the box. The link will only appear in the title row if no ordinary columns lie before it in the resultset.

Only one of TopLink, LinkId, MenuItem and MenuItemId can be used at the same time.

Multiple MenuItemId columns may appear in a single resultset.
NavigatorLinkText optional string
Deprecated. Use TopLink with a link label instead.

Used in combination with menuitem/menuitemid to give the navigator link a text that differs from the name of the menu item.
PassingFields optional string
Additional information to menuitem/menuitemid, appends values to querystring (supports simple Softadmin® parameters).

If multiple passingfield columns exists, only the first one is used and the others are disregarded.
<colname> optional string
Value displayed in the box with heading defined by field information or column name.
<colname>_Color optional string
Sets the text color of <colname> to the specified color using #RRGGBB color code or HTML color name. If using color names then you must use American spellling (for example gray, not grey).
<colname>_Icon optional string
The name of the system icon to show before the <colname> value.

Use the menu item "Admin>Theme>System icons" to register system icons.
<colname>_IconColor optional string
Color in #RRGGBB format to use for the icon specified in <colname>_Icon.
<colname>_CellLink optional string
Displays the link with the specified alias as a cell link for the <colname> cell.

PassingField_<xxx> columns can be referenced from the link.

Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
<colname>_LinkId optional int
Deprecated. Use <colname>_CellLink instead.

Creates a cell link with the specified link id for the <colname> cell.

PassingField_<xxx> columns can be referenced from the link.

Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
<colname>_MenuItem optional string
Recommended to use <colname>_CellLink instead for better tracking of links.

Supplies a link to the menu item with the specified alias when used in conjunction with <colname>.

Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
<colname>_MenuItemId optional int
Deprecated. Use <colname>_CellLink or <colname>_MenuItem instead.

Supplies a link to the menu item with the specified menuitemid when used in conjunction with <colname>.

Only one of <colname>_CellLink, <colname>_LinkId, <colname>_MenuItem or <colname>_MenuItemId can be used at the same time.
<colname>_PassingFields optional string
Supplies the querystring when used in conjunction with <colname>_MenuItemId.
<colname>_Style optional string
Sets the CSS style for <colname>. Never use a string from a user as part of this column for security reasons.
<colname>_Tooltip optional string
Sets the tooltip for <colname>.
PlaintextFull, PlaintextLeft, PlaintextRight optional string
These columns are deprecated. Use either PlainText, Html or SafeHtml instead, depending on what behavior you need.

The content of this column will be treated as Html, but line breaks and non-breaking spaces will be converted to br-tags. In future versions this column will be escaped.
PlainText optional string
Displays plain text without a column title, i.e. occupies the entire vertical space available in the box. Any HTML in the text will be escaped.
Html optional string
Displays HTML without a column title, i.e. occupies the entire vertical space available in the box. Uses the Layouted HTML level to determine allowed elements and attributes.

If the Html column is too restrictive for your needs then use the SafeHtml column instead.
SafeHtml optional string
Displays HTML without a column title, i.e. occupies the entire vertical space available in the box. Uses the Safe HTML level to determine allowed elements and attributes.

The SafeHtml column is less restrictive than the Html column. Use it only when you need it.
WarningSuccess optional string
The text will be at the top of the menu item and displayed in green.
WarningInfo optional string
The text will be at the top of the menu item and displayed in blue.
Warning optional string
The text will be at the top of the menu item and displayed in yellow. This will match any column prefixed with Warning that is not WarningSuccess, WarningInfo, and WarningError.
WarningError optional string
The text will be at the top of the menu item and displayed in red.
WarningLink optional string
Displays the link with the specified alias inside the warning.

Columns named PassingField_<xxx> will not be shown in the box and can be referenced from the link as a Column value with name <xxx>.

Requires that the row only contains one warning.
StartExpanded optional bit
Whether the infobox should start expanded or collapsed. NULL/Omitted means default behavior, where all boxes are expanded on big screens, and only the first box is expanded on small screens.
ExternalEmbedHeight optional int
Used together with the ExternalEmbedUrl column to set the height (in pixels) of the generated frame.
ExternalEmbedUrl optional string
Embeds content from an external server as an iframe in the infobox. The URL must be an absolute URL.
PassingField_<xxx> optional string
Not shown in InfoSQL. The corresponding link should be of link type "Top link (InfoSQL)", "InfoSQL cell link" or "InfoSQL warning link", and one of its passing fields should have a value matching <xxx>, and be of type "Column value".
QrCode optional string
A QR Code will be rendered containing the text in the column.

To generate Swiss QR Code for digital payments, return an XML with the root attribute Type="Swiss". See example-XML in the documentation for the RTF Document component.

Resultset: Dynamic field information (optional)

Specify extra properties for fields in the InfoSql.
Table count: repeated zero or more times
Row count: zero or more rows

Columns

AdminFieldName mandatory string
The name of the field to apply the information to. The presence of this column indicates that the resultset specifies field information.
AllowHtml optional bit
Allow HTML.
ButtonJavaScript<xxx> optional string
Inserts a button next to the control that is used to execute the JavaScript supplied here. <xxx> is an arbitrary text that can be empty if only one button is required.
ButtonJavaScript<xxx>_Label optional string
The label for the JavaScript button <xxx>.
CellAlignment optional string
Specifies the alignment of the text in the field.
Possible value Description
Center Center aligned.
Left Left aligned.
Right Right aligned.
ColumnTooltip optional string
Sets the tooltip on the column title. Only supported by the Grid component.
DefaultValue optional string
The default value for the control or if prefixed by 'SQL:' the sql to run to determine the default value.
DefaultValueSql optional string
SQL that evaluates default value for field. Can contain other fields for value dependency.
Description optional string
The description for the field.
EnabledJavaScript optional string
Javascript that controls the enabled status of the field. The control is only enabled if the expression specified here evaluates to true. The expression is evaluated every time the value of a dependent control is changed. This is only available to control types for which the enabled javascript field is visible in the user interface.
FieldGroupId optional int
The field group to use.
FieldInfoId optional int
ID of field information to base the dynamic field on. All properties not explicitly overridden by dynamic field information will be copied from this field. The referenced field must be found in the menu item's field tables.
FieldLabel optional string
If present the field label is used as the heading for fields instead of the field name.
FieldType optional string
The name of the control type to use. It is usually recommended to use FieldInfoId instead unless the column is used to make fields hidden or uneditable.
Possible value Description
boolean checkbox Legacy alias. Use "checkbox" instead.
boolean dropdown
chart
checkbox
colorpicker
date
datetime
dropdown
file
heading
heading with checkbox
hidden
html
info text
listbox
multi-listbox
multi-picker
multirow
password
picture
radio buttons
textarea
textbox
textbox with autosearch
textbox with autosuggest
textbox with dropdown
textbox with popup
time
uneditable text
Height optional int
The height of the control.
IgnoreOnSave optional bit
Do not pass the field value to the insert/update procedure.
InfoSqlLayout optional string
Where the label is shown in relation to the contents in InfoSQL.
Possible value Description
Default Inherit layout from menu item.
LabelAbove Full width, label above.
LabelLeft Label to the left.
NoLabel Full width, no label.
Standard Deprecated. Use LabelLeft instead.
MaxDate optional date
Only applicable to the Date and Datetime controls.
MinDate optional date
Only applicable to the Date and Datetime controls.
NullChoice optional bit
Specifies whether the control allows null values.
NumberOfDecimals optional int
The number of decimals to display for numeric values.
OnChangeJavaScript optional string
Javascript run when the value of the control has changed.
OutputFormat optional string
Special formatting to be applied when the field is displayed.
Possible value Description
Hyperlink
MailToLink
PhoneLink
Placeholder optional string
Text shown when the field is empty.
Sql optional string
The SQL that determines the control's behavior. (Refer to control documentation for more information)
ThousandDelimiter optional string
The thousand grouping delimiter for numeric values.
TimePickerFrom optional string
Only applicable to the Time and Datetime controls.
TimePickerTo optional string
Only applicable to the Time and Datetime controls.
Width optional int
The width of the control.
VisibleJavaScript optional string
JavaScript that controls the visibility of the field. The control is only visible if the expression specified here evaluates to true. The expression is evaluated every time the value of a dependent control is changed.

Resultset: Dynamic top links (optional)

Defines one or more links to be shown among the top links.
Table count: repeated zero or more times
Row count: zero or more rows

Columns

BoxLink optional string
See the "Box" resultset for documentation.
IsPrimaryTopLink optional bit
See the "Box" resultset for documentation.
LinkId optional int
Deprecated, Use TopLink instead.
See the "Box" resultset for documentation.
MenuItem optional string
Deprecated. Use TopLink for better tracking of links.

Displays a link to the menu item with this alias among the top links. The title of the box will also turn into a link when the user hovers the mouse.
MenuItemId optional int
Deprecated. Use MenuItem instead, or better yet, use TopLink for better tracking of links.

Displays a link to the menu item with this id among the top links. The title of the box will also turn into a link when the user hovers the mouse.
NavigatorLinkIconBadgeId optional int
Used in combination with menuitemid or LinkId to give the navigator link an icon that differs from the icon badge of the menu item.
NavigatorLinkIconId optional int
Used in combination with menuitemid or LinkId to give the navigator link an icon that differs from the icon of the menu item. Only one of navigatorlinkiconid and navigatorlinkiconname can have a value.
NavigatorLinkText optional string
Used in combination with menuitemid to give the navigator link a text that differs from the name of the menu item.
PassingField_<xxx> optional string
See the "Box" resultset documentation.
PassingFields optional string
Additional information to 'menuitemid', appends values to querystring (supports simple Softadmin® parameters).
TopLink optional string
See the "Box" resultset for documentation.

Resultset: JavaScripts (optional)

InfoSQL can declare JavaScript used by the menu item.
Table count: repeated zero or more times
Row count: zero or more rows

Columns

JavaScript optional string
A piece of JavaScript to execute as the page loads, or containing one or more function declarations that can be called by other scripts on the page.
LocalJavaScriptUrl optional string
An URL, relative to the system's admin/customization folder, specifying a JavaScript file that should be imported.
ExternalJavaScriptUrl optional string
An URL specifying a JavaScript file on another server that should be imported. Take care to use an URL that is reachable by the end user's web browser.

Resultset: Timeline (optional)

Displays a timeline to visualize the current state of a process.

Each row represents one step in the timeline.
Table count: repeated zero or one time
Row count: one or more rows

Columns

Timeline mandatory any
The value of this column is not used and it's only purpose is to mark this as a timeline table.
StepStatus mandatory string
Specifies how the step will be visualized.
Possible value Description
Current This is the current step.
Done This step has been completed successfully.
Failed Something went wrong in this step.
Future This step is later on in the process.
StepDescription optional string
Description of the step.
StepTitle optional string
Title of the step.
StepTooltip optional string
Tooltip of the step.
StepLink optional string
Alias of the link that the step leads to.
<xxx> optional any
Any other column will be sent as a passing field to the link.

Custom access control and logging

SQL Call: Custom access control and logging

Use this call to restrict which entries a user is allowed to view and edit, and to log which entries a user views.

Access to a menu item is normally controlled through functions and roles alone but some entities need more fine grained control. For example, a user may have access to the View Member menu item for normal members but not for members with a protected identity.

The menu items a user visits are always logged (in ADMINLogMenuItem) but for sensitive data you may need to log exactly what entries are viewed. Do the logging in this call as the common ways of viewing data (grid and InfoSQL) are not allowed to modify the database.

If you bind a scalar function instead of a stored procedure to this call then its name must end with '_GrantAccess'.

May modify database: Yes

Resultset: Access permissions

Return whether the user is allowed to visit the menu item with the current parameters.
Table count: repeated exactly once
Row count: exactly one row

Columns

GrantAccess mandatory bit
1 if the user is allowed to view the menu item, 0 if the user should not be allowed to view the menu item.

If 0 then an error will be logged as the user should not have been able to reach the menu item with the given parameters in the first place.

Querystring parameters

menuitemheading optional
String that replaces the menu item name when the menu item is loaded. It does not replace the name before that (like for example in the navigator). It is ignored if the menu item is displayed as a part in a multipart in which case the name can be set from the multipart procedure.