IMG 1010 - Variant Provisioning
The IMG allows a user the ability to utilize Signaling Variants to work within a network. The IMG gives a user a whole host of options of what can be done with a signaling variant. The table below displays the functionality supported on the IMG when working with signaling variants.
Function | Description |
Pre-Loaded Variants | The GCEMS application comes pre loaded with a few variants that can be imported into the IMG for use. The import procedure below describes how to import and export these pre-loaded variants to and from the IMG. |
Create a Variant | Through use of the GCEMS and ClientView applications, a custom variant can be created or an existing variant can be modified using the PPL logic embedded in the IMG. If creating a custom variant or requiring a new custom variant, it is recommended that customers submit a request as "FR - Feature Request" and work with Sangoma Support Personnel. |
Delete a Variant | Through use of the GCEMS and ClientView a variant that is loaded on the IMG can be deleted. |
Import/Export a Variant | Pre-configured variants can be imported to the IMG and any variants loaded on the IMG can be exported. Exporting is used to be able to load that same variant on multiple IMG's. |
The information below describes how to achieve the functions in the table above.
Importing a Variant
Importing a variant implies importing a variant from the GCEMS/ClientView applications to the IMG. When importing a variant, the variants .xml file must be previously loaded into the /opt/dialogic/common/config/Imports directory on the GCEMS server and the variants .cfg file must be loaded into the /opt/dialogic/common/config/Variant directory in this same server. Through ClientView and GCEMS the variant is transferred to the IMG. The procedure below describes how to import a variant from these directories.
The procedure describes importing the Spirou variant but can be used to import any variant configured and loaded into the correct directory on the GCEMS server. Verify the basic configuration and SS7 configuration have been accomplished before proceeding. |
Right click on the Dialogic IMG EMS object and select New Signaling Variants. A Signaling Variants object will appear. Nothing needs to be configured in this object. The Signaling Variants object is a parent object and no configuration is needed here. For more information on this object, refer to the IMG 1010 - Signaling Variants topic.
Right click on the Signaling Variants object and select Import Variant Table. A Configure Import Variant Table box appears. Select the variant from drop down menu of the Import File Name field. Variant file will have a .xml extension. Refer to screen capture below. Select Next >> button.
Verify the variant in the Import File Name field is correct and select Finish. The variant will now be displayed under the Signaling Variants object in the object tree in ClientView. The icons for the variant will display a cached icon. This indicates that the variant has been cached and has not been sent to the 1010 IMG.
Click on one of the cached icons in the configuration tree and click on the Save Variant Table button located under the variant object pane. Clicking on the Save Variant Table button will send the variant to the .csa file being configured. The icons displaying the cached symbol in the variant object tree will now change to an icon with a check symbol indicating the variant is configured on 1010 IMG. At this point depending on which type of variant being configured, the variant will be selectable in either the SS7 Stack, the SIP-T entity object, or the Channel Associated Signaling object under the CAS Channel group. Once associated with one of these objects, the variant will used during call processing.
Supported Variants
In the procedure above, the Import File Name field has a drop down menu with all the pre-loaded variants. These variants are all loaded into the /opt/dialogic/common/config/Imports and the /opt/dialogic/common/config/Variants directories. Also Sangoma Support personnel have created other variants that can be acquired by request and downloaded to the IMG. Refer to the tables below for more information on each variant.
** Indicates the variant is not loaded during GCEMS installation. Variants are available by contacting Sangoma Support Personnel
Exporting a Variant
Exporting a Variant procedure takes a previously created variant that is installed on the IMG and moves the variant to the /opt/dialogic/common/config/Imports directory. Once in this directory any other 1010 IMG within the ClientView can use the variant.
Right click on the Signaling Variants object again and select Export Variant Table. A Configure Export Variant Table box will appear. Select the variant from drop down menu in the Variant Table to export field. This field will display all the variants that have been either imported or created on the IMG. See screen capture below.
In the Export File Name field, enter a Name that describes the variant being exported. In this procedure, the Export File Name given is the same as the signaling variant name (BritishTelecom). Select the Next >> button and then Finish in the Wizard Summary screen that appears.
The variant being exported has been saved in the /opt/dialogic/common/config/Imports directory on the linux server running GCEMS. The exported variant can be imported into a different IMG or can be modified and re-imported into the IMG the variant was originally exported from.
Creating a Variant
The procedure below describes how to create a variant using the ClientView application. It is not recommended that customers create their own variants without the assistance of Sangoma Support Personnel. Creating custom variants requires a great deal of knowledge of the variant being created.
Right click on the Dialogic IMG EMS object and select New Signaling Variants. A Signaling Variants object will appear. The Signaling Variants object is a parent object and no configuration is needed here. Refer to the IMG 1010 - Signaling Variants topic for more information on this object.
Right click on the Signaling Variants object created and select New Signaling Variant. In this procedure the variant will be named New_Variant. Enter a name, Variant Type, Base variant, and Variant Id in this object. Refer to IMG 1010 - Signaling Variant topic for more information on populating the individual fields.
Right click on the Signaling Variant and select New Variant Entry. Refer to IMG 1010 - Variant Entry topic for more information on configuring this object. Continue to create Variant Entries until the new variant being created is complete.
Right click on the New_Variant being created in the object tree and select Save Variant Table button. By clicking on Save Variant Table button the variant created will now be saved in the .csa file being created for the ClientView application. Below is screen capture of the Export Variant Table displaying the new variant that was created and saved on the IMG.
At this point depending on which type of variant is being configured, the variant will be selectable in either the SS7 Stack object, the SIP-T entity object, or the Channel Associated Signaling object under the CAS Channel group. Once associated with one of these objects, the variant will be used during call processing.
Note: After creating a New Variant, it is initially saved only in the .csa file. To be able to use it on a second and third IMG, it must first be exported and saved as a .xml file in the /opt/dialogic/common/config/Imports directory. Once the New Variant has been exported to the Imports directory, it can then be imported to a second and third IMG. |
Deleting a Variant
Deleting a variant can be a very tedious operation if procedure below is not followed. Variants typically have many PPL objects configured below them and can take quite a while to delete all the child objects before deleting the actual signaling variant. Follow the procedure below to delete a variant from the ClientView without having to first delete all the child objects first.
Right click on the Signaling Variants object created above and select Delete Variant Table. A Configure Delete Variant Table box will appear. Select the variant to delete from drop down menu of all variants created. See screen capture below.
Select Next >> button.
Select Finish button. The variant will be deleted from the ClientView screen, the .csa file, and the IMG. Depending on the variant being deleted, it will no longer be displayed as a selection in the SS7 stack, the SIP-T entity object, or the Channel Associated Signaling object under the CAS Channel group.