sequence-sh/connectormanager

This repository is a mirror of https://gitlab.com/sequence/connectormanager

Sequence® Connector Manager

A plugins management system for Sequence and Sequence Connectors.

Connectors

All the available connectors can be found in the Connector Registry. The connector manager is set up to work with this registry by default.

Pre-release and development builds of connectors can be found in the Connector Registry Dev.

Example connectors.json

{
  "Sequence.Connectors.Nuix": {
    "id": "Sequence.Connectors.Nuix",
    "version": "0.18.0",
    "settings": {
      "exeConsolePath": "C:\\Program Files\\Nuix\\Nuix 9.0\\nuix_console.exe",
      "licencesourcetype": "dongle",
      "version": "9.0",
      "features": [
        "ANALYSIS",
        "CASE_CREATION",
        "EXPORT_ITEMS",
        "METADATA_IMPORT",
        "OCR_PROCESSING",
        "PRODUCTION_SET"
      ]
    }
  },
  "Sequence.Connectors.FileSystem": {
    "id": "Sequence.Connectors.FileSystem",
    "version": "0.18.0"
  },
  "data": {
    "id": "Sequence.Connectors.StructuredData",
    "version": "0.18.0",
    "enabled": false
  }
}

Packaging Projects as Connectors

For a nuget package to be compatible with Core, all the dependencies need to be included. To do this, add this to your csproj file:

  <PropertyGroup Condition="$(PackConnector) != ''">
    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
  </PropertyGroup>

  <Target Name="AddConnectorDependencies"
          BeforeTargets="GenerateNuspec"
          Condition="$(PackConnector) != ''">
    <ItemGroup>
      <_PackageFiles
        Include="@(RuntimeCopyLocalItems)"
        PackagePath="$(BuildOutputTargetFolder)/$(TargetFramework)/%(Filename)%(Extension)" />
    </ItemGroup>
  </Target>

Then package the connector using:

dotnet pack --configuration Release --version-suffix "-alpha.1" -p:PackConnector=true --output ./

Connector Directory Structure

Everything in these nuget package directories will be extracted to the connector's root directory, preserving any subdirectories:

• lib/net6.0/
• contentFiles/any/any/

All other files will be extracted to their respective paths.

Testing

The ConnectorRegistry is integration tested against the nuget feed of this project.

Documentation

Documentation available at https://sequence.sh

Releases

Can be downloaded from the Releases page.

NuGet Packages

Release builds are available on nuget.org.