Platform for deployment and maintenance of state electronic registers

The Registries Platform

    • What’s new
      • What’s new
      • Release notes
      • Breaking changes
      • Deprecated functionality
    • User documentation
      • Officers and services providers
        • Officer portal overview
        • Generating excerpts
          • Generating excerpts in DOCX format
          • Generating excerpts in CSV format
        • Sorting and pagination
          • Paginating and sorting tasks in the Officer portal
          • Paginating and sorting services in the Officer portal
          • Sorting services by execution status in the Officer portal
      • Citizens and service recipients
        • Citizen portal overview
        • Generating excerpts in PDF format
        • Sending messages to users
          • Sending inbox messages to users
          • Confirming email address with OTP code in user profile
        • Sorting and pagination
          • Paginating and sorting services in the Citizen portal
      • Registry user authentication
      • Contact support
        • Contacting support for critical errors
        • Contacting support for non-critical errors
      • Files
        • Uploading files in .p7s and .asics format in User portals
      • Notifying about successful task completion in User portals
      • Alerting pop-up windows for action confirmation in User portals
    • Platform administrators
      • Installing and configuring
        • Platform for state registries: requirements for OKD clusters
        • Deploying the Platform on target environments
          • Deploying the Platform in a public AWS cloud environment
          • Deploying the Platform in a public Azure cloud environment
          • Deploying the Platform in a public GCP cloud environment
          • Deploying the Platform in a private vSphere cloud environment
        • Configuring internal SMTP server
        • Changing the network provider of the OKD 4.x cluster
      • Managing the Platform and registries in the Control Plane
        • Creating Platform administrators
        • Deploying a registry
        • Viewing and editing registry configuration
        • Deleting a registry
        • Configuring registry access
        • Configuring digital signature keys and certificates
          • Updating the Platform digital signature keys and certificates
          • Updating registry digital signature keys and certificates
        • Managing registry resources
        • Configuring custom DNS
          • Configuring custom DNS for user portals
          • Configuring custom DNS for Keycloak
        • CIDR: Restricting access to Platform and registry components
        • Approving registry configuration update requests
        • Managing restrictions on digital document uploads
        • Quick links to registry services
      • Migration
        • Understanding our migration strategy
        • Migrating registries
      • Updating
        • Updating Platform infrastructure components
        • Updating registry components
        • Updating OpenShift cluster certificates
      • Backing up and restoring
        • Central components
          • Manual backing up and restoring central components
          • Setting up the central components backup schedule and retention time
        • Registry components
          • Manually backing up and restoring the registry
          • Setting up the registry backup schedule and retention time
        • Backing up and restoring registry databases
        • Restoring the cluster after changing the master nodes IP addresses
      • Scaling
        • Scaling registry resources
        • Scaling master nodes vertically for OKD on AWS and vSphere
      • Technical maintenance of Event logging subsystem (EFK)
        • Expanding space for Elasticsearch
      • Managing the distributed file system
        • Extending Ceph storage
        • Scaling the Ceph file system
        • S3 Ceph Object Storage
          • S3 Ceph Object Storage policy
      • Integrating with external systems
        • Integrating with external services using REST connector: Creating a service entry and authorization secret
      • Technical platform administrator crash course
        • Technical platform administrator: duties and responsibilities
        • Platform administrator tools
    • Registry development and support teams
      • Registry administrators
        • Who are the registry administrators
        • Deploying demo-registry with reference examples
        • Administrative portal
          • Managing registry regulations versions
            • Reviewing and configuring the master version
            • Creating merge requests
            • Reviewing metadata and managing the candidate version settings
          • Managing users
          • Registry modeling
            • Configuring global registry settings
            • Managing business process models
              • Creating business processes
              • Editing business processes
              • Searching for processes by name
              • Copying business processes
              • Uploading business processes
              • Sorting business processes
              • Categorizing available services in user portals
              • Deleting business processes
              • Viewing and editing business process components
                • Viewing and editing business process XML code representation
                • Modeling business processes in BPMN editor
                • Editing business process scripts in a visual code editor
            • Managing UI forms
              • Sorting UI forms
              • Viewing and editing a UI-form JSON representation
            • Tables
              • Registry data model tables and their structures
              • Modeling the structure of registry database tables in an XML code editor
            • Managing registry report templates
          • Contacting support for non-critical errors
        • Working with registry regulations in Gerrit
          • Registry regulations structure
          • Deploying regulations in Gerrit
          • Automatic validation of registry regulations changes
          • Registry regulations cleanup
        • Creating users in the system
          • Creating a user and granting access rights
          • Importing users through a file and granting access rights
          • Creating registry administrators
        • Configuring user authentication
          • Officers
            • Configuring authentication for officers
            • Configuring self-registration for officers
        • Working with registry databases
          • Interacting with the registry database through pgAdmin
        • Hierarchical model
        • Working with geodata in the registry
        • User notifications
          • Sending in-app notifications using a citizen portal inbox
            • Configuring in-app notifications
          • Sending email notifications
            • Setting up a message template with an email confirmation code
            • Notifying users via email
            • Configuring the mail server
        • Administering business processes
        • Reviewing the Platform event logs (Kibana)
          • Working with logs in Kibana UI
          • Visualizing a request state in Kibana during registry operation
        • Monitoring the Platform subsystems (Grafana)
          • Monitoring business process execution metrics
        • Managing registry settings (settings.yaml)
        • Changing registry deployment mode
        • Configuring registry excerpts: PDF, DOCX and CSV
        • Integrating with external registries and systems
          • Managing external integrations
          • Interacting via REST between Platform registries and with external systems
          • Calling external registries and systems
            • Other registries and systems
              • Integrating with external services using the REST connector: configuring the regulations
              • Configuring integrations with external systems in Control Plane
          • Providing registry API endpoints for integration
            • Configuring the regulations to provide access to data via SOAP and REST APIs
            • Other registries and systems
              • Calling the registry from an external system: getting a JWT token from Keycloak
          • Emulating external integrations
        • Managing API rate limits
        • Connecting to services remotely
      • Data modelers
        • Creating a logical data model
        • Creating a physical data model
          • Liquibase: physical data model creation and management tool
          • Standard Liquibase tags for data modeling
          • Liquibase extensions for data modeling
          • Scenarios for building the registry physical data model
          • Setting access attributes for registry API views
          • Generating a unique number for registry entities
          • Scenarios of combining tables using JOIN with additional AND OR conditions
        • Initial data loading
          • Preparing data for migration
          • Initial loading of registry data
        • Analytical reporting
          • Restricting data samples based on token information
      • Business process modelers
        • Business process modeling and decision tables
          • Business process extensions (Element templates)
            • User task extensions
              • User form
              • Officer sign task
              • Citizen sign task
            • Service task extensions
              • Managing users and roles
                • Add role to Keycloak user
                • Save user roles in Keycloak
                • Get roles from Keycloak
                • Searching users by equal and Inverse startsWith functions
                • Remove role from Keycloak user
              • Managing user settings
                • Read user settings
              • Creating entities
                • Create entity in data factory
                • Create nested entities in data factory
                • Batch creation of entities in data factory
                • Batch creation of entities in data factory v2
              • Reading and searching entities
                • Read entity from data factory
                • Batch Read entities from data factory
                • Search for entities in data factory
              • Updating entities
                • Update entity in data factory
                • Update entity in data factory partially
              • Deleting entities
                • Delete entity from data factory
              • Modeling digital signatures
                • Digital signature by DSO service
              • Integrating with external systems
                • Connect to external system v2
              • Modeling business process errors
                • Throw system error
                • Throw validation error
              • Modeling statuses
                • Define business process status
            • Call Activity extensions
              • Call Activity delegate
              • Check excerpt status delegate
            • Integrating extensions
              • Start business process in another registry
              • Search for entities in another registry data factory
          • Modeling elements
            • Tasks
            • Gateways
              • Exclusive event-based gateway
            • Events
              • Link event
              • Message event
              • Timer event
              • Error event
            • Subprocesses
              • Embedded subprocess
              • Call Activity
              • Event subprocess
              • Transaction subprocess
                • Error event in a transaction subprocess
                • Cancel event
          • Modeling facilitation
            • JUEL functions in business processes
            • Configuring business keys in business processes
            • Partial entity update in data factory
          • Supporting alternative branches in business processes
          • Granting access to business processes and user tasks
            • Business process modeling and access control (RBAC)
            • Granting organization access to business process tasks at the level of user attributes
          • Modeling excerpts
            • Modeling business processes for generating excerpts in csv and docx format
          • Notifying users via email
          • Uploading data from a CSV file as an array into a database
          • Downloading digital documents at an external link
          • Setting global registry variables
        • Modeling UI forms for business processes
          • Form modeling process
          • UI form modeling components
            • General recommendations
              • Variables in JavaScript insertions
            • Text Field
            • Content
            • Columns
            • Field Set
            • Email
            • Text Area
            • Table
            • Number
            • Edit Grid
              • Saving form data to the database as an array
              • Setting the sort type for columns in the Edit Grid component
            • Date/Time
            • Checkbox
            • Select
              • Configuring the Select component to get and filter data from API resources
              • Using the "Refresh Options On" function in the updated Select component
            • Radio
            • File
              • Loading multiple files in one field using the File component
            • Data Import
            • Button
              • Button
              • Modeling confirmation dialogues in the Button component
            • Map
              • Map component
        • Integrating with external registries and systems
          • Calling external registries and systems
            • SOAP integration
              • SOAP-based integration connectors with other registries
            • Other systems
              • Modeling business processes using the "Connect to external system" delegate
      • Learning
        • Registry regulations development training course
          • Study tasks
            • Task 1. Modeling registry database structures
            • Task 2. Modeling a business process without integration
            • Task 3. Modeling a business process with integration
            • Task 4. Modeling a business process with a start form and dependent form components
            • Task 5. Modeling a business process with multiple participants
            • Task 6. Developing analytical reports
          • Tests
            • Test 1
            • Test 2
            • Test 3
        • Study materials for registry administrators
          • Registry administrator: duties and responsibilities
          • Registry administrators onboarding
      • Best practices
        • Business process reference examples
          • Launching a business process by schedule
          • Self-registration
            • Self-registering officers with manual moderation
          • Selecting and acting on one or multiple rows in a table
          • Uploading and editing a file
      • Classes of IT systems that can be built on the Registries Platform
    • Platform development team
      • Software development and quality control practices
    • Technical documentation
      • Architectural documentation
        • Platform conceptual architecture
        • Platform logical architecture
        • Platform deployment architecture
        • Platform system requirements
          • Calculating registry cost
        • Security architecture
          • Standards and compliance
          • Data classification
          • Encryption at rest
          • Encryption in transit
          • Data retention
          • Secrets management
          • Access control
          • Data integrity
        • Platform technology stack
        • Container orchestration platform
          • Key subsystem aspects
            • Automatic horizontal scaling of cluster node instances
        • Platform subsystems
          • Platform administrative zone
            • Platform and registries management subsystem
              • Registry configuration structure
              • Platform configuration structure
              • Subsystem evolution
                • Managing registry backup schedule and retention
                • Separating digital certificate and key updating processes
                • Configuring custom URL for Keycloak
                • Editing registry settings by version
                • Managing settings and secrets for external integrations
                • Deploying a demo registry with reference modeling examples
            • Subsystem for deploying and configuring the Platform and registries
              • Subsystem evolution
                • Configuring custom DNS name for registry portals in OpenShift 4.x
                • Secure resource publishing in OpenShift 4.x cluster
                • Setting up Platform and registry administrators
                • Platform deployment in production without registry development tools
                • Updating platform and registry keys and digital signature service configuration
          • Platform operational zone
            • External traffic management subsystem
            • Users and roles management subsystem
              • Platform actors and roles
              • Subsystem evolution
                • Authorizing users
                  • Registry roles
            • Cross-service communication management subsystem
              • Service Mesh: Platform and registry components
              • Key subsystem aspects
                • Validating JWT with Istio Envoy
            • Secret and encryption management subsystem
            • Event logging subsystem
            • Event monitoring and notification subsystem
              • Subsystem evolution
                • Monitoring the general metrics of business process execution
            • Request tracing subsystem
            • Distributed data storage subsystem
            • Email messaging subsystem
            • Backup and restore subsystem
    • Quality attributes testing
      • Functional testing
      • Performance testing
      • Security testing
    • Glossary
The Registries Platform 1.9.6
  • The Registries Platform
    • 1.9.6
    • 1.9.5
    • 1.9.4
  • The Registries Platform
  • Registry development and support teams
  • Registry administrators
  • User notifications
  • Sending email notifications
1.9.6 1.9.5 1.9.4
Українська English

Sending email notifications

On this page:
  • 1. Section overview

The Platform supports sending email messages via the SMTP protocol using an internal (Platform) or external mail server.

email-notification
Figure 1. Sample email with a verification code

1. Section overview

  • Setting up a message template with an email confirmation code

  • Notifying users via email

  • Configuring the mail server

© 2023 The Registries Platform.