The Self Help Application Home Page


The Self Help Home page is the entry point for Self Help administrators and writers.

It enables them to access the Editor Portal and the Studio directly and to consult step-by-step procedures on how the Studio works.
         Application home page.png

Notes

  • Self Help must be installed on the workstation of each administrator or writer.
  • Run EVSelfHelpStudio.exe found in the Self Help installation folder.
  • User authentication is required for accessing the Home page. Users must enter their login and password.

Title bar, menu bar and toolbar

Title_Menu_Toolbars

         Title and menus and tools bars.png

(1) Title bar: Information on the current Self Help session, i.e. server name, domain, logged-in user.

(2) Menu bar. Open url.png See the description in the Studio.

  • Grayed-out options can only be accessed via the Studio.
  • You can select File > Import... in the menu only in Edit mode. This is used to import an archive to the last project opened in the Studio.
  • If you select options from the View and Mode menus, they will automatically be taken into account in the Studio.
EndTitle_Menu_Toolbars

(3) Toolbar

Functionalities

Accessing the Studio

The Studio provides access to Self Help projects, the related components and domain management options.

    Open url.png See the description.

Accessing the Editor Portal

The Editor Portal groups a set of functionalities intended for use by the writers of Self Help projects:

  • Quick Start guide (PDF format)
  • Step-by-step procedures on how the Studio works
  • Access to the Administration module Note: The menus available will depend on each user's access rights.

    Open url.png See the description.

Documentation

The documentation provides step-by-step procedures that describe how the Studio works.

DocumentationGeneralities

  • The Home page of the portal displays documentation by topic.
  • Click one of the topics to see the list of help procedures.
             Procedure - List.png
  • Each help procedure provides step-by-step instructions.
             Procedure - Detail.png
  • A toolbar is available in each procedure. Open url.png See the detailled description.
    It is used to:
    • Procedure page - Toolbar - Overview icon.png Display a flow chart of the whole procedure.
    • Procedure page - Toolbar - Report icon.png Generate the execution report of the current procedure.
    • Procedure page - Toolbar - Comment icon.png Send a message with a file attachment to writers of the procedure. This feedback can include errors in the content, comments, suggestions, etc.
    • Procedure page - Toolbar - Share icon.png Generate the URL of the current page to share it with other users.
EndDocumentationGeneralities

BestPractice_DetailledStepByStep

Best Practice

  • You can also click See the detailled step by step in Self Help button in some procedures in the wiki to access step-by-step procedures on how the Studio works.

example  Detailled step by step in wiki.png

EndBestPractice_DetailledStepByStep

Description of the toolbar

         Procedure - Toolbar.png

Overview

Procedure_OverviewIcon

Procedure page - Toolbar - Overview icon.png: Used to display the flow chart of the whole procedure.
       Procedure page - Toolbar - Overview detail.png

Procedure page - Toolbar - Overview step icon.png: Used to identify a step in the procedure. 

  • Steps with a dark green background correspond to the current node in the thumbnail found in the left corner.
  • Click Procedure page - Toolbar - Overview collapse icon.png in the top right corner to show or hide the next steps of the procedure.
     

Procedure page - Toolbar - Overview end icon.png: Used to identify an exit step in the procedure.

Icons displayed on hover

Procedure page - Toolbar - Overview Mouse hover step - Current nod icon.png: Used to display the topic associated with the selected step. In an exit step, this returns a list of procedures from the same category.

Procedure page - Toolbar - Overview Mouse hover step - Add comment icon.png: Used to send feedback with a file attachment to writers of the procedure in order to report errors, comment on how relevant the content is, or make suggestions.

Thumbnail in the left corner

  • Zoom tab: Used to display different zoom functionalities.
  • Preferences tab: Used to display the overview vertically or horizontally and select the number of steps displayed in the flow chart.

Report

Procedure_ReportIcon

Procedure page - Toolbar - Report icon.png: Used to generate the execution report of the current procedure.
       Procedure page - Toolbar - Report detail.png

Comment

Procedure_CommentIcon

Procedure page - Toolbar - Comment icon.png: Used to send a message with a file attachment to writers of the procedure in order to report errors, comment on how relevant the content is, or make suggestions.
       Procedure page - Toolbar - Comment detail.png

Share

Procedure_ShareIcon

Procedure page - Toolbar - Share icon.png: Used to generate a link to the current procedure. You can copy and paste the URL on the clipboard or send it by email.
       Procedure page - Toolbar - Share detail.png

Tags:
Last modified by Christine Daussac on 2020/03/24 12:37
Created by Administrator XWiki on 2019/12/10 17:21

Shortcuts

Recent changes
•  Service Manager
•  Service Apps
•  Self Help

Glossary

Powered by XWiki ©, EasyVista 2020