Software Packages
Last updated
Last updated
This menu contains a list of all added software packages. Nine different attributes are displayed in this menu:
Package Type
Package Name
Package GroupName
Upgradeability of a package
Package Version
Package Order
Dependencies ****(**Dep**) for a package
Group (Gr) assignment
User (Us) assignment
Above the attributes, there is a search bar (Search for ...). This search compares the input made with each of the attributes and returns suitable results.
Next to the search box is the Only Updates checkbox. If you check this box, only the packages for which an update is available will be displayed. Next to it is another selection field: Hide Organics. If you check this box, all packages of type "Organic" will not be listed in the overview.
At the lower right end of the menu, you can browse through the pages manually.
If you click on a number in the Gr or Us fields, you will get a list of all RealmJoin groups and all RealmJoin users. In these lists, you can choose which groups or users should receive the software package.
Click on a group/user of your choice to assign. You can now configure the following settings:
Availability
Mandatory: The Packages are non-optional
Hidden: The Packages are invisible in the RealmJoin client context menu. This might be used for mandatory software or multiple level dependencies when the user should only be able to install the highest hierarchy and the underlying packages should be installed automatically.
Ignore on VDI pool clients: If you select this setting, a package cannot be executed during a 'Virtual Desktop Infrastructure' (VDI) session, if primary user is "vdipool" or "wvdpool".
Deployment Rate
Select the deployment rate. You have the choice between Slow, Fast and Tomorrow.
Auto Upgrade
With a tick at Enable you activate the automatic upgrade function
Args
If the packaged software has to be installed with arguments. Make sure to use correct escaping. Usually arguments are in the form of:
/Parameter1:value1 /Paramater2:"value 2"
Main Script Restrictions - Users
This option allows a RealmJoin administrator to define whether this package should run for just the primary device user/group (default) or also/exclusively for secondary users.
Main Script Restrictions - Phases
This option allows a RealmJoin administrator to define whether this package should be run during the initial deployment of the device or throughout other phases.
RealmJoin offers the following phases:
Logon: The package runs after the user has logged on.
Manual: The package will run, when the user starts it via tray menu.
Initial: The package only runs during the deployment.
Normal: Neither Logon, nor Manual, nor Initial. A background deployment.
To view details of a package and edit it, simply click on the name of a package. The following overview (Package Definition) will open:
There are different input fields on this page. Have a look at the table below for more details
Name
The package is listed under this name of the client and the RealmJoin Admin Console.
GroupName
An optional group name may be entered. This name has no connection to the user groups, instead it will be shown in the RealmJoin client context menu to group the depicted applications
ID
The RealmJoin internal name of the package, for example: realmjoin-core.extension
Depends on
This option is used to indicate if a package needs another package to be installed to work properly. This may be the case for Office user setting packages, that require an office installation upfront.
For a working correlation, the correct package name has to be provided. Enter the package name into the following form: ["PACKAGE ID"]. If two or more packets need to be entered, separate the names with a comma. For example: ["PACKAGE ID1","PACKAGE ID2"]
Order
The order number is an Int32 type figure and provides RealmJoin with a basic structure to determine the package installation sequence. The lower the number the higher the importance, therefore a 10 will be installed before 100. It has to be noted that a 0 is translated to no sequence given and the order number is only taken into account at the first rollout.
Args
If the packaged software has to be installed with arguments. Make sure to use correct escaping. Usually arguments are in the form of:
/Parameter1:value1 /Paramater2:"value 2"
Globally relevant parameters (e. g. volume license number) should be provided at the package addition step, while more individualized arguments (like language packs) are better specified during the assignment.
Version
The version of the package to be installed
Chocolatey Package ID
Exact Chocolatey repository name of the package to be installed. The combination of name and version is used to ensure that the correct package is installed. Usually, similar to the internal RealmJoin ID.
Availability
Allow Reinstall: This option allows the client user to reinstall and therefore override their current installation of the package.
Allow Background Install: The software package may be installed outside of the black screen installation, thus not blocking the access to the client's desktop and software. Do not use this option for regular packages without discussion with your RealmJoin consultant!
Pre-Release: The pre-release flag has two distinctive features within RealmJoin. It allows:
1. To add a package with ID and version similar to another existing package in the portal and
2. If assigned to a group or user, it overwrites all other packages with the same ID assigned to the group user. Those features are usually used for the testing of new packages or updates of an existing one: The test-groups or test-users get the pre-release version of a package assigned during the testing. The pre-release flagged package is visually highlighted in the portal's package list with a lightning symbol behind the name.
Require Intune Compliance: The package is installed as soon as RealmJoin is able to verify via the GraphAPI that the machine is considered compliant. This might stop the rollout for some time. The installation of the package and therefore all other mandatory packages with higher-order numbers that are queued to be installed afterwards is resumed when the client is compliant.
Ignore on VDI pool clients: If you select this setting, a package cannot be executed during a 'Virtual Desktop Infrastructure' (VDI) session, if primary user is "vdipool" or "wvdpool".
Deployment Rate
Select the deployment rate. You have the choice between Slow, Fast and Tomorrow
Auto Upgrade
With a tick at Enable you activate the automatic upgrade function
Under normal circumstances, it is highly advised to prevent a normal user from having the same package assigned more than once.
To change the package Name or ID is not a proper way to edit assigned packages. Add a new package instead. Delete the obsolete one.
Do not use the dependency and order option on mandatory packages parallel. This might prevent the back-end from correctly resolve the order installation: During the initial rollout, or any rollout of mandatory packages after a login for this purpose, RealmJoin in the first step resolves all dependencies of the packages. If there are any, all packages which are listed as a dependency for a different package are installed. In the second step, the original packages are installed. This may cancel out any order numbers.
For example:
Package A, order 1
Package B, order 101and depending on Package C, order 100.
If all packages are assigned as mandatory, the installation sequency will be C, A, B
NOTE: Per defintion, packages that are entered as dependency for other packages always have to be set to Autoupgrade:true.
To access these options, press Show Advanced Options above Auto Upgrade. These are the available options:
Includes User Script
In the latest generation of packages, it is not necessary anymore to create a second package for the deployment of corresponding user settings, but such a script can be part of the main package. If this is the case, it will be run automatically if this option is checked. Parameters can be transferred via arguments as established. User scripts will not run for secondary users if the main application is not installed.
Main Script Restrictions - Users
This option allows a RealmJoin administrator to define whether this package should run for just the primary device user (default) or also/exclusively for secondary users.
Main Script Restrictions - Phases
This option allows a RealmJoin administrator to define whether this package should be run during the initial deployment of the device or throughout other phases.
RealmJoin offers the following phases:
Logon: The package runs after the user has logged on.
Manual: The package will run, when the user starts it via tray menu.
Initial: The package only runs during the deployment.
Normal: Neither Logon, nor Manual, nor Initial. A background deployment.
This tile shows a list of active clients to which the package has already been distributed.
Instead of entering the name, version, order, args etc. manually, you can insert the JSON code of the package. You can find this code in the corresponding package repository.
To view details of a package and edit it, simply click on the name of a package. The following overview (Package Definition) will open:
There are different input fields on this page. Have a look at the table below for more details
Name
The package is listed under the name of the client and the RealmJoin Admin Console.
GroupName
An optional group name may be entered. This name has no connection to the user groups, instead, it will be shown in the RealmJoin client context menu to group the depicted applications
ID
The RealmJoin internal name of the package; for example, realmjoin-core.extension
Depends on
This option is used to indicate if a package needs another package to be installed to work properly. This may be the case for Office user setting packages, which requires an office installation upfront.
For a working correlation, the correct package name has to be provided. Enter the package name into the following form: ["PACKAGE ID"]. If two or more packets need to be entered, separate the names with a comma. For example: ["PACKAGE ID1","PACKAGE ID2"]
Order
The order number is an Int32 type figure and provides RealmJoin with a basic structure to determine the package installation sequence. The lower the number the higher the importance, therefore, a 10 will be installed before 100. It has to be noted that a 0 is translated to no sequence given and the order number is only taken into account at the first rollout.
Args
If the packaged software has to be installed with arguments. Make sure to use correct escaping. Normally, arguments are in the form of:
/Parameter1:value1 /Paramater2:"value 2"
Globally relevant parameters (e. g. volume license number) should be provided at the package addition step, while more individualized arguments (like language packs) are better specified during the assignment.
Version
The version of the package to be installed
Location
Location of the package on the back-end
Hash
Hash of the package
Scope
Craft packages might be installed in the user or system scope
Availability
Allow Reinstall: This option allows the client user to reinstall and therefore override their current installation of the package.
Allow Background Install: The software package may be installed outside of the black screen installation, thus not blocking the access to the client's desktop and software.
Pre-Release: The pre-release flag has two distinctive features within RealmJoin. It allows:
To add a package with ID and version similar to another existing package in the portal and
2. If assigned to a group or user, overwrites all other packages with the same ID assigned to the group user. Those features are usually used for the testing of new packages or updates of an existing one: The test-groups or test-users get the pre-release version of a package assigned during the testing. The pre-release flagged package is visually highlighted in the portal's package list with a lightning symbol behind the name.
Require Intune Compliance: The package is installed as soon as RealmJoin is able to verify via the GraphAPI that the machine is considered compliant. This might stop the rollout for some time. The installation of the package and therefore all other mandatory packages with higher-order numbers that are queued to be installed afterwards is resumed when the client is compliant.
Ignore on VDI pool clients: If you select this setting, a package cannot be executed during a 'Virtual Desktop Infrastructure' (VDI) session, if primary user is "vdipool" or "wvdpool".
Deployment Rate
Select the deployment rate. You have the choice between Slow, Fast and Tomorrow
Auto Upgrade
With a click at Enable you activate the automatic upgrade function
Under normal circumstances, it is highly advised to prevent a normal user for having the same package assigned more than once.
To change package Name or ID is not a proper way to edit assigned packages. Add a new package instead. Delete the obsolete one.
Do not use the dependency and order option on mandatory packages parallel. This might prevent the back-end from correctly resolve the order installation: During the initial rollout, or any rollout of mandatory packages after a login for this purpose, RealmJoin in the first step resolves all dependencies of the packages. If there are any, all packages which are listed as a dependency for a different package are installed. In the second step, the original packages are installed. This may cancel out any order numbers.
For example:
Package A, order 1
Package B, order 101 and depending on Package C, order 100.
If all packages are assigned as mandatory, the installation sequence will be C, A, B
To access these options, press Show Advanced Options above Auto Upgrade. These are the available options:
Includes User Script
In the latest generation of packages, it is not necessary anymore to create a second package for the deployment of corresponding user settings, but such a script can be part of the main package. If this is the case, it will be run automatically if this option is checked. Parameters can be transferred via arguments as established. User scripts will not run for secondary users if the main application is not installed.
Main Script Restrictions - Users
This option allows a RealmJoin administrator to define whether this package should run for just the primary device user (default) or also/exclusively for secondary users.
Main Script Restrictions - Phases
This options allows a RealmJoin administrator to define whether this package should be run during the initial deployment of the device or throughout other phases.
RealmJoin offers the following phases:
Logon: The package runs after the user has logged on.
Manual: The package will run, when the user starts it via tray menu.
Initial: The package only runs during the deployment.
Normal: Neither Logon, nor Manual, nor Initial. A background deployment.
This tile shows a list of active clients to which the package has already been distributed.
Instead of entering the name, version, order, args etc. manually, you can insert the JSON code of the package. You can find this code in the corresponding package repository.
In this tile, you will find technical help and information if you need further support.
To add a Choco or Craft package, in the Software Packages overview, click one of the two green buttons in the upper right corner: +Add Choco or +Add Craft
You get an input mask (like the one from Package Definition, but it is empty).
Whenever a package with identical content is needed multiple times for the same user or group, the RealmJoin Portal offers the possibility to use the same package multiple times while preventing conflicting installations.
A possible scenario: One user group needs the same package with different arguments (for example to map several network drives) and the RealmJoin Client requires unique packages IDs.
To make the ID unique, a hash is written behind the ID and provided with a meaningful word/index, like package-id#Value
