21
State DBT Portal data exchange with DBT Bharat Portal Integration framework April, 2018

State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

  • Upload
    others

  • View
    0

  • Download
    0

Embed Size (px)

Citation preview

Page 1: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

State DBT Portal data exchange with DBT Bharat

Portal

Integration framework

April, 2018

Page 2: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

1.Version Control Table

Sr No.

Version

Change Brief UpdatedDate

Remarks

(if any)1 V2 Included tags for revised 5 MPR sections Oct 2017 -

2 V3 Included/updated below fields:-Expenditure tag for inkind and composite schemes-MIS Scheme Integration Status Options Rename-Expenditure-incurred(through through Aadhaar-Authentication (/ Validated Transaction) field for DBT Expenditure Incurred (Inkind and composite schemes)

Apr 2018 -

State DBT Portal – Integration Framework 2

Page 3: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

Contents1. State DBT Portal...............................................................................................................4

a. Overview..........................................................................................................................4

b. Objective..........................................................................................................................4

c. Data Exchange Format.................................................................................................4d. Pre requisite to Integrate..........................................................................................12

2. Integration Approach...................................................................................................133. Web Services based Integration...............................................................................154. Integration Process with DBT Bharat Portal......................................................16

State DBT Portal – Integration Framework 3

Page 4: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

1.State DBT Portala. Overview

The purpose of this document is to provide an unde₹tanding of the State / State Specific CSS schemes data exchange through State DBT Portal to DBT Bharat Portal on monthly basis.

DBT Bharat Portal is a web based Portal developed by DBT Mission to provide aggregated real time view of DBT applicable schemes running in center as well as state and get aggregated dashboard and information.

State has complete access of the Portal which can be modified or enhanced by their own IT team / pe₹on as per business requirement of state.

b. Objective

Once State DBT Portal gets data from state departments and generate aggregated report and view, aggregated data of schemes from State DBT Portal will be shared on monthly basis to DBT Bharat Portal.

To share the aggregated data with State DBT Portal, data format along with approach has been defined.

c. Data Exchange Format

To show the aggregated information of State within scheme or across schemes in each location, below mentioned format has been defined.

Fields related to Cash Benefit Type Schemes.

Cash Scheme Format

SNO Field name Format / Type Description

Scheme General Information

1 Scheme Code* String5 digit alphanumeric code generated from DBT Bharat Portal started with C, D or E

State DBT Portal – Integration Framework 4

Page 5: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

2Status of Scheme Specific MIS, integration and data

reporting*String

Please pass relevant status from below options- Online system / MIS at

Conceptual Stage Online system / MIS under

development Online system / MIS

implemented at field level (Roll out) and data reported manually

Online system / MIS integrated with State DBT Portal but data reported manually

Online system / MIS integrated with State DBT Portal and report submitted through web-services

3 Central Allocation for the State (in ₹) (in FY 2017-18) String

Fund Allocation by Central (for CSS scheme only)N/A for State scheme

4 State Normative Allocation(in ₹) (in FY 2017-18) String Fund Allocation by State (for

CSS / State Scheme)

5Additional State Allocation (if any) (in ₹) (in FY 2017-

18)String Any Additional Fund Allocation

by State

6 Remarks String Any information to be shared by State

Scheme Monthly Progress Information7 Year* String Year for which data will be

exchanged

8 Month* String Month for which data will be exchanged

9Number of beneficiaries as

per Central Allocation(should be unique

cumulative)String

No. of beneficiaries as per central government fund allocation under the scheme (for CSS scheme)

10

Number of additional beneficiaries supported by

State , if any(should be unique

cumulative)

StringNo. of additional beneficiaries supported by State fund allocation under the scheme (for CSS / State scheme)

11Total No. of Beneficiaries*

(should be unique cumulative)

String Total number of beneficiaries in the scheme (cumulative)

12No. of beneficiaries

digitized(should be unique

cumulative)String

Total number of beneficiaries digitized in scheme MIS (cumulative)

State DBT Portal – Integration Framework 5

Page 6: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

13

No. of Aadhaar authenticated and seeded

Beneficiaries(should be unique

cumulative)

StringTotal number of Aadhaar authenticated and seeded beneficiaries in the scheme (cumulative)

14

No. of Beneficiaries for whom mobile number is

captured(should be unique

cumulative)

StringTotal number of beneficiaries for whom mobile number is captured (cumulative)

15 Central Share fund transferred String

Cash Scheme - Fund disbursed in a month from Central funded amount (for CSS scheme)

16 Normative - State Share fund transferred String

Cash Scheme - Fund disbursed in a month from State funded amount (for CSS / State scheme)

17Additional State Contributed fund

transferredString

Cash Scheme - Fund disbursed in a month from State funded additional contributed amount (for CSS scheme)

18 Total Fund transferred StringCash Scheme - Fund disbursed in a month (aggregated in a month)

19State Share fund

transferred to additional beneficiaries supported by

StateString

Cash Scheme - Fund disbursed in a month from State fund to additional beneficiaries (which are not covered under central fund) (for CSS scheme)

20 Total No. of Transactions for Electronic Modes String

Cash Scheme - Total number of transactions for electronic modes fund transferred to beneficiaries in a month

21 Electronic Modes (ABP, NEFT, RTGS, AEPS) (in ₹) String

Cash Scheme - Total fund disbursed through electronic modes in a month

22 Total No. of Transactions for Other Modes String

Cash Scheme - Total number of transactions for other modes fund transferred to beneficiaries in a month

23 Other Modes (Cash, Cheque, DD, MO) (in ₹) String

Cash Scheme - Total fund disbursed through other modes in a month

24 Unit of Measurement String NA25 Quantity Transferred String NA

26Total No. of Validated

Transactions Aadhar based authentication

String NA

State DBT Portal – Integration Framework 6

Page 7: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

27

Total Expenditure incurred through Aadhaar

Authentication / Validated Transaction 

(in ₹)

String NA

28 No. of Records De Duplicated String

Number of beneficiaries removed due to de-duplication using Aadhaar

29 No. of Ghost / Fake Beneficiaries removed String Number of fake / ghost

beneficiaries removed

30Other Savings due to

process improvement / efficiency

String Other Savings due to process improvement / efficiency

31 Saving Amount (in ₹) StringSaving occurred due to removal of fake / ghost / de-duplicated beneficiaries

32 RequestID* String A Unique id for each Web Request generated by Source

33 Remarks String Remarks Description; if any

Note: *(asterisk marked) cells are mandatory to provide minimum information.

Fields related to In Kind Benefit Type Schemes.

In Kind Scheme Format

SNO Field name Format / Type Description

Scheme General Information

1 Scheme Code* String5 digit alphanumeric code generated from DBT Bharat Portal started with C D or E

2 Status of Scheme Specific MIS, integration and data

reporting*

String Please pass relevant status from below options- Online system / MIS at

Conceptual Stage Online system / MIS under

development Online system / MIS

implemented at field level (Roll out) and data reported manually

Online system / MIS integrated with State DBT Portal but data reported manually

Online system / MIS integrated with State DBT Portal and

State DBT Portal – Integration Framework 7

Page 8: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

report submitted through web-services

3 Central Allocation for the State (in ₹) (in FY 2017-18) String

Fund Allocation by Central (for CSS scheme only)N/A for State scheme

4 State Normative Allocation (in ₹) (in FY 2017-18) String Fund Allocation by State (for

CSS / State Scheme)

5Additional State Allocation (if any) (in ₹) (in FY 2017-

18)String Any Additional Fund Allocation

by State

6 Remarks String Any information to be shared by State

Scheme Monthly Progress Information7 Year* String Year for which data will be

exchanged

8 Month* String Month for which data will be exchanged

9 Number of beneficiaries as per Central Allocation String

No. of beneficiaries as per central government fund allocation under the scheme (for CSS scheme)

9Number of additional

beneficiaries supported by State , if any

StringNo. of additional beneficiaries supported by State fund allocation under the scheme (for CSS / State scheme)

10 Total No. of Beneficiaries* String Total number of beneficiaries in the scheme (cumulative)

11 No. of beneficiaries digitized String

Total number of beneficiaries digitized in scheme MIS (cumulative)

12No. of Aadhaar

authenticated and seeded Beneficiaries

StringTotal number of Aadhaar authenticated and seeded beneficiaries in the scheme (cumulative)

13 No. of Beneficiaries for whom mobile number is

capturedString

Total number of beneficiaries for whom mobile number is captured (cumulative)

14 Central Share fund transferred String NA

15 Normative - State Share fund transferred String NA

16Additional State Contributed fund

transferredString NA

State DBT Portal – Integration Framework 8

Page 9: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

17 Total Fund transferred String NA

18State Share fund

transferred to additional beneficiaries supported by

StateString NA

19 Total No. of Transactions for Electronic Modes String NA

20 Electronic Modes (ABP, NEFT, RTGS, AEPS) (in ₹) String NA

21 Total No. of Transactions for Other Modes String NA

22 Other Modes (Cash, Cheque, DD, MO) (in ₹) String NA

23 Unit of Measurement StringIn Kind Scheme - Quantity units which transferred to beneficiary such as MT, Pieces (books, laptops etc.)

24 Quantity Transferred StringIn Kind Scheme - No. of In kind product transferred to beneficiary in a month

25Total No. of Validated

Transactions Aadhar based authentication

StringIn Kind Scheme -Total No. of Aadhaar based / authenticated inkind Transaction in a month

26

Total Expenditure incurred through Aadhaar

Authentication / Validated Transaction 

(in ₹)

String

In Kind Scheme -Total Expenditure incurred through Aadhaar Authentication / Validated Transaction (Bio / Demo / OTP / e-Sign)

27 No. of Records De Duplicated String

Number of beneficiaries removed due to de-duplication using Aadhaar

28 No. of Ghost / Fake Beneficiaries removed String Number of fake / ghost

beneficiaries removed

29Other Savings due to

process improvement / efficiency

String Other Savings due to process improvement / efficiency

30 Saving Amount (in ₹) StringSaving occurred due to removal of fake / ghost / de-duplicated beneficiaries

31 RequestID* String A Unique id for each Web Request generated by Source

State DBT Portal – Integration Framework 9

Page 10: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

32 Remarks String Remarks Description; if any

Note: *(asterisk marked) cells are mandatory to provide minimum information.

Fields related to Composite (Cash-inkind) Benefit Type Schemes.Cash Scheme Format

SNO Field name Format / Type Description

Scheme General Information

1 Scheme Code* String5 digit alphanumeric code generated from DBT Bharat Portal started with C, D or E

2Status of Scheme Specific MIS, integration and data

reporting*String

Please pass relevant status from below options- Online system / MIS at

Conceptual Stage Online system / MIS under

development Online system / MIS

implemented at field level (Roll out) and data reported manually

Online system / MIS integrated with State DBT Portal but data reported manually

Online system / MIS integrated with State DBT Portal and report submitted through web-services

3 Central Allocation for the State (in ₹) (in FY 2017-18) String

Fund Allocation by Central (for CSS scheme only)N/A for State scheme

4 State Normative Allocation(in ₹) (in FY 2017-18) String Fund Allocation by State (for

CSS / State Scheme)

5Additional State Allocation (if any) (in ₹) (in FY 2017-

18)String Any Additional Fund Allocation

by State

6 Remarks String Any information to be shared by State

Scheme Monthly Progress Information7 Year* String Year for which data will be

exchanged

8 Month* String Month for which data will be exchanged

9 Number of beneficiaries as String No. of beneficiaries as per

State DBT Portal – Integration Framework 10

Page 11: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

per Central Allocation(should be unique

cumulative)

central government fund allocation under the scheme (for CSS scheme)

10

Number of additional beneficiaries supported by

State , if any(should be unique

cumulative)

StringNo. of additional beneficiaries supported by State fund allocation under the scheme (for CSS / State scheme)

11Total No. of Beneficiaries*

(should be unique cumulative)

String Total number of beneficiaries in the scheme (cumulative)

12No. of beneficiaries

digitized(should be unique

cumulative)String

Total number of beneficiaries digitized in scheme MIS (cumulative)

13

No. of Aadhaar authenticated and seeded

Beneficiaries(should be unique

cumulative)

StringTotal number of Aadhaar authenticated and seeded beneficiaries in the scheme (cumulative)

14

No. of Beneficiaries for whom mobile number is

captured(should be unique

cumulative)

StringTotal number of beneficiaries for whom mobile number is captured (cumulative)

15 Central Share fund transferred String

Cash Scheme - Fund disbursed in a month from Central funded amount (for CSS scheme)

16 Normative - State Share fund transferred String

Cash Scheme - Fund disbursed in a month from State funded amount (for CSS / State scheme)

17Additional State Contributed fund

transferredString

Cash Scheme - Fund disbursed in a month from State funded additional contributed amount (for CSS scheme)

18 Total Fund transferred StringCash Scheme - Fund disbursed in a month (aggregated in a month)

19State Share fund

transferred to additional beneficiaries supported by

StateString

Cash Scheme - Fund disbursed in a month from State fund to additional beneficiaries (which are not covered under central fund) (for CSS scheme)

20 Total No. of Transactions for Electronic Modes String

Cash Scheme - Total number of transactions for electronic modes fund transferred to beneficiaries in a month

State DBT Portal – Integration Framework 11

Page 12: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

21 Electronic Modes (ABP, NEFT, RTGS, AEPS) (in ₹) String

Cash Scheme - Total fund disbursed through electronic modes in a month

22 Total No. of Transactions for Other Modes String

Cash Scheme - Total number of transactions for other modes fund transferred to beneficiaries in a month

23 Other Modes (Cash, Cheque, DD, MO) (in ₹) String

Cash Scheme - Total fund disbursed through other modes in a month

24 Unit of Measurement StringIn Kind Scheme - Quantity units which transferred to beneficiary such as MT, Pieces (books, laptops etc.)

25 Quantity Transferred StringIn Kind Scheme - No. of In kind product transferred to beneficiary in a month

26Total No. of Validated

Transactions Aadhar based authentication

StringIn Kind Scheme -Total No. of Aadhaar based / authenticated inkind Transaction in a month

27

Total Expenditure incurred through Aadhaar

Authentication / Validated Transaction 

(in ₹)

String

In Kind Scheme -Total Expenditure incurred through Aadhaar Authentication / Validated Transaction (Bio / Demo / OTP / e-Sign)(in ₹)

28 No. of Records De Duplicated String

Number of beneficiaries removed due to de-duplication using Aadhaar

29 No. of Ghost / Fake Beneficiaries removed String Number of fake / ghost

beneficiaries removed

30Other Savings due to

process improvement / efficiency

String Other Savings due to process improvement / efficiency

31 Saving Amount (in ₹) StringSaving occurred due to removal of fake / ghost / de-duplicated beneficiaries

32 RequestID* String A Unique id for each Web Request generated by Source

33 Remarks String Remarks Description; if any

d. Pre requisite to Integrate

Department has to ensure key functionality in State DBT Portal-

State DBT Portal – Integration Framework 12

Page 13: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

1) Scheme Code integration – Scheme code to be generated through DBT Bharat Portal (https://dbtbharat.gov.in), which is 5 digit code and used in State DBT Portal.

2) All relevant fields’ availability as mentioned in above section

