Jump to content

Guides: Difference between revisions

From Resco's Wiki
 
(51 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Guides are an optional component of the [[resco.ServicePlatform]] that allows you to create step-by-step instructions that your technicians in the field can follow to solve a problem.
{{Discontinued}}{{Guides TOC}}
'''Resco Guides''' is a workforce knowledge management software by Resco.
 
It is an optional component of [[Mobile App Development Toolkit]] that allows you to create step-by-step instructions that your technicians in the field can follow to solve a problem. If you have an existing solution that uses Woodford and Resco mobile apps, it can be added to your solution in a few clicks.
 
It is available for Microsoft Dataverse/Dynamics 365, Salesforce, and Resco Cloud backends.


{{YT|zjG4RY36VMk}}
{{YT|zjG4RY36VMk}}
Line 5: Line 10:
== Features ==
== Features ==


* '''Guides''': Step-by-step instructions that combine text content, images, videos, and PDF attachments that are related to a particular record (for example, a piece of machinery) that users of [[Resco mobile apps]] can display in their apps.
* '''Guides''': Step-by-step instructions that combine text content, images, videos, and PDF attachments that are related to a particular record (for example, a piece of machinery). Guides can be displayed in [[Resco mobile apps]] or Power Apps.
* '''Guides editor''': A web application accessible from the [[Resco_Cloud#Resco_Cloud_landing_page|Resco Cloud landing page]] and [[Dynamics]] which allows you to create, modify, and publish guides.
* '''[[Guides library]]''': A web application that allows you to create, modify, and publish guides.
* '''Feedback''': App users can rate the guides and provide feedback to the guide editors in the back office.
* '''[[Guides feedback and statistics|Feedback]]''': App users can rate the guides and provide feedback to the guide editors in the back office.
* '''Guides harvesting''': App users can quickly collect simple guides from the field (take/upload photos and add comments) if they identify missing processes. Guide editors in the back office can then standardize the guides, add proper language and associations, and then publish them to make the information available to all users in the field (knowledge decentralization from experts to the entire organization).
* '''Guides harvesting''': App users can quickly collect simple guides from the field (take/upload photos and add comments) if they identify missing processes. Guide editors in the back office can then standardize the guides, add proper language and associations, and then publish them to make the information available to all users in the field (knowledge decentralization from experts to the entire organization).
* '''[[Guides_library#Localizing_guides|Localization]]''': [[Guides_library#Localizing_guides|Guides can be localized]]. The translation can be either manual, or you can leverage cloud services for machine translation.
* '''AI generation''': [[Guides_library#AI_tools|You can generate new guides using AI.]]


== Prerequisites ==
== Prerequisites ==


* [[Resco Cloud]] – [[Releases/Spring 2022|Release 15.0 (spring 2022)]] or later
* [[Resco Cloud]] – [[Releases/Spring 2022|Release 15.0 (spring 2022)]] or later
* [[Dynamics|Microsoft Dynamics 365]] – [[Releases/Summer 2022|Release 15.1 (summer 2022)]] or later
* [[Dynamics|Dataverse/Dynamics]] – [[Releases/Summer 2022|Release 15.1 (summer 2022)]] or later
* [[Guides on Power Platform|Power Apps]] – [[Releases/Summer 2023|Release 16.1 (summer 2023)]] or later
* [[Guides on Power Platform|Power Pages]] – [[Releases/Summer 2023|Release 16.1 (summer 2023)]] or later
* [[Salesforce]] – [[Releases/Spring 2024|Release 17.1 (spring 2024)]] or later
 
== License ==
 
* Resco Guides requires Resco's ultimate license.
* If you need more information, contact us at [mailto:sales@resco.net sales@resco.net].


== Configuring in Woodford ==
== Configuring in Woodford ==
Line 28: Line 43:
# Click '''Save'''.
# Click '''Save'''.
# Optionally, click '''Add To Home''' if you want to add the Guides view as the last item on your [[home screen]].
# Optionally, click '''Add To Home''' if you want to add the Guides view as the last item on your [[home screen]].
# For manager/admin projects that should have access to the Guides Editor, click '''Add Editor To Home'''.<br>[[File:Enable Guide.png|600px]]
# For manager/admin projects that should have access to the Guides Editor, click '''Add Editor To Home'''.<br>[[File:Enable Guide.png|alt=Guides: Add Editor To Home|600px]]


;Adding guides to entity forms
;Adding guides to entity forms
Line 37: Line 52:
# Save all changes.
# Save all changes.


== Setting up Dynamics ==
== Setting up Power Platform ==


Before you can use Guides on Dynamics, you have to:
Before you can use guides on Microsoft Power Platform (Dynamics/Dataverse) , you have to:
* Install the Guides solution to your Dynamics
* Install the Guides solution to your organization.
* Create N:N entities between the Guide entity and entities that needs access to guides.
* Create N:N entities between the Guide entity and entities that need access to guides.


=== Installing the Guides solution ===
=== Installing the guides solution ===


# Download [https://woodford-download.resco.net/online/rescoguides the Guides solution file] from Resco web.
# Download [https://woodford-download.resco.net/online/rescoguides the Guides managed solution file] from Resco web.
# Log in to Dynamics as a '''system administrator'''.
# Log in to https://make.powerapps.com/ as a '''system administrator'''.
# Go to the '''Solutions''' section of your server settings.
# Select the correct environment where you want to install guides.
# Click '''Import''' and select the downloaded solution file.
# Select '''Solutions''' from the menu.
# Click '''Import solution''' and select the downloaded solution file.<br>[[File:Import-solution-into-powerapps.png|alt=Import Guides solution into powerapps|600px]]
# Finish the import wizard.
# Finish the import wizard.
# Publish all customizations.
# Wait until the import is complete. Then, click '''Publish all customizations'''.
# Reload the Dynamics webpage (often, this can be accomplished by pressing F5).


Once installed, you can find Resco Guides in the list of published apps.
The Resco Guides managed solution includes custom tables and a model-driven app "Resco Guides", designed to run on a PC. Select "Resco Guides" in the list of apps on your environment and click '''Play''' to start it. It offers the following features:
* Guides: Starts the [[Guides library]] tool for creating, editing, and managing guides.
* Categories: Allows you to view, create, and update guide categories.
* Guides: Displays the standard view for guides in model-driven apps.
* Guide Feedbacks: Displays the rating and feedback left by users.


:[[File:Resco suite app.png|300px]]
::[[File:Resco-guides-model-driven-app.png|alt=Resco Guides model driven app showcase|600px]]


=== Defining N:N relationships ===
=== Defining N:N relationships ===


On the Dynamics backend, before you can associate a guide with another entity in Woodford, you must create an N:N relationship on Dynamics.
On Dataverse, before you can associate a guide with another table in Woodford, you must create an N:N relationship.
#Go to the '''Settings > Customizations''' and click '''Customize the System'''. A new window opens.
 
#In the left panel, expand Entities and find Guide.
# Go to https://make.powerapps.com/ and select the right environment with guides installed.
#Expand Guide and click '''N: N Relationship'''.<br>[[File:N N relationship.png|600px]]  
# Select '''Tables''' from the menu and switch to '''All''' tab.
#Click '''New Many-to-Many Relationship''' and fill Other Entity information.
# Find the "Guide" table and click it.
#Click '''Save & Close'''.
# Click '''New > Relationship > Many-to-Many'''.<br>[[File:Creating-new-many-to-many-in-powerapps.png|alt=Guides: Creating new many to many relationship in powerapps]]
# Select the other table from the list, for example, "Account", if you want to link guides to the Account records.
# Click '''Done''' and wait until the relationship is created.


== Adding guide categories ==
== Adding guide categories ==
===Resco Cloud===
Guides that you create can belong to a category. To keep your guides organized, create guide categories that are suitable for your organization.
# Start the [[Admin Console]].
# Select '''Data > Manage Data'''.
# Scroll down to the Guide Category entity and open it.
# Click '''New''' and enter a category, for example, "Maintenance" or "Repair", and save it. <br> [[File:Guide category.png|400px]]


===Microsoft Dynamics===
Guides that you create can belong to a category. To keep your guides organized, create guide categories that are suitable for your organization, such as "maintenance" or "safety".
#Start Resco Guides > Categories from the left panel.  
#Click New in the tool bar and fill in the information. <br> [[File:Categories.png|600px]]
#Click Save & Close.


== Guides editor ==
=== Power Platform ===


Guides editor or library is web application for creating, updating, and publishing guides. To start the editor, log in to your organization:
# Start the Resco Guides app.
* On the [[Resco_Cloud#Resco_Cloud_landing_page|Resco Cloud landing page]], select '''Guides Editor'''.
# Select '''Categories''' from the menu.  
* On Dynamics, start to the '''Resco Guides''' app and select '''Guides'''.<br>[[File:Guides editor.png|600px]]
# Click '''New''' and enter the name of the new category, such as "Maintenance". <br> [[File:Categories.png|alt=Adding guide categories in Dataverse|600px]]
# Click '''Save & Close'''.


The editor screen offers several functions that should make your work a pleasant experience:
=== Resco Cloud===
* Filters in the left pane allow to you quickly locate what you need. You can filter guides according to their category, status, associations, authors and tags.
* '''Sort by''': Select how should the displayed guides be ordered in the top row.
* '''View as''': Switch between grid and list view.<br>[[File:Working with guides.png|300px]]


To work with a particular guide, do one of the following:
# Start the [[Admin Console]].
* select it and use the top row buttons.
# Select '''Data > Manage Data''' and enable '''Show System Entities'''.
* hover over a guide and use the buttons that appear.
# Scroll down to the Guide Category entity and open it.
# Click '''New''' and enter a category, for example, "Maintenance" or "Repair", and save it. <br> [[File:Guide category.png|alt=Adding guide categories in Admin Console|400px]]


The following functions are available:
=== Salesforce ===
* Edit
* Duplicate (clone) (not supported on Dynamics)
* Archive
* Import
* Export
* Share: Available for published guides. Displays a QR code that you can scan on your phone to open the guide. Also displays a link that you can use in the [[Questionnaire Designer]] to link the guide from a questionnaire.
* Preview
* View feedback
* Publish or unpublish


=== I don't see guides editor ===
On Salesforce, because of the [[Getting_started_with_Salesforce#Specifics_and_limitations|specifics and limitations]], the recommended way for managing Guide Categories is using the Resco Mobile CRM app. This method can be used with any backend.
 
# Edit an [[app project]] in [[Woodford]].
If you are using a [[resco.FieldService]] or [[resco.Inspections]] organization with a custom manager's landing page, there's no Guides Editor link on it by default. You can add it in the [[Guides#Configuring_in_Woodford|Guides configuration in Woodford]]: click '''Add Editor To Home'''.
# Select the "Guide Category" entity (rh_guidecategory) from the project menu.
# Create a simple [[view]] and a simple [[form]] so that you can view and edit categories in the mobile app.
# Add the entity to your [[home screen]], then save everything and publish the project.


=== Creating a new guide ===
== Guides library ==


{{Create a new Houston guide}}
Guides library or editor is a web tool for guide authors. It serves for creating and managing guides. See [[Guides library]] for details.
 
=== Using the media library ===
 
The media library within the guide editor is the place where you store files that are or can be used in a guide. The following media types are supported:
; Images
* You can edit the images directly in the media library, resizing them, cropping them, adding text or arrows, etc.
* You can also set up how to scale images.<br>[[File:Image display options.png]]
 
;PDF documents
 
;Videos
* When harvesting guides in the field, users can record video on device (limited duration)
* In the guide editor, users can embed YouTube videos and/or include local videos (limited size)
{{Note|Videos recorded on some Android devices are by default saved in the webm format. Unfortunately, iOS devices often don't support this format. As a workaround, a guides administrator can download the video from the guide using the guide editor, convert it to mp4 format using a third-party tool, then upload it back to the guide.}}
 
;Gallery
* Each guide step can contain multiple images/videos/PDF documents in a gallery. Up to 5 documents can be used. Multiple documents are not available on the cover page.


== Using guides in the app ==
== Using guides in the app ==
Line 136: Line 123:
On the '''home screen''' - all guides (if you used the '''Add To Home''' button in Guides configuration)
On the '''home screen''' - all guides (if you used the '''Add To Home''' button in Guides configuration)


:[[File:Guides on the home screen.png|600px]]
:[[File:Guides on the home screen.png|alt= Guides on the home screen showcase|600px]]


On the '''entity form''' - related guides (if you added the related guides list to the form)
On the '''entity form''' - related guides (if you added the related guides list to the form)


:[[File:Guides on a form.png|600px]]
:[[File:Guides on a form.png|alt=Guides on a form showcase|600px]]


In a '''questionnaire''' (if you [[Questionnaire_Designer#Static_components|added the guide as a static component]] of the questionnaire)
In a '''questionnaire''' (if you [[Questionnaire_Designer#Static_components|added the guide as a static component]] of the questionnaire)


:[[File:Guides from inspections.png|600px]]
:[[File:Guides from inspections.png|alt=Guides from inspections showcase|600px]]


Tap the guide that interests you to display it.
Tap the guide that interests you to display it.


:[[File:Houston9.png|200px]] [[File:Houston10.png|200px]]
:[[File:Houston9.png|alt=Guide showcase|200px]] [[File:Houston10.png|alt=Guide showcase|200px]]


== Harvesting guides from the app ==
== Harvesting guides from the app ==
{{Note|The ability to create new guides in Resco Mobile CRM was removed in [[Releases/Winter_2026|release 19.0]].}}


You can also create new draft guides:
You can also create new draft guides:
Line 157: Line 146:
# Add a title, description, steps, and photos.
# Add a title, description, steps, and photos.
# Save the guide.
# Save the guide.
# Synchronize the app to make the guide available in the Guides Editor (status = "collected").<br>[[File:Creating a new guide.png|250px]]
# Synchronize the app to make the guide available in the Guides Editor (status = "collected").<br>[[File:Creating a new guide.png|ALT=Creating a new guide showcase|250px]]


Harvesting is not supported with Salesforce.


[[Category:Woodford]]


== Guide feedback and reader count ==


[[File:Guide feedback and logging.png|thumb|right]]
Usage statistics and guide feedback can help guide editors improve the documentation. These features are configured in Woodford:
# Go to the [[Guides#Configuring_in_Woodford|Guides configuration in Woodford]].
# To enable feedback, and select '''Enable Feedback'''.
# To enable reader count, and select '''Enable Usage Logging'''.
# Save changes and publish the app project.


The information on how many times a particular guide was opened is available in the guides library:


[[File:Guides_statistics.png]]


Additionally, users can rate the guides and provide feedback to the guide editors.
[[Category:Woodford]]
 
[[File:Guide feedback.png|300px]]
 
The option to leave feedback is displayed after closing the guide preview. Users must spend at least 10 seconds in the guide to leave feedback. The minimum time spent viewing the guide can be configured in the [[Guides#Configuring_in_Woodford|Guides configuration]] ('''Time''') or in the [[Configuration#Forms|project configuration]] ('''Guide Feedback Timeout''').
 
Editors in the back office can then view user feedback in the Guide Editor and use it to improve the guides.
 
[[File:Guideeditor feedback.png|500px]]
 
== See also ==
 
* [https://www.resco.net/guides/ Product webpage]
* [https://www.resco.net/blog/tag/guides/ Blogs related to guides]

Latest revision as of 10:55, 29 September 2025

Warning This feature has been discontinued and is no longer available. If you have questions, contact your business development manager at Resco.

Resco Guides is a workforce knowledge management software by Resco.

It is an optional component of Mobile App Development Toolkit that allows you to create step-by-step instructions that your technicians in the field can follow to solve a problem. If you have an existing solution that uses Woodford and Resco mobile apps, it can be added to your solution in a few clicks.

It is available for Microsoft Dataverse/Dynamics 365, Salesforce, and Resco Cloud backends.

Features

  • Guides: Step-by-step instructions that combine text content, images, videos, and PDF attachments that are related to a particular record (for example, a piece of machinery). Guides can be displayed in Resco mobile apps or Power Apps.
  • Guides library: A web application that allows you to create, modify, and publish guides.
  • Feedback: App users can rate the guides and provide feedback to the guide editors in the back office.
  • Guides harvesting: App users can quickly collect simple guides from the field (take/upload photos and add comments) if they identify missing processes. Guide editors in the back office can then standardize the guides, add proper language and associations, and then publish them to make the information available to all users in the field (knowledge decentralization from experts to the entire organization).
  • Localization: Guides can be localized. The translation can be either manual, or you can leverage cloud services for machine translation.
  • AI generation: You can generate new guides using AI.

Prerequisites

License

  • Resco Guides requires Resco's ultimate license.
  • If you need more information, contact us at sales@resco.net.

Configuring in Woodford

Enabling guides
  1. Edit an app project in Woodford.
  2. Select Settings > Guides from the Project menu.
    1. Select Enable Guides.
    2. Select the entities for which you want to define guides. For example, if you want guides for your products, select the Product entity. You can add multiple.
      Notes:
      • Once guides are enabled for an entity, they cannot be disabled.
      • On Dynamics, you need to create an N:N entity before you can enable guides for an entity.
    3. Select Enable Feedback and set the delay after viewing a guide when a feedback form appears.
  3. Click Save.
  4. Optionally, click Add To Home if you want to add the Guides view as the last item on your home screen.
  5. For manager/admin projects that should have access to the Guides Editor, click Add Editor To Home.
    Guides: Add Editor To Home
Adding guides to entity forms
The home screen item lists all guides. Alternatively (or in addition) to the home screen button, you can add a list of related guides to an entity form. Users that display a record can then see the list of relevant guides.
  1. Edit an entity form.
  2. Click Add List and select "Guides List".
  3. Optionally, set up a filter, for example, Status Reason Equals Published.
  4. Save all changes.

Setting up Power Platform

Before you can use guides on Microsoft Power Platform (Dynamics/Dataverse) , you have to:

  • Install the Guides solution to your organization.
  • Create N:N entities between the Guide entity and entities that need access to guides.

Installing the guides solution

  1. Download the Guides managed solution file from Resco web.
  2. Log in to https://make.powerapps.com/ as a system administrator.
  3. Select the correct environment where you want to install guides.
  4. Select Solutions from the menu.
  5. Click Import solution and select the downloaded solution file.
    Import Guides solution into powerapps
  6. Finish the import wizard.
  7. Wait until the import is complete. Then, click Publish all customizations.

The Resco Guides managed solution includes custom tables and a model-driven app "Resco Guides", designed to run on a PC. Select "Resco Guides" in the list of apps on your environment and click Play to start it. It offers the following features:

  • Guides: Starts the Guides library tool for creating, editing, and managing guides.
  • Categories: Allows you to view, create, and update guide categories.
  • Guides: Displays the standard view for guides in model-driven apps.
  • Guide Feedbacks: Displays the rating and feedback left by users.
Resco Guides model driven app showcase

Defining N:N relationships

On Dataverse, before you can associate a guide with another table in Woodford, you must create an N:N relationship.

  1. Go to https://make.powerapps.com/ and select the right environment with guides installed.
  2. Select Tables from the menu and switch to All tab.
  3. Find the "Guide" table and click it.
  4. Click New > Relationship > Many-to-Many.
    Guides: Creating new many to many relationship in powerapps
  5. Select the other table from the list, for example, "Account", if you want to link guides to the Account records.
  6. Click Done and wait until the relationship is created.

Adding guide categories

Guides that you create can belong to a category. To keep your guides organized, create guide categories that are suitable for your organization, such as "maintenance" or "safety".

Power Platform

  1. Start the Resco Guides app.
  2. Select Categories from the menu.
  3. Click New and enter the name of the new category, such as "Maintenance".
    Adding guide categories in Dataverse
  4. Click Save & Close.

Resco Cloud

  1. Start the Admin Console.
  2. Select Data > Manage Data and enable Show System Entities.
  3. Scroll down to the Guide Category entity and open it.
  4. Click New and enter a category, for example, "Maintenance" or "Repair", and save it.
    Adding guide categories in Admin Console

Salesforce

On Salesforce, because of the specifics and limitations, the recommended way for managing Guide Categories is using the Resco Mobile CRM app. This method can be used with any backend.

  1. Edit an app project in Woodford.
  2. Select the "Guide Category" entity (rh_guidecategory) from the project menu.
  3. Create a simple view and a simple form so that you can view and edit categories in the mobile app.
  4. Add the entity to your home screen, then save everything and publish the project.

Guides library

Guides library or editor is a web tool for guide authors. It serves for creating and managing guides. See Guides library for details.

Using guides in the app

In the app, you can find guides in three places:

On the home screen - all guides (if you used the Add To Home button in Guides configuration)

Guides on the home screen showcase

On the entity form - related guides (if you added the related guides list to the form)

Guides on a form showcase

In a questionnaire (if you added the guide as a static component of the questionnaire)

Guides from inspections showcase

Tap the guide that interests you to display it.

Guide showcase Guide showcase

Harvesting guides from the app

Note The ability to create new guides in Resco Mobile CRM was removed in release 19.0.

You can also create new draft guides:

  1. On the home screen, tap Guides.
  2. Tap the plus button in the top right corner.
  3. Add a title, description, steps, and photos.
  4. Save the guide.
  5. Synchronize the app to make the guide available in the Guides Editor (status = "collected").
    ALT=Creating a new guide showcase

Harvesting is not supported with Salesforce.