.. _system-admin:

==============
 System Admin
==============

.. |admin-add-link| image:: ./_static/admin-add-link.png

Overview
========

The *System Admin* section of the site allows for the modification of settings
and other parts of the database. This is necessary in order to setup default
objects such as competency scores, types of training tasks, and what sequences
are included in particular training tasks.

.. warning::

   Making incorrect settings or using the *System Admin* setting in correctly
   may result in either the **site being unavailable** or in **loss of data**.

   As such, **be careful** making changes through this admin site, and please
   *contact the* |sysadmin| if there are any questions or if any assistance is
   required.

.. _admin-access:

Accessing the System Admin
--------------------------

The *System Admin* pages can be accessed only by members of the ``sysadmin``
group. To access the admin site, either:

1. Go to the admin site directly at http://training.airnorth.com.au/admin/sysadmin
2. Click on the ``System Admin`` link in the *Admin* menu

Use of the Site
----------------

The user interface for the *System Admin* site is the same for all of the
different modules that make up the site.

Authentication and Authorization
================================

.. _admin-group-management:

Group Management
----------------

Groups for the site are designed to be managed through a text-based settings
file stored on the web server. Whilst changes to groups and permissions *can*
be made through this module, this is not recommended.

The security and access restrictions for the site can **only** be assured if
the groups and permissions are loaded from the permissions file stored on the
server.

.. warning::

   **Changing the groups and associated permissions may compromise the security
   and access restrictions of the site.**

.. _admin-user-management:

User Management
---------------

Most of the necessary changes for user management can be performed through the
:ref:`user-management` part of the site. However, the *System Admin* section of
the site allows for the following additional actions to be performed:

- Resetting a User's password
- Setting additional permissions for a User
- Setting whether a User can login to the site
- Setting whether a User receives email alerts and notifications

.. _admin-edit-profile:

Editing a User's Profile Through the Admin Site
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To edit a User's profile through the admin site:

1. Login to the admin site (see :ref:`admin-access`) and click on the ``Users`` module
#. Select the User whose password is to be changed on the *Select user to
   change* page.

.. _admin-change-password:

Resetting a User's Password in System Admin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To reset a User's password:

#. Selecting the User's profile as described in :ref:`admin-edit-profile`
   section
#. Click on the link at the top of the page to reset the User's password
#. Enter the new password for the User in the *Change Password* page and click
   submit

Note that the User isn't notified of this password change by the system for
security reasons. As such, the System Administrator who changes the password
must let the User know what their new password is.

.. caution::

   Electronic means of communication such as (unencrypted) email and online
   messaging services are **not** secure for the purpose of communicating the
   new password to the User.

   Communicating a new password to a User using unencrypted email (etc.) *may
   result in the security of the site being* **compromised**.

.. warning::

   **Passwords should not be re-used on multiple sites**

   Re-using a password that's already in use for a User may result in
   **compromising the security** of **both** the *Training Portal* and any
   other sites the password was used on.

Setting Additional Permissions for a User
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

As described in the :ref:`admin-group-management` section, the permissions for
a User are controlled through that User being a member of a particular
Group. As mentioned in that section, making changes to a User's permissions
outside this framework **may compromise the security and access of the site**.

Nonetheless, it *may* be necessary to change an individual permission for an
individual User. If so, this action can be performed by:

1. Selecting the User's profile as described in :ref:`admin-edit-profile`
   section
#. Scrolling to the *User Permissions* section of the *Change User* page
#. Enabling *individual* permissions for a User by selecting them in the left-
   or right-hand panel and clicking on the arrows to move the permissions.

   Permissions are activated when they're in the *Chosen* box on the right-hand
   panel.

.. note::

   It is *normal* for no permissions to be chosen for a User, as the
   permissions for that User are set by the Groups that the User belongs to.

Setting Whether a User can Login to the Site
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The normal way to prevent a User from accessing the site is to make their
account *Inactive* through the :ref:`user-management` section of the site. (See
the :ref:`user-remove` section of this users guide for details on how to make a
User *inactive*).

