Skip to content

09 Checks... All the Options for UEX

Ayla Abbott edited this page Feb 16, 2020 · 2 revisions

Main Action Flags

These Actions are the main function of UEX. They can have thier wording modified with the wording/popup tweaks.

Check Wording/Action
quit Both
block Both
logout Both
restart Both
power Both
trigger Action
critical Both
compliance Both

QUIT

  • Quits applications before running the changes

BLOCK

  • Quits and runs agent to keep applications from running during changes

LOGOUT

  • Starts an agent after changes to prompt a user logout within the next 1 hr

RESTART

  • Starts an agent after changes to prompt a restart within the next 1 hr

POWER

  • Verifies that AC power is connected before changes occur

TRIGGER

  • Can be used to run additional triggers in parameter 10

CRITICAL

  • flag for mission critical changes that users can't postpone

COMPLIANCE

  • Flag that will force the policy to run if the user ignores it after 3 times past their postpone limit (1 time if critical)
  • See Compliance-Policies for more info

Wording and popup tweaks

These flags change the wording of the UEX Dialog or change how the window presents. Some give a follow up dialog, like saveallwork. Other just change th wording of popups and logs.

Check Wording/Action
macosupdgrade Wording
saveallwork Both
notify Action
custom Action
ssavail Both
install Wording
update Wording
uninstall Wording

MACOSUPGRADE

  • Notifies that restart will begin automatically after preparation completes
  • Does not start the uexrestartagent

SAVEALLWORK

  • This does not actually quit apps for the user. Add the 'quit' parameter for that
  • Notifies the user to save all their work
  • Forces a popup even if there are no quit, bock, logout, or restart actions.

NOTIFY

  • Show dialog as just a notice for useful for misc communication before an action starts
  • Used when there are no packages and but you want to trigger something and inform the user before hand
  • Forces a popup even if there are no quit, bock, logout, or restart actions.

CUSTOM

  • Not commonly needed
  • Overrides the default dialog to only show parameter 11

SSAVAIL

  • Flag for changes that can also be run via Self Service.app
  • Combine this with any UEX Policy that you'll also list in Self Service using the 00-$action-via-Self-Service.sh scripts.
  • If a user pospones a deployment they'll get a handy dandy dialog to let them know they can run the policy any time via Self Service.
    • This dialog is dynamic and will show any custom name and location of your Self Service app.
    • This will also check if Self Service is in the dock but depending on how it was added to the dock your user may not get the extra text telling them it's in the dock.

INSTALL, UPDATE, UNINSTALL

  • Not Required by default it assumes that all UEX policies are an install.
  • Used to communicate the action to the user.
    • All dialogs will change the action word acordingly.
    • For example: instead of saying "Starting Install" it will say "Starting Update"

Special Flags

These flags have special functions like software update for Apple & Microsoft.

Check Wording/Action
debug Both
suspackage Action
merp Action
msupdate Action

DEBUG

  • Used to see increase logging and test the block agent
  • Can also be use to override the package requirement and just see what the exprience does

SUSPACKAGE

MSUPDATE (as of v5.0)

  • This is used in combination with application flags to check for and install updates using the msupdate tool in Microsoft AutoUpdate.app
  • Check out 11-UEX-Integration-With-msupdate for more info
  • Application Flags:
    • Microsoft Word (check=word)
    • Microsoft Excel (check=excel)
    • Microsoft PowerPoint (check=powerpoint)
    • Microsoft Outlook (check=outlook)
    • Microsoft OneNote (check=onenote)
    • Microsoft OneDrive (check=onedrive)
    • Company Portal (check=companyportal)
    • Microsoft Teams (check=teams)
    • Skype for Business (check=sfb)
    • Microsoft Edge (check=edge)

Customizations to Actions or Buttons

Check Wording/Action
merp Action
nopreclose Both
forcenorecon Action
noloutoption Both

MERP

  • For now, if you add merp in the checks, UEX will try to safely quit an app with osascript in order to avoid getting the Microsoft Error Reporting App.
  • This is included automatically if you're using msupdate

NOPRECLOSE

  • This can be used per-policy to prevent the apps from performing a safe quit after the user choose to start the interaction.
  • This changes the wording by switching the default "will be closed" to "please close"
  • Useful for apps that need more time to quit or if you just want to suppress the feature.
  • Highly recommended to test the behavior with your app with and without this option if you have doubts.

FORCENORECON (as of v4.2.3)

  • This disables the uex_inventory_update_agent and prevents it from running at the the end of check-in.
  • Use this if you have other scripts that are running recon and do not want to double up

NOLOUTOPTION

  • This is used to disable to the 'at Logout' button on a per policy basis
  • At logout buton presents with the following types
    • lockmac (coming in v6.0)
    • logout
    • restart
    • saveallwork

COMBINING UEX CHECKS PARAMETERS (RULES FOR COMBINATION)

  • When using combination actions you should ensure that they required or applicable to the installation.
  • For example, if the changes do not require a restart do not specify restart
  • Must be separated by spaces:
    • Good example: Quit Restart ssavail
    • Good example: Restart power
    • Bad example: Quit;Restart ssavail
    • Bad example: Restartpower

COMBINATION OPTIONS

  • QUIT & BLOCK do not need to be combined with each other as Block also quits the software beforehand.
  • RESTART & LOGOUT cannot be combined with each other since a restart already logs the user out.
  • You can combine QUIT or BLOCK with RESTART or LOGOUT.
  • This will cause the application quit/blocking to happen and then after the changes the restart/logout agent will prompt the next specified action.
    • Good Example: Quit Logout
    • Good Example: Quit Restart
    • Good Example: Block Logout
    • Good Example: Block Restart
    • Bad Example: Quit Block
    • Bad Example: Restart Logout
  • POWER can be added to any UEX Policy
  • SSAVAIL can be added to any UEX Policy
  • CRITICAL can be added to any UEX Policy.
  • Install, Uninstall, and Update can be added to any UEX Policy.
  • MACOSUPGRADE should not be paired with RESTART
  • SUSPACKAGE should not be combined with anything other that SSAVAIL.
  • MSUPDATE should only be combined with COMPLIANCE, SSAVAIL, and the flag for the app it's updating (ie. word or excel)