Self Help - Resource

Contents

A resource is a shared object created in a project and used in Product name - ev Self Help.png procedure steps. It may be a file (picture, video, PDF, etc.), HTML content or a hyperlink, a form, and so on.  - Open url.png see Resource types

By defining a resource, you can:

  • define the object in a unique manner;
  • reuse it several times in the project;
  • automatically propagate any modification to all the procedures that use it.

The resources are managed from the Explorer pane of the graphic editor and built in the Design pane. They can then be:

  • added as an attachment to a step: their page layout is managed automatically by the theme associated with the procedure;
  • inserted in the HTML content of the step: their page layout can be customized.

Notes

  • A resource can be used only in a procedure that belongs to the current project.

Best Practice big icon.pngBest practice

  • To use the resources of another project, use the import/export functions - Open url.png see Procedure

Resource types

    Open url.png see procedures:

 

Type Description
Files
  • The resource can be any type of file: Picture, Audio, Video, PDF, etc.

    Note: For videos: flash files (.swf and .flv formats) and html5 (.ogv, .mp4, .webm formats) with the restrictions given below depending on the browser.

Web browser MP4 OGV WebM
Firefox No Firefox 3.5+ Firefox 4+
Internet Explorer Internet Explorer 9+ No If codecs are installed
Google Chrome Google Chrome 4-16 (nor supported by the versions afterwards) Google Chrome 4+ Google Chrome 6+
Safari Safari 5+ No No
  • If the file is inserted in a step and not added as an attachment, you can modify its properties: in the Description pane > Content tab of the step, right-click the name and configure it using the options given - Open url.png see Procedure
HTML content
  • The resource may associate text, tables, pictures, multimedia files and so on.
  • The content is saved as a HTML file.
  • The pictures may have clickable areas: active areas that execute an action when clicked upon (open a Web page, chain to the next step, guide to a branch of the tree, etc.) - Open url.png see Procedure
Hyperlinks
  • The resource supports redirecting to an Internet site or a messaging system.
  • The links may be made dynamic by passing parameters when executing the step.
Forms
  • The resource supports interactive input to obtain information from the user.
Connectors
  • The resource gives access to an external service such as Web service, message system, etc.
Subprocedures
  • The resource is used to run business subprocesses.
  • All procedures can be declared as subprocedures.

Properties of a resource

         Resource Properties tabs.png

Access: select the procedure in the Explorer pane of the graphic editor, then go to menu View > Properties

Toolbar

  • Select language drop down.png: Select the display language for the resource properties content.
  • Properties browsing history icons.png : Navigate in the history of the properties viewed during the current session. Note: The history is reset for each Product name - ev Self Help.png session.
     

Icons contextual to the selected resource

  • Open object icon.png: Open the resource.
    • HTML content, Form, Subprocedure resource: content displayed in the Design pane.
    • Link resource: URL address displayed in the Design pane.
    • File resource: opened in the program associated with it (Excel, Word, Paint, etc.).
  • File resource:
    • Replace file icon.png : Select a new file. Its content is updated automatically everywhere it is used in the project.
    • Download file icon.png : File upload.

The tabs

Info.: Information about the resource (creation date, last update date, path, size).

  • Parameters > Edit parameters: Enter modifiable metadata of the resource - Open url.png see Procedure
     

Linked resources: List of resources linked to an HTML content resource.
 

Variable: Describe a variable contained in a Form resource.
  

Used by: List of the steps, by procedure, that use the resource.

  • Click any step of a procedure:
    • the Design pane displays the procedure diagram; the step that uses the resource is framed in blue.
    • the Description pane shows the tab in which the resource is used.

Procedures

How to create a resource

See the detailled step by step in Self Help

Step 1: Select the folder of the new resource

1. Expand the tree of the project to which the resource must be linked, via Tree expand icon.png in the Explorer pane.

2. Right-click the folder in which you want to create the new resource.
 

Step 2: Create the resource

1. Select New from the context menu, and the type of resource to add.
          Insert new resource.png

    Open url.png see Description of the resource types

2. Fill in the resource based on its nature; click below to display the instructions.

