To ensure the extensions are correctly deployed on all clients, please add the core extensions Chocolatey package to the back-end with order 1 and assign it to the global core group.
Enable extension CmdLets in Craft packages
Out of Chocolatey packages, the usage of the extension CmdLets has to be enabled:
$packageParameters = parameters as specified in the assignment arguments
$packageFolder = folder in which the package is extracted
$packageToolsFolder = sub directory "tools" of a Chocolatey package, contains the install script. Defined as: Join-Path $env:packageFolder "tools"
$packageTempDir = temp directory which is used for the package. Defined as: Join-Path $env:TEMP (Join-Path $env:chocolateyPackageName $env:chocolateyPackageVersion)
$PackageID = unique ID of the package
Environment variables
$env:RJ_Version
$env:RJ_UserSID = SID of the user who started this package installation. Can be used in system crafts if parameters are initialized
$env:RJ_DeploymentPhase = contains information on the installation.
Can be:
Blank
RunningFirstDeployment
RunningFirstDeploymentAuto
- Now the installations start
CompletedFirstDeployment
RunningDeployment
- Now the installations start
CompletedDeployment
ManualDeployment
- Now the installations start
Important
In order to keep the following sections easy to read und clear, a lot of extensions are based only on Chocolatey. Of course these extensions are also usable for Craft. Therefore you have to remove 'Chocolatey' from an extension to make it valid for 'Craft'.
Based on the given LocaleID this command will return the path of the localized transform file.
By default the file is supposed to be located in package root folder. A parent folder for localed file can provided as a parameter (localeTransformsFolder).
The root folder for any file reference inside the scripts are always tools.
For using locale string (e. g. de-de) as input the command be combinded output from Get-ChocolateyRealmjoinLocaleId.
By default MSI based installer is performed with the most common silent parameters. The valid exitcodes for success are set to 0, 1641, 3010 for MSI and EXE based installer.
Optionally args for a silent uninstallation, valid exitcodes for success and post-installation actions as a PowerShell scriptblock (e. g. deleting a desktop shortcut) can be provided.
The parameter additionalArgs is populated with args from the given uninstall info (object) and can not be overwritten. Use silentsArgs to apply additional parameter(s) for a silent uninstallation.
If parameters from uninstall info (object) are not suitable for a successful (silent) uninstallation, you can provide the uninstall info manually as parameters. You have to provide a uninstaller executable file (uninstallerFile), uninstall args (additionalArgs) and a package name (subPackageName) for product to be uninstalled.
Retrieves the package parameter given provided by the RealmJoin Portal (package or user assignment). Those parameters will become available inside the scripting as prefixed variable (packParam). A parameter like /Language:de-de will be provided as the variable $packParamLanguage with the string value of de-de.
With this command you can test if a software exist on your system. This test based on the uninstall info from Get-ChocolateyRealmjoinRegistryUninstallInfo.
With this command you will get an object with key name, file and arguments of an uninstall info match. You will get this info from Get-ChocolateyRealmjoinRegistryUninstallInfo.
A system restart can be initiated. By default with a delay of 10 seconds, which can be overwritten by the corresponding parameter. Optional you can provide a message by parameter. Behind the scene, a scheduled task is created which performs a shutdown with a parameter for restart.
Name Aliases Description Required? Pipeline Input? Default Value
---- ------- ----------- --------- --------------- -------------
Name None true false
Scheduled Tasks
Using predefined RealmJoin cmdlets, it is possible to register scheduled tasks in system or user scope. The cmdlet provides an XML template, that is modified following the used parameters. Tasks also might be unscheduled.
Register-RealmjoinCustomStateScheduledTask
This command registers a scheduled task with package title a its name for creation. By default with a repetition interval of one day and a mandatory PowerShell script (publishState.ps1) in the current script dir.
Optionally the parameters PublishStateScriptFile can be overwritten.
This command creates (and optionally registers) a scheduled task with a given action and trigger, e. g. loggon trigger.
By default its only returns the XML content for a scheduled task, enabled with user as principal and a execution time limit of 15 minutes. To optionally register the task the parameter Register and a mandatory task name (TaskName) must be provided.
Optional switchparameters to start the task once after creation (StartOnce) or for deleting the task after its first run (DeleteAfterFirstRun) can be set.
Name Aliases Description Required? Pipeline Input? Default Value
---- ------- ----------- --------- --------------- -------------
forCurrentUser None Remove and disable a shortcut for current user false false
onDesktop None Remove a shortcut from desktop false false
shortcutPath None true false
Name Aliases Description Required? Pipeline Input? Default Value
---- ------- ----------- --------- --------------- -------------
packageName None false false
Add-RealmjoinExeToTaskbar
This command attaches a given path to the Windows taskbar.
Only the extension types .exeand .lnkare supported.
Syntax
Add-RealmjoinExeToTaskbar
Parameters
Fonts
tbd
Add-RealmjoinFont
This command adds and registers a font to the system by a given path to the font file.
Syntax
Add-RealmjoinFont
Parameters
Remove-RealmjoinFont
This command removes a font from the system.
If you only know the file path, you can provide the mandatory name by using the PowerShell pipeline with the output of command Get-RealmjoinFontName.
Syntax
Remove-RealmjoinFont
Parameters
Get-RealmjoinFontName
This command returns the font name of a given font file.
The output can typically used to remove a font without knowing the font name and using the command Remove-RealmjoinFont.
Syntax
Get-RealmjoinFontName
Parameters
Registry
tbd
Get-RealmjoinRegistryValue
Returns the value of one or more registry entries. Will return $null (or hashtable with entries set to $null) of the registry key or any entries are missing, but will not fail. If only one registry entry is requested, its value will be returned directly. If more than one registry entry is requested, a hashtable will be returned.
This command copies product-specific logfiles from a given location to the common RealmJoin-specific location. By default every file with a last write time greater or equal then 5 seconds before script start will be collected.
Optionally a filename filter (e.g. *.log), in- or exluding filename(s) can be provided. Optional switch parameters for deletion after copy (DeleteAfterCopy), creation time prefixing (PrefixWithCreationTime) and a recursivley copy including subfolders (Recurse) can be set.
The parameter NotBefore can be overwritten with a custom value of type[DateTime]. Alternatively for more specific filtering with a powershell scriptblock, used as a criteria for Where-Object, can be given.
This command returns a RealmJoin-specific log file path including a package-specific log file depending on the script execution context. Optionally a operation (e.g. <scriptname>) and a target (e.g. start_licenseactivation.exe) can be provided.
In absence of parameter Operation it will be set to an empty string, if the executing script name is chocolateyInstall.ps1, chocolateyUninstall.ps1 or rj_install.ps1. Otherwise the executing script name without its extension will used as value for parameter.
This command applies a firewall rule by adding the common appv - specific java executables (java.exe, javaw.exe, jnlplauncher.exe) to the given AppV package.
Optionally the java executable file(s) can be overwritten by the parameter "exeFiles" (e.g. javaw.exe).
This command adds one or more entries to the hostsfile of the system. Behind the scene these entries are added as a block with RealmJoin - specific comments.
For an update you must always provide all (including previous) entries. By providing the switchparameter CleanUp the whole RealmJoin - specific block of entries will be removed from the file.
Convert boolean related strings like '1', 'true', '0' and 'false' to its corresponding and valid boolean type. The default return value, if conversion failed is $false.
The default return value can be overwritten to $true or $null
This command loops and waits for a given condition provided as a PowerShell scriptblock.
By default with 0.5 minutes timeout, the condition as display name and final throw of a exception by reaching the timeout. The parameter 'TimeOutMinutes', 'TimeOutSeconds', 'DisplayName' and final action 'OnTimeout' can be overwritten.
This command invoke a given action (defined as scriptblock) with retries and also executes a fail and a final fail action.
By default with maximal 4 retries and an delay of 1 seconds increased by 1.5 seconds each retry. Optionally a fail ('OnErrorRetry') and a final fail ('OnErrorFinal') action can be provided as a scriptblock.
The parameters 'RetryDelaySeconds', 'MaxRetries' can be overwritten. The increment of the delay can be suppressed by providing the switch parameter 'DoNotIncreaseDelay'.
By default with a delay of 10 seconds, which can be overwritten by the parameter 'Delay'.
Optionally a message can be provided by the parameter 'Message'. Behind the scene a scheduled task is created which performs a shutdown with parameter for restart.
This command enables AppV service on current client with BranchCache as supported. For enabling the Package Scripts support the optional parameter 'enablePackageScripts' can be used.
Publishing is only allow with administrative permissons.
Syntax
Enable-ChocolateyRealmjoinAppv
Parameters
Get-RealmjoinJavaAppvRootFolder
This command returns the root AppV path (Vfs) of Java Runtime Environment by giving any existing AppV package.
