Skip to content

Blue Prism api

Jump to bottom
datacorner edited this page Jun 26, 2023 · 2 revisions

The purpose of this page is to describe how to Gather the Blue Prism logs by using the Blue Prism APIs. Of course the Blue Prism API must be deployed and you also need to get some API informations (ID, secret, etc.).

Characteristics

These are some characteristics of this bridge:

  • Gather logs from a selected Blue Prism process (use the processname parameter)
  • can collect the high level log data (not the variables)
  • Include all then logs (from thr Process and the VBOs)

Execute (from Command line)

  • -sourcetype (Mandatory) bpapi
  • -configfile (Mandatory) Config file with all configuration details (INI format) / must follow the INI format rules. Example/Template -> See the config.ini-template (rename it as an .ini file)

Example

Launch the program in the shell (windows or linux) command line like this:

$ python3 bppibridge.py -sourcetype bpapi -configfile {config.ini}

Pre-Requisites

This bridges leverages the Blue Prism API. It works only from the version 7.x and thoes API must be installed and configured properly. An ID and Secret (from the Blue Prism Hub) must also be provided to get access to them. Moreover, 2 URLs are necessary:

  • The Authentication server URL (the one which checks the access and provide a security token)
  • The API URL

BPPI

It's mandatory to create a Data Source in the BPPI Repository. At the end of this processus, BPPI provides a token needed for the configuration file.

See § [BPPI Configuration](BPPI Configuration.md)

The configuration file (ini)

Before using the bridge it's mandatory to create a configuration file. This configuration files is at the INI format (with sections and entries). Several entries are necessary:

Section blueprism

  • processname must contains the Blue Prism Process name
[blueprism]
processname=Load Customers Queue

Section blueprismapi

  • ssl_verification if yes each API call checks the SSL Certificate
  • client_id Blue Prism Hub client ID
  • client_secret Blue Prism Hub client Secret
  • auth_url Blue Prism Authentication server URL (without the slash at the end)
  • api_url Blue Prism API URL (without the slash at the end)
  • api_page_size Blue Prism API Page size (for returnning list of results)
# Verify the SSL Certificate when calling API
ssl_verification=no
client_id = bpapi
client_secret = ***
auth_url = https://authentication.local
api_url=https://bpapi.local
api_page_size=300

BPPI Access

See the BPPI Configuration chapter

Log configuration

See the BPPI Configuration chapter

Clone this wiki locally