In-product help

This topic describes the options available in Blue Prism for getting help and accessing documentation.

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.

Application Manager help

Application Manager has its own help page, accessible from the Blue Prism interface. It lists Blue Prism actions and conditions, application types and elements, also detailing the compatibility and relationships between each, where appropriate.

The help page displays in a browser window and is accessible in two ways:

  • In Object Studio, select Help > View AMI Documentation.
  • In the properties of stages where actions can be configured (Read, Write, and Navigate), click the information icon.

The Application Manager help page is split into the following sections:

  • Actions – Details of each action, any association parameters, and the compatible element types.
  • Conditions – Details of each condition and the compatible element types.
  • Element Types – Details of each element type and the compatible actions and conditions.
  • Application Types – Details of the application types that can be used with the Application Modeller.

Visual Business Object (VBO) API documentation

Our internal and external business objects have built-in documentation to help you understand and use them successfully. The documentation lists all elements of a business object, specifying any preconditions and details of each parameter.

The VBO documentation is available from the main help menu and from the help menu in Process and Object Studio. Select API Documentation and choose the required VBO from the Visual Business Objects drop-down list to display the associated help page.

Tooltips

Blue Prism uses tooltips to provide additional information about the user interface. Hover over a button or area of the interface with your pointer and the appropriate tip displays.