How to Create IM Instance

Aim of this article

Explains how to create a new IntegrationManager instance ("provisioned IM") from PlatformManager.

Related sections

Required permissions

Integration - Allow create/delete

Once you submit a new IM instance, you are automatically assigned also the Integration - Git Manager permission which is useful for managing users in Git.

Steps:

  1. Go to Account > Integrations.

  2. Click the New IntegrationManager button at top right.

  3. As Server Type select Create New Instance.

  4. Fill in:

    • Version – Select from available IM versions. (In Administration, you can restrict the list of IM versions which show in this drop-down menu. You can also decide whether the version would run on old hardware or new one (new form)).

      • When creating a new IM, the version selected here applies to all of the environments. 

      • When editing an existing IM, the version selected here applies only to the newly added environment.

    • Starting with IntegrationManager 2.2.0, the creation is done in Kubernetes and you have the following advanced options to define a new IM environment: 

      • Integration Name – It follows this pattern: pim-<account> which is enforced by the form: the prefix is filled in automatically, you only need to enter the account name (only lower case letters and numbers are allowed; minimum length is 3 characters, maximum is 34 characters).

      • Cloud Provider – Allows you to select hosting infrastructure from those currently supported.

      • Region – Select from available options (which depend on selected cloud provider). The value should match the location where your data runs. Currently supported region: eu.

      • Environment – Options are: dev, qa, prod, sim, staging, test, uat, poc. You can define more environments after you click the button under the table. There is no limit to the number of environments, but at least one must be present. For each environment an IM instance is created. 

      • CPU – Allows you to select the processing power for your environment. 
         Choose the value carefully please. Requesting the highest value without valid reasons may result in additional charge by Pricefx.

      • Memory – Allows you to select the memory size for your environment. 

      • Storage – Allows you to select the storage size for your environment.
         For IM instances created with the cloud provider, you can restrict the advanced sizing options CPU, Memory and Storage only to users with the Integration Instance - Admin permission. For non-admin users, sizing is taken from default values given by the imHttpClient method instanceDefaultOptions.
        Instance resources are editable later, if needed.

      • Expiration – Sets a date after which the instance will be deleted. If needed, the date can be later modified in Settings.

      • Version – Shows a version of the environment. For details on behavior, see the option Version above.

         

      • Integration Architecture Information section: Fill in which ERP/CRM system to integrate with, integration direction (inbound, outbound etc.), used technology (Camel, Groovy, Java) and the expected usage of Integration templates. This information is synced on the account level with Salesfx.

         

    • For IntegrationManager up to version 2.1.5, you have the following options to define a new IM environment:

      • Integration Name –  It follows this pattern: pim-<account>-<environment> which is enforced by the form: the prefix and suffix are filled in automatically, you only need to enter the account name (only lower case letters and numbers are allowed; minimum length is 3 characters, maximum 20).

      • Integration Type – Options are: dev, qa, prod, sim, staging, test, uat, poc.

         

  5. When you submit the request, the instance creation starts. It may take a while. Once it is ready, you will be notified by email.

The SFTP connection is created automatically with the IM instance and users are informed about it by email (containing host, port, username and password information). 

 

Infrastructure capacity for new IMs is monitored on ongoing basis. If the account is about to run out of space for new IMs, there is a notification displayed. Any requests for new IMs are kept in the pending state and they get processed as soon as more space is acquired.

In addition, there is a limit on how many IMs it is possible to create for a particular account. This limit is set by Pricefx administrators in Administration. If you need more IM instances, you need to contact Pricefx Support via helpdesk. 

 

PlatformManager version 1.75.0