diff --git a/content/applications/hr/referrals.rst b/content/applications/hr/referrals.rst index ca95c9dc7..48b9d1997 100644 --- a/content/applications/hr/referrals.rst +++ b/content/applications/hr/referrals.rst @@ -323,56 +323,6 @@ points required. can be redeemed for rewards, but they are no longer able to level up. The ring around their photo remains solid cyan. -Alerts -====== - -In the *Referrals* application, it is possible to post a message, also referred to as an *alert*, at -the top of the dashboard to share important information with users. These alerts appear as a thin -semi-transparent banner, with the word :guilabel:`New!` appearing on the far left. The text for the -alert is in the center of the banner, and on the far right side is an :guilabel:`X`. - -Alerts appear on the main dashboard for the specified time configured on the individual alert. If a -user does not wish to see a specific alert again, click the :guilabel:`X` in the far right side of -the alert. This removes the alert from the dashboard and will not appear again, even when opening -the *Referrals* application for the first time in a new session. - -.. image:: referrals/alerts.png - :align: center - :alt: Two alert banners appear above the user's photo. - -Create an alert ---------------- - -Only users with :guilabel:`Administrator` rights for the *Recruitment* application can create -alerts. To add a new alert, navigate to the :menuselection:`Referrals application --> Configuration ---> Alerts`. - -Click :guilabel:`Create` and a blank alert form loads. Enter the following information on the form: - -- :guilabel:`Date From`: the date the alert starts. On this date, the alert will be visible on the - dashboard. -- :guilabel:`Date To`: the date the alert ends. After this date, the alert will be hidden from view. -- :guilabel:`Company`: the current company populates this field by default. To modify the company - the alert should be displayed for, select the company from the drop-down menu. If this field - remains blank, the alert is visible to everyone with access to the *Referrals* application. If a - company is specified, only user's within that company (who also have access to the *Referrals* - application) will see the alert. This field only appears when in a multi-company database. -- :guilabel:`Alert`: enter the text for the alert. This message appears inside the alert banner on - the main dashboard. -- :guilabel:`On Click`: there are three options for the alert. Click the radio button next to the - desired selection. The options are: - - - :guilabel:`Not Clickable`: the alert only displays text, there is no link to click. - - :guilabel:`Go to All Jobs`: the alert contains a link that when clicked, navigates to the - website with all the currently posted job positions. - - :guilabel:`Specify URL`: the alert contains a link to a specific URL, that when clicked, - navigates to that URL. When selected, a :guilabel:`URL` field appears below the :guilabel:`On - Click` section. Enter the URL in the field. - -.. image:: referrals/alert-form.png - :align: center - :alt: An alert form completely filled in with all selections entered. - .. _referrals/reporting: Reporting @@ -407,8 +357,10 @@ spreadsheet from the drop-down menu, or select :guilabel:`New Spreadsheet`. Clic .. seealso:: - :doc:`referrals/share_jobs` - :doc:`referrals/rewards` + - :doc:`referrals/alerts` .. toctree:: referrals/share_jobs referrals/rewards + referrals/alerts diff --git a/content/applications/hr/referrals/alerts.rst b/content/applications/hr/referrals/alerts.rst new file mode 100644 index 000000000..015e27790 --- /dev/null +++ b/content/applications/hr/referrals/alerts.rst @@ -0,0 +1,60 @@ +====== +Alerts +====== + +In the *Referrals* application, it is possible to post a message, also referred to as an *alert*, at +the top of the dashboard to share important information with users. + +Alerts remain on the main *Referrals* dashboard for the specified amount of time configured on the +individual alert. + +.. image:: alerts/alerts.png + :align: center + :alt: Two alert banners appear above the user's photo. + +Create an alert +=============== + +Only users with *Administrator* access rights for the *Recruitment* application can create alerts. +To add a new alert, navigate to the :menuselection:`Referrals app --> Configuration --> Alerts`. + +Click :guilabel:`New` to open a blank alert form. Enter the following information on the form: + +- :guilabel:`Date From`: the date the alert starts. On this date, the alert is visible on the + dashboard. +- :guilabel:`Date To`: the date the alert ends. After this date, the alert is hidden from view. +- :guilabel:`Company`: the current company populates this field, by default. To modify the company + the alert should be displayed for, select the desired company from the drop-down menu in this + field. + + If this field remains blank, the alert is visible to everyone with access to the *Referrals* + application. + + If a company is specified, only users within that company (who also have access to the *Referrals* + application) see the alert. This field **only** appears when in a multi-company database. +- :guilabel:`Alert`: enter the text for the alert. This message appears inside the alert banner on + the main *Referrals* dashboard. +- :guilabel:`On Click`: there are three options for the alert. Click the radio button next to the + desired selection. The options are: + + - :guilabel:`Not Clickable`: the alert only displays text, there is no link to click. + - :guilabel:`Go to All Jobs`: the alert contains a link that, when clicked, navigates to the + website with all the job positions that are currently posted. + - :guilabel:`Specify URL`: the alert contains a link to a specific URL that, when clicked, + navigates to that URL. When selected, a :guilabel:`URL` field appears below the :guilabel:`On + Click` section. Enter the desired URL in that field. + +.. image:: alerts/alert-form.png + :align: center + :alt: An alert form completely filled in with all selections entered. + +Dismiss an alert +================ + +It is possible to dismiss an alert, if a user does not wish to see a specific alert again. + +To dismiss an alert, click the :icon:`fa-times` :guilabel:`(remove)` icon on the far-right side of +the alert to remove the alert from the dashboard. + +This prevents the alert from appearing again, even when opening the *Referrals* application for the +first time in a new session. diff --git a/content/applications/hr/referrals/alert-form.png b/content/applications/hr/referrals/alerts/alert-form.png similarity index 100% rename from content/applications/hr/referrals/alert-form.png rename to content/applications/hr/referrals/alerts/alert-form.png diff --git a/content/applications/hr/referrals/alerts.png b/content/applications/hr/referrals/alerts/alerts.png similarity index 100% rename from content/applications/hr/referrals/alerts.png rename to content/applications/hr/referrals/alerts/alerts.png