2.3.0

Get Started

The Sybrin Onboarding Product can be used to implement a user onboarding journey that includes capture of all required user information. In this section we will focus on how to get the Sybrin Onboarding Product hosted and ready for use.

Before you begin

Choose your preferred hosting structure.

Please ensure that you have acquired all required license keys, endpoints and corresponding API keys from Sybrin.

Depending on the hosting environment of your choosing (considering Docker, IIS, Azure, etc...) ensure you have downloaded the necessary files or acquired the relevant container(s) that you will be using.

Hosting Structure Options

The Sybrin Onboarding Product offers two options for hosting structures:

  • The first option is to host the UI through the onboarding API. This means the UI files will be served through the onboarding backend.

  • The second option is to host the UI separately and configure it to connect to your onboarding API instance.

API Host

If you choose to use the API host structure, please ensure that you have the following essential files (you may download these files from the Demo Application section):

  • Backend API

    • All relevant DLL files

    • log4net.config

    • appsettings.release.json

    • Tenants/Default/config.release.json

    • Tenants/Default/Languages/en-us.json

    • Tenants/Default/Translations/en-us.xliff

    • Tenants/Default/Terms/en-us.html

    • Tenants/Default/Privacy/en-us.html

    • Tenants/Default/Assets/background.png

    • Tenants/Default/Assets/logo.png

    • Tenants/Default/Assets/custom.css

    • wwwroot/sybrin.onboarding.js

    • wwwroot/sybrin.onboarding.css

    • wwwroot/sybrin.common.js

    • wwwroot/index.js

    • wwwroot/index.css

    • wwwroot/assets/*

And the following optional files:

  • Backend API

    • Tenants/Default/Languages

      • A JSON metadata entry for each additional language that you would like to support

    • Tenants/Default/Translations

      • An XLIFF translation file for each additional language that you would like to support

    • Tenants/Default/Terms

      • An HTML file detailing terms and conditions in each additional language that you would like to support

    • Tenants/Default/Privacy

      • An HTML file detailing the privacy policy in each additional language that you would like to support

Separate UI

Please ensure that you have the following essential files (you may download these files from the Demo Application section):

  • Backend API

    • All relevant DLL files

    • log4net.config

    • appsettings.release.json

    • Tenants/Default/config.release.json

    • Tenants/Default/Languages/en-us.json

    • Tenants/Default/Translations/en-us.xliff

    • Tenants/Default/Terms/en-us.html

    • Tenants/Default/Privacy/en-us.html

    • Tenants/Default/Assets/background.png

    • Tenants/Default/Assets/logo.png

    • Tenants/Default/Assets/custom.css

And the following optional files:

  • Backend API

    • Tenants/Default/Languages

      • A JSON metadata entry for each additional language that you would like to support

    • Tenants/Default/Translations

      • An XLIFF translation file for each additional language that you would like to support

    • Tenants/Default/Terms

      • An HTML file detailing terms and conditions in each additional language that you would like to support

    • Tenants/Default/Privacy

      • An HTML file detailing the privacy policy in each additional language that you would like to support

In addition, you will require the following web UI files separately:

  • Web UI

    • index.css

    • index.html

    • index.js

    • sybrin.onboarding.js

    • assets/haarcascade_eye.xml

    • assets/haarcascade_frontalface_default.xml

    • index.css

    • index.html

    • index.js

    • sybrin.onboarding.css

    • sybrin.common.js

    • All files and folders under assets/samples

Backend API

You must have a DotNet-5-ready hosting environment of your choosing (such as IIS), with Redis installed, prepared beforehand.

Please ensure that you have all backend API files as listed above.

Deploy the files as a new web application on the hosting environment.

Set your appsettings configuration as desired (described in the Backend API section).

Set your tenant configuration as desired (described in the Backend API section). This is also where you will supply your license keys, endpoints and API keys.

Follow the steps required to enable the web application for hosting as per the environment of your choosing.

Web UI

If you choose the separate UI hosting structure approach, the web UI may be deployed either on the same environment where the backend API is located, or on a separate environment.

If you choose to deploy the UI on a separate environment, please ensure that it is prepared beforehand.

Please ensure that you have all web UI files as listed under the separate UI section.

Deploy the files as a new site on the hosting environment.

Set configuration options (as described in the Web UI section) as desired.

Follow steps required to enable the site for hosting as per the environment of your choosing.

Done

You are now ready and all set up to use the Sybrin Onboarding product! Check out all the Onboarding features.

Last updated