However, some User profiles need to remain active, even though the User should
not be able to login to the site. For example, the *Engineering* account may
need to remain active to assigned maintenance training tasks to that
account/User, however there's not need for this account to be able to login to
the site, and so the login should be disabled to reduce the chance of
unauthorised access.

To set whether a User can login to the site:

1. Select the User's profile as described in :ref:`admin-edit-profile`
   section
#. Scroll down to the *Can login* checkbox.
#. If the *Can Login* box is ticked then the User will be able to login to the
   site.

   To prevent a User from logging in to the site, un-tick the checkbox and then
   click *Save*.

Setting Whether a User Receives Email Alerts
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For the :ref:`email-alerts` module of the site, email alerts are sent to
nominated Users when a task is not scheduled, when it is due to expire, has
expired, or has not been completed as scheduled. These notifications are sent
to User's where the *Receives Email Alerts* setting is selected.

To set whether a User receives these email alerts:

1. Select the User's profile as described in :ref:`admin-edit-profile`
   section
#. Scroll down to the *Receives email alerts* checkbox at the very bottom of
   the page
#. If the *Receives email alerts* box is ticked then the User will receive the
   emails sent from the site.

   To change whether a User receives these alerts, tick or un-tick the checkbox
   (as appropriate), and then click *Save*

Documents
=========

The *Documents* section of the *System Admin* site allows for modification of
the *Document Types* and document *Categories*.

.. caution::

   Whilst the *Documents* themselves can be modified through the *System Admin*
   site, they are best managed through the :ref:`documents` module of the site.

   Modifying a *Document* directly through the *System Admin* site may result
   in data loss and/or a failure to follow normal system processes and logic.

Document Types
--------------

The *Document Type* is used to group Documents on the main document index
page. Each type of document is displayed in a table on the main *Document
Index* page.

Documents can also be filtered and searched by the document type.

Examples of document types *may* include:

- Forms
- Company Operations Manual
- Training/Users Guides

Adding Document Types
~~~~~~~~~~~~~~~~~~~~~

To add a *Document Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Document types`` module
#. Click on the *Add document type* link at the top-right of the *Select
   document type to change* page.

.. note::

   *Document Types* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on the main *System Admin*
   pages.

Editing Document Types
~~~~~~~~~~~~~~~~~~~~~~

To edit, or delete a *Document Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Document types`` module
#. Select the *Document Type* which is to be changed on the *Select document
   type to change* page.

Category
--------

Document *Categories* are *tags* which can be further used to group and
classify documents. Like with *Document Types*, documents can be search and
filtered by category.

Unlike document types, the category a document belongs to doesn't affect where
it appears on the index page. A document's categories are displayed in the
listing for the document on the index page.

Examples of document types *may* include:

- Controlled vs Uncontrolled
- Fleet type (e.g. M23, EMB120, ERJ170)
- Training program (e.g. recurrent, intake, type rating, etc.)

Adding a Category
~~~~~~~~~~~~~~~~~

To add a *Category*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   Document ``Category`` module
#. Click on the *Add category* link at the top-right of the *Select
   category to change* page.

.. note::

   A document *Category* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing A Category
~~~~~~~~~~~~~~~~~~

To edit, or delete a document *Category*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Category`` module
#. Select the document *Category* which is to be changed on the *Select
   category to change* page.

Email Alerts
============

.. note::

   The data in this section of the *System Admin* site does **not** need to be
   setup or modified in order for the site to operate normally.

The *Email Alerts* module is used to store data about emails that are sent to
candidates and trainers. Two modules available in this section of the *System
Admin* site:

Email Alert Logs
  This module stores data that's used to send alerts to admin staff about
  training tasks that are about to expire, or which have expired.

  This data is available for review and audit about what alerts were sent, but
  does not otherwise require modification or changing.

Task Notification Stack
  The task notification stack contains information that's used to send alerts
  to candidates and trainers about scheduled training tasks.

  Again, this data is available for review purposes only, and it does not
  otherwise require modification or changing.

Exams
=====

The *Exams* section of the admin site allows for the management of the *Topics*
that are used to group questions in exams.