State DBT Portal – Integration Framework 13

Page 14: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

2.Integration Approach

State DBT Cell has to take care following activities which are not only related to technical enablement but also process readiness.

SNo. Activity Detail Document / Attachment (if any)

DBT Bharat Portal Integration

I Scheme Code to be generated

State has to generate the scheme code from DBT Bharat Portal and need to incorporate into Scheme MIS against the scheme

5 digit alphanumeric

number to be generated

and mentioned into

Scheme level MIS

system as well as State

DBT Portal while adding

scheme

ii Webservice URL to be shared

State DBT Cell technical person has to share webservice URL with WSDL details with DBT Mission Technical team (at [email protected]) to integrate with DBT Bharat Portal

Once above steps will be completed, DBT Bharat Portal Technical Team will verify data published from State DBT Portal and map with DBT Bharat Portal based on scheme code

Before schedule webservice, a Standard Operating procedure (SOP) document will be finalized between DBT Cell and Department for seamless data exchange.

iii Technology Enablement

Please refer below section

a. Approach to update DBT scheme data on DBT Bharat Portal

Web Service Based Integration: This is the only (automated) process to share the data with DBT Bharat Portal. In this approach, State DBT Portal has to generate the

State DBT Portal – Integration Framework 14

Page 15: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

webservice in defined signature and share with DBT Mission technical team. Detail information provided in section 3.