File

1. Select New > File... from the context menu.

2. Name the resource.

3. Select the associated file using Browse.

4. Click Finish.

Html Content (Text)

1. Select New > Text from the context menu.

2. Name the resource and press < Entrée > to confirm.

An HTML file associated with the resource is generated automatically.

3. Double-click the resource in the Explorer pane.

The Design pane opens without any content..

4. Define the content of the HTML file in the Design pane:

  • Add the text:
    • Use the toolbar to arrange the page layout.
    • You can hide a part of the text by placing it within [ ] characters.
  • Add the pictures:
    • Drag&drop the files (locally or to a server) from your Windows Explorer to the Design pane.
    • (Optional) Define the clickable areas using Pictures > Create a clickable area in the context menu of the picture - Open url.png see Procedure
  • Add the tables:
  • Drag&drop the resources from the Explorer pane to the Design pane to add them.

The HTML file is saved automatically every time content is added or modified.

Hypertext link

Form

Connector

Sub-procedure

1. In the diagram, hold down the < Ctrl > key to select all the steps to include in the subprocedure.

All the selected steps are framed in blue in the diagram.

2. Right-click any of the steps of the subprocedure and select Create a procedure from this selection from the context menu.

3. Name the subprocedure.

4. Click Finish.

The selected steps are replaced by Redaction Pane - Sub procedure icon.png.

5. (Optional) Double-click Redaction Pane - Sub procedure icon.png to display the content of the subprocedure.

The resource is inserted in the Explorer pane, in the selected project/folder.

How to use a resource in a Product name - ev Self Help - big.pngSelf Help procedure step

Step 1: Select the step in the procedure 

1. Double-click the procedure in the Explorer pane.
The procedure is shown in the Design pane.

2. Click the desired step in the Design pane.
The Description pane is refreshed.

Step 2: Select the method for adding the resource


Add the resource as an attachment to the step

See the detailled step by step in Self Help

Caution: In this method, the page layout of the resource is automatically updated by the theme associated with the procedure.

1. Drag&drop the resource from the Explorer pane to the step selected in the Design pane.

  • The icon illustrating the type of resource that was added is shown in the step frame.
             Redaction Pane - Resource icon on object.png
  • The resource is added to the Description pane, in the tab dedicated to the resource type - Open url.png see Description of the tabs


Insert the resource in the step content editor

See the detailled step by step in Self Help

1. Drag&drop the resource from the Explorer pane to the Content tab of the Description pane, at the place where it must be displayed on the Web page.

  • An area is displayed containing the name of the resource.
             Description Pane - Area for resource.png
  • The resource is added to the Description pane, in the tab dedicated to the resource type - Open url.png see Description of the tabs

2. Right-click the area delimiting the resource and configure it according to its type:

  • Picture file: define the clickable areas - Open url.png see Procedure
  • Audio file: select the display mode from among the three options given:
    • Presentation options... : select the listening options in the dialog box and click Finish;
    • See as link: the audio file is shown as a hyperlink in the procedure;
    • See content: the audio player is shown in the procedure.
       
  • Video file:
  • HTML content:
    • (Optional) Display the HTML file content in the Description pane by selecting See content from the context menu.

3. (Optional) View the step as it would appear on screen to the user:

  • Click a step in the Design pane.
  • Click the Preview view.
             Step - Overview example.png

How to view the use of resources in the Product name - ev Self Help - big.pngSelf Help procedures

What resources use a given procedure?

1. Select the procedure in the Explorer pane.

2. (Optional) Display the Properties pane using the menu View > Properties.

3. Click the Uses tab of the Properties pane.
 

What procedures use a given resource?

1. Select the resource in the Explorer pane.

2. (Optional) Display the Properties pane using the menu View > Properties.

3. Click the Used by tab in the Properties pane.

How to modify the content of a File resource

See the detailled step by step in Self Help

Step 1: Select the resource to be modified

1. Open the folder of the project containing the resource must be linked, via Tree expand icon.png in the Explorer pane.

2. Select the resource.
 

Step 2: Replace the file linked to the resource