.. caution::

   Whilst individual *Exams*, *Questions*, and *Answers* may be modified
   through the *System Admin* site, they are best managed through the
   :ref:`exams` module of the site.

   Modifying an *Exam*, *Question*, or *Answer* directly through the *System
   Admin* site may result in data loss and/or a failure to follow normal system
   processes and logic.

Topics
------

A *Topic* is a group or tag that a question belongs to. When an exam is
created, all questions which belong to a particular topic are goruped together
in the exam.

The exams are also setup such that *at least one* question from each topic
selected is included in the exam.

Adding a Topic
~~~~~~~~~~~~~~

To add a *Topic*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   Exam ``Topics`` module
#. Click on the *Add topic* link at the top-right of the *Select
   topic to change* page.

.. note::

   A document *Topic* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing A Category
~~~~~~~~~~~~~~~~~~

To edit, or delete an exam *Topic*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Topics`` module
#. Select the exam *Topic* which is to be changed on the *Select category to
   change* page.

Instrument Register
===================

The *Instrument Register* section of the *System Admin* site allows for the
management of the CASA Offices.

.. caution::

   Whilst the *CASA Instruments* and *Omnibuses* themselves can be modified
   through the *System Admin* site, they are best managed through the
   :ref:`instruments` module of the site.

   Modifying a *CASA Instrument* or *Omnibus* directly through the *System
   Admin* site may result in data loss and/or a failure to follow normal system
   processes and logic.

CASA Offices
------------

A *CASA Office* keeps track of what office has issued a particular CASA
instrument or approval.

Adding a CASA Office
~~~~~~~~~~~~~~~~~~~~

To add a *CASA Office*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   Exam ``CASA Officers`` module
#. Click on the *Add casa office* link at the top-right of the *Select
   casa office to change* page.

.. note::

   A *CASA Office* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing A Category
~~~~~~~~~~~~~~~~~~

To edit, or delete a *CASA Office*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``CASA Offices`` module
#. Select the *CASA Office* which is to be changed on the *Select casa office
   to change* page.

.. _admin-resources:

Resources
=========

The *Resources* part of the *System Admin* site allows for management of the
following models:

Aircraft Types:
  The *Aircraft type* is used to classify what fleet a *User* belongs to.

  Each *Aircraft Type* has a *Designator* and a longer *Description*. The
  *Designator* appears on training and checking records and the various indices
  and reports.

Ranks:
  A *Rank* is used to classify *Users*. Common ranks which are used include
  *First Officer* and *Captain*.

Results:
  A *Result* is used to record the outcome of training and checking tasks.

.. _admin-aircraft-type:

Aircraft Types
--------------

Adding Aircraft Types
~~~~~~~~~~~~~~~~~~~~~

To add an *Aircraft Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Aircraft types`` module
#. Click on the *Add aircraft type* link at the top-right of the *Select
   aircraft type to change* page.

.. note::

   *Aircraft Types* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on the main *System Admin*
   pages.

Editing Document Types
~~~~~~~~~~~~~~~~~~~~~~

To edit, or delete a *Aircraft Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Aircraft types`` module
#. Select the *Aircraft Type* which is to be changed on the *Select aircraft
   type to change* page.

.. _admin-rank:

Ranks
-----

Adding a Rank
~~~~~~~~~~~~~

To add a *Rank*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Rank`` module
#. Click on the *Add rank* link at the top-right of the *Select
   rank to change* page.

.. note::

   a *Rank* can also be added directly by clicking on the |admin-add-link|
   button on the applicable entry on the main *System Admin* pages.

Editing Document Types
~~~~~~~~~~~~~~~~~~~~~~

To edit, or delete a *Rank*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Rank`` module
#. Select the *Rank* which is to be changed on the *Select rank to change*
   page.

.. _admin-results:

Results
-------

The *Results* model has 2 fields:

Result:
  This is a positive or negative *integer* which is used to classify the
  result. Three results **must** be defined in order for the system logic in
  the *Training Tasks* and *Training Records* modules to work correctly:

  - **-1:** This is the *default* result, and indicates that the task has not
    yet been completed.
  - **0:** This indicates that the task has been *completed in full* and the
    *required standard/outcome* has been achieved.
  - **1:** This indicates that the task has been *completed in full*, but that
    the *required standard/outcome* **was not achieved**.

  .. caution::

     Changing the value of these numerical *Result* fields *may cause the
     Training Tasks and Training Records modules to* **cease functioning**.

