Creating a Configuration

Navigation:  Managing a Site > Applications > Configurations >

Creating a Configuration

Previous pageReturn to chapter overviewNext page

 

Overview

 

Configurations are containers with specific software elements (applications, MCL-software, files) directed at specific devices which are grouped according to manufacturer, model and/or OS (Device Groups).

A configuration that is created in a particular site, is restricted to that site but a configuration created at account level is, by default, a "shared configuration", meaning, it is available to all the sites that are compatible with it. The account administrator can, however, create a configuration, at account level, and restrict it to a particular site

The creation of a configuration is divided into 4 main steps/tabs - "Properties"; "Firmwares"; "Applications" and "Others". Depending on the configuration's objective it may NOT be necessary to fill in all the steps/tabs.

Ex: If you just want to install firmware into your device(s), you can skip the "Applications" and "Others" steps/tabs and just fill in the "Properties" and "Firmwares" steps/tabs OR  When delivering an application to a device, the corresponding configuration requires you to fill in the "Properties" and "Applications" tabs.

Check our Configuration Examples below.

 

Step-by-step

1. In the Site Dashboard's "Control Panel" section, click Applications button to access the Configurations Sub Module Button button.

 

2. Click Configurations Sub Module Button and open the "Configurations" page.

 

Site Configurations0

 

 

TIPIt is recommended that the Show all Versions box option is checked. This ensures the viewing of all existing versions for each configuration instead of just the latest configuration version prior to adding a new configuration.

 

3. Click Add Configuration Header Button to open the "New Configuration step 1 (Properties tab)" wizard page.

 

Step 1 "Properties" tab

Regardless of the configuration's purpose, this step/tab CANNOT be skipped.

 

Site Configurations Add A

 

4. Fill in the information for the new configuration (the fields marked with an asterisk are mandatory):

 

Name *

Enter the name for the new configuration.

 

TIPWe recommend you avoid special characters and consider the related best practices when you define a configuration's name:

Use alphabetic/numeric characters (a-z; A-Z; 0-9).

Underscore character is allowed.

Always start the entity's name with an alphabetic character.

Version *

Define the configuration's version.

Device Model

Check "Select Device Manufacturer" to define the manufacturer, the model and OS of the configuration's target device from the corresponding drop-down boxes. As an alternative, click lupa button and select a device model in the resulting window. See Details on the "Select Device Type" window below.

 

Note

The Samsung manufacturer provides a "Generic Device Android" option - this generic "device model" is compatible with all Samsung Android devices. This means you can create a device group for "Generic Device Android" devices (it can contain different Samsung models) and deploy configurations to it. In this case, the configuration's target MUST be "Samsung Generic Device Android". It will NOT be available for other device groups with a specific Samsung device type, it can ONLY be deployed for this device group.

 

Note

If required, the MCL-Mobility Platform provides a "Generic Android" software. This software should ONLY be used if there is NO specific MCL-Agent V4 software available for your Android devices because it has some limitations compared to the specific MCL firmware. Choosing "[Others]" + "Generic" + "Android" in the corresponding drop-down means that the configuration can ONLY be deployed to a device group with a "Generic Android" target device model.

 

Check "No Device Model" if no device target is to be specified. (Ex: Useful, if you intend to deploy a configuration to all the device groups of a site regardless of device type).

Qualification

Not editable. The configuration inherits the site's qualification.

Site Restriction

Not editable. The configuration is restricted to the site it is created in.

Description

If relevant, add notes regarding the new configuration.

 

Detail of Select Device Type windowClick Here for Details on the "Select Device Type" window

 

5. Click Button_Next to proceed to the "New Configuration step 2 (Firmwares tab)" wizard page.

 

If an error message appears, check Possible Error Message(s).

 

Step 2 "Firmwares" tab

You are ONLY required to fill in this step/tab, if you intend to deliver a firmware package to your device(s).

 

Site Configurations Add1 A

 

To return to the "New Configuration step 1 (Properties tab)" wizard page, click Button_Previous OR Step 1 Wizard icon.

 

6. Select the product and corresponding firmware package version for your configuration from the respective drop-down.

Depending on the selected product/firmware package version, you may have firmware options to select.

If there are no firmware options (message display: "This product comes with no firmware options."), proceed to step 8.

If there are, continue to step 7.

 

7. Make your selection according to the imposed rules/available options:

 

a. Click Add ASR button and/or Add TTS button to access the corresponding languages list.

b. In the resulting pop-up window, check the Check box of the languages you need.

 

Note

The TTS languages list includes 2 possible speech models for a given language:

The Standard TTS speech model – Uses a large speech base (encoded speech units based on natural speech recordings that are selected/concatenated as necessary). The resulting TTS is closer to a natural sounding speech.

Example of a Standard TTS languages file: “MCL-Client Voice V4 TTS French (FR) Female Speaker Audrey".

 

The Compact TTS speech model – Uses a smaller speech base (the speech units are a result of a limited number of recordings which are, then, compiled together). The resulting TTS is more synthetic.

Example of a Compact TTS languages file: “MCL-Client Voice V4 TTS  French (FR) - Compact - Female Speaker Audrey".

 

Select a Compact TTS language file OR  a Standard TTS language file. There is NO simultaneous use, the device will ONLY use the file that was downloaded last

 

c. Click Add Check Gray Button to apply your choices.

d. If required, use the Add Login App button option to add MCL's "Login Application" to the configuration. (There is a speech and a non-speech version of this application. Depending on the selected MCL product, you will be provided with the compatible version.

 

I. Click Add Login App button .

II. Check the Login Application available.

III. Click Add Check Gray Button to apply.

 

e. If required, click Add Speech Control Panel button to add MCL's "MCL Speech Control Panel" to the configuration.

 

I. Click Add Speech Control Panel button .

II. Check the "MCL Speech Control Panel" entry.

III. Click Add Check Gray Button to apply.

 

[MCL-Voice Blind is an MCL product intended for specific speech environments where a screen is NOT necessary to the operator handling the MCL speech application(s) - the operator’s interaction with the speech application is, mainly, via speech input/output.

For more details, check our MCL Knowledge Base for the corresponding article. (You must register/log in to access this article.)]

 

Site Configurations Add1 B

 

If required, click info button to open a "Packages" window and view the name of the selected firmware package version.

 

Packages Window2a_Site

 

Click Close Button to close the "Packages" window and return to the Firmwares tab.

 

8. Click Button_Next to continue to the "New Configuration step 3 (Applications tab)" wizard page.

 

Step 3 "Applications" tab

Unless you intend to deliver an application to your device(s), you do NOT need to fill in this step/tab.

 

Site Configurations Add7 A

 

To return to the "New Configuration step 2 (Firmwares tab)" wizard page, click Button_Previous OR Step 2 Wizard icon.

 

TIPBefore creating a configuration, make sure you have applications available. If that is not the case, add them. For more information, see Adding an Application.

 

9. If required, add applications to your configuration. Click Add Applications button to open a "Select Application" window.

 

Select Application Window_Site

 

This window displays the compatible applications available to the site.

 

If required, use the following options to organize/filter the window's display:

 

Click No Filter Buttonto access the "Name", "Qualification", "Upload Date", "Author" and/or "Company" filters to limit the display:

 

I. Enter data in the required fields/select from the drop-down. You can use as many filters, simultaneously, as necessary.

II. Click Apply Button Green to filter the list according to the data you added in the filter fields.

III. Click Clear Button to empty all the filters simultaneously OR  click the Delete Search Icon button of the field you want to clear OR  select the "All" option in the corresponding drop-down.

 

Click Button_Grid for a grid view (default option) or Button_List for a list view.

 

Click the intended Site management items displayedbutton to define how many items are displayed at a time (10 items per page/20 items per page/50 items per page/100 items per page).

 