1. (Optional) Display the Properties pane using the menu View > Properties.

2. Click Replace file icon.png in the toolbar in the Properties pane > Properties tab.

3. Select the new file using Browse in the Replace content dialog box.

4. Click Finish.
The new content of the file is automatically updated everywhere it is used in the selected project.

How to import/export a resource

See the detailled step by step in Self Help

Step 1: Select the project containing the resource

1. Click the project in the Explorer pane.
 

Step 2: Select the process to run 

Import a resource from another project

1. Click File > Import....

2. Select the resource to import, via Browse in the Import projects or resources dialog box.

3. Click Finish.
The resource is added to the Explorer pane, in the selected project.
 

Export a resource to another project

1. Right-click the resource to export.

2. Select Export > Export as EV Self Help archive... from the context menu.

3. (Optional - If linked resources are opened) Click Yes if the There are opened editors associated with this project. message is displayed.

4. Select the option corresponding to the destination of the exported resource in the Export resources dialog box:

  • To an archive:
    • click Browse;
    • select the location of the new archive;
    • click Finish.
      A .rar file containing the resource is created at the selected location.
  • To another working project:
    • select the project from the list of working projects displayed;
    • click Finish.
      The resource is added to the Explorer of the selected project.
       

Step 3: Use the imported / exported resource 

    Open url.png see How to use a resource in a Product name - ev Self Help.png procedure step

How to enter the parameters of a resource

File, HTML content, Link resource
         Resource Content File Link - Info tab - Parameters.png

Form resource
         Resource Form - Info tab - Parameters.png

List of predefined variables

Variable Content Type of data
currentNode (information about the node step being viewed)
currentNode.automatic Invisible step (without interaction) or visible step Boolean
currentNode.id Identifier of the current step Text
currentNode.name Title of the current step Text
currentNode.resourcesTab List of resources linked to the step (identifier, name, URL) Table
currentNode.textId Identifier of the Text resource corresponding to the step content Text
currentNode.type Step type (Task, Choice, etc.) Text
executionContext (information about the current procedure execution)
executionContext.startScenarioTime Procedure execution start time Integer
executionContext.lastNodeDuration Time the last step was viewed (= procedure execution end time) Integer
executionContext.currentNodeTimeOnEnter Execution time of the step being viewed Integer
executionContext.sessionLess Access to the procedure by identifying oneself/generating a direct link (= sessionLess) Boolean
executionContext.isMobile Procedure launched from a mobile theme Boolean
executionContext.lang Procedure language (e.g.: EN, FR) Fixed character string
executionContext.country Country of the language in which the procedure is run (e.g.: FR, GB, US, etc.) Fixed character string
executionContext.user.login User identifier (entered at the time of identification) Text
executionContext.user.title Identifier title (Mr./ Mrs./ Ms.) Text
executionContext.user.firstName User’s first name Text
executionContext.user.lastName User’s last name Text
executionContext.user.email User’s e-mail address Text
executionContext.user.id User’s unique identifier Text
executionContext.user.groups List of groups to which the user running the procedure belongs Text table
executionContext.log Report (Report tab content) Text
executionContext.userSessionId User session identifier if logged in from the portal Text
executionContext.instanceId Procedure execution identifier Text
executionContext.expertSessionId Expert session identifier if it generates a direct link from the editor when Test Link is clicked Text
executionContext.contextId Identifier of the current executed step Text
executionContext.referrer Procedure execution referrer URL (launched from a site, the portal, etc.) Text
executionContext.userAgent Information on the browser in which the procedure was run Text
executionContext.versionId Identifier of the version in which the procedure was run Text
Other
custom Generic global variable, empty by default, used prior to v2.6 (before the Library was created) Text
stopMessage Variable, empty by default, whose content is displayed in the Statistics message column Text
Tags:
Last modified by Unknown User on 2019/12/10 17:38
Created by Administrator XWiki on 2018/12/14 11:21

Help

•  SiteMap

•  How to use Feedback

Shortcuts

Recent changes
•  Service Engine
•  Service Apps
•  Self Help

Glossary

Powered by XWiki ©, EasyVista 2019