KYC Config Page #35716
KYC Config Page #35716
Conversation
zandre-eng
added
the
product/feature-flag
dimagimon
added
the
reindex/migration
corehq/apps/integration/kyc/forms.py
Outdated
| x_init='provider = $el.value', | ||
| x_show='showProvider', | ||
| ), | ||
| crispy.Field( |
There was a problem hiding this comment.
An open question I have is how to make the JSON field more user-friendly. Currently, it is simply a text box with JSON validation which can be difficult to correclty format JSON in. What makes this challenging is that the crispy form is loaded in as a partial HTML template, and so importing something like the base_ace JSON editor in the parent template is not possible.
There was a problem hiding this comment.
I took a quick look at QuillJS, which is currently being evaluated.
Would it be possible to load it in corehq/apps/integration/templates/kyc/kyc_config_base.html?
It looks like it has syntax highlighting for code blocks.
There was a problem hiding this comment.
Okay it looks like I managed to successfully load the base_ace JSON editor (8bc0145). The tricky part was with saving the form. When this happens the partial gets loaded again, causing the JSON editor to be removed. I managed to work around this by initializing the editor again after the form gets saved.
| api_field_to_user_data_map = JsonField( | ||
| label=_('API Field to User Data Map'), | ||
| required=True, | ||
| expected_type=list, |
There was a problem hiding this comment.
The model field is api_field_to_user_data_map = jsonfield.JSONField(default=dict). Should this be dict? i.e.
| expected_type=list, | |
| expected_type=dict, |
There was a problem hiding this comment.
The model field has been updated to take list as a default type here. The expected format for the API mapping will be something like this:
[
...
{
"fieldName": "foo",
"mapsTo": "bar",
"source": "standard"
}
...
]
corehq/apps/integration/kyc/forms.py
Outdated
| x_init='provider = $el.value', | ||
| x_show='showProvider', | ||
| ), | ||
| crispy.Field( |
There was a problem hiding this comment.
I took a quick look at QuillJS, which is currently being evaluated.
Would it be possible to load it in corehq/apps/integration/templates/kyc/kyc_config_base.html?
It looks like it has syntax highlighting for code blocks.
| form = self.config_form | ||
| show_success = False | ||
| if form.is_valid(): | ||
| form.save(commit=True) |
There was a problem hiding this comment.
I presume the fact that the form is a ModelForm will persist the model to the database with commit=True?
There was a problem hiding this comment.
That is correct. The save() function's help text reads "Save this form's self.instance object if commit=True...". I also verified this in my local testing by checking that the instance is actually getting saved with this function call.
|
Few nits, but otherwise good! |
Product Description
A new "KYC Configuration" page is added to the "Data" sidebar:
This new page shows the configuration settings for setting up KYC for a domain:
Please note that there is an extra "Provider" input on this page, however this is hidden due to there only currently being one available provider.
Upon clicking "Save", a new alert banner will be shown to the user if the form was successfully saved:
Technical Summary
Link to ticket here.
Link to design doc here.
Link to tech spec here.
This PR adds a new configuration page for the KYC feature. Specifically, this page will be used to set up the following:
Feature Flag
KYC_VERIFICATIONSafety Assurance
Safety story
Automated test coverage
New unit tests have been created to verify that a user cannot access the configuration page if they are not logged in or if the domain does not have access to the feature flag.
QA Plan
No QA planned.
Migrations
Rollback instructions
Labels & Review