Choice:
  The *Choice* is the text which is displayed on the training records and
  training task when a particular result has been achieved.

  The label used for the *Choice* field should reflect the meaning of the
  *Result* field as described above.

Adding a Result
~~~~~~~~~~~~~~~

To add a *Result*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Results`` module
#. Click on the *Add result* link at the top-right of the *Select result to
   change* page.

.. note::

   A *Result* can also be added directly by clicking on the |admin-add-link|
   button on the applicable entry on the main *System Admin* pages.

Editing a Result
~~~~~~~~~~~~~~~~

To edit, or delete a *Aircraft Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Aircraft types`` module
#. Select the *Aircraft Type* which is to be changed on the *Select aircraft
   type to change* page.

.. _admin-sites:

Sites
=====

The *Sites* framework for the site is used to ensure that the database and
program are matched up with the right web server and address for the site.

These settings are setup when the site is first hosted, and shouldn't require
modifications or changes unless the hosting arrangements for the site are
changed.

If this is believed to be causing problems for managing the site, contact the
|sysadmin| to have the problem investigated and addressed.

.. _admin-training-packages:

Training Packages
=================

The *Training Packages* module supports the system that's used to control and
manage the training packages maintained by the T&C organisation.

In practice, only the *Package Type* should be managed through this interface,
as the management of the *Packages* themselves is fully automated.

.. caution::

   Whilst individual *Training Packages* may be modified through the *System
   Admin* site, they are best managed through the :ref:`exams` module of the
   site.

   Modifying an individual *Package* directly through the *System Admin* site
   may result in data loss and/or a failure to follow normal system processes
   and logic.

For details on how the *Training Packages* work and are managed, see the
:ref:`packages` section of this documentation.

.. _admin-package-type:

Package Type
------------

A *Package Type* is used to classify and group packages on the *Training
Package* index page.

*Package Types* are allocated to particular *Training Packages* using the
interface provided in the normal site. See the :ref:`packages` section of this
documentation for details.

Adding a Package Type
~~~~~~~~~~~~~~~~~~~~~

To add a *Package Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Package Type`` module
#. Click on the *Add package type* link at the top-right of the *Select package
   type to change* page.

.. note::

   A *Package Type* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing A Package Type
~~~~~~~~~~~~~~~~~~~~~~

To edit, or delete a *Package Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Category`` module
#. Select the *Package Type* which is to be changed on the *Select
   package type to change* page.

.. _admin-training-records:

Training Records
================

The *Training Records* component of the *System Admin* site allows the
following models to be managed and controlled:

- Assessment markers
- Instrument approaches
- Score classes

.. caution::

   Whilst individual *Training Records* and *Scores8 may be modified through
   the *System Admin* site, they are best managed through the
   :ref:`training-records` module of the site.

   Modifying an individual *Training Record* or *Score* directly through the
   *System Admin* site may result in data loss and/or a failure to follow
   normal system processes and logic.

Changing Training Records
-------------------------

Security of Records
~~~~~~~~~~~~~~~~~~~

As a matter of principle, *Training Records* which have been entered and
accepted by the Trainer **should not** be modified or changed. However, in
cases where obvious data entry errors have occurred (e.g. no scores recorded),
the record *may* be re-opened to be edited and corrected.

Reopening a Closed Training Record
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To re-open a close training record:

1. Open the *Training Record* using the procedure set out in the
   :ref:`training-record-complete` section of this document.

2. Change the *Trainer Status* and *Candidate Status* fields to **Open**.

After the *Trainer Status* field has been set to open, the trainer will be able
to re-open and edit the training record from either their home screen,
the *Training Task Index*, or the *Training Record Index*.

.. _admin-assessment-marker:

Assessment Markers
------------------

*Assessment Markers* are used to record areas of weakness or areas to improve
in a training or checking task. They are also known as *Reason Codes*.

The following fields can be defined for an *Assessment Marker*:

