Component: Planner

 Show all Hide all

Used to assign items to resources and dates using drag and drop.

Component mode: Without time scale

Supported modes: Without time scale

SQL

SQL Call: Filters (mandatory)

This is the first call made by the component. It is followed by the 'Get data' call to finish initialization.

Specifies the filter dropdowns to display and their values, using two result sets per filter.

The selected values will be passed to the 'Get data' call.
The selected values are also available for item links and day/resource links.
Supports custom errors: No
May modify database: No

Parameters:

@Action mandatory string
Set to 'GetFilters' for this call.

Resultset: Filter

Repeat mode: repeated zero or more times
Row count: exactly one row

Columns:

DefaultValue optional string
Default value to use.
If omitted, the first value is used.
Filter optional string
The name of the filter dropdown.

Resultset: Filter values

Values to show in the dropdown from the previous resultset.
Repeat mode: repeated zero or more times
Row count: zero or more rows

Columns:

<column with ordinal 1> mandatory int
Id value for filter. The column name is used as parameter name.
<column with ordinal 2> mandatory string
Text to display.

SQL Call: Get data (mandatory)

Called initially after the 'Get filters' call. Also called after a 'Move' call has requested a reload.

If @Mode is 'Weeks', then a temp table #WeekDates(FromDate, ToDate) is available with one row per week to show.
Supports custom errors: No
May modify database: No

Parameters:

@<filter-name> mandatory string
One parameter for each filter is set to the current value of that filter.
@Action mandatory string
Set to 'GetData' for this call.
@FromDate mandatory date
The first date shown.
@Mode mandatory string
Possible value Description
Days If the view is grouped by days.
Weeks If the view is grouped by weeks.
@ToDate mandatory date
The last date shown.

Resultset: General

General configuration.
Repeat mode: repeated zero or one time
Row count: exactly one row

Columns:

AggregateLabel optional string
The label to show when both the aggregate rows and the aggregate columns are visible.
Defaults to a sum sign.
Title optional string
The title to show in the upper left corner.
UnbookedDayExpanded optional bit
If the area with unbooked items per day should start expanded.
UnbookedDayLabel optional string
The label for the area holding unbooked items per day. The area is only shown if a label has been given.
UnbookedExpanded optional bit
If the area with unbooked items not connected to a date should start expanded.
UnbookedLabel optional string
The label for the area holding unbooked items not connected to a date. The area is only shown if a label has been given.

Resultset: ColumnInfo

Additional information for specific columns.
Repeat mode: repeated zero or one time
Row count: zero or more rows

Columns:

Aggregate optional string
The aggregate value for the specified date. The row with column aggregate values is only shown if at least one column has an aggregate value.
Date mandatory date
The date the information belongs to. Use the value of the FromDate column from #WeekDates when @Mode is 'Weeks'.
ExtraInfo optional string
Extra info for the specified date, shown below the date.
IsHoliday optional bit
Whether the specified date is a holiday.

Resultset: ResourceInfo

The resources to show.
Repeat mode: repeated exactly once
Row count: zero or more rows

Columns:

Aggregate optional string
The aggregate value for the specified resource.

The column with resource aggregate values is only shown if at least one resource has an aggregate value.
ExtraInfo optional string
Extra info for the specified resource.
Resource mandatory string
The name of the resource.
ResourceId mandatory string
The ID of the resource.

Resultset: Items

The items to show. The component supports at most 2000 items, but that amount of items is difficult to manage. Try adding additional filters if you have many items.
Repeat mode: repeated exactly once
Row count: zero or more rows

Columns:

BackgroundColor optional string
The background color for the item.
CanDrag optional bit
Determines if the item can be dragged.
Days optional int
The number of days the item spans.
Description optional string
Item description shown below the title.
ItemId mandatory string
The Item ID. Used by the 'Move' call after the user has dropped the item.
ResourceId optional string
The ID of the resource that this item belongs to, if any.
StartDate optional date
The start date of the item, if any. Note that items with a start date before @DateFrom should be included in this result set if they end on or after @DateFrom.
Title mandatory string
The title of the item.
ToolTip optional string
The tooltip of the item.

