The Exposed Properties of an App


Exposed properties are parameters passed in the URL of an app. They apply to certain types of data sources from the Applications category and, when the app is run, they are used to:

  • Restrict the records displayed by applying a specific filter.
  • Display records using a specific view.
  • Narrow the search to specific records in Service Manager or in a Self Help knowledge base.

Examples

App narrowing the search for employees based on the login
    Open url.png See the use case.

  • Employees are displayed using a Data Viewer widget that points to an EasyVista data source.
  • To display only employees whose login contains the value, ALBERS, the exposed property of the data source, SearchValue, is passed as a parameter in the URL.
             Apps - Exposed properties - Example Employee directory.png
     

App retrieving the details of an incident

  • An automatic email containing a direct link to the Incident form is sent to users.
  • To retrieve the incident, the exposed property of the EasyVista data source, SearchValue, is passed as a parameter in the URL.
     

App narrowing the search for information from a Self Help knowledge base based on the title of a ticket
    Open url.png See the use case.

  • A Self Help project is implemented in the app via a Self Help widget that points to an EasyVista Self Help data source.
  • To enable the search for information in this Self Help project, the exposed property of the EasyVista data source, SearchValue, is passed as a parameter in the URL.
  • The app is linked to Service Manager Incident form.
  • The value to be retrieved from the data source is determined dynamically in Service Manager based on the title of the current ticket.
             Apps - Exposed properties - Example Self Help search.png

Notes

  • The list of objects with exposed properties as well as the properties that can be used are defined by EasyVista. You cannot add new ones.
  • The parameters passed in the URL apply to all app widgets that point to a data source where one of the exposed properties is specified.
  • Integration of exposed properties:
    • Shortcuts integrate the exposed properties of apps to which they point.
    • The QR code does not take exposed properties into consideration. This enables it to be valid at all times.

List of predefined exposed properties

Objects can have several exposed properties. 

  • View property:
    • Used to display records using a specific view.
    • Applies to EasyVista data sources.
    • Corresponds to the Content > View property of the data source.
    • The search value corresponds to the view selected from the drop-down list.

Caution

  • Aliases associated with parameters are for information purposes only. They do not have any impact on the search values.
  • You must select the column to be used for a Search Value exposed property in the Search section of the data source. Open url.png  See the use case.
  • Because the app URL can be seen by users, parameters are therefore passed using aliases. For security reasons, you should specify anonymous aliases such as Param1, Param2, etc.
  • For contextual apps implemented in Service Manager forms, you must map the Service Apps exposed properties with the relevant fields in the Service Manager form. Open url.png See the use case.
    Only fields in the Service Manager form with an alias that are present in the main form presentation will be available for the mapping. Open url.png See the procedure if the field you want is not available.

Best Practice

  • To retrieve a filter ID or view ID, select the relevant filter or view in the Content section of the data source. The GUID will automatically be loaded as the default value in the exposed properties.
  • Rename the default values of parameter aliases so that you can identify their function easily.

    example Default value SearchValue ==> Alias Phone

  • URL generation:
    • No exposed property is selected by default when you open the dialog box. Select the exposed properties you want and generate the URL.
    • If you modify one of the exposed properties, you should regenerate the URL so that the modifications you made are taken into account.

Screen description

         Apps - Exposed properties - Selected.png

Access: In the general properties Apps - Application properties icon.png or in the dialog box for sharing the app EVApps - GUI - Share icon.png

Note: When using exposed properties for the first time, the dialog box will display all exposed properties available for the app. Select those you want to pass in the URL and define their value.

Widget name: App object with exposed properties.

Property name: Name of the exposed property applicable to the object. Open url.png See the list.

URL parameter alias: Alias used to identify the parameter function. 

  • Double-click the cell to modify the default name.

Content/Value: Parameter value to be passed in the URL.

  • Double-click the cell to modify the value.
    • Filter/View parameters: Filter ID or view ID (GUID).
    • SearchValue parameter: String of characters in the column selected in the Search > Search Field property of the data source.
  • Values specified in the data source are displayed as default values.

    example  DS EasyVista Employee data source using the List view ==> Value of the View exposed property = {42CEA486-C6CD-4146-AFB6-8830D59E0A86}

     

Add Properties: Used to add new exposed properties from those that have not yet been used.

  • Select the exposed properties you want to pass in the URL and define their value.
             Apps - Exposed properties - List.png
     

Delete Properties: Used to delete the selected exposed properties from the list. They will no longer be passed as a parameter in the URL and will once again be available in the Add Properties dialog box.

Generate URL: Used to generate the URL using the selected exposed properties. A link will be used to run the app in a new Web browser tab via the URL containing the exposed properties.

  • Parameters are passed using aliases.
  • You should separate exposed properties using the ampersand &.
https://....&param1=value1&param2=value2&param3=value3...

Use cases

Narrow the search for employees based on the login

example  Generate a URL that will display the list of Service Manager employees whose login contains the value ALBERS ==> You must define the Search Value exposed property linked to the data source pointing to the list of employees.

Step 1: Create the data source pointing to the list of employees.

1. Create an EasyVista data source and name it DS EasyVista Employee.

2. Specify the following properties.

3. Complete the information required for the exposed properties.

  • Search > Search Field property: Login
     

Step 2: Create the widget to display the list of employees.

1. Create a Data Viewer widget.

2. Link it to the DS EasyVista Employee data source in Grid mode.
All records in the data source will appear in List mode.
         Apps - Exposed properties - Example Employee directory - All.png
 

Step 3: Configure the Search Value exposed property of the data source.

1. Click Apps - Application properties icon.png or EVApps - GUI - Share icon.png to open the Exposed properties dialog box and click Exposed properties.

2. Add the Search Value exposed property of the data source so that a search can be run on specific values.

  • Click Add Properties.

         Apps - Exposed properties - Example Employee directory - Add properties.png

  • Select the Search Value property of the DS EasyVista Employee data source and click OK.
    The data source's exposed property will be added to the list of exposed properties already used in the app.
             Apps - Exposed properties - Example Employee directory - Define properties.png

3. (optional) Modify the default value of the alias, SearchValue, and give it a meaningful name so that you can identify the exposed property easily.

  • Double-click the URL parameter alias cell.
  • Rename the parameter alias, Login.

4. Indicate the search value for the data source.

  • Double-click the Content/Value cell.
  • Enter the value you want to search for, ALBERS.
     

Step 4: Run the app with the exposed property.

1. Select the Login exposed property in the DS EasyVista Employee data source.

2. Click Generate URL.

The direct link to the app will be generated and displayed at the bottom of the dialog box.
         Apps - Exposed properties - Example Employee directory - Generate URL.png

3. Run the app using this URL.

  • Click the Execute url application link.

    or 

  • Click to copy the link.
  • Access the link using your Web browser.

The list of employees whose login contains ALBERS will appear.
         Apps - Exposed properties - Example Employee directory - Search value applied.png

Search in Self Help contextual information to a ticket title

    Open url.png See Forms - Contextual Apps > Use case.

Tags:
Last modified by Unknown User on 2021/02/23 15:49
Created by Administrator XWiki on 2019/04/01 20:07

Shortcuts

Recent changes
•  EV Service Manager
•  Service Apps
•  EV Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021