Views


Note: This document describes the screen for editing autonomous views. The descriptions of their criteria, conditions and data entry mode are identical to those for a reporting view.

Views contain summarized information that can be displayed onscreen or printed. This is based on the presentation of information, how it is grouped and its page layout.

Each view:

  • Is built around a parent query that accesses a set of standardized data from the database.
  • Can contain grouping levels:
    • Data is grouped and sorted by level. These levels filter data based on hierarchy. 
    • Information from the lowest level is displayed in a list containing configured columns with one row for each record.
  • Can contain visual alerts where special formatting is applied when the value satisfies certain conditions. This is used to highlight critical information in the lowest level.

    Example documentation icon EN.png  The status of equipment is displayed in red with a yellow background if it is Out of Order. Open url.png See the examples.

  • Can be associated with:
    • A menu option, e.g. the Equipment by location view is available in the equipment inventory. In this case, it is autonomous and is a full functionality in Product name - ev itsm.png.
    • A report to restrict its scope, e.g. the Number of late incidents this week view defined for the report. In this case, it will only run as a component within this object. 
  • Can access the Google Maps geolocation service to position Google map icon.png markers on a map using the location name, address, city and country.

Examples

1. The Equipment view associated with the Equipment inventory menu option is defined with the following criteria:

  • Three grouping levels: Department (last level) > Manufacturer > Model
  • Four last-level information to display: Type; Model; Asset; Status

    How to browse through the view?

  • Select a view --> First grouping level displayed = All last levels for departments, e.g. Purchasing, Accounting, IT associated with the Finance department.
  • Select a department --> Second grouping level displayed = All manufacturing brands used by the department, e.g. for the Purchasing department, the manufacturers displayed are Compaq, Dell, and HP.
  • Select a manufacturer --> Third grouping level displayed = All models associated with the manufacturer, e.g. for HP, the models displayed are DeskJet 970, LaserJet 5, and LaserJet 1100.
  • Select a model --> Last-level information displayed (Type; Model; Asset; Status) in a grid = All equipment associated with the model for the selected manufacturer, e.g. for the LaserJet 1100 model, the asset tags displayed are 10221P and 10224C.

    Last-level display of the view

Type Model Asset Status
Printers LaserJet 1100 10221P Out of Order
Printers LaserJet 1100 10224C In Stock


2. Visual alerts are defined in the Status field:

  • Alert for the Out of Order status:
         Condition = Out of Order;  font = Arial;  style = Bold;  text color = red;  background color = yellow
  • Alert for the In Stock status:
         Condition = In Stock;  font = Arial;  style = Bold;  text color = white;  background color = red

    Last-level display of the view

Type Model Asset Status
Printers LaserJet 1100 10221P

Out of Order

Printers LaserJet 1100 10224C

In Stock

PC HP Compaq 6000 POSEIDON_1492

In Stock

Phone SGH-E200 P01487 Active

Notes

  • Do not confuse the views described in this document with the SQL views used as tables in parent queries for adding fields.
  • Only a profile with the right to edit views for the module associated with the menu option can modify it.
  • For autonomous views associated with a menu option, access rights are defined by profile
  • You can add other fields to the parent query of the view manually, as long as you are authorized to edit the display for the module associated with the menu option that opens the view.
    • Perform this operation before editing the view.
    • Fields added manually appear with their alias. If the alias is not specified, then the physical name will appear.

      Example documentation icon EN.png  Alias: Phone, Physical Name: PHONE_NUMBER

  • In each menu option, there is a predefined List view for viewing all records at the lowest level.
  • A default display mode is defined for the view.
    • Views with grouping levels can also be displayed in graphs using the icons found to the right of the View drop-down list, e.g. Sector mode icon.png pie chart, Histogram mode icon.png bar chart, Geographical mode icon.png map, Google map icon.png Google Maps geolocation.
    • List mode icon.png Can display the List mode directly without going through intermediate grouping levels. 
  • In the case of tree fields such as Location, Department, Type, and Analytical Cost Allocation, only a Last Level field can be defined as a grouping level.
  • The formatting defined in visual alerts is not printed when you click Print icon.png.
  • Positioning of locations using Google map icon.png markers on a map:
    • This uses a Google Maps API. You are required to have a Google Maps API key.
      Open url.png  See the procedure.
    • To minimize calls between the client workstation and the Google Maps servers, geodecoding information is stored in the database once it has been obtained. It is only re-requested in the case of a change of address.

