# Roster Availability

## Overview <a href="#overview" id="overview"></a>

The Roster Availability is used to records the availability of [users](https://docs.cw.crisisworks.com/system-administration/user-and-contact-administration) (usually staff) for a given shift.&#x20;

Roster Availability is used with the Rostering functions but can be used standalone.

### Positions <a href="#positions" id="positions"></a>

The following table outlines [positions](https://docs.cw.crisisworks.com/concepts-and-fundamentals/concepts-and-fundamentals#events-users-positions-and-duty) that can manage this register and what users with them can do according to their default security policies:

<table><thead><tr><th width="317.5859375">Position</th><th width="408.453125">Description</th><th data-hidden></th></tr></thead><tbody><tr><td>Operations Officer</td><td><ul><li>Add and edit their own availability</li></ul></td><td></td></tr><tr><td>Operations Coordinator</td><td><ul><li>Manage the availability of users</li><li><a href="#bulk-actions">Export</a> availability</li><li>View <a href="#reports">reports</a></li></ul></td><td></td></tr></tbody></table>

Other positions may have similar security policies. A [System Administrato](https://docs.cw.crisisworks.com/system-administration/configuring-the-system/positions)r can establish positions with custom security policies.

### Setup & Configuration <a href="#setup-and-configuration" id="setup-and-configuration"></a>

Refer to: [Configuring the System](https://docs.cw.crisisworks.com/system-administration/configuring-the-system) and [Administration](#administration)

The following steps should be done to configure the system.

1. Enable the register
2. Enable the positions
3. Configure the shifts

#### Enable the register

To enable the register for the Event, [Manage the Event](https://docs.cw.crisisworks.com/system-administration/managing-events) and add the register by ticking it [under registers](https://docs.cw.crisisworks.com/system-administration/managing-events#registers).

#### Enable the positions

To enable users to sign in, [Manage the Event](https://docs.cw.crisisworks.com/system-administration/managing-events) and add the [Roster Availability positions](#positions) by ticking them [under positions](https://docs.cw.crisisworks.com/system-administration/managing-events#positions).&#x20;

Make sure to [add these positions](https://docs.cw.crisisworks.com/system-administration/user-and-contact-administration#positions) to the relevant users.

#### Configure shifts

To configure shifts, use the [Roster Availability lookup](https://docs.cw.crisisworks.com/system-administration/configuring-the-system/lookups). A default 'Main' shift comes pre-installed.

### Access <a href="#access" id="access"></a>

To access the register:

1. [Go on duty](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/working-with-events#setting-your-duties-for-events) with an appropriate [position](#positions). If you can't access it, contact your System Administrator.
2. Locate the *Roster Availability* register under **Operations > Roster Availability** in the menu.&#x20;

<figure><img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2FTlcivlRjA6thdXWWZx0r%2Fimage.png?alt=media&#x26;token=e2021eb7-d4a1-448d-8682-d3f779d59c94" alt="" width="188"><figcaption><p>Location of the Roster Availability register in the module menu</p></figcaption></figure>

{% hint style="info" %}
Note that Relief Registrations must be [enabled for the event](https://docs.cw.crisisworks.com/system-administration/managing-events#registers) by your System Administrator.
{% endhint %}

### Operation <a href="#process" id="process"></a>

Roster Availability records are created either by users or a Coordinator (refer to [Positions](#positions)).

User can [add availability](#adding) if they have access to the register by adding dates, times and shifts that they are rostered on for. Coordinators can also add availability for any user including themselves.

When adding new records, the [Availability](#availability) is set to Available by default, although users can set this to either Available or Unavailable. The Unavailable status will override Available for the same date. So if a user is available for three months except for one week, they can create one 'Available' record for three months and one 'Unavailable' record for one week in the middle.

If you're working on an item it can be set to Draft.&#x20;

For availabilities that have similar date ranges, shifts or users you can use the Template option.

If an item is no longer needed it can be set to Cancelled; Closed (Duplicate); or Closed (Error).

## Finding user availability information <a href="#finding" id="finding"></a>

{% content-ref url="../../concepts-and-fundamentals/on-a-computer/searching-filtering-and-querying-registers" %}
[searching-filtering-and-querying-registers](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/searching-filtering-and-querying-registers)
{% endcontent-ref %}

The find items you can use:

* [Datagrid](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid#data-grid-view) view
* [Filters](#information-editinganexistinginformationitem-1) including Active, Workflow (Available, Unavailable etc) and Unassigned
* A combination of filters and search by most fields

<figure><img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2FicbskWDW9M66ovP6ZJGe%2Fimage.png?alt=media&#x26;token=906db39f-fa77-4894-8158-c5bc331cac4d" alt=""><figcaption><p>Roster Availability datagrid (sample view)</p></figcaption></figure>

### Filters <a href="#filters" id="filters"></a>

Filters help make management of *Roster Availability* easier by focusing on specific groups of items on the datagrid.

<figure><img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2FkwGYc3O50SXAAzu3zdj6%2Fimage.png?alt=media&#x26;token=cfd99d0e-b45d-4691-a56c-e323e1155488" alt="" width="135"><figcaption><p>Filters</p></figcaption></figure>

<details>

<summary>Filter menu explanations</summary>

The following lists some of the filters and how to use them:

<table><thead><tr><th width="247">Filter Group</th><th>Filter/s</th><th>Use</th></tr></thead><tbody><tr><td>Main</td><td>Active</td><td>Finds all Active items (Available, Unavailable or New)</td></tr><tr><td></td><td>Recently Updated</td><td>Finds all items updated in the last 5 days</td></tr><tr><td></td><td>All</td><td>Finds all items in the register</td></tr><tr><td>Total</td><td>Active</td><td>Finds all items with an Date Until less than 30 days away</td></tr><tr><td></td><td>Mine</td><td>Finds all items with you set as the User</td></tr><tr><td>Region</td><td>[List is based on your system configuration]*</td><td>Refer to: <a href="../../../concepts-and-fundamentals/concepts-and-fundamentals#sites-and-regions">Regions</a></td></tr><tr><td>Workflow</td><td>Available</td><td>Finds all items with Status of Available</td></tr><tr><td></td><td>Cancelled</td><td>Finds all items with Status of Cancelled</td></tr><tr><td></td><td>New</td><td>Finds all items with Status of New</td></tr><tr><td></td><td>Unavailable</td><td>Finds all items with Status of Unavailable</td></tr><tr><td>Assignments</td><td>Unassigned</td><td>Finds all items where Assigned is not set</td></tr></tbody></table>

&#x20;\* May vary based on your system configuration

</details>

## Opening and Viewing <a href="#opening-and-viewing" id="opening-and-viewing"></a>

{% content-ref url="../../concepts-and-fundamentals/on-a-computer/using-the-datagrid/viewing-items" %}
[viewing-items](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/viewing-items)
{% endcontent-ref %}

When viewing Roster Availability items, sections can be expanded to show information.

As each section is completed, new sections may show additional information.&#x20;

<figure><img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2FTO4jcR8KdERhlpYxpkJT%2Fimage.png?alt=media&#x26;token=7f0a7e4e-cec6-46a1-bddc-7ab93a6b1e92" alt=""><figcaption><p>Screenshot showing read only view of the General section. The user is available for most of the September.</p></figcaption></figure>

## Settings <a href="#settings" id="settings"></a>

Roster Availability has the following sections:&#x20;

| Left Column                   | Right Column          |
| ----------------------------- | --------------------- |
| [Record Notes](#record-notes) | [Workflow](#workflow) |
| [General](#general)           | [Activity](#activity) |

### Record Notes <a href="#record-notes" id="record-notes"></a>

When editing, record notes in the [rich text field](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/editing-items#rich-text-fields) as you make changes which will appear in the Activity log.

Refer to: [Recording Notes](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/editing-items#recording-notes)

### General

The General section contains the main availability details with the [rich text field](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/editing-items#rich-text-fields) provided.

#### Date From

Use this setting to set the date that the user is available from. This is required.

Refer to: [Setting Dates](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/editing-items#selecting-dates)

#### Date until

Use this setting to set the date that the user is available until. This is required.

Refer to: [Setting Dates](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/editing-items#selecting-dates)

{% hint style="info" %}
It is possible to set a Date until before the Date from, however do not do this as it can affect the availability results.
{% endhint %}

#### Shift

Use this setting to select the shift(s) from the list. This is required.

Once selected, these appear like tags and can be similarly removed by toggling them off the list with the cross.

<figure><img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2FwcyyPupFOcKiYmAV3zZG%2Fimage.png?alt=media&#x26;token=a5295803-6a8a-4c2e-90e8-3156bb6992d6" alt="" width="375"><figcaption><p>Shift setting with Main shift added</p></figcaption></figure>

Shifts are set up by your System Administrator. Refer to: [Setup & Configuration](#setup-and-configuration)

#### Availability

Use this setting to whether the user is Available, Unavailable or something else.

<table><thead><tr><th width="130">Status</th><th width="143">Datagrid Icon</th><th>Notes</th></tr></thead><tbody><tr><td>Available</td><td> <img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2FJx4faPCVMjGLpimVdSgv%2Fimage.png?alt=media&#x26;token=3fb33fa6-e44e-49bb-a85b-3a040d423afb" alt="" data-size="line"></td><td>All new Roster Availability items begin with this status</td></tr><tr><td>Unavailable</td><td>  <img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2FhfWdHjN10aX4l6y6OFWh%2Fimage.png?alt=media&#x26;token=f62b8f29-3caa-477f-afd2-4aca0d31219d" alt="" data-size="line"></td><td></td></tr><tr><td>New</td><td>  <img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2FMLtJHFBAFZ4if5TUb8XD%2Fimage.png?alt=media&#x26;token=979f33c5-6d0f-41cd-9246-f590fbc9c096" alt="" data-size="line"></td><td></td></tr><tr><td>Cancelled</td><td> <img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2F3qs9VMx5qDCTbcx1OpLD%2Fimage.png?alt=media&#x26;token=ebf63464-c58c-472d-8db7-041e79586250" alt="" data-size="line"></td><td></td></tr><tr><td>Closed (Duplicate)</td><td></td><td></td></tr><tr><td>Closed (Error)</td><td></td><td></td></tr><tr><td>Draft</td><td></td><td></td></tr><tr><td>Template</td><td></td><td></td></tr></tbody></table>

#### User <a href="#workflow" id="workflow"></a>

Use this setting to select a user who the availability is for from the list.

#### Details

Use this setting to add details on ths availability. For example, there might be notes about certain days or if the user has limited capacity. They can be added here.

### Workflow <a href="#workflow" id="workflow"></a>

#### Tags

Refer to: [tags](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/tagging-items)

### Activity

Refer to: [Viewing Items: Activity](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/viewing-items#activity)

## Updating <a href="#updating" id="updating"></a>

{% content-ref url="../../concepts-and-fundamentals/on-a-computer/using-the-datagrid/editing-items" %}
[editing-items](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/editing-items)
{% endcontent-ref %}

When updating an item:

* Add notes on your edits in the **Record Notes** field
* Complete each section of the [Settings](#register-item-settings) as required. Note that some options may open up new sections to complete.

<figure><img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2FL3DUU3OzleNTB2L72bOe%2Fimage.png?alt=media&#x26;token=72085613-93fb-42d2-b6eb-e60c89385383" alt=""><figcaption><p>Editing a sample Roster Availability item</p></figcaption></figure>

## Adding <a href="#adding" id="adding"></a>

{% content-ref url="../../concepts-and-fundamentals/on-a-computer/using-the-datagrid/adding-items" %}
[adding-items](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/adding-items)
{% endcontent-ref %}

1. From the register, in the New item menu select the **New Roster Availability**  <img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2Fa0jqgd37mZTdigA94UPV%2Fimage.png?alt=media&#x26;token=dc71686f-fac8-4ac7-bfab-bba3d60bc716" alt="" data-size="line"> button (or drop down the list from any other register and select it)
2. Complete each section of the [Settings](#register-item-settings) as required.&#x20;
3. Save <img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2F2qJNRqfHczOPl1cKEcMo%2Fimage.png?alt=media&#x26;token=1f653f47-1199-4f87-88da-313768ca3dac" alt="" data-size="line">

<figure><img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2FDlIIjW01hv21xWqGX7MF%2Fimage.png?alt=media&#x26;token=5011841a-625a-4d3a-b43b-ab5154153b5b" alt=""><figcaption><p>New Roster Availability screen</p></figcaption></figure>

## Bulk Actions <a href="#bulk-actions" id="bulk-actions"></a>

{% content-ref url="../../concepts-and-fundamentals/on-a-computer/using-the-datagrid/bulk-actions" %}
[bulk-actions](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/bulk-actions)
{% endcontent-ref %}

The following additional bulk actions can be performed via the Actions menu:

| Action           | Description                                                                                                                                                                                                                                                     |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Copy IDs         | Refer to: [Copy IDs](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/bulk-actions#copy-ids)                                                                                                                          |
| Export to Report | <p>Refer to: <a href="../../../concepts-and-fundamentals/on-a-computer/using-the-datagrid/bulk-actions#export-to-report">Export to Report</a><br>Exports to <a href="../../system-administration/reporting/built-in-reports">Roster Availability Report</a></p> |
| Bulk Edit        | Refer to: [Bulk Edit](https://docs.cw.crisisworks.com/concepts-and-fundamentals/on-a-computer/using-the-datagrid/bulk-actions#bulk-edit)                                                                                                                        |

## Importing <a href="#importing" id="importing"></a>

{% content-ref url="../../system-administration/configuring-the-system/imports" %}
[imports](https://docs.cw.crisisworks.com/system-administration/configuring-the-system/imports)
{% endcontent-ref %}

A System Administrator can import in bulk via the Import system using the [Availability Periods](https://docs.cw.crisisworks.com/system-administration/configuring-the-system/imports/register-items/availability-periods) option.

## Reports <a href="#reports" id="reports"></a>

{% content-ref url="../../system-administration/reporting/running-reports" %}
[running-reports](https://docs.cw.crisisworks.com/system-administration/reporting/running-reports)
{% endcontent-ref %}

The main report, **Roster Availability** found in [Rostering Reports](https://docs.cw.crisisworks.com/modules/reports/rostering-reports) can be run from either the Bulk Actions or the Reports menu.

<figure><img src="https://3923904090-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNy7IznbrPLUq6GJDDQDk%2Fuploads%2Fiy1QtV6j5Ds54zkwVlGG%2Fimage.png?alt=media&#x26;token=07c6ce5f-3179-4130-a9bb-6775ae27d3e2" alt=""><figcaption><p>View of some of the Roster Availability Report parameters</p></figcaption></figure>
