|
| 1 | +# Compliance information when publishing |
| 2 | + |
| 3 | +_Introduced in v13_ |
| 4 | + |
| 5 | +InvenioRDM lets you customize the confirmation information shown to users when publishing records, such as terms of service, data policy, or other compliance requirements. This flexibility supports custom publishing workflows and helps ensure users acknowledge your organization's policies. |
| 6 | + |
| 7 | +## Configure checkboxes |
| 8 | +InvenioRDM requires users to confirm compliance both when submitting a record for review and when publishing directly. Each interface can be configured independently, allowing you to tailor the compliance workflow to your organization's needs. |
| 9 | + |
| 10 | +In your `mapping.js`, parametrize the your UI components by adding a new `extraCheckboxes` parameter in the following format: |
| 11 | + |
| 12 | +```javascript |
| 13 | +import { PublishModal } from "@js/invenio_rdm_records"; |
| 14 | +import { parametrize } from "react-overridable"; |
| 15 | + |
| 16 | +const parameters = { |
| 17 | + extraCheckboxes: [ |
| 18 | + { |
| 19 | + fieldPath: "acceptTermsOfService", // give it an unique name |
| 20 | + text: i18next.t( |
| 21 | + "I confirm that this record complies with the data policy and terms of service." |
| 22 | + ), // define the text to show |
| 23 | + }, |
| 24 | + ], |
| 25 | +}; |
| 26 | + |
| 27 | +const PublishModalComponent = parametrize(PublishModal, parameters); |
| 28 | + |
| 29 | +export const overriddenComponents = { |
| 30 | + "InvenioRdmRecords.PublishModal.container": PublishModalComponent, // applied only to the confirmation box when publishing directly |
| 31 | +}; |
| 32 | +``` |
| 33 | + |
| 34 | + |
| 35 | + |
| 36 | +### Configure extra messages |
| 37 | +You can also show information messages before and after the compliance checkboxes section. In your `mapping.js`, define: |
| 38 | + |
| 39 | +```javascript |
| 40 | +import { i18next } from "@translations/invenio_rdm_records/i18next"; |
| 41 | +import { SubmitReviewModal } from "@js/invenio_rdm_records"; |
| 42 | +import { parametrize } from "react-overridable"; |
| 43 | + |
| 44 | +const LegalDisclaimer = () => ( |
| 45 | + <> |
| 46 | + <p className="text-xs"> |
| 47 | + By publishing, you agree to our <a href="/terms" className="underline">terms of service</a>. |
| 48 | + </p> |
| 49 | + <p className="text-xs mt-1">This action is irreversible.</p> |
| 50 | + </> |
| 51 | +); |
| 52 | + |
| 53 | +const parameters = { |
| 54 | + beforeContent: <p className="text-sm mb-2">Please review before continuing:</p>, |
| 55 | + afterContent: <LegalDisclaimer />, |
| 56 | +}; |
| 57 | + |
| 58 | +const SubmitReviewModalComponent = parametrize(SubmitReviewModal, parameters); |
| 59 | + |
| 60 | +export const overriddenComponents = { |
| 61 | + "InvenioRdmRecords.SubmitReviewModal.container": SubmitReviewModalComponent, // applied only to the confirmation box when submitting for review |
| 62 | +}; |
| 63 | +``` |
| 64 | + |
| 65 | + |
| 66 | + |
| 67 | +Don't forget to re-build the assets for the changes to take effect. |
| 68 | + |
| 69 | +```sh |
| 70 | +invenio-cli assets build |
| 71 | +``` |
| 72 | + |
0 commit comments