How to use the documentation system
This topic describes how to get the best out of our documentation system, with tips on how to search, navigate, and access PDF content.
For details about how to access help and documentation from the Blue Prism interface, see In-product help.
Access the online help from the Blue Prism user interface
To help you understand and use Blue Prism, an online help system is available. The easiest way to access the help system is to press F1 from anywhere in the Blue Prism client. The online help will open at the help topic relevant to the area of Blue Prism you are currently viewing.
More options are available from the Blue Prism help menu:
- Show Help Topic – The same action as pressing F1 – displays the help topic relevant to the current screen or dialog.
- Open Product Help – Opens the help at the home page.
- Acknowledgments – Provides access to details of the third-party software that is included in Blue Prism with associated license information.
- Guided Tour – View a short tutorial to get you started with Blue Prism.
- API Documentation – Access the documentation for the installed visual business objects.
- Request Support – Access the fault reporting topic and to find out how customers with appropriate support packages can contact us.
- About – View our copyright information and check which version of Blue Prism and .NET framework is installed.
Select the right help version
Help systems are provided for each product version and in the languages supported by the individual products.
You can view all the help systems that are available by clicking the link at the bottom of the table of contents menu panel that takes you to the help home page.
Change the product version
Our help systems are updated for each new release and a new version is created for every major and minor release, for example Blue Prism versions 6.9, 6.10, and 7.0 all have dedicated help systems.
To select the help project for a different version, click the Select version drop-down and select the required version.
If the page you are viewing is not available in a selected version, this message displays when you attempt to change the version:
This often means that the page was only introduced in the version you are currently looking at – perhaps it is a new feature or you were viewing the release notes for the latest release. If you still want to select a different version, view a different page, such as the help home page, and then change the version.
Change the language
To display the help in a different language, click the language button and select the required language.
This button is only available on help systems that have multiple languages available. If you cannot see this button, the help is only available in English.
Search the help
To find information in the help system, enter text in the search field in the help header and press Enter or click the search button.
You can search from any topic in the help system.
Search for keywords, such as runtime resource rather than questions or sentences. The search returns all topics that include the keywords and each keyword is highlighted when a topic is accessed from the search results. If a matching result is found in drop-down text, the drop-down is automatically expanded when the page is accessed.
To make a topic easier to read, click the remove highlight button on the topic toolbar.
Navigate the help system
The easiest way to find what you're looking for is to search the help as described above. However, there are a number of other navigation methods to help you to access the content you require and navigate through the system.
Table of contents
Select the required topic from the table of contents menu on the left side of the help.
The topic displays. The example below shows that:
- The topic is highlighted in the table of contents. This topic is contained under a parent topic, which is expanded providing access to other related topics in this section.
- A mini table of contents displays to the right side of the topic. This displays the top-level sections in the topic. Click on a section title to jump to that area of the topic.
If you have reduced your browser window width, the table of contents is accessed from a menu icon in the top corner of the screen.
The mini table of contents is not available in this view. A toolbar with navigation controls appropriate to mobile devices and other smaller screens displays at the bottom of the page in this view.
Move back and forward through topics in the order they are listed in the table of contents.
View the PDF guide
To give you the flexibility to choose how you access our information, we make much of our content available in both HTML and PDF formats.
If the help topic is included in a PDF guide, you will see the PDF button on the toolbar. Click this to open the PDF in a new tab. Once opened, you can download and save the PDF locally so you can access the content when you need it.
Print and save content
Send topics to a printer or save them as a PDF – click the print button and select the required printer or save location.
Printouts and generated PDFs are a reflection of the screen at the time of printing – drop-down text must be visible to be included in the printout.
Click the expand all button to display all drop-down text and include in the saved or printed output.
If a topic forms part of a PDF guide, you can also download the whole guide by clicking the button on the toolbar.
We are always interested to receive your feedback or comments regarding our help and how we can improve it for you. If you can't find the information you need, or if you notice something that is incorrect or that could be explained better, click the email button and drop us a message.
Please note, if you are requiring product support, please contact the Support Team direct. For details about how to raise Support tickets, see our knowledge base.
Use the help system offline
If you are unable to access the internet or want to provide the help via an internal system, shared drive, or on individual machines, the help files can be downloaded and made accessible by specifying the location in Blue Prism's system settings.
- Download the help files from the Blue Prism customer portal.
- Extract the help from the ZIP file to the required location. The help can be hosted on an internal network, a shared directory, or placed in a folder on a local machine.
- In the Blue Prism interactive client, click the System tab and select System > Settings.
In the Offline Help section, select the check box and enter the URL or folder location of the parent directory of the help files.
The help files in the specified location are now accessed when the help in called from the Blue Prism user interface.
To revert back to using the server-based help, deselect Enable Online Help.
Troubleshooting the help
A help site is not available and a Not Found message displays
This can happen when we are publishing a help site. Depending on the size of the help site, publishing can take up to 10 minutes during which time all help pages for that help system will not be available and such a message will display in your browser.
If you cannot access one of our help sites, please go to our home page and select another version of the help for the product. Although there will be differences between versions, much of the information you seek will be available.
If the issue persists, please contact us at [email protected].
Page is not available
The following message displays when changing the version or language of the help system you are viewing and the current page does not exist in the version you have selected:
This often means that the page was only introduced in the version you are currently looking at – perhaps it is a new feature or you were viewing the release notes for the latest release. If you still want to access a different version, view a different page, such as the help home page, and then change the version or language.
There are display issues with the help site I am trying to view
After we publish a new version of a help system, particularly if there have been changes to the design, you may notice some anomalies with the display, such as the table of contents area being blank or some of the images not displaying. This can happen when the files are being overwritten on our server. These issues are normally fixed by refreshing your browser or clearing your cache by pressing CTRL + F5.
The search hangs and no results are returned
Occasionally when searching one of the help systems, something goes wrong and the progress icon displays continuously and the search does not complete. Again, this usually happens following a re‑publish and is normally fixed by refreshing your browser or clearing your cache by pressing CTRL + F5.
I keep getting asked to confirm I'm human
To ensure we keep our systems safe and to prevent them being spammed, we check for unusual activity on our help systems. This means that you may occasionally be asked to enter some characters to prove you are not a bot.
I want to know when a help system has been updated and what has changed
At the bottom of each of our help site pages is a Help last updated link. This shows you the date the current version of the help was published and if you click the link, it will take you to a summary of the changes in that version.