Installing eSign

Install Server Configuration

First, make sure you have the right application dependencies installed and configured.

In order to configure the processors to make the requests correctly to DCS, you must add in web.config / FTOS Vault (Portal / B2C - depending where the server side script is executing) the following keys:

<add key="FTOSServicesESignEndpoint" value="get-the-url-from-portal"/>  
<add key="FTOSServicesESignAppId" value="the subscription key"/>
<add key="DDMESawToken" value="ApiToken"/>

Install Application Configuration

Log in to FintechOS Studio:

1 Import Packs

Import in Deployment Package the packs from the Pack received. The 08 eSign_Processor - vxx.x.xxxx.zip pack contains the services configuration model and scripts for ESign.

2 Modify data

Import the Pkg08_ESignProcessor_01_FlowSetting_Example_vx.x.xml.zip from

..\02 ConfigurationDataDeploymentPackages form DevOps -> Configuration data deployment package.

Log in to FintechOS Studio:

3 ESign Configuration

For the configuration of Automation Blocks, select Digital Flow Processing > Flow Settings.

In the “Example Flow Setting Esign” you can find an eSign setting and mapping examples. You can copy the examples and modify them.

Processor Settings fields

Settings

{
            "attributeKey":"YourAttribute"
}

{
            "attributeKey": null
}

Mappings

ESign Load component examples

Example Flow Setting: Javascript code - After Events:

Copy

var dfpHelper = ebs.importClientScript('FTOS.DFP');

var componentName = "FTOS_DFP_ESign"; //name of the component
var recordId = ebs.getCurrentEntityId();
var fileExists = true; //"documentToBeSigned" argument = source entity file attribute

var flowSettingsName = formData.FlowSettings;

var p = {};
p.flowSettingsName = formData.FlowSettings;
p.processorSettingsType = 'ESign';
p.processorSettingsName = 'ESign_Example';
   
ebs.callActionByName("FTOS_DFP_FlowProcessorSettingsByType", p, function(e)
    {
        var processorSettingsId = e.UIResult.Data.ProcessorSettingsId;
        dfpHelper.loadComponent(componentName, processorSettingsId, recordId, fileExists);
    });

4 ESign Download Configuration

For the configuration of Esign, select Digital Flow Processing -> Flow Settings.

In “Example Flow Setting Esign” you can find a Esign setting and mapping examples. You can copy the examples and modify them.

Processor Settings fields

Settings

{ "entity":"NemOf entity", "form": "Name of UserJourney", "section": "NameOfSuccessSection" }, 

 
{ "entity":"NemOf entity", "form": "Name of UserJourney", "section": "NameOfailSection" }, 

Mappings

ESign Load component examples

Example Flow Setting: Javascript code - After Events:

Copy

var dfpHelper = ebs.importClientScript('FTOS.DFP');
var componentName = "FTOS_DFP_ESign_Download"; //name of the component
var recordId = ebs.getCurrentEntityId();
var fileExists = true;

var flowSettingsName = formData.FlowSettings;
var p = {};
p.flowSettingsName = formData.FlowSettings;
p.processorSettingsType = 'ESign';

var businessStatusName = ebs.getFormData().model.businessStatus.name;

if (businessStatusName == "Documents Signed") {
    p.processorSettingsName = 'ESign_Download_Documents';
}
else if (businessStatusName == "Contract Signed") {
    p.processorSettingsName = 'ESign_Download_Documents';
}
console.log("p.processorSettingsName "+ p.processorSettingsName); 
if (p.processorSettingsName) {
    ebs.callActionByName("FTOS_DFP_FlowProcessorSettingsByType", p, function (e) {
        var processorSettingsId = e.UIResult.Data.ProcessorSettingsId;
        dfpHelper.loadComponent(componentName, processorSettingsId, recordId, fileExists);
    });
}

5 ESign Configuration for Automatic Signature Profile

The automatic signature has a key value that must be set, this key value is the form the Namirial Account that has activated the automatic signature option.

This key value is inserted in the table: FTOS_DFP_ESignKey

Name and Key Type are not relevant for the flow to work, but will help you organize your records.

The most important attribute is Key Value and is the value described above.

The key is provided by Namirial when you configure the Automatic Remote Signature Profiles. More than one profiles can be set, depending on the needs.

Auto Profile Case 1

If there is only one automatic profile set in Namirial, then you can fill in only the Name and Key Value for that profile.

In The Processor Setting field the configuration will look like this:

"signatureType":"AutomaticSign",
         "automaticProfile":{
            "attributeKey":""
         }

Auto Profile Case 2

If there is more than one automatic profile set in Namirial then we will fill in all fields Name, Key Record Id and Key Value for that profile. The Key type is for you to fill in to know from where that Key Record Id is from. (e.g. In the Key Type you can fill in systemuser if the Key Record Id is the id of the user).

In The Processor Setting field the configuration will look like this:

"signatureType":"AutomaticSign",
         "automaticProfile":{
            "attributeKey":"userId"
         }

For example:

If you have more users from FintechOS with the right to sign automatically, then the configuration is like this:

userId: will be then name of the attribute from your entity that stores the userid from FintechOS.

In FTOS_DFP_ESignKey, the Key record id will be the id of the userid form the systemuser table.

Auto Profile Case 3

You can set other tables (e.g. CustomProfileTable) for your profiles, apart from systemuser. This means that the Key record id will be the id from the record form that table, and yourAttribute_From_EntityName: will be the name of the attribute from your entity that stores the Record ID from the table created.

(In the Key Type you can fill in CustomProfileTable)

Example:

"signatureType":"AutomaticSign",
         "automaticProfile":{
            "attributeKey":"yourAttribute_From_EntityName"
         }

yourAttribute_From_EntityName= CustomProfileTableId (the lookup from your entity to the CustomProfileTable for example or just an attribute that stores that RecordId).

This way the system will know witch Automatic Profile to use to sign.

Upgrade Application Configuration

1 Import Again Packs

Import in Deployment Package the packs from the Pack received.

2 Modify data

The Pkg08_ESignProcessor_01_FlowSetting_Example_v1.0.xml.zip from ..\02 ConfigurationDataDeploymentPackages from DevOps -> Configuration data deployment package.