Skip to content

Commit

Permalink
Copied from 1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
pjoshi751 committed Dec 28, 2023
1 parent ef7a3f3 commit 778a737
Show file tree
Hide file tree
Showing 25 changed files with 93 additions and 93 deletions.
2 changes: 1 addition & 1 deletion guides/user-guides/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# User Guides
# 📔 User Guides

23 changes: 15 additions & 8 deletions guides/user-guides/assign-roles-to-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,30 @@

## Description

The guide here provides steps to create a new user and assign a role. This process is typically done by the Administrator.
This document contains the step-by-step instruction to create a new user and assign a role. A person who has admin access can create a new user and assign a role.

## Pre-requisites

The user should have an Administrator role.
A user should have an admin access to create a new user and assign a role.

## Steps
## Procedure

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

<figure><img src="../../.gitbook/assets/settings-menu-bar.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/Create a user.png" alt=""><figcaption><p>Choose Settings Screen</p></figcaption></figure>

2. Click on _Users & Companies_ and then select _Users_ to reach user's list view page.

<figure><img src="../../.gitbook/assets/user-and-companies.png" alt=""><figcaption></figcaption></figure>

3. Click on the _Create_ button to reach user creation page.
<figure><img src="../../.gitbook/assets/Settings screen.png" alt=""><figcaption><p>Settings Screen</p></figcaption></figure>

2. Click the _**Users & Companies**_ tab and then select _**Users**_.



<figure><img src="../../.gitbook/assets/Users - Dashboard.png" alt=""><figcaption></figcaption></figure>

2. Click on the _Create_ button to reach user creation page.

<figure><img src="../../.gitbook/assets/user-creation-page.png" alt=""><figcaption></figcaption></figure>

Expand Down
12 changes: 6 additions & 6 deletions guides/user-guides/configure-notification-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,31 @@ The user must have the Program Manager role.

## Steps

1. Navigate to _Programs_ using the menu bar.
1. Navigate to _Programs_ using the menu bar.&#x20;

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

2. Click on the program name for which configuration to be done.
2. Click on the program name for which configuration to be done.&#x20;

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

3. Navigate to the _Configuration_ section on Program detailed view page.

<figure><img src="../../.gitbook/assets/program-detailed-view.png" alt=""><figcaption></figcaption></figure>

4. Click on _Add a line_ in the Notification Manager section.
4. &#x20;Click on _Add a line_ in the Notification Manager section.&#x20;

<figure><img src="../../.gitbook/assets/add-notification-manager.png" alt=""><figcaption></figcaption></figure>

5. Click on the _Create_ button on the Add: Notification Managers pop-up window.
5. Click on the _Create_ button on the Add: Notification Managers pop-up window.&#x20;

<figure><img src="../../.gitbook/assets/add-notification-managers-window.png" alt=""><figcaption></figcaption></figure>

6. Select the notification manager type.
6. Select the notification manager type.&#x20;

<figure><img src="../../.gitbook/assets/notification-manager-types.png" alt=""><figcaption></figcaption></figure>

7. Once the name is provided to the deduplication manager, _Create and Edit_ buttons will appear. Click on _Create and Edit_ to create a deduplication manager.
7. Once the name is provided to the deduplication manager, _Create and Edit_ buttons will appear. Click on _Create and Edit_ to create a deduplication manager. &#x20;

<figure><img src="../../.gitbook/assets/notification-manager-create-and-edit.png" alt=""><figcaption></figcaption></figure>

