Self Help Online Studio - The User Interface

Last modified on 2023/08/01 14:54

The Online Studio contains a set of functionalities designed for writers and administrators.

     Open url.png See Overview of the Online Studio

Structure of the graphic interface

       Online studio.png

Description

  • (2): Menu pane
    • The pane appears in all Online Studio screens.
    • The user profile will determine the menu items displayed.
  • (3): Home page
    • The Home page displays the list of the latest procedures and resources modified by the logged-in user, as well as different indicators for monitoring activity in the user's Self Help projects.
    • The user profile will determine the content displayed.

Notes

Fundamentals

Login

       Online studio connexion page.png

  • Connection to the Online Studio is secure. Login is performed via the login page.
  • The account is linked to a user created via SSO, e.g. using an API key or corporate directory, or a user created directly in Self Help.

Notes

  • By default, the interface language is identical to the Web browser language. Click Language button.png to select another language.
  • Password management
    • This is performed by server administrators and domain administrators authorized to access the Users menu.
    • You can only change passwords stored in Self Help. You cannot change passwords in Self Help if the passwords are stored in an LDAP directory.
  • Logged-in users can change their own password in the user information zone Online studio user information - Little.png found in the top banner provided that authentication is not performed via an LDAP directory.

Procedures

Access the Online Studio

1. Log in to Self Help using the Web URL or via the Intranet.

2. (optional) Click Language button.png to modify the interface language.

3. Enter your login and password.

  • The Password field is case-sensitive.

4. Click Log in or Log in via SSO depending on your authentication method.

Change your password

1. Click the user information zone in the top banner.

2. Select Change my password.

Online studio user information - Change password.png

3. Enter your current password.

  • The Password field is case-sensitive.

4. Enter and confirm your new password.

  • The Password field is case-sensitive.
  • The password must comprise at least six characters.

5. Click Save.

6. Log out of the Online Studio.

7. Log in again using your new password.

Request a new password if the password is forgotten

1. Click the Forgot password link in the login page.

Online studio user information - Forgot password.png

2. Enter your login.

3. Click Send.

An email for resetting the password will be sent to the email address specified in your Self Help account.

4. Click the Reset password link in the email.

5. Enter and confirm your new temporary password.

Online studio user information - Reset password.png

6. Click Reset.

Your previous password will be reset and will no longer be usable.

7. Log in to the Online Studio using your new password.

Manage user passwords

Note: Only for authorized user profiles. Open url.png See procedures related to the Users menu

Logout

Tasks in progress

          Online studio ongoing tasks.png

  • The Ongoing tasks icon.png icon in the top banner enables you to view the tasks currently in progress.
  • When a task is in progress, a number will appear above the icon.
    • It indicates the number of tasks currently being run.
    • Click the icon to see the progress and status of each task, e.g. in progress, completed, failed.

Notifications

          Online studio notifications.png

  • The Notification icon.png icon in the top banner enables you to view immediate and scheduled extraction tasks, metadata import tasks and user import tasks run by the logged-in user. 
  • When there are new notifications, a number will appear above the icon.
    • It indicates the number of new notifications available.
    • Click the icon to display them in the right pane.

Description

Zone     Description
Open link This displays the menu item associated with the task. Click the relevant row to see its details.

Online studio notifications - List.png

Clear notifications This link at the bottom of the pane is used to clear the list of notifications.

User information zone

          Online studio user information.png

  • The user information zone is found to the right of the top banner.
  • Click to open it.
    • Minimized mode: This displays the logged-in user.
    • Expanded mode: You can access personal user information (e.g. credentials, domains, password modification), select the interface language, access help options (e.g. wiki, virtual agent Vicky), check the version of the Self Help server and log out.

Description

Option     Description
Display Profile This displays the My Profile screen: logged-in user account information, list of authorized Self Help projects and domains with the corresponding access rights, modification of the password for accessing the Online Studio

Online studio user information - Display profile.png

Language button.png Used to modify the Online Studio interface language

   Changing the interface language will not change the content language. To do so, you should click Online studio menu pane - Language button.png in the menu pane.