Best Practice big icon.pngBest practice

 

  • To ensure that information is grouped in a meaningful way, you should select fields that can group more than one value as grouping levels.

    Example documentation icon EN.png   It is pointless to define the asset tag as a grouping level in a list of equipment because asset tags are unique.

  • Display Name:
    • Give a descriptive name that enables users to understand the hierarchy of grouping levels easily.
    • You should generate names automatically once you have built the hierarchy of grouping levels.
    • If you modify the hierarchy of grouping levels, remember to modify the name of the view or to regenerate it automatically.
  • Visual alerts:
    • You should use the most frequently used fonts such as Arial, Courier, Verdana or Times New Roman to avoid display issues in different Web browsers.
    • In the conditions of alerts, you should specify the exact values of fields which are case-sensitive and accent-sensitive.
    • In the conditions of alerts, if the value to be specified contains a dash, you should place the value within quotes.

      Example documentation icon EN.png  Condition on priority: '1 - High'.

    • In a multilingual context, you should define as many alerts as there are labels for the value.

      Example documentation icon EN.png  In the Status field, you define English and French values Out of Order (EN) and En panne (FR) for the same alert.

Screens description

         View.png

Menu access: In any screen in List mode, click Edit icon.png to the right of the View drop-down list

Last-level display of the view

  • Display grouping levels (drill-down)
             View - Final presentation - drilldown.png
  • Display last-level information (List)
             View - Final presentation - information.png

Toolbar

Add icon.png: Used to create a new view.

Save icon.png : Used to save the view.

Duplicate icon.png : Used to duplicate and save the view using another name. The entire display of the view is duplicated.

Trash icon.png : Used to delete the view.

Display Name: Name identifying the view. 

  • View - Multilingual labels icon.png : Used to enter multilingual labels manually for the name of the view.
  • Sheet full icon.png : Used to generate names automatically once you have built the hierarchy of grouping levels. Naming rules applied:
    • View without any grouping level --> List
    • View with only one grouping level --> Name of the grouping level
    • View with several grouping levels --> Concatenation of the grouping level names separated by commas, e.g. Manufacturer, Model.

Default View: Used to indicate if the view displayed is the default one when the menu option is selected (box is checked) or not (box is not checked).
    Example documentation icon EN.png  The Location view is the default one for the Equipment inventory menu option

Display mode drop-down list (Note: Only for views with grouping levels): Default display mode when the view is selected, e.g. pie chart, bar chart, etc.

Password close icon.png : Used to define view access rights by profile.

Drop-down list of existing views: List of all views defined for the menu option. To display a view, select it from the drop-down list and click Select ok icon.png.

Available Fields: List of fields from the parent query associated with the view and other manually added fields.

Preview:

  • Drill-down section (Note: Accessible once you have defined a field in the List Mode section): List of fields defining the hierarchy of grouping levels.
    • The field at the top of the list is the highest grouping level. The field at the bottom of the list is the lowest grouping level.
    • To add a grouping level, click and drag the field you want from the Available Fields section to the Drill-down section.
      • There is no limit to the number of grouping levels you can define.
      • If no grouping level is defined, the view is displayed in List mode.
      • In the case of tree fields, only a Last Level field can be defined as a grouping level.
    • To arrange the hierarchy of grouping levels, click and drag the field up or down within the Drill-down section.
    • To delete a grouping level, click and drag the field you want from the Drill-down section to the Available Fields section.
  • List Mode section: List of fields displayed as columns in the last-level display of the view.
    • To add a column, click and drag the field you want from the Available Fields section to the List Mode section.
    • To arrange the columns, click and drag the field up or down within the List Mode section.
    • To delete a column, click and drag the field you want from the List Mode section to the Available Fields section.
       

Configuration of fields: Click Tools icon.png. Used to define how you want to display fields in the last-level display of the view.
         View - alert.png

  • Group by: Only for Date fields, used to define how records should be grouped.

Example documentation icon EN.png  You want a quick view of all equipment whose warranty expires in 2015:

  • End of Warranty field = 9/1/2015 
  • Grouping By Year = 2015
  • Start of the Path/End of the PathOpen url.png: Displayed only for a tree field if it is not a Last Level field, used to select the levels to be displayed. Note: The default 0 value is used to display all grouping levels in the hierarchy.

