Skip to main content

How To Guide - External Form Integration

Overview​

Construct your external form utilizing standard technologies such as .NET, Java, or similar. However, it's crucial to remember that you should only use the external form activities to prevent the form from initiating the process.

Creating and executing a sample application with detailed step-by-step instructions​

Here are the step-by-step instructions with an example explaining how to integrate an external form into the IntelliBuddies Control Room:

Let's create Leave Application Management using Python and link it to the IntelliBuddies Control Room for execution.

Instructions to run a sample application​

To use the application, you first need to download it. Then, set it up on your device and run it.

  1. Install Python 3.10 and above:

    • Download and install Python from the official website: Python Downloads.
    • Check the option to add Python to your system PATH during installation.

  2. Open source code:

    Download Leave Application Example
    • Extract the above-downloaded source code and put it in a folder.
    • Open source code in VS code or any other editor you choose.

  3. Open a command prompt terminal:

    • Open a terminal in VS Code or use your system's command prompt.

  4. Run the following commands:

    • Use the following commands to install Flask for web applications.

           pip install flask

    5. Update baseurl, username, and password fields in the ibapi.py file:

  • Locate the ibapi.py file in your source code.
  • Update the baseurl, username, and password fields in the following section of the ibapi.py file.
    # Define your authorization server's endpoint and credentials
     baseurl = 'http://localhost/api' 
     authurl =baseurl+'/auth/login'
     headers = {'Content-Type': 'application/json; charset=utf-8'}
     username = 'Username'
     password = 'password'
  1. Utilize the provided BPA process example:

Download Example BPA Process
  1. Run the Flask application:

  • Start the Flask application.

         python -m flask run

  • Creates Enterprise Variable and User inside your Control Room

    • Users:  
    **Log on Creation**
    A User with the username 'manager' is successfully created in the Contro Room.
    • Enterprise variables:    
    **Log on Creation**
    An Enterprise Variable named 'LeaveMgntAppApprovalUrl' was created successfully in the Control Room.
  1. Access the application using the URL given in the terminal: