Custom Functions With The Python Interject API

Setup

setup requires the following conditions be met:

• The Python Interject API is downloaded and all dependancies satisfied
• appconfig.py contains a name of a valid python script in the current directory for CUSTOM_MODULE
  • I.E. CUSTOM_MODULE = 'etl'
• the custom python function script contains a function that expects kwargs and returns a dataframe
• Interject Connection
  • name = user defined
  • connection type = "web api"
  • api root uri = url to your interject python server
  • api connection string name = Not Needed
  • authentication type = 10
• Interject Data Portal
  • connection = name of connection
  • command type = stored procedure name
  • Stored Procedure / Command = function name to run in CUSTOM_MODULE
  • Api Relative URI = PandasDataframeRequest or MongoDBRequest

    ### etl.py ###
    import pandas as pd
  
    def interject_custom_func(**kwargs):
        """ Custom defined function which operates on pulled data from excel
            or a data portal source before sending the data to its final destination
              
            Arguments:
                kwargs {dict} -- dictionary with options and input dataframe
  
            NOTE: - kwargs contains (dataframe, param_list)
                - expects return value to be a pandas DataFrame() 
        """
  
        d = {"column1":[1,2,3,4,5,6,7,8], "column2" : [5,4,3,2,1,5,43,7]}
        kwargs['dataframe'] = pd.DataFrame(d)
        kwargs['user_message'] = "user message to return"
        kwargs['param_list']['param1']['output_value'] = "output value"
        return kwargs
  
  

• server must be running for interject to pull data from. call using

    python main.py
  

  NOTE: the following files are required to exist in the local directory of the server

  • main.py
  • etl.py (arbitrary module name)
  • appconfig.py

Output Options

Custom functions have the ability to utilize input and output parameters as well as return user messages to Interject.

Interject request information is passed to a custom function through the kwargs function argument.