.. Reminder for header structure:
	Parts (H1)			    : #################### with overline
	Chapters (H2)		    : ******************** with overline
	Sections (H3)		    : ====================
	Subsections (H4)	  : --------------------
	Subsubsections (H5) : ^^^^^^^^^^^^^^^^^^^^
	Paragraphs (H6)		  : """"""""""""""""""""

.. |enterprise_feature| image:: wapt-resources/wapt_enterprise.png
  :scale: 3%
  :alt: WAPT Enterprise feature only

.. |ok| image:: wapt-resources/ok.png
  :scale: 5%
  :alt: ok

.. _wapt_console:

######################
Using the WAPT console
######################

To install and start the WAPT console visit the documentation
for :ref:`installing the WAPT console <installing_the_WAPT_console>`.

.. note::

  If you have skipped the step for creating the WAPT agent, return to
  the documentation on :ref:`building the WAPT agent installer <create_WAPT_agent>`.

On your **management computer**, hosts are displayed in the WAPT console.

.. figure:: wapt-resources/wapt_console-registered-clients.png
  :align: center
  :alt: Inventory of hosts registered with WAPT

  Inventory of hosts registered with WAPT

.. note::

  If a host does not appear in the console after having installed the WAPT
  agent, open the Windows command line utility :program:`cmd.exe`
  on the host and type :command:`wapt-get register`.

.. _add_package_on_host:

************************
Add package for the host
************************

If you want to add WAPT packages directly on the host,
you have to edit the host package.

To do so, you have 3 methods:

* Double-click on the host.

* Right-click on the host then :guilabel:`Edit host`.

* Select a host and use the :guilabel:`Edit host` button.

Then, you just have to drag and drop wanted package(s) and confirm.

.. figure:: wapt-resources/wapt_console-add_package_host.gif
  :align: center
  :alt: Method for adding a WAPT package on a host

Pressing :guilabel:`Save` does the same thing as doing an :ref:`update <update_host>`.

Pressing :guilabel:`Save and apply` does the same thing as an :ref:`update
<update_host>` immediatelly followed by an :ref:`upgrade <upgrade_host>`.

.. _update_host:

**************************
Check updates for the host
**************************

.. figure:: wapt-resources/wapt_console-check-updates.png
  :align: center
  :alt: Check updates for the host

This button will execute 2 actions :

1. give current state of the host to the server
2. server displays if the host must get updates

Every configuration modification require a :guilabel:`Check updates`.

.. _upgrade_host:

**************************
Apply updates for the host
**************************

.. figure:: wapt-resources/wapt_console-apply-upgrades.png
  :align: center
  :alt: Apply updates for the host

This button allows to apply waiting updates on the host.

.. warning::

  Use with caution, it will force close the softwares that are currently in use.

  You can use instead :guilabel:`Apply upgrade for not running applications` to prevent any loss of work

  |enterprise_feature|

.. _global_search:

***************************************
Performing a global search on all hosts
***************************************

Performing global searches on all the criteria presented above is possible.

Choose the filters to check or uncheck.

.. figure:: wapt-resources/wapt_console-advanced-search.png
  :align: center
  :alt: Advanced search functionalities in the WAPT console

  Advanced search functionalities in the WAPT console

.. list-table:: Choice of filters
  :header-rows: 1
  :align: center
  :widths: auto

  * - Possible options
    - Description
  * - :guilabel:`Host`
    - :guilabel:`Host` section in the :guilabel:`Hardware inventory`
      tab when a host is selected
  * - :guilabel:`Hardware`
    - :guilabel:`DMI` section in the :guilabel:`Hardware inventory`
      tab when a host is selected
  * - :guilabel:`Software`
    - :guilabel:`Software inventory` section when a host is selected
  * - :guilabel:`Package`
    - List of packages installed on the selected hosts
  * - :guilabel:`Has errors`
    - Search only for hosts for which a task has not finished correctly
  * - :guilabel:`Needs updating`
    - Search only for hosts needing upgrades
  * - :guilabel:`Connected only`
    - Search only for connected hosts
  * - :guilabel:`Only authorized computers`
    - Search only for hosts authorized by certificate of current console user
  * - :guilabel:`WAPT Group`
    - Filter hosts based on their membership / dependency to a WAPT group package
  * - :guilabel:`AD Site`
    - Filter hosts based on their membership / dependency to a Site on Active Directory
  * - :guilabel:`AD Group`
    - Filter hosts based on their membership / dependency to a Active Directory group

