============
Installation
============

:Author:    Stefan Eletzhofer
:Date:      |today|

Prerequisites
=============

To install the **nexiles|gateway file service**, the following conditions
need to be met:

- **nexiles|gatewy** version **1.4.4 or better** installed.
- access to the Windchill server file system granted
- Windchill restart possible / granted
- view plugin page and check licenses

Installation Steps
==================

To install the **nexiles|gateway file service** the following steps need
to be performed:

- copy the needed files to `$WT_HOME/codebase/WEB-INF/lib-python`
- update the **license file**
- update the **nexiles|gateway plugin configuration**
- restart Windchill

Copy files
----------

- locate the **Windchill Home** -- we'll refer to the Windchill home as `WT_HOME`
- locate the `lib-python` directory in the `codebase/WEB-INF` directory
- copy the **plugin package** named `nexiles.gateway.fileservice-VERXION-py2.5.egg` to `lib-python`
- copy the **PTH file** named `fileservice-windows.pth` to `lib-python` **OR**
- copy the **PTH file** named `fileservice-unix.pth` to `lib-python`


Update the License File
-----------------------

Depending on the configuration of the `nexiles.gateway.licensefile` property, copy the license file
for your system to the configured place.

.. note:: The default is `$WT_HOME/nexiles-licenses.json`

Restart Windchill
-----------------

Restart windchill.

Check Licenses
--------------

Navigate to the **nexiles|gateway** home page and view the `plugins` tab.
Check that the **nexiles|gateway fileservice** is listed and has a valid
license.


.. image:: license-check.jpg
   :width: 800px

.. vim: set ft=rst tw=75 nocin nosi ai sw=4 ts=4 expandtab: