**Note**. Apptimized shows the following screen when the user logs in after registration (see [**Register to Apptimized Portal**](https://docs.apptimized.com/books/apptimized-admincenter-user-manual/page/single-sign-on#bkmrk-register-to-apptimiz)): [](https://docs.apptimized.com/uploads/images/gallery/2021-09/7I3eGDTnhRVRi4CL-sso_reg_4.png)
When a user does not have an assigned project, Apptimized shows the **Create new page** screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Gg7LKr44kfK9cCRK-log_05.png) A manual to create a project is available at the chapter [**Create project**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/create-project "Create project"). When a user has an assigned project, Apptimized shows the **Project list page** screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/hkfEmE4iP2jrxmCa-log_03.png) A project assigns to a user by a project administrator. When a user logs in after invitation via email, Apptimized shows the project user has been invited to (see [**Invite via email**](https://docs.apptimized.com/link/244#bkmrk-if-the-person-does-n)): [](https://docs.apptimized.com/uploads/images/gallery/2021-09/68lqUF8jL5K3Olbw-sso_reg_5.png) When a user logs in via trial account, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2021-09/iIuW4HTnMYgmqThl-onb1.png) The notification about the remaining trial period is displayed in the header: [](https://docs.apptimized.com/uploads/images/gallery/2021-09/cWQRmbAGtaUIeh6M-on_b_3.png) [](https://docs.apptimized.com/uploads/images/gallery/2021-09/08IBz5Is6cgDWqz9-on_b_4.png) The option to **cancel a subscription** is available under the **Your Workspace trial end in X days** button. Apptimized shows the following modal window when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-09/tcuQkLcwGvcm9Tbc-on_b_5-(1).png) The option to **Confirm subscription cancellation** is available under **Yes** button. Apptimized shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-09/E3B3xIiELth0cYZG-on_b_6.png) ### User Guides The User Guides enable a user to check the step-by-step instruction of using the Apptimized platform and solutions. The option to check the user guides is available under the **Information** button. [](https://docs.apptimized.com/uploads/images/gallery/2021-01/fqMjRsEnrVNrnM01-guides_1.png) Apptimized solution guides are also available in PDF format.| **Solution** | **Description** | **User Guide** |
| Apptimized Workspace | Packaging Self-service to package and test applications from Apptimized portfolio (check the **[Packaging](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/packaging "Packaging")**). | [](https://docs.apptimized.com/attachments/126) |
| Apptimized Catalogue | Pre-packaged applications on-demand (check the [**Catalogue**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/catalogue)). | [](https://docs.apptimized.com/attachments/127) |
| **Notification type** | **Description** | **Example** |
| Blue banner | This notification provides some news. | [](https://docs.apptimized.com/uploads/images/gallery/2020-04/tTHiUx017cppyl4n-notif_02.PNG) |
| Green banner | This notification informs a user about success action. | [](https://docs.apptimized.com/uploads/images/gallery/2020-04/p6qEUbS9SKXIXziP-notif_03.PNG) |
| Yellow banner | This notification warnings a user. | [](https://docs.apptimized.com/uploads/images/gallery/2020-04/gAzv3dvkZOQppqBq-notif_04.PNG) |
| Red banner | This notification informs a user about danger or failure action. | [](https://docs.apptimized.com/uploads/images/gallery/2020-04/NVuNPCzNpCoFV2Js-notif_05.PNG) |
**Note.** “**Import**” step comes with 2 predefined features (**Classic import** and **Import by CSV file**) and 2 additional paid features (**SCCM import** and **Catalogue & UM Import**). To activate **SCCM import** feature the **SCCM Integration** module must be enabled for the project. The one-time configuration is available for project administrators under **Settings** in the project menu **> Integration > SCCM.** To activate **Catalogue & UM Import** feature the **Update monitoring/Catalog** module must be enabled for the project. The one-time configuration is available for project administrators under **Settings** in the project menu **> Update monitoring** **> Enable Update Monitoring / Enable vulnerability Notifications.**
A new step in the project workflow is created by clicking on the **Add step** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-03/Oqn9xq71gUFH1xh5-create_04.png) Step renaming in the workflow is available by clicking on the relevant field. [](https://docs.apptimized.com/uploads/images/gallery/2020-03/WY7zAR862TwImREU-create_07.png) Exclude a step from the workflow by clicking on the **bin** symbol. [](https://docs.apptimized.com/uploads/images/gallery/2020-03/8s5J99dp4kGPNoXp-create_05.png) The portal provides verification for permissions. This means that at the workflow construction stage, the user sees only those modules at the **"Pick a module"** box for which he has permissions. A workflow module is added when dragged and dropped from the "**Pick a module**" box to the workflow step. [](https://docs.apptimized.com/uploads/images/gallery/2020-03/x5M4sG6JCKsimFkM-create_06.png) The block is removed from the project workflow when dragged and dropped from the workflow step to the "**Pick a module**" box.| Module name | Details |
| Discovery – Self Service | A user installs an application on the chosen Microsoft Windows platform. A user automatically documents an installation, configuration, and test activities. A user can collaborate with his co-workers and Apptimized support staff. |
| Discovery – Factory Service | Apptimized installs, configures, and tests an application for a user. Apptimized documents the configuration for a user. Apptimized contacts a user if any details are needed. |
| Packaging – Self Service | A user packages the application using the Apptimized Packaging Tool. A user creates and customizes MSI package and App-V sequence. A user customizes an existing package or sequence. A user tests and debugs installations. |
| Packaging – Factory Service | Apptimized packages an application for a user. Apptimized customizes the MSI or App-V output to meet user’s requirements. Apptimized contacts a user if any details are needed while packaging an application. Apptimized notifies a user when the application is ready for testing. |
| Testing – Self Service | A user tests created packages on his own. A user runs and documents test cases. A user logs installation or functional errors. A user provides debugging guidance. |
| Testing – Factory Service | Apptimized tests created packages for a user. Apptimized runs and documents test cases based on user’s requirements. Apptimized logs installation or functional errors. Apptimized debugging guidance. |
| 1. General settings: - Project settings; - Characters substitutions. 2. Workflow: - Import; - Step settings. 3. Echo; 4. Integration: - Intune; - ServiceNow; - SCCM. 5. Update Monitoring; 6. Storage 6. Virtualization - General; - Providers. 7. Apptimized TO GO. | [](https://docs.apptimized.com/uploads/images/gallery/2023-03/6Hzg9Sr7mVxgmA03-project_settings_02_new-1.png) |
| **Setting** | **Description** |
| Follow workflow rules | Enforces the provision of a source and documentation. |
| Can skip steps | Allows moving forward in the workflow without satisfying process requirements such as providing a source, documentation, or completing the current step. |
| Revert to Import step | Allows moving backward to the start of workflow in order to replace the application source. |
| Revert back completed apps | Allows moving backward from the final workflow step to change applications that are already marked as completed. |
| **Setting** | **Description** |
| Installation source | This setting enables a field for source file uploading if switched on. |
| Documentations/Instructions | This settings enables a user to add the **Discovery document** field to upload the discovery document under it. |
| Mandatory | This setting enables a user to make the **Discovery document** setting as mandatory. This setting displays only if **Discovery document** setting switched on. |
| Application icon for Intune | This setting enables a user to add the Application icon for Intune field to upload the Icon for the application and made it available during the Intune push (see https://docs.apptimized.com/books/apptimized-platform-admin-manual/page/upload-package-to-the-microsoft-intune-from-the-apptimized-portal) |
| Mandatory | This setting enables a user to make the **Application icon for Intune** setting as mandatory. This setting displays only if **Application icon for Intune** setting switched on. |
| Application owner | This setting enables Application owner field under application metadata, and enables [additional project permissions](https://docs.apptimized.com/link/243#bkmrk-attribute-descriptio) under role permissions list |
| Mandatory | This setting enables a user to make the Application owner as mandatory. This setting displays only if Application owner setting switched on. |
| Architecture | This setting enables the **Architecture** field under application metadata and allows defining the application architecture. |
| **Language code** | **Description** | **Example** |
| Keep original | Apptimized saves the language code value a user indicated on the Import step | English (US) |
| ISO 639-1 (Uppercase) | A two-character code set entered with uppercase letters | EN |
| ISO 639-1 (Capitalize case) | A two-character code set entered with the capitalized letter | En |
| ISO 639-2 (Uppercase) | A three-character code set. Begins with a capital letter | ENG |
| ISO 639-2 (Capitalize case) | A three-character code set. Begins with a capital letter | Eng |
| **Category** | **Description** |
| Name | Indicates the name of the Custom field |
| Type | Indicates the type of Custom field. The following types are available: - Input - Select - Multiple select |
| Data type | Indicates the data type of Custom field. The following types are available:
- Integer
- Text
- DateTime
- Boolean
- Html
**Note.** **Data type **is available only if the **Input **type was selected. |
| Source type | Indicates the source type of Custom field. The following types are available:
- Custom
- Applications
- Users
**Note.** **Source type **is available only if the **Select** & **Multiple select **types were selected. |
| Required | Indicates the status of the custom field. The following statuses are available: - Yes - No |
**Note.** **Custom field options **section becomes available only if **Select **option was selected under the **Field type **dropdown list & **Custom **option was selected under the **Source type **dropdown list. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/ptfyMMU5S2VIPirZ-settings_custmfield_17_2.png) The option to add **Customfieldoptions** parameter is available after setting **Display & Value** fields. The custom field can be designated as required under the **Default** checkbox. The option to add a new entry is available under **plus** button. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/yc9FXcieOv2MWG0q-settings_custmfield_18.png) The option to delete entry is available under **bin** symbol. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/3qxpbkMAU87qDFZk-settings_custmfield_20.png)
Apptimized shows the following notification when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2022-02/U408cg8B9mMTEx09-settings_custmfield_09-(2).png) The option to edit **Custom field **name & **Required **switch is available under **Actions **block > **Edit**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/SLHLyIxNjoYD4ea8-settings_custmfield_10-(1).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/oY8wpx6MAskL1hAt-settings_custmfield_12-(1).png) The option to remove Custom field is available under the **Actions **block > **Remove**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/gGrUAPs9fukAaK2w-settings_custmfield_11-(2).png) Apptimized shows the following modal window when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/X5gHU9vZnBeDQ1eG-settings_custmfield_13-(1).png) To apply the settings, click the **Save **button. To revert the settings, click on the **Reset** button. Apptimized shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-08/KlE2PVQaDNJOgceA-image-32.png)**Note.** When the additional field settings are applied they appear in the application metadata block (i.e., at the Import step, at the application settings screen). [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/K9Yx39s0ZGcEnfi2-settings_custmfield_15-(1).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/vwVxauGtQaBvinaq-settings_custmfield_16-(1).png)
#### **Steps settings** The set of workflow settings depends on workflow structure (i.e., the number of steps, the set of module types) that was configured during project creation. The screenshot below shows the examples of possible workflow settings configurations. [](https://docs.apptimized.com/uploads/images/gallery/2020-08/7lVUj5VgohEdbcHm-steps_settings_01_new.png) #### **Discovery – Self Service** The screenshot below shows the default settings of the **Discovery – Self Service** module. All required fields are marked with an asterisk \*. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/pjZ5gbA3z4GEwJYz-discovery_selfservice_1.png) The option to change a module name is available under the **Module name** field. The default module name is **Discovery – Self Service.** The option to change a file name pattern is available under the **Document file name pattern** field. The default file name pattern is **\[Manufacturer\]\_\[ProductName\]\_\[ProductVersion\].html.** To insert the variable tag into the field, click the relevant variable tag from the dropdown list. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/YHDcNfqcjYWyqgs1-discovery_selfservice_2.png) The option to edit a discovery case template is available under the **Edit installation document template** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/D98wJDlaN78sB0sL-steps_settings_03.png) Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/A1zLkT22t1Vh3bpe-steps_settings_04.png)| **Option** | **Details** | **Default value** |
| Filter system noise during recording | This option allows for applying a filter (exclusion list) to automatically remove the captured system and user activity (noise). **Yes** and **No** options available. **Yes** – the value of this option removes redundant files and registry keys that were created by the system while recording sessions and did not relate to installing software (i.e., telemetry or diagnostics data). **No** – the system noise which is captured by the application packaging tool will not be removed. | Yes |
| Remove Desktop shortcuts | This setting indicates the option to remove all desktop shortcuts (**Yes**) from the package or to leave desktop shortcuts in the package (**No**). | Yes |
| Produce AppV | This setting indicates the option to generate a file in App-V format. **Yes** and **No** options available. | No |
| Produce VSL | This setting indicates the option to generate a file in VSL format. **Yes** and **No** options available. | No |
| Produce MSIX | This setting indicates the option to repackage software to MSIX format. **Yes** and **No** options available. | No |
| Produce MSI | This setting indicates the option to repackage software to MSI format. **Yes** and **No** options available. When **No** option is chosen, a legacy setup for software will be implemented if possible. | Yes |
| **Setting** | **Details** | **Default value** |
| Installation script name | This setting indicates the file name of the generated installation command line (msiexec command line). This setting indicates a filename template for naming the .CMD file to install the package. | install.cmd |
| Installation script content | This setting indicates the command line for installing the package. | msiexec /i "%~dp0\[MsiName\]" /qn |
| Uninstall script name | This setting indicates the command line file name for the package uninstallation. | uninstall.cmd |
| Installation script content with transforms | This setting indicates the command line for installing the package using the created **Transform** file. | msiexec /x \[ProductCode\] /qn |
| User interface | This setting indicates which parameter will be added to the msiexec command line. The following options available: - **No user interface** – the user interface does not show any wizard dialogue. - **Basic user interface** – only a progress bar will be shown during the installation, with the possibility to cancel this process by the Cancel button. - **Basic user interface with hidden “Cancel” button** – shows only progress bar without the ability to cancel the installation process. | No user interface |
| Default installation command line | This setting indicates the command line for the installation of the MSI with transform. | - |
| Installation log | This setting indicates the installation log mode. The following options available: - **None** (no logging available). - **Basic** (logging shows only errors appeared during installation/uninstallation). - **Full** (logging shows all informational, warning, error messages during installation/uninstallation). | Full |
| **Setting** | **Details** | **Default value** |
| Install command | This setting indicates the command line for installing the package. | Execute-MSI -Action 'Install' -Path "\[MsiName\]" -private:$PackageName |
| Install with transform command | This setting indicates the command line for installing the package using the created **Transform** file. | Execute-MSI -Action 'Install' -Path "\[MsiName\]" -Transform "\[MstName\]" -private:$PackageName |
| Uninstall command | This setting indicates the command line for uninstalling the package. | Execute-MSI -Action 'Uninstall' -Path '\[ProductCode\]' -private:$PackageName |
| Reboot required | This setting indicates the reboot mode. **Yes** and **No** options available. | No |
| User interface | This setting indicates which parameter will be added to the msiexec command line. The following options available: - **No user interface** – the user interface does not show any wizard dialogue. - **Basic user interface** – only a progress bar will be shown during the installation, with the possibility to cancel this process by the Cancel button. - **Basic user interface with hidden “Cancel” button** – shows only progress bar without the ability to cancel the installation process. | No user interface |
| Default installation command line | This setting indicates the command line for the installation of the MSI with transform. | - |
| Installation log | This setting indicates the installation log mode. The following options available: - **None** (no logging available). - **Basic** (logging shows only errors appeared during installation/uninstallation). - **Full** (logging shows all informational, warning, error messages during installation/uninstallation). | Full |
| **Setting** | **Details** | **Default value** |
| Installation script name | This setting indicates the file name of the generated installation command line (msiexec command line). This setting indicates a filename template for naming the .VBS file to install the package. | install.vbs |
| Installation script content | This setting indicates the command line for installing package. | set res = run("%windir%\\system32\\msiexec.exe /i " & chr(34) & "%~dp0\[MsiName\]" & chr(34) & " /qn", "0,3010", 0, true) wscript.quit(res.ReturnCode) |
| Installation script content with transforms | This setting indicates the command line for installing the package using the created **Transform** file. | set res = run("%windir%\\system32\\msiexec.exe /i " & chr(34) & "%~dp0\[MsiName\]" & chr(34) & " TRANSFORMS=" & chr(34) & "%~dp0\[MstName\]" & chr(34) & " /qn", "0,3010", 0, true) wscript.quit(res.ReturnCode) |
| Uninstall script name | This setting indicates the file name of the generated uninstallation command line (msiexec command line). This setting indicates a filename template for naming the .VBS file to ninstall the package. | uninstall.vbs |
| Uninstall script content | This setting indicates the command line for uninstalling package. | set res = run("%windir%\\system32\\msiexec.exe /x \[ProductCode\] /qn", "0,3010", 0, true) wscript.quit(res.ReturnCode) |
| User interface | This setting indicates which parameter will be added to the msiexec command line. The following options available: - **No user interface** – the user interface does not show any wizard dialogue. - **Basic user interface** – only a progress bar will be shown during the installation, with the possibility to cancel this process by the Cancel button. - **Basic user interface with hidden “Cancel” button** – shows only progress bar without the ability to cancel the installation process. | No user interface |
| Default installation command line | This setting indicates the command line for the installation of the MSI with transform. | - |
| Installation log | This setting indicates the installation log mode. The following options available: · **None** (no logging available). · **Basic** (logging shows only errors appeared during installation/uninstallation). · **Full** (logging shows all informational, warning, error messages during installation/uninstallation). | Full |
| **Setting** | **Details** | **Default value** |
| Installation context | This setting indicates the installation context mode. The following options available: - **Per-user** (access to a program is granted only to a user from which a program was installed); - **Per-machine** (the package installation is required to enable all computer users to access and use the application. A per-machine installation is based on ALLUSERS property value. The per-machine installation provides changes to the system that affects all users. Standard users with limited privileges will be restricted to install a package in the per-machine context. First, obtaining permission is needed. - **Per-user or per-machine** (If this is a per-user installation, the registry value is **HKEY\_CURRENT\_USER**; if this is a per-machine installation, the registry value is **HKEY\_LOCAL\_MACHINE**. A per-machine installation is based on ALLUSERS property value. | Per-machine |
| Destination drive | This setting indicates the drive where a package will be installed, set value for ROOTDRIVE property of MSI. The ROOTDRIVE property specifies the default drive for the destination directory of the installation. [Learn more](https://msdn.microsoft.com/en-us/library/windows/desktop/aa371372(v=vs.85).aspx). The following options available: - C:\\ - D:\\ | C:\\ |
| **Setting** | **Details** | **Default value** |
| Reboot after install | This setting is based on the REBOOT property value. The REBOOT property suppresses certain prompts for a restart of the system. The following options available: - Never; - Always; - At the end of a chain. | Never |
| Shut down any files in use | This setting is based on the MSIRMSHUTDOWN property value. When the default value (**Yes**) is set, all system services and files that were shut down to install the update will be restarted. The following options available: - Yes; - If they are registered for a restart; - Only if they have all been registered. | Yes |
| If files are in use | This setting is based on MSIRESTARTMANAGERCONTROL property value. This setting enables setup authors to specify whether the package will use the Restart Manager or FileInUse Dialog to handle locked files. The following options available: - Use Restart Manager; - Use FilesInUse Dialog; - Disable Shutdown. | Use restart manager |
| Display of reboot prompts | This setting is based on REBOOTPROMPT property value. This property does not initiate a reboot if one is not needed, it only suppresses any prompts for reboots to the user. The following options available: - Suppress; - Do not set / Remove. | Suppress |
| **Setting** | **Details** | **Default value** |
| Show in ARP | This option specifies the listing mode of the program in the ARP (Add-Remove Program) and is based on ARPSYSTEMCOMPONENT property value. When the option is enabled, the program will be listed in the Add-Remove Program. When the option is disabled, the program will be hidden in the Add-Remove Program list. | Enabled |
| Manual repair from ARP | This option enables or disables the usage of the **Repair** button in the ARP for the package and is based on ARPNOREPAIR property value. When the option is enabled, the **Repair** button is added to the ARP for the package. When the option is disabled, the **Repair** button is removed from the ARP for the package. | Enabled |
| Manual uninstall from ARP | This option enables or disables the usage of the **Uninstall** button in the ARP for the package and is based on ARPNOREMOVE property value. When the option is enabled, the **Uninstall** button is added to the ARP for the package. When the option is disabled, the **Uninstall** button is removed from the ARP for the package. | Enabled |
| Manual feature modification from ARP | This option enables or disables the usage of the **Modify** button in the ARP for the package and is based on ARPNOMODIFY property value. When the option is enabled, the **Modify** button is added to the ARP for the package. When the option is disabled, the **Modify** button is removed from the ARP for the package. | Disabled |
| **Setting** | **Details** | **Default value** |
| Cab archive name pattern | This setting indicates the filename template for naming **.CAB** files. Cab files contain files that will be installed by MSI package. | Data{0}.cab |
| Max cab file size (in MB) | These settings indicate the number of files that will be placed in a single cab file. If the size of one cab file is bigger than the provided value, it will be divided into several cab files. | 2048 |
| Max files count per cab | 9999 | |
| Use embedded cab | This setting sets the mode to use an embedded file. When the **Use embedded cab** switch is enabled a **.CAB** file will be implemented into **.MSI**. When the **Use embedded cab** switch is disabled a **.CAB** file will be outside the **.MSI** (external CAB). It is a compressed source (opposed to "Loose files" = uncompressed source). | Yes |
| Parse ini files to the IniFile table | This option indicates the mode to parse ini files. When the **Parse ini files to the IniFile table** switch is enabled, the ini files will be added via an IniFile table. It is the best practice to add ini files via IniFile table because these files may contain hard-coded values, which in this case can be replaced with MSI properties. When the **Parse ini files to the IniFile table** switch is disabled, the ini files will be added via an File table. | No |
| Map registry data to the appropriate COM tables | This setting allows identifying objects and to add them to the appropriate tables. When the **Map registry data to the appropriate COM tables** switch is enabled, all COM objects will be mapped to MSI via special tables designed for these objects (ProgID, Classes, etc.). It is a better way of COM objects registration according to Microsoft's best practices and helps easily navigate and manage these objects through MSI. When the **Map registry data to the appropriate COM tables** switch is disabled all COM objects will be added to MSI via Registry table and installed as regular registry keys. | No |
| Post process MSI filesystem & components | This setting sets the File Table entries for the Language and Version fields. [Learn more](https://docs.microsoft.com/en-us/windows/win32/msi/file-versioning-rules?redirectedfrom=MSDN). | Yes |
| Mark components destined for the System folder as permanent | A system folder is used by other programs. If the package contains some System folder files, they can be removed from the system during uninstallation. So, it will affect other programs that use these files. When the **Mark components destined for the System folder as permanent** switch is enabled, the files will be marked as permanent and won’t be removed after the package uninstalling. When the **Mark components destined for the System folder as permanent** switch is disabled, the files will be deleted after the package uninstalling. | Yes |
| Use Duplicate File table for user files installation | Some files (.DLL, .OCX, etc.) that are installed in the Common Files folder is used by other programs. If the package contains some of these files they can be removed from the system during uninstallation. So, this affects other programs that use these files. When the **Use Duplicate File table for user files installation** switch is enabled, the files mark as shared. Every time when such files are installed in this folder, a counter is incremented. This counter shows how many programs use this file. When the package tries to remove this file, the counter is decremented. When this counter equals 0 this file removes from the system. | Yes |
The created bundle(s) will appear on the VM while Packaging Self-Service (see the **[Packaging](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/packaging "Packaging")**).
The Workspace Launcher section is available under **Project Settings** > **Workflow** > **Packaging – Self Service** > **Workspace Launcher**. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/dcijzvI3QNZ3rGtD-launcher_selfservice_1.png) The option to create a new bundle is available under the **Create new bundle** button. Apptimized shows the following modal window: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/hYjS3KjKtqER6jea-launcher_selfservice_2.png)| **Setting** | **Details** |
| Bundle name | **The bundle name **field allows defining the bundle name (e.g., MSI). There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/yUnMl5t3iTx2QXMv-launcher_selfservice_3.png) |
| Bundle description | **The bundle description **field allows defining the bundle description (e.g., Tools for packaging MSI format). There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/I7C13HBnBWsQibmB-launcher_selfservice_4.png) |
| Select categories | **The select categories **field allows defining the categories for a new bundle. The following options available: - App-V - MSI - MSIX - Productivity - System - Utility There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/30Vma9OsUDSnlA71-launcher_selfservice_5.png) The option to choose multiple categories is available. |
| Select applications | **The select applications **field allows defining the applications included in a new bundle. The following options available: - 7-Zip - Adobe Creative Cloud Cleaner Tool - Adobe Customization Wizard - App-V 5 Configuration Editor - App-V Manage - Apptimized MSI Editor - Apptimized Packaging Engine - AppV 5.1 Sequencer - Double Commander - InstEd - LockHunter - MSIX Packaging Tool - Notepad++ - Process Explorer - Process Monitor - PsExec - Resources Extract - WhatChanged - Orca - InstallWatch There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/1KNgSjO04wm1AGdB-launcher_selfservice_6.png) The option to choose multiple applications is available. |
| **Setting** | **Description** |
| Action | This field allows defining the name of Custom Action. |
| Type | This field allows defining the type of Custom Action. The following types available: VBS Script: - 38 – Scheduling: Always; - 3110 – Execution Context: Deffered, No Impersonate; - 3174 – Return Processing: ContinueOnReturn, Execution Context: Deffered, No Impersonate; Property: - 51 – Set Property, Scheduling: Always. |
| Source | This field allows defining the source property of the MSI package (i.e., ProductName). |
| Target | This field allows defining the execution parameter that depends on the basic type of custom action (i.e., Entry point).
**Note.** If Target is **Null**, Custom Action must contain script code. |
| Condition | This field allows defining the condition under which the Custom Action will be executed (e.g., Not installed). |
| Sequence | This field allows defining the order in which the Custom Action will be performed. The sequence value must be more than 1500 and less than 6600. |
**Note.** There is no option to delete the initial Custom Action field.
The option to apply settings is available under the **Save** button. Apptimized shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-08/Jq9HXWrAtjcZGJAs-cust_actions_new_6.png) The option to download JavaScript Object Notation file is available under **Download JSON** button: [](https://docs.apptimized.com/uploads/images/gallery/2021-08/viYThuU0FC3D5RMQ-cust_actions_new_7.png) The option to reset settings is available under **Reset** button. #### **Packaging Wrappers** ##### **Wrapper templates** This section enables a user: - to set the PSADT templates - to manage the PSADT parameters (i.e., parameters, replace items, and ZIP templates). The Packaging Wrappers section is available under **Project Settings** > **Workflow** > **Packaging – Self Service** > **Packaging Wrappers > Wrapper templates**. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-09/cPnwX7iNE6GVbb2h-wrap_sett_01.PNG) ##### Download default template The option to download the package wrappers default template is available under the **Download default template** button. The following default templates available: **1.1.10.1 (MSI, Transform, Legacy)**, **1.1.10.2 (App-V)**, **1.1.11.1 (MSI, Transform, Legacy)**, **1.1.12.1 (MSI, Transform, Legacy)**, **1.1.12.2 (App-V)**, **1.1.13.1 (MSI, Transform, Legacy)**, **1.1.13.2 (App-V)**. **[](https://docs.apptimized.com/uploads/images/gallery/2020-09/woEIGdc3ye8buONZ-wrapp_sett_02.png)****Note.** After a user downloaded an archive with the default templates, it is recommended to examine the archive structure and files content. The list of placeholders to replace can be formed, or needed modifications to the archive can be provided as a result of the review.
##### Create a new package wrapper template The option to create a new package wrapper template is available under the **Create new** button. [](https://docs.apptimized.com/uploads/images/gallery/2025-12/wrapper.png)**Note. Based on** field indicates the state of the wrapper created. The **Empty** option creates wrapper without any predefined settings. The **Default Wrapper** option contains predefined parameters, replace items, and templates. The options under the **Project** **Wrappers** allow duplicating wrappers created previously on the project.
**Note.** When the new package template is created, it is recommended to implement the following sequence of actions: 1. Upload a ZIP archive with the wrapper template (see the [**Templates** **tab**](#bkmrk-templates-tab)) 2. Create a list of parameters (see the [**Parameters tab**](#h_48102001851599766225691)) 3. Create a list of replaced items (see the [**Replace items tab**](#bkmrk-replace-items-tab))
##### Parameters tab This tab enables a user to set the list of parameters to customize wrapper templates. The option to create a new parameter is available under the **Add parameter** button. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/QKNF9YaLr4Xeunhe-wrap_sett_04_2.png)| **Settings** | **Details** |
| Name | This field sets the name of the created parameter (e.g., **Software name**). Parameter naming is a user preference. This field is required. |
| Required | This switch allows a user to specify the parameter as required. |
| Description | A user can provide here any meaningful description to simplify the parameter's identification. |
| Applicable for the package type | This setting indicates the list of package types for which this parameter will be applicable. The following options available: - MSI - Transform - App-V - MSIX - VSL The multiple-choice is available. |
| Type | This setting indicates the type of the created parameter. The following options available: - String - Select list - Editable select list - Multiple select list - Boolean - Date time - MSI property - TrimmedString The default value is **String**. |
| Value | This field indicates the static or dynamic generated name which a user can apply within the settings for replaced items. The following actions available: - The field can stay empty (Apptimized will apply the default value) - A user can hardcode the value (e.g., **File Zilla 3.46 Eng**) - A user can use the variables from the list below (e.g., **\[Manufacturer\]\[ProductName\]\[ProductVersion\]\[AppLanguage\]**). |
| Values | This field enables a user to create a predefined list of values (e.g., **Windows 10 32 bit**, **Windows 10 64 bit**, **Language (Eng)**, **Language (De)**, etc.). This field is disabled by default. The field becomes active when the **Select list**, **Editable select list**, or **Multiple select list** parameter’s type is selected. A user must provide at least one value. |
| Order | This field indicates the parameter’s position in the parameters list. This field is required. |
| **Settings** | **Details** |
| Placeholder | This setting indicates the variable to be replaced in template files or folders (e.g., **AppVendorShort**). This field is required. |
| Replaced by | This field indicates the static or dynamic generated name which a user can apply within the settings for replaced items. The following actions available: - A user can enter the value manually. The following templates must be implemented: for files - **$(ParameterName)**, and for folders **\[ParameterName\]** - A user can use the variables from the list below the field. |
| Package types | This setting indicates the list of package types for which this replacement item will be applicable. The following options available: - MSI - Transform - Legacy - App-V - MSIX - VSL The multiple-choice is available. This field is required. |
| File extensions | This field indicates the extension of a file for which the replacement rules will be applied (e.g., **.PS1** or **.TXT**). This field is required. The option to add a file extension is available under the **plus** symbol. The option to delete a file extension is available under the **bin** symbol. |
| **Settings** | **Details** |
| File path | This field enables a user to define the destination of the installation file or several installation files (e.g., **\[packagefoldername\]\\package**). To define the file (s) path, a user needs to select a folder that will store the installation file or several installation files from the hierarchical folder structure on the left-hand side of the settings window. [](https://docs.apptimized.com/uploads/images/gallery/2020-09/317anF1r6L5hMfGN-wrap_sett_07_path.png) This field is required. |
| Version | This field provides information about the wrapper’s version number (e.g., **1.1.1.1** or **1.1.05.1**). The wrapper’s version number should be represented as a four-part string with the following format: **<major version>.<minor version>.<build number>.<revision>** This field is required. |
| Package types | This setting indicates the list of package types for which this template will be applicable. The following options available: - MSI - Transform - Legacy - App-V - MSIX - VSL The multiple-choice is available. This field is required. |
| Description | A user can provide here any meaningful description to simplify the template's identification. |
**Note.** If required to modify the current wrapper template or implement any changes, a user doesn't need to create a new packaging wrapper entry. A user can upload a new wrapper revision (**Template tab** > **Add template** button). A wrapper version number update is needed. Apptimized Platform will automatically use the latest one when the wrapper template updated successfully.
##### **Intunewin** This section enables a user to operate with Interactive mode during Intunewin wrapping. [](https://docs.apptimized.com/uploads/images/gallery/2023-03/Pn9f3V6IXVEH9TBX-intunewin_1.png) Interactive mode allows a user to show windows for the user during installation.**Note.** MSI package can't be interactive due to Intune restrictions.
The option to enable Interactive mode is available via the Interactive mode switch. The option is enabled by default. [](https://docs.apptimized.com/uploads/images/gallery/2023-03/H1l9cFInt2WTRDj3-intunewin_2.png) #### **Packaging – Factory Service** ##### **General** The screenshot below shows the default settings of the **Packaging – Factory Service** module. All required fields are marked with an asterisk \*. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-07/mOEeeta75UiTC7cR-step_settings_72_2-(2).png) The option to change a module name is available under the **Module name** field. The default module name is **Packaging – Factory Service.** The option to change a results archive name pattern is available under the **Name of results archive** field. The default archive name pattern is **\[Manufacturer\]\_\[ProductName\]\_\[ProductVersion\]\_\[PackageType\].package.zip.** The option to change a package folder name pattern is available under the **Name of package folder** field. The default package folder name pattern is **\[Manufacturer\]\_\[ProductName\]\_\[ProductVersion\].** To insert the variable tag into the field, click the relevant variable tag from the dropdown list. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/vTdBqK9qJIOUizVJ-steps_settings_73.png) The following additional options can be enabled: Table 10. Packaging – Factory Service additional options| **Option** | **Details** | **Default value** |
| Filter system noise during recording | This option allows for applying a filter (exclusion list) to automatically remove the captured system and user activity (noise). **Yes** and **No** options available. **Yes** – the value of this option removes redundant files and registry keys that were created by the system while recording sessions and did not relate to installing software (i.e., telemetry or diagnostics data). **No** – the system noise which is captured by the application packaging tool will not be removed. | Yes |
| Remove Desktop shortcuts | This setting indicates the option to remove all desktop shortcuts (**Yes**) from the package or to leave desktop shortcuts in the package (**No**). | Yes |
| Produce AppV | This setting indicates the option to generate a file in App-V format. **Yes** and **No** options available. | No |
| Produce VSL | This setting indicates the option to generate a file in VSL format. **Yes** and **No** options available. | No |
| Produce MSIX | This setting indicates the option to repackage software to MSIX format. **Yes** and **No** options available. | No |
| Produce MSI | This setting indicates the option to repackage software to MSI format. **Yes** and **No** options available. When **No** option is chosen, a legacy setup for software will be implemented if possible. | Yes |
| **Setting** | **Details** | **Default value** |
| Installation script name | This setting indicates the file name of the generated installation command line (msiexec command line). This setting indicates a filename template for naming the .CMD file to install the package. | install.cmd |
| Installation script content | This setting indicates the command line for installing the package. | msiexec /i "%~dp0\[MsiName\]" /qn |
| Uninstall script name | This setting indicates the command line file name for the package uninstallation. | uninstall.cmd |
| Installation script content with transforms | This setting indicates the command line for installing the package using the created **Transform** file. | msiexec /x \[ProductCode\] /qn |
| User interface | This setting indicates which parameter will be added to the msiexec command line. The following options available: - **No user interface** – the user interface does not show any wizard dialogue. - **Basic user interface** – only a progress bar will be shown during the installation, with the possibility to cancel this process by the Cancel button. - **Basic user interface with hidden “Cancel” button** – shows only progress bar without the ability to cancel the installation process. | No user interface |
| Default installation command line | This setting indicates the command line for the installation of the MSI with transform. | - |
| Installation log | This setting indicates the installation log mode. The following options available: - **None** (no logging available). - **Basic** (logging shows only errors appeared during installation/uninstallation). - **Full** (logging shows all informational, warning, error messages during installation/uninstallation). | Full |
| **Setting** | **Details** | **Default value** |
| Install command | This setting indicates the command line for installing the package. | Execute-MSI -Action 'Install' -Path "\[MsiName\]" -private:$PackageName |
| Install with transform command | This setting indicates the command line for installing the package using the created **Transform** file. | Execute-MSI -Action 'Install' -Path "\[MsiName\]" -Transform "\[MstName\]" -private:$PackageName |
| Uninstall command | This setting indicates the command line for uninstalling the package. | Execute-MSI -Action 'Uninstall' -Path '\[ProductCode\]' -private:$PackageName |
| Reboot required | This setting indicates the reboot mode. **Yes** and **No** options available. | No |
| User interface | This setting indicates which parameter will be added to the msiexec command line. The following options available: - **No user interface** – the user interface does not show any wizard dialogue. - **Basic user interface** – only a progress bar will be shown during the installation, with the possibility to cancel this process by the Cancel button. - **Basic user interface with hidden “Cancel” button** – shows only progress bar without the ability to cancel the installation process. | No user interface |
| Default installation command line | This setting indicates the command line for the installation of the MSI with transform. | - |
| Installation log | This setting indicates the installation log mode. The following options available: - **None** (no logging available). - **Basic** (logging shows only errors appeared during installation/uninstallation). - **Full** (logging shows all informational, warning, error messages during installation/uninstallation). | Full |
| **Setting** | **Details** | **Default value** |
| Installation script name | This setting indicates the file name of the generated installation command line (msiexec command line). This setting indicates a filename template for naming the .VBS file to install the package. | install.vbs |
| Installation script content | This setting indicates the command line for installing package. | set res = run("%windir%\\system32\\msiexec.exe /i " & chr(34) & "%~dp0\[MsiName\]" & chr(34) & " /qn", "0,3010", 0, true) wscript.quit(res.ReturnCode) |
| Installation script content with transforms | This setting indicates the command line for installing the package using the created **Transform** file. | set res = run("%windir%\\system32\\msiexec.exe /i " & chr(34) & "%~dp0\[MsiName\]" & chr(34) & " TRANSFORMS=" & chr(34) & "%~dp0\[MstName\]" & chr(34) & " /qn", "0,3010", 0, true) wscript.quit(res.ReturnCode) |
| Uninstall script name | This setting indicates the file name of the generated uninstallation command line (msiexec command line). This setting indicates a filename template for naming the .VBS file to uninstall the package. | uninstall.vbs |
| Uninstall script content | This setting indicates the command line for uninstalling package. | set res = run("%windir%\\system32\\msiexec.exe /x \[ProductCode\] /qn", "0,3010", 0, true) wscript.quit(res.ReturnCode) |
| User interface | This setting indicates which parameter will be added to the msiexec command line. The following options available: - **No user interface** – the user interface does not show any wizard dialogue. - **Basic user interface** – only a progress bar will be shown during the installation, with the possibility to cancel this process by the Cancel button. - **Basic user interface with hidden “Cancel” button** – shows only progress bar without the ability to cancel the installation process. | No user interface |
| Default installation command line | This setting indicates the command line for the installation of the MSI with transform. | - |
| Installation log | This setting indicates the installation log mode. The following options available: - **None** (no logging available). - **Basic** (logging shows only errors appeared during installation/uninstallation). - **Full** (logging shows all informational, warning, error messages during installation/uninstallation). | Full |
| **Setting** | **Details** | **Default value** |
| Installation context | This setting indicates the installation context mode. The following options available: - **Per-user** (an access to a program is granted only to a user from which a program was installed); - **Per-machine** (the package installation is required to enable all computer users to access and use the application. A per-machine installation is based on ALLUSERS property value. The per-machine installation provides changes to the system that affects all users. Standard users with limited privileges will be restricted to install a package in the per-machine context. First obtaining permission is needed. - **Per-user or per-machine** (If this is a per-user installation, the registry value is **HKEY\_CURRENT\_USER**; if this is a per-machine installation, the registry value is **HKEY\_LOCAL\_MACHINE**. A per-machine installation is based on ALLUSERS property value. | Per-machine |
| Destination drive | This setting indicates the drive where a package will be installed, set value for ROOTDRIVE property of MSI. The ROOTDRIVE property specifies the default drive for the destination directory of the installation. [Learn more](https://msdn.microsoft.com/en-us/library/windows/desktop/aa371372(v=vs.85).aspx). The following options available: - C:\\ - D:\\ | C:\\ |
| **Setting** | **Details** | **Default value** |
| Reboot after install | This setting is based on the REBOOT property value. The REBOOT property suppresses certain prompts for a restart of the system. The following options available: - Never; - Always; - At the end of a chain. | Never |
| Shut down any files in use | This setting is based on the MSIRMSHUTDOWN property value. When the default value (**Yes**) is set, all system services and files that were shut down to install the update will be restarted. The following options available: - Yes; - If they are registered for a restart; - Only if they have all been registered. | YesThis setting is |
| If files are in use | This setting is based on MSIRESTARTMANAGERCONTROL property value. This setting enables setup authors to specify whether the package will use the Restart Manager or FileInUse Dialog to handle locked files. The following options available: - Use Restart Manager; - Use FilesInUse Dialog; - Disable Shutdown. | Use restart manager |
| Display of reboot prompts | This setting is based on REBOOTPROMPT property value. This property does not initiate a reboot if one is not needed, it only suppresses any prompts for reboots to the user. The following options available: - Suppress; - Do not set / Remove. | Suppress |
| **Setting** | **Details** | **Default value** |
| Show ARP | This option specifies the listing mode of the program in the ARP (Add-Remove Program) and is based on ARPSYSTEMCOMPONENT property value. When the option is enabled, the program will be listed in the Add-Remove Program. When the option is disabled, the program will be hidden in the Add-Remove Program list. | Enabled |
| Manual repair from ARP | This option enables or disables the usage of the **Repair** button in the ARP for the package and is based on ARPNOREPAIR property value. When the option is enabled, the **Repair** button is added to the ARP for the package. When the option is disabled, the **Repair** button is removed from the ARP for the package. | Enabled |
| Manual uninstall from ARP | This option enables or disables the usage of the **Uninstall** button in the ARP for the package and is based on ARPNOREMOVE property value. When the option is enabled the **Uninstall** button, is added to the ARP for the package. When the option is disabled the **Uninstall** button, is removed from the ARP for the package. | Enabled |
| Manual feature modification from ARP | This option enables or disables the usage of the **Modify** button in the ARP for the package and is based on ARPNOMODIFY property value. When the option is enabled, the **Modify** button is added to the ARP for the package. When the option is disabled, the **Modify** button is removed from the ARP for the package. | Disabled |
| **Setting** | **Details** | **Default value** |
| Cab archive name pattern | This setting indicates the filename template for naming **.CAB** files. Cab files contain files that will be installed by MSI package. | Data{0}.cab |
| Max cab file size (in MB) | These settings indicate the number of files that will be placed in a single cab file. If the size of one cab file is bigger than the provided value, it will be divided to several cab files. | 2048 |
| Max files count per cab | 9999 | |
| Use embedded cab | This setting sets the mode to use an embedded file. When the **Use embedded cab** switch is enabled, a **.CAB** file will be implemented into **.MSI**. When the **Use embedded cab** switch is disabled, a **.CAB** file will be outside the **.MSI** (external CAB). It is a compressed source (opposed to "Loose files" = uncompressed source). | Yes |
| Parse ini files to the IniFile table | This option indicates the mode to parse ini files. When the **Parse ini files to the IniFile table** switch is enabled, the ini files will be added via an IniFile table. It is the best practice to add ini files via IniFile table because these files may contain hard-coded values which in this case can be replaced with MSI properties. When the **Parse ini files to the IniFile table** switch is disabled, the ini files will be added via an File table. | No |
| Map registry data to the appropriate COM tables | This setting allows to identify objects and to add them to the appropriate tables. When the **Map registry data to the appropriate COM tables** switch is enabled, all COM objects will be mapped to MSI via special tables designed for these objects (ProgID, Classes, etc.). It is a better way of COM objects registration according to Microsoft's best practices and helps easily navigate and manage these objects through MSI. When the **Map registry data to the appropriate COM tables** switch is disabled, all COM objects will be added to MSI via Registry table and installed as regular registry keys. | No |
| Post process MSI filesystem & components | This setting sets the File Table entries for the Language and Version fields. [Learn more](https://docs.microsoft.com/en-us/windows/win32/msi/file-versioning-rules?redirectedfrom=MSDN). | Yes |
| Mark components destined for the System folder as permanent | A system folder is used by other programs. If the package contains some System folder files, they can be removed from the system during uninstallation. So, it will affect other programs that use these files. When the **Mark components destined for the System folder as permanent** switch is enabled, the files will be marked as permanent and won’t be removed after the package uninstalling. When the **Mark components destined for the System folder as permanent** switch is disabled, the files will be deleted after the package uninstalling. | Yes |
| Use Duplicate File table for user files installation | Some files (.DLL, .OCX, etc.) that are installed in the Common Files folder is used by other programs. If the package contains some of these files they can be removed from the system during uninstallation. So, this affects other programs that use these files. When the **Use Duplicate File table for user files installation** switch is enabled, the files mark as shared. Every time when such files are installed in this folder, a counter is incremented. This counter shows how many programs use this file. When the package tries to remove this file, the counter is decremented. When this counter equals 0 this file removes from the system. | Yes |
| **Setting** | **Description** |
| Action | This field allows defining the name of Custom Action. |
| Type | This field allows defining the type of Custom Action. The following types available: VBS Script: - 38 – Scheduling: Always; - 3110 – Execution Context: Deffered, No Impersonate; - 3174 – Return Processing: ContinueOnReturn, Execution Context: Deffered, No Impersonate; Property: - 51 – Set Property, Scheduling: Always. |
| Source | This field allows defining the source property of the MSI package (i.e., ProductName). |
| Target | This field allows defining the execution parameter that depends on the basic type of custom action (i.e., Entry point).
**Note.** If Target is **Null**, Custom Action must contain script code. |
| Condition | This field allows defining the condition under which the Custom Action will be executed (e.g., Not installed). |
| Sequence | This field allows defining the order in which the Custom Action will be performed. The sequence value must be more than 1500 and less than 6600. |
**Note.** There is no option to delete the initial Custom Action field.
The option to apply settings is available under the **Save** button. Apptimized shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-08/Jq9HXWrAtjcZGJAs-cust_actions_new_6.png) The option to download JavaScript Object Notation file is available under **Download JSON** button: [](https://docs.apptimized.com/uploads/images/gallery/2021-08/viYThuU0FC3D5RMQ-cust_actions_new_7.png) THe option to reset settings is available under **Reset** button. ##### **Packaging Wrappers** This section enables a user: - to set the PSADT templates - to manage the PSADT parameters (i.e., parameters, replace items, and ZIP templates). The Packaging Wrappers section is available under **Project Settings** > **Workflow** > **Packaging – Self Service** > **Packaging Wrappers**. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-09/cPnwX7iNE6GVbb2h-wrap_sett_01.PNG) ##### Download default template The option to download the package wrappers default template is available under the **Download default template** button. The following default templates available: **1.1.10.1 (MSI, Transform, Legacy)**, **1.1.10.2 (App-V)**, **1.1.11.1 (MSI, Transform, Legacy)**, **1.1.12.1 (MSI, Transform, Legacy)**, **1.1.12.2 (App-V)**, **1.1.13.1 (MSI, Transform, Legacy)**, **1.1.13.2 (App-V)**. **[](https://docs.apptimized.com/uploads/images/gallery/2020-09/woEIGdc3ye8buONZ-wrapp_sett_02.png)****Note.** After a user downloaded an archive with the default templates, it is recommended to examine the archive structure and files content. The list of placeholders to replace can be formed, or needed modifications to the archive can be provided as a result of the review.
##### Create a new package wrapper template The option to create a new package wrapper template is available under the **Create new** button. **[](https://docs.apptimized.com/uploads/images/gallery/2021-07/3R4BCVOpUMjMXSK4-wrapp_sett_03_2.png)****Note. Based on** field indicates the state of the wrapper created. The **Empty** option creates wrapper without any predefined settings. The **Default Wrapper** option contains predefined parameters, replace items, and templates. The options under the **Project** **Wrappers** allow duplicating wrappers created previously on the project.
**Note.** When the new package template is created, it is recommended to implement the following sequence of actions: 1. Upload a ZIP archive with the wrapper template (see the [**Templates** **tab**](#bkmrk-templates-tab)) 2. Create a list of parameters (see the [**Parameters tab**](#h_48102001851599766225691)) 3. Create a list of replaced items (see the [**Replace items tab**](#bkmrk-replace-items-tab))
##### Parameters tab This tab enables a user to set the list of parameters to customize wrapper templates. The option to create a new parameter is available under the **Add parameter** button. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/QKNF9YaLr4Xeunhe-wrap_sett_04_2.png)| **Settings** | **Details** |
| Name | This field sets the name of the created parameter (e.g., **Software name**). Parameter naming is a user preference. This field is required. |
| Required | This field allows a user to specify the parameter as required. |
| Description | A user can provide here any meaningful description to simplify the parameter's identification. |
| Applicable for the package type | This setting indicates the list of package types for which this parameter will be applicable. The following options available: - MSI - Transform - App-V - MSIX - VSL The multiple-choice is available. |
| Type | This setting indicates the type of the created parameter. The following options available: - String - Select list - Editable select list - Multiple select list - Boolean - Date time - MSI property - TrimmedString The default value is **String**. |
| Value | This field indicates the static or dynamic generated name which a user can apply within the settings for replaced items. The following actions available: - The field can stay empty (Apptimized will apply the default value) - A user can hardcode the value (e.g., **File Zilla 3.46 Eng**) - A user can use the variables from the list below (e.g., **\[Manufacturer\]\[ProductName\]\[ProductVersion\]\[AppLanguage\]**). |
| Values | This field enables a user to create a predefined list of values (e.g., **Windows 10 32 bit**, **Windows 10 64 bit**, **Language (Eng)**, **Language (De)**, etc.). This field is disabled by default. The field becomes active when the **Select list**, **Editable select list**, or **Multiple select list** parameter’s type is selected. A user must provide at least one value. |
| Order | This field indicates the parameter’s position in the parameters list. This field is required. |
| **Settings** | **Details** |
| Placeholder | This setting indicates the variable to be replaced in template files or folders (e.g., **AppVendorShort**). This field is required. |
| Replaced by | This field indicates the static or dynamic generated name which a user can apply within the settings for replaced items. The following actions available: - A user can enter the value manually. The following templates must be implemented: for files - **$(ParameterName)**, and for folders **\[ParameterName\]** - A user can use the variables from the list below the field. |
| Package types | This setting indicates the list of package types for which this replacement item will be applicable. The following options available: - MSI - Transform - Legacy - App-V - MSIX - VSL The multiple-choice is available. This field is required. |
| File extensions | This field indicates the extension of a file for which the replacement rules will be applied (e.g., **.PS1** or **.TXT**). This field is required. The option to add a file extension is available under the **plus** symbol. The option to delete a file extension is available under the **bin** symbol. |
| **Settings** | **Details** |
| File path | This field enables a user to define the destination of the installation file or several installation files (e.g., **\[packagefoldername\]\\package**). To define the file (s) path, a user needs to select a folder that will store the installation file or several installation files from the hierarchical folder structure on the left-hand side of the settings window. [](https://docs.apptimized.com/uploads/images/gallery/2020-09/317anF1r6L5hMfGN-wrap_sett_07_path.png) This field is required. |
| Version | This field provides information about the wrapper’s version number (e.g., **1.1.1.1** or **1.1.05.1**). The wrapper’s version number should be represented as a four-part string with the following format: **<major version>.<minor version>.<build number>.<revision>** This field is required. |
| Package types | This setting indicates the list of package types for which this template will be applicable. The following options available: - MSI - Transform - Legacy - App-V - MSIX - VSL The multiple-choice is available. This field is required. |
| Description | A user can provide here any meaningful description to simplify the template's identification. |
**Note.** If required to modify the current wrapper template or implement any changes, a user doesn't need to create a new packaging wrapper entry. A user can upload a new wrapper revision (**Template tab** > **Add template** button). A wrapper version number update is needed. Apptimized Platform will automatically use the latest one when the wrapper template updated successfully.
#### **Testing – Self Service** The screenshot below shows the default settings of the **Testing – Self Service** module. All required fields are marked with an asterisk \*. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/DyK7zms6zeHWDB12-testing_selfservice_1.png) The option to change a module name is available under the **Module name** field. The default module name is **Testing – Self Service.** The option to change a file name pattern is available under the **Document file name pattern** field. The default file name pattern is **\[Manufacturer\]\_\[ProductName\]\_\[ProductVersion\].html.** To insert the variable tag into the field, click the relevant variable tag from the dropdown list. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/NOdvKb0QSMy8XVzl-testing_selfservice_2.png) The option to edit a testing case template is available under the **Edit testing document template** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/JFLKtjz842DwdvjS-steps_settings_15.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/hNt1o8PrKHenZiDd-steps_settings_16.png) To return the document to the default state, click the **Restore testing document template** button. To apply edits in a discovery case template, click the **Save** button. Settings are persisted on click to the **Save** button. To revert the settings, click on the **Reset** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/JKaghggTWkNdQMBw-testing_selfservice_3.png) Apptimized shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/jbdVHUv8yipb6c24-steps_settings_22.png) #### **Testing – Factory Service** The screenshot below shows the default settings of the **Testing – Factory Service** module. All required fields are marked with an asterisk \*. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/ZPdms1twgcmCk5SJ-steps_settings_23.png) The option to change a module name is available under the **Module name** field. The default module name is **Testing – Factory Service.** The option to set the person’s data who will receive notifications on factory requests in the project is available under “**Escalation contact's email address”** and **“Escalation contact's name”** fields. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/e2EAH7WQBg0uIKvM-steps_settings_24.png) Settings are persisted on click to the **Save** button. Apptimized shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/xGnczHxKWkjU0TST-steps_settings_25.png) ### **Echo settings** The option to enable [Echo](https://www.youtube.com/watch?v=EaVj5lDKufM) is available under the **Echo** switch. The default value is **No**. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/6j9NZCPDtEnkQtFu-project_settings_09.png) Apptimized shows the following screen when Echo option is enabled: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/iUVkbf4WQxnMvZHV-project_settings_10.png) The option to replay the recorded installation and configuration of the application from the initial version is available under the **Enable Echo assisted playback (interactive)** switch. The option is inactive by default. The option to replay the record automatically against the selected Windows OS is available under the **Enable Echo automated playback (non-interactive)** switch. The option is inactive by default. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/HSbM5shBdPE2CLzE-project_settings_11.png) A playback mode enables a user to choose how to proceed with recorded test cases when the new platform (VM) is added. Three playback modes available: - **Automated** – when a new platform (VM) is added, all possible test cases run; - **Opt-In** – when a new platform (VM) is added, a user is notified by email to add it manually to the project; - **Opt-Out** – when a new platform (VM) is added, a user is notified by email. A user has 48 hours to cancel prepared test cases or they run automatically. The default value is **Automated**.**Note.** The **Playback Echo scenario from** field is required. Apptimized Portal shows the following error screen: [](https://docs.apptimized.com/uploads/images/gallery/2021-07/VgCSsluSP0L9J8Oc-echo_error_message.png)
Keyword search mode available: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/9nX93ApZ5LdcPnvb-project_settings_12.png) To choose an Echo platform, a user can drag and drop a suitable platform from the **Available Echo platform / Available non-public Echo platforms** container to the **Project Echo platforms / Project non-public Echo platforms** container. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/mN3yLQwEoQP0JGr4-project_settings_13.png) The option to change a file name pattern is available under the **Document file name pattern** field. The default file name pattern is **\[Manufacturer\]\_\[ProductName\]\_\[ProductVersion\].html.** **[](https://docs.apptimized.com/uploads/images/gallery/2020-04/DSPd5Mt2vs8BygKy-project_settings_14.png)** The option to edit a test case template is available under the **Edit test case template** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/VjP7EYWnixHDYRqm-project_settings_15.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/9RgS7wSK9viYNY19-project_settings_16.png) To apply edits in a test case template, click the **Save** button. To apply the Echo settings, click the **Save** button. Apptimized shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/RFPFWqbOk24V3ivc-project_settings_16_1.png) ### **Integration settings** #### **Intune** ##### **Create environment** **Your Project → Administration → Settings → Integration → Intune → Environments → Create environment**  Put a name for your environment on the Apptimized Portal and press "**Create**". **Then you will faced massage about that your environment was created. **
 [](https://docs.apptimized.com/uploads/images/gallery/2025-03/main.PNG) ##### **Connect environment** After creating your project on the Apptimized Portal you have two options for integrating your Intune environment. - **Apptimized** – use Apptimized provided App Registration - **Custom** – use own App Registration connection  ##### **Apptimized connection** In the “**Application registration type for connection**” you can choose: - Connection with Application permissions - Connection only with Delegated permissions In this step, please select the desired Azure App Registration from the dropdown menu. Once selected, this action will automatically create an Enterprise Application (App Registration) in your Azure tenant. This application will integrate with your Azure services securely, and you can manage its settings and permissions within your tenant. [](https://docs.apptimized.com/uploads/images/gallery/2025-03/two.PNG) Then press “**Create connection**” button: [](https://docs.apptimized.com/uploads/images/gallery/2025-03/connection-button.PNG)In case if you have enough permissions for this operation (Global Admin role) you will faced the next window:
After pressing “Accept” connection with your environment will be created and it will back you to the your created If all went well you would face the status - “**Connected**”
And if something went wrong – “**Error**”
In this case please press: **“Test connection”** button: It will update information aboud status of your Intune connection**If status don’t change, please contact support.**
Also here you can see: - **Connection Mode**: Apptimized or Custom - **Connected By**: User who made autorization - **Connected At**: Time when authorization was doneIn case if you do not have enough permissions, but your Enterprise application settings allow you request it, you will face the next window.
After pressing “**Request approval**” email will be sent to your Admin and you will see next window.
After pressing "**Back to app**” you will back to the Intune Environment page. [](https://docs.apptimized.com/uploads/images/gallery/2025-09/VeEintune-environment-page.PNG) In this case, the status will be “Not finished”. [](https://docs.apptimized.com/uploads/images/gallery/2025-09/image.png) Also, you will face the next warning (it's ok). [](https://docs.apptimized.com/uploads/images/gallery/2025-09/g5wimage.png) And now you need to wait approval from your Admin by Email message.
> Email Example: > > [](https://docs.apptimized.com/uploads/images/gallery/2025-08/group-1.png) > > > After Admin approval you will get the next message on your Email. > Example: > >  After that you need to go to the Intune Environment setting page of your created environment and press “**Update connection**” button. [](https://docs.apptimized.com/uploads/images/gallery/2025-09/group-8.png) If the request is approved, the status will change to “Connected”, and the environment will be ready for work. [](https://docs.apptimized.com/uploads/images/gallery/2025-09/group-9.png) If you get the window with the approval request, it means that your request has not been approved yet or denied.In case if you do not have enough permissions and can not request it you will faced the next window:
In this case you can create this type of connection only with Global Administrator permission.   **Setting that allow you to request Admin consent:**  --- ##### **Custom connection** The application registration is carried out in the Microsoft Azure portal via administrative credentials. A user can choose one of the following types of accounts: A tenant admin account; - A tenant user account (with the enabled **“Users can register applications”** setting). The option to open an application registration page is available under: - **Microsoft Azure** portal > **Azure services** > **App registrations**; [](https://docs.apptimized.com/uploads/images/gallery/2020-05/ql2t7GeHU7oa1KFn-intune_01.png) - **Microsoft Azure** portal > Search > Enter a search request (i.e., “App registrations”) > Select the service in the list > **App registrations**; [](https://docs.apptimized.com/uploads/images/gallery/2022-08/q7ncDCyqN1eH0oih-intune_02_02.png) - **Microsoft Azure** portal > Menu > All services > Enter a search request (i.e., “App registrations”) > Select the service in the list > **App registrations**. [](https://docs.apptimized.com/uploads/images/gallery/2022-08/yC2QnvLLANcWCJZq-intune_03_03.png) **Microsoft Azure** portal shows the screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2025-08/group-2.png) The option to create a new application registration is available under the **New registration** option. [](https://docs.apptimized.com/uploads/images/gallery/2020-05/lcgEArRMyPn4ljJz-intune_05.png) Microsoft Azure portal shows the Create window when successful: [](https://docs.apptimized.com/uploads/images/gallery/2022-08/BK5Q9Jma32fJJnFN-intune_06_01.png) To create a new application registration, a user fills in the fields in the form (see Table 1 and the [Microsoft Azure manual](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app)). Table 1. A new application registration| **Field name** | **Details** |
| Name | This field sets a meaningful application name to display to users (i.e., **Apptimized Intune Test**) |
| Supported accounts | This option identifies types of accounts that can use the application. Three options available: - Accounts in this organizational directory only; - Accounts in any organizational directory; - Accounts in any organizational directory and personal Microsoft accounts; - Personal Microsoft account only. |
| Redirect URI | This setting is optional, and the values can be provided later. [](https://docs.apptimized.com/uploads/images/gallery/2020-05/dEYiRGrv0j8eCFmJ-intune_07.png) |
**Note.** When clicking on the **Add** button, the client secret value appears (i.e., **~\_fd-Y49~haNZ~g8RbDz9yQCF4KQ\_\_1j49**). A user must copy the value to the clipboard to use it in the client’s application code. It becomes inaccessible once a user leaves this page. The **Client secret** value correlates with the **Client secret** field when integrating **Intune** into the **Apptimized** portal.
[](https://docs.apptimized.com/uploads/images/gallery/2022-08/ksgCXV9lGzvrlvxw-intune_11_02.png) The option to [configure permissions](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent) to the application to call API is available under **All services** > **App registrations** > Select the application in the list > **Manage** menu > **API permissions** > Add a permission > **Microsoft Graph**. [](https://docs.apptimized.com/uploads/images/gallery/2025-08/group-4.png) **Microsoft Azure** portal shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2025-08/group-5.png) The option to set the types of permissions to the application is available under the **Delegated permissions** button > Select the permissions from the list > **Add permissions** button. The screenshot below shows the list of enabled permissions: [](https://docs.apptimized.com/uploads/images/gallery/2024-03/intunepermissions1.png) Some delegated permissions can be consented by non-administrative users, but some higher-privileged permissions require administrator consent. The option to grant permissions is available under the **Grant admin consent for \[company name\]** button. [](https://docs.apptimized.com/uploads/images/gallery/2022-11/7x9tcR8L6ovBVp9e-Intune_51_1.png)**Note.** If the application runs as a background service or daemon without a signed-in user, the required option is **Application permissions**. The **Applications permissions** are the permissions that are used by applications that run without a signed-in user present. Using Application permissions enables Apptimized users to push packages to Intune without requiring an own Intune access or even an AAD account in the target Azure directory. By configuring the use of application permissions, the API will be authorized to push packages to Intune without requiring an authenticated AAD Intune user with adequate permissions to provide this authorization. [](https://docs.apptimized.com/uploads/images/gallery/2024-03/intuneapppermisions.png) The **DeviceManagementApps** permissions in **Applications permissions** are identical to **Delegated permissions** group. [](https://docs.apptimized.com/uploads/images/gallery/2024-03/permissionsintune.png)
##### **Assignment template** After connecting Intune environment, "Create assignment template" is available. [](https://docs.apptimized.com/uploads/images/gallery/2025-08/group-7.png) Configurating template window [](https://docs.apptimized.com/uploads/images/gallery/2025-08/group-7-2.PNG) List with created templates [](https://docs.apptimized.com/uploads/images/gallery/2025-08/group-6.png) ##### **Intune template** Creating [](https://docs.apptimized.com/uploads/images/gallery/2025-08/VXOmain.PNG) Configuration menu [](https://docs.apptimized.com/uploads/images/gallery/2025-08/create.PNG) List with created templates [](https://docs.apptimized.com/uploads/images/gallery/2025-08/5C8created.PNG) #### **ServiceNow** The option is disabled by default. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/ImU73vSD6dEqZxoo-project_settings_32.png) ServiceNow becomes active when switched on and once the required settings are completed. All required fields are marked with an asterisk \*. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/OpXQT5V5ZY1EiN2G-project_settings_32_1.png) The option to check the connection status with ServiceNow is available under the **Check ServiceNow Connection** button. Apptimized shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/FsWPxLYqrCowobrc-project_settings_36_3.PNG) To synchronize ServiceNow data with Apptimized, a user must map ServiceNow table fields with Apptimized table fields. To add additional fields to the list, click on the **plus** symbol. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/v94o2KinWQlilqxW-project_settings_33.png) An additional field can be excluded from the list by clicking on the **bin** symbol. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/sHY8GjpWWKuV6IyR-project_settings_34.png) The **Original column names** fields fill in with the ServiceNow system name of this value (i.e., **u\_app\_id**). [](https://docs.apptimized.com/uploads/images/gallery/2020-04/SKK7AxXXscSZdKMw-project_settings_35.png) Settings are persisted on click to the **Save** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/FCegReySfDWA0ksi-project_settings_36.png) Apptimized shows the following notifications when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/OGBYJOtpX49Nb70o-project_settings_36_2.PNG) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/eG94BfVqCSBN2Xcr-project_settings_36_1.png) #### **SCCM** The option is disabled by default. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/9a5UZp7bJ0ZKDzz3-image-1612445003086.png) SCCM option becomes active when switched on and once the required settings are completed. ##### General settings The one-time configuration is available for project administrators under **Settings** in the project menu > **Integration** section > **SCCM** > **General**. [](https://docs.apptimized.com/uploads/images/gallery/2024-11/sccm1m.png) SCCM Connector becomes active when switched on and once the required settings are completed. [](https://docs.apptimized.com/uploads/images/gallery/2024-11/sccm2.png) ##### SCCM Connector Initial Configuration A user must follow the next steps to complete the initial configuration of the SCCM Connector: **1. Setting Environment Details** - **Environment Name**: Enter a unique name to identify this SCCM environment. - **Site Code**: Specify the SCCM site code for the environment. **2. Configuring Proxy Settings (if required)** - **Using Default Windows Proxy Server**: Select **Yes** to use the default Windows proxy server. If **No** is selected, a **Proxy Address** field will appear, where you can manually enter the address of your proxy server. - **Using Default Windows Credentials**: Select **Yes** to use default Windows credentials for authentication. If **No** is selected, **Username** and **Password** fields will appear, which must be populated with the credentials for proxy access. **3. Updating Settings** - **Installation Type: Automatic **(updates will install automatically when available) or **Manual** (updates require manual installation). - **Update Types**: **All Updates** (the connector will check for all available updates) or **Critical Only** (only critical updates will be checked and applied). **4. Sending News and Updates To** - **Notification Recipient: **Select a user from your project team who will receive email notifications for connector updates and API key expiration reminders. [](https://docs.apptimized.com/uploads/images/gallery/2024-11/image-155.png) Table 18. General Settings| **Settings** | **Details** |
| Environment name | A unique name to identify this environment at Apptimized Portal. |
| Site code | Site codes and site names identify sites in a Configuration Manager hierarchy. Configuration Manager Setup prompts for a site code and site name for the central administration site, and secondary site installation. [Learn more.](https://learn.microsoft.com/en-us/mem/configmgr/core/servers/deploy/install/prepare-to-install-sites) |
| Automatic updates | Indicates how a user would like Apptimized SCCM Connector application updates to be applied. The following types are: - **Automatic**: updates will install automatically when available. - **Manual**: updates require manual installation from Apptimized portal or directly on a target machine. |
| When checking for updates, check for | Selecting the types for updates to check for. The following types are: - **All updates:** the connector will check for all available updates and automatically install them if **Automatic updates** are enabled. - **Critical only:** only critical updates will be checked and applied. Minor updates will be ignored for automatic installation. |
| Send news and updates to | Allows selecting a user from a project team who will receive email notifications for new connector update releases API key expiration reminders. |
**Note.** SCCM connector can’t use Windows default proxy settings. A user enters manually the proxy settings (which are configured on a machine) into the Apptimized portal.
#### Generating SCCM API Key and Installing Apptimized SCCM Connector ##### Generating SCCM API Key A user should go to the **General** section in the portal and select **Generate SCCM API Key**. A modal window titled **Generate a New SCCM API Key** will appear. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/modalwinowsccm.png) The user has to set the **Expiration date** using the calendar to specify how long the connector will be authorized to operate with this key. The user clicks **Generate** to create the API key. This key will be automatically applied to the connector installer. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/newkeysccm.png) The modal can now be closed by clicking **Cancel**, or a .reg file containing the key can be downloaded to apply it to an existing SCCM Connector installation. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/downloadocancelsccm.png) When the key is generated successfully, the expiration date appears below the **Generate SCCM API Key** button. Additionally, a green key icon displays in the **SCCM Connector Status** bar, confirming the key is active. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/generatedsccm.png) [](https://docs.apptimized.com/uploads/images/gallery/2024-12/greenkeybutton.png) ##### API Key Expiration Status Indicators To ensure seamless operation, the system provides visual indicators for the status of your API key. These indicators help you track the expiration of your API key and take timely action. The **Save** button can now be pressed to proceed with the **Connector installation**, or the Application or **Package template configuration** can be accessed. **Green Status**: [](https://docs.apptimized.com/uploads/images/gallery/2024-12/green-status.png) - The API key is active and valid. - No action is required. **Yellow Status**: [](https://docs.apptimized.com/uploads/images/gallery/2024-12/yellow-status.png) - The API key is nearing expiration, with 7 days or fewer remaining. - A notification email will be sent to the registered email address, alerting user to renew the key. **Red Status**: [](https://docs.apptimized.com/uploads/images/gallery/2024-12/red-status.png) - The API key has expired. - The system will cease to function with the expired key, and an additional email notification will be sent to inform user about the expiration. ##### API Key Expiration Display **[](https://docs.apptimized.com/uploads/images/gallery/2024-12/apikey-expiration-display.png)** To provide users with clear visibility into the validity of their API key, the expiration date and time are displayed directly under the **Generate SCCM API Key** button. **Email Notifications for API Key Expiration** To help users manage API key validity, the system automatically sends email notifications at critical points: 1. **One Week Before Expiration**: - An email will be sent when the API key enters the yellow status (7 days before expiration). - The email will include the expiration date and instructions for renewing the key. 3. **Upon Expiration**: - An email will be sent immediately after the API key enters the red status (expired). - The email will inform user the key is no longer valid and provide a link or instructions for generating a new key. #### Downloading and Installing Apptimized SCCM Connector A user downloads Apptimized **SCCM Connector installer** from the **portal**. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/downloadsccmconnectorinstaller.png) The user runs the installer on a machine with an access to his SCCM environment.**Note**. The user has to ensure this machine has network permissions and connectivity to SCCM for seamless operation.
During installation, the connector will automatically apply the generated API key, or the user can use the **.reg file** to manually update an existing installation. ##### SCCM Connector Application Installation To install the **SCCM Connector application**, a user follows the next steps: **Downloading the exact installation files** - Downloading the **ZIP archive** containing the SCCM Connector installation files from the portal.[](https://docs.apptimized.com/uploads/images/gallery/2024-12/ziparchive.png) - Extracting the contents of the archive to a location on a machine with access to the **Configuration Manager** console. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/configmanagerc.png) **Running the Setup Wizard** - Locating the install.cmd file within the extracted folder. - Right-clicking on install.cmd and select **Run as Administrator** to open the SCCM Connector Setup Wizard with the required administrative privileges. - Clicking **Next** to proceed in the **Setup Wizard**. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/setupwizard.png) **Selecting the Installation Type** A user chooses one of the following installation options based on his requirements: [](https://docs.apptimized.com/uploads/images/gallery/2024-12/picture9sccm.png) **If selecting Install as a Service:** - The connector will be installed as a Windows service, allowing it running in the background even in case no user is signed in. - On the next screen the user enters an **Active Directory Account Name** and **Password**. These credentials are needed to run and install the service. - The user has to ensure the account has the necessary permissions to communicate with the SCCM server. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/credentialssccm.png) **If selecting Install as an Application:** - The connector will be installed as a standard, which requires the user to be signed in to operate. - No additional Active Directory permissions are required, and the user can proceed directly to the installation. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/installingsccm.png) Table 19. Types of Installation| **Installing as a Service** | **Installing as an Application** | |
| **Description** | Installs the SCCM Connector as a Windows service, allowing it to run in the background, even without a signed-in user. | Installs the SCCM Connector as a standard application, which requires a signed-in user to operate. |
| **Requirements** | Requires an Active Directory (AD) user login and password, as the service will use this account’s permissions. | No additional Active Directory permissions needed. |
| **Benefits** | Ideal for continuous operation, such as on servers or unattended systems where minimal user interaction is desired. | Suitable for personal or single-user environments where continuous background operation is unnecessary. |
**Note**. A user has to ensure that the AD account’s password doesn’t expire (if your policy allows) or consider a service account to prevent service interruptions.
##### Verifying Service Runs Under the Correct User After SCCM Connector Installation After installing the SCCM Connector as a service, a user should confirm the service is running under the newly created Active Directory (AD) user by following these steps: **Step 1: Verifying the SCCM Connector Service in Services** 1. **Opening the Services Management Console**: - On the server where the SCCM Connector was installed, the user presses **Windows + R**, typing services.msc, and pressing **Enter**. 2. **Locating the SCCM Connector Service**: - Finding the service named **Apptimized SCCM Connector** (or a similar name depending on the installation). [](https://docs.apptimized.com/uploads/images/gallery/2024-12/sccmconnectorproperties3.png) 3. **Checking the Log On Account** - Right-clicking on the **Apptimized SCCM Connector** service and selecting **Properties**. - Going to the **Log On** tab. - Ensuring **This account** is selected and that the **Account Name** and **Password** correspond to the newly created AD user (e.g., sccm\_connector\_user). - If the details do not match, updating the account information and click **OK**. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/checkinglogonacc.png) **Step 2: Confirming Service is Running Under the Correct User** 1. **Verifying the Service is Running**: - In the **Services** window, checking the **Status** column to ensure the **Apptimized SCCM Connector** service is listed as **Running**. 3. **Checking Event Viewer for Errors**: - Pressing **Windows + R**, type eventvwr.msc, and pressing **Enter** to open the **Event Viewer**. - Navigating to **Windows Logs** > **Application**. - Looking for events related to the **Apptimized SCCM Connector** service. Specifically, looking for **error messages** or **warnings** that might indicate issues with permissions or the service account. 5. **Testing SCCM Connectivity**: - Opening the **SCCM Environment Settings** at Apptimized portal and verifying the connector can communicate with the SCCM server (e.g., Connector status in Sccm Connector Status Bar should be **Connected**). [](https://docs.apptimized.com/uploads/images/gallery/2024-12/accountconnectedsccm.png) - If the connector fails to perform actions, confirming that the user account has the necessary SCCM permissions and the **Log On as a Service** rights are correctly applied. **Step 3: Troubleshooting Common Issues** **If the service doesn't start:** - Double-checking the AD user has the **Log on as a service** permission. - Ensuring the password for the user account is correct and not expired. - Checking the permissions on the **SCCM Connector** folder and files to ensure the service account has appropriate access. **If the service starts, but it doesn't communicate with SCCM:** - Confirming the user account is a member of the correct **SCCM administrative group** (e.g., **SCCM Admins** or **Application Administrator**). - Ensuring the user has the correct permissions to access the necessary **SCCM collections**. ### Application Template This section allows you to configure key settings for application deployment in SCCM. Define display and localized names, add administrative comments, organize applications in SCCM folders, and set options for task sequence auto-installation and distribution management during SCCM push. They will be used as default values for push to SCCM. The option to configure SCCM application template is available under **Project settings** > **Integration >** choose **SCCM Environment** > **Application template.** [](https://docs.apptimized.com/uploads/images/gallery/2024-12/apptemplate1.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2024-12/apptemplate2.png) ##### Application Settings Template [](https://docs.apptimized.com/uploads/images/gallery/2024-12/appsettingstemplate3.png) Table 1. Application template settings| **Setting** | **Description** |
| **Application Display Name** **(Required)** | The main name displayed for the application in the SCCM Console. This should be descriptive and easily identifiable for administrators. The default value is: **\[PackageName\]** for Workspace can be configured in Settings > Workspace > General > Packaging — Self Service settings > Package name. Dynamic variables in fields are allowed. |
| **Localized Application Name** | The name shown for the application in localized language settings, if applicable. Useful for multi-language environments. The default value is: **\[PackageName\]** for Workspace can be configured in Settings > Workspace > General > Packaging — Self Service settings > Package name. Dynamic variables in fields are allowed. |
| **Administrator Comments** | Notes or comments for administrators to document details about the application (e.g., purpose, version information). Dynamic variables in fields are allowed |
| **Folder for Application in SCCM Console** | Specifies the folder location within the SCCM Console where this application will be organized. Helps with managing and locating applications efficiently. Example: - Dummy\\Folder; - Dummy. **Note.** The package will be created under the root if the value is empty. |
| **Auto Install in Task Sequence** | A Yes/No switch that determines whether the application is automatically included in SCCM task sequences for deployment. |
| **Copy Package to DML During SCCM Push** | A Yes/No switch that controls whether the application package is copied to the **Distribution Management Library (DML)** during the SCCM push process. |
| **Сategory ** | **Description ** |
| Template name | The field indicates the template name to help a user to identify templates in Apptimized portal. |
| Name | This field indicates the name of a deployment type. |
| Technology title | This field indicates the type of template installation. |
| Source folder | This field indicates the path to the location of the package source. |
| Path to executable | This field indicates the path to the location of the package source executable file. |
| **Settings** | **Description** | **Availability of settings depending on the Installer type** | |||
| MSI | Script Installer | AppV | |||
| Microsoft Application Virtualization 4 | Microsoft Application Virtualization 5 | ||||
| Deployment type template name | The field indicates the template name to help a user to identify templates in Apptimized portal. The default value is **Deployment type template name \[number\]**. This field is required. | + | + | + | + |
| Deployment type name | This field indicates the name of a deployment type. It is implemented during SCCM application deployment process and is sent to SCCM server. A user can set the **Deployment type name** manually or use the following dynamic variables: [](https://docs.apptimized.com/uploads/images/gallery/2024-12/deploymenttypename.png) This field is required. | + | + | + | + |
| Path to the source | This field indicates the path to the location of the package source. SCCM deployment template automatically generated this field. This field is required. | + | + | + | + |
| Path to the executable | This field indicates the path to the location of the package source executable file. A user can set the **Path to the executable** manually or use the following dynamic variables: [](https://docs.apptimized.com/uploads/images/gallery/2024-12/pathtotheexecutable.png) This field is required. | + | + | + | + |
| Copy source to file share | This option allows to copy to the folder, the location of which was defined in field **Place for storing sources** in the **General** SCCM settings tab. | + | + | + | + |
| Installer type | This setting indicates the type of installer to use. The following installer types are available: - [MSI (Microsoft Installer)](https://docs.microsoft.com/en-us/windows/win32/msi/about-windows-installer); - [Script Installer](https://docs.microsoft.com/en-us/powershell/module/configurationmanager/add-cmdeploymenttype?view=sccm-ps#-scriptinstaller); - [AppV (Microsoft Application Virtualization 4)](https://docs.microsoft.com/en-us/microsoft-desktop-optimization-pack/appv-v4/); - [AppV (Microsoft Application Virtualization 5)](https://docs.microsoft.com/en-us/microsoft-desktop-optimization-pack/appv-v5/). The default value is **Script Installer**. | + | + | + | + |
| Script type for the detection method | This setting indicates the type of script content of the [detection method](https://docs.microsoft.com/en-us/configmgr/apps/deploy-use/create-applications#bkmk_dt-detect). The following script types for detection method are available: - [Powershell](https://docs.microsoft.com/en-us/powershell/scripting/overview?view=powershell-7); - [VB Script](https://docs.microsoft.com/en-us/previous-versions/sx7b3k7y%28v%3dvs.85%29); - [JScript](https://docs.microsoft.com/en-us/previous-versions/hbxc2t98(v=vs.85)). The default value is **Powershell**. | + | |||
| Detection script content template | This field specifies the script template of the detection method. It is possible to provide a custom template with mandatory variables in square brackets, indicating them in any order and quantity. The Connector replaces these variables with specific values during the deployment to SCCM. The default value is **Get-ItemProperty "HKLM:Software\\\[PackageName\]\\** **\[Manufacturer\]\\\[ApplicationName\]\\\[ApplicationVersion\]" -ErrorAction SilentlyContinue | Where { $\_.IsInstalled -eq 1 }** | + | |||
| Persist content in the client cache | This setting indicates the necessity to upload the application or package source to the client's machine or device cache. **Yes** or **No** options are available. The default value is **No**. | + | |||
| Installation command with parameters | This setting indicates the command to run during the package installation. The default value for the Script Installer is **Deploy-Application.exe -DeploymentType Install** The default value for the MSI Package is **msiexec /i "\\\\atd-dist01\\Public\\CM\\DTeam\\FeatureData\\OSD\\Tbreck\\Setup1.msi" or msiexec /i "\\\\atd-dist01\\Public\\CM\\DTeam\\FeatureData\\OSD\\Tbreck\\Setup1.msi" /qn** | + | + | ||
| Uninstallation command with parameters | This setting indicates the command to run during the package uninstallation. The default value is **Deploy-Application.exe -DeploymentType Uninstall** | + | |||
| Installation context | This option defines the context of the package installation. The following installation contexts are available: - install for the system; - install for a user; - install for the system if a resource is a device otherwise install for the user. The default value is **Install for the system**. This option corresponds to the term **Installation behaviour** in the SCCM admin console. | + | |||
| Should the user be logged on or not | This option defines the required user state when the installation starts. The following options are available: - only when no users are in the system; - only when a user logs in; - whether or not users are active in the system. The default value is **Whether or not users are active in the system**. This option corresponds to the term **Logon requirement** in the SCCM admin console. | + | |||
| Installation visibility for the user | This option defines the installation process visibility. The following options are available: - normal; - minimized; - maximized; - hidden. The default value is **Normal**. This option corresponds to the term **Installation program visibility** in the SCCM admin console. | + | |||
| Requires user interaction | This setting indicates if the user can be involved in the installation or uninstallation process. **Yes** or **No** options are available. The default value is **No**. | + | |||
| Identify deployment type information from a package file | This setting indicates the option of a manual (**Yes**) or automatic (**No**) deployment type information identification. The default value is **No**. | + | + | + | |
| The file where to get information | This field indicates the file with the deployment type information. The following options are available: - MSI file for MsiInstaller; - XML manifest for AppvInstaller; - AppV file for App5xInstaller. An installation type defines default value. | + | + | + | |
| What to do on a slow network | This option specifies actions with package sources in case of a slow network. Following options are available: - do nothing; - download; - download content for streaming. The default value is **Download**. | + | + | + | + |
| Maximum installation time (minutes) | This option indicates the maximum duration per installation in minutes. The default value is **120**. | + | + | + | + |
| Estimated installation time by default (minutes) | This option indicates the estimated duration per installation in minutes. The default value is 0. | + | + | + | + |
| Run installation program as a 32-bit process on 64-bit client | This setting forces the installer to launch as a 32-bit process on the 64-bit client. **Yes** or **No** options are available. The default value is **No**. | + | + | ||
| Administrator comments | This optional field corresponds to the term **Administrator comments** in the SCCM admin console. | + | + | + | + |
| **Сategory ** | **Description ** |
| Template name | The field indicates the template name to help a user to identify templates in Apptimized portal. |
| Name | This field indicates the name of a deployment type. |
| Distribution group | This field indicates group of users or devices where apps should be installed. |
| Collection type | This field indicates the type of collection required for application SCCM deployment. |
| Collection name | This field indicates the collection where apps should be installed. |
| Install or uninstall | This field indicates should application be installed/uninstalled on/from client machine. |
| Deploy purpose of the installation | This field defines if application is required to be installed or user can choose. |
| Set as default | This field defines which template should be used by default for SCCM autopush. |
| **Settings** | **Details** |
| Deployment template name | A unique name for the deployment template, allowing easy identification and reuse in future application deployments to SCCM. |
| Name of the default distribution group | Indicates the default group of users or devices where to Install applications. This setting corresponds to the term "**Distribution point group**" in the SCCM admin console. |
| Collection type | Indicates the type of collection where apps should be installed. The following types are: - Device - User |
| Collection name | Indicates the collection of devices where to install applications. This setting allows you to search and select from existing SCCM collections stored in the Apptimized database. To update the stored collections, click **Sync SCCM Collections** to the right of the **Collection Name** field. This sync will retrieve the latest collections from SCCM. [](https://docs.apptimized.com/uploads/images/gallery/2024-12/collectionname.png) The date of the last successful sync is displayed below the **Collection Name** field, helping you track when the collections were last updated. Collection list is updated automatically weekly. |
| Install or uninstall application | This setting indicates whether a task sequence action in SCCM Console can install the application. **Yes** or **No** options are available. |
| Deploy purpose of the installation | This option specifies whether the application deployment can is mandatory or optional. **Available** or **Required** options are available. |
| Setting | Description |
| Package name | This setting enables a user to set up the name for package template. This setting is **required**. The default value is: **\[Manufacturer\]\_\[ProductName\]\_\[ProductVersion\]\_\[AppLanguage\].** |
| Description | This setting enables a user to set an optional descriptions for the package template. |
| Where unzip package source | This setting enables a user to set up patch for unzipped package source files will be placed on. This section is **required**.
**Note. **In most cases, this field will be the same as **Source path **field value. |
| Use package name for the folder name | This setting enables a user to use package name as package folder name. The default value is **No**. |
| Source path | This setting enables a user to set up folder where the source is placed in zip file. The zip file name is ignored under clarifying the source path. This setting is **required**.
The default value is **\[Manufacturer\]\_\[ProductName\]\_\[ProductVersion\]\_\[AppLanguage\]**
**Note.** This path is relative to **Where unzip package source **field value. |
| Folder for package in SCCM Console | This setting enables a user to set up folder for package in SCCM Console.
Example:
- Dummy\\Folder;
- Dummy.
**Note.** The package will be created under the root if the value is empty. |
| Remove default User account | This setting enables a user to Remove user from Manage Access Account window, which is added to package by default. The default value is **Yes**. |
| Add account access | This setting enables a user to fill **Group name **and **Permission access level** fields. The default value is **Yes**. |
| Group name | This setting enables a user to fill name of the group that will be addedd to Manage Accont Acces window of SCCM servier. The fill within form is **\[domain\]\\\[groupName\]**. This setting is **required**. |
| Permission access level | This setting enables to set up permission access level for the specified user. The following levels available: - Read; - Change; - Full control; - No access. The default value is **Read**. |
| Set security scope | This setting enables to set up **Security scope **field to be specified. |
| Security scope | This setting enables a user to set up Security scope name that will be set to most (or all) packages. This setting is **required**. The default value is **Factory DPs**. |
| **Setting** | **Description** |
| Program name | This setting enables a user to set up the name of the program template. This setting is **required**. The default value is **Install.** |
| Command line | This setting enables a user to set up the command line of the program template. The default value is **install.cmd** |
| Start folder | This setting enables a user to set up he name of startup folder of the program template. |
| User interaction | This setting enables to set up interaction lever of user with package. The following levels available: - Hidden; - Minimized; - Normal; - Maximized. The default value is **Hidden**. |
| Program can run | This setting enables a user to define run context of package. The following contexts available: - Whether or not user is logged on; - Only when user is logged on; - Only when no user is logged on. The default value is **Whether or not user is logged on**. |
| Run mode | This setting enables a user to define permission level of package context run. This setting is available to change only if **Only when user is logged on **setting is set under **Program can run **setting. The following permission levels available: - Run with Administrative rights; - Run with user rights; The default value is **Run with Administrative rights**. |
| Allow users to view and interact with the program installation | This setting enables to allow users to view and interact with the program insallation. The default value is **No**. |
| Drive mode | This setting enables to define drive mode of the package installation / uninstallation. The following modes available: - Runs with UNC name; - Required drive letter - Requires specific drive letter (example: Z:). The default value is **Runs with UNC name**. |
| Allow this program to be installed from task sequence | This setting enables to allow the program to be installaed from the Install Package task sequecne without being deployed. The default value is **No**. |
| Select platfroms | This setting enables to select OS platforms where package can run.
The following platforms available:
- All Windows 10 (64-bit);
- All Windows 7 (64-bit);
- All Windows 8.1 (64-bit);
- All Windows Server 2008 R2 (64-bit);
- All Windows Server 2012 R2 (64-bit);
- All Windows Server 2016 (64-bit);
- All Windows 7 (32-bit).
**Note**. Empty field value is allowing any platform. |
| Estimated disk space | This setting enables to estimate disk space for packages if required. The value if unknown is 0 or empty. The default value is 0. |
| Select unit of a disk sace size | This setting enables to define unit f the disk space if the estimated disk space is set. The following units available: - KB; - MB; - GB. The default value is **MB**. |
| Maximum allowed run time (minutes) | This setting enables a user to set up maximum allowed run time in minutes. The default value is **120**. |
| Administrative comment | This optional field corresponds to the term **Administrator comments** in the SCCM admin console. |
| **Setting** | **Description** |
| Program name | This setting enables to set up program name to which deployment belongs to. This field is **required**. The default value is **Install**. |
| Collection type | This setting enables to indicate the collection type that will be loaded from the user SCCM server. This setting is **required**. The following types are available: - Device; - User. The default value is **Device**. |
| Limiting collection for the deployment | This setting enables settng limiting collection for the collection deployment. |
| Collection folder in SCCM Console | This setting enables setting up a collection path under the SCCM console. |
| Action | This setting enables set the action during deployment. The available action is **Install**. The value can not be changed. |
| Purpose | This setting enables the definition of the requirement of the installation/uninstallation process. The following values are available: - Available; - Required. The default value is **Available**. |
| Send wake-up packets | This setting enables to define sending [wake-up packets](https://docs.microsoft.com/en-us/mem/configmgr/core/clients/deploy/plan/plan-wake-up-clients) before deployment under SCCM. The default value is **No**. Note. This setting is available only if **Required **purpose is set. |
| Allow clients on a metered internet connection to download content after the installation deadline, which right incurs additional costs | This setting enables to allow clients on a metered internet connection to download content after the installation deadline, which right incurs additional costs. The default value is **No**. Note. This setting is available only if **Required **purpose is set. |
| Rerun behavior | This setting enables to specify rerunning deployment behavior on a client. The following values are available: - Always rerun program; - Never rerun deployed program; - Rerun if failed previous attempt; - Rerun if succeeded on the previous attempt. The default value is **Always rerun program**. Note. This setting is available only if **Required **purpose is set. |
| Recur every | The setting enables to specify a recurring interval. The default value is **1**. **Note**. This setting is available only if **Required **purpose is set. |
| Recurrence interval type | This setting enables selection of recurrence interval types for the schedule. The following options are available: - Days; - Hours; - Minutes. The default value is **Days**. **Note**. This setting is available only if **Required **purpose is set. |
| Schedule | This setting enables to schedule date and time for the deployment. **Note. **Time must be UTC. The time will be converted to the timezone of the User’s SCCM Server. This setting is** **available only if** Required **purpose is set. |
| Allow users to run the program independently of assignments | This setting enables users to run the program from Software Center. The default value is **Yes**. The value can not be changed. |
| Software installation | This setting enables a user to allow installation of the deployed software outside of maintenance windows. The default value is **No**. |
| System restart (if required to complete the installation) | This setting enables to set up system restarting outside a maintenance window. The default value is **No**. |
| Commit changes at deadline or during a maintenance window (requires restarts) | This setting enables to setting up write filters for embedded devices. The default value is **Yes**. **Note**. If this setting is not enabled, the content will be applied on the overlay and committed later. |
| Select the deployment option to use when a client uses a distribution point from a current boundary group | This setting enables to specify client behavior on a fast network. The following options are available to select: - Download content from distribution point and run locally; - Run program from the distribution point. The default value is **Download content from distribution point and run locally**. |
| Select the deployment option to use when a client uses a distribution point from a neighbor boundary group or the default site boundary group | This setting enables to specify client behavior on a slow network. The following options are available to select: - Download content from distribution point and run locally; - Do not run program; The default value is **Download content from distribution point and run locally**. |
| Allow clients to use distribution points from the default site boundary group | This setting enables allow clients to use shared content. The default value is **No**. |
**Note.** The multiple-choice option is available in the **Select platforms** field. For each selected item, a separate category will be created.
The following Windows platforms available: - Windows 7 DE - Windows 7 64-bit EN - Windows 10 64 bit EN (1809) - Windows 10 64 bit EN (1607) - Windows 10 64 bit DE (1607) - Windows 10 (1809) DE The option to delete the Windows platform from the list within the Project is available under the **Delete** button > **Confirm delete platform** modal window > **Delete** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/H5qiW4Fm4Ex7oWsH-virtualization_05.png) To enable the Windows platform required in the self-service module, check the box in front of the platform name. To apply the virtualization general settings, click the **Save** button. #### **Providers** ##### **Azure switch****Note.** The Azure-side configuration is available under [**Azure Tenant VDI Provider Integration**](https://docs.apptimized.com/books/apptimized-platform-admin-manual/page/azure-tenant-vdi-provider-integration)
The Azure virtualization provider activates when the **Azure** switch is enabled. All required fields are marked with an asterisk \*. The option is disabled by default.| **Setting** | **Details** |
| Azure subscription name | This setting indicates the name of user’s Azure subscription (**portal.azure.com** > **Subscription** > **Subscription name**). |
| Subscription Id | This setting indicates the user’s subscription Id in Azure (**portal.azure.com** > **Subscription** > **Subscription Id**). |
| Client Id | This setting indicates the user (application) Id from Azure Active directory. |
| Client Secret | This setting indicates the client secret of the application from Azure Active directory. It is a secret string that an application uses to prove its identity when requesting a token. Also, it can be referred to as an application password. |
| Tenant Id | This setting indicates the directory (Tenant) Id of Application from Azure Active Directory. |
| Resource group | This setting indicates the resource group from **portal.azure.com**. It is a container that keeps related resources for an Azure solution. |
| Region | This setting indicates the region of a resource group at **portal.azure.com**. |
| Network name | This setting indicates the virtual network name from **portal.azure.com.** |
| Subnet name | This setting indicates the subnet name the virtual network from **portal.azure.com**. |
| VM size | This setting indicates a disk size of the VM.
VM disk size depends on a user subscription type.
The following types of sizes available:
- General purpose;
- Compute optimized;
- Memory optimized
- Storage optimized;
- GPU;
- High performance compute
[Learn more](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes).
**Note**. It is necessary to select the size of the VM's that supports Generation 1 and 2 if any will be used. |
| OS disk type | This setting indicates a disk type of the VM. The following types available: - Standard HDD; - Standard SSD; - Premium SSD; - Ultra disk. |
| VMs limit | This setting indicates a maximum number of currently running VMs. **Yes** or **No** options are available. The default value is **No**. When the **VMs limit** switch is activated, a user must enter a number in the **Maximum number of currently running VMs** field. |
**Note**. The option to add a new Azure image becomes available after the Azure switch settings were set up.
| **Setting** | **Description** |
| Name | This setting defines the name for a new Azure image. The naming is a user preference. |
| Platform | This setting defines the name of Windows platform (i.e., **Windows 10**). |
| OS Build | This setting defines the operating system build that will be used (i.e., **18363.753** – is an OS build for Windows 10, version 1909). OS build is a timeline of minor build releases in between the major version number releases. |
| OS Version | This setting defines the operation system version that will be used. The following options available: - Windows 7; - Windows 8; - Windows 10. The default value is **Windows 10**. |
| OS Language | This setting defines the operating system language mode. The following options available: - EN; - DE. The default value is **EN**. |
| OS type | This setting defines the operating system type mode. The following options available: - Windows Server; - Desktop Windows. The default value is **Windows Server**. |
| Enabled | This setting indicates that the current image is enabled for use. |
| Disk generation | This setting defines the Hyper-V virtual machine generation. The following options available: - V1; - V2. |
| Link to VHD / Snapshot name | This setting indicates the link to VHD / Snapshot that is stored on **portal.azure.com** storage. |
| Windows username | This setting is automatically prefilling with the project creator data (i.e., **test.account@apptimized.com**). Setting a Windows username is a user preference and the automatically prefilling data can be changed. |
| Password for log in | This setting is automatically prefilling with the project creator data. Setting a login password is a user preference and the automatically prefilling data can be changed. |
| **Setting** | **Description** |
| Name | This setting defines the name for a new Azure image. The naming is a user preference. This field is required. |
| Platform | This setting defines the name of the Windows platform (i.e., **Windows 10**). |
| OS Build | This setting defines the operating system build that will be used (i.e., **18363.753** – is an OS build for Windows 10, version 1909). OS build is a timeline of minor build releases in between the major version number releases. |
| OS Version | This setting defines the operation system version that will be used. The following options available: - Windows 7; - Windows 8; - Windows 10. The default value is **Windows 10**. |
| OS Language | This setting defines the operating system language mode. The following options available: - EN; - DE. The default value is **EN**. |
| OS type | This setting defines the operating system type mode. The following options available: - Windows Server; - Desktop Windows. The default value is **Windows**. **Server**. |
| Enabled | This setting indicates that the current image is enabled for use. |
| Base snapshot | This setting defines the name of the snapshot (a captured state of a system in a particular time point). It is usually used as a back-up copy or as a basis to troubleshoot issues. This field is required. |
| Base image | This setting defines the name of the existed operating system image which can be used as a basis for this image. This field is required. |
The project administrator role appears as an initial default role after the project was created. Project administrators can perform any workflow action.
To complete the tasks with role assignments, a user must be a Project administrator or must have permission for these activities.
### Create a role The option to create a role with needed permissions is available under **Roles** in project settings (**Project** menu > **Administration** > **Roles**). [](https://docs.apptimized.com/uploads/images/gallery/2025-11/tOKimage.png) Apptimized opens the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2025-11/gl8image.png) The option to create a new role is available under the **Add new role** button: [](https://docs.apptimized.com/uploads/images/gallery/2025-11/Wl9image.png) Apptimized shows the following modal window when successful: [](https://docs.apptimized.com/uploads/images/gallery/2026-02/add-new-role.png) The new role requires its name, project, workflow and updates permissions. All required fields are marked with an asterisk \*. [](https://docs.apptimized.com/uploads/images/gallery/2026-02/2vTadd-new-role-pick.png) Table 1. Role attributes| **Attribute** | **Description** |
| **Project permissions** | |
| Dashboards | This attribute provides access to the project dashboard. |
| Access to all apps | This attribute providees access to all apps if the **Application owner** field is enabled. |
| Roles | This attribute provides access to perform role management activities for the project. |
| Groups and users | This attribute provides access to perform management activities with groups and users for the project. |
| File Storage | This attribute provides access to a dedicated/separate file storage to which the user can upload files for later use. |
| Echo “assisted” | This attribute provides access to assisted Echo playback for interactive sessions such as Discovery and Testing. |
| Echo Testing | This attribute provides test automation capabilities: record the user’s test case and play it back automatically when needed. |
| Echo platforms | This attribute provides the ability to add and remove Echo platforms in project on Echo statistics page. |
| Echo applications | This attribute provides abilities to check applications for new Echo platform and approve new Echo platform in Project on Echo statistics page. |
| Catalogue | This attribute provides access to latest version of the application which was packaged with a standard guide and ready for use. |
| SCCM | This attribute provides access to perform SCCM activities within the project. The option becomes active when SCCM is enabled for the project. |
| Intune | This attribute provides access to perform Intune activities within the project. The option becomes active when Intune is enabled for the project. |
| Notifications | This attribute provides access to project notification settings. |
| Care | This attribute provides access to Apptimized Care functionality within the project. |
| Customiz3r | This attribute allows access to receive custom packages from the Care service. The option becomes available when Care is selected for the role. |
| **Workflow permissions** | |
| Import | This attribute provides access to perform activities on the **Import** step of the project's workflow. |
| Discovery Self Service | This attribute provides access to perform activities on the **Discovery - Self Service** step of the project's workflow. |
| Discovery Factory Service | This attribute provides access to perform activities on the **Discovery - Factory Service** step of the project's workflow. |
| Packaging Self Service | This attribute provides access to perform activities on the **Packaging - Self Service step** of the project's workflow. |
| Packaging Factory Service | This attribute provides access to perform activities on the **Packaging Factory Service** step of the project's workflow. |
| Testing Self Service | This attribute provides access to perform activities on the **Testing - Self Service step** of the project's workflow. |
| Download | This attribute provides access to perform the **Download** step in the workflow. |
| **Updates** | |
| View | This attribute provides view access to the Updates feature of Apptimized. |
| Modify | This attribute provides permissions to operate with updates, including tracking, editing, and processing. |
| Emails | This attribute enables receiving e-mail notifications about updates. The option becomes available when Notifications is selected for the role. |
| **File Storage** (available if the [Storage](https://docs.apptimized.com/link/242#bkmrk-storage) feature is enabled in the project settings) | |
| Full control | This attribute provides permissions to download, upload, and remove files and directories in project storage. |
| Upload | This attribute provides permission to upload files and create directories in project storage. |
| Download | This attribute provides permission to access, view, and download content from project storage. |
The **Project administrators** group appears as an initial default group after the project was created. Project administrators can perform any workflow action.
To complete the tasks with role assignments, a user must be a Project administrator or must have permission for these activities.
### Create a group The option to create a group with needed permissions is available under **Groups & users** in project settings (**Project** menu > **Administration** > **Groups & users**). [](https://docs.apptimized.com/uploads/images/gallery/2020-04/xpctEC0Ncr1uRdEG-groups_01.PNG) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/A1DHiv3ZbZ9rjKoR-groups_02.PNG) The option to create a new group is available under the **Create new group** button:[](https://docs.apptimized.com/uploads/images/gallery/2020-04/XG43yI7Jf2YMF8CB-groups_03.PNG) Apptimized shows the following modal window when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/jQmR0CfwIZ223O69-groups_04.PNG) The new group requires its name and role. All required fields are marked with an asterisk \*. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/nfNe3xsbNRIh8RPq-groups_05.png) Adding a role to a group implies that the role has already been created (see [**Project roles** ](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/project-roles)chapter). Apptimized shows the following notification and screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/MWrt4kRvVZoB1G6K-groups_06.png) ### Manage a group Users can be added to the group via the **Update members** button (**Update members** button > **Add users** field > Select a user from a drop-down list > **Save** button). [](https://docs.apptimized.com/uploads/images/gallery/2020-04/g7N4VT0ppA7dkeBF-groups_07.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/29pdSx6cIyzzGRbM-groups_08.png) Apptimized shows the following notifications and screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/9UHp0rYUL0tAJaWf-groups_09.png) If the person does not have an Apptimized account, the Email address will not appear in the drop-down menu. The option to invite a new user to Apptimized and to add the to-be-created user account to a group is available under the **Update members** button > **Add users** field > Enter Email > **Save** button. The person will be informed via Email (see **[Register to Apptimized Portal](https://docs.apptimized.com/books/apptimized-admincenter-user-manual/page/single-sign-on#bkmrk-register-to-apptimiz))**. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/NIn8zQHKobRed807-groups_10.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/9AYlVnFGOZvATQeG-groups_10_1.png) The option to delete a group member is available under the **Update members** button > **Bin** symbol in front of the user's name > **Save** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/D6eB8UevrLkYXDgP-groups_11_1.png) The option to set a group manager is available under the **Update members** button > **Group manager** field > Select a user from a drop-down list > **Save** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Nv6rZb5cieSgBTgQ-groups_13.png) A group can be changed with the **Edit** button and by following the same set of operations as for adding a new group. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/eC2SegGsBaaZDZXX-groups_12.png) The option to delete the group is available under the **Delete** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/7qRsPErjNWRv8J3a-groups_14.png) Apptimized shows the following modal window: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/xeaME8rL86jSifwF-groups_15.png) Apptimized shows the following notification and screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Dgcyo1aOTCvx3kQP-groups_16.png) # Dashboards #### Default configurations By default, a new project is created with two predefined components in the project dashboard: **Portfolio** and **Overview**. [](https://docs.apptimized.com/uploads/images/gallery/2020-07/IcmFnZw8cV5cvkv3-dashboards_default_02.png) ##### Overview dashboard Apptimized shows the following screen upon the project creation: [](https://docs.apptimized.com/uploads/images/gallery/2020-07/eMr8o2hjMbHZYovU-dashboards_overview_01.PNG) The overview dashboard contains the following blocks: 1. Project stages statistics 2. Your assignments 3. Project basket 4. Completed modules The overview dashboard is filled with data as the project is implemented. The project progress data (i.e., multiple dashboard widgets, depending on enabled modules; a list of assignments; a list of applications) will be displayed in the relevant dashboard blocks.| **Block name** | **Description** |
| Project stages statistics | This block shows the Project workflow steps statistics and status. Project steps statistics is provided in the form of the number of applications used in a particular step (module). Apptimized shows the following screen when the project gets some progress: [](https://docs.apptimized.com/uploads/images/gallery/2020-07/W1WH2LDlJyiRPcwn-dashboards_overview_02.PNG) |
| Your assignments | This block shows a list of applications that are assigned to a user currently logged in. This block is configured as a table. Assignments data is grouped into the following categories: - Vendor - Software - Version - Language - Actions [](https://docs.apptimized.com/uploads/images/gallery/2020-07/mP7BvaXKMtS0gXgd-dashboards_overview_03.PNG) |
| Project basket | This block contains information about all applications that are used in this particular project. This block is configured as a table. Project basket data is grouped into the following categories: - Vendor - Software - Version - Language - Assignee - Actions [](https://docs.apptimized.com/uploads/images/gallery/2020-07/zGxZkVxhWAmSEwXF-dashboards_overview_04.PNG) |
| Completed modules | This block shows the statistics of completed steps (modules) within the project. This block is configured as a chart. Each chart sector shows the number of applications completed a particular step (module). [](https://docs.apptimized.com/uploads/images/gallery/2020-07/w1FosJlixL0a6Wsa-dashboards_overview_05.PNG) |
| **Settings** | **Details** |
| Dashboard name | **Dashboard name** field allows users to set the dashboard name (e.g., “Demo dashboard”). There is no default value in this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/nt2Tw7zWV89e1TpF-dashboard_01.png) |
| Share it | **Share it** option. Apptimized provides two options to share the dashboard: - Sharing with users - Sharing with groups (e.g., with “Project Administrators”) There is no default value in this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/vrax7mSlsWi8KcOR-dashboard_02.png) |
**Note**. If a user chooses **Chart widget** type, the field **Based on preset** appears in the modal window (see the [**Widget presets**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-widget-presets%C2%A0)). [](https://docs.apptimized.com/uploads/images/gallery/2020-12/lRogCGbDEK7KOGnC-dashboard_07.png)
The widget settings become active when clicking on the **Create** button. Apptimized shows the Widget when successful. The screenshot below shows a result for the creation of a **Chart** widget named “Portfolio”. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/re9C3vhsbqQZbQkZ-dashboard_06.png) The option to edit the layout for the dashboard is available under **Settings > Edit dashboard. ** **[](https://docs.apptimized.com/uploads/images/gallery/2020-12/CPJgVHha5q6DrW2e-dashboard_09.png)** Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/wTJwndVKyPgagZWa-dashboard_10.png) The option to delete a block or a widget from a dashboard is available under **bin** symbol. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/SGMOMCDI49i1dcQ6-dashboard_11.png) The option to change the owner is available under **Settings > Edit dashboard. ** **[](https://docs.apptimized.com/uploads/images/gallery/2024-11/change-owner.png)**The option is available for project and Global admins only.
##### Widget presets **Widget presets** are pre-configured and automatically generated presets available for **Chart widget** type. Every preset is based on the information in the project **Portfolio** (see the [**Portfolio**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/portfolio "Portfolio")). The option to choose a widget preset is available under **Based on preset** while widget creation (see the [**Add Widget**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-add-widget)). [](https://docs.apptimized.com/uploads/images/gallery/2020-12/U8IZrGEtrr3hpcyk-dashboard_12.png) The following **Based on preset** settings available:| **Setting** | **Details** |
| Portfolio chart | **Portfolio chart** is a setting indicating the option to create a **Chart **widget based on the application number in each workflow module (see the [**Overview dashboard**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-overview-dashboard)). The default value is the **Portfolio chart**. The screenshot below shows a result for the creation of a widget based on the **Portfolio chart**: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/bn2uzazdB5cDgP19-dashboard_13.png) The option to change Widget is available after creation (see [**Widget configuration**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-widget-configuration)). |
| Echo chart | **Echo chart** is a setting indicating the option to create a **Chart **widget based on a user’s Echo test cases status. The screenshot below shows a result for the creation of a widget based on the **Echo chart**: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/U9xfqV3w0kv4RSSM-dashboard_14.png) The option to change Widget is available after creation (see [**Widget configuration**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-widget-configuration)). |
| Project stages statistics | **Project stages statistics** is a setting indicating the option to create a **Chart** widget based on a user’s current project workflow steps statistics and status (see the [**Overview dashboard**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-overview-dashboard)). The screenshot below shows a result for the creation of a widget based on **Project stages statistics**: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/1W39XnVvjILGVPMK-dashboard_15.png) The option to change Widget is not available after creation. |
| Custom chart | **Custom chart** is a setting indicating the option to create a **Chart** widget based on a user’s configurations and conditions (see the **[Widget configuration](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-widget-configuration)** and [**Widget conditions configuration**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-widget-conditions%C2%A0co)). The screenshot below shows a few results for the creation of a widget based on the **Custom chart**: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/HA3Kue2RLNUh3hBR-dashboard_16.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-12/GienKh2tlDrmJxR2-dashboard_17.png) The widget view varies depending on the conditions configuration set by a user. The option to change Widget is available after creation (see [**Widget configuration**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-widget-configuration)). |
**Note**. Step 1: The widget conditions block is the same for all widget types. Step 2: Widget appearance varies depending on widget type (see the [**Table widget appearance configuration**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-table%C2%A0widget-appeara) and [**Chart widget appearance configuration**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/dashboards#bkmrk-chart%C2%A0widget-appeara)).
##### Widget conditions configuration The **Widget conditions** block sets the rules by which to apply applications search. This block consists of the condition groups list. Group consists of logical operators that should be applied to conditions below: • If all/any of these conditions are true/false; • Inner group conditions. The options to add a condition or a group of conditions are available under the** Add condition** and **Add group** buttons. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-09/TaD2Ne3fQAAycioW-dashboard_21_2-(1).png) [](https://docs.apptimized.com/uploads/images/gallery/2021-09/OcuvQYfjyZeCD0IH-dashboard_22_2.png) The following table contains all widget condition settings, options, parameters and values:| **Condition setting** | **Condition setting options** | **Condition setting parameter** | **Condition setting value** |
| App ID | - Is less than - Is greater than | - | Number |
| Application owner | - Contains - Not in | **-** | - Current user - Users assigned to a project |
| Vendor Software Language Reference | - Is - Is not - Starts with - Ends with - Contains - Is null or empty | - | Integer |
| Version | - Is less than - Is - Is not - Is greater than | - | Integer |
| Echo | - Contains - Not in | - Pending - In progress - Success - Failed - Review required - Action required - No Scenario - Disabled - All | - |
| Updated Push To Sccm | - Is less than - Is - Is not - Is greater than | - Date - Current Date - Days Offset - Weeks Offset - Start of week - Start of month - Start of year - End of week - End of month - End of year | Date |
| Application’s prerequisites | - Contains - Not in | - | Applications uploaded to the project & packages |
| Origin | - Contains - Not in | - CSV import - Classic import - Intune Import - SCCM Import - Catalogue & UM Import | - |
| Stage | - Starts with - Ends with - Contains | - | Integer |
| Application’s parent | - Contains - Not in | - | Applications uploaded to the project & packages |
| Factory request type Factory Request platfom Factory request start date Factory request SLA On Time/Overdue Factory request status Factory request delivery date Factory request invoiced Factory request date of invoicing | - Packaging – Factory Service | - | - |
| Assignee | - All - Current - Discovery – Self Service - Packaging – Self Service - Testing – Self Service - Discovery – Factory Service - Packaging – Factory Service - Testing - Factory Service | - | Users assigned to a specific step. |
| Status | - Global - Discovery – Self Service - Packaging – Self Service - Testing – Self Service - Discovery – Factory Service - Packaging – Factory Service - Testing – Factory Service | - Is - Is not | - Incomplete - Complete |
| Start Module Time Finish Module Time | - Discovery – Self Service - Packaging – Self Service - Testing – Self Service - Discovery – Factory Service - Packaging – Factory Service - Testing – Factory Service | - Is less than - Is - Is not - Is greater than | - Date - Current Date - Days Offset - Weeks Offset - Start of week - Start of month - Start of year - End of week - End of month - End of year |
| Deliverable | - Import - Discovery – Self Service - Packaging – Self Service - Testing – Self Serivce - Discovery – Factory Service - Packaging – Factory Service - Testing – Factory Service | - Is | - Not available - Available |
| Test status | - Testing – Self Service - Testing – Factory Service | - Contains - Not in | - Untested - Success - Failed - Fixed |
**Note.** If the project Portfolio is shared with other projects within organization, the **Projects to include** field appears in the **Step 2: Widget appearance** block (see the [**Project settings**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/project-settings "Project settings")). The **Project to include** field allows a user to include applications from other organization's projects to the Widget. There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/1mRRWxVQLTs8g1im-dashboard_35.png)
| Setting | Description |
| Widget name | The widget name field allows defining the widget name (e.g., Portfolio). |
| Default page size | This field allows defining number of items per table page. |
| Table Columns | This section allows setting up table columns container. |
| Ordering | This field allows arranging items in a sequence. The following criteria available: - Ascending; - Descending. The following items available: - App ID; - Application owner; - Vendor; - Software; - Version; - Language; - Assignee: All; - Updated; - Stage; - Assignee: Current. |
| Grouping | This field allows combining data into groups that have the same value in selected columns. The following items available: - App ID; - Application owner; - Vendor; - Software; - Version; - Language; - Assignee: All; - Updated; - Stage; - Assignee: Current. The following order settings available: - Ascending; - Descending. |
| Aggregates | This field allows defining high-level data composed from other more individual data by selected measurement for the column. The following aggregate options available: - Count; - Sum; - Average; - Min; - Max. |
| **Settings** | **Details** |
| Widget name | **The widget name **field allows defining the widget name (e.g., Portfolio). There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2021-09/c0qWAyrCjqimPN52-dashboard_28_2.png) |
| Chart type | **Chart type **field allows choosing a type for the chart. The following options available: - Pie - Bar The default value is **Pie**. [](https://docs.apptimized.com/uploads/images/gallery/2021-09/AwzzVmyxcFievq8z-dashboard_29_2.png) |
| Grouping | **The g****rouping** field allows combining data into groups.
The following options available:
- App ID
- Vendor
- Software
- Version
- Language
- Reference
- Echo
- Updated
- Application’s prerequisites
- Origin
- Stage
- Application’s parent
- Testcase status
- Echo platform
- Assignee
- Status
- Start module time
- Finish module time
- Deliverable
- Test status
- Push to Sccm
- Application owner
The default value is **App ID**.
[](https://docs.apptimized.com/uploads/images/gallery/2021-09/crB9GRJVlLIpz86w-dashboard_30_2.png)
**Note.** The options Assignee, Status, Start module time, Finish module time, Deliverable, and Test status varies depending on the project configuration (see the [**Create project**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/create-project "Create project")). |
**Note.** If the project Portfolio is shared with other projects within organization, the **Projects to include** field appears in the **Step 2: Project appearance** block (see the [**Project settings**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/project-settings "Project settings")). The **Project to include** field allows a user to include applications from other organization's projects to the Widget. There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2021-09/rWJJ91ax7oRrz8Pd-dashboard_36_2.png)
The settings are applied when clicking the **Save** button. A chart widget appears on the project dashboard. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/ZzU0pWsRpNvyKm06-dashboard_08.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/VK6XCYrFTefJka4f-dashboard_31_1.png) ##### Echo consumption widget appearance configuration The screenshot below shows settings a user can apply to configure echo consuption widget appearance. [](https://docs.apptimized.com/uploads/images/gallery/2022-02/C7CoS0mCELjFGjua-dashboards_30_x_2.png)**Note.** If the project Portfolio is shared with other projects within organization, the **Projects to include** field appears in the **Step 2: Widget appearance** block (see the [**Project settings**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/project-settings "Project settings")). The **Project to include** field allows a user to include applications from other organization's projects to the Widget. There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/1mRRWxVQLTs8g1im-dashboard_35.png)
| **Setting** | **Description** |
| Widget name | The widget name field allows defining the widget name (e.g., Portfolio). |
| Default page size | This field allows defining number of items per table page. |
| Table Columns | This section allows setting up table columns container. |
| Ordering | This field allows arranging items in a sequence. |
| Grouping | This field allows combining data into groups that have the same value in selected columns. |
| Aggregates | This field allows defining high-level data composed from other more individual data by selected measurement for the column. |
| **Column name** | **Details** |
| App ID | A personal static number of the application. |
| Vendor | A supplier of the application (i.e., **Tim Kosse**). |
| Software | The full official name of the application (i.e., **FileZilla**). |
| Version | A current version of the application (i.e., **3.5.2**). |
| Language | Information on the application language taken from metadata. A user can change this information in the **Upload - Confirm** step. |
| Assignee | This column indicates a person appointed to manage the application. |
| Updated | This column indicates the date and time when data on the application was last updated (i.e., **03/30/2020 10:35**). |
| Stage | This column provides the information on a current request step. The information is grouped by template: **<step name>** – **<sub step name>** (i.e., **Upload – Confirm**). The following stages options available: - Upload – Confirm / Initialize; - Discovery / Testing / Packaging – Initialize; - Discovery / Testing / Packaging - <Factory statuses>; - Discovery / Testing / Packaging – Self Service; - Discovery / Packaging – Screenshots; - Testing – Results; - Download - List of files. The following factory statuses available: - Ready for Discovery - a user’s request is submitted to Apptimized and is ready for processing by Apptimized team; - In Progress - Apptimized team is processing a user’s request; - Delivered - Apptimized team finished processing a user’s request and sent corresponding Deliverables; - Action Required – a user must check the request and provide additional information to Apptimized team; - Incoming check – Apptimized team is started processing a user’s request and checking all additional information; - Factory QA – a user’s Testing request is submitted to Apptimized and is in progress for processing by Apptimized team; - Action Required – a user must check a ticket and provide additional information to Apptimized team; - Delivered - Apptimized team uploaded the result for a user’s request, and a user must check it; - Error Analysis – a user found a bug in the package and sent a bug report to Apptimized team; - Approved - when the package is correct, and a user approves a request in the ticket. |
**Note.** With this type of import, the user can skip loading the source. In this case, the user enters the application metadata manually. But it should be noted that after the import step is completed, the user isn't able to perform actions on the workflow. Subsequently, the user can assign another user to the project, which downloads the source and perform actions on workflow.
Three options available to upload **Installation Source**: - Upload application file from user's PC; [](https://docs.apptimized.com/uploads/images/gallery/2026-03/upload-application-file-from-users-pc.png) - Upload application file from the Internet; [](https://docs.apptimized.com/uploads/images/gallery/2026-03/upload-application-file-from-the-internet.png) - Upload application file from the file storage. [](https://docs.apptimized.com/uploads/images/gallery/2026-03/upload-application-file-from-the-file-storage.png) The **Installation Source** uploading progress displays as follows: [](https://docs.apptimized.com/uploads/images/gallery/2026-03/the-installation-source-uploading-progress.png) The upload time depends on the application's size. When each download of an application is completed, the user can start uploading another application. **Five** application uploads are available for one session. Uploading **Discovery** **Document** is optional. A discovery document can be generated on previous sessions. Two options available to upload **Discovery** **Document**: - Upload application file from user's PC; [](https://docs.apptimized.com/uploads/images/gallery/2026-03/instructions-select-a-file.png) - Upload documentation file from the Internet. [](https://docs.apptimized.com/uploads/images/gallery/2026-03/load-documentation-from-the-internet.png) **One** discovery document upload is available for **one** session. Uploading **Application icon for SCCM/Intune** is optional. Supported file formats are **.png**, **.jpeg**, and **.jpg**. The maximum file size is **2 MB**. [](https://docs.apptimized.com/uploads/images/gallery/2026-03/application-icon-for-sccmintune.png) The **Upload sources and discovery document** step is finalised by clicking the **Next** button. [](https://docs.apptimized.com/uploads/images/gallery/2026-03/the-next-button.png) Apptimized shows the **Metadata** step when successful. [](https://docs.apptimized.com/uploads/images/gallery/2026-03/metadata.png) The process reverts to the previous step by clicking on the **Upload sources and documentation/instructions** button. [](https://docs.apptimized.com/uploads/images/gallery/2026-03/revert-to-the-previous-step.png) To extract the application metadata automatically a user can select the main installer from the list on the left or can enter the metadata manually into the fields on the right. All required fields are marked with an asterisk \*.**Note.** Apptimized automatically extracts metadata from the following files: exe, msi, msix, msixbundle, appx, appxbundle.
The following metadata will be provided: Table 1. Application metadata| **Metadata** | **Details** |
| Previous version of an application | This field defines if the previous version of the application is available in the portfolio. The default value is *Search by %Vendor% %AppName% %Version% %Language% (AppID %AppID%)*. A click opens a dropdown list to select the previous version of the application from the list. |
| Application ID | The application ID is a unique identifier generated automatically for every application during its upload. Application ID provides application identification. |
| Reference | This field is optional and can stay blank. This field provides additional comments from a user to the Apptimized portal (i.e. internal application ID). |
| Vendor | This field defines the vendor name. This is a required field. |
| Software | This field defines the application name. This is a required field. |
| Version | This field defines the application version. This is a required field. |
| Language | This field defines the application language. This is a required field. |
| Architecture | The Architecture field defines the system architecture supported by the application. The original value is detected from the installation source. This is a required field. |
| Enable Echo | This option defines if Echo is needed to be enabled. The Echo is enabled by default. |
**Note.** If the internal error while starting VM occurred, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-07/mfGAyKvousWOgkf1-discovery_error-massage_02.png) The following actions are recommended for consideration by a user: 1. Contact the Apptimized support 2. **Go to image page** button > **Select discovery – self-service platform** field > **Start VM** button [](https://docs.apptimized.com/uploads/images/gallery/2020-07/eCL8pyeSSe5jkcw7-discovery_error-massage_01.png)
The uploaded files locate in the **Apptimized files** folder on the VM desktop. To start the installation process, a user opens the **.EXE** file located in the **Source** folder. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/RZgpEpvsqvKyhNNX-discovery_08_02.png) Every action is captured as a screenshot which is shown in green boxes appearing on the right-hand side: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/gnvqJZaswYsQjSKd-discovery_09_02-(2).png) When application installation is completed, a user can provide further configurations (only the **Edit** and **Settings** categories). The option to copy files to **Temp storage** is available under **Explorer context menu** > **Copy To Temp**: [](https://docs.apptimized.com/uploads/images/gallery/2021-09/4rQFL20TVySxJ7hi-discovery_x_temp.png) The options to finish the VM session is available under the **Finish** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/zN0pb9KcXmEYBjOM-discovery_10.png) The following interface will appear when recording session with Apptimized VM finishes: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/VyEmdrcPwoadnywo-discovery_11.png) The option to restart the VM discovery session is available under the **Restart** button. To confirm the restarting the VM Apptimized shows the following modal window: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/1OYovMcZKX8ySaDX-discovery_12.png) #### **VM control menu** The VM control menu panel is available in the upper right corner of the VM interface. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/JoMtbGQZtNLEAKbT-discovery_14_3-(1).png) Next, each settings category is shown in more detail. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/nNEZNAPUcfm13h9N-Group-4-(2).png) Table 1. VM control menu| **Control menu category** | **Details** | |
| 1 | Screenshots | This setting indicates the screenshot mode. **On** and **Off** options available. The default value is **On**. |
| 2 | Add prerequisites/Edit prerequisites | This setting enables a user to add prerequisite applications.
**Portfolio** tab is available by default. **Update Monitoring** & **Catalogue** tabs become available if there are delivered packages on them.
[](https://docs.apptimized.com/uploads/images/gallery/2021-06/gKl7jlo4mZEY9n7Y-discovery_15_3.png)
**Portfolio** tab
The option to select application is available under **Select applications** field.
[.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/aVX1wrTkkFHsI6Uu-discovery_15_4-(1).png)
The option to select media type for applications is available after the application was selected.
The following media types available:
- Package
- Source
[](https://docs.apptimized.com/uploads/images/gallery/2021-06/9rTFu3uO8jQBfLgz-discovery_x_1.png)
**Note**. One media type is automatically selected if others are missing. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/RRzaEg7knQYdW6AG-image-73.png) The option to use Source media type is available under **Use Source** > **Select Media** > select source file. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/09nzmMPTTY0PjnNz-discovery_x_2-(1).png) The option to use Package media type is available under **Use Package** > **Select Media** > select package file. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/UTvHlXMeOp8T6RGS-discovery_x_3-(1).png) **Update Monitoring** Update Monitoring tab allows to add prerequisites as applications from **Update Monitoring **delivered packages. The option to Select application from Update Monitoring is available under **Select applications: **field > **Select Version for application**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/dDiIZZi1WXOAJvwx-discovery_X_4-(1).png) **Catalogue** **Catalogue **tab allows to add prerequisites as applications from **Catalogue **delivered packages. The option to select applications from the **Catalogue **is available under **Selec applications: **field > **Select Version for application**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/BqSiCGZbcUL99MGL-discovery_x_5-(1).png) The option to Save Changes is available under **Save **button. Apptimized shows the following notifications when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-06/cIBw78yPri9MfFL0-image-1624347161356.png) The option to **Edit prerequisites** becomes available after the prerequisites were added.**Note**. Uploaded prerequisites are shown in the discovery documentation under the Previous application section. [](https://docs.apptimized.com/uploads/images/gallery/2021-09/aZr9gkKZ88d8Edj2-discovery_x_8.png) |
| 3 | RDP | This setting enables a user to work on the VM directly via RDP rather than a browser window. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/q6mRszlhBxoS6Ug7-discovery_16_2-(1).png) The option to download a file is available under the **Download RDP** file. The **RDP file** is available in the **Downloads** folder in user’s PC. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/rj7D1Na0q3zipAnR-discovery_16_10.png) When the remote connection is set, copy the RDP password paste to the modal window. The remote desktop connection window appears when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-06/hXxgRaHm2vEiUvI8-discovery_16_11.png) |
| 4 | VM Snapshots | The setting enables to create a snapshot of the VM to save its current state or to revert to a state saved earlier. This is applicable when the application has prerequisites that need to be present before a certain action (i.e., Discovery, Packaging, or Testing) can be started. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/q1earvQUGQF2qJeK-discovery_17_2-(2).png) The snapshot option is available under the **VM snapshot** button > **Snapshot name** field > **Take** button. |
| 5 | Clipboard | This setting enables a user to put text from the user’s system to the VM clipboard. Transferring clipboard content between the host machine and the VM is performed via "Cut & Paste" in most user scenarios. If the user experiences any issues with "Cut & Paste", the Clipboard button can be used to put the text to the VM's clipboard. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/FirV4VtGIrouVpAf-discovery_18_2-(1).png) |
| 6 | Ctrl + Alt + Del | This setting enables to open security options menu at the VM. |
| 7 | Fullscreen | This setting enables to put a browser in a full-screen mode. |
| 8 | Restart | This setting enables a user to redo the discovery session on a restarted VM. The following restart options available: - OS (Operating system restart. Equal to Power > Restart); - VM (Equal to the Reset button on the real PC); - Session (Restart current session. All unsaved progress will be lost). [](https://docs.apptimized.com/uploads/images/gallery/2020-04/izI3ki86lz1WjB3S-discovery_19.png) When the restart option is chosen, the confirmation model window appears. |
| 9 | Finish | This setting finishes the VM when the discovery session is completed. |
| **Request status** | **Description** |
| Incoming check | The request has not been processed by the Apptimized team yet. The request is in the queue. |
| In progress | The request was processed by the Apptimized team. The request is in progress. |
| Action required | The Apptimized team asked the user a question. The user answer is needed. |
| Delivered | Discovery results are available to the user. Discovery results can be provided in **PDF** and **HTML** formats. |
| Error analysis | The user rejected the Discovery results. Apptimized team fixes bugs in the Discovery document. |
| Approved | The user has confirmed the Discovery results. |
| Canceled | The user canceled the Discovery request at the processing stage. |
**Note.** When a user approves the request, the option can`t be canceled.
##### **Deliverables block** This block provides the discovery results to a user. Discovery results can be provided in PDF and HTML formats. The option to download the discovery results is available under the **Download** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/fCmMOzkPF7ePOqjo-discovery_54-(1).png) If a user is not satisfied with the discovery results, they can be rejected for further processing by the Apptimized team. The option to reject the discovery results is available under the **Factory request** section under the **Factory activity **block (see [**Factory activity**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/discovery#bkmrk-comments-%26-attachmen) block). ##### **Factory activity block** The option to contact the specialist from the team is available under the **Factory activity** block > **Factory request** > **Write a message**... field. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/9uM3zWDYFN9427iC-discovery_19-(1).png) The option to add optional attachments to the comment, such as screenshots or additional files (max 10 MB per file), is available under the **Select ****file**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/YpioXUsNWIlUqMVd-discovery_20-(2).png) The option to send a message is available under the **Add** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/PLn2ZE9n3MlRx3J3-discovery_21-(1).png) The option to provide additional comments or attachments to the Apptimized team is available under the **Factory activity** block after the Factory request was solved. The option to ask additional questions to the Apptimized team is available under the **Report a problem** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/dCyeofcN0C8DqNmh-discovery_22-(1).png) Apptimized provides the following modal window when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/N2n2ngaEjbmuGYvS-packaging_23-(2).png) The option to write a text message is available under the **Write your problem** field. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/6xoAlvb3jarfH8su-packaging_24.png)**Note.** This field is mandatory.
The option to attach a file is available under the **Select file** field. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/BohpvVdHQAv8vQD9-packaging_25.png) The option to change the attached file is available under the **Change** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/O39QjMB2hotX9p2z-packaging_26_3-(1).png) The option to remove the attached file is available under the **Remove** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/ITBYIKfheqDvVfxR-packaging-27-(1).png) The option to send a message is available under **Send** field. **Cancel** – reverts to general Factory process workflow. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/9UTowLyYgK7MB2ZW-packaging_28.png) Apptimized shows the message history interface when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/fCmMOzkPF7ePOqjo-discovery_54-(1).png)**Note.** The attached files appear above the message history interface.
[.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/PpQYlcpOFyHOAo6Z-discovery_30-(1).png) If Apptimized needs some additional information, a user will receive notifications and a warning icon in the dashboard: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/YrFbKwxmH57iw66m-discovery_40-(2).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/LKFlzJYbCoL0pwpL-discovery_34-(1).png) If there is feedback from the user regarding the Factory Request, the following notification and status in the dashboard appear: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/wsajrhpC8RCdeXuQ-packaging_36-(1).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/gAY4IknVjTajo4CA-discovery_36-(1).png) Apptimized provides the following notification and statuses in workflow and dashboard after the request was solved: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/wsajrhpC8RCdeXuQ-packaging_36-(1).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/qWlHKpSJMcdp5swM-discovery_33-(2).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/GZ5eFNv0AiDqwREG-discovery_37-(2).png) ##### **Finish Discovery - Factory Service** The Finish button becomes active when a request is approved by a user. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/xPAWwfKD1DwjQCyP-discovery_62-(4).png) The option to create a new request is available under the **Create new request** button. Apptimized shows the following modal window to confirm the request approval: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/SySuYgeb9XrmoHNT-discovery_49.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/YOeDdCjqeZUenEiA-discovery_61.png) The option to finish Discovery - Factory Service process is available under the **Finish** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/6qlXsYryghMyrXDB-discovery_59-(1).png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-08/MNP04Qq1Iber55Bs-discovery_60_2.png) # Packaging The following scenarios to open the transition screen available: 1. **My Dashboard** > **My Applications** > Choose the project > Actions column > **Process** option; 2. **Project menu** > **Dashboards** > **Overview** > **Your assignments** module > Choose the application > Actions column > **Process** option; 3. **Project menu** > **Dashboards** > **Portfolio** > Actions column > **Process** option; 4. **Project menu** > **Import** > **Start import** > **Classic import / Import from CSV file / SCCM Import /Catalogue & UM Import** > Application upload session > **Finish** Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/O9885x7Wsanw7jle-packaging_01_1.PNG) The packaging process starts by clicking the **Packaging module** on the Transition screen. An imported application into a project is a prerequisite. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Es4iHI9bHJHhIYiw-packaging_01.png) Two packaging scenarios available in Apptimized portal: - Packaging – Self Service; - Packaging – Factory Service. ## **Packaging – Self Service** A user implements a built-in packaging tool on VMs – Apptimized Workspace. A user can easily in a couple of clicks create one or several packages of multiple formats and send them to Apptimized for further testing or deployment. Packaging – Self Service characteristics: - A user packages the application using the Apptimized Packaging Tool; - A user creates and customizes MSI, App-V, MSIX, VSL packages; - A user customizes an existing package or sequence; - A user tests and debugs installations. The **Packaging - Self Service** option is available under the **Packaging - Self Service** module in the **Transition screen**. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/X5wd7An6tKeKKaWo-packaging_01_2.PNG) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2026-03/vm.png) ### **Packaging tab** ### **Start VM** The field **Select packaging – self service platform** is filled automatically and can be changed if needed. To change the packaging – self service platform, click the drop-down menu as it is shown in the screenshot below: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/yEIA6pQNPDAWwplo-packaging_31.png) The option to revert to the transition screen is available under the **Go to Transition screen** button. The option to use an original Windows desktop image is available via the **support** link on the **Packaging — Self Service** screen. [](https://docs.apptimized.com/uploads/images/gallery/2026-03/original-windows-desktop-image.png) The option to start the packaging – self service process is available under the **Start VM** button. A user can track the VM loading and deploying. Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-10/0rEUhGQslGKmqmae-packaging_32.PNG)**Note.** There is often a situation when a user has already run 2 VMs in parallel. To continue planned activities within the current workflow step, a user must terminate an irrelevant VM. In this case, Apptimized shows the warning box with a list of VMs which are currently running by the user: [](https://docs.apptimized.com/uploads/images/gallery/2020-07/uh1YFhfTV4ZZGU24-listvm_01.png) The information is grouped into the following categories in the modal window: 1. Application 2. VM started time 3. Workflow progress 4. Link The option to select a VM for termination is available under the **Go to VM** link. A new tab opens when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/hjRSj8A8v5lh9KoR-03_packaging_02-(1).png) When a VM is terminated, a user returns to the screen where he needs to restart a VM (previously a user started a VM but received a modal window with a list of running VMs).
Apptimized shows the following screen when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/kKWtF9BEAIfsyH00-0x_packaging-(1).png)**Note.** If the internal error while starting VM occurred, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-07/P9iWGIvewtYN4jgW-packaging_error-massage_02.png) The following actions are recommended for consideration by a user: 1. Contact the Apptimized support 2. **Go to image page** button > **Select discovery – self-service platform** field > **Start VM** button [](https://docs.apptimized.com/uploads/images/gallery/2020-07/CcmVJQZOcQUn3rDO-packaging_error-massage_01.png)
The option to copy files to **Temp storage** is available under **Explorer context menu** > **Copy To Temp**: [](https://docs.apptimized.com/uploads/images/gallery/2021-09/4rQFL20TVySxJ7hi-discovery_x_temp.png) The option to restart VM is available under the **Restart** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/ECtSk2CUv4Dakubp-packaging_07_3.png) Apptimized shows the following modal window to confirm restart the task: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Rj1wUkAOYoP8YSsk-packaging_07_4.png) Apptimized shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/JNW3EdJopZ56DHQd-packaging_07_5.png) ### **Workspace Launcher** #### **General overview** **Apptimized Workspace Launcher** is a Windows-based application that provides a user with a packaging toolset within Apptimized cloud environment. With the **Apptimized Workspace Launcher**, the** **cloud** **environment is prepared according to a user’s preferences so that any additional activities to start packaging are not needed. With the release of the Workspace Launcher, new shared storage implemented that empowers a user with the enhanced upload and editing capabilities: - Editing packages is available both via Apptmized Packaging Engine and favorite third-party tools. - All packages synchronize automatically from the VM to the project once it is located in the **[Packages](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/packaging#bkmrk-upload-results-from-)** folder. Apptimized Workspace Launcher enables the user with additional tools, as part of their daily packaging experience. With Apptimized Workspace (providing Discovery, Packaging, Testing as Self-Service) by implementing Workspace Launcher, users can add to the functionality already offered to overcome many packaging scenarios. The **Apptimized Workspace Launcher **comes preinstalled on Apptimized VMs and could be launched by a shortcut on the VM’s desktop. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/jZn7V0CnEMFZ48nZ-launcher_01.png)**Note. ** When the VM starts, the application imported within the project and the VM’s shortcut are available. The packaging toolset is no installed. Once the user selects tools to implement for the desired deliverable, the application starts automatically.
The Apptimized Workspace Launcher applications have no impact on an operating system. The operating system always stays clean, so no repackaging conflicts occur, or system noise does not affect the user’s packaging session. By default, **Apptimized Workspace Launcher **comes with the following user interface (UI). [](https://docs.apptimized.com/uploads/images/gallery/2020-12/N0ir5FBF6MbKG1Kj-launcher_02.png) The **Apptimized Workspace Launcher** UI consists of the following elements: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/188lCzZ2nDWUj4WY-launcher_03.png)| **UI element** | **Description** |
| 1. Categories filter | This component allows a user to navigate between different categories of applications (bundles) and filter the content pane. The following categories available: - All - App-V - Msi - Msix - Productivity - System - Utility |
| 2\. Top panel 2.1. Favorites tab | This component contains a list of applications (bundles) a user marked as a favorite. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/FZDIWsFI6CKAYo0n-launcher_04.png) |
| 2.2. Tools tab | This component includes a full list of applications in a current category. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/TXiTgO4bZrkVwPd9-launcher_05.png) |
| 2.3. Installed tab | This component contains a list of applications a user installed. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/bUOs9bADAbqaVrSV-launcher_38.png) |
| 2.4. Search Launcher field | This component enables a user to apply search activities within the current applications pane. Keyword search mode available under the **Search** **Launcher** field > Enter a search request. The search result appears when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/gs4kfclccMaIAdGO-launcher_05-1.png) |
| 3. Applications pane | This component contains a list of applications (bundles) within the current pane. The list of displayed applications on the **Applications pane** varies according to the implemented **Categories filter** and the selected tab. The Applications pane contains items of 2 different types: - Application - Bundle |
| 4\. Current user information 4.1. Launcher settings | This component provides information about the logged-in user. Apptimized Platform automatically identifies a user who started the VM within the specific project and step, which considers the user’s preferences. The icon  provides a user with Workspace Launcher settings (see the [**Launcher settings**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/packaging#bkmrk-launcher-settings)). |
| **Setting** | **Details** |
| Bundle name | **The bundle name **field allows defining the bundle name (e.g., MSI). There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/w1SCT1A7Snc4H3oM-launcher_29.png) |
| Bundle description | **The bundle description **field allows defining the bundle description (e.g., Tools for packaging MSI format). There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/G5iZysVwuECNx2hk-launcher_30.png) |
| Select categories | **The select categories **field allows defining the categories for a new bundle. The following options available: - App-V - MSI - MSIX - Productivity - System - Utility There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/c2Dth1w2DRUh62W6-launcher_31.png) The option to choose a few categories is available. |
| Select applications | **The select applications **field allows defining the applications included in a new bundle. The following options available: - 7-Zip - Adobe Creative Cloud Cleaner Tool - Adobe Customization Wizard - App-V 5 Configuration Editor - App-V Manage - Apptimized MSI Editor - Apptimized Packaging Engine - Apptimized MSIX AppAttach Converter - AppV 5.1 Sequencer - Double Commander - InstEd - InstallWatch - LockHunter - MSIX Packaging Tool - Notepad++ - Orca - Process Explorer - Process Monitor - PsExec - Resources Extract - WhatChanged There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/oeW7dUfXYovpHtaD-launcher_32.png) The option to choose a few applications is available. |
| **Element** | **Description** |
| 1. Icon | This block contains a visual logo of an application. |
| 2. Icon to minimize / maximize application card | An icon that allows a user to expand or collapse the application card. [](https://docs.apptimized.com/uploads/images/gallery/2020-08/JwGBog1jA6PYVOgg-collapse.png) - An application card is in a minimized mode [](https://docs.apptimized.com/uploads/images/gallery/2020-08/6OJwRgeRrqvy1BTq-expand.png) - An application card is in a maximized mode |
| 3. Application metadata | This block contains the meta information of an application.
Application metadata is provided by the template (from top to bottom):
- Application name
- Application vendor
- Application version
**Note.** The icon [](https://docs.apptimized.com/uploads/images/gallery/2020-11/MnWSHs3UuEOSUbK2-vendor-link.png) appears when a link to the application vendor site available. |
| 4. Installation button | This button enables a user to install an application. |
| 5. Icon to favorite / unfavorite an application | An icon that allows a user to toggle the favorite status for an application. [](https://docs.apptimized.com/uploads/images/gallery/2020-08/1F9M51Pza9e35qJd-star_disabled.png) - An application is not marked as a favorite [](https://docs.apptimized.com/uploads/images/gallery/2020-08/nMQk7GhsiDylbG1C-star_enabled.png) - An application is marked as a favorite The Install automatically switch becomes available when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/PnfPyyIKZdqfMqGH-launcher_09.png) |
| 6. Application description | This block provides a brief description of the purpose of an application |
| 7. Shortcut buttons | This block provides the set of shortcuts to most usable actions with an application.
A process (action) gets started by the click on the shortcut button.
**Note.** If a user has not yet installed the application, the **Apptimized Workspace Launcher **will proceed following steps after clicking on the **Shortcut button**: 1. Application installation. 2. Application launch with the required functionality. |
| **Element** | **Description** |
| 1. Icon | This block contains a set of visual logos of applications the bundle consists of. |
| 2. Icon to minimize / maximize bundle card | An icon that allows a user to expand or collapse the bundle card. [](https://docs.apptimized.com/uploads/images/gallery/2020-08/JwGBog1jA6PYVOgg-collapse.png) - A bundle card is in a minimized mode [](https://docs.apptimized.com/uploads/images/gallery/2020-08/6OJwRgeRrqvy1BTq-expand.png) - A bundle card is in a maximized mode |
| 3. Bundle name | This block contains the name of the bundle and the number of applications the bundle consists of. Application metadata is provided by the template (from top to bottom): - Bundle name - Number of applications |
| 4. Installation button | This button enables a user to install a bundle. |
| 5. Icon to favorite / unfavorite a bundle | An icon that allows a user to toggle the favorite status for an application. [](https://docs.apptimized.com/uploads/images/gallery/2020-08/1F9M51Pza9e35qJd-star_disabled.png) - A bundle is not marked as a favorite [](https://docs.apptimized.com/uploads/images/gallery/2020-08/nMQk7GhsiDylbG1C-star_enabled.png) - A bundle is marked as a favorite The Install automatically switch becomes available when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/optDBzmwRDVc1F8V-launcher_13.png) |
| 6. Bundle description | This block provides a brief description of the purpose of a bundle |
**Note.** All applications are in the uninstalled state by default.
Every application goes through 3 states: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/2VVVwdJavbPnQC7O-launcher_17.png) ##### **Bundle installation** The option to install a bundle is available under the **Install** button: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/QeTYfEcffWJNSo3l-launcher_18.png) In this case, the **Apptimized Workspace Launcher** installs all applications that are part of the bundle collection. The progress bar shows the aggregated process of the collection installation.**Note.** All bundles are in the uninstalled state by default.
Every bundle goes through 3 states: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/zh8svexXXNcxh5fB-launcher_19.png) ##### **Install automatically** The **Install automatically** switch becomes available after an application or a bundle was marked as a favorite: [](https://docs.apptimized.com/uploads/images/gallery/2020-12/I1lnFObTXlhO92Ja-launcher_20.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-12/Ge3f0Oz8JxrcLus3-launcher_20_1.png) The option to install an application or a bundle automatically becomes active when switched on. The option is inactive by default. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/qQfSVPYzKcBjyRRM-launcher_21.png)**Note.** If a user has not yet installed the application, the **Apptimized Workspace Launcher** will install an application after enabling the **Install automatically** switch.
In the case of a bundle, all contained applications (regardless of the status of an application: favorite / unfavorite) will be installed automatically when the **Install automatically** switch is enabled. [](https://docs.apptimized.com/uploads/images/gallery/2020-12/zPZelU4GAnef0Yul-launcher_22.png) ##### **Run application** The following scenarios to run an application available: - Select an application > Click on the Shortcut button (e.g., **Run APE**) - Select a bundle > Select an application > Click on the Shortcut button (e.g., **Transform existing MSI**) [](https://docs.apptimized.com/uploads/images/gallery/2020-12/yCBZIP76JVkWIaS1-launcher_24.png)**Note.** If a user has not yet installed the application, the **Apptimized Workspace Launcher** will proceed following actions after clicking on the Shortcut button: 1. Application installation. 2. Application launch with the required functionality.
##### **Upload results from VM to Apptimized Portal** To upload created via Workspace Launcher deliverables to Apptimized Portal a user needs to place them into the Packages folder before VM is finished (VM desktop > **Apptimized files** icon > **Packages** folder).**Note.** By default, the **Packages** folder comes with the Log folder which contains system information. It is prohibited to a user to add any files to this folder. The **Log** folder will not be uploaded to the Apptimized Portal after VM is finished.
[](https://docs.apptimized.com/uploads/images/gallery/2020-08/sCyIHk1tIZvkekM0-launcher_26.png) During the synchronization process, every file is treated as a unique package. In case a user created a complex deliverable (i.e., a folder contains 2 or more files) this folder must be compressed into a ZIP archive. The naming of files, folders, and archives should be consistent with the name patterns indicated in the **[Project settings](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/project-settings)**. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-08/odCiXCYhnxIK3Dtc-launcher_27.png) ### **Apptimized Packaging Engine** The **Apptimized** **Packaging Engine** (APE) launches when clicking **Install** the **Apptimized Packaging Engine** > **Run APE**. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/bfsNpaVReUPcSh3v-install_run_.png) The process may take few moments. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/lqfm8O0GZFUr8boA-packaging_35.png) Apptimized shows the Apptimized Packaging Engine (APE) main screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-06/NWS35hHUMJOz8hIH-packaging_36.PNG) Table 1. Apptimized Packaging Engine options| **Option** | **Details** |
| Repackage to MSI, App-V, MSIX, IntuneWin or VSL | This option is snapshot-based and enables to create a completely new installer. This option is applicable when a user has a non-MSI vendor installer. A user converts it to MSI or App-V or virtualizes MSI installer into App-V. |
| Transform and edit vendor MSI | This option enables the transformation or customizing the existing Windows Installer. This option is applicable when a user has an MSI-based vendor installer and needs to produce an MST for it containing changes made during the installation process and/or configuration post-installation settings. |
| Review and edit result | This option enables to review the packages. The option becomes available only after a user completed the repackaging or transformation procedure. |
| Save locally | This option enables saving the output locally to verify before uploading back to Apptimized. |
| Upload result to Apptimized | This option enables uploading verified output back to Apptimized. A user can upload the output generated by Apptimized or select an archive with modified files to be used as an output. |
**Note.** Any VM activity or inactivity can leave traces in the captured result (including those not relevant to the package or application results). A user needs to confine to the activities needed for packaging and finish the process as quickly as possible).
APE shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/kYpbiFRyR54Hkcif-packaging_37_1.png) The option to suspend capturing changes made to the filesystem and registry is available under the **Pause** button. The option to resume the recording is available under the **Pause** button (click the **Pause** button again). [](https://docs.apptimized.com/uploads/images/gallery/2020-04/WCNBSMstT2fRhbvn-packaging_40.png) Once the recording has started a user enables a user to browse the path of the installation file (**Browse** button). The option to provide the additional parameters (i.e., to specify additional launch arguments) is available under the **Parameters (optional)** field. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/AkC1a5yj0ADYobfE-packaging_38.png) Once the file has been selected, the **Run** button becomes active. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/2dlYhzZcOgci8VCC-packaging_37_2.png) When the synchronization process is finished, APE shows the following screen:[](https://docs.apptimized.com/uploads/images/gallery/2020-04/S4B5OTn6BR7fFiZA-packaging_40_3.png) When the installation and configuration activities are completed, the record must be finished. The option to stop the record is available under the **Stop recording** button. This will terminate the recording process and prepare the captured system changes for producing an MSI, MSIX, App-V, or VSL. The terminating process may take few moments (additional post-processing and cleanup will be applied to the output).**Note.** Apptimized applies advanced logic and filters to keep the snapshot result clean from unneeded or dangerous files and registry keys. However, typically captured results require manual review and adjustments to achieve the desired result or to apply further cleanup from the captured system or user activity.
The processing file system changes may take few moments: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Xb6Ic1YRqGUYNRch-packaging_40_4.png) When successful APE shows the screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/05tEmZ4OWBM1nqJc-packaging_41.png) ##### **Editing Application Metadata** A user can review and adjust the application metadata if required. The default values generate from the portfolio metadata provided during the file import process and do not need to be changed in most of the cases. If the installation session consisted of more than one installer, select the primary installer to extract the metadata. ##### **Review captured content** The option to the recorded content for the files, registry entries, services, and other system items that were modified or created during the installation is available under the **Review recorded content** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/KJMWMDnrPUc6tkav-packaging_41_1.png) APE shows the snapshot editor screen when successful:[](https://docs.apptimized.com/uploads/images/gallery/2020-04/87rFTmI5qQoVyztu-packaging_42.png) A user can navigate across different tabs based on the captured content nature: - Filesystem; - Registry; - Shortcuts; - Drivers; - Services; - Certificates; - Environment; - Registry ACL; - Filesystem ACL; - Firewall Rules. **Filesystem** and **Registry** tabs are presented in a tree structure view. **Shortcuts**, **Environment**, **ACL**, **Services**, and other tabs are presented in a table-based view. The **Filesystem** tab shows captured changes to the filesystem (file & folders). The **Registry** tab shows captured changes to the Windows registry. The **Shortcuts** tab shows captured shortcuts. The **Drivers** tab shows captured drivers. The **Services** tab shows all services which were created during source installation. The **Certificates** tab shows all changes which were added to the Certificate Stores. The **Environment** tab shows captured environment variables created during the source installation. The **Registry ACL** tab shows captured permission changes in the Windows registry. The **Filesystem ACL** tab shows captured changes to filesystem ACLs. An Access Control List (ACL) is a list of Access Control Entries (ACE). Each ACE in an ACL identifies a trustee and specifies the access rights allowed, denied, or audited for that trustee. The **Firewall Rules** tab shows firewall rules created during the source installation. Due to the nature of the recording process, unwanted resources, also known as system activity or noise, might be captured into the recording result. These happen because the system is altered by the installation (or by the application, by the user, by the other applications, and by the operating system itself) during packaging in areas that are unrelated to the application and are not needed in the package. Those unwanted resources might negatively influence the installation or uninstallation of the package, or other applications and the operating system's stability, or, at least, create unneeded bloat. System activity traces and noise cleaning is required to receive good-quality packages. When recording completed, APE applies a default exclusion list, which filters most of the unwanted system changes from the package (which need to be removed from the package). A user can additionally exclude unwanted resources or re-include resources that were automatically excluded from the list. Such actions should only cover specific scenarios involving changes to the operating system. The option to exclude the files from the package is available under the **context menu** or using the keyboard shortcuts **Ctrl+E** or **Del**. The option to include the files to the package is available under the **context menu** or using the keyboard shortcut **Ctrl+I**. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/8286Q4l3VU4SXDOf-packaging_42_5.png) Captured resources that are intended to exclude from the package are shown with a red overlay. Captured resources that are intended to include the package are shown with no overlay. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/s3dUXyrxS4BaAxS6-packaging_42_1.png) The **status bar** with the total number of files and the number of included files is available in the footer of the **Review recorded content** window. The option to search files or folders by name is available under the **Search in files** field available in the footer of the **Review recorded content** window. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/jCiHH0k8qGMwPkT3-packaging_42_4.png) The screenshot below shows the tab interface with table-based view (i.e., **Shortcuts** tab): [](https://docs.apptimized.com/uploads/images/gallery/2020-04/9iLcBYLumqxgYEcB-packaging_42_3.png) To exclude the item, tick the checkbox in front of its name. Table 2. Shortcuts tab structure| **Column name** | **Details** |
| Exclude | This column provides the option to include or exclude entities. |
| Icon | This column provides the shortcut icon. |
| Location | This column provides details on the shortcut location (i.e., a physical location of the shortcut file). |
| Destination | This column provides details on the shortcut’s target (usually target is an executable file). |
| **Column name** | **Details** |
| Exclude | This column provides the option to include or exclude entities (i.e., detected file or folder ACL). |
| Review | This column provides the option to open the **Permission properties** for the selected file or folder. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/uVNSmmnyNv0bhBIb-packaging_42_6.png) This dialogue window enables a user to Set, View, Change, or Remove permissions for the current item. Permissions are set recursively, so to set permissions onto a folder, its subfolders and files only configure permission changes on the parent folder level. The option to set permissions for a group or user that does not appear in the **Group or user names** box is available under the **Add** button (Type the name of the group or user > **OK** button). The option to remove permissions for a group or user that appears in the **Group or user names** box is available under the **Remove** button (Type the name of the group or user > **OK** button). The options to allow or deny permission are available under **the Permissions for <User or Group>** box (Select the **Allow** or **Deny** column > Check / Uncheck the box). The option to set the special permissions or advanced settings is available under the **Advanced** button. |
| Path | This column provides details on file or folder with detected, modified or created permissions. |
| **Column name** | **Details** |
| Exclude | This column provides the option to include or exclude entities (i.e., detected driver file). |
| Name | This column indicates the name of the driver file. |
| Location | This column provides details on the driver location (i.e., a physical location of the driver file). |
| Add ARP entry | This column provides an option to add ARP (Add-Remove Program) entry which is based on ARPSYSTEMCOMPONENT property value. |
| Remove on uninstall | This column provides an option to automatically delete the driver during the uninstallation process. |
| **Severity** | **Problem code** | **Description** |
| High | DriversInSnapshot | The installation driver is not supported in repackaging mode. It won't be included in the final package. |
| Medium | ServicesInSnapshot | Installation services are detected. This can lead to problems with App-V or AppX packaging formats. |
| EnvironmentalVariablesChanged | The environmental variables change is detected. A user must sure this won't overwrite existing entries during installation. | |
| Low | MSIExecLaunched | MSI installation is detected. It's recommended to use transformation instead of repackaging until a user converts the installer to the not MSI format. |
| AutoStartDetected | Auto-start modification is detected during the installation. | |
| DllHostDetected | COM registration is detected. An application may not work when packaged in App-V or AppX formats. | |
| SystemFilesIncluded | System files were modified during the installation. A user must review captured content and exclude unneeded entries. |
| **Settings** | **Details** |
| Optional command line arguments | This setting provides the command to be executed (i.e., msiexec /i \[FilePath\] /v\*l \[LogPath\]). |
| Include additional files and subfolders from the installer folder | This setting specifies if all files and (sub)folders from the folder in which the MSI locates will use. If the setting is enabled, all folder content will use to build the final package. If the setting is disabled, only the MSI and CAB files will use (everything else will be ignored). The setting is **disabled** by default. |
| Do not execute installation actions | This setting enables a user to run through the MSI's setup screens and do not need to perform a true installation. In that case, only property changes captured by inputs into the MSI's dialog will be taken. The filesystem and registry will remain untouched. The setting is **disabled** by default. |
| Capture post-configuration | This setting enables a user to include additional configuration items outside the MSI setup screens into the MST after the installation (i.e. post-configuration), e.g.: adding extra files or adding extra registry keys. The following cases to capture changes in the MST available: - Changes are captured in a separate intermediary MSI; - The intermediary MSI is merged into the MST; - The intermediary MSI is discarded. |
| Wrap into .intunewin bundle for Intune deployment | This setting enables a user to create the .intunewin bundle for Intune deployment. The setting is **disabled** by default. |
| Package release | This is the package version. It is used in the package name. Initially, a release version is 01. If something needs to be changed in this package, then release 02 is made, and the package name differs from the initial one. The package release is not similar to the application version ( (i.e. the application version can be the same but the release will be 02 because some files were added). The field can stay blank. |
| Package release property prefix | This prefix is used in the names of the created MSI components, properties, and custom actions. This is the element of branding. A user can put the prefix (i.e., \[company name\]\_SiteURL). So, when the MSI reviews, a user can understand what properties were added additionally (i.e., not by default). |
| Install/Uninstall script file type | This setting indicates the script file type. The following script file types available; **Batch**, **PowerShell**, and **Vbs**. The default value is **Batch**. |
**Note.** Apptimized always replaces special properties. The following properties are marked as red under the transformation screen: [](https://docs.apptimized.com/uploads/images/gallery/2021-08/Fd3vDn3ekKyJq3DR-pack_transf_05_3.png)
When the MSI properties list is reviewed, click the **Finish** button. The transformation process may take few moments: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/EtwALEMCmo7cE3oK-pack_transf_06.png) APE shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/elZscgA5EzPHG2xF-pack_transf_07.png) The option to launch the built-in MSI editor and edit the output is available under the **OK** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/t8Xg2Smp0NnOY5Ya-pack_transf_08.png) This case provides changes in the application's settings store in registry keys, which are captured and subsequently merged into the MST file by the "post-configuration capturing" process. The instructions on editing the result in Advanced MSI Editor are provided below. #### **Wrap file(s)** ##### **Create Wrapper** The option to wrap files i.e., wrap fully configured package - repackaged MSI, MSI+MST, Silent EXE, or package with Apptimized Wrapper) is available under the **Wrap file(s) **> **Create Wrapper **tab **[](https://docs.apptimized.com/uploads/images/gallery/2023-03/8Uc2qLclN959cP0T-wrap_1.png)** The process includes the following steps: 1. Choose the wrapper [](https://docs.apptimized.com/uploads/images/gallery/2023-03/YmZAIBwfNYKVHEQy-wrap_2.png) Default wrapper is available by default. 2. Enter the package type The following package types are available: MSI Transform Legacy App-V Empty Wrapper [](https://docs.apptimized.com/uploads/images/gallery/2023-03/7l1XJXpq5e5UPo0P-wrap_3.png) 3. Clicking the **Next** button enables proceeding to the Configuration step. APE shows the following windows when successful: [](https://docs.apptimized.com/uploads/images/gallery/2023-03/QTtKxLaXboavZF4t-wrap_4.png) 4. Select source folder or archive files, select necessary file in package format [](https://docs.apptimized.com/uploads/images/gallery/2023-03/hxkQ9Be4VRVlAY9u-wrap_5.png)**Note.** All content from source folder/archive will be copied to the package
5. Clicking the **Next **button enables proceeding to the **Review **step. APE shows the following window when successful: [](https://docs.apptimized.com/uploads/images/gallery/2023-03/MQDoZC6XyyFv7WNg-wrap_6.png) The following options to change are available:| Option | Description |
| Vendor | Indicates application vendor short name |
| Software | Indicates application software short name |
| Version | Indicates application version |
| Language | Indicates language of the application. The following options available: - ENG - DEU - MUI |
| Architecture | Indicates architecture of the package. The following options available: - x86 - x64 |
| PackageRelease | Indicates number of package release |
| Platform | Indicates platform where package was tested |
| ScriptDate | Indicates script create/change date in format MM/DD/YY |
| MSIName\* | Indicates MSI location and name(e.g. $env:ProgramFiles/.../Setup.msi) \* - available only for MSI package type. |
| PackageNameAppv\*\* | Indicates Package Name of AppV package without extension \*\* - available only for AppV package type. |
| APPVPath\*\* | Indicates path to directory with .appv file \*\* - available only for AppV package type. |
| VendorEXESilentInstall\*\*\* | Indicates path to vendor exe for legacy installation e.g. $env:ProframFiles/.../Setup.exe) \*\*\* - available only for Legacy package type. |
| VendorEXESilentUninstall\*\*\* | Indicates path to vendor exe for legacy uninstallation e.g. $env:ProframFiles/.../unin000.exe) \*\*\* - available only for Legacy package type. |
| SilentInstallParameters\*\*\* | Indicates silent parameters for installation(e.g. /silent). \*\*\* - available only for Legacy package type. |
| SilentUninstallParameters\*\*\* | Indicates silent parameters for uninstallation(e.g. /silent). \*\*\* - available only for Legacy package type. |
| Uninstall hives\*\*\* | Indicates all uninstall hives that must be updated, separated by “;”.(e.g. HKLM:SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\18469ED8-8C36-4CF7-BD43-OFC9B1931AF8);HKLM:SOFTWAREWOW6432Node\\Microsoft\\' dows\\CurrentVersion\\UninstallV0240359E-6A4C-4884-994-B397A02D89301) \*\*\* - available only for Legacy package type. |
| MSTName\*\*\*\* | Indicates MST location and name(e.g. $env:ProgramFiles/.../Setup.mst) \*\*\*\* - available only for Transform package type. |
| **Component** | **Details** |
| File | This component provides the commands for working with the installer file. The following options available: - New; - Open; - Open recent; - Save; Save As; - Exit. |
| Edit | This component provides the commands to apply/cancel last committed action as well as the command to enable the search window. The following options available: - Undo; - Redo; - Find / Replace. |
| Tables | This component provides the commands for manipulating the MSI tables, to enable the Summary info and Code Page. The following options available: - Add tables; - Import tables; - Summary information; - Code page. |
| Tools | This component provides access to the import commands to perform install and uninstall processes. The following options available: - Import files; - Import registry; - Import ini file; - Install; - Admin install; - Uninstall; - View Log. |
| Transforms | This component provides access to commands for working with the transforms. The following options available: - New transform; - Apply transform; - Remove transform; - Save transformed. |
| Validations | This component allows ICE validation using existing or custom cub files. The following ICE validations options available: - Internal Consistency Evaluators – Full Set (darice.cub); - Internal Consistency Evaluators – Merge Modules (mergemod.cub); - Internal Consistency Evaluators For NT5 Logo (logo.cub); - Internal Consistency Evaluators For Windows Vista Logo (Vistalogo.cub); - Internal Consistency Evaluators For XP Logo (XPlogo.cub); - Use a custom cub file for validation. |
| Scripting | This component executes an existing or custom script. The following options available: - Remove shortcuts on the desktop (Remove-Desktop-Shortcuts.ps1); - Use custom script. |
| Help | This component enables the help mode. |
| **Tab name** | **Details** |
| Application | This tab provides basic information about MSI. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/7u83WljfSxIhgjsU-pack_transf_10_2.png) |
| Files | This tab enables to work with files associated with the MSI.
The files are presented in a hierarchical tree structure view.
Folders that contain files are displayed in yellow. The folder’s content is displayed in the table on the right side of the MSI Advanced Editor window.
The files in the table on the left can be edited. It is also possible to add and remove custom and standard directories.
[](https://docs.apptimized.com/uploads/images/gallery/2021-08/YBoaTT9L888bAmCC-pack_transf_11_2.png)
The option to delete files is available under the:
- **Cross** symbol;
- Context menu > **Remove** option.
[](https://docs.apptimized.com/uploads/images/gallery/2020-04/Z8fE1E0cdVlU01zd-pack_transf_14.png)
The option to rename files or folders is available under the:
- Double click on the item > Enter item’s new name > Enter;
- Context menu > **Rename** option > Enter.
The option to add folders is available under the:
- Context menu > **New Standard Folder** option > Select a folder type from the list;
- Context menu > **New Custom Folder** option > Enter.
The option to add files is available under the:
- **Plus** symbol > **Import Files** option > Import files wizard;
- Context menu > **Import Files** option > Import files wizard.
The files import process involves the following iterations:
[](https://docs.apptimized.com/uploads/images/gallery/2020-04/gCOrhHigvTwkLNTv-pack_transf_13.png)
1\. Select the target directory:
- Click the **Target Directory** field > Select the directory from drop-down list > **Continue** button;
- Click the **Plus** symbol > Insert a new row into the table “Directory” > Enter directory name > Select the directory parent mode from drop-down list > Enter DefaultDir name > **Save** button > **Continue** button.
[](https://docs.apptimized.com/uploads/images/gallery/2020-04/tAq69QNoqCuS0Hkj-pack_transf_15.png)
2\. Select files or folders to import: Click the **Plus** symbol > **Add files** / **Add folder** button > Browse to find the file > Double click to add the file > **Continue** button.
[](https://docs.apptimized.com/uploads/images/gallery/2020-04/NSVJtMlMTiVkBMkn-pack_transf_16.png)
3\. Select features to assign new components (Select the **Feature** > Select the **Cab** **type** > **OK** button).
4\. The added file appears in the tree.
The option to hide empty folders is available under the **Hide empty** checkbox on the bottom side of the MSI Advanced Editor window.
**Note**. When a user adds files & folders that already exist, Advanced MSI Editor shows the following modal window: [](https://docs.apptimized.com/uploads/images/gallery/2021-09/m4vBQ7m4g0p6uBTv-packaging_x_new.png) |
| Registry | This tab enables editing registry keys (i.e. add/remove registry keys, import from the file). [](https://docs.apptimized.com/uploads/images/gallery/2021-08/qIctRBreihZ8u1dU-pack_transf_17_2.png) The registry keys are presented in a hierarchical tree structure view. The registry keys details are presented in the table on the right side of the MSI Advanced Editor window. The option to add a key, registry value or import from a file is available under the **Context menu**. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/P6Tm6QvrV99veys0-pack_transf_18_2.png) The option to add a new value is available under the **Context menu** > **New value** option: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/C0CxnYBOkZqGzHx9-pack_transf_19.png) A new variable creates an empty name and value fields. Double click sets the values of the corresponding fields. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Ezg58VdOXdqvwSJH-pack_transf_20.png) The following registry key values available: - String; - Integer; - Binary; - Expandable string. The default value is **String**. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/x8huEH2lVWL2BNYb-pack_transf_21.png) The option to create the new key is available under the **Context menu** > **New key** option > Enter a new key name > **Save** button: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/3ZSY9UpsiyXxED8B-pack_transf_22.png) The generated key will appear in the tree: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/DzwK8Q6NFs2fJOTM-pack_transf_23.png) The renaming and importing activities are the same as in the previous tab. |
| Shortcuts | This tab enables a user to create, delete or edit shortcuts. The buttons indicated in block 1 on the screen below are used to add and remove shortcuts. The button indicated in block 2 is used to edit the parameters of the selected shortcut. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/DNgDZ7PATgm2excl-pack_transf_24_2.png) The option to delete the shortcut is available under the **Context menu** > **Remove shortcut** option: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/uXQDq1sR3KQvrzDx-pack_transf_26.png) When creating a shortcut, an entry with default values appears: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/CtEU2QvDIlrAmkwz-pack_transf_27.png) The shortcut changes save when clicking the **Save** button. |
| Features & components | This tab enables a user to add, remove and edit [features and components](https://docs.microsoft.com/en-us/windows/win32/msi/components-and-features?redirectedfrom=MSDN). [](https://docs.apptimized.com/uploads/images/gallery/2021-08/3BsVfn3Sr2Tn83cu-pack_transf_28_2.png) The option to add a new feature is available under the: - **Plus** symbol > **New child feature** option; - Context menu > **New child feature** option. The option to add a new component is available under the: - **Plus** symbol > **New child component** option; - Context menu > **New child component** option. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/sf7fLDRKFKJK9gi7-pack_transf_29.png) When a new feature or component is added it appears at the end of a tree view: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/MjM0PnNHQBeE0hRH-pack_transf_30.png) The option to delete an item is available under the: - Context menu > **Remove** option; - **Cross** symbol > **Delete just this** item / **Delete** all. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/comWaNofE4UQFok2-pack_transf_31.png) When creating a new feature, an entry with default values appears: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/ov5J3G6TQXJfvary-pack_transf_32.png) When creating a new component, an entry with default values appears: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/PRIIkKgX9JZlRufP-pack_transf_33.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/vA4xwapu20dHKPWI-pack_transf_34.png) The features and components changes save when clicking the **Save** button. |
| Custom actions | The tab enables to view and edit custom or standard Windows Installer actions. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/v0wYHASCQCPZnD0W-pack_transf_35_2.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/O45a1qqxbhe5Jtsn-pack_transf_36.png) The option to add a new custom action is available under the: - **Plus** symbol > **New custom action** option; - Context menu > **New custom action** option. When creating a new custom action, an entry with default values appears: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/eBQlISgrsEjgfXqJ-pack_transf_38.png) The following source types available: - EXE file stored in a Binary table stream - DLL file stored in a Binary table stream - JScript file stored in a Binary table stream - VBScript file stored in a Binary table stream - DLL file that is installed with a product - EXE file that is installed with a product - Displays a specified error message and returns failure, terminating the installation - JScript file that is installed with a product - VBScript file that is installed with a product - EXE file having a path referencing a directory - Directory set with formatted text - JScript text stored in this sequence table - VBScript text stored in this sequence table - EXE file having a path specified by a property value - Property set with formatted text - JScript text specified by a property value - VBScript text specified by a property value The option to choose a binary resource from the file system while creating new custom action is available under the Browse button. MSI advanced editor enables the Browse button when one of the “ … file stored in a Binary table stream” source types is selected. [](https://docs.apptimized.com/uploads/images/gallery/2020-07/0qjUwV60ULKCCsMA-new_custom_action_01.png) MSI advanced editor automatically creates a row in Binary table when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-07/bs6AbqyCcMvYlua6-new_custom_action_02.png) The option to add a new standard action is available under the: - **Plus** symbol > **New standard action** option > Select the action type from the drop-down list; - Context menu > **New standard action** option > Select the action type from the drop-down list. When creating a new custom action, an entry with default values appears: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/9YCJ3NWqibzbCz6e-pack_transf_39.png) New action is enabled by default. To disable the action, uncheck the checkbox in front of its name (or Context menu > **Disable** option). The option to delete action is available under the: - Select the action in the actions list > **Cross** symbol; - Context menu > **Remove** option. |
| Properties | This enables a user to work with the global variables that Windows Installer uses during an installation. The checkboxes on the left enable filtering by property type.
[](https://docs.apptimized.com/uploads/images/gallery/2021-08/h63Qfnrjs5CoXnN2-pack_transf_40_2.png)
**Note.** Advanced MSI Editor mark additional properties added under the Project settings (see [ARP & Properties](https://docs.apptimized.com/books/apptimized-platform/page/project-settings#bkmrk-arp-%26-properties)): [](https://docs.apptimized.com/uploads/images/gallery/2021-09/5cq1HvQISOOF6GGa-851f635d-03d6-439e-a6ca-34e0ee821ae4.png) |
| Environment | This tab enables a user to work with environment variables that Windows Installer uses during an installation. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/Hsn1eCtsl3hihRHm-pack_transf_43-(1).png) The option to add new envrionemt variable is available under the: - **Plus **symbol > **Add variable** option; - Context menu > **Add variable** option; [](https://docs.apptimized.com/uploads/images/gallery/2021-08/yEtqFBwstuH3dYXc-pack_transf_44.png) When creating a new custom action, an entry with default values appears: [](https://docs.apptimized.com/uploads/images/gallery/2021-08/FHxYtr6haYODi7GP-pack_transf_45.png) The option to create dummy component is available after choosing Component under Component drop-down list > **Create Dummy **button. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/zErIezFiFhHG2Tqy-pack_transf_46.png) The option to create variable is available after filling Environment, Name, Value, Component fields > setting Context, Mode, Install behaviour, Uninstall behaviour options > **Save** button. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/GosEQP4RiDIbXnDu-pack_transf_49.png) AME shows the following screen when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/XSiLzs7tYeiuNWEK-pack_transf_48-(1).png) |
| Tables | This tab enables to work with MSI tables. The list of available tables is on the left. Empty tables are hidden by default. The checkbox on the bottom of the list enables a user to see empty tables. The grid on the left displays the contents of the table. The content is editable if the table is not read-only. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/Pbx3zF4OIx3BdnUZ-pack_transf_41_2.png) |
**Note.** To apply custom templates, a user needs to configure them in **Project settings**.
Apptimized shows the following modal windows: [](https://docs.apptimized.com/uploads/images/gallery/2021-09/oGPVIcCsoVbn5asU-wrap_pack_tree_02.png) The table below shows the components of the default wrap file configuration at **Initialize** step:| **Setting** | **Details** |
| Wrapper | This field indicates the wrapper to be used for wrapping. The following options are available: - Default Wrapper - \[Custom template 1\] - \[Custom template 2\] - … - \[Custom template N\] The default value is **Default Wrapper**. |
| Package type | This field indicates the list of package types for which this template will be applicable. The following package types available: - MSI - Transform - Legacy - App-V The default value is **MSI**. |
| **Setting** | **Details** |
| Vendor | This field indicates the vendor of the application. The data synchronizes from the metadata collected at the **Import** step. |
| Software | This field indicates the name of the application. The data synchronizes from the metadata collected at the **Import** step. |
| Version | This field indicates the version of the application. The data synchronizes from the metadata collected at the **Import** step. |
| Language | This field indicates the language of the application. The following options available: - ENG - DEU - MUI The multiple-choice is available. |
| Architecture | This field indicates the package architecture. The following options available: - x64 - x86 The default value is **x64**. |
| Package Release | This field indicates the package’s version number. The following options available: - 01 - 02 - 03 |
| Platform | This field indicates the platform the test activities were provided. The following options available: - Win 10 - Win7 - Win2k8 - Win2k12 - Win2k16 - Win2k19 The multiple-choice is available. |
| Vendor M S I | This field indicates the Vendor name of the selected MSI (i.g., Setup.msi).
**Note.** This field appears only if the **Transform** package type was selected under **Initialize** step and the MSI file was selected under **Configure** step. |
| Script Date | This field indicated the date when the script was created or changed. The default value sets to the **package creation date** (i.e., **Month/Day/Year**). |
| Product Code | This field indicates the MSI product code using the template **{ProductCode}**. |
| MST Name | This field indicates the MST file name(i.g., Setup.mst).
**Note.** This field appears only if the **Transform** package type was selected under **Initialize** step and the MSI & MST files were selected under **Configure** step. |
| Package Name | This field indicates the name of the package installation file (i.e., **TimKosse\_FileZilla\_3.48.1**). The package name generates according to the **Project settings.** A user must follow the naming templates indicated in the [**Project settings**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/project-settings "Project settings") > **Workflow settings** > **Packaging – Self Service** > **General**. |
| **Control menu category** | **Details** |
| Add prerequisites/Edit prerequisites | This setting enables a user to add prerequisite applications.
**Portfolio** tab is available by default. **Update Monitoring** & **Catalogue** tabs become available if there are delivered packages on them.
[](https://docs.apptimized.com/uploads/images/gallery/2021-06/gKl7jlo4mZEY9n7Y-discovery_15_3.png)
**Portfolio** tab
The option to select application is available under **Select applications** field.
[.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/aVX1wrTkkFHsI6Uu-discovery_15_4-(1).png)
The option to select media type for applications is available after the application was selected.
The following media types available:
- Package
- Source
[](https://docs.apptimized.com/uploads/images/gallery/2021-06/9rTFu3uO8jQBfLgz-discovery_x_1.png)
**Note**. One media type is automatically selected if others are missing. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/RRzaEg7knQYdW6AG-image-73.png) The option to use Source media type is available under **Use Source** > **Select Media** > select source file. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/09nzmMPTTY0PjnNz-discovery_x_2-(1).png) The option to use Package media type is available under **Use Package** > **Select Media** > select package file. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/UTvHlXMeOp8T6RGS-discovery_x_3-(1).png) **Update Monitoring** Update Monitoring tab allows to add prerequisites as applications from **Update Monitoring **delivered packages. The option to Select application from Update Monitoring is available under **Select applications: **field > **Select Version for application**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/dDiIZZi1WXOAJvwx-discovery_X_4-(1).png) **Catalogue** **Catalogue **tab allows to add prerequisites as applications from **Catalogue **delivered packages. The option to select applications from the **Catalogue **is available under **Selec applications: **field > **Select Version for application**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/BqSiCGZbcUL99MGL-discovery_x_5-(1).png) The option to Save Changes is available under **Save **button. Apptimized shows the following notifications when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-06/cIBw78yPri9MfFL0-image-1624347161356.png) The option to **Edit prerequisites** becomes available after the prerequisites were added. |
| RDP | This setting enables a user to work on the VM directly via RDP rather than a browser window. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/rY19nOp7NFpmPAL2-packag_vm_03.png) The option to download a file is available under the Download RDP file. The RDP file is available in the Downloads folder in user’s PC. [](https://docs.apptimized.com/uploads/images/gallery/2021-08/h5iswzQaIXwlye80-packag_vm_04_2.png) When the remote connection is set, copy the RDP password paste to the modal window. The remote desktop connection window appears when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/piUPV2V5nmVulac0-packag_vm_05_2-(1).png) |
| VM Snapshots | The setting enables to create a snapshot of the VM to save its current state or to revert to a state saved earlier. This is applicable when the application has prerequisites that need to be present before a certain action (i.e., Discovery, Packaging, or Testing) can be started. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/YKtscCMsC95p3WFE-packag_vm_06.png) The snapshot option is available under the **VM snapshot** button > **Snapshot name** field > **Take** button. |
| Clipboard | This setting enables a user to put text from the user’s system to the VM clipboard. Transferring clipboard content between the host machine and the VM is performed via "Cut & Paste" in most user scenarios. If the user experiences any issues with "Cut & Paste", the Clipboard button can be used to put the text to the VM's clipboard. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/mdPNmqKjoONmnl9j-packag_vm_07.png) |
| Fullscreen | This setting enables to put a browser in a full-screen mode. |
| Restart | This setting enables a user to redo the testing session on a restarted VM. The following restart options available: - OS (Operating system restart. Equal to Power > Restart); - VM (Equal to the Reset button on the real PC); - Session (Restart current session. All unsaved progress will be lost). [](https://docs.apptimized.com/uploads/images/gallery/2020-04/BHfGL1CGqJkluqaD-packag_vm_08.png) When the restart option is chosen, the confirmation model window appears. |
| Finish | This setting finishes the VM when the testing session is completed. |
| **Column name** | **Details** |
| Type | This field indicates the type of provided fixup |
| Path | This field provides the file system path to the place fixup effects |
| Scope | This field indicates the target application (file.exe or regular expression pattern) |
| Details | This field shows the redirect options (files pattern, dll name, etc.) patterns of the fixup |
| **Packaging technology** | **Details** |
| Apptimized Best Practice | The MSI of Legacy package will be created by the decision of Apptimized team. |
| MSI | The source will be repackaged and the batch file will be used for installation and uninstallation of the package (if another was not agreed with the delivery manager) |
| MSIX | MSIX package will be created |
| App-V (latest version) | The latest App-V sequencer will be used for creating App-V package |
| App-V 4.6 | The 4.6 version of App-V sequencer will be used for creating App-V package |
| App-V 5.0 | The 5.0 version of App-V sequencer will be used for creating App-V package |
| App-V 5.1 | The 5.1 version of App-V sequencer will be used for creating App-V package |
| **Wrapper format** | **Details** |
| Install.cmd | This files are used for transferring application parameters. |
| Apptimized PowerShell Wrapper (based on PSADT) | Depending on the customer's requirement and the vendor's logic the package can be repackaged or silent installation can be used. The package will be wrapped in the PowerShell Application Deploy Toolkit. This wrapper will be used for configuration, installation, and uninstallation if the package |
| Intunewin | Intunewin package will be provided to the package. |
**Note.** If Apptimized Portal can’t connect to SDC, the following error notification appears: [](https://docs.apptimized.com/uploads/images/gallery/2021-07/0p6aQClukyGNPToC-packaging_09.png)
Apptimized shows the following screen when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/ppdmvHe9LcLe1lc4-packaging_10_2-(2).png) This is an initial screen, and all blocks except the **Status** block are empty.**Note.** If Apptimized Portal can’t connect to SDC, the following error notification appears: [](https://docs.apptimized.com/uploads/images/gallery/2021-07/sSBXMCdjnZZ9aYeD-packaging_11.png)
This screen provides information on the Apptimized **Packaging – Factory Service** request (i.e., request progress and status). Additional information that might be needed during the packaging process will be exchanged here. Next, each **Packaging – Factory Service** block is shown in more detail. ### **Status block** The Status block shows packaging progress. The following request statuses appear depending on the **Packaging – Factory Service** progress: Table 11. Discovery request statuses| **Request status** | **Description** |
| Incoming check | The request has not been processed by the Apptimized team yet. The request is in the queue. |
| In progress | The request was processed by the Apptimized team. The request is in progress. |
| Factory QA | Deliverables are testing by the Apptimized team. |
| Action required | The Apptimized team asked the user a question. The user answer is needed. |
| Delivered | Packaging results are available to the user. Packaging results are as a package (i.e. **MSI**). The package extension depends on packaging technology. |
| Error analysis | The user rejected the Packaging results. Apptimized team fixes bugs in the package. |
| Approved | The user has confirmed the Packaging results. |
| Canceled | The user canceled the Packaging request at the processing stage. |
**Note**. When public holidays are approaching that affect the factory packaging performance, Apptimized Portal shows the following notification above the Status block: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-07/KEfVydjpGz4jRKxs-packaging_9_4-(1).png)
The option to cancel the request is available under the **Cancel Request** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/nuQ9aKKGXVrYRw3C-packaging_10_1.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/5xJ5v5rL5ksfBt4C-packaging_10_2.png) Apptimized shows the following modal window to confirm the request cancellation: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/qbeSZrR2Hk00TaMD-packaging_14.png) Apptimized shows the following modal window when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-08/bJ8VjfwbVu4UoR99-packaging_15_2.png) A user can cancel the packaging request until the **Delivered** status is achieved, and the discovery deliverables are available. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/bAowFQMEzgtsJ7Tk-packaging-13-2-(2).png) If a user is not unsatisfied with the packaging results, they can be rejected in the **Factory request** section under the **Factory activity** block. When a user is satisfied with the packaging results, they must be approved in the **Status** block. The option to approve the request is available under the **Approve Request** button. The **Approve Request** button becomes active when the **Delivered** status is achieved, and the packaging deliverables are available. Apptimized shows the following modal window to confirm the request approval: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/uGW61ghNksoGxbWJ-packaging_16.png) Apptimized shows the following screen when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/lsW839tWTFOwT0Q7-packaging-17-1-(2).png)**Note.** When a user approves the request, the option can`t be canceled.
### **Deliverables block** This block provides the packaging results to a user. Discovery results are provided as a package. The package extension depends on the selected packaging technology. The option to download the testing results is available under the **Download** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/QMqFt0Jsua8PdqAn-packaging_18_3-(1).png) If a user is not satisfied with the testing results, they can be rejected to further processing by the Apptimized team. The option to reject the testing results is available in the **Factory request** section under the **Factory activity block**. (see [**Factory activity** ](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/packaging#bkmrk-comments-%26-attachmen)block) ### **Factory activity block** The option to contact the specialist from the team is available under the **Factory activity block** > **Factory request** > **Write a message...** field. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/stKjy719hprrU91I-packaging_19-(1).png) The option to add supplementary attachments (i.e., screenshots, additional file) is available under the **Select file** button (Choose a file > **Open** button > **Add** button). The file can be a maximum of 10 MB. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/MXytM2lXC6L4QIwf-packaging_20-(1).png) The option to send a message is available under the **Add** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/300pfCVBMrxKlmNg-packaging_21-(2).png) Apptimized shows the message history interface when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-06/V8HgWe4exCOrfWqH-packaging_18_4.png) The option to provide additional comments or attachments to the Apptimized team is available under the **Factory activity block** after the Factory request was solved. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/r0oH3o1cf5goDl6D-packaging_21_2.png) The option to ask additional questions to the Apptimized team is available under the **Report a problem** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/qJVqurZr0p1BzgOI-packaging_22-(1).png) Apptimized provides the following modal window when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/N2n2ngaEjbmuGYvS-packaging_23-(2).png) The option to write a text message is available under the **Write your problem** field [](https://docs.apptimized.com/uploads/images/gallery/2021-06/6xoAlvb3jarfH8su-packaging_24.png)**Note. **This field is mandatory.
The option to attach a file is available under the **Select file** field. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/BohpvVdHQAv8vQD9-packaging_25.png) The option to change the attached file is available under the **Change** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/O39QjMB2hotX9p2z-packaging_26_3-(1).png) The option to remove the attached file is available under the **Remove** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/ITBYIKfheqDvVfxR-packaging-27-(1).png) The option to send a message is available under **Send** field. **Cancel** – reverts to **general Factory process** workflow. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/9UTowLyYgK7MB2ZW-packaging_28.png) Apptimized shows the message history interface when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/jf8Q1355QQiuyiwV-packaging_29_2-(2).png)**Note.** The attached files appear above the message history interface.
[.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/PB8kz4rQYeAEUKLm-packaging_30-(2).png)
If Apptimized needs some additional information, a user will receive notifications and a warning icon in the dashboard: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/zwwXyZSrRSbGQGwz-packaging_30-(3).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/LwJiqpnBhFO8ihUn-packaging_31-(2).png) If there is feedback from the user regarding the Factory Request, the following notification and status in the dashboard appear: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/wsajrhpC8RCdeXuQ-packaging_36-(1).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/gqRxpwARUXcW7rqh-packaging_35-(1).png) Apptimized provides the following notification and statuses in the workflow and dashboard after the request is resolved: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/wsajrhpC8RCdeXuQ-packaging_36-(1).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/ftTCL5XyMG2rBbeO-packaging_33-(3).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/WtKJ6jlTutz1fsTE-packaging_37-(1).png) ### **Finish Packaging - Factory Service** The **Finish** button becomes active when a request is approved by a user. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/i42ZSqNvtVduJzhc-packaging_31-(3).png) The option to create a new request is available under the **Create new request** button. Apptimized shows the following modal window to confirm the request approval: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/vZK2y7DH5AES6k1l-packaging_24.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/WFee0Uc08vr1o8TT-packaging_25.png) The option to finish Packaging - Factory Service process is available under the **Finish** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/9vFKtVIcXaopnxc7-packaging_32-(2).png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/kyf8h4wQxBcE2NvT-packaging_27.png) # MSIX packaging **[MSIX](https://docs.microsoft.com/en-us/windows/msix/overview#:~:text=MSIX%20is%20a%20Windows%20app,WPF%2C%20and%20Windows%20Forms%20apps.)** is a Windows app package format that provides a modern packaging experience to all Windows apps. The MSIX package format preserves the functionality of existing app packages and/or install files in addition to enabling new, modern packaging and deployment features to Win32, WPF, and Windows Forms apps. Apptimized Portal allows a user to create MSIX packages with the help of [**Apptimized Packaging Engine**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/msix-packaging#bkmrk-apptimized-packaging), bulk convert packages to MSIX packaging format within the **[MSIX bulk conversion](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/msix-packaging#bkmrk-msix-bulk-conversion),** and automatically convert the existing MSIX packages to Virtual Hard Disk files based on MSIX App Attach technology within the **[MSIX App Attach Converter](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/msix-packaging#bkmrk-apptimized%C2%A0msix-appa)**. ### Apptimized Packaging Engine The Apptimized Packaging Engine (APE) launches when double-clicking the **Apptimized Packaging Engine** icon. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/dEdxI2W8cFeBarct-screen-1.png) The process may take few moments. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/BXCCkwF8CfsRPsvJ-screen-2.png) Apptimized shows the Apptimized Packaging Engine (APE) main screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/d6ssUeQtEB7WDJ0n-screen-3.png) Table 1. Apptimized Packaging Engine options| **Option** | **Details** |
| Repackage to MSI, App-V, MSIX, IntuneWin or VSL | This option is snapshot-based and enables to create a completely new installer. This option is applicable when a user has a non-MSI vendor installer. A user converts it to MSI or App-V or virtualizes MSI installer into App-V. |
| Transform and edit vendor MSI | This option enables the transformation or customizing the existing Windows Installer. This option is applicable when a user has an MSI-based vendor installer and needs to produce an MST for it containing changes made during the installation process and/or configuration post-installation settings. |
| Review and edit result | This option enables to review the packages. The option becomes available only after a user completed the repackaging or transformation procedure. |
| Save locally | This option enables saving the output locally to verify before uploading back to Apptimized. |
| Upload result to Apptimized | This option enables uploading verified output back to Apptimized. A user can upload the output generated by Apptimized or select an archive with modified files to be used as an output. |
**Note.** Any VM activity or inactivity can leave traces in the captured result (including those not relevant to the package or application results). A user needs to confine to the activities needed for packaging and finish the process as quickly as possible).
APE shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/rbkW6PXdUsoP8vo3-screen-8.png) The option to suspend capturing changes made to the filesystem and registry is available under the **Pause** button. The option to resume the recording is available under the **Pause** button (click the** Pause** button again). [](https://docs.apptimized.com/uploads/images/gallery/2021-02/pYFs2tmN8f0kYWBU-screen-9.png) Once the recording has started a user enables a user to browse the path of the installation file (**Browse** button). The option to provide the additional parameters (i.e., to specify additional launch arguments) is available under the **Parameters (optional)** field. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/b6jZEKoDfO5p7j71-screen-10.png) Once the file has been selected, the **Run** button becomes active. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/fxd5c0zWv7GfE2VM-screen-11.png) When the synchronization process is finished, APE shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/skF7lSCKK01ckRXR-screen-12.png) When the installation and configuration activities are completed, the record must be finished. The option to stop the record is available under the **Stop recording** button. This will terminate the recording process and prepare the captured system changes for producing an MSI, MSIX, App-V, or VSL. The terminating process may take few moments (additional post-processing and cleanup will be applied to the output).**Note**. Apptimized applies advanced logic and filters to keep the snapshot result clean from unneeded or dangerous files and registry keys. However, typically captured results require manual review and adjustments to achieve the desired result or to apply further cleanup from the captured system or user activity.
The processing file system changes may take few moments: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/SBDY3o3HipQYSQt1-screen-13.png) When successful APE shows the screen: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/ulMZKtkNxG3dzxcd-screen-14.png) ##### Editing Application Metadata A user can review and adjust the application metadata if required. The default values generate from the portfolio metadata provided during the file import process and do not need to be changed in most of the cases. If the installation session consisted of more than one installer, select the primary installer to extract the metadata. ##### Review captured content The option to the recorded content for the files, registry entries, services, and other system items that were modified or created during the installation is available under the **Review recorded content **button. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/GNDv9TYfcUkuoUA9-screen-15.png) APE shows the snapshot editor screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/0FQXOUvpMRC18sKK-screen-16.png) A user can navigate across different tabs based on the captured content nature: - Filesystem; - Registry; - Shortcuts; - Drivers; - Services; - Certificates; - Environment; - Registry ACL; - Filesystem ACL; - Firewall Rules. **Filesystem** and **Registry** tabs are presented in a tree structure view. **Shortcuts**, **Environment**, **ACL**, **Services**, and other tabs are presented in a table-based view. The **Filesystem** tab shows captured changes to the filesystem (file & folders). The **Registry** tab shows captured changes to the Windows registry. The **Shortcuts** tab shows captured shortcuts. The **Drivers** tab shows captured drivers. The **Services** tab shows all services which were created during source installation. The **Certificates **tab shows all changes which were added to the Certificate Stores. The **Environment **tab shows captured environment variables created during the source installation. The **Registry ACL **tab shows captured permission changes in the Windows registry. The **Filesystem ACL** tab shows captured changes to filesystem ACLs. An Access Control List (ACL) is a list of Access Control Entries (ACE). Each ACE in an ACL identifies a trustee and specifies the access rights allowed, denied, or audited for that trustee. The **Firewall Rules **tab shows firewall rules created during the source installation. Due to the nature of the recording process, unwanted resources, also known as system activity or noise, might be captured into the recording result. These happen because the system is altered by the installation (or by the application, by the user, by the other applications, and by the operating system itself) during packaging in areas that are unrelated to the application and are not needed in the package. Those unwanted resources might negatively influence the installation or uninstallation of the package, or other applications and the operating system's stability, or, at least, create unneeded bloat. System activity traces and noise cleaning is required to receive good-quality packages. When recording completed, APE applies a default exclusion list, which filters most of the unwanted system changes from the package (which need to be removed from the package). A user can additionally exclude unwanted resources or re-include resources that were automatically excluded from the list. Such actions should only cover specific scenarios involving changes to the operating system. The option to exclude the files from the package is available under the **context menu** or using the keyboard shortcuts **Ctrl+E** or **Del**. The option to include the files to the package is available under the **context menu** or using the keyboard shortcut **Ctrl+I**. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/FOSysPLXQz4MAiGf-screen-17.png) Captured resources that are intended to exclude from the package are shown with a red overlay. Captured resources that are intended to include the package are shown with no overlay. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/rp9QREJ3DDPbonIr-screen-18.png) The **status bar** with the total number of files and the number of included files is available in the footer of the **Review recorded content** window. The option to search files or folders by name is available under the **Search in files **field available in the footer of the **Review recorded content** window. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/tAnKQyFY0hlBHfso-screen-19.png) The screenshot below shows the tab interface with table-based view (i.e., **Shortcuts** tab): [](https://docs.apptimized.com/uploads/images/gallery/2021-02/fAufS95UtYi8KCsS-screen-20.png) To exclude the item, tick the checkbox in front of its name. Table 2. Shortcuts tab structure| **Column name** | **Details** |
| Exclude | This column provides the option to include or exclude entities. |
| Icon | This column provides the shortcut icon. |
| Location | This column provides details on the shortcut location (i.e., a physical location of the shortcut file). |
| Destination | This column provides details on the shortcut’s target (usually target is an executable file). |
| **Column name** | **Details** |
| Exclude | This column provides the option to include or exclude entities (i.e., detected file or folder ACL). |
| Review | This column provides the option to open the **Permission properties** for the selected file or folder. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/4YvFw65lL1OpiPBA-screen-21.png) This dialogue window enables a user to Set, View, Change, or Remove permissions for the current item. Permissions are set recursively, so to set permissions onto a folder, its subfolders and files only configure permission changes on the parent folder level. The option to set permissions for a group or user that does not appear in the **Group or user names** box is available under the **Add** button (Type the name of the group or user > **OK** button). The option to remove permissions for a group or user that appears in the **Group or user names** box is available under the **Remove** button (Type the name of the group or user > **OK** button). The options to allow or deny permission are available under **the Permissions for <User or Group>** box (Select the **Allow** or **Deny** column > Check / Uncheck the box). The option to set the special permissions or advanced settings is available under the **Advanced** button. |
| Path | This column provides details on file or folder with detected, modified or created permissions. |
| **Column name** | **Details** |
| Exclude | This column provides the option to include or exclude entities (i.e., detected driver file). |
| Name | This column indicates the name of the driver file name. |
| Location | This column provides details on the driver location (i.e., a physical location of the driver file). |
| Add ARP entry | This column provides an option to add ARP (Add-Remove Program) entry which is based on ARPSYSTEMCOMPONENT property value. |
| Remove on uninstall | This column provides an option to automatically delete the driver during the uninstallation process. |
| **Severity** | **Problem code** | **Description** |
| High | DriversInSnapshot | The installation driver is not supported in repackaging mode. It won't be included in the final package. |
| Medium | ServicesInSnapshot | Installation services are detected. This can lead to problems with App-V or AppX packaging formats. |
| EnvironmentalVariablesChanged | The environmental variables change is detected. A user must sure this won't overwrite existing entries during installation. | |
| Low | MSIExecLaunched | MSI installation is detected. It's recommended to use transformation instead of repackaging until a user converts the installer to the not MSI format. |
| AutoStartDetected | Auto-start modification is detected during the installation. | |
| DllHostDetected | COM registration is detected. An application may not work when packaged in App-V or AppX formats. | |
| SystemFilesIncluded | System files were modified during the installation. A user must review captured content and exclude unneeded entries. |
**Note**. If the application is not packaged, there will be no options available.
| **Field** | **Details** |
| Search | The **Search** field allows finding the application from the portfolio. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/ybEeC6lhgNgKGIR5-search_1-(1).png) There is no default value for this field. |
| Select | The **Select** field allows selecting the application from the portfolio. There is no default value for this field. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/KVqYHu4gNfYXO6r3-select_2-(1).png) There is an option to select all applications. |
| **Column name** | **Details** |
| App ID | This component indicates an ID of the application that will be available to a user for the conversion. |
| Vendor | The component provides a user with information about the vendor of the application. |
| Software | This component indicates the name of the application. |
| Version | This component provides a user with information about the version of the application. |
| Conversion Status | This component indicates the state of conversion of the application. The following statuses are provided: - Required preparation – indicates, that a file with installation script must be provided. - Ready to start – indicates, that a package is ready to be converted. - Processing – indicates, that the package is being converted at the time. - Success – indicates the successful result of converting. - Failed – indicates the unsuccessful result of converting. |
| Testing Status | This component provides the state of testing of the application. The following statuses are provided: - Wait for conversion – indicates that the package is ready to be converted. - Ready to start – indicates that the testing process is ready to be started. - Testing – indicates that the package is being tested at the time. - Success – indicates the successful result of testing - Failed – indicates the unsuccessful result of testing. |
| **Field** | **Details** | ** ** |
| Package conversion options | The field allows selecting an installation file of the application to convert it. For every application to convert, the installation file must be selected. The installation file can be in MSI, EXE, or BAT formats. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/2ADuPCAGmwI6C2kO-file_man_1-(1).png) | |
| Certificate publisher | The field allows setting a publisher for the future package. The information is automatically filled in with the information of the publisher of the package. There is no default value for this field. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/c5Y1jkJ5UAQqCud2-cert_publish_1-(1).png) | |
| Installation script file | The **Installation script file **field allows setting the installation file of the application to convert. It is set after selecting the file in the **Package convert options **field. The installation file can be in MSI, EXE, or BAT formats. There is no default value for this field. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/t0acgelEhtIUKNpO-sdsd.png) |
**Note**. The conversion won’t be done immediately. The processing time depends on the size of the package.
To stop the conversion process, click the **Stop** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/1JEd4795VCRKLic2-stop_butt_1-(1).png) Apptimized provides the following modal window: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/Z96Eocfz4MLB6SNn-stop_conf.png) To stop conversion, click **Confirm**. **Cancel – **refers to the general **Silent conversion** section. Apptimized shows the following screen when the conversion process finishes: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/5DBdePKCMzirJSeC-image-21.png) ##### Test package To test the package, click the **Test **button in the **Actions **tab: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/vrRBhtSYTTUN2kk5-msix_test_button-(1).png) Apptimized provides the following screen: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/GB1UW4MbSaKDUUkO-msix_test_vm-(1).png) Apptimized provides the VM to test the package. After testing, click the **Terminate** button to get the results of testing: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/MeNpv8g29wugMb7u-terminate_vm_1-(1).png) Apptimized provides the following screen when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/YZ0XIxyzG701Y4Q3-testing_result_1-(1).png) To continue, click the **Result** button. **Restart** option allows to restart VM and return to testing. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/5LrDrzI5BX4u6Gh2-testing_result_2-(1).png) Apptimized provides the following modal window when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/f6skoVOT0mxN1yG5-im8.png) To enter the **Testing result** section, click **Result. Cancel – refers to the VM testing section.** Apptimized provides the following screen when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/2thed2J84J55jGOd-image-27-(1).png) The **Result **field indicates the state of testing. There are 2 options available: **Success** – indicates, that testing was successful. **Failed** – indicates, that testing was unsuccessful. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/vFMUyEHjQ6Dtc6TH-result_drop_down-(1).png) To apply the settings, click the **Save** button. **Retest** **– refers** to the **VM testing** section. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/eHlOZdVfHruUf5ju-buttons_1-(1).png)Apptimized provides the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/nAt85iS2txglZKs1-gen_Sec.png) ##### Delete application The option to delete the application from the **Silent conversion **tab is available in the **Actions **tab by clicking [](https://docs.apptimized.com/uploads/images/gallery/2021-02/wzO04NAEeSsHDwqN-butbut.png) button > **Delete**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/a8PoXmk3fcRKGDBn-delete_app_1-(1).png) Apptimized shows the following modal window when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/P3EeTNmEnEHxZSo9-mod.png) To delete the application from the conversion tab, click **Delete**. **Cancel **- refers to the general **Silent conversion **tab. Apptimized shows the following notification when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/2BfkGKbnD2wXfobK-delete_result_1-(1).png) ##### Download the application To download the converted package, click [](https://docs.apptimized.com/uploads/images/gallery/2021-02/wzO04NAEeSsHDwqN-butbut.png) button > **Download.** [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-02/5tgRwbCXaP2AV3Vx-download_msix-(1).png) The download process will start immediately. #### Apptimized MSIX AppAttach Converter ##### General Overview MSIX App Attach is a way to deliver MSIX applications to both physical and virtual machines. A Microsoft technology allowing to make MSIX packages compliant for virtualized desktop environments such as Windows Virtual Desktop. The **Apptimized** **MSIX AppAttach Converter** is a tool that allows to automatically convert the existing MSIX packages to VHD (Virtual Hard Disk) files based on MSIX App Attach technology. The tool is available in the Workspace Launcher (see the [**Workspace Launcher**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/packaging#bkmrk-introduction%C2%A0)). [](https://docs.apptimized.com/uploads/images/gallery/2021-02/dU6EZkeuPbwfZjIL-screen.png) The option to install the application is available under the **Install** button (see the [**Application installation**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/packaging#bkmrk-application-installa)). ##### Convert existing MSIX package A user can convert the existing MSIX package into MSIX app attach package. This option is available under **C****onvert the existing MSIX package** button. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/usnyW42hEElXWFCV-screen-2.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/NXNfg2Ep68nZXHWc-screen-3.png) A user can select the existing MSIX package by clicking the **Folder** icon. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/LKOiSNc4wfY5cQJq-screen-4.png) [](https://docs.apptimized.com/uploads/images/gallery/2021-02/EnSkH8ZRpng46lpi-screen-5.png) A user can select an MSIX file that will be automatically converted to the app-attach package and click the **Open** button to start the converting process. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/v6PpjTa4rGs9HQ1S-screen-6.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/BiJE32iHzPqHPlNm-screen-7.png) The creation process may take few moments. **Cancel** - stop the VHD file creation. After completing the creation a user can save the app-attach package (VHD file by clicking the **Save** button. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/dJGbbez9qfg1NSKk-screen-8.png) The process may take few moments. [](https://docs.apptimized.com/uploads/images/gallery/2021-02/lTqN1TQOihw1wEeL-screen-9.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-02/8ZYYI4XIhFA5ddAm-screen-10.png) #### #### **Apptimized MSIX PSF Tool** ##### General overview Package Support Frameworks is an open-source kit that helps apply fixes to the existing desktop application without access to the source code. It can run in an MSIX container. **Apptimized MSIX PSF Tool** allows applying fixups semi-automatically to a Win32 application in existing MSIX files. The tool is available in the Workspace Launcher (see the [**Workspace Launcher**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/packaging#bkmrk-introduction%C2%A0)) [](https://docs.apptimized.com/uploads/images/gallery/2021-03/vLcPB9uNEdPSW1Or-PSF-tool-1.png) The option to install the application is available under the **Install** button (see the [**Application installation**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/packaging#bkmrk-application-installa)) ##### Run Apptimized MSIX PSF Tool A user can apply the fixes in existing MSIX files. The option is available under **Run Apptimized MSIX PSF tool** button. [](https://docs.apptimized.com/uploads/images/gallery/2021-03/tweV5R3bpA7kX6tL-image-14.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-03/32722ZUSNvXoXfRw-PSF-tool-2.png) ##### Select MSIX package A user can select the existing MSIX package by clicking the **Folder **icon. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-03/c3SIz495Rvo3ltyC-folder_1-(1).png) [](https://docs.apptimized.com/uploads/images/gallery/2021-03/Yz5rXTXOzSzvRC7m-image-2.png) A user can select an MSIX file to automatically check for errors and all the appropriate fixes for them and click the **Open **button to start the checking process. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-03/nrIQbfWE3aTyXtJj-check_2-(1).png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-03/C20LUdGItz0CwSzM-package-opening.png) The opening process may take a few moments. **Cancel – **stops the package opening. Apptimized shows the following screen after successfully opening: [](https://docs.apptimized.com/uploads/images/gallery/2021-03/eObmoABzo8WGvwXg-image-15.png) Fixup suggestions are automatically provided after the package opens. They can be manually added, by clicking the **Apply suggestions** button. [](https://docs.apptimized.com/uploads/images/gallery/2021-03/Crf0VdwA3nx8mA0w-apply-sugg.png) To create default fixups based on package content, click **Create**. **Cancel – **reverts to general **Apptimized MSIX PSF Tool **section. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-03/mYV4ZAd23EYsohF7-image-4.png) ##### Apply fixups Fixup suggestions will be provided in the general **Apply fixups **section. **Apply fixups** allow setting DLL and file system redirection rules or setting command-line arguments to the MSIX package. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-03/coXokHGDvhtoAelR-apply-fixups_1-(1).png) The fixups data is performed in 2 blocks: - Information block – this block contains detailed information about fixups. - Action block – this block provides options to configure the fixups. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-03/Am7cmoGPEP945j99-apply-fixups_2-(1).png) Fixup's data is grouped into the following categories: - Type - Path - Scope - Details [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-03/OKQnNg9Mbt0gSaE7-data_fixups_1-(1).png)| **Column name** | **Details** |
| Type | This field indicates the type of provided fixup |
| Path | This field provides the file system path to the place fixup effects |
| Scope | This field indicates the target application (file.exe or regular expression pattern) |
| Details | This field shows the redirect options (files pattern, dll name, etc.) patterns of the fixup |
**Note.** A source for Testing step downloads at the **Import** step (see [Classic impor](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/classic-import "Classic Import")t, [CSV import](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/csv-import "CSV Import"), [SCCM import](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/sccm-import "SCCM Import"), [Catalogue & UM Import](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/catalogue-um-import "Catalogue & UM Import")). Depending on the project workflow structure, a source can be an EXE file, a package). Next, the most common cases with the Testing are provided: 1. The project workflow consists of 3 steps (Discovery - Self Service, Packaging - Factory Service, Testing - Self Service). A user uses a Classic import option to import the source (**EXE** file). The user goes through the steps sequentially. When the package is ready the user starts the Testing step with the package (i.e., Selects the testing platform > Starts VM > Opens **Packages** folder >Launches **install.cmd** file **>** Performs the testing actions > Finish VM > Reviews the testing results). 2. The project workflow consists of 3 steps (Discovery - Self Service, Packaging - Factory Service, Testing - Self Service). A user uses a Classic import option to import the source (**EXE** file). The user skips the Discovery - Self Service and Packaging - Factory Service steps. The user starts the Testing step with the existing source (i.e., Selects the testing platform > Starts VM > Opens **Source** folder >Launches **EXE** file **>** Performs the testing actions > Finish VM > Reviews the testing results). 3. The project workflow consists of 1 step (Testing - Self Service). A user uses a Classic import option to import the source (**MSI** file). The user starts the Testing step with the existing source (i.e., Selects the testing platform > Starts VM > Opens **Source** folder >Launches package file **>** Performs the testing actions > Finish VM > Reviews the testing results).
#### **Testing – Self Service** A user can record a guide to install and configure the application on Apptimized VMs. Also, a customer can enable a testing option and set the status of testing. Testing - Self Service characteristics: - A user tests created packages on his own. - A user runs and documents test cases. - A user logs installation or functional errors. - A user provides debugging guidance. The Testing - Self Service option is available under the **Testing - Self Service** module in the **Transition** screen. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/4lc8TrNjqRniRpqc-testing_03.PNG) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2026-03/lnLvm.png) A field "**Select testing – self service platform**" is filled automatically and can be changed if needed. To change the testing – self service platform, click the drop-down menu as it is shown in the screenshot below: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Bkp1vD7RBrJRNIDh-testing_05.png) The option to revert to the transition screen is available under the **Go to Transition screen** button. ##### **Testing – Self Service process** The option to start the testing – self service process is available under the **Start VM** button. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-10/os806Wjo3UaTMqYL-testing_06_2.png) The file synchronization process may take few moments. Apptimized shows the following notification: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/5mg2x63FX7ZMYA3g-testing_06_3.png)**Note.** There is often a situation when a user has already run 2 VMs in parallel. To continue planned activities within the current workflow step, a user must terminate an irrelevant VM. In this case, Apptimized shows the warning box with a list of VMs which are currently running by the user: [](https://docs.apptimized.com/uploads/images/gallery/2020-07/uh1YFhfTV4ZZGU24-listvm_01.png) The information is grouped into the following categories in the modal window: 1. Application 2. VM started time 3. Workflow progress 4. Link The option to select a VM for termination is available under the **Go to VM** link. A new tab opens when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/OYyQkjVRJGJ36FBU-03_testing_02-(1).png) When a VM is terminated, a user returns to the screen where he needs to restart a VM (previously a user started a VM but received a modal window with a list of running VMs).
When the synchronization process is finished, Apptimized shows the following screen: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/JctdlQuWfxZGMGux-testing_07_02-(2).png)Note. If the internal error while starting VM occurred, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-07/dXL1QeFeTaXiNvPc-testing_error-massage_02.png) The following actions are recommended for consideration by a user: 1. Contact the Apptimized support 2. **Go to image page** button > **Select discovery – self-service platform** field > **Start VM** button [](https://docs.apptimized.com/uploads/images/gallery/2020-07/u7YzzDU8TFo8O9TU-testing_error-massage_01.png)
The option to copy files to **Temp storage** is available under **Explorer context menu** > **Copy To Temp**: [](https://docs.apptimized.com/uploads/images/gallery/2021-09/4rQFL20TVySxJ7hi-discovery_x_temp.png) The uploaded files locate in the **Apptimized files** folder on the VM desktop. To start the installation process, a user opens the **.EXE** file located in the Source folder. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/tjjHQA8l5PBaKMFA-testing_08_02-(1).png) Every action is captured as a screenshot which is shown in green boxes appearing on the right-hand side: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/C87kOcnP6CADHUbG-testing_08_2-(1).png) When application installation is completed, a user can provide further configurations (only the **Edit** and **Settings** categories). The options to finish the VM session is available under the **Finish** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/rs8jchnEax728gm9-testing_10.png) The following interface will appear when recording session with Apptimized VM finishes: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-08/xCTeWE1bfeLdSCJy-testing_13_2-(1).png) The option to restart the VM testing session is available under the **Restart** button. To confirm the restarting the VM Apptimized shows the following modal window: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/HZdbfJe2ewpeOsSf-testing_12.png) ##### **VM control menu** The VM control menu panel is available in the upper right corner of the VM interface. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/9kLhZQfEshhc61xD-testing_01_2-(1).png) Next, each settings category is shown in more detail. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/0500ZvsAFpk8lCzK-testing_02_2-(1).png) Table 1. VM control menu| **Control menu category** | **Details** | |
| 1 | Screenshots | This setting indicates the screenshot mode. **On** and **Off** options available. The default value is **On**. |
| 2 | Add prerequisites | This setting enables a user to add prerequisite applications.
**Portfolio** tab is available by default. **Update Monitoring** & **Catalogue** tabs become available if there are delivered packages on them.
[](https://docs.apptimized.com/uploads/images/gallery/2021-06/gKl7jlo4mZEY9n7Y-discovery_15_3.png)
**Portfolio** tab
The option to select application is available under **Select applications** field.
[.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/aVX1wrTkkFHsI6Uu-discovery_15_4-(1).png)
The option to select media type for applications is available after the application was selected.
The following media types available:
- Package
- Source
[](https://docs.apptimized.com/uploads/images/gallery/2021-06/9rTFu3uO8jQBfLgz-discovery_x_1.png)
**Note**. One media type is automatically selected if others are missing. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/RRzaEg7knQYdW6AG-image-73.png) The option to use Source media type is available under **Use Source** > **Select Media** > select source file. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/09nzmMPTTY0PjnNz-discovery_x_2-(1).png) The option to use Package media type is available under **Use Package** > **Select Media** > select package file. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/UTvHlXMeOp8T6RGS-discovery_x_3-(1).png) **Update Monitoring** Update Monitoring tab allows to add prerequisites as applications from **Update Monitoring **delivered packages. The option to Select application from Update Monitoring is available under **Select applications: **field > **Select Version for application**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/dDiIZZi1WXOAJvwx-discovery_X_4-(1).png) **Catalogue** **Catalogue **tab allows to add prerequisites as applications from **Catalogue **delivered packages. The option to select applications from the **Catalogue **is available under **Selec applications: **field > **Select Version for application**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/BqSiCGZbcUL99MGL-discovery_x_5-(1).png) The option to Save Changes is available under **Save **button. Apptimized shows the following notifications when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-06/cIBw78yPri9MfFL0-image-1624347161356.png) The option to **Edit prerequisites** becomes available after the prerequisites were added.**Note**. Uploaded prerequisites are shown in the testing documentation under the Previous application section. [](https://docs.apptimized.com/uploads/images/gallery/2021-09/x5QHLowiN9ncxI6S-testing_x_3.png) |
| 3 | RDP | This setting enables a user to work on the VM directly via RDP rather than a browser window. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/HoX3kAP5nmG43g2y-discovery_16_2-(2).png) The option to download a file is available under the Download RDP file. The RDP file is available in the Downloads folder in user’s PC. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/4LNxnwGiKsP3xR8V-discovery_16_10.png) When the remote connection is set, copy the RDP password paste to the modal window. The remote desktop connection window appears when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-06/9a5OQxKprJBf8nkp-image-1624351495562.png) |
| 4 | VM Snapshots | The setting enables to create a snapshot of the VM to save its current state or to revert to a state saved earlier. This is applicable when the application has prerequisites that need to be present before a certain action (i.e., Discovery, Packaging, or Testing) can be started. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/rdCtBy8uzwa7Ghb6-image-1624351510953.png) The snapshot option is available under the **VM snapshot** button > **Snapshot name** field > **Take** button. |
| 5 | Clipboard | This setting enables a user to put text from the user’s system to the VM clipboard. Transferring clipboard content between the host machine and the VM is performed via "Cut & Paste" in most user scenarios. If the user experiences any issues with "Cut & Paste", the Clipboard button can be used to put the text to the VM's clipboard. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/16yANwuiav4hqtWc-image-1624351522416.png) |
| 6 | Ctrl+Alt+Del | This setting enables to open security options menu at the VM. |
| 7 | Fullscreen | This setting enables to put a browser in a full-screen mode. |
| 8 | Restart | This setting enables a user to redo the testing session on a restarted VM. The following restart options available: - OS (Operating system restart. Equal to Power > Restart); - VM (Equal to the Reset button on the real PC); - Session (Restart current session. All unsaved progress will be lost). [](https://docs.apptimized.com/uploads/images/gallery/2020-04/qoxJ3iMvBZKP4Ihr-discovery_19.png) When the restart option is chosen, the confirmation model window appears. |
| 9 | Finish | This setting finishes the VM when the testing session is completed. |
| **Request status** | **Description** |
| Incoming check | The request has not been processed by the Apptimized team yet. The request is in the queue. |
| In progress | The request was processed by the Apptimized team. The request is in progress. |
| Action required | The Apptimized team asked the user a question. The user answer is needed. |
| Delivered | Testing results are available to the user. Testing results can be provided in **PDF** and **HTML** formats. |
| Error analysis | The user rejected the Testing results. Apptimized team fixes bugs in the Testing document. |
| Approved | The user has confirmed the Testing results. |
| Canceled | The user canceled the Testing request at the processing stage. |
**Note.** When a user approves the request, the option can`t be canceled.
##### **Deliverables block** This block provides the testing results to a user. Discovery results can be provided in **PDF** and **HTML** formats. The option to download the testing results is available under the **Download** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/G4lZNY42fznaUeCG-testing_45-(4).png) If a user is not satisfied with the testing results, they can be rejected to further processing by the Apptimized team. The option to reject the testing results is available under the **Factory request** section under the **Factory activity** block (see [**Factory activity**](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/testing#bkmrk-comments-%26-attachmen) block). ##### **Factory activity block** The option to contact specialists from the Apptimized team and provide comments or attachments is available under the **Factory activity** block. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/YlwstSfuT9FI0rjL-testing_19-(1).png) The option to write a message in the **Factory request** is available under the **Write a message**... field. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/h315FWHzD66iibAX-testing_19-(2).png) The option to add optional attachments to the comment, such as screenshots or additional files (max 10 MB per file), is available under the **Select ****file**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/V0XMRQ9aUtChb1DP-testing_20-(1).png) The option to send a message is available under the **Add** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/67ICxWEm1JC9Ci81-testing_21-(2).png) The option to provide additional comments or attachments to the Apptimized team is available under the **Factory activity** block after the Factory request was solved. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/z2morkP3D7ugBMel-testing_21-(3).png) The option to ask additional questions to the Apptimized team is available under the **Report a problem** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/z20K3BlSMV2HfFMc-testing_22-(1).png) Apptimized provides the following modal window when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/N2n2ngaEjbmuGYvS-packaging_23-(2).png) The option to write a text message is available under the **Write your problem **field [](https://docs.apptimized.com/uploads/images/gallery/2021-06/6xoAlvb3jarfH8su-packaging_24.png)**Note! **This field is mandatory.
The option to attach a file is available under the **Select file **field [](https://docs.apptimized.com/uploads/images/gallery/2021-06/BohpvVdHQAv8vQD9-packaging_25.png) The option to change the attached file is available under the **Change **button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/O39QjMB2hotX9p2z-packaging_26_3-(1).png) The option to remove the attached file is available under the **Remove **button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/ITBYIKfheqDvVfxR-packaging-27-(1).png) The option to send a message is available under **Send **field. **Cancel – **reverts to **general Factory process **workflow. [](https://docs.apptimized.com/uploads/images/gallery/2021-06/9UTowLyYgK7MB2ZW-packaging_28.png) Apptimized shows the message history interface when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/i3XL2e5klwz3fbxU-testing_29_2-(2).png)**Note****.** The attached files appear above the message history interface.
[.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/6zqNc6MUuSSIu5Tl-packaging_30-(4).png) If Apptimized needs some additional information, a user will receive notifications and a warning icon in the dashboard: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/YrFbKwxmH57iw66m-discovery_40-(2).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/wOXOlkXFF2qxytGi-testing_34-(2).png) If there is feedback from the user regarding the Factory Request, the following notification and status in the dashboard appear: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/wsajrhpC8RCdeXuQ-packaging_36-(1).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/2eFgsNYaLCe8zkhO-testing_36-(1).png) Apptimized provides the following notification and statuses in workflow and dashboard after the request was solved: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/wsajrhpC8RCdeXuQ-packaging_36-(1).png) [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/fqPJ8G8nLfm6v2YR-testing_38-(1).png) ##### **Finish Testing - Factory Service** The **Finish** button becomes active when a request is approved by a user. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/eakVwBw4pBy4yzXn-testing_46-(2).png) The option to create a new request is available under the **Create new request** button. Apptimized shows the following modal window to confirm the request approval: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/SoQHB7XQjJ7OBbKT-testing_51.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/v8gLydmi9ibMYR95-testing_52.png) The option to finish Testing- Factory Service process is available under the **Finish** button. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-06/Oc47VHfCwWZXtLk8-testing_47-(2).png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/kFvfN0pRCsI89O7D-testing_54.png) # Download The download process starts by clicking the **Download** module on the **Transition screen**: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Iw0ItQ5pKKnqOb6u-download_01.png) The set of documents to download depends on: - the workflow structure (i.e., the number of steps, the set of module types) that was configured during project creation; - the number of steps a user completed (a user can skip steps (for example, after importing the application user proceeds to the testing step). Thus, regardless of the workflow structure, the step may remain without results (generated documents), if the user skipped it. The screenshot below shows the examples of possible download page configurations: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/KXcM5YfImI9MtBJ3-download_02.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/5xjQiXQRf2qTTTDK-download_03.png) The option to download results is available under the **Download installation source,** or **Download package,** or **Download generated \[discovery/testing\] HTML document,** or **Download generated \[discovery/testing\] PDF document** buttons. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/BKFtejEmC1RatNCR-download_04.png) Table 1. Possible download document options| **Step** | **Type of a document** | **Extensions** | **Example** |
| Import | Installation source Discovery document | EXE HTML, PDF | FileZilla\_3.34.0\_win64-setup\_bundled.exe |
| Discovery – Self Service | Discovery document | HTML, PDF | TimKosse\_FileZilla\_3.34.0.pdf TimKosse\_FileZilla\_3.34.0.html |
| Discovery – Factory Service | |||
| Packaging – Self Service | Package | MSI, MSIX, App-V, VSL, ZIP | FileZilla\_3.34.0.msi |
| Packaging – Factory Service | |||
| Testing – Self Service | Testing document | HTML, PDF | TimKosse\_FileZilla\_3.34.0.pdf TimKosse\_FileZilla\_3.34.0.html |
| Testing – Factory Service |
**Note.** Rating the Apptimized experience is optional.
Apptimized shows the following notification when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/t3ZQsxR1KefxxQuG-download_06.png) # Catalogue **Apptimized Catalogue** is one of the Apptimized features that provides access to a store, where a user can purchase the version of the application which is packaged according to a standard procedure and is ready for use. The latest application versions available for orders within 24 hours release of the update by the vendor, and ready for download within 48 hours after the request.**Note.** The "catalogue" option appears in the project menu after it is initiated in the [project settings](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/project-settings "Project settings") by the project administrator.
The **Catalogue** is available under the **Project** menu > **Catalogue**: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/tIupzeiM5DmsUAOU-catalogue_02.PNG) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2021-12/gkSyEng0Fa2Zu9SN-catalogue_01_02.png) Apptimized sends the follow-up email when the user has been accessed the Apptimized Catalogue: [](https://docs.apptimized.com/uploads/images/gallery/2021-09/sbJmA367Enhrm5Ru-caralogue_18.png) #### New request ##### New package request The option to make a request for a new package in the Apptimized Catalogue is available under the **Request new Catalogue package** block > Select the value from the drop-down list in the **Application** field > Select the value from the drop-down list in the **Version** field > Select the value from the drop-down list in the **Platform** field > Select the value from the drop-down list in the **Format** field > **Request** button. All required fields are marked with an asterisk \*.**Note.** The multiple-choice option is available in the **Platform** and **Format** fields. For each selected item, a separate catalogue request will be created.
[](https://docs.apptimized.com/uploads/images/gallery/2021-12/fO3uZn2Ptjv4DKt6-Group-4.png) Apptimized shows one of the following modal windows: a) the request doesn’t include a match to the previously made request; b) the request includes a match to the previously made request. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/aPMZ0FsyOuHPQukc-catalogue_04.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/k91nfWfaJlRa7DYi-catalogue_05.png) ##### New package request from the Updates The option to import source file from the Updates interface is available under Actions > **Process latest version** > Select source file > **Request catalogue package**[](https://docs.apptimized.com/uploads/images/gallery/2023-07/Of09z1MItRC6RUyf-catalogue_20.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2023-07/8B1WTDbeDYSqCkiD-image-1688395630898.png) ##### New application request The option to create a request to add an application to the Catalogue list is available under the **Request for add application** link. The Apptimized Team will check the possibility to add the application to the Catalogue list. [](https://docs.apptimized.com/uploads/images/gallery/2021-12/G8aoxumZFVQPipCO-Group-2.png) Apptimized shows the modal window when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-08/zfuTWzzHfLK4RVT2-catalogue_07.png) Enter the value in the **Vendor name** field > Enter the value in the **Software name** field > Select the value from the drop-down list in the **Platform** field > Select the value from the drop-down list in the **Package type** field > **Request** button. All required fields are marked with an asterisk \*.**Note.** The multiple-choice option is available in the **Platform** and **Package type** fields. For each selected item, a separate request will be created.
Apptimized notifies the user when the request is submitted. The following screen provides an example of the notifications: [](https://docs.apptimized.com/uploads/images/gallery/2020-08/CS4kM2ZggahGa8ag-catalogue_08.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-08/nbm4yo5FgQey3AQ3-catalogue_email.png) Apptimized sends the following email when the application can be added to the Catalogue list. [](https://docs.apptimized.com/uploads/images/gallery/2020-08/HkAhabBRL7kLv13H-catalogue_approved.png) Apptimized sends the following email when the application can't be added to the Catalogue list. [](https://docs.apptimized.com/uploads/images/gallery/2020-08/drfaWyid0b9C4gEp-catalogue_rejected.png) #### #### Catalogue request monitoring New Catalogue requests appear in the **Active requests** tab of the **Catalogue deliverables** block. After the Apptimized processed the request and the package is available, the request appears in the **Completed requests** tab. Apptimized notifies the user when the requested package is ready. The following screen provides the example of the notification: [](https://docs.apptimized.com/uploads/images/gallery/2020-08/nbm4yo5FgQey3AQ3-catalogue_email.png) Catalogue active request data is grouped into 7 categories: - Application; - Version; - Platform; - Format; - Order date; - Remained time; - Status. The columns in the catalogue request table can be swapped and grouped in any order. A user can drag and drop a column header to a suitable place. To exclude columns in the catalogue request table, uncheck the box next to the column name not required in view. This option is available under **Edit Column Settings** > **Columns**. To sort data in columns select ascending or descending mode. This option is available under **Edit Column Settings** > **Sort Ascending** or **Edit Column Settings** > **Sort Descending**. To filter data in columns use **Edit Column Settings** > **Filter** > Select a value > **Filter** button. To exclude the item the catalogue request table, uncheck boxes next to the name not required in view. Keyword search mode available. Catalogue completed request data is grouped into 7 categories: - Application; - Version; - Platform; - Format; - Order date; - Delivered date; - Actions. Request history can be downloaded as an Excel file by clicking the **Export to Excel** button. Apptimized shows the following screen after the request was completed: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-07/sSAa3UqeAFhMcsAR-image-15-(1).png) The option to download a package after the catalogue request is completed is available under the **Actions** column > **Download**. The option to import application as a source is available under the **Actions > Import as source** [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-07/PYTPJjQmF3H7QrpF-catalogue_12-(1).png) Apptimized shows the following modal window when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-07/vbJ57pz7JOp1opI7-catalogue_13-(1).png) Enter the value in the **Vendor name** field > Enter the value in the **Software name** field > Enter the value in the **Version **field > Enter the value in the **Language **field > **Import **button. All required fields are marked with an asterisk \*. Apptimized shows the following notification and screen when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-07/JpWaSljXNmm4rdZM-catalogue_14-(1).png) The option to import application as a package is available under the **Actions > Import as package**. [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-07/DmwmMawGaFJ3WQBU-catalogue_15-(2).png)**Note**. This option becomes available if **Packaging – Self Service **module is presented on the project.
Apptimized shows the following modal window when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-07/RZLKcGCQKTjNi8MV-catalogue_16-(1).png) Enter the value in the **Vendor name** field > Enter the value in the **Software name** field > Enter the value in the **Version **field > Enter the value in the **Language **field > **Import **button. All required fields are marked with an asterisk \*. Apptimized shows the following notification and screen when successful: [.png)](https://docs.apptimized.com/uploads/images/gallery/2021-07/31dMhJlaW2YQGhxm-catalogue_17-(2).png) # Update Monitoring **Update Monitoring** is one of the Apptimized products that provides a user with a flexible and automated notification system. Also, the Apptimized Update Monitoring subscription enables a user to download a vendor media in a few clicks directly from the portfolio. Apptimized **Update Monitoring** informs users when the software vendor has released an application update or found vulnerabilities. Apptimized monitors over 380 of the most widely used applications.Note.** The Update monitoring appears in the project menu after it is initiated in the project settings by the project administrator.
The following screenshot shows the notification email when the vendor releases a new version of the monitored application: [](https://docs.apptimized.com/uploads/images/gallery/2020-07/vLjU8ZD2cz4Jrr5Y-updates_27.png) #### Update monitoring interface The **Update Monitoring** is available under the **Project** menu > **Updates**: [](https://docs.apptimized.com/uploads/images/gallery/2023-06/6rUGi94DMdg1klL5-updates_01_2.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2023-06/VyZmY7ORNcryULAJ-updates_02_2.png) The screen above shows the default Apptimized Portal interface when no applications are added. When a user adds the application to the monitoring list, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2023-06/LG1QPflmM7OAWRQp-updates_05_2.png) Updates group data into six categories: Table 1. Update Monitoring data categories| **Category** | **Details** |
| Vendor | This category provides the details about the application’s vendor (e.g., **Tim Kosse**) |
| Software | This category provides the details about the application’s name (e.g., **FileZilla**) |
| Latest version | This category provides information about the newest version of the application released by the vendor and available in the Apptimized Platform. |
| Your version | This category provides information about the latest version of the application that is pinned within the recent user’s activities on the Updates page.
The following colours are implemented to indicate the current state of the monitored application:
[](https://docs.apptimized.com/uploads/images/gallery/2020-07/q78N5eCZAV5tgJ95-Green.png) - The latest version is available in the user’s packaged application portfolio
[ - ](https://docs.apptimized.com/uploads/images/gallery/2020-08/zBebxkPOBqODS8p6-Orange.png)The newer version (in comparison to the one a user has in the portfolio) has been released by the vendor
[ - ](https://docs.apptimized.com/uploads/images/gallery/2020-07/nLgxiP04WWO3iDo5-Red.png)The version a user has in the packaged application portfolio is outdated. This means that there are two or more recent releases of the application provided by the vendor
**Note**. The application version can be pinned in the following cases: 1. A user started the application monitoring (**Project** menu > **Updates** option > **Track updates** button > Select the application > **Save** button) 2. A user requested to process the latest version of the application (**Actions** column > **Process latest version** button > Confirm update software > **Yes** button) 3. A user changes the version of the application (**Actions** column > **Versions** button > Process column > Select the application’s version > Confirm update software > **Yes** button) 4. A user changes the version of the application manually (**Actions** column > **Edit** button > **Your version** field > Enter the numeric value > **Save** button) |
| Version’s mask | This category indicates what versions of the same application are tacked for updates in parallel. The highest version of an application is tracked by default, but some vendors support several versions of applications (i.e., **Java Runtime Environment**) in parallel. The version’s mask option enables a user to monitor an application version in addition to the highest one. |
| Actions | This category enables a user to provide the activities under the monitored applications. The following actions available: - Process latest version - Versions - Edit - Untrack |
**Note.** In the case of a source media is not available for a certain update version, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-08/dOqoHZjaABiS5BGg-updates_notif.png)
- **Actions** column > **Edit** button > Edit software modal window > **Your version** field > Enter the numeric value > **Save** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-07/UKdCjX9YGrjqFfky-updates_11.png) [](https://docs.apptimized.com/uploads/images/gallery/2021-09/qe36gCsjCCMpLa8R-updates_12_2.png) ##### Edit monitored application settings The option to change the settings of the monitored application is available under the **Actions** column > **Edit** button.  Apptimized opens the window when successful:  The option to change the application version manually is available under **General** in the Your version field.  The option to receive notifications about monitored applications is available under the **Send notifications by Project Role or Group membership** checkbox. This option is enabled by default.  The option to assign a user to receive Update Monitoring notifications is available under the **Send notifications to specific users** field.  The option to remove a user from Update Monitoring notifications is available under the **Remove** button.  The option to remove all users from Update Monitoring notifications is available under the **Remove all items** button.  The option to define how the monitored application is serviced is available under the **Lifecycle servicing option** setting. Two servicing modes are available:| Option | Description |
| Package type | This option defines which package formats should be generated for the monitored application. The following package types are available: • Intunewin • Apptimized PowerShell Wrapper (based on PSADT) Multiple values can be selected. This option is required. |
| Target platforms | This option indicates which operating systems the generated packages will support. This option is required. |
| Bitness | This option defines the architecture type of the generated package. The following options are available: • x86 • x64 Multiple values can be selected. This option is required. |
| Application manager | This option allows selecting the user responsible for managing the application. This option is required. |
| Discovery document (.html, .pdf, .doc, .docx) | This option allows attaching the discovery document for the monitored application. The following actions are available: • Change – upload a new discovery document. • Remove – delete the existing discovery document. • Preview – open the document in a new tab for viewing. |
**Note**. Enabling **Echo** in **Project** **settings** by a project administrator is a prerequisite.
Apptimized Echo is available under the **Project** menu > **Echo**: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Q2ipLGJ3egYy6emz-echo_01_1.PNG) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/BZQ8Fpl6hSAldKt5-echo_01_2.PNG) This is an initial screen when no Echo activities are implemented. ##### **Echo dashboard** The **Echo statistics** tab opens by default. The option to manage Echo platforms is available under the **Manage Echo platforms** button. Apptimized shows the following modal window when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/o1pomJS64Xui5Lmg-echo_01_3.PNG) To choose an Echo platform, a user can drag and drop a suitable platform from the **Available Echo platform / Available non-public Echo platforms** container to the **Project Echo platforms / Project non-public Echo platforms** container. The activities on managing Echo platforms finalize when clicking the **Save** button. The Echo platforms colors indicate the status of platform support by Microsoft: - **Green** – the platform is currently supported by Microsoft; - **Yellow** - the platform is currently supported by Microsoft. The Microsoft support will end in 2 months; - **Red** - Microsoft does not support the platform. The option to filter Echo platforms in the Echo statistics table is available under the Filter platforms columns button. To exclude entities from the table, uncheck boxes next to the name not required in view. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/47fTgVaVRnvPYLw6-echo_01_4.PNG) The echo reports overview is available under the **Echo reports** tab > **Get report** button: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/aOOoO4tvvYLt6oTG-echo_01_5.PNG) The option to set the Echo report time frames is available under the date field (Click the date field > Set the start date > Set the end date > **Apply** button). [](https://docs.apptimized.com/uploads/images/gallery/2020-04/sGDCk5AofzRNH5ST-echo_19.png) The option to customize columns in the Echo reports table is available under the **Select columns** button. To exclude entities from the table, uncheck boxes next to the name not required in view. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/hoZUzNZK0kYi6jGI-echo_20.png) When Echo activities are implemented, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/7RiqgbDFF6zEvudo-echo_15.PNG) Table 1. Echo results statuses (Echo states)| **Icon** | **Status** | **Details** |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/S94dyA8rMACfe99K-echo_icon_08.png) | Pending | Tests are scheduled to start in a moment. Echo results will be available after the VM termination. |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Xya6Q0hJJvqyq0zZ-echo_icon_09.png) | Progress | Tests will be completed in a moment. Echo results will be available after finishing the VM. |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/vpqvsaXzs9eWQUiv-echo_icon_10.png) | Success | Tests were completed as it was expected. |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/6pObZHRwGhpTuPWo-echo_icon_12.png) | Review | A minor discrepancy between test results and the reference test case occurs. |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/iGgD96A5DxXC8DE6-echo_icon_11.png) | Failed | A major discrepancy between the test result and the reference test case occurs. |
| **Icon** | **Status** | **Details** |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/vx8BEBJ87QrFX2oT-echo_icon_01.png) | Disabled | Status for the application with the disabled Echo option. |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/OT1Kn4JpMtWJQdNU-echo_icon_02.png) | No scenario | Status for the application with enabled Echo option with no Echo scenario provided. |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/yv0tI9LtEyfHKgIq-echo_icon_03.png) | Pending | The echo is preparing to work on the application. Tests are scheduled to start momentarily. Echo results will be available after finishing the VM. |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/WcWFVbCmSqyjjioi-echo_icon_04.png) | In Progress | The echo is working on the application. Tests will be completed momentarily. Echo results will be available after finishing the VM. |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/2ode2L03VpdoOzYf-echo_icon_06.png) | Review | At least one test failed, but all have finished and are no longer running or waiting. A minor discrepancy between test results and the reference test case occurs. |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/5pBalSWkE2jUkUK1-echo_icon_05.png) | Success | The echo is ready to use. All tests are finished and succeeded. |
| [](https://docs.apptimized.com/uploads/images/gallery/2020-04/vRnCWjGpGB8CQ17Q-echo_icon_07.png) | Failed | Something went wrong with the Echo. All tests have finished and are no longer running or waiting. A major discrepancy between test results and the reference test case occurs. In this case, a user needs to run Echo Discovery again. |
| **Action** | **Details** |
| Retest | This option provides the possibility to run the VM one more time (e.g., if progress failed). [](https://docs.apptimized.com/uploads/images/gallery/2020-04/26eqFcXwY19ifUna-echo_25_3.png) Apptimized shows the following modal window: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/FQU69ADjeKgschCr-echo_27_1.png) When clicking the **Restart** button, the retesting process launches automatically and Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/wlB6vUXlB7Udyqro-echo_29_2.png) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/RJcBO4ziCpj3Fv8K-echo_29_1.png) |
| Results | This option provides the ability to review the Echo performance and check the generated screenshots.
Apptimized shows the following screen, when clicking the **Result** button:
[](https://docs.apptimized.com/uploads/images/gallery/2020-04/NSVq9y62HLJCggxB-echo_26.png)
Test session results for the applications consist of the following components:
- Main information (i.e., software, platform, test, project, and user information). Editing this block is not available;
- Log test session results (i.e., platform test result (review, success, failed), additional comment). Editing this block is available;
- Screenshots tab. Editing this block is not available;
- Echo logs tab. Editing this block is not available;
- Windows logs tab. Editing this block is not available.
Next, **Log test session results** block is shown in more detail.
The option to log the platform test result is available under the **Platform test result** field (Log test session results block > Platform test result field > Select the test result > **Save** button). **Review**, **Success** and **Failed** options available.
[](https://docs.apptimized.com/uploads/images/gallery/2020-04/RHHuGzqeJFq7KtAy-echo_27_4.png)
The field **Additional comment** is optional and can stay blank.
The option to revert to the test session results screen is available under the **Go back** button.
The option to restart the test case automatically is available under the **Retest automatically** button (**Results** button > Log test session results block > **Retest automatically** button).
[](https://docs.apptimized.com/uploads/images/gallery/2020-04/O99Gamk6dnU74HbE-echo_27_5.png)
Apptimized shows the following modal window to confirm restart activities:
[](https://docs.apptimized.com/uploads/images/gallery/2020-04/FQU69ADjeKgschCr-echo_27_1.png)
Apptimized shows the following screen when successful:
[](https://docs.apptimized.com/uploads/images/gallery/2020-04/MyfLOTlD8VxecFx4-echo_27_2.png)
The retesting process my take a few minutes. Apptimized shows the following screen when successful:
[](https://docs.apptimized.com/uploads/images/gallery/2020-04/sbKiqI44BZuMeNLT-echo_27_3.png)
The option to restart the test case manually is available under the **Retest manually** button (**Results** button > Log test session results block > **Retest manually** button). This option provides the ability to change the Discovery result.
**Note**. When clicking the **Retest manually** button the previous Echo deletes. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/69QTnQv2iPIe5plH-echo_27_6.PNG) VM preparation process may last a few moments: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/MAPfhXohgukOEJnp-echo_27_7.PNG) Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/hDHT43tRBBKznE4s-echo_30.png) To receive new test results all installation and settings activities for the application must be proceeded. The option to revert to the previous screen (i.e., **Test session results**) is available under the **Go back** button. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/JTRqczS5tgWl4b17-echo_27_9.png) When a user runs the retest activities, a screen of the VM is locked for not to disturb the Echo work. But a user can enable the **Lock screen** switch to involve in Echo process: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/YWrqZfmMsX8SdJtX-echo_27_10.png) The option to put text from the user’s host machine VM clipboard is available under the **Clipboard** button. Transferring clipboard content between the host machine and the VM works via "Cut & paste" in the majority of user scenarios. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/ThdN7OtmE8EcLJsD-echo_27_11.png) The option to provide a full-screen mode for a browser is available under the **Fullscreen** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/BvyL07XK8g47L7RZ-echo_27_12.png) The option to stop the current VM session and to start it from scratch manually is available under the **Retest manually** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/R9bhlzvJYL3IyxsL-echo_27_13.png) The option to review discovery documentation is available under the **Open discovery document** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/2da4eg8Gg3SZtSna-echo_27_15.png) Apptimized opens the discovery document in a new tab: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/T4eF15hfvCxZ8I7V-echo_27_16.png) The option to stop the VM is available under the **Terminate** button. All screenshots which were already produced will be saved and the Echo script will be changed. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/WZUCm4E0OdmbBOiO-echo_27_14.png) Apptimized shows the following modal window and notification: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/q7Utw6bzjqY15KQU-echo_30_1.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/srIWmxy7tIu9QmQw-echo_30_3.png) If a user fails test result this status will keep in the test session results. To proceed with the manually retest results, a user changes a platform test result from **Failed** to **Success** (**Log test session results** block > Platform test result field > Success > **Save** button): [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Z37c3Q93NxiSjvJi-echo_27_18.png) If the test fails, there is an opportunity to choose one of the following remediation options: 1. **Repackage** (Applicable when a user needs to request a change in the current package or send a new package request); 2. **Desktop App Assure** (Applicable when the issue can’t be remediated by the latest app version or an updated package, nor can it be accepted); 3. **Accept** (Applicable when the issue is of minor nature and doesn’t impact users’ productivity – and there is no alternative now). Apptimized shows the following screen when the remediations applied: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/bzLfZtcgejtRaVcY-echo_27_19_1.png) The option to review the test case remediations is available under the **Remediators** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/TmqDpbDH8wN0VVIU-echo_27_19.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/O5Ggcazs19ti48wo-echo_icon_13.png) |
| Download | This option provides the ability to download test case results documentation in **HTML**. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/xtsALwtxbjHNXOTa-echo_28.png) |
| View | This option provides the ability to check the VM current session. The **View** button is disabled by default and becomes active when the VM restarts and retesting activities are in progress. |
| Show history | This option provides the ability to see the test case history. **[](https://docs.apptimized.com/uploads/images/gallery/2021-08/YIwrbbdysJi3iW5H-echo_31_2.png)** The option to clean all test case history is available under the **Delete all history** button. The option to delete a specific test case is available under the **Remove** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/y6v376S4Zeb28ycn-echo_32.png) The option to download test case results documentation in **HTML** is available under the **Download** button. The option to review test case results is available under the **Results** button. The keyword search available. |
**Note.** When any issues occur, the notification comes in yellow (i.e., minor issues) or red (i.e., major issues) color.
A user can **Retest** results or **Continue with Discovery – Self Service – Screenshots**. When the review of the generated screenshots completed, click **Save changes** button. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/2RoWvdML2liQ7ml2-echo_12.PNG) The generated document is available in **PDF** and **HTML** formats. To download a document, click the **Download** **generated** **HTML** **document** or **Download** **generated** **PDF** **document** buttons. The option to edit a discovery document is available under the **Edit** **generated** **document** button. The document editing finalizes by clicking the **Save** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/EJM9JaeC2VTBQsOk-echo_13.PNG) The option to return to the discovery self-service screen mode is available under the **Revert to Discovery – Self Service** button. The option to finish the discovery process is available under the **Finish** button. The option to inspect the Echo results is available under the **Project** menu > **Echo.** Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/7RiqgbDFF6zEvudo-echo_15.PNG) #### **Echo with packages (Testing)** **Apptimized Echo** provides test automation capabilities by which repeated application and package testing is simplified. Echo will playback a recorded test case automatically when needed. If a user wants to automate testing of packages or software that has been prepared for automated and silent installation (e.g., for mass deployment via ESD), the Echo must be implemented at the **Testing - Self Service** step. The following use cases available: - Automated installation (e.g., from install.cmd; - Providing a typical use case like creating a file, entering, manipulating, and saving data. The following scenarios to open the transition screen available: - **My Dashboard** > **My Applications** > Choose the project > **Actions** column > **Process** option; - **Project** **menu** > **Dashboards** > **Overview** > **Your** **assignments** module > Choose the application > **Actions** column > **Process** option; - **Project** **menu** > **Dashboards** > **Portfolio** > **Actions** column > **Process** option; - **Project** **menu** > **Import** > **Start** **import** > **Classic** **import** > Application upload session > Apptimized Echo plays back test cases automatically in the following cases: - a new version of the package is released by the packaging group (or by the packaging self-service or by the Apptimized packaging factory), is uploaded to Portfolio and is pushed to Testing again (see **Playback: Apptimized Assisted Testing for future package versions and repeated testing (iterations)**); - a new version of Windows is released by Microsoft (see **Playback: WaaS automated OS compat testing for vendor media**). To start producing the Echo scenario via **Testing - Self Service**, the relevant Playback Echo scenario form must be selected in the **Project menu** > **Settings** > **Echo** > **Playback Echo scenario from** field > **Testing – Self Service**. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/2M6RSvrYlY2hWw2k-echo_35.png) ##### **Recording: Testing – Self Service** The option to import package (e.g., **MSI**) is available under the **Project** **menu** > **Import** > **Start** **import** > **Classic** **import** > Application upload session > **Next** button. When the application is uploaded, and the metadata is reviewed, the **Enable Echo** option must be activated as it is shown on the screenshot below: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/myPR6Di8Sk6G2HP1-echo_52.PNG) Apptimized shows the transition screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/b5QjJ3i14vmlO431-echo_38.png) Skipping to the Testing modules required. The next step is available when clicking the **Testing – Self Service** block. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/4MPfXqYiLLiShOdK-echo_53.PNG) The testing process actions with Echo are similar to testing process actions without Echo (see **Testing – Self Service manual**). VM preparation may take a few moments: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/t5f8h9XTZUVaCgC1-echo_54.PNG) When the synchronization process is finished, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-06/ngZJV8cNgijTzboW-echo_55.png) The uploaded files locate in the **Apptimized files** folder on the VM desktop. To start the installation process, a user opens a file (i.e., **EXE, MSI**) located in the **Source** folder (or an installation file in the **Packages** folder). Every action is captured as a screenshot which is shown in green boxes appearing on the right-hand side: [](https://docs.apptimized.com/uploads/images/gallery/2020-06/PChhIjhAtUAMk8VT-echo_56.png) When installation session and configuration settings completed, click the **Finish** button to terminate the VM. Apptimized shows the following modal window: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/rCCXCrNyWoLza9ub-echo_57.PNG) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/eeLLcwFqWcbwYhch-echo_59.PNG) The next step available when clicking the **Continue with** **Testing - Self Service – Screenshots** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/nl3sMK8YHJucIr6S-echo_60.PNG) The following options to log test session results are available: - Untested; - Success; - Failed. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/K58JNEJYEVZ5Esiu-echo_61.PNG) The default value is **Untested**. The field **Optional comment** can stay blank. The screenshots review is finished when clicking the **Save changes** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/kNQQakNVeP4iy8ZA-echo_62.PNG) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/IIwHqMu1UyYSrA61-echo_63.PNG) The generated document is available in **PDF** and **HTML** formats. To download a document, click the **Download** **generated** **HTML** **document** or **Download** **generated** **PDF** **document** buttons. The option to edit a testing document is available under the **Edit** **generated** **document** button. The document editing finalizes by clicking the **Save** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Tsi9ruju4iwhmkb4-echo_64.PNG) The option to return to the discovery self-service screen mode is available under the **Revert to Testing – Self Service** button. The option to finish the discovery process is available under the **Finish** button. The option to inspect the Echo results is available under the **Project** menu > **Echo.** Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/yS5Wz2VgRQOxhfCc-echo_65.png) ##### **Playback: Apptimized Assisted Testing for future package versions and repeated testing (iterations)** Apptimized Echo enables a user to record Testing step activities for the package, and then (if the newer version of the application is released, a new package of it is created and added to project’s portfolio), a user can specify the initial version of the application on which Testing step was recorded. By doing so, a user doesn’t need to perform the Testing step for the newer version of the package anymore. When the workflow proceeds to the Testing step, it will replay the recorded installation and configuration activities of the package. So, a user saves time significantly. This feature is called **Apptimized Assisted Testing**. To run **Apptimized Assisted Testing** the new version of the application (or package) must be imported. The option to import application is available under the **Project** **menu** > **Import** > **Start** **import** > **Classic** **import** > Application/ package upload session > **Next** button**.** When the application (package) is uploaded, and the metadata is reviewed, the previous version of the application must be indicated, and **Enable Echo** option must be activated as it is shown on the screenshot below: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/sT0tpO0nWubwW29o-echo_44.png) When changes to the **Previous version of the application** field applied, the **Show recorded Echo scenario** option becomes available. A user can click on it to make sure that the needed Echo Discovery was selected: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/aXO6EtbXVgCHejh4-echo_45.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/KFhBLs1Kzc4tgXnt-echo_46.png) The import step finalizes when clicking the **Finish** button. Apptimized shows the transition screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/BIDZt3pKFgKUnRIZ-echo_70.png) The next step is available when clicking the **Testing – Self Service** block. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/YKXmvjdVMmw9TPfS-echo_72.png) The option to set the Echo assisted self-service mode is available under the **Self-Service** **mode** field (select a value from the drop-down list): [](https://docs.apptimized.com/uploads/images/gallery/2020-04/KYL3wozOF0GrhjUh-echo_71.png) The VM starts when clicking the **Start VM** button. VM preparation may take a few moments. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-06/MZCVURzf4TVNNoTy-Untitled.png) User’s interactions to VM are not needed. The Echo provides Testing activities automatically. When the playback scenario finished, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-06/dHS2prFhhSpeOUuv-Untitled-4.png) User’s interactions to VM are not needed. The Echo provides the Discovery activities automatically. When the playback scenario finished, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2020-06/Mteh4NDdnAsGBCU1-Untitled-9.png) The VM will be terminated automatically.**Note.** When any issues occur, the notification comes in yellow (i.e., minor issues) or red (i.e., major issues) color.
A user can **Retest** results or **Continue with Testing – Results**. [](https://docs.apptimized.com/uploads/images/gallery/2020-06/sjq2xhJyUtWAjJrP-Untitled-5.png) When the review of the generated screenshots completed, click **Save changes** button. Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-06/oxee6d3Tdg8R1EUq-Untitled-6.png) The generated document is available in **PDF** and **HTML** formats. To download a document, click the **Download** **generated** **HTML** **document** or **Download** **generated** **PDF** **document** buttons. The option to edit a testing document is available under the **Edit** **generated** **document** button. The document editing finalizes by clicking the **Save** button. The option to return to the testing self-service screen mode is available under the **Revert to Testing – Self Service** button. The option to finish the discovery process is available under the **Finish** button. The option to inspect the Echo results is available under the **Project** menu > **Echo.** ##### **Playback: WaaS automated OS compat testing for vendor media** Apptimized Echo allows a user to understand, will the package work properly on the next releases of the Windows platform or not. The next Windows releases are available to Apptimized as Windows Insider builds. When Echo enabled and the non-public testing platforms (Windows Insider builds) are selected in project settings, Echo will record the installation and configuration of created packages, and then recorded steps will be replayed automatically against the selected Windows Insider builds. A user will receive an automatic notification if playback succeeds on a new Windows update. To implement saved Echo, a new version of the application must be imported via the **Classic import** (**Project** **menu** > **Import** > **Start** **import** > **Classic** **import** > Application upload session > **Next** button). When the application is uploaded, and the metadata is reviewed, the previous version of the application must be indicated, and **Enable Echo** option must be activated as it is shown on the screenshot below: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/8iAy9rbgr5gjQOa6-echo_67.png) When changes to the **Previous version of the application** field applied, the **Show recorded Echo scenario** option becomes available. A user can click on it to make sure that the needed Echo Discovery was selected: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/aXO6EtbXVgCHejh4-echo_45.png) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/KFhBLs1Kzc4tgXnt-echo_46.png) The import step finalizes when clicking the **Finish** button. Apptimized shows the transition screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/b5QjJ3i14vmlO431-echo_38.png) Any other actions with the **Discovery - Self Service** are not needed. The option to check the Echo status of the new application is available under the: - **Project** menu > Apptimized shows the following screen when successful: **[](https://docs.apptimized.com/uploads/images/gallery/2020-04/R23gufdrMEhH53Ib-echo_47.png)****Note.** The Echo status of the new application in a portfolio will change to **Pending.**
The **Success** Echo status of new application means that new application processed through Testing as it was saved in the previous version via Echo: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/xaQjNR1mexatnaJ2-echo_49.png) - **My Dashboard** > **My Applications**. Apptimized shows the following screen when successful: **[](https://docs.apptimized.com/uploads/images/gallery/2020-04/bqY41zBWetGyTVKM-echo_50_1.png)****Note.** The Echo status of the new application in a portfolio will change to **Pending.**
The **Success** Echo status of new application means that new application processed through Testing as it was saved in the previous version via Echo: #### #### **Echo Assumptions** Summarizing the FAQ on Echo results Apptimized support team assumes that a user is not trying to do the following actions during the recording step or Echo playback: 1. Mouse gestures: drag & drop of windows or individual elements of a window. 2. Recording actions in web browsers (i.e., Internet Explorer, Edge, Chrome, Firefox, etc.) and web applications (i.e., Slack, Microsoft Teams, GitHub Client). 3. Recording actions on applications without a graphical user interface (GUI). Echo is a GUI-based testing automation tool for Windows applications. It supports win32 and UWP applications. It cannot be used to test GUI-less applications such as services, drivers, and other types of applications that do not have a graphical user interface. However, you can still record the installation and launch of such applications. 4. Interaction with Windows Explorer: Echo does not record and replay the next actions made in Windows Explorer: \- opening the context menu by click on the right mouse button and work with the context menu; \- creating, deleting, copying and pasting folders and files manually (installation process of an application will be recorded properly); \- working with tray icons and calling the application’s main GUI from the tray. 5. Entering text in Java-based applications (software that requires "Oracle Java" prerequisite or works based on Java core technologies). 6. Working with CMD: switching between folders, adding, deleting, copying, cutting and pasting files, launching executable and other files via CMD. Echo filters interaction with CMD during recording, because there is much of system noise that processing in the background through CMD. In terms of changes in the application’s logic, core technologies and UI from one version of the application to another, Echo does support: - Change of text, color, and font of the application’s UI element ( \* ); - Change of position of the application’s UI element within one page (except Java-based applications); - Change of graphical design (size, color, form) of the page-container of the application’s UI element (except Java-based applications); Echo does not support the next changes between different version of the application: - Change of sequence of windows for the installation process, the application’s startup and configuration, including adding new windows or removal of old ones; - Removal of application’s UI elements. Example: user clicked on button “OK” in the application’s settings in the previous version of the application during recording, but in the new version, this button doesn’t exist; - Change of type of the application’s UI element. Example: element previously was a checkbox, but in the new version, it is an item of the dropdown list; - Moving the application’s UI element from one UI’s page to another. Example: “Ask for updates” dropdown list was on “General” tab of app’s settings, but in the new version it is on the “Miscellaneous” tab; - Change of location for menu list items within different parent items. Example: a user clicked on “Tools” menu on app’s main page, then selected the dropdown list “Options”, and “Advanced” list item. On the newer version of the app “Options” dropdown list is located under another list “Miscellaneous”, which is under “Tools” menu. In such case, Echo will not play click on “Options” dropdown list on the newer version and will fail. ( \* ) “application’s UI element(s)” means UI element which was a part of recorded (Discovery or Testing) document. **Example:** A user enabled the recording of the Discovery step of the application “Mozilla Firefox” (version 61). A user added the newer version (i.e., 65) of this application, in which a vendor changed the sequence of windows of the installation process. If a user wants the Echo to perform Assisted Discovery on version 65 but based on recorded steps with version 61, Echo will fail because of changed GUI logic. Some applications are built by their vendors to contain complex logic regards to the interaction of users with GUI elements. **Examples:** - Echo supports Java-based applications partially, but input in text fields in such applications is not supported; - Some UI elements are too complicated for automatic testing by Echo: windows that are built as panels, text boxes with complex logic of implementation, etc. Apptimized Echo might fail with recording or playback of such test cases. When a user encounters an issue, contact with the Apptimized support team (to provide the needed information to reproduce the issue) is required. # Storage **Apptimized Storage** enables uploading applications and using it in a future for several times skipping the **Import** step. A user directly uploads the application or creates a directory to group applications. Apptimized Storage enables uploading applications once and using them in the future several times, skipping the Import step. A user directly uploads the application or creates a directory to group applications. **Note.** The "storage" option appears in the project menu after it is initiated in the project settings by the project administrator. The **Storage** is available under the **Project** menu > **Storage**: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/IJ5yR8byTo09eUqD-storage_01.PNG) Apptimized shows the following screen when successful: [](https://docs.apptimized.com/uploads/images/gallery/2020-04/jxYUz0Uc2jhh43On-storage_02.PNG) The option to upload an application is available under the **Upload file** button > **Click here to select file** button > Browse to select the file > **Open** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/9P02DNF1XUhSEWSO-storage_03.png) The application appears in the **Storage** when successful. The option to create a folder is available under the **New directory** button > Enter a folder name > **Save** button. All required fields are marked with an asterisk \*. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/zr5mtfNqYOVq3uPC-storage_04.png) The folder appears in the **Storage** when successful. The option to delete an application or a folder is available under the **Delete** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/zteedPhkF07r0WAh-storage_05.PNG) The option to download an application is available under the **Download** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/Oy9RqFryDFe85mNX-storage_06.PNG) [](https://docs.apptimized.com/uploads/images/gallery/2020-04/N9MDJPPZ6z8REJmE-storage_07.PNG) The option to open the folder is available under the **Open** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/SBL6Bx88ko3654sJ-storage_10.png) The option to create a new subfolder is available under the **New directory** button. The sequence of actions is the same as it described above. The option to add a new application is available under the **Upload file** button. The sequence of actions is the same as it described above. The option to revert to the Storage initial screen is available under the **Get back to the root directory** button. [](https://docs.apptimized.com/uploads/images/gallery/2020-04/yWpZfxClAytKwJuk-storage_11.png) # Care and Care+ # Care **Apptimized Care **is one of the Apptimized services that provides access to a store, where a user can track the version package of the application which is packaged according to a standard procedure and is ready for use. The latest application versions available for orders within 2 hours release of the update by the vendor, and ready for download within seconds after the request.**Note.** The "Updates" option appears in the project menu after it is initiated in the [project settings](https://docs.apptimized.com/books/apptimized-platform-user-manual/page/project-settings) by the project administrator.
Apptimized sends the follow-up email when the user has accessed the Apptimized Care: [](https://docs.apptimized.com/uploads/images/gallery/2024-03/careletter.png) #### Apptimized Care interface The **Care** is available under the **Project **menu > **Updates** [](https://docs.apptimized.com/uploads/images/gallery/2023-05/BmfzeAB2veTZhpF0-care_1.png) Apptimized shows the following screen when clicking **Updates** button: [](https://docs.apptimized.com/uploads/images/gallery/2024-09/care-table.png) The screen above shows the default Apptimized Portal interface when several applications are added. Care groups data into six categories: Table 1. Care data categories| **Category** | **Details** |
| Vendor | This category provides the details about the application’s vendor (e.g., **Tim Kosse**) |
| Software | This category provides the details about the application’s name (e.g., **FileZilla**) |
| Latest version | This category provides information about the newest version of the application released by the vendor and available in the Apptimized Platform. |
| Autopush | This category shows if Autopush is active. |
| Your version | This category provides information about the latest version of the application that is pinned within the recent user’s activities in the Care page.
The following colors are implemented to indicate the current state of the monitored application:
[](https://docs.apptimized.com/uploads/images/gallery/2020-07/q78N5eCZAV5tgJ95-Green.png) - The latest version is available in the user’s packaged application portfolio
[](https://docs.apptimized.com/uploads/images/gallery/2020-08/zBebxkPOBqODS8p6-Orange.png) - The newer version (in comparison to the one a user has in portfolio) has been released by the vendor
[](https://docs.apptimized.com/uploads/images/gallery/2020-07/nLgxiP04WWO3iDo5-Red.png) - The version a user has in the packaged application portfolio is outdated. This means that there are two or more recent releases of the application provided by the vendor
**Note**. The application version can be pinned in the following cases: 1. A user started the application package monitoring (**Project** menu > **Updates **option > **Track updates **button > Select the application > **Save** button) 2. A user requested to process the latest version of the application (**Actions** column > **Process version packages** section > Select the Windows bitness > Select PSADT or Intunewin package > Download package or Push to SCCM / Intune > Confirm update software > **Yes** button) 3. A user changes the version of the application package (**Actions** column > **Versions** button > Process package column > Select the application’s version > Download package or Push to SCCM / Intune > Confirm update software > **Yes** button) 4. A user changes the version of the application manually (**Actions **column > **Edit** button > **Your version** field > Enter the numeric value > **Save** button) |
| Servicing option | This category provides information on whether the Care or Care+ service is enabled. The following options are available: - Care - indicates that Care service is enabled; - Care+ - indicates that Care+ service is enabled; - - indicates that none of the services are enabled. |
| Actions | This category enables a user to provide the activities under the monitored applications. The following actions are available: - Process version packages for Windows 32 bit, Windows 64 bit - Versions - Edit - Untrack |
**Note.** In the case of the packages are not available for a new update version for a time, Apptimized shows the following screen: [](https://docs.apptimized.com/uploads/images/gallery/2023-05/HLRfUYQVoZqcKx4R-care_16-2.png)
- **Actions** column > **Edit** button > Edit software modal window > **Your version** field > Enter the numeric value > **Save** button. [](https://docs.apptimized.com/uploads/images/gallery/2024-03/careeditbutton.png) [](https://docs.apptimized.com/uploads/images/gallery/2025-06/1-um-settings.png) #### Edit monitored application settings The option to change settings of the monitored application is available under the **Actions **>** Edit** button. Apptimized shows the modal windows when successful: [](https://docs.apptimized.com/uploads/images/gallery/2025-06/2-care-settings.png) All required fields are marked with an asterisk \*. The option to change the version of the application manually is available under the **Your version** field. The option to create the Apptimized packaging request for the monitored application is available under the **Сreate package request on update **option. The following options are available| Option | Description |
| Care | This option enables the Care service (see [Care](https://apptimized.com/en/service/application-lifecycle-management-service-care/)) |
| Care+ | This option enables the Care+ service (see [Care+](https://apptimized.com/en/service/care-plus/)) |
| **Option** | **Description** |
| Packaging technology | This option indicates which packaging technology should be implemented by Apptimized specialists. The following packaging technologies available: - Apptimized PowerShell Wrapper (based on PSADT) - Intunewin This option is required. Both technologies enabled by default. |
| Target platforms | This option indicates which packaging platform should be implemented by Apptimized specialists. The following packaging platforms available: - Windows 10 64 bit This option is required. Packaging platform option is enabled by default. |
| Bitness | This option indicates the bitness of the created package. The following options available: - x86 - x64 This option is required. Both options enabled by default. |
| Application manager | This option allows to set up default user assignee for managing application (downloading, editing, deploying, untracking). |
| Discovery document | This option allows to upload the discovery document of the application provided by the Apptimized team. |
| Application language | Specifies the default language of the application included in the delivered Care package. To modify the default language, the Customizer must be enabled in the project. |
**Note.** The multiple-choice option is available in the **Package types** and **Bitness** fields.
##### Updates Configuration A user goes to **Administration > Settings > Updates Sections** The **Updates** section in the **Administration** > **Settings** menu includes three parts: **General**, **Intune**, and **SCCM**. Below is a description of each section and its available options: [](https://docs.apptimized.com/uploads/images/gallery/2024-12/updates-settings-general.png) Table 3. Updates Settings| **Section** | **Description** | **Options** |
| General | Configure general settings for updates and notifications. | - **Enable Updates**: Enables the Updates feature for Care and Care+ applications. - **Enable Vulnerability Notifications: **Sends email notifications when application vulnerabilities are detected. |
| Intune | Predefine default templates for Intune Auto-Push Deployments. | - Set default **Intune Assignment Template.** - Configure default **Intune Template** for streamlined deployments. |
| SCCM | Predefine default templates for SCCM Auto-Push Deployments. | - Set default **Deployment Type Template.** - Configure default **Deployment Template** SCCM application pushes. |
| **Option** | **Description** | **Required** |
| Enable Auto-Push (checkbox) | If enabled, additional options for configuring Intune Auto-Push are displayed. | no |
| Intune Environment | Specifies the target Intune environment for deployments, | yes |
| Intune Template | Predefined template for configuring application deployment settings in Intune. | yes |
| Intune Assignment Template | Optional template for assigning applications to groups or users in Intune. | no |
| **Option** | **Description** | **Required** |
| Enable Auto-Push (checkbox) | If enabled, additional options for configuring SCCM Auto-Push are displayed. | no |
| SCCM Environment | Specifies the target SCCM environment for deployments, | yes |
| Deployment Type Template | Predefined template for configuring application deployment settings (e.g., installation methods, rules). | yes |
| Deployment Template | Predefined template for configuring deployment settings (e.g., scheduling, user experience settings). | no |
| **Option** | **Description** |
| Intune Environment | This option allows choosing an appropriate environment. ** ** |
| Intune Template | This option allows choosing created templates. |
| Intune Assignment Template | This option allows choosing assignment templates. |
| **Option** | **Description** |
| End User Notifications | This option allows choosing to show all toast notifications, show toast notifications for computer restarts or hide all toast notifications. ** ** |
| Delivery Optimization Priority | This option has two functions: "content download in foreground" and "content download in background". |
| Time Zone | This option allows choosing an appropriate time zone. |
| Application Availability | This option allows specifying when the app is downloaded to the user's device. |
| Application Installation Deadline | This option allows specifying when the app is installed on the targeted device. When more than one assignment is made for the same user or device, the app installation deadline time is picked based on the earliest time possible. |
| Restart Grace Period | This option allows starting as soon as the app installation has finished on the device. When the setting is disabled, the device can restart without warning. |
| Device Restart Grace Period | The default value is 1,440 minutes (24 hours). This value can be a maximum of 2 weeks. |
| **Option** | **Description** | **Required** | **Example** |
| SCCM Environment | Select the target SCCM environment, where the application will be deployed. ** ** | yes | "Demo Environment" |
| Deployment Type Template | Choose a predefined template that defines deployment type settings, such as installation methods and rules. | yes | "Demo Deployment Type Template" |
| Deployment Template | Select a template for deployment configuration, including scheduling and user experience settings. | no | "Demo Deployment Template" |
| Enable Auto-Push | Automates application deployment to SCCM without manual intervention. | no | Checkbox (Enabled/Disabled) |
| Install the latest version | Autopush for the lates available version in SCCM immediately. | no | Checkbox (Enabled/Disabled) |
| Enable Supersedence | Allows an application to supersede an older version during deployment. | no | Checkbox (Enabled/Disabled) |
| **Category** | **Details** |
| Vendor | This category provides the details about the application’s vendor (e.g., **Tim Kosse**) |
| Software | This category provides the details about the application’s name (e.g., **FileZilla**) |
| Latest version | This category provides information about the newest version of the application released by the vendor and available in the Apptimized Platform. |
| Autopush | This category shows if Autopush function is active. |
| Your version | This category provides information about the latest version of the application that is pinned within the recent user’s activities in the Care page.
The following colors are implemented to indicate the current state of the monitored application:
[](https://docs.apptimized.com/uploads/images/gallery/2020-07/q78N5eCZAV5tgJ95-Green.png) - The latest version is available in the user’s packaged application portfolio
[](https://docs.apptimized.com/uploads/images/gallery/2020-08/zBebxkPOBqODS8p6-Orange.png) - The newer version (in comparison to the one a user has in portfolio) has been released by the vendor
[](https://docs.apptimized.com/uploads/images/gallery/2020-07/nLgxiP04WWO3iDo5-Red.png) - The version a user has in the packaged application portfolio is outdated. This means that there are two or more recent releases of the application provided by the vendor
**Note**. The application version can be pinned in the following cases: 1. A user started the application package monitoring (**Project** menu > **Updates **option > **Track updates **button > Select the application > **Save** button) 2. A user requested to process the latest version of the application (**Actions** column > **Process version packages** section > Select the Windows bitness > Select PSADT or Intunewin package > Download package or Push to SCCM / Intune > Confirm update software > **Yes** button) 3. A user changes the version of the application package (**Actions** column > **Versions** button > Process package column > Select the application’s version > Download package or Push to SCCM / Intune > Confirm update software > **Yes** button) 4. A user changes the version of the application manually (**Actions **column > **Edit** button > **Your version** field > Enter the numeric value > **Save** button) |
| Сare/+ | This category provides information on whether the Care or Care+ service is enabled. The following options are available: - Care - indicates that Care service is enabled; - Care+ - indicates that Care+ service is enabled; - - indicates that none of the services are enabled. |
| Actions | This category enables a user to provide the activities under the monitored applications. The following actions are available: - Process version packages for Windows 32 bit, Windows 64 bit - Versions - Edit - Untrack |
| **Option** | **Description** |
| Your Version | This category provides information about the latest version of the application. |
| Send Notifications by Project Role or Group membership | This checkbox enables sending notifications. |
| Send Notifications to Specific Users | This option allows choosing specific users by providing their emails. |
| Lifecycle Servicing Option | This option provides information on whether Care or Care+ service is enabled. |
| Package type | This option indicates which packaging technology should be implemented by Apptimized specialists. |
| Target platforms | This option indicates which packaging platform should be implemented by Apptimized specialists. Packaging platform option is enabled by default. |
| Urgent | This option gives an opportunity to speed up the packaging process. Please clarify the deadlines with your project manager. |
| Bitness | This option indicates the bitness of the created package. The following options available: - x86 - x64 This option is required. Both options enabled by default. |
| Application Manager | This option allows setting up default user assignee for managing application (downloading, editing, deploying, untracking). |
| Comment | This field gives an opportunity to provide description to auto generated issues and suggestions. |
| Discovery Document | This option allows uploading the discovery document of the application provided by the Apptimized team. |
| Trigger | This option allows defining events to control the frequency of update package delivery. The following triggers available: - Version-based - Time-based - Security release-based |
**Note: **If the checkbox is not visible in the settings, contact the Apptimized support team or the designated contact person from Apptimized to request the necessary permissions.
#### Customization settings overview All custom configurations are stored under the “Updates – Customization” and “Updates – Wrapper” sections in the project settings. These settings apply to all Care packages enabled within the project. The **Customization** tab contains the following settings: [](https://docs.apptimized.com/uploads/images/gallery/2025-02/image2.png) Table 1. Configuration settings| **Configuration ** | **Description ** |
| Package Name | Defines the naming convention for packages |
| Detection method script template | Specifies the script template used to verify successful installation and uninstallation during Intune deployment |
| Disable auto-update functionality | Enables or disables application auto-update functionality (if supported) |
| Remove desktop shortcuts | Removes desktop shortcuts or leaves them based on the vendor’s default behavior |
| **Configuration ** | **Description ** |
| Deployment Mode | Defines the package installation mode (Silent, Interactive, or Non-Interactive) |
| Installation logs location | Specifies the log file path for PSADT and package logs |
| Branding location | Configures the registry key path used for package branding |
| Custom Logo | Sets a custom logo for the PSADT installation window (preferred format: .ico, 64×64). The **Set default** option restores the default logo. |
| Custom Banner | Sets a custom banner for the PSADT installation window (preferred format: .png, 450×50). The **Set default** option restores the default banner. |
| **Configuration ** | **Description ** |
| Detection method script template | Specifies the script template used to verify successful installation and uninstallation during Intune deployment |
| Disable auto-update functionality | Enables or disables application auto-update functionality (if supported) |
| Remove desktop shortcuts | Removes desktop shortcuts or leaves them based on the vendor’s default behavior |
| Application language | Specifies the default language of the application included in the delivered Care package |
| **Configuration ** | **Description ** |
| Installation parameters | Specifies the set of parameters applied to the application source file during the installation process |
| Apps to close | Specifies the list of processes that are closed during package installation and uninstallation |
| **Configuration ** | **Description ** |
| Section | Specifies the section where the PowerShell script will be included (*Pre-Installation, Installation, Post-Installation, Pre-Uninstallation, Uninstallation,* or *Post-Uninstallation*) |
| Architecture | Defines the package architecture(s) to which the PowerShell script applies |
| Comment | Adds a comment above the PowerShell script to describe the action it performs |
| PowerShell script | A multiline section that may include PowerShell and PSADT cmdlets to be added to the final generated Care package |
| **Configuration ** | **Description ** |
| Upload file | Field used to upload a file to the package |
| Applicable for architecture | Defines the package architecture(s) to which the file will be added |
| Location | Specifies the package folder where the file should be placed (custom subfolders are created automatically if needed) |
| **Option** | **Details** |
| \[PackageName\] placeholder value | This option shows a construction of the PackageName that will be applied to the result package |
| Name of result archive | This option provides a result package archive name template |
| Detection method script template | This option shows a PowerShell script template which will be used to check if the package is installed or uninstalled |
| Path to store .intunewin file | This option shows the Intunewin file location in the result package structure |
| Path to store detection method file | This option shows a detection method file location in the result package structure |
| Path to store txt file with deployment commands | This option provides information about txt file with deployment commands location in the result package structure |
| Path to store extracted content of .intunewin file | This option shows the Intunewin package extracted content location in the result package structure |
| Key file to detect the package location | This option shows the file name in the source archive that points to the level where the package is located (e.g. Deploy-Application.exe for PSADT packages) |
| An entry point file for Intune wrapping | This option provides a file name used for intunewin conversion as an entry point (usually, it's an installation file without arguments) |
| Install commands | This option provides the installation file name with arguments |
| Uninstall commands | This option provides the uninstallation file name with arguments |
| Responsible people to receive notifications | This field gives information about people who will receive an email notification if the conversion for the particular application fails |
| Testing image | This option allows choosing the image that will be used for testing incoming packages |
| Skip incoming packages testing | If this option is enabled, the applications will be converted without incoming packages testing |
| **Stage** | **Details** |
| Pending | The application in the queue and is ready to be converted |
| Testing | The incoming app is going to be tested to make sure installation and uninstallation works properly |
| Wrapping | The application is being wrapped to the. intunewin format |
| **Status** | **Details** |
| Pending | The application in the queue and is ready to be converted |
| In progress | The current stage is in progress |
| Skipped | If the “Skip incoming packages testing” option is enabled in conversion settings, the status will be set to the “Testing stage” |
| Failed | A conversion is failed for some reason |
| Removed | The application is removed from bulk conversion and should be processed manually |
| Success | A conversion is finished successfully |
It's important to note that the application **metadata and the PackageName components** used in the package **should match exactly**.
[](https://docs.apptimized.com/uploads/images/gallery/2024-10/image-18.png) Prior to start converting the imported packages, it’s important to review the conversion settings if anything should be changed. If a user struggles with understanding which settings should be changed, he should contact **Apptimized support team.** #### Error Handling In case the conversion for the particular application fails, a user will receive an email notification with detailed information about the issue: [](https://docs.apptimized.com/uploads/images/gallery/2024-10/image-19.png) The conversion item status will be changed to **'Failed'.** The hint with explanation of the reason for the failure will be shown: [](https://docs.apptimized.com/uploads/images/gallery/2024-10/image-20.png) In case the installation or uninstallation of incoming package fails as shown on the screenshot above, it’s required to **check the package and fix problems manually.** After the package is fixed, the archive should be re-uploaded to the Portfolio item. A user should go to **Dashboards** > **Portfolio.** **[](https://docs.apptimized.com/uploads/images/gallery/2024-10/image-21.png)** Finding a **failed application** in the Dashboard list is available by clicking on the “**Settings**” action button. [](https://docs.apptimized.com/uploads/images/gallery/2024-10/image-22.png) A user should click on the **“Reupload source”** button and **re-upload fixed package archive.** **[](https://docs.apptimized.com/uploads/images/gallery/2024-10/image-23.png)** To **restart the conversion process for the following item**, a user goes back to **Bulk Conversion** > **“Restart”** action button. [](https://docs.apptimized.com/uploads/images/gallery/2024-10/image-24.png) In case it doesn’t work, a user can skip testing the application by clicking on the **“Mark test as success”** action button. [](https://docs.apptimized.com/uploads/images/gallery/2024-10/image-25.png) Additionally, by using the **"Mark as removed"** action button, **an application can be removed from the conversion process** if it cannot be converted automatically for any reason. The application needs to be manually converted in this case. [](https://docs.apptimized.com/uploads/images/gallery/2024-10/image-26.png) If the **conversion for the particular application fails** for a technical reason, a user can try **to restart the conversion.** If it doesn’t help, he should contact the **support team.** [](https://docs.apptimized.com/uploads/images/gallery/2024-10/image-27.png)