UDF Configure#

Overview#

UDF Configure is the first step that you need to decide before using user defined functions (UDFs). Basically, the user needs to specify the path location of the Python file from which the user-defined function is imported. If you already have an existing Python file that you want to import functions from it, you need to select the second option in the radio button. Whereas, if you want to insert a starter Python file which includes some of our example functions, you need to select the first option in the radio button. More details will be explained in the next part.

Examples#

Example 1: Insert a Starter Python file#

Here is a step-by-step introduction to insert a starter Python file to import user-defined function in Finplicity.

  1. Click “select project” button to open project manager. In the project manager, open an existing project or create a new project. See more in Project Manager

  2. Open Finplicity, and then click User Defined Functions > Configure. The form of UDF Configure will appear, as shown below.

  3. Select “Select a folder within the current project folder in which to place a starter python file (udf_external.py). This file will be the External UDF associated with the current project, which you change later using the next option.”

  4. Click “Browse” button to open file dialog. And use file dialog to select a folder location. Please note that you can only select a folder location within the current project folder. When you finish selecting the folder location, you can see the relative path in the text box. In this example, we created a folder name as “Udf_select_example” under current project folder.

  5. Click “Set” button to set the user-defined function file path. A successful message will pop up at the top of the form. And a starter Python file will be inserted into the folder location that you set. Now you can click User Defined Functions > Python Editor to write more user-defined functions or click User Defined Functions > Call to use the current functions (See UDF Call).

Example 2: Select an Existing File#

Here is a step-by-step introduction to select an existing Python file to import user-defined function in Finplicity.

  1. Click “select project” button to open project manager. In the project manager, open an existing project or create a new project. See more in Project Manager

  2. Open Finplicity, and then click User Defined Functions > Configure. The form of UDF select will appear, as shown below.

  3. Select “Select an existing Python file as the External UDF associated with the current project.”

  4. Click “Browse” button to open file dialog. And use file dialog to select a file location. Please move your existing Python file to the current project folder in advance. Because you can only select a file within the current project folder. When you finish selecting the file location, you can see the relative path in the text box. In this example, we move a Python file name as “Udf_custom” under current project folder.

  5. Click “Set” button to set the user-defined function file path. A successful message will pop up at the top of the form. Now you can click User Defined Functions > Python Editor to write more user-defined functions or click User Defined Functions > New Task to use the current functions (See UDF Call).

FAQ#

  • Can I use User Defined Functions without opening a project ?

No. All User Defined Functions can only be used when you open a project.

  • Can I set multiple Python file locations ?

No. One project can only be associated with one Python file at a time. But you can use User Defined Functions > Configure to switch to another Python file anytime.