This wizard allows us to manage custom operation views for the existing operation types.
Section
Below you can see the list of the configured views.
Every operation view has his own actions in order to manage independently:
You can edit, launch and remove the custom view.
Operations Views Wizards
In this section you can create, edit and delete custom operation views. By pressing Create Operation View wizard wizard will be opened.
Steps
Administrative Data
Principal and administrative data for the Custom Operation View. Title and icon will be the visible parts in menus.
Set Your Default Values
Here you can configure default values for the operation that will be executed within this custom view.
Set Your Fields
Here you can configure visible steps and fields for the operation execution wizard.
Previous Validations
Create validations that will be executed before the execution of the operation.
Callback must be called in order to validate the introduced data:
callback(boolean result, array messages)
result must be true or false in order to determine if continue the execution
messages contains strings to be shown to the execution log
Custom Organization Labels
In this section you can customize labels for your organization. This labels can be used for table headers, datastreams, custom sections and as title for widgets, dashboards and workspaces.
Section
Below you can see the list of the configured labels.
Configuration
You can add a new custom label by clicking in the + New button:
Custom labels have 3 fields and all of them are required:
Key is the unique identifier for your label
Spanish is the desired translation for this language
English is the desired translation for this language
If you type an existing internal label during the creation Spanish and English fields will be fulfilled with the internal translations. This changes only applies to your organization until you remove the custom label.
Labels actions
Edit You can update translation for your custom labels and changes will be applied immediately
Delete Also you can remove your custom labels but a browser restart is required. A warning is shown in order to remind you to restart.
Widgets Defaults
In this configuration section you can configure widgets behaviour when opened from others.
Section
Below you can see the list of the available configurable widgets. List can be filtered by category and/or widget name
You can add, edit and remove the configuration for every available widget in this list.
These configurations will be available for the user organization.
Widget defaults actions
Every listed widget has actions shown below:
New action is shown while no previous configuration saved and allows to configure new defaults for the selected widget
When widget is configured an actions menu will be available with these options:
Edit that allows change previously configured defaults
Delete quits the current configurations once you confirm the operation
Preview and configuration
A preview window will be opened were you can see how is opened the selected widget.
From this you can configure as you consider using own widget configuration panel.
Workspaces templates
Templates are preconfigured dashboards designed to display relevant information about an entity: device, asset, subscriber, subscription, and tickets.
Here you can find all the preconfigured templates for your account in every workspaces.
Creating a Template
By clicking in the Actions Menu -> Create new template template wizard will be opened to configure your template:
Dashboard: Choose the dashboard for the template.
Workspace: Choose the workspace or workspaces where the template will be saved.
Name: Choose the name for the template.
Priority: Choose the priority for displaying different templates if you configure more than one for the same conditions.
Conditions
Allowed resource type: Choose the type of resource it will open.
Specific type: Choose the specific type or specific types of resource.
You can filter, delete and modify the templates configured for a workspace.
Collection Wizard
Here you can view/configure new collection wizards for your organization’s website.
How it works
The collection wizard listing displays the created wizards along with their Title, Wizard type, and Specific Type.
Actions on the wizard
You can perform the following actions for each item in the listing:
Edit opens the collection wizard’s configuration for modification.
Delete removes the selected wizard.
Collection Wizard
When editing an item from the listing, you will see the collection wizard with its previously entered data.
Organization Files
From here, you can manage the files uploaded to the private storage of the organization.
How it Works
The file listing displays information for each of the stored files.
Files are grouped into 4 categories, which help the user identify the type of files and where they can be used. These categories are as follows:
BIM/IFC files in this category contain 3D models compatible with the BIM/IFC standard and are ready to be used in the corresponding widget.
SVG vector files that can be used in image widgets or any configuration that allows image import.
Image image files that can be used in image widgets or in any configuration that allows image import.
Documents any type of documentation files can be placed here, especially to be used in iframe widgets and to be displayed.
The following information is shown in the listing:
Unique Identifier the unique identifier of the file.
Name the name of the file.
Owner the organization where this file is located.
Category indicates the category where the file is placed.
Size (KB) the size of the file in kilobytes.
Updated date and time of the last file update.
Shared displays the number of users and organizations the file is shared with.
File Actions
For each item in the listing, the following actions can be performed:
Download opens the file for downloading.
Copy to Clipboard copies the unique URL of the file for use on the platform.
Share allows viewing and sharing the script for other users to use.
Choose File to Upload allows updating the uploaded file with another. This does not affect the generated link, so the change will be reflected wherever it was being used.
Delete removes the selected file.
Navigation Bar
In the navigation bar, the following actions can be performed:
Category Selector allows selecting a category to filter the listing.
Search allows applying a filter on the listing.
New File opens the file selection dialog.
IMPORTANT NOTE: To add a new file, it is necessary to select a category first.
Provision Wizard
Here you can view/configure new provision wizards for your organization’s website.
How it works
The provision wizard listing displays the created wizards along with their Title, Wizard type, and Specific Type.
Actions on the wizard
For each item in the listing, you can perform the following actions:
Edit opens the provision wizard’s configuration for modification.
Delete removes the selected wizard.
Provision Wizard
When editing an item from the listing, you will see the wizard with its previously entered data.
Scripts Formatters
From here, you can manage the formatting scripts saved by the widgets.
How it Works
The list of scripts displays the necessary information to locate where it is used and for what purpose. The following information is detailed:
Name identifier of the script
Version a number identifying the versioning
Description descriptive text of what the script does
Widget type of widget compatible with this script
Expanding the row reveals in which dashboards, and by which users, the said script is being used.
Actions on Scripts
For each item on the list, the following actions can be performed:
Share allows viewing and sharing the script for use by other users on their dashboards
Edit opens the script’s editing form for modification
Delete removes the selected script
Navigation Bar
In the navigation bar, the following actions can be performed:
Search allows applying a filter to the list
Refresh refreshes the content of the list
Web Areas & Sections
From here, you can add new areas and sections to your left panel sections menu for the organization.
How it Works
Web Sections list displays information of custom configured areas in domain.
The following information is shown in the list:
Icon representative icon for the area in menu.
Name the name displayed in menu.
Description the description for the area.
Priority the display priority for the area when displayed in menu.
Categories show total categories availables area.
Web Section Actions
For each item in the list, the following actions can be performed:
Edit opens the Areas & Sections wizard in order to manage selected option.
Delete removes the selected area and all its contents.
Navigation Bar
In the navigation bar, the following actions can be performed:
Filter allows filtering of areas by name.
Create new area opens Areas & Sections wizard in order to create a new one.
Configuring a section
When you opened the section wizard you can see the area information step.
Area Information Step
Here you can configure the next information about the area:
Identifier unique identifier for the area (autogenerated but modifiable).
Title the name displayed in menu.
Description the description for the area.
Priority the display priority for the area when displayed in menu.
Web profile manages who can view this area in menu. If no one is seleted everyone can see it.
Icon representative icon for the area in menu.
Image background image for the area in the its home page.
Categories and Sections Step
Once you complete the required fields in previous step you can continue to this step.
Here you can see current provisioned categories and sections for the area and manage categories order.
Also you can add new categories by pressing New Category or new sections for each category by pressing the conventient New section button.
Categories can be created, edited or deleted. Also you can manage sections from this panel.
Category modal
A category is the sections grouper in left menu once you opened Area menu. Every category has their own sections.
You can configure the next in a category:
Identifier unique identifier for the category (autogenerated but modifiable).
Name the name displayed in menu.
If sections available in category you can manage the display order by dragging then.
Section modal
Section represents the final menu leaf and the opened window.
You can configure the next in a section:
Identifier unique identifier for the section (autogenerated but modifiable).
Name the name displayed in menu.
Icon the icon that identify the section.
Show in home makes the sections appear at area’s home.
Web profile manages who can view this section in menu. If no one is seleted everyone can see it.
Widget is the preconfigured widget to be shown in section.
Web Permissions
Here you can view/configure new roles for your organization’s web based on OpenGate’s original profiles.
How it Works
The list of roles shows the name of the role and the OpenGate profile on which it is based.
This means that a user will have the OpenGate profile as a base, but some functionalities will be limited on the web.
Actions on Roles
For each item on the list, the following actions can be performed:
Clone allows creating a new role based on the current one
Edit opens the role’s configuration for modification
Delete removes the selected role
Navigation Bar
In the navigation bar, the following actions can be performed:
Search allows applying a filter to the list
Refresh refreshes the content of the list
New opens the form for creating a new role
New Role Form
The form for the creation/modification of roles contains the following information:
Name unique identifying value of the role
Original Profile indicates which OpenGate profile is taken as a base for this role
Lastly, there are various layers of role customization. There are 4 groups:
Visibility allows hiding/showing common elements of the menu, widgets, workspaces, and dashboards
Management groups everything related to wizards and action forms for elements on the platform
Sections from here you can manage which web sections you want to enable for the role
Views allows selecting which provisioning/collection wizards should be displayed/hidden for the role. This option will only be visible if any of these elements are configured
IMPORTANT NOTE: To make use of this new role, it will be necessary to log out and log back into the platform.
Common Elements
At the top of the form, we can find the following elements:
Search With this, you can filter the permissions to be selected, facilitating their identification
Import/Export Configuration Allows importing and exporting the wizard configuration via JSON.
Import/Export Configuration
When accessing the import and export functionality, it displays a window with various actions. Additionally, it presents the configuration of the wizard in JSON format.
The available actions are as follows:
Upload Json: Uploads a JSON file and replaces the previous JSON configuration.
Paste from clipboard: Pastes JSON data from the clipboard and replaces the previous JSON configuration.
Download Json: Downloads the JSON configuration as a file with the wizard’s name.
Copy to clipboard: Copies the JSON configuration to the clipboard.
Web Preferences
Here you can configure everything related to the web for your organization.
How it Works
Within the configuration, we can distinguish three parts:
Organization Logo where an identifying image can be uploaded that will always be displayed on the navigation bar of the website.
Themes allows the selection of the color and overall appearance of the website.
Other Configs here, specific parameters can be configured that will affect the content displayed across the website. Their use is detailed below:
Google Key enables the use of Google’s localization tools. For example, in the tracking widget, it enables route calculations for device location points.
Weather Key allows activation of weather layers in the map widget. A free key can be created at OpenWeatherMaps.
Date Formatting this allows setting the desired format for the dates displayed across the website (to the extent possible). This relies on Moment.js.
Storage Limit indicates the maximum storage available for uploading files to the organization. With sufficient permissions, this can be modified.
Navigation Bar
In the navigation bar, the following actions can be performed:
Refresh refreshes the content of the listing.
Cancel cancel changes.
Save saves the current changes so they are not lost.