SQL Call: Move (mandatory)

Called after an item has been moved using drag and drop.
Supports custom errors: No
May modify database: Yes

Parameters:

@<filter-name> mandatory string
One parameter for each filter is set to the current value of that filter.
@Action mandatory string
Set to 'Move' for this call.
@Date mandatory date
The date that the item was moved to. Not set if the item does not belong to a date.
@FromDate mandatory date
The first date shown.
@ItemId mandatory string
The ID of the item that was moved.
@Mode mandatory string
If @Mode is 'Weeks', then a temp table #WeekDates(FromDate, ToDate) is available with one row per week to show.
Possible value Description
Days If the view is grouped by days.
Weeks If the view is grouped by weeks.
@ResourceId mandatory string
The ID of the resource that the item was moved to. Null if the item was moved to an unbooked spot.
@ToDate mandatory date
The last date shown.

Resultset: Reload

Can be used when partial updates are not sufficient.

Can not be combined with any other result sets.
Repeat mode: repeated zero or one time
Row count: exactly one row

Columns:

Reload mandatory bit
Set to 1 to trigger a 'Get data' call.

Resultset: Columns to update

Repeat mode: repeated zero or one time
Row count: zero or more rows

Columns:

Aggregate optional string
The new aggregate value for the specified date.
Date mandatory date
The date to update. Use the value of the FromDate column from #WeekDates when @Mode is 'Weeks'.

Resultset: Resources to update

Repeat mode: repeated zero or one time
Row count: zero or more rows

Columns:

Aggregate optional string
The new aggregate value for the specified resource.
ResourceId mandatory string
The ID of the resource to update.

Resultset: Items to update

Repeat mode: repeated zero or one time
Row count: zero or more rows

Columns:

BackgroundColor optional string
The new background color for the item.
Description optional string
The description for the item.
ItemId mandatory string
The ID of the item to update.
Title optional string
The new title for the item.
ToolTip optional string
The tool tip for the item.

Resultset: Messages

Can not be combined with any other result sets.
Repeat mode: repeated zero or one time
Row count: exactly one row

Columns:

admin_force optional string
Message to show.
admin_message optional string
Message to show (preventing the move).

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.
Supports custom errors: No
May modify database: No

Parameters:

@force optional bit
@validateparams mandatory bit
This parameter is set to 1 by Softadmin® when this call is made.

Info SQL

SQL Call: InfoSql (2008)

SQL that can have several resultsets that are displayed at top of component.
Supports custom errors: No
May modify database: No

Resultset: Main title

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

Columns:

maintitle optional string
The main title.

Resultset: Box

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

Columns:

Title optional string
The title of the box.
TitleIconId optional int
Displays an icon next to the box title.
TitleIconBadgeId optional int
Override menuitem 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.
LinkId optional int
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>.

LinkId and MenuItemId can not be used at the same time.

Multiple LinkId columns may appear in a single resultset.
MenuItemId optional int
Recomended to use LinkId instead for better tracking of links.

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.

LinkId and MenuItemId can not be used at the same time.

Multiple MenuItemId columns may appear in a single resultset.
NavigatorLinkText optional string
Used in combination with menuitemid to give the navigator link a text that differs from the name of the menu item.

If explicitly set to NULL the link will not be shown in the navigator but may still appear as a link in the title of a box.
PassingFields optional string
Additional information to 'menuitemid', appends values to querystring (supports simple Softadmin® parameters).

Multiple passingfield columns may appear in a single resultset. Passingfields will normally be connected with the closest preceeding menuitemid column, but see the note below regarding the title link.

NOTE: The first passingfield column will be used for the title link regardless of whether there is another menuitemid column in between.
<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>_LinkId optional int
Creates a cell link with the specified link id for the <colname> cell.

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