search box (on the window's upper right corner) to filter the information:

 

a. Enter what you want to search for.

b. Click lupa button or press <ENTER> in your PC keyboard to initiate the search.

c. End the search operation by emptying the search box and clicking lupa button OR Emptying the search box and pressing <ENTER> in your PC keyboard OR clicking the Delete Search Iconicon.

 

TIPThe application name (in light blue) is a shortcut to the application's details page. See Application Details.

 

 

10. Select the appropriate application version(s) by checking the corresponding Check box and proceed to step 11.

As an alternative, import an application:

 

How to import an applicationClick Here for Details on How to Import an Application

 

11. Click Confirm button and return to the "New Configuration step 3 (Applications tab)" wizard page.

 

New Configuration Step 3 Result

 

12. If required, add resources to an application. Click the corresponding Button_add resources button and proceed as described below.

If you do not want to add any resources, proceed to step 13.

 

how to add resources to an applicationClick Here for Details on How to Add Resources to an Application

 

13. If there are no more applications/resources to be added, click Button_Next to continue to the "New Configuration step 4 (Others tab)" wizard page.

 

Step 4 "Others" tab

This step/tab is used to deliver all sorts of files to your devices. The exceptions are MCL firmware (save some cases, you SHOULD always use the "Firmwares" tab for that) and MCL applications (those are added to Step 3 "Applications" tab).

 

New Configuration Step 4

 

To return to the "New Configuration step 3 (Applications tab)" wizard page,click Button_Previous OR Step 3 Wizard icon.

 

14. If required, add resources to your configuration. Click Button_add resources to open an "Upload Resource" window and an overlapping OS browse window.

 

LoadItems

 

15. Select the appropriate resource and click Button_Open.

 

Upload Resource to Configuration window

 

The OS browse window closes and the resource file is displayed in the "Upload Resource" window.

TIP

If, for some reason, you close the OS browse window, reopen it by clicking Add Button Blue in the "Upload Resource" window (it opens at the same time as the OS browse window, in the background).

 

Add Resources Window

 

If necessary, delete a file by using the corresponding Button_Delete option. To delete all added files, at once, click Button_Clear all.

 

Use the Add Button Blue button to browse for/select more resources.

 

 

16. If there are no more resources to add, click Button_Upload1.

 

New Configuration Step 4 Result

 

 

NoteIf you upload files with a .pdk, an.apk or .cab extension, you do not need to enter a path. For any other file extensions, you must enter the path in the "Resources" box, in order to locate the file. To ensure compatibility with the Windows Mobile and Android operating systems, use a backlash at the beginning and end of the entered path (ex: \Temp\).

 

Note

If you want to deploy files (with extensions other than ".pdk", an ".apk" or ".cab") to a known location, you can use the corresponding alias in the path.

"<APPS>", "<SHARED>", "<MCL>", "<INSTALL>" and/or "<SYSTEM>" are the available aliases you can enter. Ex: <APPS>\User_Guide\; <INSTALL>\Zebra manifest file ("*.mprf"); <INSTALL>\parameter services files ("*.dpf", "*.upf", "*apf", "*.cpf").

For more information about aliases, see "Details on Aliases" below.

 

hmtoggle_plus1Click Here for Details on Aliases

 

NoteDo NOT upload MCL ".cabs" into the "Others" tab - for instance, the ".cab" files available in the MCL Technologies sites meant for an initial installation. Deploying those installation packages as a resource will interfere with the established workflow between device and MCL-Mobility Platform (ex: files can be deleted/replaced in the device). Any necessary MCL-Agent upgrades/downgrades MUST be performed in the "Firmwares" tab.

 

NoteIf your valid path is pointing towards a device folder that does not exist, one is created in the device.

 

 

Note

The size limit for file uploads into the "Others" tab of a configuration is 300 Mb.

 

 

 

New Configuration Step 4 Result2

 

You can delete the newly added resource(s) by clicking the corresponding Button_Delete.

 

The configuration's resources will be delivered in the order they are presented in the table, from top to bottom.

Ex: The "items.txt" resource will be uploaded on to the device first and the "English.loc" file will follow.

You can change the installation order of the added resource(s) by clicking the corresponding Resources order arrow buttons. The resources will move up and/or down accordingly.

 

17. Complete the configuration creation by clicking Button_Save.

 

If an error message appears, check Possible Error Message(s) to know how to proceed.

 

18. A summary window is displayed with the configuration's details.

 

New Configuration Step 4 Summary

 

19. If it all checks out, click Confirm button1.

The new configuration will be displayed in the "Configurations" page.

 

 

NoteTo have a configuration deployed into devices, you must create a deployment plan. For more detailed information, see Creating a Deployment.

 

 

TIPYou can use the 4 botoes buttons of the New Configuration wizard to navigate between steps.

 

TIPDo NOT forget to create a deployment for your configuration, otherwise the intended elements will NOT be delivered to the device(s).

 

 

Configuration Examples

 

To install a device compatible MCL-ClientExample 1 - To Install a Device Compatible with "MCL-Client"

 

To add an MCL application to a device.Example 2 - To Add an "MCL" Application to a Device

 

hmtoggle_plus1Example 3 - To Update the "MCL-Agent" Firmware of a Device

 

hmtoggle_plus1Example 4 - To Install "MCL Applications" without specifying a Target Device

 

TIPDo NOT forget to create a deployment for your configuration, otherwise the intended elements will NOT be delivered to the device(s).

 

 

 

Possible Error Message(s)

 

 

Error Message Invalid Zip File

 

Occurrence: When trying to upload an imported file.

Cause: Any imported application must have a .pdk extension.

Action: Repeat the import operation and select a file with the correct extension.

 

Error Message_No destination Path

 

Occurrence: When clicking Button_Save, on the "New Configuration step 4 (Misc tab)" wizard page.

Cause: The added resource does not have a .pdk, an .apk or .cab extension and no path was provided.

Action: Enter a path to locate the file.