Example documentation icon EN.png Display the Location tree field = Europe/France/Paris/Champs Elysees/124  

  • Start = 0, end = 0 --> Europe/France/Paris/Champs Elysees/124  
  • Start = 1, end = 3 --> Europe/France/Strasbourg 
  • Start = 4, end = 5 --> Champs Elysees/124  
  • Value Location (Last Level) = 124
  • Visual alert: Used to define special formatting for a field when its value satisfies certain conditions.  Open url.png See the examples.
    • Condition: Expression interpreted when the view is run. It is used to assess whether a visual alert should be applied to the field. A condition is made up of the following:
      • An operator: =, <, <=, >, >=, <>
      • une expression texte correspondant à l'une des valeurs du champ à tester et/ou à une variable d'environnement :
        • variables disponibles : today --> Today; now --> Now (current date/time)
        • Variables can be combined with values and operators
        • If you want to specify a value containing a dash, you should place the value within quotes

Example documentation icon EN.png

  • Equipment Status field: condition =Out of Order
  • Priority field: condition >=3
  • Urgency field: condition '1 - High'
  • Incident: Creation Date field: condition today --> find all incidents created today
  • Equipment: Installation Date field: condition today-20 --> find all equipment installed 20 days before the current date
  • Action - Scheduled Start field: condition >now --> find actions scheduled after the current time
    • Background Color: Background color for displaying the field value. By default, White or Blue, alternate rows.
    • Text Color: Color for displaying the field value. By default, Black.
      • Color palette icon.png : Used to open a color palette for selecting the text and background colors.
      • You can enter the hexadecimal code, e.g. 0000FF for blue, 2B9137 for a custom green.
    • Font: Text font, e.g. Arial or Times New Roman applied to the field value. By default, the Web browser font.
      • All fonts supported by the Web browser are available.
      • You can concatenate the font name and size by separating them with a comma.
                 Example documentation icon EN.png  Arial, 10
    • Style: Font style applied to the field value. By default, Normal. Click to select the style you want.
    • Preview: Preview the formatting of the field in the last-level display of the view when the condition is satisfied.
    • Delete icon.png : Used to delete a row from the alert.

Procedure and Wizards

How to create a view and check its workability

1. Display any screen in List mode. Click Edit icon.png to the right of the View drop-down list and then click Add icon.png.

2. If you want to add other fields to the parent query:

  • Exit the view.
  • Click Tools icon.png and select Edit icon.png [ EDIT ] (Note: Your profile must be authorized to edit displays for the module).
  • Add the fields you want. Open url.png To find out more, see How to modify a parent query.
  • Return to the window for creating views.

3. Define the attributes of the view.

  • Click View - Multilingual labels icon.png to name the view. Note: To name the view based on the hierarchy of grouping levels, you must first define them. Once you have done so, click Sheet full icon.png.
  • Indicate and arrange the fields displayed as columns in the last-level display of the view:
    • In the Available Fields section, click and drag each field to be used as a column to the Preview > List Mode section.
    • In the Preview > List Mode section, arrange the order of the fields to be displayed as columns. To do so, click and drag the fields up or down within the section.
  • Indicate and arrange the grouping levels (Note: You must first place a field in the Preview > List Mode section):
    • In the Available Fields section, click and drag the field to be used as an grouping level to the Preview > Drill-down section. 
    • In the Preview > Drill-down section, arrange the hierarchy of the fields to be displayed as grouping levels. To do so, click and drag the fields up or down within the section.
  • Define special formatting for the fields in the view. In the Preview section,
    • click Tools icon.png next to the field you want. A window will appear enabling you to configure visual alerts.
      • Grouping: For Date fields, select the grouping you want.
      • Start of the Path/End of the Path: For tree fields, specify the first and last grouping level.
      • Visual alerts: Click [ ADD CONDITION ] and enter one row for each condition. Define the formatting of the visual alert applicable when the condition is satisfied.
      • To delete a row from the alert, click Delete icon.png.
    • Click [ SAVE ].
  • Click Password close icon.png to select the profiles authorized to access the view.

4. Click Save icon.png to save the changes made.

5. Check the workability of the view.

  • Close the window for creating views.
  • Select the new view from the View drop-down list.
  • Browse through the hierarchy of grouping levels and check the data displayed in the last-level display of the view.
  • If you defined visual alerts, check that their values are correctly highlighted.

How to create a view using a template

1. Go to the screen you want and display the List mode. Click Edit icon.png to the right of the View drop-down list.

2. In the Existing Views list, select the template you want and click Select ok icon.png.

3. Click View - Multilingual labels icon.png to enter a new name for the new view. Modify the settings as required. Click Duplicate icon.png so that you do not overwrite the template.

 How to enable geolocation using Google Maps