Sort order:
  This field determines the order in which the marker is displayed on the
  training and checking records.

  *Assessment Markers* are ordered in *ascending order* based on this field
  (i.e. fields with a *smaller* sort order number appear first).

Marker key:
  The *Marker Key* is the *single letter* abbreviation for the *Assessment
  Marker* that appears on the training and checking record.

Marker value:
  The *Marker Value* is the text that's displayed on the training and checking
  record to explain what the assessment marker means.

Adding an Assessment Marker
~~~~~~~~~~~~~~~~~~~~~~~~~~~

To add an *Assessment Marker*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Assessment Marker`` module
#. Click on the *Add assessment marker* link at the top-right of the *Select
   assessment marker to change* page.

.. note::

   An *Assessment Marker* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing An Assessment Marker
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To edit, or delete an *Assessment Marker*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Assessment marker`` module
#. Select the *Assessment Marker* which is to be changed on the *Select
   assessment marker to change* page.

.. _admin-instrument-approach:

Instrument Approaches
---------------------

The *Instrument Approaches* are displayed on the training and checking record
to indicate what instrument approaches, or other specialist sequences, were
completed during a training or checking task.

The following fields can be defined for an *Instrument Approach*:

Sort order:
  This field determines the order in which the marker is displayed on the
  training and checking records.

  *Instrument Approaches* are ordered in *ascending order* based on this field
  (i.e. fields with a *smaller* sort order number appear first).

Key:
  The *Key* is the *single letter* abbreviation for the *Instrument Approach*
  that is recorded in the database for that particular approach type.

  The *Key* **does not** appear on the training and assessment record.

Value:
  The *Value* is the text that's displayed on the training and checking
  record for the selected instrument approach.

Adding an Instrument Approach
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To add an *Instrument Approach*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Instrument Approach`` module
#. Click on the *Add instrument approach* link at the top-right of the *Select
   instrument approach to change* page.

.. note::

   An *Instrument Approach* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing An Instrument Approach
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To edit, or delete an *Instrument Approach*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Instrument Approach`` module
#. Select the *Instrument Approach* which is to be changed on the *Select
   instrument approach to change* page.

.. _admin-score-class:

Score Class
-----------

A *Score Class* are the scores that are awarded for each sequence on a training
record to indicate the level of competency achieved by the candidate. Typical
examples for a *Score Class* include *Competent*, *Not Competent*, *Not
Assessed* (etc.).

The following fields need to be defined for for a *Score Class*:

Sort Order:
  This field determines the order in which the score class is displayed on the
  training and checking records.

  *Score Classes* are ordered in *ascending order* based on this field
  (i.e. fields with a *smaller* sort order number appear first).

Score Key:
  The *Score Key* is a *short* abbreviation for the *Score Class* that is shown
  at the top of each score class column on the training and checking record.

Score Value:
  The *Score Value* is a longer description of what the *Score Key* means. It
  is shown on an explanatory section of the training and checking record, and
  should be brief but direct regarding the score class's meaning.

  For example, the *Score Key* of *C* may have a *Score Value* of *Competent*
  to explain what the ``C`` abbreviation *means*.

is_active:
  This is a boolean (true/false) setting to determine whether or not the score
  is activated.

  Scores that are *inactive* (i.e. the ``is_active`` box is *not* checked) are
  hidden/not displayed for selection when editing a training record.

Score Weight:
  The Score Weight selects whether the score indicates a good or bad result.

  This field is necessary because good and bad results may be called different
  things in different training and checking systems, even though they have a
  similar meaning (e.g. *Not Competent* may alternatively be *Not Yet
  Competent*, or *Poor*, *Below Standard*, etc.).

  The setting of this field affects the *validation* logic used to process the
  form, and so errors in this field may lead to unexpected effects when
  training and checking record forms are submitted.

Adding a Score Class
~~~~~~~~~~~~~~~~~~~~

To add a *Score Class*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Score Classs`` module
#. Click on the *Add score class* link at the top-right of the *Select
   score class to change* page.

.. note::

   A *Score Class* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing a Score Class
~~~~~~~~~~~~~~~~~~~~~