Note:

Data uploaded should be incremental except for beneficiaries details which should be unique cumulative)

Data ownership lies with State, DBT Bharat Portal is just an aggregator to show the data in reports which will be used in multiple review meetings.

Manual Data Entry has been disabled.

State DBT Portal – Integration Framework 15

Page 16: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

3.Web Services based Integration

Process of Interaction: Interaction of DBT Bharat Portal with Schemes is depicted below.DBT Bharat Portal will call a Web service exposed by the scheme by passing Scheme Code (5 digit alphanumeric number - generated on DBT Bharat Portal), Date as request parameters State DBT Portal will send back the following details in response:

1) Complete Dataset OR 2) No Data if No Records are found OR 3) Error Message if there was some issue. Technology Details

Technology: Restful web service / SOAPResponse: XMLUsage: This web service will push/insert beneficiary data to DBT Portal database for specific scheme.Limitation: It only appends beneficiaries’ data into existing data.Server: DBT Bharat Portal Every time, system will publish monthly incremental data (except for beneficiaries details which should be unique cumulative) to DBT Bharat Portal.To use this Service follow steps are needed:

Data should be prepared in discussed XML format before pushing it to DBT Bharat Portal.

Response: XML will be taken by DBT Bharat Portal in response and need to grab response and update accordingly. Fields in XML given below:

