Skip to main content

How to Create a New Module/Package in the Marketplace

Prerequisites

We assume you have all prerequisites you may need, including:

  1. If needed: the VPN is configured to access the Finmars resources
  2. If needed: access to the Virtual Machine to work with the sensitive information
  3. Must have: registered in Finmars in the needed region environment (self-registered or registered by Finmars)
  4. Must have: password from the administrator for creating package/module 

Creating a New Module/Package in the Marketplace

Step 1. Add a new module or package by navigating to Configuration > Configuration > Manage. Once there, click the "Add New Configuration" button in the top right corner, as shown in the picture below.

Untitled3.png

Picture 1.  Finmars manage configuration

Step 2: After clicking the "Add New Configuration" button, a new window will appear where it's needed to fill in the required fields.

 See the example below:

  • Configuration Code: Enter the configuration code for your module. Follow the configuration pattern that is shown.
  • Name: Enter the desired module name.
  • Version: Add the version.
  • Status: Choose between "Stable" or "Release Candidate."
  • Category: Select from "General," "UI," "Pricing," or "Workflow." Choose "General" if unsure.

*** IfThe a'Is packagePrimary' orcheckbox moduleindicates needsthe toprimary receiveconfiguration. When this option is enabled, user fields andor other related entities should be retrieved from the primary configuration, check the "Is Primary" checkbox.configuration.

In the Finmars environment, packages are fundamental components that group modules to enable specific functionalities. Modules are installable components on the Finmars platform that enhance its functionalities. IfA it’sPackage is a set of modules that will be installed in ordered sequence. To create a package, check the "Is Package" checkbox. If it’s a module, leave it empty.

When clicking button "CREATE".  The manifest will be created. 

Untitled4.png

Picture 2.  Finmars configuration manager 

Step 3:  To verify if your module has been created, go to the marketplacemanage configurations and check if your package/module is created.

Untitled6.png

Picture 3.  Locally created module

Back to top