Lobby Element Designer¶
The 'Lobby Element Designer' enables users to create new elements and customize existing lobby elements within IFS Cloud. The system comprises 15 distinct types of lobby elements, each lobby element is accompanied by its unique set of features within the configuration UI. Notably, all of these elements share four common configuration sections:
Element Layout¶
"Element Layout" allows you to configure the basic layout (appearance) of a Lobby Element
Configuration Properties¶
These properties are common for all element types
| Property | Description |
|---|---|
| Name | Name of the element (Name to be stored within the system) |
| Title | Title of the element. Searchable in the Element Browser (Title visible to the end user) |
| Title Visibility | Shows/hides the title. |
| Width | The width of the element (1,2,4,6,8 are supported) |
| Height | The height of the element (1,2,4,6,8 are supported) |
| Color Style | The background color and foreground color will apply depending on the element type |
Element Preview¶
"Preview" section allows you to get a preview of the configured element
Preview
- Once you have completed the Element configuration Click the "Preview" button (
) to obtain a preview of the configured Element.
Note: Preview allows you to run data source queries and check whether the element shows the set of data that's received.
Parameters
There are certain Data Sources which includes Parameters.
- Click the "Parameters" button (
)to access the parameters slide-out menu and view all the assigned parameters. - You can dynamically change the parameter values and observe element's behavior with the "Preview" option.
Navigation¶
"Navigation" allows you to provide end users with a seamless navigation experience, enabling them to access specific sections within the system by clicking on the details presented in Lobby Elements.
Configuration Properties¶
| Property | Description |
|---|---|
| Use Data Source Condition | The data filtration logics defined during the data source configuration, will be directly applied to the dataset on the destination pages.(More Info.) |
| Ignore Data Types During URL Parameterization | Ignore data type when parameterizing the destination URL. (More Info.) |
| URL Address | Add the navigation URL according to IFS guidelines. (More Info.) |
Use Data Source Condition¶
Using "DataSource Designer" you can create data sources, from "SQL" or "Projection" sources. These data sources are then used for ingest data to lobby elements. By configuring the "URL Address" section in "Element Designer, you can facilitate the end users with a functionality to navigate within the system by clicking on the lobby element components.
Example: Let's consider a scenario of creating a Counter element to visualize all the "Active Users" in the system.
Requirement:
- In the above example, consider that you are required to provide the end users with the capability to navigate to a destination page which consists only the records of all the active users, when he/she clicks on the "Counter value".
- You are only required to visualize the profiles of users with "Active" status on the destination page.
Note: You can visualise the active user count within the "Counter Element" by defining a condition in the "Data" section of counter element configuration window (More Info.). Issue arise when you try to navigate the users to a destination page which only consists records of "Active Users".
Issue:
- In a normal scenario if you have a simple filteration logic ("where" or "filter" logic for "SQL" or "Projection" data source) you can manually add it to the destination URL
Example:
- page/TstUserDetails/UserDetails (Destination page link without filter)
- page/TstUserDetails/UserDetails?$fitler=State eq 'active' (Destination page link with filter)
-
page/Users/List?$filter=(Userstatus eq $[User_Status]) (Destination page link on the navigation section)
-
However, if your have a much more complex filteration logic defined in the filteration section ("where" or "filter" logic for "SQL" or "Projection" data source) manually appending the filter to the navigation URL becomes challenging..
Solution:
To overcome this challenge, you can include the destination page link without the filter in the "URL Address" section and then select the "Use Data Source Condition" option. This will apply the same filter conditions that were defined during the "data source configuration".
Note: The system will automatically handle the backend filter logic for SQL or Projection data sources and apply it to the navigation URL, offering a seamless solution to the issue.
How “Use Data Source Condition” works with OData Source (Projection)
- When you apply a filtration logic in the “Filter” section in “DataSource Designer” for a projection data source, the filtration logic will be added as "$filter" in the navigation URL.
- If a "$filter" statement is already present in the navigation URL, the data source filtration statement will be combined with the existing URL using an "AND" operator. This ensures that both filtering conditions are considered while retrieving the data from the source.
How “Use Data Source Condition” works with SQL Sources
- When you apply a filtration logic in the “where” section in “DataSource Designer” for a SQL data source, the filtration logic will be integrated into the SQL statement generated for the destination pages entity set.
- If a ''$filter" statement is already applied to the navigation URL, the Data Source's filtration logic will be applied prior to the "$filter" operation.
Ignore Data Types During URL Parameterization¶
When you choose the "Ignore Data Types During URL Parameterization" option, the system ignores data type separations in the navigation URL, embedding the data without any formattings.
Example:
- Without "Ignore Data Types During URL Parameterization" option
Navigation URL: page/Customers/List;$filter=(CustomerId eq 'NA1057')
- With "Ignore Data Types During URL Parameterization" option
Navigation URL: page/Customers/List;$filter=(CustomerId eq NA1057)
Use Case: Entity data embedded in the generated URL can be directly extracted and used as for your preference.
Information¶
You can use this section to update general information about an element. These properties are common for all the element types
Configuration Properties¶
| Property | Description |
|---|---|
| Component | Component of the Data Source (By Default it will be 'CONFIG') |
| Author | The author of the element. Searchable in the Element Browser. |
| Keywords | Element keywords. Searchable via Element Browser |
| Last Modified | The date when the element was last modified. |
| Copied From | |
| ID | Elements presentation object id. |
| Descriptive Text | Description of the element. |
Lobby Element Types & Field Descriptions¶
- Analog Gauge Properties
- Bar Chart Properties
- Counter Properties
- Funnel Chart Properties
- Line Chart Properties
- Links List Properties
- List Properties
- Matrix Properties
- Pie Chart Properties
- Radar Chart Properties
- State Gauge Properties
- Image/Text Properties
- Web Content Properties
- Image Properties
(Depreciated Feature)
Find Element¶
Once you access the "Element Designer" UI, you can view the "Find Element" slide-out menu. This menu consists of
Find Element (Element Search Bar)¶
- "Find Element" (Element Search Bar) helps you to search for an element by typing any of the following search criteria's in the search textbox.
- Search using the element's name
- Search using the element's author e.g. "author: <author name>"
- Search using the element's Data Source e.g. "ds: <data source name>"
- Search using the element's type e.g. "tp: Chart"
Element Repository¶
Element repository provides an organized view of all the elements created within the environment. Each element type has its own section, displaying the element names and the number of elements created under that specific type.
To access an existing element, click on any element type dropdown menu in the "Find Element" section, or simply search for the element using "Find Element" search bar. Once you have found the desired element, select it, and the Element Designer canvas will open with the selected element properties.
Options Available for Existing Elements¶
Translations¶
Translations of texts can be made by using the "Translate" button (
). See more about Translations here.
Export / Import¶
Data in lobby elements can be exported to an .xml file or imported from a .xml file using the "Export" (
) and "Import" (
) options.
Used In¶
If the selected element is used on a Lobby page, the "Used In" button (
) will indicate how many lobby pages are utilizing the current element. By clicking the "Used In" button, the "Used On Pages" slide-in menu will appear, providing a tiled view of all the lobby pages that utilize this particular element. You can easily navigate to the desired lobby page by selecting the appropriate tile in the slide-in menu.
Protect Element¶
Protect / Protected¶
You can click on "Protect" (
) / "Protected" (
) button to enable / disable the editing privilege's of an element.
Edit Anyway¶
If you are an authorized user, you can click on "Edit Anyway" button (
) to restore the element editing privilege's back.