To edit, or delete a *Score Class*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Score Classs`` module
#. Select the *Score Class* which is to be changed on the *Select
   score class to change* page.

.. _admin-training-tasks:

Training Tasks
==============

The *Training Tasks* section of the *System Admin* site allows for the
management of the following models:

- Training task *Components*
- Training task *Types*
- *Training Resources*
- *Training Courses*
- *Sequences*
- *Repeat Types*

.. caution::

   Whilst individual *Training Tasks* may be modified through the *System
   Admin* site, they are best managed through the :ref:`training-tasks`
   module of the site.

   Modifying an individual *Training Task* directly through the *System Admin*
   site may result in data loss and/or a failure to follow normal system
   processes and logic.

Training Tasks
--------------

.. warning::

   *Training Tasks* should normally only be managed and edited through the
   :ref:`training-tasks` section of this site.

   Changing a *Training Task* directly through the admin site may lead to a
   loss of data, or a failure to follow the normal business logic included in
   the site.

   **It is strongly advised that the** |sysadmin| **is contacted before making
   changes to a Training Task through the admin site.**

In spite of the above warning, the *status* of a *Training Task* may viewed or
changed if problems have occurred with the site. The following fields are
available for *Training Tasks*:

Task Type:
  The *Training Task Type* that defines the details of the task.

  See :ref:`admin-training-task-type` section of this documentation for further
  details.

Candidate:
  The *User* who is assigned to complete the task as the *candidate* (i.e. the
  student, trainee, or person being checked).

Trainer:
  The *User* who has been assigned to complete the task.

Aircraft Type:
  The *Aircraft Type* or fleet that the task applies to.

Due Date:
  The date by which the task must be completed.

  The *Due Date* is used to send email alerts when a task hasn't been scheduled
  or completed a certain number of days prior to the due date.

Scheduled Date:
  The date that a task has been rostered or scheduled to be completed.

Completed Date:
  The date that a task was completed.

Result:
  The result of the task.

  See the :ref:`admin-results` section of this documentation for details of the
  choices available for this field.

Is Active:
  Sets whether the *Training Task* is active or not. *Training Tasks* that are
  *not* active are not shown on the various training task indexes.

Is Remedial:
  Sets whether the task is part of a remedial training program for a candidate.

  .. note::

     This value is usually set automatically by the normal site when a task is
     completed to an *Unsatisfactory* standard.

Ignore Repeat:
  If this setting is checked then *no* new task is created when the task is
  completed.

Remarks:
  This field includes comments or notes for a particular task.

  Note that these comments are included in emails that are sent to both the
  candidate and the trainer.

Is Filed:
  If this field is checked then it indicates that the training record for task
  has been filed.

Filing Date:
  This field records the date the training record was filed.

Filing User:
  This field records the *User* who filed the training record.

Is Checked:
  If this field is checked then it indicates that the training record for the
  task has been checked by the FTM or their delegate.

Checked Date:
  This field records the date that the training record was checked by the FTM
  or their delegate.

Checked User:
  This field records the *User* who checked the training record (either the FTM
  or their delegate).

Adding a Training Task Component
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. warning::

   **It is not recommended for Training Tasks to be created using the System
   Admin site.**

   To Add a *Training Task*, use the *Add Task* function available through the
   *normal* site. See the :ref:`training-tasks` section of this documentation
   for details on how to do this.

Editing a Training Task Component
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. warning::

   **Editing** or **deleting** a *Training Task* may result in **data loss that
   is unrecoverable**.

   Please contact the |sysadmin| for assistance if a *Training Task* is to be
   deleted or changed.

To view, edit, or delete a *Training Task*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Training Task`` module
#. Select the *Training Task* which is to be changed on the *Select training to
   change* page.

.. _training-task-component:

Training Task Component
-----------------------

A *Training Task Component* is used to classify what type of training program a
task belongs to. Typical training program components may include:

- Initial training
- Recurrent training

The following fields need to be defined for a *Component*:

Name:
  The name of the training task component.

Is Active:
  Sets whether the *Component* is active or not. *Components* that are *not*
  active are not shown on the various training task indexes.

