i4connected Knowledgebase 5.6

Areas management

Abstract

The i4connected Areas are the structural units which compose a Site, representing physical locations and can establish complex hierarchies.

This article describes the Areas Management functionality from the Admin section of the i4connected portal.

The i4connected Areas are the structural units which compose a Site. Like the Sites, the Areas represent physical locations (such as the ground floor, building A or medical bay) and can establish complex hierarchies within a Site. An Area can have more sub-Areas, which can have other sub-Areas. The list of Areas can be accessed through the dedicated tile,but the most logical method to manage Areas, is directly in context of a Site.

Just like Sites, the list of Areas will only be visible for users having at least the View Sites and Areas permission enabled. Additionally, only the Areas to which the currently logged in user is assigned will be visible in the list.

List_of_Areas.jpg

The Areas panel

The Areas panel represents the Areas as cards in a scrollable list. Each Area card provides information upon the Area name and the amount of Sub-Areas. In this view the user can either select a specific Area in detailed view mode Area_details.jpg or open the list of Sub-Areas assigned to it Area_children.jpg.

Further on, this panel provides a filtering mechanism that helps the user to pinpoint the desired Areas, by searching for the entity name.

Area_filter.jpg

Example of Area filtered list

The Refresh toolbar button from the top menu provides a manual way to reload/update this Area list.

Refresh_areas.jpg

The Refresh button

Further on, system administrators having the Manage configuration permission enabled can manage Custom field definitions by clicking the Metadata toolbar button.

CFD_button_Areas.jpg

The Metadata button

Tip

For more details about the Custom field definitions panel, please visit the dedicated article here.

The Areas panel allows the user with possibility to open an Area in detailed view mode, by clicking on a listed item.

Area_details.jpg

The Area detailed view mode

Using the Extra information meta toolbar button, the Area detailed view mode panel is expanded to display all the predefined metadata.

ExtraInformation_area.jpg

The Extra information area lists all the Area specific Custom field definitions, in view mode only. However, there are some metadata that allows the user interaction, as follows:

  • when clicking the linkable field of the metadata of type Url, the URL address in opened in a new tab of the used browser.

  • when clicking the linkable field of the metadata of type Email, the default email application is opened, having the user's email address prefilled, in the "To" field.

    email_is_prefiled.jpg

Further on, the detailed view mode of an Area displays the following management tiles that can be either shown or hidden, on basis of the currently logged in user's permissions:

Area_management_tiles.jpg

The Area's management tiles

  • Manage Area's Users - The Users tile will be visible for all users having at least the View Sites and Areas and View users permissions enabled.

    The Users tile displays the amount of users assigned to the current Area. Users can be assigned to an Area by means of direct assignment or by inheritance. By clicking on the Users tile, the Site role assignments panel is opened, where further changes at level of Site's users and their permissions can be processed.

    Tip

    For more details about the Sites role assignments panel please also visit the article here.

  • Manage Area's Devices - the Devices tile will be visible for all users having at least the View Sites and Areas and View devices permissions enabled.

    The Devices tile displays the total amount of Devices assigned to the current Area. By clicking the Devices tile, the Device List panel is opened.

    Tip

    For more details about Device List panel please also visit the article here.

  • Manage Area's Measure aggregations - the Measure aggregations tile will be visible for all users having at least the View Sites and Areas and Manage configurations permissions enabled.

    The Measure aggregations tile displays the total amount of Measure aggregations used by the current site. By clicking the Measure aggregations tile, the panel with the same name is opened.

    Tip

    For more details about Measure aggregations panel please also visit the article here.

Besides the general Area's information and the management tiles, the Area details panel may also display an associated i4designer Application.

Area_App_in_detailed_view_mode.jpg

Example of Area's application

Tip

For more details about the i4designer Application mapping feature please also refer to the dedicated articles here.

Additionally, to learn how to manage a Site's Application mappings please also visit this article.

Users having higher permissions enabled (Manage Sites and Areas permission ) are allowed to perform advanced operations such as editing, deleting and adding Areas.

Manage_areas.jpg

The Areas panel

Adding a new Area