<colname>_LinkId and <colname>_MenuItemId can not be used at the same time.
<colname>_MenuItemId optional int
Supplies a link to the menu item with the specified menuitemid when used in conjunction with <colname>.
<colname>_PassingFields optional string
Supplies the querystring when used in conjunction with <colname>_MenuItemId.
<colname>_Style optional string
Sets the CSS style for <colname>.
<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.
WarningInfo optional string
The text will be at the top of the menuitem and displayed in blue.
Warning optional string
The text will be at the top of the menuitem and displayed in yellow.
WarningError optional string
The text will be at the top of the menuitem and displayed in red.
Javascript optional string
The column is hidden from the user and treated as a javascript to be included in the HTML.
StartExpanded optional bit
Whether the infobox should start expanded or collapsed. NULL/Ommited means default behavior, all expanded on big screens, only first expanded on small screens.
PassingField_<xxx> optional string
Can be used by links referenced by <colname>_LinkId or LinkId columns. Not shown in InfoSQL.
QrCode optional string
A QR Code will be rendered containing the text in the column.

Resultset: Dynamic field information

Specify extra properties for fields in the InfoSql.
Repeat mode:
Row count:

Columns:

<xxx> optional string
Set property <xxx> for the field specified in adminfieldname. If set to null the value will not be applied.
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.
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.
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.
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
LabelAbove Full width, label above.
NoLabel Full width, no label.
Standard Label to the left.
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.
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

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

Columns:

LinkId optional int
See the "Box" resultset documentation.
MenuItemId mandatory int
Recomended to use LinkId instead 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).

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'.
Supports custom errors: No
May modify database: Yes

Resultset: Access permissions

Return whether the user is allowed to visit the menu item with the current parameters.
Repeat mode: 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.

URL

Querystring parameters

DisplayMode optional
The default value for the 'View' dropdown.
Possible value Description
Month
Month-Weeks
Quarter-Weeks
Week
WorkWeek
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.
StartDate optional
Start date. Will be adjusted to the first day of the week or month, depending on the 'View' dropdown.

Examples

Simple planner

A simple planner where tasks start in the Unbooked area and can be dragged to users.

CREATE TABLE Example.Task
(
	TaskId           int identity primary key,
	TaskName         varchar(100) NOT NULL,
	DaysRequired     int NOT NULL,
	UserIdAssignedTo int NULL,
	StartDate        date NULL,
	EndDate          AS DATEADD(day, DaysRequired - 1, StartDate)
);

GO

INSERT Example.Task ( TaskName, DaysRequired )
VALUES
('ThreeDays', 3),
('OneDay', 1),
('TwoWeeks', 14);

GO

CREATE OR ALTER PROCEDURE Example.Task_Planner
	@Action     varchar(50) = NULL,
	@Mode       varchar(50) = NULL,
	@FromDate   date        = NULL,
	@ToDate     date        = NULL,
	@ItemId     int         = NULL,
	@Date       date        = NULL,
	@ResourceId int         = NULL
AS
BEGIN
	IF @Action = 'GetData'
	BEGIN
		-- General.
		SELECT
			'Unplanned' AS UnbookedLabel,
			1           AS UnbookedExpanded;

		-- Resources.
		SELECT
			U.UserId   AS ResourceId,
			U.Username AS Resource
		FROM
			SoftadminApi.[User] U
		WHERE
			U.IsEnabled = 1;

		-- Items.
		SELECT
			T.TaskId           AS ItemId,
			T.TaskName         AS Title,
			T.StartDate        AS StartDate,
			T.DaysRequired     AS Days,
			T.UserIdAssignedTo AS ResourceId
		FROM
			Example.Task T
		WHERE
			T.StartDate IS NULL
			OR
			(
				T.StartDate <= @ToDate AND
				T.EndDate >= @FromDate
			);

		RETURN;
	END;

	IF @Action = 'Move'
	BEGIN
		UPDATE Example.Task SET
			UserIdAssignedTo = @ResourceId,
			StartDate        = @Date
		WHERE
			TaskId = @ItemId;

		RETURN;
	END;

	RETURN;
END;