Self Help Widget


Apps - Widget - Self Help icon.png This widget belongs to the EasyVista category in the widget library. It is used to integrate the contents of a Self Help project or procedure in a Service Apps app.

Example

Integration of a Self Help portal in an app

  • The Self Help widget is defined in an app page and it calls a Self Help project.
  • The page header and footer are defined in the other app pages.

         Self Help widget example.png

Notes

    Open url.png See General remarks on widgets.

Best Practice

  • We recommend that you select a connector that performs the authentication of Service Apps users in Self Help via an API key.
    • This enables users to access Self Help procedures using their Service Apps credentials.
    • Users will be automatically created in Self Help if they do not have a Self Help account. Open url.png See the example.

List of properties

Content

Data source: Self Help data source linked to the widget. 

  • The drop-down list displays only EasyVista Self Help data sources.
  • To modify the data source or to view its contents, you should click Apps - Edit icon.png.
  • To define a new data source, click Apps - Add datasource icon.png Add Data Source in the Objects pane.

Theme: Name of the Self Help skin to be used.

  • The default skin will be used if you do not specify this field.
     

Toolbar configuration in procedure pages

For each procedure, this indicates if the functionality should be enabled in the toolbar (box is checked) or not (box is not checked). If the box is checked, the corresponding icon will be displayed.

    Open url.png See:

Property Icon Description
Allow Log Procedure page - Toolbar - Report icon.png   Report Used to generate the execution report of the current procedure.
Allow Post-it Procedure page - Toolbar - Comment icon.png   Comment Used to display a message in the execution report of the procedure. Depending on the configuration, the message can also be sent by email to the writer of the procedure.
Allow Map Procedure page - Toolbar - Overview icon.png   Overview Used to display the flow chart of the entire procedure.
Allow Pause Procedure page - Toolbar - Pause icon.png   Pause Used to pause the current procedure and resume it at a later time.

         Theme evSH - Procedure.png

Add More Parameters: List of additional parameters automatically added to the end of the Self Help project URL.

  • Only parameters managed by Self Help, as well as the skin will be processed. Open url.png See the list.
  • You should separate each parameter using the & character.

example  

  • Parameters:&debug=true&myparam=blue
  • URL to run: demo/selfhelp
    ==> Full URL: demo/selfhelp&debug=true&myparam=blue

Theme

   Open url.png See the description of properties.

List of parameters

Option Context Description Expected value Default value
gobackref=true|false Project Redirect to the calling page or referrer page when leaving the portal false
returnurl=url Project/Procedure Go to a fixed page when leaving the portal/Go to a fixed page when leaving the procedure (abnormal end) Encoded URL of a page
stopurl=url Procedure Go to a fixed page when leaving the procedure (normal end) Encoded URL of a page
stopToReferrer=true|false Procedure Redirect to the calling page or referrer page when leaving the procedure (normal end) false
returnToReferrer=true|false Procedure Redirect to the calling page or referrer page when leaving the procedure (abnormal end) false
debug=true|false Procedure Display a link to a debug window false

Procedure: How to implement a Self Help project in an app

Prerequisites in Self Help

1. The Self Help project must already be published.

2. (optional) You must have the required information on the API key to configure the Self Help connector if you are using single sign-on authentication.

Procedure_EnterAPIKey

  • Create the API key. Open url.png See the procedure.
    Note: Ask your server administrator to provide the required information if you do not have the rights to create the API key.
  • Copy and paste the following information for creating the connector in a text editor:
    • The API key specific to your Self Help project (1)
    • The secret of the API key (2)
      Caution: This information is only available during this step. You cannot obtain it at a later time.
  • Download the PEM file containing the API private certificate to your workstation (3).

         API key details.png

EndDefinition

Step 1: Add a Self Help connector to Service Apps.

1. Click Apps - Gallery - Connectors icon.png Connector in the App Gallery toolbar or graphic editor toolbar.
The window for configuring the connector will appear.

2. Click Add Connector.

3. Name the connector.

4. Select the Self Help connector.
The fields specific to the type of connector will appear. Open url.png See the description.
         Self Help connector - With API key.png

5. Specify the properties for identifying the connector.(1)

  • The domain corresponds to the location of the Self Help server.
  • You can obtain the ID of the Self Help project in publish mode in the Desktop Studio. Select Generate a portal link from the contextual menu.
  • The alias is specified by the writer publishing the Self Help project. You can retrieve it in publish mode in the Desktop Studio. Select Alias Projects in the tree structure of the Explorer pane.

    Best Practice icon.png  We recommend that you use an alias because this does not change when a new Self Help project version is published, unlike the Self Help project ID which is always regenerated.

6. (optional) Configure the API key if you are using single sign-on authentication. (2)

  • Tick the Cross Service Authentication box.
     The fields for configuring the API key will appear.
  • Specify the fields using the information you pasted in the text editor (see Prerequisites > Step 3).
    • Copy and paste the API key in the API ID field.
    • Copy and paste the secret of the API key in the API Secret Key field.
  • Click Upload API Private Certificate to upload the API private certificate you downloaded earlier to your workstation.
  • (optional) Specify the group that will automatically be assigned to Service Apps users if they do not exist in Self Help.
    Note: This user group must be authorized to access the Self Help project procedures.

7. Click Save to save the connector and click Save again.
 

Step 2: Add an EasyVista Self Help data source to the app.

1. Click Apps - Application properties icon.png in the app toolbar to open the graphic editor.

2. Click Apps - Add datasource icon.png Add Data Source in the Objects pane.

3. Select the type of data source, Applications > EasyVista Self Help.

4. Select the Self Help connector you created earlier in the Self Help Alias/Connector field.

5. (optional) In the EasyVista Alias/Connector field, select the EasyVista IT Service Manager connector for connecting to a Service Manager database.

6. Specify the other properties of the data source. Open url.png See the description.
 

Step 3: Add a Self Help widget to the app.

1. Click Apps - Add widget icon.png Add Widget in the Objects pane.

2. Click and drag the EasyVista > Self Help widget type to the Design pane.

3. Ensure that the widget points to the EasyVista Self Help data source you created earlier in the Content > Data Source property.
 

Step 4: Check the Self Help project.

1. Click EVApps - GUI - Execute icon.png to run the app.
The app will appear in a new Web browser tab.

2. Check that the Self Help project runs correctly.

Tags:
Last modified by Unknown User on 2021/05/07 18:26
Created by Administrator XWiki on 2017/11/27 11:06

Shortcuts

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

Powered by XWiki ©, EasyVista 2021