The Certificate Action is a configuration that defines how a certificate should be generated for a completed service application. This is done using a JSON structure, which tells the system what the certificate should look like, how long it should remain valid, and what kind of notifications should be sent.
Even if you are new to JSON, think of this as a set of instructions given to the system to automatically create and manage certificates.
{
"args": {
"certificateName": "Certificate_Name",
"certificateTemplateCode": {
"en-US": "en_US_CODE",
"fr-FR": "fr_FR_CODE",
"rw-RW": "rw_RW_CODE"
},
"certificateExpirationDays": 1000,
"certificateWithList": true,
"reminderOffsetDays": 5,
"reminderNotifications": {
"staticTemplate": {
"en": {
"smsBody": "...",
"subject": "Application Paid",
"emailBody": "..."
},
"fr": {
"smsBody": "...",
"subject": "Dossier Payee",
"emailBody": "..."
},
"rw": {
"smsBody": "...",
"subject": "Dosiye Yishyuwe",
"emailBody": "..."
}
},
"dynamicTemplate": null,
"notificationType": "STATIC"
}
},
"actionType": "GENERATE_CERTIFICATE"
}
| Field | Meaning | Example |
|---|---|---|
| certificateName | The name of the certificate that will be generated. | "Birth_Certificate" |
| certificateTemplateCode | The design/layout of the certificate for different languages (multi-locale support). | "en-US": "en_US_CODE" |
| certificateExpirationDays | Number of days before the certificate expires. | 1000 (about 3 years) |
| certificateWithList | Boolean (true/false). Defines if the certificate can be generated in bulk (list of beneficiaries). | true |
| reminderOffsetDays | Number of days before certificate expiration when a reminder notification should be sent. | 5 |
| reminderNotifications | Notification content sent to applicants (via SMS or email). | Customizable per language |
| staticTemplate | Fixed (pre-written) notification templates. | "subject": "Application Paid" |
| dynamicTemplate | Allows advanced users to define notifications dynamically (using variables). | null (not used here) |
| notificationType | Defines whether notification is STATIC or DYNAMIC. | "STATIC" |
| actionType | The type of action being performed — here, generating a certificate. | "GENERATE_CERTIFICATE" |