.. hint::

  Filters work with `regular expression <https://en.wikipedia.org/wiki/Regular_expression>`_.

*********************
Showing the inventory
*********************

When the WAPT agents :command:`register`, they send some information
to the WAPT Server.

Information displayed in the console is not updated in real-time, you have
to refresh the display to view new status and information.

Click on the :guilabel:`Refresh` button or press :kbd:`F5` on the keyboard.

.. figure:: wapt-resources/wapt_console-main-grid.png
  :align: center
  :alt: WAPT console displaying inventory

  WAPT console displaying inventory

The WAPT console lists hosts that are registered with the WAPT Server
and some information that is useful for managing the hosts.

Selecting a host displays its information in the right panel of
the WAPT console (:guilabel:`Hardware inventory` and
:guilabel:`Software inventory`).

More détail :ref:`here <console_host_inventory>`.

************************************
How to perform actions on the hosts?
************************************

.. figure:: wapt-resources/wapt_console-host-configuration-menu.png
  :align: center
  :alt: Host configuration menu

  Host configuration menu

Some actions are note present in multi selection, cf :

.. list-table:: List of actions available to be performed on the hosts from the WAPT console
  :header-rows: 1
  :widths: auto
  :align: center

  * - Name
    - Multi-selection
  * - Edit host
    - **no**
  * - Check updates
    - **yes**
  * - Apply upgrades
    - **yes**
  * - Apply upgrades for applications not currently running
    - **yes**
  * - Propose upgrades for applications not currently running
    - **yes**
  * - Send a message to users
    - **yes**
  * - Run package audits
    - **yes**
  * - Add packages to host dependencies
    - **yes**
  * - Remove packages from host dependencies
    - **yes**
  * - Re-sign *host* packages
    - **yes**
  * - Add package to host conflicts
    - **yes**
  * - Remove package from host conflicts
    - **yes**
  * - Remove the host
    - **yes**
  * - Connect via RDP
    - **no**
  * - Remote Assistance
    - **no**
  * - Mesh remote desktop
    - **yes**
  * - Windows Computer management
    -
  * - Update AD Group Policies on hosts
    - **yes**
  * - Run CleanMgr on host
    - **no**
  * - Computer management
    - **no**
  * - Local users and groups management
    - **no**
  * - Service management
    - **no**
  * - Power ON with WakeOnLan
    - **yes**
  * - Reboot computers
    - **no**
  * - Shutdown computers
    - **no**
  * - Trigger the scan of missing Windows updates
    - **yes**
  * - Trigger the download pending Windows updates
    - **yes**
  * - Trigger the install of pending Windows updates
    - **yes**
  * - Refresh host inventory
    - **yes**
  * - Trigger a restart of waptservice
    -  **yes**

.. note::

  For description of these actions, visit to :ref:`this documentation
  <detailled_host_actions>`.

*********************************************
Importing packages from external repository
*********************************************

Package importation principles
==============================

Importing a WAPT package consists of:

* Importing an existing WAPT package from an external repository.

* Changing its prefix (for example from *tis* to *my-prefix*).

* Re-signing the WAPT package with the :term:`Administrator`'s
  or the :guilabel:`Code signing` private key
  to allow the deployment of the imported package on your WAPT equipped hosts.

* Finally, uploading it on the main WAPT repository.

