Editing a Configuration

Navigation:  Managing a Site > Application Management > Configurations >

Editing a Configuration

Previous pageReturn to chapter overviewNext page

 

Overview

 

It is possible to edit the details of a configuration, as long as the configuration is not associated to a deployment. If the configuration is, already, part of a deployment plan, by editing it, you will be creating an incremented version of that configuration.

 

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, the following message is displayed:

Note for new config version

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

 

Site Configurations Edit1

 

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

 

Configuration Properties

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 Type

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

Restrict Configuration... (to current Site)

If required, restrict access of this particular configuration to this site. This option is only available if, at the moment of editing, the configuration is not associated to a deployment.

Description

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

 

5. Go to the "Firmwares" tab.

 

6. Depending on the product/firmware package version associated to the configuration, there are different edition options. Below is an example for each situation:

 

Firmwares tab without firmware options:

 

Configuration Details Firmwares tab edit

 

The "Firmwares" tab allows you to edit the following fields:

 

Configuration Firmwares

Product

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

Firmware Options

Options

The selected MCL product does NOT offer any firmware options, therefore, there is nothing to edit.

 

Click info button to open a "Packages" window and view the name of the selected firmware package version.

 

Packages Window1

 

Firmwares tab with firmware options:

 

Site Configurations Edit3A

 

Since the selected MCL product offers firmware options, make your selection according to the imposed rules.

Select a minimum and a maximum number of firmware options:

 

Configuration Firmwares

Product

Select a different product from the drop-down list.

Version

Define the selected product's version from the available options in the drop-down list.

Firmware Options

ASR (automatic speech recognition) Language V3

Select a minimum of one or maximum of two ASR firmware options.

TTS (text to speech) Language V3

Select a minimum of one or maximum of two TTS firmware options.

 

Click info button to open a "Packages" window and view the name of the selected firmware package version.

 

Packages Window2

 

7. Go to the "Applications "tab.

 

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:

 

Adding applications to the configuration

 

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

 

Select Application Window

 

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

 

c. Click Add Check Gray Button and return to the "Applications" tab which displays the newly added application(s).

 

d. If this is all the editing you want to execute, click Confirm button (step 11) to apply the modifications. If not, edit this tab further (execute any of the available operations) or proceed to the "Misc" tab (step 9).

 

Import an application into a configuration

 

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

 

Select Application Window

 

b. Click Import an Application Button which opens an "Import Application" window.

 

Import an Application window

 

c. Click Add Button Blue to open an OS file explorer window.

 

OS File Explorer window3

 

d. Select the required file and click Open.

 

NoteThe selected file must have a .pdk or .cab 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 you have more files to add, repeat steps c and d.

The added application(s) can be deleted, at any time. To do so, click the corresponding Button_Delete0. If you want to delete all applications at once, click Button_Clear all.

 

e. Click Button_Upload.

 

Select Application Window Result

 

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

 

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

 

g. If this is all the editing you want to execute, click Confirm button (step 11) to apply the modifications. If not, edit this tab further (execute any of the available operations) or proceed to the "Misc" tab (step 9).

 

Removing applications from the configuration

 

a. Click the corresponding Button_Delete0 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.

 

c. If you have finished your editing, click Confirm button (step 11) to apply the modifications. If not, edit this tab further (execute any of the available operations) or proceed to the "Misc" tab (step 9).

 

Adding resources to an existing application

 

a. Click the corresponding Button_add resources of the application you want to add resources to.

 

Upload Resource0

 

b. Click Add Button Blue and open an OS file explorer window.

 

OS File Explorer window2

 

c. Select the appropriate file and click Open.

 

Upload resource window 2

 

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

Added resource(s) can be deleted at any time. To do so, click the corresponding Button_Delete0 or, if you want to delete all resources at once, click Button_Clear all.

If you are done adding resources, continue to step e. If you want to add more resources repeat steps b and c.

 

e. Click Button_Upload to return to the "Configuration details" page.

 

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

 

Resources Display window

 

f. If you are done editing, click Confirm button (step 11) to apply the modifications. If not, edit this tab further (execute any of the available operations) or proceed to the "Misc" tab (step 9).

 

Removing resources from an existing application

 

a. Click the corresponding resource(s) (displayed in light blue) to open the "Resources" window.

 

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.

 

d. If you have finished your editing, click Confirm button (step 11) to apply the modifications. If not, edit this tab further (execute any of the available operations) or proceed to the "Misc" tab (step 9).

 

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

 

Configuration Details Misc Tab Edit

 

10. The "Misc" tab allows you to:

 

Add resources to a configuration

 

a. Click Button_add resources to open an "Upload Resource" window.

 

Upload Resource Window 0

 

b. Click Add Button Blue to open an OS file explorer window.

 

 

OS File Explorer window4

 

c. Select the appropriate resource file and click Open.

 

NoteIf you upload files with a .pdk 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 or .cab) to a known location, you can use the corresponding alias in the path.

<APPS>, <SHARED> and/or <MCL> are the available aliases you can enter (ex: <APPS>\User_Guide\).

 

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

 

 

 

Upload resource window 3

 

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

Resources can be deleted at any time. To do so, click the corresponding Button_Delete0 or, if you want to delete all resources at once, click Button_Clear all.

 

d. If you have more resource files to add, click Add Button Blue and repeat step c.

If you are done adding resources, continue to step e.

 

e. Click Button_Upload, which will automatically upload the added resource(s) and return you to the "Configuration details" page.

 

Remove resources from a configuration

 

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

 

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

 

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

 

 

 

Possible Error Message(s)

 

Error Message Invalid Zip File

 

Occurrence: When trying to upload an imported application.

Cause: Any imported application must have a pdk or .cab 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 or .cab extension and no path was provided. Without the path, the file cannot be located.

Action: Enter a path to locate the file.

 

Error Message_Invalid Application File

 

Occurrence: When clicking Button_Upload (in the "Import Application" window) to upload an imported application file into a configuration.

Cause: The imported file does not have a .pdk or .cab extension.

Action: Repeat the application import but select a file with a .pdk or .cab extension.