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 services
          • 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 distributed file system (Ceph)
        • Initial configuration for Scrubbing and Deep Scrubbing in a Ceph cluster
        • Ceph cluster maintenance and related operations
        • Ceph OSD scaling and rebalancing
        • Extending Ceph storage
        • Scaling the Ceph file system
        • Migrating registry database instance disks from ceph-rbd to cloud storage disk types
        • 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 maintenance 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
              • Creating UI-forms
              • Editing UI forms
              • Searching registry UI forms
              • Copying UI forms
              • Downloading UI forms
              • Sorting and paginating UI forms
              • Deleting UI forms
              • Viewing and editing a UI form JSON representation
              • Form editing tabs
            • 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 Platform systems (Grafana)
          • Monitoring business process execution metrics
          • Monitoring metrics of public API
        • 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
          • Your team consumes API
            • Integrating with external services using the REST connector: configuring the regulations
            • Configuring integrations with external systems in Control Plane
          • Your team exposes API
            • Private data
              • Configuring the regulations to provide access to data via SOAP and REST APIs
              • Calling the registry from an external system: getting a JWT token from Keycloak
            • Public data
              • Configuring access to registry’s public data
          • Emulating external integrations
        • Managing API rate limits
        • Connecting to services remotely
        • Configuring logo and favicon for registry portals
      • 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
        • Modeling business processes and decision tables
          • What are business processes: analysis, structure and operation types
          • Business process integration extensions (Element templates)
            • Installing extensions to business processes (for local development)
            • 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 subprocesses
                • Transaction subprocess
                • Події «Помилка» у транзакційному підпроцесі
                • Cancel event
            • Execution listeners
          • 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
        • Data structures
          • Database optimization and manual change history management
      • 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
        • System requirements
          • System requirements for the Platform instance
          • System requirements for the Registry instance
        • Security architecture
          • Standards and compliance
          • Data classification
          • Encryption at rest
          • Encryption in transit
          • Data retention
          • Secrets management
          • Access control
          • Data integrity
        • Platform technology stack
        • Platform quality attributes
          • Portability
          • Scalability
          • Availability
          • Performance
          • Security
          • Observability
          • Auditability
          • Interoperability
          • Operability
          • Modifiability
          • Verifiability
        • 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
        • Registry subsystems
          • Administrative zone
            • External traffic management subsystem
              • Non-relational data storage
              • Subsystem evolution
                • Kong API gateway: route structure for external administrative endpoints
            • Registry regulations modeling subsystem
              • Digital registry regulations
              • Object data storage
              • Subsystem evolution
                • Externalizing UI form scripts
                • Regulations development in a master version for forms and processes: simplified modeling and overwrite protection
                • Validating empty business process mandatory fields on the template level
                • Managing logical operators in search conditions
                • Verifying QES signature and signer in API-received business process content
              • Subsystem architecture
                • Managing versions of registry regulations
                  • Managing git repositories for multiple versions of registry regulations
                • Managing registry officers
                  • Importing users into Keycloak
                • Managing registry data model
                  • Managing registry data model table structures
                  • Viewing the list of registry data model tables in the read mode for candidate versions
                  • Editing registry data model table structure in the web code editor
                  • Converting database structure models to Liquibase ChangeSets
                  • Data model JSON snapshot
                • Managing registry business processes
                  • Modeling business processes using the web editor
                  • Categorizing available services in the user portal
                  • Editing business process groovy scripts in admin-portal
                • Managing registry UI form schemes
                  • Modeling UI forms using the web editor
            • Registry regulations deployment subsystem
              • Subsystem evolution
                • Decommissioning of saving previous versions of data factory API services
                • CD processes
            • Registry’s operational zone service subsystem
              • Subsystem services
                • Business process administration service
                  • Component structure
                  • Service functional capabilities
                  • Deployment diagram
                  • Technology stack
          • Operational zone
            • User portals subsystem
            • External traffic management subsystem: Registry operational zone
              • Non-relational data storage
              • Subsystem evolution
                • External Kong API Gateway routes structure
                • External operational API gateway
                  • The OIDC extension for the Kong API Gateway
            • Business processes management subsystem
              • Object data storage
              • Non-relational data storage
              • Business processes operational database
              • Business processes historical data operational database
              • Subsystem evolution
                • Working with digital documents in the user portal
                • Business processes execution history
                • Saving UI form schemes and validating user data
                • Interim data of business processes
                • Interim storage of data entered through business process UI forms
                • Downloading digital documents from external sources: scripting capabilities
            • Registry data management subsystem
              • Object data storage
              • Registry operational database
              • Historical tables mechanism
              • Subsystem evolution
                • Uploading files
                • Returning total record count with paginating search criteria
                • Modifying API behavior settings at the table creation level
                • Public API and rate limits for reading registry data
                • Asynchronous data loading
                • Adding POST methods generation for data retrieval
            • Registry analytical reporting subsystem
              • Subsystem evolution
                • Placing the Redash analytical reporting service downstream of Kong
            • External integrations subsystem
            • External API simulation subsystem
              • Subsystem evolution
                • Declarative configuration of system emulators: simplified testing of external registry integrations
            • Registry excerpt generation subsystem
              • Object data storage
              • Excerpts operational database
              • Subsystem evolution
                • Generating excerpts in user portals
                • Generating excerpts
                • Data history excerpt
            • User notification subsystem
              • Notifications operational database
              • Subsystem evolution
                • Sending messages to users
                  • Technical solution design
                    • User notification service
                    • Integrating with notification service
                    • API notification management
                    • Physical model for data storage
                    • Auditing and event logging
                  • Registry regulations modeling
                  • Migrating data during the registry update
            • Geodata management subsystem
              • Subsystem evolution
                • GIS module
                • Applying RLS rules to GIS module
            • Registry audit events logging subsystem
              • Audit events operational database
            • User settings management subsystem
              • Non-relational data storage
              • User settings operational database
              • Subsystem evolution
                • User settings management
            • Digital signatures subsystem
              • Subsystem services
                • QES operations service
                  • Working with digital signatures
                  • Working with electronic seal
            • Secrets and encryption management subsystem
            • Asynchronous messaging subsystem
            • Relational database management subsystem
              • Processing analytical requests
              • Geographic objects and geolocation queries
              • Managing database users and schemas
                • Registry database users and privileges
                • Databases
              • Horizontal scaling
              • Backup and recovery
            • Non-relational database management subsystem
        • Component for managing the state of Platform resources
          • Key component aspects
            • Installer component structure
        • Platform backup storage
        • Central service for managing Platform secrets
        • Platform libraries
          • liquibase-ddm-ext
            • ext:createTable
            • ext:alterTableApi
        • Platform API documentation
          • Keycloak extensions for additional REST API
          • Business processes management service
          • Cross-registry interaction API gateway
          • Digital signatures service
          • Business process invocation service for external systems
          • User task management service
          • User process management service
          • User settings management service
          • UI form schemes providing service
          • UI form data validation service
          • Digital documents service
          • Business processes history service
          • User notifications service
          • Excerpts management service
          • Registry regulations management service
    • Quality attributes testing
      • Functional testing
      • Performance testing
      • Security testing
    • Glossary
The Registries Platform 1.9.8
  • The Registries Platform
    • 1.9.8
    • 1.9.7
  • The Registries Platform
  • User documentation
  • Citizens and service recipients
  • Sending messages to users
1.9.8 1.9.7
Українська English

Sending messages to users

The platform allows configuring the sending of messages in the User portals through communication channels such as inbox and email.

Section overview

  • Sending inbox messages to users

  • Confirming email address with OTP code in user profile

© 2024 The Registries Platform.