Skip to content

Commit

Permalink
GITBOOK-140: Suseela's Jan 23 changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Suseela-S authored and gitbook-bot committed Jan 24, 2024
1 parent 494a008 commit 4527f97
Show file tree
Hide file tree
Showing 28 changed files with 112 additions and 31 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/add-eligibility-managers-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/add-eligibility-managers-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/add-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.
Binary file added .gitbook/assets/configuration (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/configuration -1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/cover-image.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/create-manager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/delete-eligibility-managers-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/delete-eligibility-managers-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/delete-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.
Binary file added .gitbook/assets/eligibility-manager-list-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/eligibility-manager-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/program-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/sample-program-screen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
cover: .gitbook/assets/landing-page-banner.png
cover: .gitbook/assets/OpenG2P Docs landing page_NEW_23Jan2024.png
coverY: 0
layout:
cover:
Expand All @@ -19,7 +19,7 @@ layout:

# 🏠 Home

[OpenG2P](https://openg2p.org) is an open-source platform that enables governments and humanitarian organizations to deliver critical social benefits directly to those who need them. It facilitates the building of secure, inclusive and efficient registries and digital cash transfer delivery systems
[OpenG2P](https://openg2p.org) is an open-source platform that enables governments and humanitarian organizations to deliver critical social benefits directly to those who need them. It facilitates the building of secure, inclusive and efficient registries and digital cash transfer delivery systems.

OpenG2P is a Digital Public Good (DPG) recognized by the[ DPGA](https://digitalpublicgoods.net/) and a significant building block of a country's Digital Public Infrastructure ([DPI](https://docs.cdpi.dev/dpi/readme)). OpenG2P contributes to the G2P transfers DPI layer in a digital economy, while leveraging DPGs in other categories. Its modular and interoperable technology augments existing systems in countries, without discarding what works or starting from scratch.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The user should be assigned to the Program Manager role.

2. Click on _Configuration_ and then on _ID Deduplication Manager._

<figure><img src="../../../.gitbook/assets/configuration.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/configuration (1).png" alt=""><figcaption></figcaption></figure>

3. Click the Create button to navigate to the ID deduplication manager creation page.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The user should be assigned to the Program Manager role.

2. Click on Configuration and then on _ID Deduplication Manager._

<figure><img src="../../../.gitbook/assets/configuration.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/configuration (1).png" alt=""><figcaption></figcaption></figure>

3. Click the Create button to navigate to the Phone Number Deduplication manager creation page.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Refer _**Create User and Assign Role**_ user guide to know how to assign role fo

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

<figure><img src="../../../.gitbook/assets/configuration.png" alt=""><figcaption><p> Programs screen</p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/configuration (1).png" alt=""><figcaption><p> Programs screen</p></figcaption></figure>

4. _**ID Document Eligibility Managers**_ screen is displayed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Refer _**Create User and Assign Role**_ user guide to know how to assign role fo

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>
<figure><img src="../../../.gitbook/assets/configuration (1).png" alt=""><figcaption><p>Program screen</p></figcaption></figure>

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

Expand Down
118 changes: 100 additions & 18 deletions guides/user-guides/create-eligibility-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

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

## Pre-requisites

Expand All @@ -17,36 +17,118 @@ 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></figcaption></figure>
<figure><img src="../../.gitbook/assets/programs.png" alt=""><figcaption><p>Choose Program module</p></figcaption></figure>

2. Click on the program name for which configuration to be done.
2. Click the program name for which configuration to be done.
3. The selected program screen is displayed. For example, here the program selected is Individual Cash Program.

<figure><img src="../../.gitbook/assets/program-list-view-page.png" alt=""><figcaption></figcaption></figure>
Note:

By default, in the _**Program**_ field, you can find the selected program name.

<figure><img src="../../.gitbook/assets/program-list.png" alt=""><figcaption><p>Program list</p></figcaption></figure>

<figure><img src="../../.gitbook/assets/sample-program-screen.png" alt=""><figcaption><p>Sample program screen</p></figcaption></figure>

4. Enter the _**Description**_ of the program.
5. Choose one of the _**Target Type**_s. The values are

&#x20; Group

&#x20; Individual

6. Click the _**Configuration**_ tab.

Note:&#x20;

You can configure the required Managers from the available list.

<figure><img src="../../.gitbook/assets/configuration.png" alt=""><figcaption><p>List of Configurable Managers</p></figcaption></figure>

### Eligibility Manager configuration

1. In the _**Eligibility Managers**_ section, click the link _**Add a line.**_
2. The _**Add: Eligibility Managers**_ screen is displayed.

<figure><img src="../../.gitbook/assets/add-eligibility-managers.png" alt=""><figcaption><p>Add: Eligibility Managers</p></figcaption></figure>

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

<table><thead><tr><th width="130">Feature</th><th>Description</th></tr></thead><tbody><tr><td>Search</td><td>This field is filled when the available option are selected in Filers, Group By, Favorites</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, 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></ul><ul><li>Click the <em><strong>Save</strong></em> button to display the data based on the search.</li></ul></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>Create</td><td>Click the <em><strong>Create</strong></em> button to Eligibility Managers</td></tr></tbody></table>



3. Click the _**Create**_ button.&#x20;
4. The below screen _**Add: Eligibility Managers**_ screen is displayed.

<figure><img src="../../.gitbook/assets/add-eligibility-managers-1.png" alt=""><figcaption><p>Add: Eligibility Managers</p></figcaption></figure>

The feature and their description is:

<table><thead><tr><th width="211">Feature</th><th>Description</th></tr></thead><tbody><tr><td>Manager</td><td><p>Select the Manager from the drop-down. The three available managers are:</p><ul><li>Default Eligibility</li><li>ID Document Eligibility</li><li>Phone Number Eligibility</li></ul></td></tr></tbody></table>

Note:&#x20;

Once the Manager is selected, an additional field is displayed.

<figure><img src="../../.gitbook/assets/add-eligibility-managers-2.png" alt=""><figcaption><p>Choose Eligibility Manager </p></figcaption></figure>

5. Enter the Eligibility Manager's name in the second field.

Note:

In the drop-down, choose the Eligibility Manager's name, if already available or click the option _**Start typing**_ to enter the new Eligibility Manager's name.

6. While entering the new Eligibility Manager's name, a button _**Create and Edit**_ pops up.
7. Click the _**Create and Edit**_ button.
8. _**Create: Manager screen**_ is displayed.

<figure><img src="../../.gitbook/assets/create-manager.png" alt=""><figcaption><p>Create Manger screen</p></figcaption></figure>

In the Create: Manager 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 manager</td></tr><tr><td>Domain</td><td>Set the eligibility criteria's using <em><strong>Add Filter</strong></em> button on the creation page.</td></tr><tr><td>Match all records</td><td>Retrieves the data which matches all records</td></tr><tr><td><img src="../../.gitbook/assets/image (7).png" alt="" data-size="original"></td><td><p>Click the <em><strong>Records</strong></em> button. The <em><strong>Selected records</strong></em> screen is displayed. </p><p><em>Note:</em> </p><ul><li><em>By default the list of three records are listed in the <strong>Selected records</strong> screen.</em></li><li><em>Click the <strong>Cancel</strong> button to close the <strong>Selected records</strong> screen.</em></li></ul></td></tr><tr><td><img src="../../.gitbook/assets/image (9).png" alt="" data-size="original"></td><td>Click the <em><strong>Refresh</strong></em> button to refresh the screen</td></tr><tr><td>Add filter</td><td><p>Click the <em><strong>Add filter</strong></em> button to set eligibility criteria using <a href="https://github.com/OpenG2P/openg2p-documentation/blob/1.2.1/beneficiary-management/eligibility.md#domain-filters">Domain Filters</a>. You may set multiple eligibility criteria. </p><ol><li>Click the <em><strong>Add filters</strong></em> button. The multiple criteria fields are displayed.</li><li>Select the multiple criteria such as ID, condition and count.</li><li>Click the <strong>x</strong> button to remove the entry in the criteria fields.</li><li>Click the <strong>+</strong> button to add new multiple criteria field.</li><li>Click the <strong>...</strong> option to display fields in <em><strong>Any of</strong></em> section. The multiple criteria fields are displayed.</li></ol><p><em>Note: You can click the <strong>...</strong> option to add n number of <strong>Any of</strong> section</em></p><ol start="6"><li>The value chosen in the multiple criteria fields are displayed in the <em><strong>Code editor</strong></em>.</li><li>In the Match records chose one of the followings:</li></ol><ul><li>Select <em><strong>All</strong></em> to display the data belongs to <em><strong>All</strong></em> section </li><li>Select <em><strong>Any</strong></em> to display the data belongs to <em><strong>Any</strong></em> <em><strong>of</strong></em> section</li></ul></td></tr></tbody></table>



9. Click the _**Save**_ button to save the data.
10. Click the _**Discard**_ button to exit the screen.
11. The added new Eligibility Manager is listed in the Configuration tab list.

<figure><img src="../../.gitbook/assets/eligibility-configuration-manager-list.png" alt=""><figcaption><p>List of Eligibility Managers</p></figcaption></figure>

12. Click the _**Save**_ button which will save the eligibility manager to that program under configuration.

### Configuration tab - List Eligibility Manager

In the Add Eligibility Manager screen, you can find the list of Eligibility Manager.

3. Navigate to the _Configuration_ section on Program detailed view page.
<figure><img src="../../.gitbook/assets/eligibility-manager-list.png" alt=""><figcaption><p>Eligibility Manager list</p></figcaption></figure>

<figure><img src="../../.gitbook/assets/program-detailed-view.png" alt=""><figcaption></figcaption></figure>
1. Check the required Manager in the list, it enables the _**Select, Action**_ button. It also shows the number of entries selected.

4. Click on _Add a line_ in the _Eligibility Manager_ section.
<figure><img src="../../.gitbook/assets/eligibility-manager-list-1 (1).png" alt=""><figcaption><p>Selected Eligibility Manager list</p></figcaption></figure>

<figure><img src="../../.gitbook/assets/eligibility-add-line.png" alt=""><figcaption></figcaption></figure>
2. Click the _**Select**_ button.
3. The selected Manager will be listed in the Eligibility Manager section below the _**Configuration**_ tab.

5. Click on the _Create_ button on the Add: Eligibility Managers pop-up window.
<figure><img src="../../.gitbook/assets/configuration -1.png" alt=""><figcaption><p>New list of Eligibility Manager</p></figcaption></figure>

<figure><img src="../../.gitbook/assets/add-eligibilty-manager.png" alt=""><figcaption></figcaption></figure>
### Delete - Eligibility Manager

6. Select the eligibility manager type.
In the Add Eligibility Manager, you can find the list of Eligibility Manager.

<figure><img src="../../.gitbook/assets/eligibility-manager-type.png" alt=""><figcaption></figcaption></figure>
1. Check the required Manager in the list, it enables the _**Select, Action**_ button. It also shows the number of entries selected.

7. Once the name is provided to the eligibility manager, _Create_ and _Edit_ buttons will appear. Click on _Create and Edit_ button to create an eligibility manager.
<figure><img src="../../.gitbook/assets/delete-eligibility-managers-1.png" alt=""><figcaption><p>Search, Action button enabled</p></figcaption></figure>

<figure><img src="../../.gitbook/assets/eligibility-manager-create-and-edit.png" alt=""><figcaption></figcaption></figure>
2. Click the _**Action**_ button and then click _**delete**_.&#x20;

8. Set the eligibility criteria's using Add Filter button on the creation page.
<figure><img src="../../.gitbook/assets/delete-eligibility-managers.png" alt=""><figcaption><p>Action button</p></figcaption></figure>

<figure><img src="../../.gitbook/assets/eligibility-manager-create.png" alt=""><figcaption></figcaption></figure>
3. The _**Confirmation**_ dialog box pops up.
4. Click the _**OK**_ button to delete the entry. The selected entry will be deleted
5. Click the _**Cancel**_ button to retain the entry.

9. Click on the Save button and then click on the _Save & Close_ button which will save the eligibility manager to that program under configuration.
<figure><img src="../../.gitbook/assets/delete-eligibility-managers-2.png" alt=""><figcaption><p>Deleted entry screen</p></figcaption></figure>

<figure><img src="../../.gitbook/assets/added-eligibility-manager.png" alt=""><figcaption></figcaption></figure>
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This guide will provide the steps to create a Fast2SMS notification manager.

2. Click on _Configuration_ and then on _Fast2SMS Notification Manager._

<figure><img src="../../../.gitbook/assets/configuration.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/configuration (1).png" alt=""><figcaption></figcaption></figure>

2. Click the _Create_ button to navigate to the Fast2SMS notification manager creation page.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ The user should have a Program Manager role.

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

2. Click on Configuration and then on Payment Interoperability Layer Payment Manager.&#x20;
2. Click on Configuration and then on Payment Interoperability Layer Payment Manager.

<figure><img src="../../../.gitbook/assets/configuration.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/configuration (1).png" alt=""><figcaption></figcaption></figure>

3. Click on Create button which will navigate to the Default Payment Manager creation page.

Expand All @@ -29,4 +29,3 @@ The user should have a Program Manager role.
5. Once the payment manager is saved it will be listed under the payment manager list view page which further can be used under the program configuration for which it was created.

<figure><img src="../../../.gitbook/assets/default-payment-listview-page.png" alt=""><figcaption></figcaption></figure>

Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ The user should have a Program Manager role.

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

2. Click on Configuration and then on Payment Hub EE Payment Manager.&#x20;
2. Click on Configuration and then on Payment Hub EE Payment Manager.

<figure><img src="../../../.gitbook/assets/configuration.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/configuration (1).png" alt=""><figcaption></figcaption></figure>

3. Click on _Create_ button which will navigate to the Payment Hub EE Payment Manager creation page.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The user should have a Program Manager role.

2. Click on Configuration and then on Payment Interoperability Layer Payment Manager.

<figure><img src="../../../.gitbook/assets/configuration.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/configuration (1).png" alt=""><figcaption></figcaption></figure>

3. Click on Create button which will navigate to the Payment Interoperability Layar Payment Manager creation page.

Expand Down

0 comments on commit 4527f97

Please sign in to comment.