Skip to content

Commit

Permalink
GITBOOK-132: Suseela's Jan 19 changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Suseela-S authored and gitbook-bot committed Jan 20, 2024
1 parent b3e91ae commit 5d4b4c7
Show file tree
Hide file tree
Showing 11 changed files with 86 additions and 20 deletions.
Binary file added .gitbook/assets/default-eligibility-managers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion guides/documentation-guides/documentation-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This guide provides basic guidelines for you to write neat documentation.
In addition to the above while writing user guides follow these conventions:

* Use second-person pronouns i.e. you, your, etc. in the instructions/steps.
* Use the italicized font for UI elements i.e. dashboard names, button labels, information fields, etc.
* Use the bold and italicized font for UI elements i.e. dashboard names, button labels, information fields, etc.
* Use the exact name and case for the UI elements as shown in the user interface.
* Use quotes for a phrase/word if the phrase/word has to be represented as is.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,46 @@

## Description

This guide provides the steps to create an ID document eligibility manager
This guide provides the step-by-step instructions to create a ID Document Eligibility Manager

## Pre-requisites

user should have a Program Manager role.
A user should have a Program Manager role to create a ID Document Eligibility Manager.

## Steps
Note:

1. Navigate to _Programs_ using the menu bar.
Refer _**Create User and Assign Role**_ user guide to know how to assign role for a User.

<figure><img src="../../../.gitbook/assets/programs.png" alt=""><figcaption></figcaption></figure>
## Procedure

2. Click on _Configuration_ and then on _ID document Eligibility Manager._&#x20;
1. In the menu bar, click the icon ![](../../../.gitbook/assets/image.png) and select _**Programs**_.
2. The _**Programs**_ screen is displayed.

<figure><img src="../../../.gitbook/assets/configuration.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/programs.png" alt=""><figcaption><p>Choose the programs module </p></figcaption></figure>

3. Click _Create_ a button on the ID document eligibility manager list view page.
3. Click the _**Configuration**_ tab and then select the _**ID**_ _**Document Eligibility Managers**._

<figure><img src="../../../.gitbook/assets/default-eligibility-manager-listview-page.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/configuration.png" alt=""><figcaption><p> Programs screen</p></figcaption></figure>

4. Provide the name for the eligibility manager and select the program name from the drop-down for which the eligibility manager is created.
4. _**ID Document Eligibility Managers**_ screen is displayed.

<figure><img src="../../../.gitbook/assets/id-document-eligibility-manager-creation-page.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/id-document-eligibility-managers.png" alt=""><figcaption><p>ID Document Eligibility Managers screen</p></figcaption></figure>

5. Click the _Save_ button to save the eligibility manager and it will be listed under the eligibility manager list view page.&#x20;
_**ID Document Eligibility Managers**_ screen provides dashboard view which lists all the Manager Names and the Program list.

<figure><img src="../../../.gitbook/assets/id-document-eligibility-manager-listview-page.png" alt=""><figcaption></figcaption></figure>
In _**ID**_ _**Default Eligibility Managers**_ screen, the available features and their descriptions are:

<table><thead><tr><th width="130">Feature</th><th>Description</th></tr></thead><tbody><tr><td>Create</td><td>Click the <em><strong>Create</strong></em> button to create new ID default eligibility manager</td></tr><tr><td><img src="../../../.gitbook/assets/image (1).png" alt="" data-size="original"></td><td>Click the <em><strong>Export All</strong></em> button to download the details in excel format</td></tr><tr><td>&#x3C;</td><td>Click the <em><strong>Left</strong></em> arrow to go the previous screen</td></tr><tr><td>></td><td>Click the <em><strong>Right</strong></em> arrow to go the next screen</td></tr><tr><td>Filters</td><td><p>Click the <em><strong>Filters</strong></em> link and then select Add Customer Filter.</p><ul><li>Add Customer Filter</li></ul><p>The advanced filter option allows you to define conditions and criteria to refine the search results.</p><ul><li>Select the <em><strong>Add Customer filter</strong></em> and then select the appropriate option in the first drop-down to display the specific data based on the option selected.</li><li>Select the criteria in second and third drop-down to refine the search results. </li><li>Click the <em><strong>Apply</strong></em> button to display the data based on the search</li></ul><p><em>Note: To enhance the search, click the <strong>Add a condition</strong> button and follows the steps given in <strong>Add Customer Filter</strong> option</em></p></td></tr><tr><td>Group By</td><td><ul><li>Click the <em><strong>Group By</strong></em> link and select the option <strong>Program</strong></li><li>The Default Managers are grouped below each program</li><li>Click the <em><strong>Group By</strong></em> link, select <strong>Add Custom Group</strong> and then select the appropriate options in the drop-down to display the specific data based on the option selected.</li><li>Click the <em><strong>Apply</strong></em> button to display the data based on the search</li></ul></td></tr><tr><td>Favorites</td><td><ul><li><p>Click the <em><strong>Favorites</strong></em> link, select <strong>Save current search</strong> and then check the appropriate options. The valid values are: </p><ul><li>Use by default</li><li>Share with all users</li></ul></li><li>Click the <em><strong>Save</strong></em> button to display the data based on the search</li><li>Click the <em><strong>Import records.</strong></em><strong> Import a file</strong> screen is displayed. </li><li>Click the <em><strong>Upload file</strong></em> button, navigate to the file, and import the file in excel or CSV format</li><li>Click the <em><strong>Cancel</strong></em> button to exit the screen</li></ul></td></tr><tr><td>Search</td><td>This field is filled when the available option are selected in Filers, Group By, Favorites</td></tr></tbody></table>

5. Click the _**Create**_ button. The _**ID Document Eligibility Managers/New**_ screen is displayed.

<figure><img src="../../../.gitbook/assets/id-document-eligibility-managers-new.png" alt=""><figcaption><p>ID Document Eligibility Managers/New screen</p></figcaption></figure>

In _**ID Document Eligibility Managers/New**_ screen, the features and their descriptions are:

<table><thead><tr><th width="185">Feature</th><th>Description</th></tr></thead><tbody><tr><td>Name</td><td>Enter the name of the eligibility manger</td></tr><tr><td>Program</td><td>Select the program name from the drop-down for which the eligibility manager is created</td></tr></tbody></table>

6. Click the **Save** button to save the eligibility manager and it will be listed under the eligibility manager list view page.
7. Click the _**Discard**_ button to discard the changes and go back to ID Document Eligibility Managers list view page.

<figure><img src="../../../.gitbook/assets/id-document-eligibility-manager-listview-page.png" alt=""><figcaption><p>New list of ID Document Eligibility Managers</p></figcaption></figure>
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,24 @@ Refer _**Create User and Assign Role**_ user guide to know how to assign role fo
1. In the menu bar, click the icon ![](../../../.gitbook/assets/image.png) and select _**Programs**_.
2. The _**Programs**_ screen is displayed.

<figure><img src="../../../.gitbook/assets/programs.png" alt=""><figcaption><p>Choose the Programs screen</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/programs.png" alt=""><figcaption><p>Choose the programs module</p></figcaption></figure>

3. Click the _**Configuration**_ tab and then select the _**Default Eligibility Managers**._

<figure><img src="../../../.gitbook/assets/configuration.png" alt=""><figcaption><p>Program screen</p></figcaption></figure>

4. _**Default Eligibility Managers**_ screen is displayed.

<figure><img src="../../../.gitbook/assets/default-eligibility-manager-listview-page.png" alt=""><figcaption><p>Default Eligibility Managers screen</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/default-eligibility-managers.png" alt=""><figcaption><p>Default Eligibility Managers screen</p></figcaption></figure>

_**Default Eligibility Managers**_ screen provides dashboard view which lists all the Manager Names and the Program list.

In _**Default Eligibility Managers**_ screen, the available features and their descriptions are:

<table><thead><tr><th width="130">Feature</th><th>Description</th></tr></thead><tbody><tr><td>Create</td><td>Click the <em><strong>Create</strong></em> button to create new default eligibility manager</td></tr><tr><td><img src="../../../.gitbook/assets/image (1).png" alt="" data-size="original"></td><td>Click the <em><strong>Export All</strong></em> button to download the details in excel format</td></tr><tr><td>&#x3C;</td><td>Click the <em><strong>Left</strong></em> arrow to go the previous screen</td></tr><tr><td>></td><td>Click the <em><strong>Right</strong></em> arrow to go the next screen</td></tr><tr><td>Filters</td><td><p>Click the <em><strong>Filters</strong></em> link and then select Add Customer Filter.</p><ul><li>Add Customer Filter</li></ul><p>The advanced filter option allows you to define conditions and criteria to refine the search results.</p><ul><li>Select the <em><strong>Add Customer filter</strong></em> and then select the appropriate option in the first drop-down to display the specific data based on the option selected.</li><li>Select the criteria in second and third drop-down to refine the search results. </li><li>Click the <em><strong>Apply</strong></em> button to display the data based on the search</li></ul><p><em>Note: To enhance the search, click the <strong>Add a condition</strong> button and follows the steps given in <strong>Add Customer Filter</strong> option</em></p></td></tr><tr><td>Group By</td><td><ul><li>Click the <em><strong>Group By</strong></em> link and select the option <strong>Program</strong></li><li>The Default Managers are grouped below each program</li><li>Click the <em><strong>Group By</strong></em> link, select <strong>Add Custom Group</strong> and then select the appropriate options in the drop-down to display the specific data based on the option selected.</li><li>Click the <em><strong>Apply</strong></em> button to display the data based on the search</li></ul></td></tr><tr><td>Favorites</td><td><ul><li><p>Click the <em><strong>Favorites</strong></em> link, select <strong>Save current search</strong> and then check the appropriate options. The valid values are: </p><ul><li>Use by default</li><li>Share with all users</li></ul></li><li>Click the <em><strong>Save</strong></em> button to display the data based on the search</li><li>Click the <em><strong>Import records.</strong></em><strong> Import a file</strong> screen is displayed. </li><li>Click the <em><strong>Upload file</strong></em> button, navigate to the file, and import the file in excel or CSV format</li><li>Click the <em><strong>Cancel</strong></em> button to exit the screen</li></ul></td></tr><tr><td>Search</td><td>This field is filled when the available option are selected in Filers, Group By, Favorites</td></tr></tbody></table>



5. Click the _**Create**_ button. The Default Eligibility Managers/New screen is displayed.

<figure><img src="../../../.gitbook/assets/default-eligibility-manager-creation-page.png" alt=""><figcaption><p>Default Eligibility Managers/New screen</p></figcaption></figure>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,45 @@
# Create Phone Number Eligibility Manager

## Description

This guide provides the step-by-step instructions to create a Phone Number Eligibility Manager

## Pre-requisites

A user should have a Program Manager role to create a Phone Number Eligibility Manager.

Note:

Refer _**Create User and Assign Role**_ user guide to know how to assign role for a User.

## Procedure

1. In the menu bar, click the icon ![](../../../.gitbook/assets/image.png) and select _**Programs**_.
2. The _**Programs**_ screen is displayed.

<figure><img src="../../../.gitbook/assets/programs.png" alt=""><figcaption><p>Choose the programs module </p></figcaption></figure>

3. Click the _**Configuration**_ tab and then select the _**Phone**_ _**Number Eligibility Managers**._

<figure><img src="../../../.gitbook/assets/phone-number-eligibility-manager.png" alt=""><figcaption><p>Programs screen</p></figcaption></figure>

4. _**Phone Number Eligibility Managers**_ screen is displayed.

<figure><img src="../../../.gitbook/assets/phone-number-eligibility-manager-screen.png" alt=""><figcaption><p>Phone Number Eligibility Managers screen</p></figcaption></figure>

_**Phone Number Eligibility Managers**_ screen provides dashboard view which lists all the Manager Names and the Program list.

In _**Phone Number Eligibility Managers**_ screen, the available features and their descriptions are:

