Creating a Configuration

Navigation:  Managing a Site > Application Management > 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 model (Device Groups). A configuration that is created in a particular site is, by default, shared with the other sites in the account (unless the configuration is restricted to a specific site).

The creation of a configuration is divided into 4 main steps/tabs - "Properties"; "Firmwares"; "Applications" and "Misc". 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 Misc" steps/tabs and just fill in the "Properties" and "Firmwares" steps/tabs.

When delivering an application to a device, the corresponding configuration requires you fill in the "Properties" and "Applications" tabs.

 

 

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 Button 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 and/or dash characters are allowed

Always start the entity's name with an alphabetic character

Version *

Define the configuration's version.

Device Type *

Select the manufacturer and the model of the configuration's target device from the corresponding drop-down boxes. As an alternative, click lupa button and select a device type in the resulting window. See Detail of 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.

 

Restrict Configuration...(to current Site)

Check this option to limit the configuration's use to the current site (by default, configurations are available to all sites within the account).

Description

If relevant, add notes regarding the new configuration.

 

Detail of Select Device Type window

 

Select a device A

 

a. Clicking lupa button opens a "Select Device Type" window with the available device types displayed in a grid view. (The “Device Type“ list only displays the devices selected for the current site. For more detailed information, see "Site Details" - Device Types tab. )

 

b. Select the device type by checking the corresponding Check box and click Select Green Button to return to the "New Configuration step 1 (Properties tab)" wizard page.

 

Use the following options to control the display of listed items:

 

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

 

I. Enter what you want to search for.

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

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

 

Manufacturer drop down boxFilter the item display by selecting a specific manufacturer from the drop-down list.

 

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

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.

Ex: Select a minimum and a maximum number of firmware options by checking the corresponding Check box in each tab.

If you want to use MCL's login application, check the option in the "Login Application *" tab. (There is a speech and a non-speech version of this application. Depending on the selected product, you will be provided with the compatible version. See MCL Operator Login Application.)

Since the selected product is "MCL-Client V4 Enterprise Voice", the available Login application will also have speech attributes.

 

new Configuration Step 2 Firmware Options

 

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

 

Packages Window2

 

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

 

This window displays the available applications and corresponding versions.

 

If required, use 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. To conclude the search operation, empty the search box and click lupa button or press <ENTER> in your PC keyboard.

 

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

As an alternative, continue to step 11 and import an application.

 

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

 

Import an Application window

 

12. Click Add Button Blue to open an OS File Explorer window.

 

LoadTestGoToRoutine

 

13. Select the intended application and click Button_Open.

 

NoteThe imported file must have a .pdk extension.

Any other file extension results in an error message and an aborted import. If there are any error messages, check Possible Error Message(s) to know how to proceed.

 

The selected file is displayed in the "Import Application" window.

 

Import Application window Upload

 

If necessary, delete the newly imported application(s):

To delete one application at a time, click the corresponding Button_Delete0.

To delete all applications at once, click Button_Clear all.

 

14. Once you have imported the required application(s), click Button_Upload.

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

 

Select Application Result Window

 

The imported file is, now, displayed in the "Select Application" window.

 

15. Check the Check box of the application version(s) you want to add to the configuration.

 

16. Click Add Check Gray Button and return to the "New Configuration step 3 (Applications tab)" wizard page.

 

New Configuration Step 3 Result

 

17. If you want to add more applications, click Add Applications button and repeat steps 9 to 16.

 

18. If required, add resources to an application. Click the corresponding Button_add resources attached to the application you want to add resources to and continue to step 19.

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

 

Upload Resource0

 

19. Click Add Button Blue and open an OS File Explorer window.

 

LoadEnglishLoc

 

20. Select the appropriate file and click Open.

 

Upload resource window 2

 

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

 

If necessary, it is possible to delete the newly added resource(s):

To delete one resource at a time, click the corresponding Button_Delete0.

To delete all resources at once, click Button_Clear all.

 

21. If you are done adding resources, click Button_Upload and continue to step 22. The resource is automatically uploaded and displayed in the "New Configuration step 3 (Applications tab)" wizard page.