Sample Xml and xsd

A sample xml and xsd have been attached for reference

XSD file:

State DBT Portal – Integration Framework 16

Page 17: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

XML files:

How webservice will work:

1. State DBT Portal needs to publish the scheme wise webservices which must consume 2 paramete₹

a. Scheme Code – 5 digit alphanumeric number generated through DBT Bharat Portal by Department DBT Cell coordinator.

b. Date in dd/mm/yyyy (assumed incremental data will be provided by State against the scheme code on monthly basis)

2. Instead of individual scheme data, State DBT Portal can share all DBT Schemes monthly data in single request whose scheme codes are mapped with DBT Bharat Portal. DBT Bharat Portal will send parameters as scheme code = 00 along with date to get last month data.

3. Once DBT Mission IT team will receive the xml response, DBT Bharat Portal will be updated. Once data is received by Portal, if Portal try to retrieve again that will give with message that Data is already provided. This will help to remove duplication error.

4. If DBT Bharat Portal gets error response, DBT Bharat portal will try to consume again. Still it fails, we will inform State DBT Cell to correct the issue/ error and inform via mail to pull the data for defined month. DBT Bharat Portal will fetch (invoke the webservice) after getting State confirmation.

5. If DBT Bharat Portal gets no record, DBT Bharat Portal IT team will inform to State DBT cell on this. If any correction need to be done, State DBT cell needs to be confirmed to fetch data again (on request basis).