<table><thead><tr><th width="130">Feature</th><th>Description</th></tr></thead><tbody><tr><td>Create</td><td>Click the <em><strong>Create</strong></em> button to create new phone number eligibility manager</td></tr><tr><td><img src="../../../.gitbook/assets/image (1).png" alt="" data-size="original"></td><td>Click the <em><strong>Export All</strong></em> button to download the details in excel format</td></tr><tr><td>&#x3C;</td><td>Click the <em><strong>Left</strong></em> arrow to go the previous screen</td></tr><tr><td>></td><td>Click the <em><strong>Right</strong></em> arrow to go the next screen</td></tr><tr><td>Filters</td><td><p>Click the <em><strong>Filters</strong></em> link and then select Add Customer Filter.</p><ul><li>Add Customer Filter</li></ul><p>The advanced filter option allows you to define conditions and criteria to refine the search results.</p><ul><li>Select the <em><strong>Add Customer filter</strong></em> and then select the appropriate option in the first drop-down to display the specific data based on the option selected.</li><li>Select the criteria in second and third drop-down to refine the search results. </li><li>Click the <em><strong>Apply</strong></em> button to display the data based on the search</li></ul><p><em>Note: To enhance the search, click the <strong>Add a condition</strong> button and follows the steps given in <strong>Add Customer Filter</strong> option</em></p></td></tr><tr><td>Group By</td><td><ul><li>Click the <em><strong>Group By</strong></em> link and select the option <strong>Program</strong></li><li>The Default Managers are grouped below each program</li><li>Click the <em><strong>Group By</strong></em> link, select <strong>Add Custom Group</strong> and then select the appropriate options in the drop-down to display the specific data based on the option selected.</li><li>Click the <em><strong>Apply</strong></em> button to display the data based on the search</li></ul></td></tr><tr><td>Favorites</td><td><ul><li><p>Click the <em><strong>Favorites</strong></em> link, select <strong>Save current search</strong> and then check the appropriate options. The valid values are: </p><ul><li>Use by default</li><li>Share with all users</li></ul></li><li>Click the <em><strong>Save</strong></em> button to display the data based on the search</li><li>Click the <em><strong>Import records.</strong></em><strong> Import a file</strong> screen is displayed. </li><li>Click the <em><strong>Upload file</strong></em> button, navigate to the file, and import the file in excel or CSV format</li><li>Click the <em><strong>Cancel</strong></em> button to exit the screen</li></ul></td></tr><tr><td>Search</td><td>This field is filled when the available option are selected in Filers, Group By, Favorites</td></tr></tbody></table>

5. Click the _**Create**_ button. The _**Phone Number Eligibility Managers/New**_ screen is displayed.

<figure><img src="../../../.gitbook/assets/phone-number-eligibility-manager-new-screen.png" alt=""><figcaption><p>Phone Number Eligibility Managers/New screen</p></figcaption></figure>

In _**Phone Number Eligibility Managers/New**_ screen, the features and their descriptions are:

<table><thead><tr><th width="185">Feature</th><th>Description</th></tr></thead><tbody><tr><td>Name</td><td>Enter the name of the eligibility manger</td></tr><tr><td>Program</td><td>Select the program name from the drop-down for which the eligibility manager is created</td></tr></tbody></table>

6. Click the _**Save**_ button to save the eligibility manager and it will be listed under the eligibility manager list view page.
7. Click the _**Discard**_ button to discard the changes and go back to _**Phone Number Eligibility Managers**_ list view page.
13 changes: 9 additions & 4 deletions guides/user-guides/create-eligibility-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,20 @@

## Description

This guide provides steps to create and configure the eligibility manager inside the program.
This guide provides step-by-step instructions to create and configure the eligibility manager under the program.

## Pre-requisites

The user must have the Program Manager role.
A user should have a Program Manager role to create a Eligibility Manager under program.

## Steps
Note:

1. Navigate to _Programs_ using the menu bar.
Refer _**Create User and Assign Role**_ user guide to know how to assign role for a User.

## Procedure

1. In the menu bar, click the icon ![](../../.gitbook/assets/image.png) and select _**Programs**_.
2. The _**Programs**_ screen is displayed.

<figure><img src="../../.gitbook/assets/programs.png" alt=""><figcaption></figcaption></figure>

Expand Down

0 comments on commit 5d4b4c7

Please sign in to comment.