.. _index-voss-core:

VOSS Core Platform
####################

.. tab-set::

   .. tab-item:: About VOSS Core Platform
      :sync: overview

      The VOSS Core is the enabling platform for the VOSS product suite. It provides the underlying 
      architecture, services, and tools that support the functionality of all VOSS products and includes 
      the following key components: 

      - **Core Services**: A set of foundational services that provide common functionality such as user management, 
        authentication, authorization, and system monitoring. These services are designed to be reusable across 
        all VOSS products, ensuring consistency and efficiency in development and operation.
      - **Core APIs**: A collection of APIs that allow VOSS products to interact with the core services and 
        with each other.
      - **Core Data Model**: A unified data model that defines the structure and relationships of data across all 
        VOSS products. This data model enables seamless integration and data sharing between products, facilitating a cohesive user experience.
      - **Core User Interface**: A common user interface framework that provides a consistent look and feel across all VOSS products. This framework includes shared components, design patterns, and user experience guidelines to ensure a unified and intuitive user experience. 
       
      
      .. tab-set::

         .. tab-item:: Explore Features

            .. grid:: 1 2 3 3
               :gutter: 3
               :padding: 0
               :class-container: sd-mt-3

               .. grid-item-card:: Introduction
                  :link: src/user/ch-feat-introduction.html
                  :class-card: sd-shadow-sm sd-hover-raise

                  Get started with core product concepts and tools. Learn about dashboards and search.

               .. grid-item-card:: Set up Hierarchy
                  :link: src/user/ch-feat-hierarchy-mgt.html
                  :class-card: sd-shadow-sm sd-hover-raise

                  Structure and navigate hierarchies, manage nodes, and configure site templates.

               .. grid-item-card:: Role-based Access
                  :link: src/user/ch-feat-role-based-access.html
                  :class-card: sd-shadow-sm sd-hover-raise

                  Manage system access, RBAC, user permissions, and custom menu layouts.

               .. grid-item-card:: Manage Microsoft licenses & usage
                  :link: src/user/ch-feat-license-management.html
                  :class-card: sd-shadow-sm sd-hover-raise

                  Configure Microsoft licensing, assign licenses to users or groups, and use dashboards to monitor and 
                  optimize consumption.


               .. grid-item-card:: Configure System Settings & Defaults
                  :link: src/user/ch-feat-system-configuration.html
                  :class-card: sd-shadow-sm sd-hover-raise

                  Manage system-level settings, templates, filters, entitlement rules, 
                  and monitoring tools to control how your environment behaves and scales. 
                  


               .. grid-item-card:: Run System Tasks & Operational Tools
                  :link: src/user/ch-feat-system-functions.html
                  :class-card: sd-shadow-sm sd-hover-raise

                  Execute system-level tasks: review transactions, bulk load or export data, manage files and 
                  reports, run overbuild operations, configure system settings, and setup and 
                  manage Core Framework alerting.


               .. grid-item-card:: Default Dashboards & Menus
                  :link: src/user/ch-feat-dashboards-ref-list.html
                  :class-card: sd-shadow-sm sd-hover-raise

                  Access all system dashboards and menus from here, with a high-level view of how they organize 
                  key information through widgets and how availability and customization depend on your 
                  system settings.


         .. tab-item:: Quickstart
            :sync: quickstart

            .. card:: VOSS Core Platform Setup Workflow
               :class-header: sd-bg-light sd-font-weight-bold

               .. index:: Flowchart;UC Automation Setup Quickstart
         
               .. include:: src/user/install/installation.uml

   .. tab-item:: Release Information

      .. grid:: 1 2 2 2
         :gutter: 3
         :padding: 0
         :class-container: sd-mt-3

         .. grid-item-card:: What's New by Version & Release Notes
            :link: src/user/whats-new.html
            :class-card: sd-shadow-sm sd-hover-raise

            Summary of new and changed features by version, and release notes for the latest 
            version and older versions.


         .. grid-item-card:: Product Compatibility Matrix
            :link: src/user/index-compatibility-matrix.html
            :class-card: sd-shadow-sm sd-hover-raise

            Supported versions and application interoperability across vendors. Including browser and VMWare support.

         .. grid-item-card:: Explore by Feature
            :link: src/user/index-explore-by-feature-chapters.html
            :class-card: sd-shadow-sm sd-hover-raise

            Browse all features available in this release for the Core and product suite.         

   .. tab-item:: Documentation

      All guides for the VOSS Core platform, including administration and use, 
      installation and upgrade, advanced administration, and API reference materials.

      .. tab-set::

         .. tab-item:: User Guides

            Guides for using, operating, and managing the VOSS Core Platform.

            .. list-table::
               :widths: 40 60
               :header-rows: 1
               :class: sd-table-hover

               * - Guide Name
                 - Description
               * - `VOSS Core Guide <src/user/index-voss-core-guide-chapters.html>`_
                 - Comprehensive guide to all VOSS Core features.
               * - `Platform Guide <src/user/platform/index.html>`_
                 - Installation, upgrades, and clustering.
               * - `Self-service <src/user/selfservice/index.html>`_
                 - User instructions for personal phones.
               * - `Best Practices <src/user/best-practices/index-best-practices.html>`_
                 - Critical operations and performance.

         .. tab-item:: Install & Upgrade

            **Planning and Installation**

            Guides for installing and upgrading VOSS Core.

            .. list-table::
               :widths: 30 60 10
               :header-rows: 1
               :class: sd-table-hover

               * - Resource
                 - Description
                 - PDF
               * - `Install Guide <src/user/install/index-enterprise.html>`_
                 - Step-by-step instructions.
                 - N/A
               * - `Product Compatibility Matrix <src/user/index-compatibility-matrix.html>`_
                 - Version compatibility for apps.
                 - :download:`PDF <https://documentation.voss-solutions.com/compatibility-matrix/Compatibility-Matrix.pdf>`
               * - `Architecture & Hardware <src/user/index-arch-hardware-spec.html>`_
                 - Deployment best practices.
                 - N/A


         .. tab-item:: Administration

            **Advanced Administration**

            Advanced administration guides.

            .. list-table::
               :widths: 40 60
               :header-rows: 1
               :class: sd-table-hover

               * - Resource
                 - Description
               * - `Multi-Cluster Deployments Technical Guide <src/user/multi-cluster-deploy/index.html>`_
                 - Overview of current support for multi-cluster customer deployments, offering several best 
                   practice recommendations related to Global Directory Search, User Integrations, Day 2 User and 
                   Feature Provisioning, Dial Plan Management, Overbuild, etc.
               * - `Advanced Configuration Guide <src/user/index-adv-config.html>`_
                 - Describes specific high level tasks performed by administrators higher than Provider level, such as  
                   System Monitoring, Login Banners, Feature Package Customization (for example, Field Display Policies).
               * - `Provider HCS Dial Plan Management Support Guide <src/user/dialplan/index-dialplan.html>`_
                 - Describes how the dial plan model can be integrated into the platform and the service 
                   provider infrastructure with minimal effort. The dial plan model configures not only end 
                   customer equipment but also the interaction with aggregation layers. This guide provides the 
                   standard configurations; service providers must customize parts of the model for specific 
                   environments.
               * - `Licensing and Subscriber Data Export Guide <src/user/index-license-feature.html>`_
                 - How to work with license counts and audit reports and export user data.
               * - `Language Pack Guide <src/user/index-language-pack-guide.html>`_
                 - Set up language preferences on VOSS and Self-service user interfaces.
               * - `Named Macros Reference Guide <src/user/macro-ref/macroref.html>`_
                 - Browse the named macro reference.
               * - `Open Source License Usage Guide <src/user/opensource-licenses/app-licenses/index-v4uc-application-licenses-TOC.html>`_
                 - Describes open source components used in the VOSS system.


         .. tab-item:: VOSS API

            **API Reference and Guides**

            Guides for using the VOSS API, including reference materials and best practices.
            
            .. list-table::
               :widths: 40 60
               :header-rows: 1
               :class: sd-table-hover

               * - Resource
                 - Description
               * - `VOSS API Guide <src/api/index.html>`_
                 - The REST-based API covers all functionality provided by the product and includes a 
                   comprehensive JSON-based schema with schema rules, metadata, and data that simplifies 
                   integration.
               * - `VOSS API Reference <src/api-ref/index.html>`_
                 - The VOSS API reference, by model name and model type.


   .. tab-item:: Resources

      General resources, including training videos, flowcharts, glossary, Index.

      .. tab-set::

         .. tab-item:: Videos

            .. card:: Video Details         

               .. raw:: html

                  <p style="text-align:right"><a href="https://documentation.voss-solutions.com/tutorials/docs_videos/index.html"><i style="vertical-align:bottom" class="material-icons">videocam</i>&nbsp;Automate Tutorials</a>
                  </p>
                  <p>Video links available in the documentation:
                     <ul>
                        <li><a href="src/user/concepts-introduction-to-the-admin-gui.html" target="_blank">GUI Basics - Getting Started</a></li>
                        <li><a href="src/user/concepts-hierarchy.html" target="_blank">Hierarchy Concepts</a></li>
                        <li><a href="src/user/concepts-macros.html" target="_blank">Macros Information</a></li>
                        <li><a href="src/user/concepts-transaction-logging-audit.html" target="_blank">Transactions</a></li>
                        <li><a href="src/user/concepts-working-with-lists.html" target="_blank">GUI Basics - Lists Overview</a></li>
                        <li><a href="src/user/credential-policies.html" target="_blank">Credential Policy</a></li>
                        <li><a href="src/user/best-practices/best-prac-architecture.html" target="_blank">Core System Principles</a></li>
                        <li><a href="src/user/install/automate-system-hardware-specification.html" target="_blank">Architecture and Disaster Recovery</a></li>
                        <li><a href="src/user/concepts-menu-layout.html" target="_blank">Menu Layouts</a></li>
                        <li><a href="src/user/field-display-policies.html" target="_blank">Field Display Policies</a></li>
                        <li><a href="src/user/concepts-bulk-load.html" target="_blank">Bulk load</a></li>
                     </ul>
                  </p>
        
        
         .. tab-item:: Flowcharts     
        
            .. card:: Flowcharts Details         
                        
               Flowcharts links available in the documentation.
                        
               .. raw:: html

                  <p>
                     <ul>
                        <li><a href="src/user/run-dni-audit-tool.html#index-0" target="_blank">Audit Number Inventory</a></li>
                        <li><a href="src/user/webex-app.html#index-2" target="_blank">Cisco Webex Workflow</a></li>
                        <li><a href="src/user/config-automate-for-ms-services.html#index-0" target="_blank">Configure VOSS for Microsoft Services</a></li>
                        <li><a href="src/user/dn-inventory-management.html#index-0" target="_blank">E164 Inventory Management (Provider)</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-6" target="_blank">End to end Customer and Site Dial Plans</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-2" target="_blank">End to end Customer Level Configuration</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-8" target="_blank">End to end Customer Services</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-5" target="_blank">End to end Data Sync</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-1" target="_blank">End to end Hierarchies and Customer Configuration</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-4" target="_blank">End to end Manage Devices (Cisco &amp; MSFT)</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-3" target="_blank">End to end Manage Devices (General &amp; VOSS)</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-10" target="_blank">Manage users</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-7" target="_blank">End to end Number Management</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-9" target="_blank">End to end User Import</a></li>
                        <li><a href="src/user/end-to-end-customer-process.html#index-0" target="_blank">End-to-End Customer Process with Multi-vendor</a></li>
                        <li><a href="src/user/flow-through-provisioning.html#index-0" target="_blank">Flow Through Provisioning Workflow</a></li>
                        <li><a href="src/user/install-web-service-PBR.html#index-2" target="_blank">Install Phone Based Registration</a></li>
                        <li><a href="src/user/sync-azure-users.html#index-0" target="_blank">Microsoft Configuration</a></li>
                        <li><a href="src/user/concepts-ms-exchange.html#index-0" target="_blank">Microsoft Exchange Overview</a></li>
                        <li><a href="src/user/concepts-microsoft-overview.html#index-0" target="_blank">Microsoft Overview</a></li>
                        <li><a href="src/user/microsoft-quick-start.html#index-0" target="_blank">Microsoft Quick Start</a></li>
                        <li><a href="src/user/ms-subscribers.html#index-0" target="_blank">Microsoft users</a></li>
                        <li><a href="src/user/sync-ms-users-to-sites.html#index-0" target="_blank">Microsoft User Move Configuration</a></li>
                        <li><a href="src/user/hybrid-cisco-microsoft-conversion.html#index-0" target="_blank">Microsoft-Cisco Hybrid Overview</a></li>
                        <li><a href="src/user/concepts-directory-number-cooling.html#index-0" target="_blank">Number Cooling</a></li>
                        <li><a href="src/user/configure-PBR-add-on.html#index-0" target="_blank">Phone Based Registration Configuration Per Customer</a></li>
                        <li><a href="src/user/intro-PBR.html#index-1" target="_blank">Phone Based Registration Overview</a></li>
                        <li><a href="src/user/high-level-overview-PBR.html#index-0" target="_blank">Register a Phone</a></li>
                        <li><a href="src/user/setup-CUCM-for-PBR.html#index-0" target="_blank">Set up Phone Based Registration</a></li>
                        <li><a href="src/user/entitlement.html#index-0" target="_blank">Setting up Entitlement</a></li>
                        <li><a href="src/user/webex-app-user-management.html#index-0" target="_blank">Sync with Flow Through for Cisco Webex</a></li>
                        <li><a href="src/user/microsoft-device-mgt.html#index-0" target="_blank">Automate Authentication and Authorization for Microsoft</a></li>
                     </ul>
                  </p>

         .. tab-item:: Glossary and Index     
        
            .. card:: Glossary and Index Details         
        
               Glossary and Index in the documentation.
        
               .. raw:: html 

                  <table border="1" class="docutils">
                     <colgroup>
                        <col width="30%" />
                        <col width="70%" />
                     </colgroup>
                     <tbody valign="top">
                        <tr class="row-even">
                           <td><a href="src/user/glossary.html" target="_blank">Glossary in Core Feature Guide</a></td>
                           <td>Commonly used terms and acronyms</td>
                        </tr>
                        <tr class="row-even">
                           <td><a href="genindex.html" target="_blank">Alphabetical Index</a></td>
                           <td>Features, Flowcharts, CLI commands, Macro function reference</td>
                        </tr>
                     </tbody>
                  </table>

   .. tab-item:: Previous Releases
   
      This page provides resources for previous releases of Automate, including release and upgrade information (ISO, delta or patch) 
      updates. We recommend that you upgrade Automate often to stay current with the latest fixes and enhancements. 
   
      .. tab-set::
           
         .. tab-item:: What's New
   
            These links provide information on new changes in previous releases.

            .. raw:: html

               <a href="https://documentation.voss-solutions.com/automate-25.3.html">What's New in 25.3</a><br/>
               <a href="https://documentation.voss-solutions.com/automate-25.2.html">What's New in 25.2</a><br/>
               <a href="https://documentation.voss-solutions.com/automate-25.1.html">What's New in 25.1</a><br/>
               <a href="https://documentation.voss-solutions.com/automate-24.2-PB2.html">What's New in 24.2-PB2</a><br/>
               <a href="https://documentation.voss-solutions.com/automate-24.2-PB1.html">What's New in 24.2-PB1</a><br/>
               <a href="https://documentation.voss-solutions.com/automate-24.2.html">What's New in 24.2</a><br/>
                      
           
           
         .. tab-item:: Release & Upgrade Notes
   
            .. raw:: html 

               <table border="1" class="docutils">
                  <colgroup>
                     <col width="5%" />
                     <col width="35%" />
                     <col width="60%" />
                  </colgroup>
                  <tbody valign="top">
                     <thead style="font-weight:bold;"><tr><td>PDF</td><td>HTML</td><td>Description</td></tr></thead>
                        <tr class="row-even">
                           <td><a href="https://documentation.voss-solutions.com/release_25.3-PB0/html/Release-Notes-25.3.pdf"><i class="material-icons">picture_as_pdf</i></a></td>
                           <td><a href="https://documentation.voss-solutions.com/release_25.3-PB0/html/src/release-core/Release-Notes-25.3.html">Release & Upgrade Notes for 25.3</a></td>
                           <td style="vertical-align:top!important" rowspan="5">Release Notes provide build details, and a list of all new features, enhancements, and bug fixes in the relevant release. 
                           Upgrade notes are included in the release notes and describe configuration changes that may be required as part of the relevant upgrade.</td>
                        </tr>
                        <tr class="row-even">
                           <td><a href="https://documentation.voss-solutions.com/release_25.2-PB0/html/Release-Notes-25.2.pdf"><i class="material-icons">picture_as_pdf</i></a></td>
                           <td><a href="https://documentation.voss-solutions.com/release_25.2-PB0/html/src/release-core/Release-Notes-25.2.html">Release & Upgrade Notes for 25.2</a></td>
                        </tr>
                        <tr class="row-even">
                           <td><a href="https://documentation.voss-solutions.com/release_25.1-PB0/html/Release-Notes-25.1.pdf"><i class="material-icons">picture_as_pdf</i></a></td>
                           <td><a href="https://documentation.voss-solutions.com/release_25.1-PB0/html/src/release-core/Release-Notes-25.1.html">Release & Upgrade Notes for 25.1</a></td>
                        </tr>
                        <tr class="row-even">
                           <td><a href="https://documentation.voss-solutions.com/release_24.2-PB1/html/Release-Notes-24.2-Patch-Bundle-1.pdf"><i class="material-icons">picture_as_pdf</i></a></td>
                           <td><a href="https://documentation.voss-solutions.com/release_24.2-PB1/html/src/release-core/Release-Notes-24.2-Patch-Bundle-1.html">Release & Upgrade Notes for 24.2-PB1</a></td>
                        </tr>
                        <tr class="row-even">
                           <td><a href="https://documentation.voss-solutions.com/release_24.2-PB0/html/Release-Notes-24.2.pdf"><i class="material-icons">picture_as_pdf</i></a></td>
                           <td><a href="https://documentation.voss-solutions.com/release_24.2-PB0/html/src/release-core/Release-Notes-24.2.html">Release & Upgrade Notes for 24.2</a></td>
                        </tr>
                     </tbody>
               </table>
           
   
         .. tab-item:: Docs

            .. raw:: html
               
               <p>These links go to the documentation for previous releases. Find out more about 
               supported versions and end of support dates in the 
               <a href="https://documentation.voss-solutions.com/policies/VOSS-Release-Management-Policy-Software-EoS.pdf">Software EoS Policy & Support Matrix</a>.</p>

            .. raw:: html

               <a href="https://documentation.voss-solutions.com/release_25.3-PB0/html/index.html">Automate 25.3</a><br/>
               <a href="https://documentation.voss-solutions.com/release_25.2-PB0/html/index.html">Automate 25.2</a><br/>
               <a href="https://documentation.voss-solutions.com/release_25.1-PB0/html/index.html">Automate 25.1</a><br>
               <a href="https://documentation.voss-solutions.com/release_24.2-PB2/html/index.html">Automate 24.2-PB2</a><br>
               <a href="https://documentation.voss-solutions.com/release_24.2-PB1/html/index.html">Automate 24.2-PB1</a><br>
               <a href="https://documentation.voss-solutions.com/release_24.2-PB0/html/index.html">Automate 24.2</a><br>
               <a href="https://documentation.voss-solutions.com/release_24.1-PB2/html/index.html">Automate 24.1-PB2</a><br>
               <a href="https://documentation.voss-solutions.com/release_24.1-PB1/html/index.html">Automate 24.1-PB1</a><br>
               <a href="https://documentation.voss-solutions.com/release_24.1-PB0/html/index.html">Automate 24.1</a><br>
               <a href="https://documentation.voss-solutions.com/release_21.4-PB5/html/index.html">Automate 21.4-PB5</a><br>
               <a href="https://documentation.voss-solutions.com/release_21.4-PB4/html/index.html">Automate 21.4-PB4</a><br>
               <a href="https://documentation.voss-solutions.com/release_21.4-PB5/html/Docs-21.4-PB3.zip">Automate 21.4-PB3 (zip file)</a><br>
               <a href="https://documentation.voss-solutions.com/release_21.4-PB5/html/Docs-21.4-PB2.zip">Automate 21.4-PB2 (zip file)</a><br>
               <a href="https://documentation.voss-solutions.com/release_21.4-PB5/html/Docs-21.4-PB1.zip">Automate 21.4-PB1 (zip file)</a><br>
               <a href="https://documentation.voss-solutions.com/release_21.4-PB5/html/Docs-21.4-PB0.zip">Automate 21.4 (zip file)</a><br>
               <a href="https://documentation.voss-solutions.com/release_21.3/html/index.html">Automate 21.3</a><br>
               <a href="https://documentation.voss-solutions.com/release_21.2/html/index.html">Automate 21.2</a><br>
               <a href="https://documentation.voss-solutions.com/release_21.1/html/index.html">VOSS-4-UC 21.1</a><br>
               <a href="https://documentation.voss-solutions.com/release_20.1.1/html/index.html">VOSS-4-UC 20.1.1</a><br>
               <a href="https://documentation.voss-solutions.com/release_19.3.4/html/index.html">VOSS-4-UC 19.3.4</a><br>
               <a href="https://documentation.voss-solutions.com/release_19.3.3/html/index.html">VOSS-4-UC 19.3.3</a><br>
               <a href="https://documentation.voss-solutions.com/release_19.3.2/html/index.html">VOSS-4-UC 19.3.2</a>