In map-based views, the Google map icon.png icon indicates the location of each site automatically using the label, address, city and country of the location. Information is displayed on maps using a Google Maps API. You are required to have a Google Maps API key.

         Google Maps Geocoding API - Schema.png

Note

  • Product name - ev itsm.png versions later than 2015.201 require a Google Maps V3 API key. Earlier versions require a Google Maps V2 API key.
  • The Google Maps service can only locate static addresses that are specified in advance.
  • You should avoid disclosing your Google Maps API key. This is because the use of the API key is associated with your account. It authorizes you to a specific number of requests. Each request run is counted.
  • Usage limit for the standard Google Maps API: 2,500 free requests per day, 10 requests per second. If you exceed this limit, you must enable billing to increase your usage limit. Open url.png   See Google Maps Geocoding API usage limits .
  • You can check if your limit of daily requests has been reached at any time. Open url.png See the procedure.
  • If you use a proxy for calling the Google Maps service, you must specify {ADMIN} Address: port of proxy to use with Google Maps in Other Parameters.

How to obtain a Google Maps API key

1. Go to the Google Maps Geocoding API page and click [ GET A KEY ].

2. Save the Product name - ev itsm.png app in the Google APIs Console.

  • If required, log in to your Google account to access the Google APIs Console.
  • If you are already using Google APIs, select the project used to manage your apps in the console. If this is not the case, select Create project
  • Click [ CONTINUE ]. A message will appear informing you that the project has been successfully created.

3. Generate your API key.

  • In the Credentials page, enter a name for the API key that will be specific to your server. Click [ CREATE ]. Your key will be generated and displayed.
  • Copy the key using Google Maps Geocoding API - Copy icon.png. Click [ OK ]. The Credentials page will be refreshed.
             Google Maps Geocoding API - Get a key (1).png

4. Add your Google Maps API key to the /Config/smo_config.php file found on the Apache server using the command line below:

Note:

  • Replace <Your GoogleMaps key value> with your API key.
  • Remember to add the ' ' quote marks.
define ('GOOGLE_MAPS_KEY', '<Your GoogleMaps key value>');

     Example documentation icon EN.png

define ('GOOGLE_MAPS_KEY', 'AIzaCyDq6C6oa93gvZHKNbABAf4dyIjfdjz4h7WL');

5. Check that the Google Maps API key works correctly using the procedure below.

How to check the workability of the Google Maps API key

1. Run the URL below: 

https://maps.googleapis.com/maps/api/geocode/json?sensor=false&address=<Location to geolocate>&key=<Your GoogleMaps key value>

     You should replace:

  • <Your GoogleMaps key value> with your API key.
  • <Location to geolocate> with the location to be checked.

     Example documentation icon EN.png  Check that Boston is correctly located

https://maps.googleapis.com/maps/api/geocode/json?sensor=false&address=Boston&key=AIzaCyDq6C6oa93gvZHKNbABAf4dyIjfdjz4h7WL

2. Check that the status returned at the bottom of the page by the geolocation request is OK.

         Google Maps Geocoding API - Status OK.png

    List of possible statuses:

  • OK: No error occurred. The address was analyzed and one or more items of geocoding data were found.
  • ZERO_RESULTS: The geocoding was successful but no results were returned. This can happen if the address parameter specified does not exist.
  • OVER_QUERY_LIMIT: You have exceeded your usage limit.
  • REQUEST_DENIED: Your request was rejected.
  • INVALID_REQUEST: An element is missing from the request.
  • UNKNOWN_ERROR: The request could not be processed because of an unknown server error. If you try again, the request may be successfully processed.

How to check quotas

1. Open the Google APIs Console.

2. If required, log in to your Google account to access the Google APIs Console.

3. Click Open menu icon.png  (1). Select IAM & Admin and click Quotas (2)

  • The number of authorized requests is displayed in the Google Maps Geocoding API service (3).
             Google Maps Geocoding API - Quotas.png
  • Click Edit icon.png in the row of the service to check the number of requests run during the day.
             Google Maps Geocoding API - Quotas - Update.png
Tags:
Last modified by Unknown User on 2018/07/13 12:00
Created by Administrator XWiki on 2013/03/25 18:18

Shortcuts

Recent Updates

Haven't been here in a while? Here's what changed recently:

-   Product name - ev itsm.png
-   Product name - ev sas.png

Interesting Content

How to Automate Integration
Add a Shortcut to an App
History
Quick Dashboard
Full text search - Stop Words

Powered by XWiki ©, EasyVista 2018