.. attention::

  By importing a package in your repository and signing it, **YOU THEN BECOME
  RESPONSIBLE** for that package and for what it does.
  **It has been signed with your own private key**.

  **Tranquil IT** disclaims any liability if you choose to use WAPT packages
  retrieved from its repositories. Without a support contract, Tranquil IT
  does not guarantee the suitability of the package for your own particular
  use case, nor does she guarantee the ability of the package to comply
  with your :term:`Organization`'s internal security policies.

* Go to the :guilabel:`Private repository` tab.

.. figure:: wapt-resources/wapt_console-import-package-from-internet.png
  :align: center
  :alt: Available software displayed in the WAPT console

  Available software displayed in the WAPT console

Every software package version available on the WAPT repository is shown.

If no package has been imported, the list is empty. Only the *test-waptupgrade*
package will be present if the WAPT agent has been generated previously.
Visit the documentation on :ref:`creating a WAPT agent <create_WAPT_agent>`.

Importing a package from an external repository on the Internet
===============================================================

That first method allows you to download packages directly from a WAPT repository
external to your :term:`Organization`.

By default the Tranquil IT repository is configured,
to add another repository check the documentation for
:ref:`configuring the external repositories <external_repositories_settings>`;

.. note::

  By default, the SSL/ TLS certificates to external repositories are verified.

* Click on :guilabel:`Import package` and :guilabel:`Import from Internet`.

.. figure:: wapt-resources/wapt_console-import-package.png
  :align: center
  :alt: Imported WAPT package

.. note::

  The grid view displays the list of available packages on the remote repository.
  It is possible to choose the architecture, the OS and the locale.

.. figure:: wapt-resources/wapt_console-import-package-into-repository.png
  :align: center
  :alt: Imported WAPT package in your local WAPT repository

* There are 2 methods for importing a WAPT package:

  * :menuselection:`Right-click --> Import in repository`;

  .. figure:: wapt-resources/wapt_console-import-package-options.png
    :align: center
    :alt: Imported WAPT package

  * or in the bottom right of the Window :guilabel:`Import in repository`:

  .. figure:: wapt-resources/wapt_console-import-package-options-2.png
    :align: center
    :alt: Imported WAPT package

* Validate the importation in your local repository.

.. figure:: wapt-resources/wapt_console-confirm-package-import.png
  :align: center
  :alt: Confirm the import of the package

  Confirm the importation of the package

.. note::

  It is possible to :ref:`change the maturity <maturity_import>` of a WAPT package
  before importing the package into your private repository.

* The download of the package starts.

.. figure:: wapt-resources/wapt_console-download-package-in-progress.png
  :align: center
  :alt: Progress of the package importation process

  Progress of the package importation process

* Then, enter your private key password.

.. figure:: wapt-resources/wapt_console-enter-certificate-password.png
  :align: center
  :alt: Entering the password for unlocking the private key

  Entering the password for unlocking the private key

The WAPT console confirms that the package has been imported
in your local WAPT repository.

.. figure:: wapt-resources/wapt_console-package-successfully-duplicated.png
  :align: center
  :alt: Confirmation of successful importation

  Confirmation of successful importation

The package then appears in your local WAPT repository with your Organization's
prefix.

.. figure:: wapt-resources/wapt_console-confirm-package-duplicate.png
  :align: center
  :alt: WAPT console displaying the imported package

  WAPT console displaying the imported package

.. _maturity_import:

Changing the maturity of a WAPT package before importing it into the repository
-------------------------------------------------------------------------------

It is possible to change the maturity of a WAPT package before loading it
into your private repository by choosing **DEV**, **PREPROD** or **PROD**
in :guilabel:`Default package maturity`.

.. figure:: wapt-resources/wapt_console-confirm-package-import.png
  :align: center
  :alt: Choosing the maturity of the WAPT package before import

  Choosing the maturity of the WAPT package before import

Editing a package before importing it
-------------------------------------

It is possible to edit a package downloaded
from an external repository before importing it into your main WAPT repository.

* Pour cela 2 choix disponible :

  * :menuselection:`Right-click --> Download and Edit`;

  .. figure:: wapt-resources/wapt_console-import-package-options.png
    :align: center
    :alt: Download and Edit

    Download and Edit

  * or by clicking :guilabel:`Download and Edit` on the bottom right
    of the window;

