.. Reminder for header structure: Level 1: ==================== Level 2: -------------------- Level 3: ++++++++++++++++++++ Level 4: """""""""""""""""""" Level 5: ^^^^^^^^^^^^^^^^^^^^ .. |enterprise_feature| image:: wapt-resources/icon_wapt_enterprise.png :scale: 3% :alt: WAPT Enterprise feature only .. |ok| image:: wapt-resources/icon-ok.png :scale: 5% :alt: feature available .. |nok| image:: wapt-resources/icon-nok.png :scale: 5% :alt: feature not available .. meta:: :description: WAPT usage advandced :keywords: waptconsole, waptexit, wapt_self_service, WAPT, documentation, the WAPT Console .. _wapt-self-service: *********************** Using WAPT Self-Service *********************** Presentation ============ With WAPT your users can have a selfservice for software installation. It's different in the **Discovery** and **Enterprise** versions. .. list-table:: :header-rows: 1 :widths: auto :align: center * - Functionality - Discovery - Enterprise * - Access to self-service - |ok| - |ok| * - Deploying self-service packages - |ok| - |ok| * - Filtering self-service packages - |nok| - |ok| * - Management tab - |nok| - |ok| Working principle ================= The :term:`Users` gain in autonomy while deploying software and configurations that are trusted and authorized by the :term:`Organization`. This is a time saving feature for the Organization's IT support Helpdesk. Discovery --------- Only Local Administrators and members of the *waptselfservice* group can access self-service on the hosts. .. attention:: These users have acces to all packages in your repository. Enterprise ---------- You can filter the list of self-service packages available for your users. A *self-service* package may be deployed on hosts to list the different self-service rules that apply to the host. The *self-service* packages are based on user groups. Your users will be able to install a selection of WAPT packages without having to be a :term:`Local Administrator`. Using self-service feature ========================== Configuration ------------- Discovery ^^^^^^^^^ On Discovery create a *self-service* group on your Active Directory and add your users. This users and all :term:`Local Administrator` have acces to all packages in your repository. .. note:: It is not possible to filter the packages made accessible to the user. Enterprise ^^^^^^^^^^ In the WAPT Console go to the :guilabel:`WAPT Packages` tab and select the :guilabel:`Self-service rules` menu item. .. image:: wapt-resources/wapt_console_package-type_menu-list.png :align: center :alt: Menu list for creating WAPT packages You can now create your *self-service* rules package. .. figure:: wapt-resources/wapt_console_self-service_container-window.png :align: center :alt: Create a *self-service* package #. Give a name to the *self-service* package. #. Give a Description. #. Click on the :guilabel:`Add` button to add the group (at the bottom left). #. Name the *self-service* group (with :kbd:`F2` or type directly into the cell). #. Drag and drop the allowed software and configuration packages for this *self-service* group into the central panel; #. Add as many groups as needed to be included to the WAPT *self-service* package; #. Save the WAPT package and deploy on the selected hosts; .. note:: * The name of the *self-service* package **MUST** be the same as the name of the **Active Directory user security group** to which the *self-service* rules will apply.. * If a group appears in multiple *self-service* packages, then the rules are merged. * The authentication used is system authentication by default, it is possible to authenticate with :ref:`Active Directory `. * Once the *self-service* package is deployed, only allowed WAPT packages listed in the *self-service* group(s) of which the :term:`User` is a member will be shown to the logged in :term:`User`. Using WAPT Self-Service ======================= WAPT Self-service is accessible in the Windows start menu under the name :guilabel:`Self-Service software WAPT`. .. image:: wapt-resources/wapt_selfservice_windows-start-menu_screen-item.png :align: center :alt: Starting the WAPT Self-Service from the Windows Start Menu It is also available directly in the WAPT directory :file:`\\waptself.exe`. .. note:: The login and password to enter when launching the self-service are the User's credentials (local or Active Directory credentials). The WAPT Self-service then displays a list of packages available for installation. .. figure:: wapt-resources/wapt_selfservice_main_container-window.png :align: center :alt: Main window of the WAPT Self-service Main window of the WAPT Self-service * The user can have more details on each WAPT package by clicking the :guilabel:`+` button. .. image:: wapt-resources/wapt_selfservice_more-info_container-window.png :align: center :alt: Info panel in the WAPT Self-service window * Different filters are available for the user on the left side panel. .. image:: wapt-resources/wapt_selfservice-filters_menu-list.png :align: center :alt: Filter panel in the WAPT Self-service window * The :guilabel:`Update Catalog` button is used to force a :command:`wapt-get update` on the WAPT Agent; * The current task list of the WAPT Agent is available by clicking the :guilabel:`task bar` button; .. image:: wapt-resources/wapt_selfservice_task-bar_dialog-box.png :align: center :alt: Dialog box showing the status of WAPT tasks in WAPT Self-service * It is possible to change the language of the interface with the :guilabel:`⚙` button at the bottom left. .. image:: wapt-resources/wapt_selfservice_language-selection_dialog-box.png :align: center :alt: Dialog box for selecting the locale in WAPT Self-service Default package categories available ------------------------------------ By default, WAPT manage these categories of packages: * Internet; * Utilities; * Messaging; * Security; * System and network; * Storage; * Media; * Development; * Office​​. It's possible to :ref:`add other categories ` to the packages you develop. WAPT Agent Settings for WAPT Self-Service ========================================= :ref:`WAPT Agent ` can be configured to WAPT self-service. Configuring a different authentication method for the self-service ------------------------------------------------------------------ By default, authentication on WAPT service is configured in system mode. This behavior is defined with the value of :code:`service_auth_type` in :ref:`wapt-get.ini `: .. list-table:: :header-rows: 1 :widths: auto :align: center * - Value - Description * - ``system`` *Default value* - WAPT service transmits the authentication directly to the operating system; it also recovers the groups by directly interrogating the operating system. * - ``waptserver-ldap`` - This mode allows authentication to the WAPT Server. The WAPT Server will make a LDAP request to verify authentication and groups. For this to work, you **MUST** have configured :ref:`LDAP authentication ` on the WAPT Server. * - ``waptagent-ldap`` - This mode allows authentication with an LDAP server identified in :file:`wapt-get.ini`. The WAPT Agent will make a LDAP request to verify authentication and groups. For this to work, you **MUST** have configured :ref:`LDAP authentication ` on the WAPT Server. You may be interested in looking up this article describing the :ref:`settings for WAPT Self-Service and the WAPT service Authentification ` for more options. .. note:: For the system authentication under GNU/Linux to work correctly, be sure to correctly configure your pam authentication and your :file:`nsswitch.conf`. The :command:`id username` command **MUST** return the list of the groups the user is member of. .. warning:: In ``system`` mode we assume that :term:`Local Administrators` can see all the packages. To change this behavior she the next point. Configuring the authentification for Administrator -------------------------------------------------- By default WAPT Self-Service who use ``system`` authentification. In this mode, the :term:`Local Administrators` can see all the packages of WAPT Server repository. If you do not want this behavior there are **2** possibilities: * Block the view of all packages for :term:`Local Administrators` * All packages are only visible for a specific user group Block Local Administrator on self-service ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To block all packages from being displayed to :term:`Local Administrators` you have to add the parameter :code:`waptservice_admin_filter` in :file:`wapt-get.ini`. .. list-table:: :header-rows: 1 :widths: auto :align: center * - Value - :guilabel:`True` - :guilabel:`False` * - :code:`waptservice_admin_filter` - Enable *selfservice package* view filtering for Local Administrators. - Disable *selfservice package* view filtering for Local Administrators. User group self-service Administrator ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ It's possible to use a special user group to define a list of administrators in the Self-Service. Create a user security group named ``waptselfservice`` and add members. All members of this group can view all packages on the WAPT Self-Service. With :code:`waptservice_admin_filter` parameter, you have secured the administrator acces of WAPT Self-Service. Video demonstration =================== .. youtube:: -_sm8KBwDOw .. _wapt_usage_advanced: ********************************** Using the WAPT System Tray utility ********************************** The WAPT System Tray utility is a systray program working in user context. The WAPT System Tray utility launches at logon if the option has been ticked during WAPT Agent installation. The icon will show up in the Windows tray toolbar. One can also launch the WAPT System Tray utility manually on :file:`C:\\Program Files (x86)\\wapt\\wapttray.exe`. Functionalities of the WAPT System Tray utility =============================================== .. tabs:: .. tab:: Main functions .. image:: wapt-resources/wapt_tray_menu-list.png :align: center :alt: The WAPT System Tray utility in Windows notification tray .. list-table:: List of functionalities of the WAPT System Tray utility :header-rows: 1 :align: center * - Action - Description * - :guilabel:`View software status` - Launches the local web interface in a web browser. * - :guilabel:`Update software inventory` - Refreshes the list of available WAPT packages. Double-clicking on the tray icon brings about the same effect. * - :guilabel:`Install updates` - Launches the installation of pending upgrades. * - :guilabel:`Run WAPT Self-service` - Launches the WAPT Self-Service. * - :guilabel:`Run WAPT Console` - Launches the WAPT Console. * - :guilabel:`Configuration` - See following table for detailed list of options. * - :guilabel:`Configuring all installed packages for your own session` - Launches a :command:`session-setup` to configure user environment for all packages installed on the host. * - :guilabel:`View tasks` - Display the task list on the local web interface in the web browser. * - :guilabel:`Cancel current task` - Cancel a running task on WAPT Agent. * - :guilabel:`Cancel all current tasks` - Cancel all running tasks on WAPT Agent. * - :guilabel:`WAPT service running` - Stops and reloads the WAPT service. * - :guilabel:`Quit` - Closes the tray icon without stopping the local WAPT service. .. tab:: Configuration functions .. image:: wapt-resources/wapt_tray_configuration_menu-list.png :align: center :alt: Configuration of the WAPT System Tray utility .. list-table:: List of configuration options for the WAPT System Tray utility :header-rows: 1 :align: center * - Action - Description * - :guilabel:`View configuration file` - Opens the :file:`C:\\Program Files (x86)\\wapt\\wapt-get.ini` file with :term:`Local Administrator` privileges (credentials may be asked). * - :guilabel:`Reload network related service configuration` - Reloads the connection to the WAPT Server in the event of a network reconfiguration. * - :guilabel:`Save this host to the WAPT Server` - Updates the host's inventory with the WAPT Server. * - :guilabel:`About this host` - Launches the local web interface in a browser file with :term:`Local Administrator` privileges (credentials may be asked) to display the host inventory. Video demonstration =================== .. youtube:: 9iG36IeHuVc .. _waptexit: *************************** Using the WAPT Exit utility *************************** The WAPT Exit utility allows to upgrade and install WAPT packages when a host is shutting down, at the user's request, or at a scheduled time. The mechanism is simple. If WAPT packages are waiting to be upgraded, they will be installed. .. hint:: The WAPT Exit method is very effective in most situation because it does not require the intervention of the :term:`User` or the :term:`Administrator`. .. image:: wapt-resources/wapt_exit_dialog-box.png :align: center :alt: Main window of the WAPT Exit utility The WAPT Exit utility executes by default on shutdown, it is installed with the WAPT Agent. The behavior of the WAPT Exit utility is customizable in :ref:`wapt-get.ini ` of the WAPT Agent. .. warning:: If a WAPT task is running, the shutdown of the host is suspended until the task has completed or timed-out. Manually triggering the execution of the WAPT Exit utility ========================================================== The WAPT Exit utility can be manually executed by running :file:`C:\\Program Files (x86)\\wapt\\waptexit.exe`. Triggering the WAPT Exit utility with a scheduled task |enterprise_feature| =========================================================================== One can deploy a GPO or a WAPT package that will trigger the WAPT Exit utility at a pre-scheduled time. .. hint:: **Triggering the WAPT Exit utility with a scheduled task is best suited for servers that are not shutdown frequently.** You may adapt the procedure :ref:`describing how to deploy the WAPT Agent ` to trigger the WAPT Exit utility script at the most appropriate time. .. hint:: You can use the following script for your scheduled task, adapted to your need: .. code-block:: python waptpython -c "from waptservice.enterprise import start_waptexit start_waptexit('',{'only_priorities':False,'only_if_not_process_running':True, 'install_wua_updates':False,'countdown':300},'schtask')" .. warning:: * All running software that are upgraded may be killed with possible loss of data. * The WAPT Exit utility may fail to upgrade a software program if a software that you are upgrading is in the :code:`impacted_process` list of the :file:`control` file. See :ref:`below ` for more information. * The method of triggering the WAPT Exit utility at a scheduled time is the least recommended method for desktops. It is better to let the WAPT Exit utility execute at shutdown or on user request. The WAPT Exit utility settings in wapt-get.ini ============================================== It is possible to :ref:`modify the behavior of the WAPT Exit utility ` in the :file:`wapt-get.ini`. It is also possible to modify the behavior of the WAPT Exit utility directly from the command line, see the next points. The WAPT Exit utility options with the command line =================================================== Avoiding the cancellation of upgrades ------------------------------------- To disable the interruption of the installation of updates you can run the WAPT Exit utility with the argument: .. code-block:: bash waptexit.exe -allow_cancel_upgrade = True Increasing the trigger time in the WAPT Exit utility ---------------------------------------------------- To specify the wait time before the automatic start of the installations you can start the WAPT Exit utility with the argument: .. code-block:: bash waptexit.exe -waptexit_countdown = 10000 .. _impacted_process: Avoiding to interrupt user activity =================================== To tell WAPT not to run an *upgrade* of software titles currently running on the host (:code:`impacted_process` attribute of the WAPT package), the WAPT Exit utility may be run with the argument :code:`-only_if_not_process_running`. .. code-block:: batch waptexit.exe -only_if_not_process_running = True If not specified, the WAPT Exit utility will take the value indicated in :file:`C:\\Program Files (x86)\\wapt\\wapt-get.ini`. Launching the installation of WAPT packages with a special level of priority ============================================================================ To tell WAPT to only upgrade WAPT packages with a specific priority, you can run the WAPT Exit utility with the argument :code:`-priorities`. .. code-block:: batch waptexit.exe -priorities = high Registering/ unregistering the WAPT Exit utility ================================================ .. CLARIFY, ça veut dire quoi "To register or unregister the WAPT Exit utility in local shutdown group strategy scripts" To register or unregister the WAPT Exit utility in local shutdown group strategy scripts, use: * to enable the WAPT Exit utility at host shutdown: .. code-block:: bash wapt-get add-upgrade-shutdown * to disable the WAPT Exit utility at host shutdown: .. code-block:: bash wapt-get remove-upgrade-shutdown Video demonstration =================== .. youtube::vjFgpxrWESk **************************************************************** Customizing WAPT for better user acceptance |enterprise_feature| **************************************************************** It is possible to customize WAPT with your company colors to improve user acceptance. 3 components of WAPT are customizable: * the WAPT Exit utility; * the WAPT Self-Service; * the WAPT Message utility. It's possible to use the same logo for all programs. Place the image in :file:`\\templates`. The logo **MUST** be named :file:`wapt-logo.png` .. note:: The recommended size of the logo is 200X55 and the format :file:`.png` For a different logo per program, see next points. The WAPT Exit utility ===================== It is possible to customize the WAPT Exit utility by placing the image you want in :file:`\\templates` The logo **MUST** be named :file:`waptexit-logo.png` .. note:: The recommended size of the logo is 200X55 px and the format :file:`.png` .. warning:: If it is not defined, WAPT uses :file:`wapt-logo.png`. If it does not exist, use a default WAPT logo. WAPT Self-Service ================= It is possible to customize the WAPT Exit utility by placing the image you want in :file:`\\templates` The logo **MUST** be named :file:`waptself-logo.png` .. note:: The recommended size of the logo is 200X55 px and the format :file:`.png` .. warning:: If it is not defined, WAPT uses in order :file:`waptexit-logo.png`, :file:`waptself-logo.png` and finally the default WAPT logo. WAPT Message ============ It is possible to customize the WAPT Exit utility by placing the image you want in :file:`\\templates` The logo **MUST** be named :file:`waptmessage-logo.png` .. note:: The recommended size of the logo is 200X55 px and the format :file:`.png` .. warning:: If it is not defined, WAPT uses in order :file:`waptexit-logo.png`, :file:`waptself-logo.png` and finally the default WAPT logo.