Editing a Configuration

Navigation:  Managing a Site > Applications > Configurations >

Editing a Configuration

 Previous pageReturn to chapter overviewNext page

 

Overview

 

The site manager/site users with the proper access rights can ONLY edit the configurations that were created within the site and have NOT been associated to a deployment. If the configuration is, already, part of a deployment plan, its editing will create an incremented version of that configuration.

Configurations created at account level CANNOT be edited at site level.

 

Step-by-step

1. In the Site Dashboard's "Control Panel" section, click Applications button and, then, in the resulting row below, click Configurations Sub Module Button to access the "Configurations" page.

 

Site Configurations0

 

2. Click the name of the configuration you want to edit (displayed in light blue).

 

Site Configurations det0

 

3. The resulting "Configuration Details" page is in view mode. Click Edit button to set the page to edit mode.

The "Properties" tab is open, by default.

 

NoteIf the configuration being edited is associated to a deployment and the deployment has started, the following message is displayed:

Note for new config version

The editing will result in an incremented version of that configuration.

 

Site Configurations Edit1a

 

4. Edit the available options and make sure that the mandatory fields (marked with an asterisk) contain information:

 

Name

The configuration's name. This field is NOT editable.

Version *

Define a new version number. If you edit a configuration, already involved in deployments, and do not change it, when you save your modifications, the version number will automatically be incremented.

Device Model

The configuration's target device (manufacturer, model and OS version). This field is NOT editable.

Qualification

Not Editable. See Qualification.

Site Restriction

Not Editable.

Description

Maintain or edit the displayed information. These notes are displayed in the "Description" field of a "Configurations" page.

 

5. Go to the "Firmwares" tab.

 

6. The editable options available depend on the selected Firmware product.

Click the examples below:

 

Firmwares tab without firmware options:"Firmwares" Tab without Firmware Options:

 

Site Configuration Details Firmwares tab edit_a

 

If you intend to keep this firmware/firmware version, there is nothing to edit.

If you intend to edit the configuration's firmware, proceed as follows:

 

Firmware

Select a different product from the drop-down list.

Firmware Package Version

Define the corresponding firmware package version from the available options in the drop-down.

Firmware Options

Options

If the previously selected firmware has available firmware options, select among the available options and according to the imposed rules.

 

 

Firmwares tab with firmware options:"Firmwares" Tab with Firmware Options:

 

Site Configurations Edit3A_a

 

 

Firmware

Maintain or select a different product from the drop-down.

Firmware Package Version

If necessary, choose the appropriate product version from the available options in the drop-down.

 

If you want to view the name of the available firmware package version, click the attached info button to open a "Packages" window.

 

Packages Window2

 

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

 

Firmware Options

ASR Languages V4

Maintain or select other ASR languages (minimum of one/maximum of two):

 

▪To remove an ASR language, use the corresponding Button_Delete;

 

▪To add an ASR language, click the Add ASR button button, check the intended language in the resulting list and click Add Check Gray Button to apply.

TTS Languages V4

Maintain or select other TTS languages (minimum of one/maximum of two):

▪To remove a language, click the corresponding Button_Delete.

 

▪To add a TTS language,click Add TTS button, select another language from the resulting list and click Add Check Gray Button to apply.

Login Application

Maintain or select a different MCL "Login Application"/application version. (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.)

 

▪Use the Button_Delete option to remove the current login application from the configuration.

 

▪Click Add Login App button to add the intended application/application version.

Add Speech Control Panel (Blind)

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.)

 

If required, use the corresponding Button_Delete to remove this firmware option from the configuration.

If you intend to add this product to the configuration, click Add Speech Control Panel button, check the listed option and click Add Check Gray Button to include it in the current configuration.

 

 

If you want to view the name of the available firmware package version, click info button to open a "Packages" window.

 

Packages Window0

 

If required, use the search box to filter the display of resources:

 

a. Enter what you want to search for.

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

c. To conclude the search operation, empty the search box and click lupa button or press <ENTER> in your PC keyboard.

 

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

 

 

Note

When editing the TTS languages, do NOT select/add a standard and a compact TTS file for the same language/gender. The device will NOT run both files, it will ONLY use the more recently downloaded TTS language file.

 

7. Go to the "Applications "tab.

 

Site Configuration Details App Tab Edit

 

8. The "Applications" tab displays the applications included in the configuration.

Each application also displays its internal resources. You can click the corresponding "associated resources" option (which is displayed in light blue) to access those resources' details.

 

There are several operations available:

 

hmtoggle_plus1Adding Applications to the Configuration

 

a. Click Add Applications button and open the "Select Application" window.

 

Select Application Window_Site

 

b. Select the required application(s) by checking the corresponding Check box.

 

c. Click Confirm button and return to the "Applications" tab which displays the newly added application(s).

 

 

hmtoggle_plus1Importing an Application into a Configuration

 

a. Click Add Applications button and open the "Select Application" window.

 

Select Application Window_Site

 

b. Click Import an Application Button (on the upper right corner) which opens an "Import Application" window and an overlapping OS browse window.

 

OS File Explorer window3

 

c. Select the required file and click Open.

 

NoteThe selected file must have a ".pdk" extension. Any other file type will NOT be uploaded. Check the Possible Error Message(s) to know how to proceed.

 

Import Application window Upload

 

If necessary, you can delete added files. To delete one file, click the corresponding Button_Delete. To delete all added files, at once, click Button_Clear all.

 

d. Click Button_Upload1.

 

Select Application Result Window_Site

 

