Skip to main content

Governance rules of document providers

During the onboarding process, Document Providers should read the document e-Box Enterprise: obligations du Document Provider/e-Box Enterprise: verplichtingen van de Document Provider. This page gives details on the governance rules and technical requirements mentioned in the document.

Publication​

In general, Document Senders should choose a Document Provider and do the onboarding by the chosen Document Provider before sending the publications. Document Providers should support routing rules that route publications to a specific partition in e-Box Enterprise and webhook that will notify Document Providers for enterprise's modifications on partitions & routing rules.

The detailed techniqual requirements of publication can be found here: https://dev.eboxenterprise.be/docs/dp/publication.

Notification​

Document Providers MUST integrate with Ebox Event Service (EES) Enterprise in order to send notifications. The descriptions of events to be sent can be found here: https://dev.eboxenterprise.be/docs/dp/document_provider#notifications. Details of the Ebox Event Service: https://dev.eboxenterprise.be/docs/federation/ebox_enterprise_event_service.

Consultation​

Document Providers MUST implement Message Registry Service and Register that service on the Provider Registry Service. To secure the consultation, the partitions rights should also be checked. The technical specifications can be found here: https://dev.eboxenterprise.be/docs/dp/consultation.

To validate the implementation of Message Registry Service and error management, Document Providers can refer to the page of testing scenarios: https://dev.eboxenterprise.be/docs/dp/consultation_test_scenarios.

Audit trails​

The minimum audit trail requirements can be found here: https://dev.eboxenterprise.be/docs/dp/audit_trail. Ajouter dans la page d'audit trail l'alerte sur la publication. The audit trails for the publication are obligatory even if you don't use Message Registry API for the publication.

Release management​

The e-Box ecosystem evolves regularly to accommodate new requirements, whether these changes are driven by business, functional, technical, or security needs. Consequently, there are various versions of the e-Box API. The DocProvider must comply with the latest available version, taking into account the governance and communications related to release management.

  • The definition of the e-Box “messageRegistry” API may change:
    • New minor version;
    • New major version;
  • Cross-functional services related to e-Box may change:
    • Ebox Event Service (EES);
    • OAuth Authorization Server (OAuth Social Security for e-Box Enterprise and OAuth FAS/BOSA for e-Box Citizen);
    • Partition Service, known as Pacman (for e-Box Enterprise);
    • Service ProviderRegistry (via the Ebox-federation service for e-Box Enterprise); Note: the list of cross-functional services is subject to change based on future needs.

Each DP is required to follow migration requests when a new version of one of these services becomes available and to meet the communicated deadlines.

The ACC–PRD deadlines for each update will be communicated during OCDP (“Overleg Committee DocProviders”) meetings and posted on the technical documentation sites.

Each DP is responsible for notifying us of any new version of its service and/or URL (ACC, PRD) so that we can update the providerRegistry. e-Box Enterprise Specifics: Please send notifications to eBoxIntegration@smals.be.

Service level agreement​

Document Providers must adhere to a service level agreement (SLA) regarding the availability and performance of its service to ensure the proper availability and functionality of e-Box Enterprise:

  • At least 99,5% availability rate must be maintained 24/24h, 7/7d, excluding scheduled maintenance.
  • Performance level with a response time of less than 2 seconds for at least 95% of calls.
  • In the following calls, a performance level with a response time of less than 4 seconds is accepted:
    • Advanced search of messages
    • Move a big number of messages (More than 100 messages)
    • Download big documents (>= 20MB)

Any scheduled maintenance in Production that may affect the availability or performance of the DocProvider service must be reported to eBoxIntegration@smals.be at least 5 business days prior to the maintenance.

Support user and incident management​

Each DP must provide a list of contacts (teams/individuals) for the various types of requests and/or incidents that may affect their service.

  • Development team (+ manager): for all communication regarding the implementation of the service at DocProvider and the monitoring of releases and migrations.
  • Production Support Team (+ manager): for any incidents concerning the DocProvider service requiring monitoring in Production; potentially specify the on-call team in case of incidents at night or on weekends.
  • Management/Executive Leadership: individuals who can be contacted in the event of an escalation (technical team lead; department head; and senior management).

The list of contacts can be sent to eBoxIntegration@smals.be.

Reporting​

  • Statistics must be submitted via the portal in the directory reserved for the DP.
  • The required format for the statistics is specified in a template (currently an Excel file) that will be available in that same directory.
  • Statistics for a given month are due by the third business day of the following month.