Skip to content

Latest commit

 

History

History
155 lines (100 loc) · 8.65 KB

configure-the-payments-file-with-qr-code.md

File metadata and controls

155 lines (100 loc) · 8.65 KB
layout
title description tableOfContents outline pagination
visible
true
visible
visible
true
visible
true
visible
true

📔 Configure the Payments File with QR Code

This guide provides instructions to configure the payments file with QR Code.

Prerequisites

  • The user must have Program Administrator role.
  • The user must have access to Program module in Open G2P systems.

Procedure

  1. Click the main menu icon and select Programs.

Programs screen is displayed.

  1. Click the Configuration in the menu bar and then select Payments File Configs.

Payments File Configs screen is displayed.

  1. Click the Create button.

Payments File Configs /New screen is displayed.

The fields and their descriptions are given below:

Field Description
Name Enter the name for the payments file configuration
Type

Select the format for the payments file from the drop-down. The valid values are:

  • PDF
  • CSV
Template Click the template tab to add the template of the payments file
QR Codes Click the QR codes to configure the QR codes in the payments file

Configure QR codes in payments file

  1. Click the QR Codes tab and click the Add a line link.

Create Qrcode Config screen is displayed.

The fields and their descriptions are given below:

Field Description
Name Enter the name for the QR code
Type

Select the appropriate option from the drop-down. The available options are:

  • QR code
  • Code 128 Barcode
Data Type

Select the appropriate option from the drop-down. The available options are:

  • String
  • JSON
  • JWT
Body Fill the body based on the selected datatype
Qrcode Version Enter the Qrcode version, if required. It is an optional field.
Qrcode Error Correct

Select the appropriate option from the drop-down. The available options are:

  • ERROR_CORRECT_M
  • ERROR_CORRECT_L
  • ERROR_CORRECT_H
  • ERROR_CORRECT_Q

It is an optional field.
Qrcode Box Size Enter the size of the Qrcode box. Default size is 10. It is an optional field.
Qrcode Border Enter the number of border for the QR code. Default border count is 4. It is an optional field.

Based on the requirement you can configure QR code with different data types.

  • Configure QR code with the data types:
    • string
    • JSON
    • JWT

{% tabs %} {% tab title="String" %}

Configure QR code with data type - string

  1. Select the String from the data type drop-down.

If you want to configure QR code with minimum values, then select the data type as string (i.e., a normal string to display inside the QR code). For example, the Qr codes may contain any one of the values like beneficiary ID, national ID, URL and so on.

  1. Click the Save & Close button to save Qrcode configuration.
  2. Click the Discard button to exit from the screen.
  3. Click the Save & New button to save and to create new Qrcode configuration.

The created Qrcode Config is displayed in the QR Codes list.

{% endtab %}

{% tab title="JSON" %}

Configure QR code with data type - JSON

  1. Select the JSON from the data type drop-down.

If you want to configure a QR code with more data, then select the data type as JSON (i.e., more data to display inside the QR code). For example, the QR code may contain data like issuer, subject, audience, expiry, amount, type, code, beneficiary name, service provider name, and so on.

  1. Click the Save & Close button to save Qrcode configuration.
  2. Click the Discard button to exit from the screen.
  3. Click the Save & New button to save and to create new Qrcode configuration.

The created Qrcode Config is displayed in the QR Codes list.

{% endtab %}

{% tab title="JWT" %}

Configure QR code with data type - JWT

  1. Select the JWT from the data type drop-down.

If you want to configure a QR code with a digitally signed JSON data, select the data type as JWT (i.e., digitally signed JSON data to display inside the QR code). For example, the QR code may contain digitally signed JSON data like issuer, subject, audience, expiry, amount, type, code, beneficiary name, service provider name, and so on.

  1. Click the Save & Close button to save the Qrcode configuration.
  2. Click the Discard button to exit from the screen.
  3. Click the Save & New button to save and to create new Qrcode configuration.

The created Qrcode Config is displayed in the QR Codes list.

{% endtab %} {% endtabs %}

Render QR codes

After you configured the QR code, you must render QR codes in the template.

  • Click the Template tab.

It displays the html code. Template contains the html code which defines the appearance of the files in PDF format.

In the html code, search for the image source and update the QR code name that must appear in pdf format. For example

<img style="height:1.75in;width:1.75in;" t-att-src="object.qrcode_ids.get_by_name('<QR code name>').content_htmlsafe"/>.

Sample file with QR code