Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Align
aligncenter




Contact Us

(info)  Our SDK repository is not publicly available, please contact us for more information.

Platform Extensions Overview

The SkySync Platform allows users to connect to on-premise and cloud storage platforms and orchestrate the content contained within those platforms. Out of the box, this includes migration and synchronization of content between platforms as well as any related metadata and permissions. However, the platform was never intended to solve every problem or connect to every storage platform out of the box. As such, the platform allows customers and extension developers to extend it in a number of ways to better suit their needs. Examples include:

  • Adding a custom connector that allows SkySync to connect to on-premise or cloud storage platforms that are not provided out of the box.
  • Adding a custom transfer extension that transforms content (i.e. converting Word documents to PDF) during an on-going migration job.
  • Integrating a 3rd party document classification engine that enhances custom metadata (i.e. extract invoice numbers and customer names from documents) attached to documents during an on-going migration job.
  • Adding a custom ReST service that exposes SkySync data rolled up in a different manner or data generated from a custom transfer extension.




Installation and Configuration

SDK Prerequisites

  1. .Net Core SDK (currently using latest 3.0 release)
  2. .Net IDE of choice (SkySync recommends JetBrains Rider or VS Code)


Getting access to the SkySync SDK packages 

  1. Create an account on MyGet (https://www.myget.org/Account/Login).
  2. Obtain an API key from our private skysync-vnext NuGet repository (https://www.myget.org/feed/Details/skysync-vnext, under the heading API key).
    1. If you do not have access to the skysync-vnext repository, please send an email to contact us to request access.
  3. Edit %APPDATA%\NuGet\Nuget.config. Add the following within the <configuration> block, replacing %MYGET_AUTH_TOKEN% with the API key.

    Code Block
      <packageSources>
        <add key="SkySyncSdk" value="https://www.myget.org/F/skysync-vnext/auth/%MYGET_AUTH_TOKEN%/api/v3/index.json" />
      </packageSources>



Info
titleNote

you may need to add only <add key="..." value="..." /> if a <packageSources> block is already in the <configuration> block.


Getting access to the SkySync SDK samples

  1. Fork the skysync-sdk repo and clone it locally (e.g. git clone git@github.com:youraccount/skysync-sdk.git)

    Panel
    bgColor#FFFFF0

    https://github.com/portalarchitects/skysync-sdk

    Note: This repository is not publicly available. Please contact us for more information


    All of the samples contained within should include instructions on how to build and test but the basic flow is to run dotnet build or dotnet test from a terminal window.