.. figure:: wapt-resources/wapt_console-import-package-options-2.png
  :align: center
  :alt: Download and Edit

  Download and Edit

:program:`PyScripter`, if installed, will open the :file:`control`
and :file:`setup.py` files of the WAPT package.

For more information, visit the documentation on :ref:`creating WAPT packages
from scratch <creating_WAPT_packages>`.

**********************************
Importing packages from local file
**********************************

Importing a WAPT package from a file
====================================

You can import a :mimetype:`.wapt` file from any storage.

* Click on :guilabel:`Import package` and then :guilabel:`Import from file`.

.. figure:: wapt-resources/wapt_console-import-package.png
  :align: center
  :alt: Importing a WAPT package from a file

  Importing a WAPT package from a file

* Select the file to import.

.. figure:: wapt-resources/wapt_console-select-file-to-import.png
  :align: center
  :alt: Selecting the file to import

  Selecting the file to import

* Click on :guilabel:`Open` to import the file.

The WAPT console confirms that the package has been imported in your local
WAPT repository.

.. figure:: wapt-resources/wapt_console-package-successfully-imported.png
  :align: center
  :alt: File imported successfully

  File imported successfully

The package then appears in your local WAPT repository with your
Organization's prefix.

.. figure:: wapt-resources/wapt_console-imported-package-in-repository.png
  :align: center
  :alt: Imported WAPT package showing in your local WAPT repository

  Imported WAPT package showing in your local WAPT repository

.. note::

  It is not possible to change the maturity before importing here.

Changing the prefix and re-signing a WAPT package
=================================================

When uploading your new WAPT package to your private repository,
the changing of the prefix and the re-signing of the WAPT package
are transparent and automatic.

*******************************
Managing packages on repository
*******************************

In the :guilabel:`WAPT Packages` tab, the list of packages currently
available in the WAPT repository appears. By default, the console will only
show the latest version of packages.

A search bar is also available to filter packages.
:ref:`It is possible to specify a filter <filter_packages>`.

.. figure:: wapt-resources/wapt_console-filter-packages.png
  :align: center
  :alt: Changing the maturity of a WAPT package

  Changing the maturity of a WAPT package

Displaying all packages
=======================

To display all package versions, untick :guilabel:`Last version only`.

Filtering on package type
=========================

To display a specific package type, use :guilabel:`Filter packages`:

Types of packages are:

  * *all*;

  * *base*;

  * *group*;

  * *profile*;

  * *selfservice*;

  * *unit*;

  * *waptwua*;

.. figure:: wapt-resources/wapt_console-filter-package-category-from-repository.png
  :align: center
  :alt: Filtering on WAPT package type

  Filtering on WAPT package type

Others filters
==============

.. figure:: wapt-resources/wapt_console-others-filter-package-from-repository.png
  :align: center
  :alt: Filtering on other attributes

  Filtering on other attributes

Other available filters are:

* architecture:

  * *x86*;

  * *x64*;

* :abbr:`OS (Operating System)`:

  * *all*;

  * *Windows*;

  * *macOS*;

  * *Linux*;

* locale:

  * en;

  * fr;

  * de;

  * it;

  * es;

* maturity:

  * PROD;

  * PREPROD;

  * DEV;

Doing a search based on a WAPT package
======================================

In the repository, select the package and then click on :guilabel:`Show Hosts`.

The grid will display the hosts on which the package is installed.
Note that the filter is only active on the :guilabel:`Package` attribute
of the selected package.

The different columns display information about the packages installed
on the machine (e.g. *package version*, *package status*, *audit status*,
*installation date*, *architecture*).

.. figure:: wapt-resources/wapt_console-show-hosts-configured-with-selected-package.png
  :align: center
  :alt: Filter by package

  Filter by package

You can also add the columns :guilabel:`Log install`
and :guilabel:`Last Audit Output` to display at a glance the installation
and audit logs.