The imported application is, now, displayed in the "Select Application" window and available to be added to the configuration.

 

e. If you need to import more applications, repeat steps a to d - applications can ONLY be added one at a time to the "Select Application" window.

 

f. Check the Check box of the intended application(s) and click Add Check Gray Button to return to the "Applications" tab which displays the newly added application(s).

 

 

hmtoggle_plus1Removing Applications from the Configuration

 

a. Click the Button_Delete of the application(s) you want to remove from the configuration.

 

Delete App Confirmation Window

 

b. Confirm the operation, in the resulting window, by clicking Button_OK. This returns you to the "Applications" tab.

 

 

hmtoggle_plus1Adding Resources to an existing Application

 

 

a. Click the Button_add resources button of the application you want to add resources to. This opens an OS browse window.

 

OS File Explorer window2

 

b. Select the appropriate file and click Open.

 

Upload resource window 2

 

c. The resource file is displayed in the "Upload Resource" window.

If necessary, you can delete added files. To delete one file, click the corresponding Button_Delete. To delete all added files, at once, click Button_Clear all.

If you are done adding resources, continue to step d. If you want to add more resources, click Add Button Blue to open an OS browse window and select another resource file.

 

d. Click Button_Upload1 to return to the "Configuration Details" page.

 

The resource is automatically uploaded. It can be viewed, if you click the "Associated resources" option (displayed in light blue) from the corresponding application.

 

Resources Display window

 

 

hmtoggle_plus1Removing Resources from an existing Application

 

a. Click an application's "associated resources" option (displayed in light blue) to open the "Resources" window and view its resources.

 

Resources Display window

 

b. Select the resource(s) you want to remove by checking the corresponding Check box.

 

c. Click Remove Button to conclude the operation and return to the "Applications" tab.

 

 

9. Once you have completed all the necessary changes in the "Applications" tab, proceed to the "Others" tab.

 

Site Configuration Details Misc Tab Edit

 

10. The "Others" tab allows you to:

 

hmtoggle_plus1Add Resources to a Configuration

 

a. Click Button_add resources to open an OS browse window and an "Upload Resource" window in the background.

 

OS File Explorer window4

 

b. Select the appropriate resource file and click Open.

 

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 order to locate the file. The path must start and end with a backlash (ex: \Temp\) to ensure it is compatible with the Windows Mobile and Android operating systems.

 

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.

 

 

MCL Alias List

 

Alias

Target folder (Windows devices)

Target folder (Android devices)

<MCL>

(the folder where MCL components are installed)

No default absolute path - it depends on device model and OS.

No default absolute path - it depends on device model and OS.

<APPS>

MCL\Apps

files\apps

<INSTALL>

MCL\Install

files\Install

<SYSTEM>

MCL\System

files\System

<SHARED>

MCL\Shared

The path to the root of the "external storage" disk depends on device model and OS.

<SD>

\"device name"\Storage Card\"file name"

No default absolute path - it depends on device model and OS.

 

Ex:Storage\sdcard1\Android\data\com.mcltechnologies.android.agent."manufacturer"\files\"file name"

 

NoteReading/Writing permissions depend on the device's model and OS version.

<SDROOT>

\"device name"\Storage Card\"file name"

No default absolute path - it depends on device model and OS.

 

Ex: Storage\sdcard1\"file name"

 

NoteReading/Writing permissions depend on the device's model and OS version.

 

For more detailed information on the "<SD>" and "<SDROOT>" aliases, register/log in to our MCL Community and access our MCL Knowledge Base (The Use of the <SD> and <SDROOT> MCL Aliases")

 

 

Note

When entering a path, start with a backslash. This ensures project compatibility with the Windows Mobile/Windows CE and Android devices (ex: "\MCL\Apps\"running application" or "\MCL\Shared").

 

 

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 1GB.

 

 

 

Upload resource window 3

 

The resource file is displayed in the "Upload Resource" window.

If necessary, you can delete added files. To delete one file, click the corresponding Button_Delete. To delete all added files, at once, click Button_Clear all.

 

c. If you have more resource files to add, click Add Button Blue to reopen the OS browse window and select other files.

 

d. Once you are done, click Button_Upload1 to upload the added resource(s) and return you to the "Others" tab.

 

 

hmtoggle_plus1Remove Resources from a Configuration

 

Configuration Details Misc Tab Edit1a_Site

 

a. Click the Button_Delete of the resource(s) you want to remove from the configuration.

 

 

hmtoggle_plus1Download Resources from an Application contained in a Configuration

 

Configuration Details Misc Tab Edit1a_Site

 

a. Click the icon download file of the resource(s) you want to download.

b. In the opened browser's page (if the file is a PDF file) or in the "Save as" OS window (for other file types), use the available Download/Save option to download and save the file.

 

 

hmtoggle_plus1Changing the configuration's resources delivery order

 

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

 

Configuration Details Misc Tab Edit1a_Site

 

a. Move the resources up and/or down by clicking the corresponding Resources order according to the order you want to define.

 

 

11. Once you have entered the required modifications, click Confirm button to apply them. The page returns to view mode and displays the modifications.

 

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

 

 

See Configuration Examples.

 

 

Possible Error Message(s)

 

Error Message_Invalid Application File

 

Occurrence: When trying to upload an imported application.

Cause: The imported file does not 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 Confirm button.

Cause: The added resource does not have a .pdk, an .apk or .cab extension and no path was provided. Without the path, the file cannot be located.

Action: Enter a path to locate the file.