Ressources des projets Self Help


Les ressources identifient des objets créés au niveau d'un projet Self Help et utilisables par l'ensemble des procédures de ce projet. De cette façon, les objets peuvent être modifiés en un endroit unique et mis à jour automatiquement dans toutes les procédures où ils sont utilisés.

  • Les ressources peuvent être des images, des fichiers PDF, des contenus Html, des formulaires, ...  - Open url.png voir Les types de ressources.
  • Elles sont gérées depuis le mode Édition du Studio Desktop.
  • Elles sont pilotées par un workflow de validation pour gérer l'avancement de leur contenu jusqu'à la publication du projet Self Help.
  • Elles peuvent être :
    • attachées en pièce jointe à une étape : dans ce cas, leur mise en page est gérée automatiquement par le thème associé à la procédure ;
    • insérées dans le contenu Html de l'étape : dans ce cas, leur mise en page peut être personnalisée.

Remarques

  • Une ressource peut être utilisée uniquement dans une procédure faisant partie du projet Self Help courant.
  • L'utilisation des ressources d'un autre projet Self Help est possible en créant une archive et en utilisant les fonctionnalités d'import / export  - Open url.png voir Procédure
  • La suppression d'une ressource depuis l'éditeur de contenu d'une étape supprime la ressource de cette étape, mais ne la supprime pas du projet Self Help.

Bonnes pratiques

  • Lorsque le projet Self Help comprend de nombreuses ressources :
    • Créez un dossier Ressources communes à la racine du projet Self Help et placez-y toutes les ressources communes à l'ensemble des procédures.
    • Créez un dossier Ressources dans chaque sous-dossier du projet Self Help, au plus près des procédures qui les utilisent.
    • À l'intérieur de chaque dossier Ressources, créez des sous-dossiers pour regrouper chaque type de ressource (utilisez les mêmes noms dans chaque dossier).

      exemple  Sous dossiers Icônes, Formulaires, Contenu Html

  • Donnez des noms uniques à chaque ressource, permettant de les identifier rapidement.
  • Définissez des règles de nomenclature pour l'ensemble des ressources de votre projet Self Help.
    • Règles de nommage : généralement, le nom de la ressource commence par l'initiale de la nature de la ressource, suivi d'un libellé court de la procédure à laquelle elle se rapporte.

      exemple  

      • Ressource de type Formulaire associée à la procédure Configurer Outlook ==> F_outlook_xxx
      • Ressource de type Image associée à la procédure Envoyer un e-mail ==> I_email_xxx
    • Convention d'écriture : noms des ressources écrits en minuscules, commençant par une majuscule, ...

      exemple  CamelCase ; snake_style

Les types de ressources

   Open url.png voir procédures :

Type Description
Fichiers
  • La ressource peut être un fichier Image, Vidéo, PDF, ...
  • Les propriétés d'un fichier inséré dans une étape (et non attaché en pièce jointe) peuvent être modifiées via le volet Description > onglet Contenu de l'étape > clic droit sur le nom de fichier - Open url.png voir Procédure
  • Des paramètres d'entrée / sortie peuvent être définis - Open url.png voir Description

Note : Les fichiers vidéos autorisés peuvent être des fichiers flash (formats .swf et .flv) et html5 (formats .ogv, .mp4, .webm), avec les restrictions ci-dessous suivant les navigateurs.

