Partners Portal Manual

This document includes the Partners Portal overview and a description of the main menu items.

Introduction

To enter Partners Portal:

  • Open the https://incoresoft.com website
  • Click the Personal Account button in the upper-right corner 
  • Enter login and password received from the IncoreSoft team member
  • Click the Log In button to open the Partners Portal

Usability and Functionality

The Partners Portal interface contains:

  1. Profile Menu to:
    • See the username and partner's status
    • Change account settings by clicking the Personal Information button
    • Change the interface language by selecting the required language from the drop-down list
    • Click the Exit button to log out of the Partners Portal
  2. Main Menu to choose from the following items:
    • Personal Information
    • Users
    • Partners
    • Projects
    • Licenses
    • Calculator
    • Documentation
    • Installation Files
    • Study
    • Knowledge Base
    • Help Desk
  3. Info Box with:
    • IncoreSoft Company's support email address
    • IncoreSoft Company's social networks links
Partners Portal opens with the Projects item by default.

Partners have different access rights in the Main Menu depending on their status:

  • Distributors have access to all menu items
  • Resellers have access to all menu items, except Licenses
  • Technology Partners have access only to:
    • Personal Information
    • Calculator
    • Documentation
    • Installation Files
    • Knowledge Base
    • Help Desk
  • Clients have access only to:
    • Personal Information
    • Calculator
    • Documentation
    • Installation Files

Personal Information

To change the account settings, select the Personal Information item in the Main Menu:

The item includes 3 tabs:

  • Profile to:
    1. Click the Upload Logo button to set the company's logo
    2. Change contact information in the Contact Name and Phone fields
    3. Click the Edit button to apply changes
  • Password to:
    1. Fill in the required fields to set the new password
    2. Click the Change Password button to apply changes
  • Language to:
    1. Select the desired interface language from the drop-down list
    2. Click the Save button to apply changes
The selected tab is always highlighted.

Users

To manage users, select the Users item in the Main Menu:

To add a new user, click the Add User button:

In the Add User pop-up window:

  • Step 1:
    1. Fill in the required fields
    2. Click the Next button
  • Step 2:
    1. Check the boxes next to the required categories in order to assign access rights
    2. Click the arrows next to each category to open more options
    3. Select the Create button
  • List of created users with their ID, name, email, and status is displayed in the table.
  • Status toggle shows the user access allowed (green) or denied (grey). Click the toggle to change the status.

To edit the required user parameters, click the Edit icon:

In the Edit User pop-up window:

  • Step 1:
    1. Change information in the required fields
    2. Click the Next button
  • Step 2:
    1. Check the boxes next to the required categories in order to assign access rights
    2. Click the arrows next to each category to open more options
    3. Select the Save button to apply changes

Partners

To manage partners, select the Partners item in the Main Menu:

The Partners functional menu allows to:

  • Enter the partner company name, or characters in the name to filter partner companies
  • Select the partner company registration country
  • Select the required partner company status
  • Click the Search button to start filtering
The status options include All, Reseller, and Client.

See the list of partner companies in the table below. It contains:

  • Partner company ID
  • Partner company name and country of registration
  • Name of the distributor to which the partner company belongs
  • Partner company status
  • Partner company registration date in the system
  • Toolbox includes:
    • View the icon to see the information about the required partner company
    • View the Projects icon to see only selected partner company projects
    • Edit icon to change the information about the required partner company
Click the arrow next to the required partner company name to open the list of clients, who belong to the selected partner company.

To add a new partner company, click the Create Partner Company button:

In the Create Partner Company pop-up window:

  • Step 1:
    1. Fill in the required fields
    2. Type a comment about the new partner company
    3. Click the Next button
  • Step 2:
    1. Enter new login and password for the partner company's account
    2. Enter partner company contact person's full name and phone number
    3. Click the Create button

Projects

To manage projects, select the Projects item in the Main Menu:

The Projects functional menu allows to:

  • Enter the project name or characters in the name to filter projects
  • Select the solution for the project from the drop-down list
  • Set the maximum budget for the projects
  • Set the time frame the project was created
  • Select the project implementation date (year and quarter) from the drop-down list
  • Click the Search button to start filtering

See the list of projects in the table below. It contains:

  • Project name, location, and description
  • Number of active licenses
  • Project creator's name
  • Date the project was created
  • List of planned licenses
  • Toolbox comprises:
    • View the icon to see the information about the required project
    • Edit icon to change the required project parameters
    • Add License icon to add licenses for the selected project
    • Send on the Registration button to receive project confirmation from the vendor
  • Submitted projects have different confirmation statuses: Pending Confirmation, Confirmed and Rejected. Hover the mouse over the Info icon next to the project's name to determine the actual confirmation status.
  • Project confirmation takes some time. Wait while the vendor confirms the project.

To add a new project, click the Create Project button:

