Workspace Environment Management

App Package Delivery

March 27, 2024

Contributed by:

This feature provides app delivery capabilities by allowing you to configure app installation/uninstallation tasks for agent machines that support WEM agent installers and custom .exe installers. You can add app packages with installers stored in their SMB shares, specify the command, execution criteria, and relevant settings for the package. You can then configure delivery tasks to deploy applications to the user environment, with schedules and rules to handle the execution. App packages are shared across all configuration sets. You can configure delivery tasks with app packages in each configuration set. Only machine-wide installers are supported.

For the cloud environment, only one built-in WEM agent package is available. You can create a delivery task, edit a package, and also delete a package using the ellipses associated with the WEM agent package. All packages in use cannot be deleted. You can also sort the app packages and delivery tasks in alphabetical order or based on the date of creation.

Configure storage location

To configure the current configuration set’s storage location, complete the following steps.

Enter an SMB share and credentials of an administrator with the permission to access that share in the Storage location page to add a new storage location and click Done.
The storage location specified applies to only the current configuration set.
Ensure to store your installers in the following path in your SMB share (Storage location)\Citrix\WEM\AppPackages and click Save.

Add app package

To add an app package, complete the following steps.

Click Add app package > EXE to access the Add app package page. This page lists Basic information, Execution criteria, and Settings in the tree structure.
- Execution criteria. You must specify the criteria that determine when the app package must run. The execution criteria is classified into File or folder existence, File creation date, File modification date, File version, File size, Registry key existence, Registry value existence, and Registry value. Ensure to configure the Criteria to prevent errors caused by the repeated execution of packages.
  - On a 64-bit version of Windows, when a file or folder path is configured within the Program Files directory, the WEM agent will automatically check both the 32-bit Program Files (x86) and the 64-bit Program Files folders, if you choose the Criterion type as File or folder existence. For instance, if the configured path is C:\Program Files\Test, the WEM agent verifies the existence of the following two paths: C:\Program Files (x86)\Test and C:\Program Files\Test. Similarly, if the configured path is C:\Program Files (x86)\Test, the WEM agent checks both C:\Program Files (x86)\Test and C:\Program Files\Test. This ensures compatibility and accessibility across both 32-bit and 64-bit applications.
  - If you choose the Criterion type as File size, the WEM agent calculates the file size in kilobytes (KB) by considering the whole number part and ignoring decimal values. For instance, if a file is 46,913,080 bytes in size, the WEM agent calculates its size in KB as 45,813 KB (46,913,080 divided by 1024 is equal to 45,813.554, and the decimal portion, .554,’ is disregarded).
  - If you choose the Criterion type as Registry key existence: In 64-bit versions of Windows, the registry is divided into 32-bit and 64-bit keys. When you configure a registry key as the 64-bit version, the WEM agent attempts to confirm the existence of the registry key-in both the 32-bit and 64-bit versions. However, if you configure a registry key as the 32-bit version, the WEM agent only verifies its presence in the 32-bit version. For instance, if your configured registry key is HKEY_LOCAL_MACHINE\Software\test, the criteria is met if either of the following registry keys exists: HKEY_LOCAL_MACHINE\Software\test or HKEY_LOCAL_MACHINE\Software\WOW6432Node\test. If your configured registry key is HKEY_LOCAL_MACHINE\Software\WOW6432Node\test, the criterion is met if HKEY_LOCAL_MACHINE\Software\WOW6432Node\test exists.
Update the fields listed under each option.
After installing or uninstalling some packages, you can select the Reboot machine after execution checkbox under Settings, if necessary.
- If the application package triggers a machine reboot during installation, the status is recorded as an Unexpected Reboot as you cannot retrieve the precise result. Ensure to incorporate a parameter in the installation command to prevent a reboot, and also select the Reboot machine after execution check box to address this issue.
- If the application package requires ongoing operation after a reboot, the result of the package may not be entirely accurate. This is because WEM cannot retrieve the result of a package that was not initiated by WEM.
Ensure to specify return codes to indicate the success status. You can define the return code for your packages under Settings.

Create a WEM agent upgrade task

To create a WEM agent upgrade task, complete the following steps.

Choose the Create delivery task > WEM agent upgrade task type to access the Create delivery task page. This page lists Basic information and Schedule and rules in the tree structure.
Update the fields listed under each option.
By default, the Latest version is selected under Upgrade to.
For agents running in UI mode, enabling the Allow users to upgrade agent manually makes the Upgrade option available in the agent user interface. You can use this option to upgrade the agents to the version specified in the drop-down menu (last three versions). This setting is a sub-set of the WEM agent upgrade delivery task. This means that manual upgrade task upgrades to the version specified by the WEM agent upgrade delivery task subject to the set Rules.
Ensure to set the Schedule by specifying the time window and the day you need the delivery task to run as the delivery task does not run manually without any set schedule. The start and end times must be set at least two hours apart and on the same day.
You can also set Rules to determine which agent must run the task. You can select Match all or Match any from Machine catalog name, Delivery group name, Device name, IP address, OS platform type, OS version, and Persistent machine rules.

Note:

The following WEM agent upgrade settings may result in compatibility issues while performing an agent upgrade, with versions older than 2310.

Day of week is configured in schedule settings.

Rules are configured with a rule other than Persistent machine.

Match any is selected in Rules.

Rules are configured without a Schedule.

Limitation

When you upgrade a WEM agent, the WEM agent versions earlier than 2310 can only use the first created task among all the currently available agent upgrade tasks.

Create a custom task

To create a custom task, complete the following steps.

Choose the Create delivery task > Custom task type to access the Create delivery task page. This page lists Basic information and Schedule and rules in the tree structure.
Update the fields listed under each option.
You can choose the required app packages and arrange them in the order that you want them to run.
To avoid blocking the other scheduled tasks, ensure to choose Continue if failed under Task content to continue with the seamless processing of other app packages even if one of the selected package functions (install/uninstall) fails.
If you select the Wait until the end to reboot checkbox, the reboot settings for individual app packages are ignored and the machine will reboot when the entire list of tasks finish running.
Selecting the Run once checkbox enables you to run the scheduled task only once.
Ensure to set the schedule by specifying the time window and the day you need the delivery task to run as the delivery task does not run manually without any schedule set.
The maximum execution time for each package is 60 minutes. Otherwise, the package times out and gets terminated.

For more information, see Reports, Agents, and Advanced Settings.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

App Package Delivery

March 27, 2024

Contributed by:

March 27, 2024

Contributed by:

App Package Delivery

Configure storage location

Add app package

Create a WEM agent upgrade task

Limitation

Create a custom task

In this article