If you want to add more resources, repeat steps 19 and 20.

 

New Configuration Step 3 Result 2

 

22. If required, click the corresponding "associated resources" option of the intended application (displayed in light blue) to view or remove any resources included in each application.

 

Resources Display window

 

Added resources can be removed from the application:

 

a. Select the resource(s) you want to delete by clicking the corresponding Check box.

b. Click Remove Button to conclude the operation.

 

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

 

Step 4 Misc 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 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.

 

24. If required, click Button_add resources to add resources to your configuration.

 

Add Resources Window

 

25. In the resulting window, click Add Button Blue. This opens an OS File Explorer window.

 

LoadItems

 

26. Select the appropriate resource and click Button_Open.

 

Upload Resource to Configuration window

 

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

 

If necessary, it is possible to delete the newly added application(s):

To delete one application at a time, click the corresponding Button_Delete0.

To delete all applications at once, click Button_Clear all.

 

27. If there are no more resources to add, click Button_Upload. If you want to add more resources, repeat steps 25 and 26.

 

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> and/or <MCL> are the available aliases you can enter (ex: <APPS>\User_Guide\).

 

NoteDo NOT upload MCL .cabs into the "Misc" 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 "Misc" 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_Delete0.

 

28. Complete the configuration creation by clicking Button_Save.

 

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

 

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

 

 

 

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.

 

 

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.

 

 

 

Configuration Examples

 

 

Example 1

 

Purpose: To install a device compatible MCL-Client.

 

1. In the Configurations" page, click Add Configuration Header Button.

 

2. Fill in the "Properties" tab:

 

a. Define the name and version for the new configuration - "Client for WT6000 A5".

b. Select the target device type's manufacturer and model - "Zebra / WT6000-Android 5".

 

Config Example 3a

 

3. Click Button_Next to continue to the "Firmwares" tab.

 

4. Select the appropriate product and version in the corresponding drop-downs:

 

a. Select the device compatible MCL-Client - "MCL-Client V4 Enterprise".

b. Select the most recent firmware version available - "4.05P83".

 

Config Example 3b

 

5. Click Button_Next until you reach the "Misc" tab (there is nothing to fill in in the "Applications" tab).

 

6. Click Button_Save to conclude the configuration (there is nothing to do in the "Misc" tab itself).

 

 

Example 2

 

Purpose: To add an MCL application to a device.

 

1. In the Configurations" page, click Add Configuration Header Button.

 

2. Fill in the "Properties" tab.

 

a. Define the name and version for the new configuration - "STD Inventory".

b. Select the target device type's manufacturer and model - "Motorola / MC65-Windows Mobile 6".

 

Config Example 4a

 

3. Click Button_Next until you reach the "Applications" tab.

 

Config Example 4b

 

4. Click Add Applications button to open the "Select Application" window and select the intended application ("Standard_Inventory").

 

Config Example 4c

 

5. Click Add Check Gray Button and return to the "Applications" tab.

 

Config Example 4d

 

6. Click Button_Next to proceed to the "Misc" tab and, then, click Button_Save to conclude the configuration (there is nothing to do in the "Misc" tab itself).

 

 

Example 3

 

Purpose: To update the MCL-Agent firmware of a device.

 

1. In the Configurations" page, click Add Configuration Header Button.

 

2. Fill in the "Properties" tab.

 

a. Define the name and version for the new configuration - "MC75A Firmware Update".

b. Select the target device type's manufacturer and model - "Motorola / MC75A-Windows Mobile 6".

 

Config Example 1a

 

3. Click Button_Next to continue to the "Firmwares" tab.

 

4. Select the appropriate product and version in the corresponding drop-downs:

 

a. Select the device compatible MCL-Agent - "MCL-Agent V4 Enterprise".

b. Select the most recent firmware version available - "4.05P83".

 

Config Example 1b

 

5. Click Button_Next until you reach the "Misc" tab (there is nothing to fill in in the "Applications" tab).

 

6. There is nothing to add to the "Misc" tab so, click Button_Save to conclude the configuration.

 

 

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