In the Create Project pop-up window:

  • Step 1:
    1. Fill in the required fields
    2. Select the solution for the project from the drop-down list
    3. Click the Next button
  • Step 2:
    1. Select the reseller partner company from the drop-down list
    2. Click the Next button
  • Step 3:
    1. Select the Create a Client option (if necessary):
      • Fill in the required fields to create a new client partner company
      • Click the Create button
    2. Select the client partner company from the drop-down list
    3. Click the Next button
  • Step 4:
    1. Set the budget for the new project
    2. Select the project implementation date (year and quarter)
    3. Click the Save button

Licenses

To manage licenses, select the Licenses item in the Main Menu:

The Licenses functional menu allows to:

  • Move among the main tabs All, Real, and Test Licenses to filter licenses by type
  • Enter the license key or characters in the license key to go through the search faster
  • Set the time frame the license was created
  • Select the connected client partner company from the drop-down list
  • Select the license payment status from the drop-down list
  • Click the Search button to start filtering
The Payment Status options include All, Paid, and Unpaid.

See the list of licenses in the table below. It contains:

  • License key and several additional informational options:
    • Orange Test License icon to visually distinguish test licenses in the general list
    • Copy the License Key icon to click and copy the required license key to the clipboard
    • Info icon to view the license status
  • Name of the project to which the license applies
  • Name of the distributor who created the license
  • Name of the client partner company for which the license was created
  • List of included modules
  • Date of:
    • License creation
    • License payment
    • Actual license payment
  • Toolbox comprises:
    • View the icon to see the information about the selected license
    • Edit icon to change the required license parameters (only for test licenses)
    • Extra options include:
      • Download Certificate
      • Receive Certificate by Email
      • Enter Payment Date
      • Download Invoice
      • Add Invoice
      • Offline Activation
      • Offline Deactivation
      • License Cancellation
  • Enter Payment Date, Download Invoice, and Add Invoice extra options are available only for real licenses.
  • License Cancellation extra option is available only for test licenses.

To add a new license, click the Create License button:

In the Add License pop-up window:

  • Step 1:
    1. Select the required module from the drop-down list
    2. Set the number of cameras for the selected module
    3. Click the Add License button to apply the settings
    4. Click the Next button
  • Step 2:
    1. Set the license validity period:
      • In days for the Number of Days option
      • Until the selected date for the Expiration Date option
    2. Type a comment
    3. Click the Create button
To get the test license creation access rights, previously contact the vendor.

Calculator

To calculate the required hardware parameters, select the Calculator item in the Main Menu:

To perform the calculation:

  1. Select the analytics type:
    • Server
    • Desktop
  2. Click the Hardware block and check the boxes next to the required CPU and GPU hardware options
  3. Select the analytics modules from the drop-down list and set other parameters as required:
    • Number of cameras
    • CPU/GPU hardware acceleration
    • Codec
    • Resolution
    • FPS
  4. Click the Add Module button to select more analytics modules
  5. Click the Delete icon to delete the selected module
  6. Click the Create button to start the calculation
  7. Click the Reset button to clear the parameters
  8. Select the Export PDF button to download the calculation report

Documentation

 To access the VEZHA documentation and accompanying materials, select the Documentation item in the Main Menu:

The VEZHA documentation includes:

  • Technical Documentation comprises:
    • Specifications block with product specifications for all VEZHA system plugins
    • Camera Installation Guidelines block with important camera installation recommendations for some plugins
    • VEZHA Analytics System Installation Guide for Windows
    • VEZHA Analytics System Installation Guide for Linux
    • VEZHA Analytics System Architecture Guide
  • User Manual comprises:
    • Quick Start Guide
    • Plugins User Manual block with User Guides for all VEZHA system plugins
    • Integrations block with User Guides for integrated VEZHA plugins
  • Partners Documentation comprises:
    • Presentation
    • White Papers
    • EULA
    • Prices
  • Partners Portal Manual

Installation Files

To access the VEZHA software installation files, select the Installation Files item in the Main Menu:

The VEZHA installation files include:

  • Server Analytics block with VEZHA Analytics System installation files for Windows and Linux
  • Edge block with VEZHA Edge software installation files
  • Integrations/Plugins block with installation files for integrated VEZHA plugins

Study

To learn IncoreSoft VEZHA courses, select the Study item in the Main Menu:

To start learning, select the desired course. On the selected course page:

  1. Find out about the opportunities that the course provides in the About Course tab
  2. Open and study course video lectures in the Content tab
  3. Pass the Certification Exam and obtain a specialist certificate in the Examination tab

Knowledge Base

To read the IncoreSoft VEZHA system guides, select the Knowledge Base item in the Main Menu:

The Knowledge Base menu comprises:

  • Installation Manual
  • Quick Start Guide
  • User Manual

Help Desk

To contact the IncoreSoft support for a specific request, select the Help Desk item in the Main Menu:

The Help Desk request menu comprises:

  • Technical Support
  • Licensing and Billing Questions
  • Other Questions
  • Report a Bug
  • Suggest a New Feature
  • Suggest Improvement
  • Hardware Requirements

To send the request select the desired category. In the pop-up window:

  1. Fill in the required fields
  2. Attach images if necessary
  3. Click the Create button