Adding a Training Task Component
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To add a *Training Task Component*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Training Task Component`` module
#. Click on the *Add training task component* link at the top-right of the
   *Select training task component to change* page.

.. note::

   A *Training Task Component* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing a Training Task Component
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To edit, or delete a *Training Task Component*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Training Task Component`` module
#. Select the *Training Task Component* which is to be changed on the *Select
   training task component to change* page.

.. _training-resource:

Training Resource
-----------------

A *Training Resource* is used to classify what training resources are used to
conduct a training task. Typical training resources may include simulators,
actual airctraft, or ground training facilities.

The following fields need to be set for a *Training Resource*:

Name:
  The name of the *Training Resource*.

  This value is used on the various training task indexes for the site.

Description:
  A longer description of the what the *Training Resource* is and/or is used
  for.

Is Active:
  Sets whether the *Training Resource* is active or not. *Training Resources*
  that are *not* active are not shown on the various training task indexes.

Adding a Training Resource
~~~~~~~~~~~~~~~~~~~~~~~~~~

To add a *Training Resource*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Training Resources`` module
#. Click on the *Add training resource* link at the top-right of the
   *Select training resource to change* page.

.. note::

   A *Training Resource* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing a Training Resource
~~~~~~~~~~~~~~~~~~~~~~~~~~~

To edit, or delete a *Training Resource*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Training Resources`` module
#. Select the *Training Resource* which is to be changed on the *Select
   training resource to change* page.

.. _sequences:

Sequences
---------

A *Sequence* is an event, manoeuvre, or activity that is performed during a
*Training Task*. Examples of things that are *Sequences* include:

- Takeoff
- Landing
- Aviation knowledge

The following fields need to be defined for a *Sequence*:

Sequence ID:
  The sequence ID is a one or two letter abbreviation that is used for the
  *Sequence* on the training records.

Sequence Label:
  The sequence label is a short phrase that describe the sequence. It appears
  on the training record and performance reports.

Sort Order:
  The sort order determines the order in which the marker is displayed on the
  training and checking records.

  *Sequences* are ordered in *ascending order* based on this field (i.e. fields
  with a *smaller* sort order number appear first).

Has Marker:
  This field determines whether this sequence has *Assessment Markers*
  associated with it.

  If this field is checked, then all of the active *Assessment Markers* are
  displayed next to this sequence on the training record.

Is Active:
  Sets whether the *Sequence* is active or not. *Sequences* that are *not*
  active are not shown on the various training task indexes.

Adding a Sequence
~~~~~~~~~~~~~~~~~

To add a *Sequence*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Sequences`` module
#. Click on the *Add sequence* link at the top-right of the *Select sequence to
   change* page.

.. note::

   A *Sequence* can also be added directly by clicking on the |admin-add-link|
   button on the applicable entry on main *System Admin* pages.

Editing a Sequence
~~~~~~~~~~~~~~~~~~

To edit, or delete a *Sequence*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Sequences`` module
#. Select the *Sequence* which is to be changed on the *Select sequence to
   change* page.

.. _admin-repeat-type:

Repeat Types
------------

A *Repeat Type* sets the timeframe and condition used to calculate the new due
date when a *Training Task* is completed. For instance, the settings for this
model allow a task to be repeated annually, or monthly, and at the end of the
month, or on a specific date, etc.

.. caution::

   The *Repeat Types* for the training tasks in use have been created and
   *tested* using automated unittests to ensure that they produce the required
   results.

   If changes are made to the *Repeat Types* then this may affect the
   reliability or accuracy of the due dates which are automatically calculated
   for training and checking tasks.

   If detailed changes to the *Repeat Types* are required, please contact the
   |sysadmin| for assistance.

The following fields need to be set for a *Sequence*:

Label:
  The label is used in the menu entry in the *Training Task Type* admin pages
  to select the *Repeat Type* that applies to that training task.

Does Repeat:
  If this field is checked then a *new* training task is created when a
  training task is completed.

  If this field is *not* checked, then *no* new training task is created when a
  training task is completed.

Interval:
  The interval is a number that sets the number of days, months, or years later
  that the new due date for a repeating task.

  .. note::

     Whether the interval is months, days, or years is set by the *Interval
     Type* setting.

