Procurations and access rights - Technical description

 WARNING : This documentation is valid for ePortal version 6.0 and later.

Introduction

As a user of the ePortal, you (called "mandator") have the option of authorising one (or more) person(s) to act on your behalf at the ePortal "by procuration".
The person with this procuration (called "mandatary") will then be able to carry out certain transactions/transactions on your behalf.
The purpose of this page is to explain the procedure for granting access rights to certain services linked to your account to a third party, who will then be authorised to act on your behalf at the ePortal.


Mandator e-mail restriction

When an invitation token is generated, the mandator can send it by e-mail to the mandatory.
The mandator can also send the invitation by e-mail from the procurations list page after it has been generated.

In order to prevent the mandator from sending the invitation token to himself by indicating his own e-mail, a global setting makes it possible to activate the verification of the e-mail entered before sending.
If this parameter is activated, an error message will be displayed under the field if the user enter his own e-mail.

Example of error message if the entered e-mail address is the same as that of the current user (New token page).

Example of error message if the entered e-mail is the same as that of the current user (Procuration list page).

The translation term key is : GV.Portal.Account.Private.Procuration.NewToken.Error.PreventOwnEmail
The global settings is called Features.Procurations.NewToken.PreventEnteringOwnEmail.

Features.Procurations.NewToken.PreventEnteringOwnEmail
TypeBoolean
ModuleePortal
RestartFALSE
DescriptionEnable or disable the verification of the e-mail address entered when sending a procuration token to prevent to prevent the current user to entering his own e-mail address.
Value
  • true to enable the verification
  • false to disable the verification


Invitation ticket document

It is possible to generate a document, the invitation ticket, containing the token to activate a proxy.
Since ePortal version 6.0, the document is generated using the Stimulsoft library and a template in .mrt format.
In this template, it is possible to transmit four translation terms.

Translation terms

Here is the list of terms that are passed to the invitation ticket template. The terms are not the same if the ticket is generated in the context of a company or a private user.

Example of Invitation token document with a visualization of the translations terms.

Translation term keys (Private context)
1.GV.Portal.Account.Private.Rights.Report.ReportTitle
2.GV.Portal.Account.Private.Rights.Report.SummaryText
3.GV.Portal.Account.Private.Rights.Report.TokenIdLabel
4.GV.Portal.Account.Private.Rights.Report.UrlText

Translation term keys (Organization context)
1.GV.Portal.Account.Organization.Rights.Report.ReportTitle
2.GV.Portal.Account.Organization.Rights.Report.SummaryText
3.GV.Portal.Account.Organization.Rights.Report.TokenIdLabel
4.GV.Portal.Account.Organization.Rights.Report.UrlText

Each of these translation terms can contain slots to incorporate data into the text.
Here is a list of available slots:

Slot
Description
{TokenId}Token Identifier.
{TokenCreationDate}Token creation date (format: dd.MM.yyy).
{TokenExpirationDate}Token expiration date (format: dd.MM.yyyy).
{TokenName}Token name (name given when the token was created).
{MandatorName}Mandator name.
{ConsumeUrl}Url of the page allowing to confirm the invitation.


Document template

The invitation ticket template must be in .mrt format (Stimulsoft).

It is possible to have a specific template for the private procuration (user to user) and the procuration within a company (organization to user).

The paths to the templates are defined in the following global settings:

Feature.Procuration.Organization.Report.TemplatePath
Typestring
ModuleePortal
RestartFALSE
DescriptionPath to the organization (organization to user) invitation ticket template.

Feature.Procuration.Private.Report.TemplatePath
Typestring
ModuleePortal
RestartFALSE
DescriptionPath to the private (user to user) invitation ticket template.


Document template per language

It is possible to have a different template for each language supported by ePortal in case you don't want to use the translation terms or if you want to add more information in the document that will be generated.

In order for the system to find the specific template, their file name must comply with a given nomenclature.
Another important point is that the templates must all be stored in the same folder (more precisely in the same location as the base template).

Base template nomenclature:
<BaseTemplateName>.mrt
Template nomenclature for a specific language:
<BaseTemplateName>_<Lang>.mrt
 <BaseTemplateName> : Base template file name without extension
 <Lang> : Language ISO Code (2 capital letters)

Generated document name

The translation terms GV.Account.Private.Procuration.Report.FileName and GV.Account.Organization.Procuration.Report.FileName contain the name that the generated file will have (the one transmitted to the user).

 The name must contain the .pdf extension.

The system will automatically add the name of the client before the extension.

For example, if the term contains the value 
Procuration.pdf
and the client is named
James Bond
then the generated file will have this name
Procuration_JamesBond.pdf