Show virtual agent Used to enable the wiki's virtual agent called Vicky in the Online Studio.
  • The option is available in all Online Studio pages. Open url.png See the procedure
Wiki This displays the wiki Home page
  • The option is available in all Online Studio pages.
About Self Help This displays technical information on the Self Help server as well as information on connectors and skins.

Procedures

Modify the interface language

1. Click Language button.png in the user information zone.

2. Select the language you want.

The menu pane, field names and chart titles will be displayed in the selected language.

Display the wiki's virtual agent, Vicky

1. Click Online studio user information - Little.png in the top banner.

2. Tick the Show virtual agent box.

The button for calling the virtual agent Vicky button.png will appear at the bottom of each Online Studio page.

3. Click Vicky button.png.

The conversation panel will open. Open url.png See How to use a virtual agent

Online studio user information - Display Vicky.png

4. Hover over the button and click Reduce Vicky icon.png to minimize the button.

The call button will now appear vertically.

Hover with mouse Vicky button.png

Menu pane

       Online studio menu pane.png

  • The menu pane displays the menu items that logged-in users are authorized to access based on their user profile, e.g. administrator or writer.
  • The Online studio menu pane - Language button.png button is used to select the content language, e.g. Self Help project names, procedure titles, or chart values.

Notes

  • The menu pane always appears to the left of the screen. Click Reduce menu icon.png at the bottom of the pane to minimize it. In this case, only menu icons will be displayed.
  • The Home page icon.png Home menu item is always found at the top of the pane. It enables you to return to the Home page.
  • Changing the content language will not change the Online Studio interface language. To do so, you must access the user information zone in the top banner.
  • The word, <Unnamed> will appear if there is no translation available for the selected language.
Language: EN Language: FR
Online studio menu pane - Selection language EN.png Online studio menu pane - Selection language FR.png

Procedures

Show or hide the menu pane

1. Click Reduce menu icon.png at the bottom of the menu pane.

The menu pane will be minimized. Only menu icons will be displayed.

Online studio menu pane - Pane reduced.png

2. Hover over Expand menu icon.png.

The options in the menu pane will appear as long as the cursor is not moved.

3. Click Expand menu icon.png.

The menu pane will appear again.

Modify the content language

Home page

       Online studio home page.png

  • The Home page displays the list of working procedures and resources that have been modified by the logged-in user, as well as different indicators for monitoring activity in the user's Self Help projects.
  • It enables users to open the decision tree to monitor progress in the writing of procedures and test each procedure without having to exit the Online Studio.
  • It enables users to open a procedure or resource directly in the Desktop Studio.

Notes

  • The user profile will determine the content displayed on the Home page.
    • The Recently changed pane cannot be seen by server administrators.
    • Writers and administrators can only display data from their authorized domains.
  • Only the procedures and resources associated with the domains that logged-in users are authorized to access will appear.
  • By default, the Home page displays data from the last 30 days.
  • Procedures and resources from published Self Help projects will not be displayed.
  • The dashboard in the Activity pane is managed by EasyVista. You cannot modify the KPIs displayed.
  • You can change the interface language in the user information zone.
  • You can click Online studio menu pane - Language button.png in the menu pane to change the language in which content is displayed.

Best Practice

  • Apply the filters available to limit the number of procedures and resources displayed in the Recently changed pane.
  • Writers can use the Online Studio Home page as an entry point to access the Desktop Studio. This enables them to open a procedure or resource directly in edit mode.

Description

