How to Generate a Connector ZIP Package

First published on: 04/24/2024/9:41 am

 

 

1. Create a zip file with the connector ID you defined in the ConnectorInfo.cs, like the highlighted text in the given example:

  • [Connector("Connector.Integration.OEM", "OEM Widgets Connector", "Powered by Saltbox, OEM Widgets Connector supports OEM Integrations, including Inbound and Outbound transactions. Visit help.saltbox.io for a full list of supported document types.")]

 

2. Create a folder with the same connector ID 

  • “Connector.Integration.OEM”

 

3. Navigate to the above folder and place the main connector DLL (Connector.Integration.OEM.dll), icons, and spec file (connector.spec) in the root of the folder.

 

4. Create a “libs” folder and place all external/3rd-party DLLs inside this folder.

  • Don't include “Vision33.Integration.Connector.Dependencies.dll” as it’s provided by the platform.

 

5. Connector zip file structure

                Connector.Integration.OEM.zip

                        Connector.Integration.OEM

                               libs

                               connector.spec

                               Connector.Integration.OEM.dll

                               [all icons]

 

How to Generate the Connector Spec file

 

1. Extract the SpecGenerator zip file to the folder “SpecGenerator”.

 

2. Open a command prompt and navigate to the extracted folder.

 

3. Run the following command:

 

  • Connector.Spec.Generator -v [versionNumber] -c [connectoreDllPath] -e [specFileOutPutPath]

 

4. It will generate the connector.spec file in the folder you specified in the above command.

 

5. Copy that file into the connector zip package as defined in step 3.

 

SpecGenerator is available to partners upon request.

 

-