The Add toolbar button available in the Areas panel opens the Add area panel.

Add_area_button.jpg

The Add Area button

To add a new Area the user is required to fill in at least the mandatory settings. The Area settings are as follows:

Add_area_panel.jpg

The Add Area panel

  • Name - the name of the Area

  • Area subpage -the Area subpage can be selected in a dedicated panel, from a list of already defined page lists.

  • Roles - the role(s) defined for the new Area. Role can be selected in a dedicated panel, from a list of roles available for the currently logged in user.

  • Photo - the Area photo will be displayed in thumbnails and tiles. The user can Browse for an image file or Clear the existing one.

  • Custom parameters

    Important

    If no Custom field definitions were specified for Areas, the Custom parameters area will be hidden from the Add / Edit area panel.

    As soon as at least one Custom field definition is available, the Custom parameters area allows the user to fill in Area's metadata, as described below.

    For more details upon the Custom field definitions validation rules, please also visit the dedicated article here.

    • Text metadata - expects a textual metadata, with the scope to provide additional information about the user. When setting the textual metadata, the introduced value will be validated against the rules specified at level of the Text Custom field definition.

      Text_param.jpg
    • Email metadata - expects a valid email address. When setting the email metadata, the introduced value will be validated against the rules specified at level of the Email Custom field definition.

      Custom_para_email.jpg
    • Integer metadata - expects an integer value. When setting the integer metadata, the introduced value will be validated against the rules specified at level of the Integer Custom field definition.

      Custom_param_integer.jpg
    • Decimal metadata - expects a decimal value. When setting the decimal metadata, the introduced value will be validated against the rules specified at level of the Decimal Custom field definition.

      Custom_param_decimal.jpg
    • Date metadata - expects a date metadata, that can be selected using the Calendar pop-up. When setting the date metadata, the introduced value will be validated against the rules specified at level of the Date Custom field definition.

      Date.jpg
    • Time metadata - expects a time metadata, that can be selected using the Clock pop-up. When setting the time metadata, the introduced value will be validated against the rules specified at level of the Time Custom field definition.

      Time.jpg
    • DateTime metadata - expects a date and time metadata, that can be selected using the Calendar pop-up. When setting the DateTime metadata, the introduced value will be validated against the rules specified at level of the DateTime Custom field definition.

      DateTime.jpg
    • Url metadata - expects an URL. When setting the DateTime metadata, the introduced value will be validated against the rules specified at level of the DateTime Custom field definition.

      Url_Param.jpg
    • Enumeration metadata - expects the selection of one of the values defined by the Custom field definition. Selection can be done using the drop-down list. When setting the Enumeration metadata, the introduced value will be validated against the rules specified at level of the Enumeration Custom field definition.

      Custom_param_enumeratiohn.jpg
    • Boolean metadata - expects the selection of one of the Yes / No values. Selection can be done using the toggle button. When setting the Boolean metadata, the introduced value will be validated against the rules specified at level of the Boolean Custom field definition.

      Boolean.jpg

The bottom section of the Add area panel provides the options for saving the new area and closing the panel. Upon saving, the new area will be automatically displayed in the Areas panel's list.

Editing Areas

The Edit button located in the Area detailed view mode toolbar opens the Edit area panel. The edit function is available only for users having the Manage Sites and Areas permission enabled.

Edit_Area_button.jpg

The Edit Area button

In this view, the user can update all the Area information: Name, Photo and Subpage and Custom parameters.

Edit_area.jpg

The Edit Area panel

Deleting Areas

The Area detailed view mode provides the user with possibility to remove the Area, by clicking the Delete toolbar button. The Delete button is available only for users having the Manage Sites and Areas permission enabled.

Delete_area.jpg

The Delete Area button

In the Delete Area panel the user is provided with information about the impact of the deletion over the whole system.

Warning

When deleting an Area all it's assigned Sub-Areas, Devices, Signals, Measurements and Event occurrences will be deleted as well.

To acknowledge the consequences and proceed with the deletion, the user has to type in the designated field, the displayed confirmation code. To proceed with the deletion, the user can press the Delete button, located at the bottom of the panel. Deletion is immediately visible, in the Areas panel.

