[Index]

Model: data/FlowThroughProvisioningCriteria

Flow Through Provisioning

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

VOSS Automate allows for flow through provisioning, in other words, for auto-provisioning users and services during user sync from devices.

Auto-provisioning typically references user attributes such as a user's department, division or city address. This filter is set up as Model Filter Criteria.

When setting up a Flow Through Provisioning Criteria instance, this initial Model filter criteria definition of user attributes is then further associated with additional properties for the user in VOSS Automate:

An instance of Flow Through Provisioning Criteria that can be selected in the Subscriber Criteria drop down list of the Global Settings, Flow Through Provisioning Criteria tab. See: Global Settings.

Related Topics

Microsoft Overview in the Core Feature Guide

Sync with Flow Through in the Core Feature Guide

Subscriber Profiles in the Core Feature Guide

User Roles in the Core Feature Guide

Flow Through Provisioning

Full HTML Help

Overview

VOSS Automate's flow through provisioning feature allows auto-provisioning of users and services during user sync from devices.

Note

Related Topics

LDAP Integration in the Core Feature Guide

Add CUCM Server in the Core Feature Guide

CUCM Configuration in the Core Feature Guide

Microsoft Overview in the Core Feature Guide

Sync with Flow Through for Microsoft in the Core Feature Guide

Sync Webex App Users with Flow-through Provisioning in the Core Feature Guide

Subscriber Profiles in the Core Feature Guide

Model Filter Criteria in the Core Feature Guide

Global Settings in the Core Feature Guide

Site Defaults in the Core Feature Guide

User Roles in the Core Feature Guide

This topic describes the steps for setting up your system to enable a seamless sync in of users to VOSS Automate from the hierarchy where the sync source device is set up (typically, Customer level), and the flow through provisioning of services to subscribers at your sites.

Flow Through Provisioning Workflow

To access the flowcharts, view the topic via the release documentation at: https://documentation.voss-solutions.com/automate.html

Before you Start: Add a Server as Sync Source

Users are imported from the server sync source to the Customer level in VOSS Automate. The flow through provisioning is generic functionality and supports a number of scenarios, including Microsoft, LDAP, CUCM, Cisco Webex and other models (depending on predefined model criteria).

Note

See the Core Feature Guide for details around adding and setting up a server for your flow through provisioning scenario. For example, see Microsoft Quick Start, Set up an LDAP Server, Set Up Cisco Unified Communications Manager Servers

Step 1: Add Model Filter Criteria

Flow through provisioning references model filter criteria set up for each user type (for example, Microsoft, LDAP, or CUCM).

When setting up the model filter criteria, you will specify usage, either flow through provisioning, or move user:

Step 2: Add Subscriber Profiles

Flow through provisioning uses the subscriber profile to determine the services to be assigned to a subscriber once they're moved to the site.

For details around adding subscriber profiles, see Subscriber Profiles

Step 3: Add Flow Through Provisioning Criteria

Flow through provisioning criteria is a type of model filter criteria used for provisioning. One named flow through provisioning criteria can be added at each Customer level.

Each flow through provisioning criteria is a collection of one or more pairs of model filter criteria and subscriber profile combinations. The flow through provisioning criteria defines how users are matched to both sites and subscriber profiles, allowing the tool to seamlessly move users to the sites (based on model filter criteria) and to create a subscriber and assign services from the subscriber profile.

Flow through provisioning uses the first match to execute the move and service assignment operation.

You can use a single flow through provisioning criteria to match any number of subscriber profiles for this customer and its sites. For example, if you have ten different subscriber profiles, you can add ten pairs of model filter criteria and subscriber profile combinations.

Note

Flow through provisioning criteria is configured via either of the following menu options (default menus):

Before setting up the flow through provisioning criteria, configure the following:

Step 4: Choose Move Criteria

To allow users to be moved in a flow through provisioning, you need to choose move filter criteria for the user type (Microsoft, LDAP, and/or CUCM). The move filter criteria defines how the system moves users to the correct site once they're synced in; that is, it matches each user to the relevant site.

Note

The system uses the existence of the move filter criteria from the site defaults to determine if the user must be moved. Flow through provisioning will not work if a user is not moved to a site.

Prerequisites:

To choose move criteria ...

  1. Go to (default menus) Site Management > Defaults.
  2. Click on the relevant site.
  3. On the Move Filter Criteria tab, choose the criteria for the user types you're importing (Microsoft, LDAP, and/or CUCM).
  4. Save.

Step 5: Enable Flow Through Provisioning

Enabling your system for flow through provisioning in the Global Settings allows VOSS Automate to perform a seamless sync in, to move users to the correct site (based on move filter criteria) as subscribers (based on the model filter criteria), and to provision these subscribers with appropriate services (based on the subscriber profile).

Prerequisites:

To enable flow through provisioning ...

  1. Log in to the Admin Portal as Provider admin or higher.

  2. Set the hierarchy to the level where the sync source device is installed. Typically, this is at the customer.

  3. Go to (default menus) Customizations > Global Settings, and select the Flow Through Provisioning tab.

    Note

    Alternative menu: Flow Through Provisioning Configuration > Global Settings.

  4. At Enable Move & Flow Through Provisioning, select Yes.

  5. At Enable Move & Provisioning after Add Sync, select Yes.

  6. At Flow Through Provisioning Criteria, choose the flow through provisioning criteria to use at the customer level (for all sites at the customer).

  7. Save.

Step 6: Sync with Flow Through Provisioning

This section describes the general workflow in a generic sync with flow through provisioning.

You can run the sync directly, or via a schedule.

Ensure you have the following set up before a sync:

Sync with Flow Through Provisioning Workflow Steps

The flow through provisioning workflow is executed per user and runs in parallel:

  1. Imports user.

  2. Creates a corresponding LDAP user (for LDAP scenario), and a local VOSS user.

  3. Moves users to the sites (based on model filter criteria). If no criteria in place, user remains at Customer level.

  4. Updates the user's role for the site.

  5. Executes Add Subscriber from Profile to create the subscriber, and checks the flow through provisioning criteria to match it to a subscriber profile.

  6. Provisions the subscribers with appropriate services, from the subscriber profile.

  7. Sends a welcome email to subscribers if the following applies:

    See also Email HTML Templates.

You can monitor the progress of the transaction via the Transaction Log. When complete, verify the user's move and provisioning status:

  1. Go to (default menus) User Management > Users, and in the list view, check that synced in users are at the correct sites.
  2. On the Subscribers list view, check that subscribers exist at the sites, with relevant services.

Flow Through Provisioning Criteria is a model where user criteria is stored for FTP. When a user is synced into the system and FTP is configured this data will be checked to see if the user that is synced in matches the criteria or not. If it matches the appropriate Subscriber from Profile mechanism is called to automatically provision the user.

Model Details: data/FlowThroughProvisioningCriteria

Title Description Details
Name Name of the flow through provisioning criteria
  • Field Name: name
  • Type: String
Description Description of the flow through provisioning criteria
  • Field Name: description
  • Type: String
Criteria Order Ordered list a criteria to math on. The first criteria that matches will be used.
  • Field Name: criteria.[n]
  • Type: Array
Model filter criteria Model Filter Criteria
  • Field Name: criteria.[n].model_filter_criteria
  • Type: String
  • Target: data/ModelFilterCriteria
  • Format: uri
Subscriber Profile Profile of the Subscriber to use.
  • Field Name: criteria.[n].profile
  • Type: String
User Role Role to assign to the user.
  • Field Name: criteria.[n].role
  • Type: String