Changing maturity of a WAPT package after import on a repository
================================================================

When a package is imported on a WAPT repository it is possible to change the maturity
by rigth-clicking on the WAPT package.
Choose your maturity on :menuselection:`Change packages maturity` menu.

.. figure:: wapt-resources/wapt_console-change-maturity-on-repositorie.png
  :align: center
  :alt: Changing the maturity of a WAPT package

Once the maturity chosen a windows pop up:

.. figure:: wapt-resources/wapt_console-change-packages-maturity.png
  :align: center
  :alt: Changing the maturity of a WAPT package

Many choices are available :

.. list-table::
  :header-rows: 1
  :widths: auto
  :align: center

  * - Label
    - Description
  * - :guilabel:`Increment the package version`
    - Increments the packaging version (version number after `-`).
  * - :guilabel:`Delete old packages after successful process`
    - Delete the old WAPT package after having changed the maturity.
  * - :guilabel:`Change package maturity`
    - Configure the new maturity of the WAPT package.
  * - :guilabel:`New packages prefix`
    - Configure a new prefix for the WAPT package.

.. note::

  You can stop the process by pressing the :guilabel:`Abort process` button.

Once finished, the status switches to |ok|.

.. hint::

  You can change the maturity of multiple packages at once

.. warning::

  Changing the maturity of the package will change the hash of the package.

  If the package is used in a GPO, like :program:`waptupgrade`,
  you'll have to change the hash in your GPO.

.. _creating_group_package:

Creating a group package
========================

Group packages allow you to create a package containing other packages
to be affected as dependencies.

To create a group of packages, go to the :guilabel:`WAPT Packages` tab,
then click on the :guilabel:`Make package template from setup file` button
and finally choose :guilabel:`Group`.

.. figure:: wapt-resources/wapt_console-package-group-grid.png
  :align: center
  :alt: Package group grid

  Package group grid

* Change the name in :guilabel:`Package name`.

* Fill in the description.

* Add packages to the group package by dragging
  and dropping them or by Right-clicking on the package name,
  and adding it to the bundle.

.. figure:: wapt-resources/wapt_console-add-packages-to-group.png
  :align: center
  :alt: Creating a group package

  Creating a group package

* Click on :guilabel:`Save` to save the bundle.

.. hint::

  To uninstall a package, it is possible to add is as a forbidden package
  to a package group. The forbidden package, if installed, will be removed
  before other packages are installed.

.. figure:: wapt-resources/wapt_console-configure-forbiden-package.png
  :align: center
  :alt: Adding a forbidden package to a host

  Adding a forbidden package to a host

Removing a WAPT package
=======================

.. figure:: wapt-resources/wapt_console-remove-package-from-repository.png
  :align: center
  :alt: Remove a package

To delete a package from the repository, do a :menuselection:`Right-click
--> Remove from repository`.

.. hint::

  You can select multiple packages at once to delete.

Editing a WAPT package
======================

.. figure:: wapt-resources/wapt_console-remove-package-from-repository.png
  :align: center
  :alt: Editing a WAPT package

  Editing a WAPT package

To edit a package, do a :menuselection:`Right-click --> Edit package`.

The package will be downloaded locally in **the base package development folder**,
set in the :ref:`console settings <console_detailed_advanced_config>`.

If :program:`PyScripter` is installed, it will automatically open the
:file:`control` and :file:`setup.py` files.

Once edited you can upload the package :ref:`using the WAPT console
<build_upload_from_console>`.

Deploying WAPT packages from the WAPT console
=============================================

You can deploy packages on hosts using multiple methods:

* Directly by :ref:`adding a WAPT package to the selected host(s)
  <add_package_on_host>`.

* By :ref:`adding a WAPT package to an Organizational Unit
  <create_edit_ou_packages>` |enterprise_feature| of which the host is a member.

* By :ref:`adding a package to a host profile <wapt_profile_bundles>`
  |enterprise_feature| that is applied to the host.

* By :ref:`adding the package to a group package <creating_group_package>`
  of which the host is a member.