Configuration Workflows and Templates

In this section:

The Configuration Workflows and Templates object:

guides you through a process in the application
presents a series of steps so you can configure one at a time in sequence
includes steps that contain text, images, or user-configurable settings and attributes
may allow the repetition of certain steps
supports committing the configuration to the SBC either by step or at the end of the workflow
can be extended - new workflows may be made available in the Ribbon Support Portal
can be customized, or new workflows can be created and uploaded to EMA

A configuration template workflow is a sample configuration that guides you through the process of data entry for a particular scenario. The sample configuration includes default values for some of the settings - you can accept or override these settings before loading the workflow onto the SBC.

On the SBC main screen, navigate to Configuration > Configuration Wizards. The Configuration Workflows and Templates window is displayed.

EMA Workflow Screen

Generic Information

Workflow Source

There are two types of EMA workflows. The type is indicated by the Source column in Configuration Template Workflows.

Sonus Workflows – Sonus workflows are attached along with the SBC, which is indicated by Sonus in the Source column. You cannot delete a Sonus workflow.
User-added Workflows – Workflows that are downloaded from the Ribbon Support Portal, customized by you, and uploaded back to EMA using the File Upload screen. This type is indicated by User in the Source column.

Launching Workflow

To launch the workflow, click in the Launch column.

Deleting Workflow

To delete the workflow, click in the Delete column.

Note

You can only delete user-added workflows.

Orientation of Workflow

This section describes the navigation of workflow and commands associated with it. After launching a workflow, the workflow home page opens.

Workflow Home Page

Workflow Title and Steps

After launching the template workflow, a new screen opens with the workflow title and the steps associated with it.

Workflow Title and Steps

The workflow steps are displayed in a vertical list and you can navigate through the steps using the Next and Back buttons.

Navigation Buttons

Navigation is sequential - you can navigate to the next step or previous step. You cannot skip a step.

Navigation Buttons

Navigation Buttons	Description
	Click the Next button to navigate to the next step in the workflow. This is displayed in all the steps in the workflow except the last step. The Next button is disabled on the mandatory steps until you submit the configuration. Once you submit the configuration, the Next button is enabled so you can navigate to the next step.
	The Submit button is displayed in every step. You can perform the following using the Submit button. Validate and check all the tokenized CLI fields in complete state. If any required fields are incomplete, an error message is displayed. Submit the tokenized CLI values to the SBC. The Submit button is not visible for the static workflow steps. The Submit button is always enabled for the template workflow steps.
	The View Config Details button is displayed in every step. Click the View Config Details button to view: CLI commands for non-tokenized workflow step. CLI commands with all the tokens filled for tokenized workflow step.
Configuration Details	The Configuration Details dialog is generated after you click View Config Details. The dialog shows the CLI commands that will be submitted to the SBC. Click X to close the dialog.
Show only required fields	This option displays only the mandatory fields required for configuration in each template workflow steps that do not have default values provided.

Static Workflow Step

These steps are provided to give an overview of the current workflow process and to inform you about any prerequisite required for the workflow. (Your interaction is required to proceed to next step.)

The static workflow step displays only text, images, and hyperlinks.

Static Workflow Step

Template Workflow Step

The template workflow steps are linked to CLI commands. For simplicity and ease of use, these commands are not visible to you in the UI (although you can still use the CLI if you wish). You will instead see text, images, hyperlinks, and forms in which to enter tokenized values.

Once you click the Submit button in that particular step, the EMA loads the CLI commands to the SBC. The CLI commands for a template step are categorized into:

Tokenized CLI – You must input the value for the tokenized CLIs before submitting the configuration step. The workflow template identifies fields that can be customized through "tokens" in the CLI. The tokens in the CLI are replaced with the values you enter. You must complete all input fields before the tokens in tokenized CLIs can be updated. For example, if a CLI command includes a token for an IP address, the IP address input field is presented to you, and the value entered in this field replaces the corresponding token in the CLI command before submitting it to the SBC.

Tokenized CLI Step
Non-Tokenized CLI Steps – Steps with CLI commands that do not require any input from you.

Non-Tokenized CLI Step

Configuration Template Workflows

Templates are included in the Configuration Template Workflow sections. For example, the Sonus template named Skype for Business is included in the SBC. This template helps you configure inbound and outbound call flows between the SBC Core and Microsoft Skype for Business using TCP and SRTP.

Note

This workflow does not include TLS configuration.

Step 1 – Launching Workflow

Skype for Business - Step 1

Step 2 – Description

Skype for Business - Step 2

Step 3 – Reference Configuration

Skype for Business - Step 3

Step 4 – Prerequisites

Skype for Business - Step 4

Step 5 – Global Configuration

The concept of tokenized CLI starts from the Global Configuration. The tokenized CLIs (marked in red) are user-defined parameters, which are customized based on the requirements. Click View Config Details tab to view the configuration.

Skype for Business - Step 5