Properties of a Tile control

The Tile control displays the total returned from a query in a compact way to display this information on a dashboard.

The Tile control is available for Desktop, Phone and Tablet forms.

Use the following tabs to configure the properties of a Tile control.

General

Name Description

Type

The type of the control.

Name

A unique name for the tile. (Default: Tile1)

Security token

Makes the information in the form secure. See Security tokens.

Visible

Makes the control visible at runtime. (Default: Selected)

Session ID

Global or form variable or form control that is used as the session ID.

Data source

Optional. The Query (Work queue query, Job query, System query) or .Net action that is used by the tile control at runtime. (Default: Query)

You can configure a Tile control to show the result for a .Net method so that you can use the tile to show information other than the count returned from a query. For example, show the number of logged-on users, or the number of notes for a job.

  • If you do not configure a query and load the form at runtime, the control appears but the number is not displayed.

  • If you set the query dynamically, the control appears at runtime and the query is applied when the action executes and displays the total returned from the query result in the tile.

  • If you set a .Net query, every time the refresh interval is reached, the .NET action is executed again, which in turn updates the value on the tile at runtime.

  • If the .NET action is configured as a multi-lingual action, the correct action based on the current language is executed.

Aggregate

Lets you perform aggregate operations on a selected query and display the counts of the completed activities, completed jobs, or live activities on a tile.

To perform an aggregate operation, do the following:

  1. On the Query list, select a query type and then select a query.

    The query types are:

    • System query

    • Job queue query

    • Work queue query

  2. On the Aggregate list, select an aggregation function.

    The aggregation functions are:

    • Count (default)
    • Min
    • Max
    • Average
    • Sum

    By default, Count is selected and displays the total number of items of a query.

  3. On the Aggregate field list, select a field.

    The aggregate fields are:

    • Time pending: Returns the time pending across all activities in the format HH:MM. For example, 07:45
    • Time spent: Returns the time spent across all activities in the format HH:MM.
    • Documents: Returns the count of the documents involved in the activities.
    • Pages: Returns the count of the pages involved in the activities.
    • Any numeric work type fields that are configured in the system query.

For example, when you select a system query as the query, max as the aggregation function, and documents as the aggregate field, at runtime, the query will display the highest document count among the activities. That is, if there are three activities with 11,15, and 21 documents respectively, the tile will display 21 at runtime.

Title

The title of the Tile control to display at runtime. (Optional)

Item description

The description of the Tile control to display at runtime.

Image

The image to display on the tile at runtime. Select an image from the store such as home.png. (Optional)

Image width

The width of the image on the tile. (Default: 40%)

Default color

The default color used for the tile. (Default: Blue)

You can configure the text color on the tile to automatically adjust to black or white depending on the contrast ratio so that you can use any color for the background of your tile and the text on the tile will always be visible. The font size on the Tile control cannot be changed and the font family is taken from the theme applied.

When you add a Tile control to a form at design time and select a background color, the text color on the tile appears as follows at both design time and runtime:

  • The text color is black if the contrast ratio between white and the selected background color is < 4.5.
  • The text color is white if the contrast ratio between black and the selected background color is > 4.5.

When conditional background colors are configured, the font color is automatically adjusted.

Apply gradient

If selected, the Fade to color option appears. You can select the required fade to color to appear on the tile at runtime.

Conditional color

Allows the user to define multiple rules to apply to change the color based on the query result. For example:

  • Count greater than 10 = Green

  • Count greater than 40 = Amber

  • Count greater than 70 = Red

To add a conditional color rule for the tile control:

  1. Click .

  2. On the Count greater than list, select a value.

  3. On the Color list, select a color, and click Apply.

  4. On the Fade to color list, scroll the bar to select the fade to color, and click Apply.

    The "Fade to color" option is only available if you select the "Apply gradient" option.

  5. Click Add.

    If a conditional color rule is not applicable, the default color is applied.

Use custom font color

If selected, the Custom font color option appears. You can select the font color to display on the tile at runtime.

Refresh interval

The interval at which the Tile control on a form should be refreshed automatically. (Default: 0 Seconds). When you view a form with the Tile control at runtime, the tile is refreshed at the given interval. If the interval is 0, then the tile is not refreshed.

When you import a form or upgrade TotalAgility from an earlier version, any forms with Tile control with value in minutes will be displayed as the equivalent value in seconds.

  • When you add a Clicked event to a Tile control, a hand cursor appears when you hover on the tile so that when you click the Tile, the Clicked event is fired, and the configured actions are executed. For example, when you configure a Redirect action, you are redirected to a form that has a Job, Work queue, or Workload control with the query details and the count on the tile. If there is no Clicked event configured, then the cursor remains as the standard pointer arrow.

  • You must use the Update control properties action to set the DynamicQueryName, DynamicQueryID, DynamicFilterField, DynamicFilterValue or DynamicQueryType properties.

  • When you add a form with the Tile control to a package with associations, the queries used by the control are added to the package.