Navigateur web MP4 OGV WebM
Firefox Non Firefox 3.5+ Firefox 4+
Internet Explorer Internet Explorer 9+ Non Si les codecs sont installés
Google Chrome Google Chrome 4-16 (non supporté par les versions ultérieures) Google Chrome 4+ Google Chrome 6+
Safari Safari 5+ Non Non
Contenu Html
  • La ressource peut associer du texte, des tableaux, des images, des fichiers multimédias, ...

    Note : Les images peuvent contenir des zones cliquables : régions actives exécutant une action après un clic (ouverture d'une page web, enchaînement sur l'étape suivante, orientation vers une branche de l'arbre, ...) - Open url.png voir Procédure

  • Le contenu est sauvegardé sous la forme d'un fichier Html.
  • Des paramètres d'entrée / sortie peuvent être définis - Open url.png voir Description

Best Practice icon.png

  • Créez un contenu Html pour afficher sur toutes les procédures le même bandeau d'entête ou le même pied de page contenant les informations de versionning, les contacts, ...

  • Placez cette ressource dans le dossier Ressources communes.
Liens hypertextes
  • La ressource permet la redirection vers un site internet ou une messagerie.
  • Les liens peuvent contenir des options de visibilité.
Formulaires
  • La ressource permet une saisie interactive pour obtenir des informations de la part de l'utilisateur. Les valeurs recueillies peuvent ensuite être utilisées dans les étapes de procédures - Open url.png voir Description
  • Des paramètres d'entrée / sortie peuvent être définis - Open url.png voir Description
Connecteurs
  • La ressource donne accès à un service tiers : web service, messagerie, tableur, ...
  • Des paramètres d'entrée / sortie peuvent être définis - Open url.png voir Description

Best Practice icon.png En sortie de l'étape d'action intégrant un connecteur :

  • testez le paramètre de sortie error : ce paramètre renvoie un code erreur lorsque l'appel au connecteur n'a pas pu s'effectuer correctement ;
  • définissez après cette étape au moins 2 branches conditionnelles, l'une d'entre elles servant à tester les différents cas d'erreur.

Les propriétés d'une ressource

        Explorer Pane - Properties view - Resource.png

Accès : mode Édition du Studio Desktop > sélection de la ressource dans l'arborescence du volet Explorateur > vue Propriétés  - Open url.png voir Description

ExplorerPane_ResourcePropertiesView_Tabs

Liste des onglets

  • Info : Informations sur la ressource (date de création, date de dernière mise à jour, emplacement, taille, ...). Note : Les informations ne sont pas modifiables.
  • Ressources liées (Note : Uniquement pour une ressource de type Contenu Html) : Liste des ressources liées à la ressource.
  • Variable (Note : Uniquement pour une ressource de type Formulaire) : Propriétés de la variable.
    • Cliquez sur le lien hypertexte pour afficher les étapes où la variable est utilisée.
  • Utilisée par : Liste des étapes, par procédure, qui utilisent la ressource.
    • Cliquez sur <Ouvrir la procédure et afficher les étapes qui utilisent cette ressource> : la liste des étapes, par procédure, qui utilisent la ressource est affichée. Cliquez sur l'une des étapes pour afficher la procédure dans le volet Conception et mettre en en évidence l'étape.

Procédures

Comment créer une ressource

Voir le pas à pas détaillé dans Self Help

Étape 1 : Sélection du projet Self Help

1. Sélectionnez dans l'arborescence du volet Explorateur le projet Self Help auquel la ressource doit être rattachée.

2. Ouvrez l'arborescence via Tree expand icon.png.

Étape 2 : Création de la ressource

1. Cliquez droit sur le dossier où doit être créée la nouvelle ressource.

Best Practice icon.png  Créez des sous-dossiers pour chaque type de ressource.

         Insert new resource.png

2. Sélectionnez Nouveau dans le menu contextuel puis cliquez sur le type de ressource à ajouter  - Open url.png voir Description des différents types de ressources


3. Renseignez la ressource suivant sa nature (Fichier, Contenu Html, ...).

   Open url.png voir Procédures détaillées

La ressource est insérée dans le volet Explorateur, dans le projet Self Help / dossier sélectionnés.

Comment utiliser une ressource dans une étape d'une procédure

Étape 1 : Sélection de l'étape de la procédure 

1. Double-cliquez sur la procédure dans le volet Explorateur.
La procédure est affichée dans le volet Conception.

2. Cliquez sur l'étape souhaitée dans le volet Conception.
Le volet Description est réactualisé.

Étape 2 : Sélection de la méthode d'ajout de la ressource


Attachement de la ressource comme pièce jointe à l'étape

Note : Via cette méthode, la mise en page de la ressource est gérée automatiquement par le thème associé à la procédure.

Voir le pas à pas détaillé dans Self Help

1. Cliquez-glissez la ressource du volet Explorateur vers l'étape sélectionnée dans le volet Conception.

  • L'icône illustrant le type de ressource ajouté est affichée dans le cadre de l'étape.
             Conception Pane - Procedure - Step with resources.png
  • La ressource est ajoutée dans le volet Description, dans l'onglet dédié au type de ressource  - Open url.png voir Description des onglets


Insertion de la ressource dans l'éditeur de contenu de l'étape

Voir le pas à pas détaillé dans Self Help

1. Insérez la ressource dans l'éditeur de contenu de l'étape.

  • Cliquez-glissez la ressource du volet Explorateur vers le volet Description > onglet Contenu, à l'endroit où elle doit être affichée sur la page web.

   ou

  • Allez sur le volet Description > onglet Contenu.
  • Positionnez le curseur à l'endroit où la ressource doit être affichée sur la page web.
  • Cliquez sur le menu Insertion > Insert resource icon.png.
  • Sélectionnez la ressource souhaitée.
  • Le contenu de la ressource est affichée dans l'éditeur. Pour une ressource de type Fichier, une zone délimitant l'emplacement est affichée.
             Description Pane - Area for resource.png
  • L'onglet dédié au type de ressource est réactualisé dans le volet Description  - Open url.png voir Description des onglets

2. Configurez la ressource.

  • Cliquez sur la ressource ou sur la zone délimitant la ressource.
    Un menu contextuel est affiché.
             Insert resource contextual menu.png
  • Configurez la ressource via les options proposées suivant son type.

3. Effectuez la mise en page.

4. (Optionnel) Visualisez l'étape telle qu'elle apparaîtra à l'écran pour l'utilisateur.

  • Cliquez sur l'étape dans le volet Conception.
  • Cliquez sur Launch procedure dropdown list.png dans la barre d'outils et cliquez sur Launch procedure icon.png Lancer la procédure.

Procédures détaillées

Comment créer une ressource suivant sa nature

        Insert new resource.png

Comment créer une ressource de type Fichier

1. Sélectionnez Nouveau > Fichier... dans le menu contextuel.

2. Nommez la ressource.

3. Sélectionnez le fichier associé via Parcourir.

4. Cliquez sur Terminer.

Comment créer une ressource de type Contenu Html (Texte)

1. Sélectionnez Nouveau > Contenu dans le menu contextuel.

2. Nommez la ressource et validez avec la touche < Entrée >.
Un fichier Html associé à la ressource est automatiquement généré.

3. Double-cliquez sur la ressource dans le volet Explorateur.
Le volet Conception est ouvert, sans contenu.

4. Définissez le contenu du fichier Html dans le volet Conception  - Open url.png voir Volet Conception pour une ressource de type Contenu Html

  • Pour ajouter du texte :
    • Insérez le texte souhaité.
    • Effectuez sa mise en page en utilisant la barre d'outils.
  • Pour ajouter des images :
    • Cliquez-glissez les fichiers (en local ou sur un serveur) depuis votre explorateur Windows vers le volet Conception.
    • (Optionnel) Définissez les zones cliquables via Images > Créer une zone cliquable dans le menu contextuel de l'image - Open url.png voir Procédure
  • Pour ajouter des tableaux :
    • Cliquez sur Table icon.png.
    • Définissez le tableau  - Open url.png voir Procédure
  • Ajoutez les ressources via un cliquer-glisser depuis le volet Explorateur vers le volet Conception.

Le fichier Html est automatiquement sauvegardé à chaque ajout / modification du contenu.

Comment créer une ressource de type Lien hypertexte

1. Sélectionnez Nouveau > Lien dans le menu contextuel.

2. Renseignez les informations du lien hypertexte dans la boîte de dialogue Nouveau lien.

  • Nom : Texte du lien hypertexte sur la page web.
  • Adresse :
    • lien vers un site internet : http://www/<url_site>
    • lien vers une messagerie : mailto:gsmith@xmail.com

3. Cliquez sur Terminer.

Comment modifier une ressource de type Fichier

Modification du contenu du fichier

Voir le pas à pas détaillé dans Self Help

1. Sélectionnez le projet Self Help dans l'arborescence du volet Explorateur.

2. Cliquez droit sur le fichier à modifier et sélectionnez l'option Ouvrir dans le menu contextuel.

3. Effectuez les modifications souhaitées.

4. Enregistrez le fichier.
Le contenu du fichier est automatiquement réactualisé dans l'ensemble des procédures qui l'utilisent.
 

Remplacement du fichier

1. Sélectionnez le fichier dans l'arborescence du volet Explorateur.

2. Affichez le volet Propriétés via le menu Vue > Propriétés.

3. Cliquez sur Replace file icon.png dans la barre d'outils.

4. Sélectionnez le nouveau fichier, via Parcourir dans la boîte de dialogue Remplacer le contenu.

4. Cliquez sur Terminer.
L'ancien fichier est automatiquement remplacé par le nouveau fichier dans l'ensemble des procédures qui l'utilisaient.

Procédures avancées

Comment consulter l'utilisation des ressources dans les procédures

Quelles ressources utilise une procédure donnée ?

1. Sélectionnez la procédure dans le volet Explorateur.

2. (Optionnel) Affichez le volet Propriétés via le menu Vue > Propriétés.

3. Cliquez sur l'onglet Utilise du volet Propriétés.
 

Quelles procédures utilisent une ressource donnée ?

1. Sélectionnez la ressource dans le volet Explorateur.

2. (Optionnel) Affichez le volet Propriétés via le menu Vue > Propriétés.

3. Cliquez sur l'onglet Utilisée par du volet Propriétés.

Comment exporter / importer des ressources entre 2 projets Self Help

Voir le pas à pas détaillé dans Self Help

Étape 1 : Export, dans une archive, des ressources du projet Self Help source

1. Sélectionnez dans l'arborescence du volet Explorateur le projet Self Help contenant les ressources.

2. Sélectionnez dans l'arborescence toutes les ressources à inclure dans l'archive, en maintenant la touche < Ctrl > enfoncée.

3. Cliquez droit sur la dernière ressource sélectionnée et sélectionnez l'option Exportez > Exportez en tant qu'archive EV Self Help dans le menu contextuel.

4. (Optionnel - Si des ressources liées sont ouvertes) Cliquez sur Oui si le message Des éditeurs associés à ce projet Self Help sont ouverts s'affiche.

5. Indiquez le nom de l'archive et son emplacement dans la boîte de dialogue Exporter un projet.
L'archive des ressources du projet Self Help source est créée.

Étape 2 : Import de l'archive des ressources dans le projet Self Help destination

1. Sélectionnez dans l'arborescence du volet Explorateur le projet Self Help destination.

2. Ouvrez l'arborescence via Tree expand icon.png.

3. Cliquez droit sur le dossier où doivent être importées les ressources et sélectionnez l'option Import dans le menu contextuel.

4. Sélectionnez l'archive contenant les ressources à importer dans la boîte de dialogue Importer des projets Self Help ou des ressources.

5. (optionnel) Sélectionnez le statut de validation des ressources.

6. Cliquez sur Terminer.
L'archive est décompressée. L'ensemble des ressources du projet Self Help source est ajoutée dans le volet Explorateur, au sein du projet Self Help destination.

Tags:
Modifié par Utilisateur inconnu le 2021/03/25 14:28
Créé par Administrator XWiki le 2018/12/14 11:21

Raccourcis

L'actualité mensuelle
•  Newsletter

Tous les changements
•  Service Manager
•  Service Apps
•  Self Help
•  Service Bots

Glossaire

Powered by XWiki ©, EasyVista 2021