Skip to main content
Skip table of contents

Installation

Follow the steps below to install the AveriSource Platform™. Refer to the Prerequisites section before proceeding with the installation.

Initialization

  1. Download the AveriSourcePlatform.exe from the FTP site provided by AveriSource.

    image-20240209-061047.png

  2. Once downloaded, run the .exe file as an administrator. (Note: Ensure admin privileges are available on the system where the AveriSource Platform will be installed.)

    image-20240503-162327.png

  3. AveriSourcePlatform.exe will launch the Prerequisites Setup Wizard. Click Next to continue.

    image-20240503-161902.png

  4. Continue with the Prerequisites selected by default.

    image-20240503-161755.png

  5. Continue with Microsoft .Net Core Windows Server Hosting. Click Install.

    image-20240209-061202.png

  6. Continue with the Prerequisite's installation. It may take a few minutes.

    image-20240209-061247.png

    image-20240503-162642.png

  7. When the AveriSource Platform installation is complete, it will automatically open the platform web UI in your default web browser.

    image-20240209-061324.png

  8. Click the Generate Request link in grey to generate a new license request. On the next screen, enter the organization name in the text box provided and click the Generate Request button.

    image-20240209-061411.png

  9. This will generate a new license request file with an .avsreq extension, found in the Downloads folder by default. You can download the request file using the Download Request button and email it to hello@averisource.com. Then click the Back to License Selection button.

    image-20240209-061446.png

  10. The AveriSource team will use the request file to generate a new license and send it back to the user.

  11. Once the license file is imported, the next step is to configure the database that will be used by the AveriSource Platform.

    image-20240209-061544.png

  12. Provide the SQL Server Name and proceed for further validation.

    image-20240209-061804.png

  13. Once the connection is established to the database, the next step is to configure your preferred SMTP server. There are two options available, the SendGrid service or leverage your own internal SMTP server. The SendGrid option requires your network to allow outbound SMTP traffic from the AveriSource Platform.

    image-20240710-165004.png


    image-20240710-165036.png


  14. After configuring the SMTP server, the next step is to create an Org Admin, the organization administrator account and profile.

    If using the AveriSource Platform 2.0, the installer will proceed to set up local user management. Choose Create Account to proceed.

    image-20240209-061844.png


    If using the AveriSource Platform 2.1 release, Windows Authentication has been added as an authentication type. Click Choose Authentication Type to proceed.

    image-20240503-172343.png

    The Windows Authentication option allows the use of Active Directory credentials thereby eliminating the task of managing users locally. The second option is to create and manage users local to the AveriSource platform. 

     

    Screenshot 2024-05-06 at 11.09.41 AM.png

Local User Management

With local user management, administrators can create, manage, and authenticate users directly with the AveriSource Platform. Follow the steps below to set up local user management.

1. The Org Admin profile requires a valid email address and a password that meets all the criteria.

image-20240209-061909.png

  1. With successful account creation, the AveriSource Platform user interface, specifically the Organization Dashboard, is launched to begin creating projects.

image-20240209-061934.png

  1. Org Admins can now create projects by adding the relevant application source and start building an AveriSource Inventory within the Organization Dashboard.

image-20240209-062004.png

Adding users with local user management 

  1. To add users to the AveriSource Platform with Local User Management, the Org Admin can click the Invite New User button under the Team menu under Organization Dashboard. 

unknown-16010101-000000.png

  1. The details of the invited user including email, company name and user type are provided. Click Invite User and the new user will be invited via an email link. 

    unknown-16010101-000000.png

  2. Once the new user is setup, access to further projects in the AveriSource platform can be edited by clicking on Edit User. 

    unknown-16010101-000000.png

  3. Select the User Type for each available project.

    unknown-16010101-000000.png

Windows Authentication

Starting with the AveriSource Platform 2.1, Windows Authentication has been added to simplify user management using Active Directory. As part of the 2.2.1 release, users are now able to configure the AveriSource Platform for an external Active Directory. This provides the ability to associate users from an external Active Directory rather than the Active Directory configured to the server where the AveriSource Platform is installed. Follow the steps below to configure Windows Authentication. 

  1. Choose Windows Authentication and click on “Configure Active Directory.” 

    image-20240726-154717.png

  1. In the following screen, you will be asked to provide the Active Directory details including the account to authenticate with the Active Directory. After supplying the required information, click on “Confirm Configuration.” 

    image-20240726-154751.png


  1. Upon a successful configuration, you can now link an initial account from the configured Active Directory instance. To do so, click on “Link Account.” 

    image-20240726-154840.png

  2. In the following screen, you will be asked to login with a Windows account. This initial login should be done with the user information who will be an OrgAdmin on the AveriSource Platform. To proceed, provide the username and password for this user and click “Login with Windows Account.” 

    image-20240726-154954.png

Note: Now that the users are created with Active Directory authentication, the AveriSource Org Admin will not have a role to play with user settings/management. This is evident from the screenshot below, which does not display “User Settings” as an option. Also, there will be no “PIN” column under Team Management. The role of the Org Admin in this case is now restricted to inviting other users to the AveriSource platform with relevant role.

image-20240503-180213.png

image-20240503-180229.png

Adding users with Windows Authentication 

Follow these steps to add users to the AveriSource Platform with Windows Authentication.

  1. The Org Admin invites new users to access the AveriSource Platform from the Organization Dashboard -> Team –>Invite User.

image-20240503-183341.png

  1. The Org Admin can now specify the User Type as “User” which lets the user log in with his Windows Active Directory credentials.

image-20240726-180949.png

  1. The new user gets a link to connect via email to the AveriSource platform. The user can choose to login with their Windows account as shown below.

image-20240726-181408.png

If the user doesn’t have access, they are prompted with the screen below and they may request access.

image-20240503-183551.png

  1. When the administrator approves the access request, the user will receive an email. The user needs to click on the link in the email and then enter Active Directory credentials on the login screen. On the next screen, the user will click on the Associate Account button to login to the AveriSource platform.

image-20240503-183620.png

Note: Because Windows Authentication stores credentials in the browser, the user must close the browser after logging out. We recommend using a separate browser profile for the AveriSource Platform to avoid having to close unrelated browser tabs after logging out.

image-20240503-183647.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close