Delete_Area.jpg

The Delete area panel

Managing Application Mappings

The Manage Application button displayed in the Area's details panel allows users, having the Manage Sites and Areas permission enabled, to add and update an Area's i4designer Application mapping.

Add_app.jpg

The Manage application button

Tip

For more details about the i4designer Application mapping feature please also refer to the dedicated articles here.

The Manage Application Mappings panel of an Area features the following properties:

Manage_Area_App_Mapping.jpg

The Manage Application Mappings panel

  • Default Application - the application added in this section will be displayed in the Area's details panel.

    • Default Application - the Application mapping used by the current Area, that will be displayed in the Area's details panel.

      Default_OrgUnit_Aplication.jpg

      The list of Application mappings

      Warning

      Please note that the Application mappings list will be available when accessed from the Manage Application Mappings only for users having at least the View applications permission enabled. The list will display only Applications owned by or assigned to the logged in user.

    • Subpage path - an optional sub-page of the i4designer project. The sub-page path is given by the project's sub-page exact name.

      Note

      By setting a sub-page path the page will be by default displayed by the Area application. If the field is left empty, the project's default page will be displayed.

    • Title - the title displayed by the panel, when opening the Application in view or preview mode. If no title is filled in this field, the Application panel will display the name of the Application mapping.

    • Subtitle - the sub-title displayed by the panel, when opening the Application in view or preview mode. If no sub-title is filled in the field, the Application panel will display no sub-title.

    • Panel size - the size of the panel, when opening the Application in view or preview mode. By default, the panel size is set to lg (large) but the user can decide to apply the following sizes: sm (small), md (medium), lg (large), xlg (extra large), xxlg (extra extra large), 3xlg (3 times extra large), 6xlg (6 times extra-large).

      Panel_size.jpg

      The Panel size selector

    • Navigation parameters - an optional set of parameters based on key-value mappings.

      Navigation parameters can be added by clicking the Add parameter button Add_parameter.jpg. The user needs to manually input the Parameter Name and Value. Inserted parameters can be removed by clicking the Delete button Remove_parameter.jpg.

      Navigation_parameters.jpg

      The Navigation parameters

      Besides the custom navigation parameters, the i4connected platform is also injecting a set of standard parameters. The standard parameters are capable to automatically resolve parsed information.

      This table lists the parameters that can be used by the application designer and which will be automatically available to the applications targeting the i4connected platform:

      • I4C_SITE_ID - Contains the ID of the site to which the application is attached. Injected via query parameters.

        Note

        Available if the application is attached to:

        • A site

        • An area

        • A device connected to a site

      • I4C_SITE_NAME - Resolved at startup, it contains the name of the site (untranslated).

        Note

        Available if the application is attached to:

        • A site

        • An area

        • A device connected to a site

      • I4C_AREA_ID - Contains the ID of the area to which the application is attached. Injected via query parameters.

        Note

        Available if the application is attached to:

        • An area

        • A device connected to an area

      • I4C_AREA_NAME - Resolved at startup, it contains the name of the area (untranslated).

        Note

        Available if the application is attached to:

        • An area

        • A device connected to an area

      • I4C_ORG_ID - Contains the ID of the organizational unit to which the application is attached. Injected via query parameters.

        Note

        Available if the application is attached to:

        • An organizational unit

        • A device connected to an organizational unit

      • I4C_ORG_NAME - Resolved at startup, it contains the name of the organizational unit (untranslated).

        Note

        Available if the application is attached to:

        • An organizational unit

        • A device connected to an organizational unit

      • I4C_DEVICE_ID - Contains the ID of the device to which the application is attached. Injected via query parameters.

        Note

        Available if the application is attached to:

        • A device

      • I4C_DEVICE_NAME - Resolved at startup, it contains the name of the device.

        Note

        Available if the application is attached to:

        • A device

      • I4C_DEVICE_DESCRIPTION - Resolved at startup, it contains the description of the device.

        Note

        Available if the application is attached to:

        • A device

      • I4C_DEVICE_ALIAS - Resolved at startup, it contains the alias of the device.

        Note

        Available if the application is attached to:

        • A device