State DBT Portal – Integration Framework 17

Page 18: State DBT Portal - Direct Benefit Transfer · Web viewThe purpose of this document is to provide an unde tanding of the State / State Specific CSS schemes data exchange through State

4.Integration Process with DBT Bharat PortalBelow are the points which brief about integration process once State DBT Portal is hosted successfully in the PRODUCTION environment:

1. State DBT Portal IT team will provide webservice URL (Test / Production) to DBT Mission Technical Team (at [email protected])

2. DBT Mission technical team will access the webservice URL at test instance and verify the format (as provided in integration document)

3. If any discrepancy, DBT Mission Technical team will intimate to State Technical team to fix that

4. Once format is verified, both teams will verify the data (may be atleast test data) against each field / parameter

5. Once State DBT Portal - production webservice URL will be available, please share the webservice URL and IP / Port details to DBT Mission for whitelisting at Firewall level so that communication can be established.

6. DBT Mission team will raise firewall request to NIC firewall team which will go for approval process and take ~8-10 working days. Same may be required at state level to provide access for DBT Bharat Portal, which has to be carried out by State IT team.

7. Once request Firewall access request is executed, production webservice URL access to be verified on DBT Bharat Portal (production instance)

8. DBT Mission team will share webservice SOP document which has to be filled by Scheme MIS IT team along with providing details of Technical nodal person and when to schedule webservice in auto-mode

9. DBT Mission team will verify information and will execute webservice on production with concurrence with Scheme MIS IT team

10.Scheme MIS IT team to verify production data which we are receiving once, before scheduling in auto mode

11.Once confirmed, DBT Bharat Portal will get data and will be shown on MPR page and based on defined date, data will be pulled from Scheme MIS for previous month accordingly

State DBT Portal – Integration Framework 18