Requirements and Installation

Requirements

• Python 3.10.x minimum
• Python library: Several Python packages are necessary (they are all listed here), to install them just execute the command below

pip install -r requirements.txt

• To use this API it's mandatory to configure correctly the BPPI repository first: BPPI Configuration
• For the ODBC Connectivity and Blue Prism Connectivity an ODBC Connection string and a User/password is necessary to query the data base. Only Read access privileges on the needed tables are mandatory.
• For the Blue Prism Connectivity, the read only access is required for these Tables:
  • BPASession
  • BPAResource
  • BPASessionLog_NonUnicode or BPASessionLog_Unicode
• For the SAP connectivity. The RFC SDK (NWRFCSDK) must be installed and the pyrfc package deployed as well.
• The configuration file config.ini-template is mandatory for ODBC and Blue Prism Connection. When the data source is a CSV file all needed parameters are passed through the command line.

Installation

By using pyPI

1. Install Python 3.10.x if needed
2. Open a command line and install the bridge via pip

$ pip install pyBPPIBridge

Note: visit the pyPI website here

3. run the bridge by typing in the command line the bppibridge entry point: Example:

$ bppibridge -sourcetype csv -configfile /home/benoit/git/pyBPPIBridge/config.ini -filename /home/benoit/git/pyBPPIBridge/tests/test.csv

Download from Github

1. Install Python 3.10.x if needed
2. Download and Copy the pyBPPIBridge file into the destination folder (dowload the latest release from Github ). and unzip the content in your chosen directory (for example C:\pyBPPIBridge)
3. Open a command line and go into the new folder, for example:

$ C:\pyBPPIBridge

5. Verify pip is well installed by launching pip in the command line:

$ pip

The pip help should appear 6) Install or update the requested python libraries via the command line:

$ pip install -r requirements.txt

7. Create a BPPI Configuration and get an access token from your BPPI Server

8. According to the datasource, create the right Data Source configuration file

9. Now you can run the Bridge via the command line by using the sample bppiBridge.py.

You can also customize the way you need to call the Bridge. You need to first get the configuration (from the command line and the INI config file), then you just run the Bridge by using the pipelineFactory class like below:

import argparse
from pipelines.pipelineFactory import pipelineFactory
from utils.configuration import configuration

if __name__ == "__main__":
	# Get configuration from cmdline & ini file
	config, src = configuration.fromCmdLine(argparse.ArgumentParser())
	# Process 
	pipelineFactory(src, config).createAndExecute()