Expand Down
8 changes: 4 additions & 4 deletions guides/user-guides/create-a-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,20 @@ The user must have a Program Manager role. See [Create User and Assign Role](ass
<figure><img src="../../.gitbook/assets/program-creation-page.png" alt=""><figcaption><p>Configure eligibility criteria</p></figcaption></figure>

</div>
4. Use\_+Add filter\_ to set eligibility criteria using [Domain Filters](broken-reference). You may set multiple eligibility criteria.
5. **Cycle Manager:** Set parameters of [disbursement cycles](broken-reference).
4. Use\_+Add filter\_ to set eligibility criteria using [Domain Filters](../../beneficiary-management/eligibility.md#domain-filters). You may set multiple eligibility criteria.
5. **Cycle Manager:** Set parameters of [disbursement cycles](../../beneficiary-management/disbursement-cycles.md).

<figure><img src="../../.gitbook/assets/cycle-manager.png" alt=""><figcaption></figcaption></figure>

* _Auto-approve Entitlements:_ To set entitlements via rules, without any manual approvals.
* _Approver Group:_ The group name of the user who has permission to approve cycles. See [Create User and Assign Role](assign-roles-to-users.md).
* _Recurrence:_ The time period for the repetition of a cycle.
6. **Entitlement Manager:** Set parameters for [entitlements](broken-reference).
6. **Entitlement Manager:** Set parameters for [entitlements](../../beneficiary-management/entitlement.md).

<figure><img src="../../.gitbook/assets/entitlement-manager.png" alt=""><figcaption></figcaption></figure>

* _Amount Per Cycle:_ The amount disbursement of a group or individual per cycle.
* _Amount Per Individual In Group:_ Amount of disbursement per individual in a group when the program [target type](broken-reference) is "group".
* _Amount Per Individual In Group:_ Amount of disbursement per individual in a group when the program [target type](../../beneficiary-management/#target-types) is "group".
* _Maximum number of individuals in a group:_ Maximum number of individuals who get disbursements per group (optional).
* _Transfer Fee(%):_ Fee incurred for disbursement as a percentage of disbursement (optional).
* _Transfer Fee Amount:_ Fee incurred for disbursement as an absolute amount (optional).
Expand Down
5 changes: 3 additions & 2 deletions guides/user-guides/create-and-approve-disbursement-cycle.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Create and Approve Program Cycle
# Create and Approve Disbursement Cycle

## Description

Expand All @@ -24,7 +24,7 @@ The user should have a role which is configured in the _Approver Group_ under _C

<figure><img src="../../.gitbook/assets/draft-cycle.png" alt=""><figcaption></figcaption></figure>

4. Navigate inside the cycle using the arrow icon button beside the cycle name.
4. Navigate inside the cycle using the arrow icon button beside the cycle name.&#x20;
5. After clicking on _Copy Beneficiaries from Program_ button program beneficiaries will be copied into the cycle.

<figure><img src="../../.gitbook/assets/cycle-detailed-view-page.png" alt=""><figcaption></figcaption></figure>
Expand All @@ -40,3 +40,4 @@ The user should have a role which is configured in the _Approver Group_ under _C
8. Once more click on _Approve_ button to approve the cycle and the cycle status will be moved from _To Approve_ to _Approved._

<figure><img src="../../.gitbook/assets/cycle-approved.png" alt=""><figcaption></figcaption></figure>

2 changes: 1 addition & 1 deletion guides/user-guides/create-deduplication-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The user must have the Program Manager role.

<figure><img src="../../.gitbook/assets/deduplication-manager-types.png" alt=""><figcaption></figcaption></figure>

7. Once the name is provided to the deduplication manager, Create and Edit buttons will appear to click on Create and Edit button to create a deduplication manager.
7. Once the name is provided to the deduplication manager, Create and Edit buttons will appear to click on Create and Edit button to create a deduplication manager.&#x20;

<figure><img src="../../.gitbook/assets/deduplication-manager-create-and-edit.png" alt=""><figcaption></figcaption></figure>

Expand Down
3 changes: 2 additions & 1 deletion guides/user-guides/create-eligibility-manager-1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ There are 3 types of eligibility managers available that can be created and then

1. [Default Eligibility Manager](create-default-eligibility-manager.md)
2. [ID Document Eligibility Manager](copy-of-create-id-document-eligibility-manager.md)
3. [Phone Number Eligibility Manager](create-phone-number-eligibility-manager.md)
3. [Phone Number Eligibility Manager](../create-eligibility-manager-types/create-phone-number-eligibility-manager.md)

Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ 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 _ID document Eligibility Manager._
2. Click on _Configuration_ and then on _ID document Eligibility Manager._&#x20;

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

Expand All @@ -26,6 +26,6 @@ user should have a Program Manager role.

<figure><img src="../../../.gitbook/assets/id-document-eligibility-manager-creation-page.png" alt=""><figcaption></figcaption></figure>

5. Click the _Save_ button to save the eligibility manager and it will be listed under the eligibility manager list view page.
5. Click the _Save_ button to save the eligibility manager and it will be listed under the eligibility manager list view page.&#x20;

<figure><img src="../../../.gitbook/assets/id-document-eligibility-manager-listview-page.png" alt=""><figcaption></figcaption></figure>
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ 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 _Default Eligibility Manager._
2. Click on _Configuration_ and then on _Default Eligibility Manager._&#x20;

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

Expand All @@ -26,8 +26,9 @@ user should have a Program Manager role.

<figure><img src="../../../.gitbook/assets/default-eligibility-manager-creation-page.png" alt=""><figcaption></figcaption></figure>

4. Use _+Add filter_ to set eligibility criteria using [Domain Filters](broken-reference). You may specify multiple eligibility criteria.
4. Use _+Add filter_ to set eligibility criteria using [Domain Filters](../../../beneficiary-management/eligibility.md#domain-filters). You may specify multiple eligibility criteria.

<figure><img src="../../../.gitbook/assets/default-eligibility-manager-filter.png" alt=""><figcaption></figcaption></figure>

5. Click the _Save_ button to save the eligibility manager and it will be listed under the eligibility manager list view page.
5. Click the _Save_ button to save the eligibility manager and it will be listed under the eligibility manager list view page.&#x20;

This file was deleted.

1 change: 1 addition & 0 deletions guides/user-guides/create-mts-connector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ There are two types of MTS Connectors differentiated based on input types
## Pre-requisites

The user must have a Program Manager role. See [Create User and Assign Role](../assign-roles-to-users.md) guide.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

This Guide will help to create the [ODK MTS Connector](broken-reference).
This Guide will help to create the [ODK MTS Connector](../../../integrations/integration-with-mosip/mts-connector.md).

## Pre-requisites

Expand All @@ -19,9 +19,9 @@ This Guide will help to create the [ODK MTS Connector](broken-reference).

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

3. Set _MTS Input Type_ as _ODK_ and for other fields configuration please go through [ODK MTS Connector Configuration](broken-reference).
3. Set _MTS Input Type_ as _ODK_ and for other fields configuration please go through [ODK MTS Connector Configuration](../../../integrations/integration-with-mosip/mts-connector.md).

<figure><img src="../../../.gitbook/assets/mts-input-type-odk.png" alt=""><figcaption></figcaption></figure>

4. Click the _Save_ button and the connector will be listed under the MTS Connectors list view page.
4. Click the _Save_ button and the connector will be listed under the MTS Connectors list view page.
5. Click on _Start_ in the MTS Collectors list view page to start the created connector.
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Description

This Guide will help to create the [OpenG2P registry MTS Connector](broken-reference).
This Guide will help to create the [OpenG2P registry MTS Connector](../../../integrations/integration-with-mosip/registry-mts-connector.md).

## Pre-requisites
## Pre-requisites&#x20;

The user must have a Program Manager role.

Expand All @@ -18,9 +18,9 @@ The user must have a Program Manager role.

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

3. Set _MTS Input Type_ as _OpenG2P Registry_ and for other fields configuration please go through [Registry MTS Connector](broken-reference).
3. Set _MTS Input Type_ as _OpenG2P Registry_ and for other fields configuration please go through [Registry MTS Connector](../../../integrations/integration-with-mosip/registry-mts-connector.md).

<figure><img src="../../../.gitbook/assets/mts-input-type-openg2p-registry.png" alt=""><figcaption></figcaption></figure>

4. Click on the _Start_ button under the MTS Connectors list view page to start the created connector.
5. Click the _Save_ button and the connector will be listed under the MTS Connectors list view page.
5. Click the _Save_ button and the connector will be listed under the MTS Connectors list view page.
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ There are 3 types of notification managers available that can be created and the
1. SMS Notification Manager
2. Email Notification Manager
3. Fast2SMS Notification Manager



4 changes: 2 additions & 2 deletions guides/user-guides/create-odk-form.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ This guide provides steps to create a new ODK form for a program.

## Steps

1. Login to ODK Central.
1. Login to ODK Central.&#x20;
2. Click on the +_New_ button to create a new project

<figure><img src="../../.gitbook/assets/odk-central.png" alt=""><figcaption></figcaption></figure>

2. Provide the project name same as the program name for which creating the form.
2. &#x20;Provide the project name same as the program name for which creating the form.

<figure><img src="../../.gitbook/assets/project-name.png" alt=""><figcaption></figcaption></figure>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ 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.
2. Click on Configuration and then on Payment Interoperability Layer Payment Manager.&#x20;

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

Expand All @@ -29,3 +29,4 @@ 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,7 +14,7 @@ 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.
2. Click on Configuration and then on Payment Hub EE Payment Manager.&#x20;

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

Expand Down
2 changes: 1 addition & 1 deletion guides/user-guides/create-payment-manager.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configure Payment Manager in Program
# Configure Entitlement Manager in Program

## Description

Expand Down
1 change: 1 addition & 0 deletions guides/user-guides/download-form-on-odk-collect.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,4 @@ This guide will help to download the program form on ODK Collect Application run
<figure><img src="../../.gitbook/assets/client-configuration-code.png" alt=""><figcaption></figcaption></figure>

<figure><img src="../../.gitbook/assets/odk-collect-program-home-page.png" alt=""><figcaption></figcaption></figure>

27 changes: 17 additions & 10 deletions guides/user-guides/install-wireguard-app-and-activate-tunnel.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,37 @@

## Description

The guide here provides steps to install WireGuard App and activate the tunnel. This app allows users to create an encrypted VPN for secure communication.
The guide here provides steps to install WireGuard app on Android device and to activate the tunnel. This app allows users to create an encrypted VPN for secure communication.

## Pre-requisites

The user must possess an Android Phone. The user should reach out to the system administrator to generate the Wireguard conf file before proceeding with the installation.
The pre-requisites to install WireGuard on Android device are:

## Steps
1. A user must have an Android Phone.&#x20;
2. Before proceeding with the installation, obtain the WireGuard conf file from a System Administrator.&#x20;

1. Search for "wireguard" in the Android Play Store.
## Procedure

<figure><img src="../../.gitbook/assets/search-wireguard.png" alt=""><figcaption></figcaption></figure>
The steps to install WireGuard in an Android device are:

2. Install the WireGuard app, open it, and click on the + icon to add the tunnel.
1. In the Android play store, search for "wireguard" and then tap **Install**.
2. After the successful installation, tap **Open**

<figure><img src="../../.gitbook/assets/add-wireguard-tunnel.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/search-wireguard.png" alt=""><figcaption><p>WireGuard application</p></figcaption></figure>

3. A list of options will appear from the bottom of the app. Click the _Import from file or archive_ option.
2. Tap the + icon to add the tunnel.

<figure><img src="../../.gitbook/assets/add-wireguard-tunnel.png" alt=""><figcaption><p>WireGuard application - Add tunnel</p></figcaption></figure>

3. A list of options appear at the bottom of the app. Tap the _Import from file or archive_ option.

<figure><img src="../../.gitbook/assets/import-from-file.png" alt=""><figcaption></figcaption></figure>

4. Select the WireGuard conf file provided by the system administrator. On successful tunnel creation, the tunnel name will appear at the top of the app.
4. Tap the WireGuard conf file provided by the system administrator.&#x20;
5. On successful tunnel creation, the tunnel name will appear at the top of the app.

<figure><img src="../../.gitbook/assets/inactive-wireguard-tunnel.png" alt=""><figcaption></figcaption></figure>

5. Activate the tunnel in WireGuard.
5. Tap to activate the tunnel in WireGuard.

<figure><img src="../../.gitbook/assets/active-wireguard-tunnel.png" alt=""><figcaption></figcaption></figure>
Loading

0 comments on commit 778a737

Please sign in to comment.