Interval Type:
  The interval type sets whether the interval number refers to days, months, or
  years.

Window of Opportunity Type:
  The window of opportunity type sets whether the number set in the *Window of
  Opportunity* field refers to days, months, or years.

Window of Opportunity:
  A window of opportunity refers to a grace period before the due date such
  that if the task is completed within the window of opportunity then the new
  due date is set based on the original due date.

End of Month:
  If the *End of Month* checkbox is selected, then the new due date for a task
  is *always* set to the last calendar month in which the training task falls
  due.

Fixed Date:
  If the *Fixed Date* checkbost is selected, then the new due date is *always*
  calculated based on the original due date.

Adding a Repeat Type
~~~~~~~~~~~~~~~~~~~~

To add a *Repeat Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Repeat Types`` module
#. Click on the *Add repeat type* link at the top-right of the *Select repeat
   type to change* page.

.. note::

   A *Repeat Type* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing a Repeat Type
~~~~~~~~~~~~~~~~~~~~~

To edit, or delete a *Repeat Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the ``Repeat
   Types`` module
#. Select the *Repeat Type* which is to be changed on the *Select repeat type
   to change* page.

.. _admin-training-task-type:

Training Task Type
------------------

The *Training Task Type* is used to define the properties and characteristics
of training tasks. Examples of the different types of training tasks that can
be defined include:

- Proficiency checks
- Line checks
- Type rating training sessions
- Remedial training sessions

The following fields need to be defined for a *Training Task Type*:

Sort Order:
  The sort order determines the order in which the task is displayed on the
  various training task indexes.

  *Training Tasks* are ordered in *ascending order* based on this field
  (i.e. fields with a *smaller* sort order number appear first).

Name:
  The name of the training task type.

Resource:
  The resource used to complete the training task. The resources available in
  this section are set by the :ref:`admin-resources` section of the *System
  Admin* site.

Repeat Type:
  The repeat type which controls how new tasks are completed to replace a task
  when it is completed. The repeat types available in this section are set by
  the :ref:`admin-repeat-type` section of the *System Admin* site.

Sequences:
  The list of *Sequences* which are trained or checked as part of the training
  task.

  If a training task type has *no* sequences associated with it then it can
  only be marked as either *Satisfactory* or *Unsatisfactory* when it is
  completed.

  If, instead, a training task type has one or more sequences selected in this
  field, then a *Training Record* is created when the task is completed so that
  competency scores (etc.) can be assigned for the task.

Is Active:
  Sets whether the *Training Task Type* is active or not. *Training Task Types*
  that are *not* active are not shown on the various training task indexes.

Component:
  Select the *Training Component* that the task belongs to.

Send Notification:
  If this setting is checked, then email notifications are sent about the task
  when it is completed.

Is Qualification:
  If this setting is checked then the task is treated as a qualification and is
  displayed on the *Crew Qualification Validity* report.

Buffer Period:
  The buffer period applies to qualifications that can be completed the after
  the due date and still be valid.

  (For example, *cyclic* sessions may be completed up to 20 days after the due
  date and the crew remain valid.)

Task Code:
  The task code is used to reference the training task to some other system or
  syllabus that sits outside the *Training Portal*.

  For example, the *Task Code* may be a course or lesson code in an external
  syllabus, or it may be related to a qualification or skill recorded in
  another Company database.

Adding a Training Task Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~

To add a *Training Task Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Training Task Types`` module
#. Click on the *Add training task type* link at the top-right of the *Select
   training task type to change* page.

.. note::

   A *Training Task Type* can also be added directly by clicking on the
   |admin-add-link| button on the applicable entry on main *System Admin*
   pages.

Editing a Training Task Type
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To edit, or delete a *Training Task Type*:

1. Login to the admin site (see :ref:`admin-access`) and click on the
   ``Training Task Types`` module
#. Select the *Training Task Type* which is to be changed on the *Select
   training tasktype to change* page.

Training Courses
----------------

The *Training Courses* are used to group a number of *Training Tasks* into a
course to allow them to be scheduled and removed as a group. *Training Courses*
are normally managed through the :ref:`training-courses` section of the site.