Option     Description
(1) Filter zone
  • Filters are applicable to the Recently changed and Activity panes.
  • Each filter will only propose values that logged-in users are authorized to access.
  • You can select several values for a given filter, except for the Period filter.
  • Click x next to a filter value to remove the filter.
  • Select All in the list of filters to remove selected filter values.
  • The Undefined value at the bottom of the Author filter is used to display procedures and resources whose writer has been deleted.
  • Filter icon.png: Used to display criteria for applying advanced filters, such as procedures shown to or hidden from users, procedures with or without comments, or resources by type, i.e. pictures, videos, content, documents, links, forms and connectors.
  • Home page - Filter zone - Recently changed section - Select element type.png: Used to select the type of component to be displayed, i.e. procedure or resource. Click the option again to remove the filter.
  • Status buttons (Draft, To be approved, etc.) : Used to filter components based on their status within the content validation workflow.
    • This filter is applicable only to the Recently changed pane.
    • The button color will automatically change when the filter is active. If no value is available for a status, the button will be grayed out.
(2) Display modes
  • Home page - Display mode - List.png: Used to display only the Recently changed pane
  • Home page - Display mode - Graphs.png: Used to display only the Activity pane
  • Disable the two display modes to return to the default mode displaying both panes.
(3) Recently changed pane This displays procedures and resources associated with the domains that logged-in users are authorized to access. Components are displayed from most recently to least recently changed.
  • The following information appears for each component:
    • The first row displays the component name as defined in the Desktop Studio, i.e. procedure title or resource name.
    • The second row displays the domain where the component belongs, the associated Self Help project, its status within the content validation workflow, and the writer who last modified it.
  • Click View icon.png next to a procedure to run and test it in a Web browser.

   The procedure must be defined as executable by users. Open url.png See edit mode in the Desktop Studio (User procedure access icon.png icon displayed to the right of the procedure name)

  • Click Edit 2 icon.png next to one of the procedures to monitor progress in the writing of the procedure via the decision tree and to test it.
(4) Activity pane This displays a dashboard for monitoring activity over a given period in Self Help projects that logged-in users are authorized to access. Four KPIs are used.
  • Total number of procedures run over a period of time
  • Number of procedures published over a period of time
  • Top five most popular procedures run over a period of time
    • The last line called Others groups all other procedures.
    • Each segment displays the number of executions for a given procedure.
  • Number of unique users who ran one or more procedures over a period of time

Procedures

Modify the interface language

1. Click Language button.png in the user information zone.

2. Select the language you want.

The menu pane, field names and chart titles will be displayed in the selected language.

Modify the content language

1. Click Online studio menu pane - Language button.png in the menu pane.

2. Select the language you want.

Self Help project names, procedure titles and chart values will be displayed in the selected language.

Use the decision tree

Open url.png See the procedure

Functionalities

Functionalities in tables of records

          Online studio list mode.png

Description

Zone     Description
Functionalities in the top banner
  • Filter and sort options apply to the list of records displayed.
  • These functionalities, e.g. deletion or modification, apply to the records selected from the list.
  • The number of elements in the list is displayed at the top of the list.

   The number indicates the total number of records and is not affected by filters applied to the list.

Online studio list mode - Select records.png

Icons displayed on hover over a row These functionalities, e.g. deletion or export, are specific to each row in the table.

Online studio list mode - Hover record.png

Sort option You can click each column header to sort data in the table.

Online studio list mode - Sort records.png

Click a row This displays the details of the record in the right pane. Open url.png See Details mode

Online studio list mode - View details.png

Functionalities in Details forms

Access: Click one of the records in the table

       Online studio details mode.png

Description

Zone     Description
Icons in the top banner These functionalities, e.g. deletion or report download, apply to the current record.

Online studio details mode - Icons.png

Sections This displays information in groups.

Online studio details mode - Tabs.png

Open link This displays the menu item associated with the information. Click the relevant row to see its details.

Online studio details mode - View details.png

Functionalities in creation wizards

Access: Click + Add in the top banner of the table

       Online studio wizard.png

Description

Zone     Description
Icons in the wizard timeline
  • Page indicators dots show the steps completed in the wizard: Wizard timeline icon - Validated step.png: Validated step, Wizard timeline icon - Current step.png: Current step, Wizard timeline icon - Not validated step.png: Non-validated step
  • Click one of the page indicator dots to access the relevant step quickly.

Online studio wizard - Timeline.png

Tags:
Powered by XWiki © EasyVista 2022