While configuring the Area Default Application, the user can check the Application's display in preview mode. By clicking the bottom Preview button a separate panel is opened displaying the drill-down Application as it will be displayed in view mode.

Preview_mode.jpg

Example of Application opened in preview mode

While in preview mode, the user can asses the Application before saving and applying the settings.

Further on, the URL of the Application is displayed at the top of the preview panel allowing the user to copy it to the clipboard. The copied URL can be afterwards used to pin tiles to i4connected pages.

Copy_to_clipboard.jpg

The Copy URL to clipboard option

Tip

For more details about the Pin tiles option, please also visit the dedicated article.

Importing Ewon configuration

The toolbar of the Area's details panel allows users having the Manage Sites and Areas and Manage configuration permissions enabled, to Import Ewon configuration.

Import_Ewon_config.jpg

The Import Ewon configuration button

The Import Ewon configuration panel features the following parameters:

Import_Ewon_area.jpg

The Import Ewon configuration panel

  • Site - the Site where the devices will be assigned. This field is by default filled in with the name of the Site, where the currently opened Area is assigned to.

  • Area - the Area where the devices will be assigned. This field is by default filled in with the name of the currently opened Area.

  • Organizational Unit - the Organizational Unit where the devices will be assigned. This field is optional.

  • Adapter - the Adapter where the devices will be chosen from.

  • Time zone - the time zone that will be assigned to the devices. After the import, the time zone setting can be modified in the Device configuration panel.

  • Ewon username - the username of the device.

  • Ewon password - the password of the device.

  • Add Ewon Devices button - when clicked, the list of Ewon devices available for import, is opened.

    Select_Ewon_device_for_area.jpg

    The Select ewon device panel

    Warning

    Please note that when importing multiple devices and filling in the Ewon username and password, only those devices that have matching credentials will allow signal writing.

By clicking the Import button the selected Devices and all their tags (signals) will be configured for the given Area and the server will be notified that it can start collecting data.

Warning

The Ewon configuration import works like a move function. Hence, importing an Ewon device available for one hierarchical entity to another, the first entity will no longer use that device.

Tip

The Import Ewon configuration operation attempts to match Ewon Signal names with i4connected Signal type names and automatically apply the matching Signal types to the Signals.

Importing Netbiter configuration

The toolbar of the Area's details panel allows users having the Manage Sites and Areas and Manage configuration permissions enabled, to Import Netbiter configuration.

Import_Netbiter_config_for_adapter.jpg

The Import Netbiter configuration button

The Import Netbiter configuration panel features the following parameters:

Import_netbiter_config_panel_for_adapter.jpg

The Import Netbiter configuration panel

  • Site - the Site where the devices will be assigned. This field will be by default filled in with the name of the Site, where the selected Area belongs to.

  • Area - the Area where the devices will be assigned. This field will be by default filled in with the name of the currently opened Area.

  • Organizational Unit - the Organizational Unit where the devices will be assigned. This field is optional.

  • Overwrite Data - Selecting the Overwrite option the previous data will be replaced with the new data.

  • Start Date - the Start date used by the Device to synchronize historical (past) values.

  • Adapter selector- when clicked, the list of Netbiter adapters is opened, allowing the user to chose and apply the desired one.

  • Add Netbiter Devices button - when clicked, the list of Netbiter devices is opened, allowing the user to chose and apply the desired one. The list of Netbiter devices shows all the Netbiter Argos projects available for the selected adapter.

    Import_Areas.jpg

    The Select Netbiter device panel

By clicking the Import button the selected Devices and all their Signals will be configured for the given Area and the server will be notified that it can start collecting data.

Warning

The Netbiter configuration import works like a move function. Hence, importing a Netbiter device available for one hierarchical entity to another, the first entity will no longer use that device.

Note

Historical measurements will not be available, when a Netbiter Adapter using Customer Data Channel communication protocol is involved in the Netbiter configurations import operation.

Tip

The Import Netbiter configuration operation attempts to match Netbiter Signal names with i4connected Signal type names and automatically apply the matching Signal types to the Signals.