SignContent

SignContent

What to use it for

Prerequisites for usage

Essential properties to set

Add a digital signature to documents.

The document content can be signed electronically, using the information from a certificate file that contains a private key.

  • Valid certificate file.
  • PDF or EDIFACT documents.
Certificate location, and depending on the setting.


Options for SmartBridge 3

Primary options

Input Options

Option

What is it

How to use it

Current document

Use CurrentDocument to indicate which data you want to process with the current Activity.

This option only becomes relevant in case a preceding Activity generated new documents.

In general, leave at the default value.

  • In most cases you do not need to modify this option.

    • With the default value, the Activity will process the original document.
  • Only enter a custom alphanumeric ID when necessary to be able to process a newly generated document.

 

 Read more »

The only situation in which you might need to modify this option, is when your Workflow produces several new documents based on one incoming original document. Activities that use a single document to produce several documents:

These Activities produce several documents, and some of those might require additional, specific processing.

To be able to indicate which documents require different processing, you will need to have done the following:

  • Have SmartBridge assign an ID to the newly produced documents.
  • Within in the current Workflow, create a specific sequence of Activities for these documents.
  • Assign the documents to their sequence, by referring to their IDs.

Certificate location options

Depending on where your certificate is stored there are different primary options for the certificate location settings. Therefore, first select your certificate location. Other option

OptionWhat is itHow to use it
Certificate location

The repository that contains the certificate.

This option affects which other options you will need to configure next.

Select an option from the dropdown list:

  • PFX_File
  • WindowsStorage
  • PKCS11_Storage
  • PKCS11_NSS_Storage


 Click here to expand...

The most common options are PFX file and WindowsStorage.

  • PFX file is a container for storing certificates and keys, used in Microsoft environments. This is an in-company created file, which you should create if you do not have one.
  • WindowsStorage is the Windows Certificate Store of your Windows machine. Use this option when your system is already using a certificate that you can use.
  • PKCS11 Storage is a certificate storage container on a secure hardware device such as a smartcard or USB drive. Use this option in case your certificate is on a hardware device.
  • Select PKCS11 NSS Storage when you use a certificate storage container on a secure hardware device such as a smartcard or USB drive which needs to be accessed using the NSS libraries.


 


Certificate locationOptions
PFX_file
 Click here to expand...

Required settings when using a PFX file.

OptionWhat is itHow to use it
Certificate file

The location of the PFX file containing the certificate. The file should also include the private key.

Indicate the absolute path to the PFX file.
Certificate file password

The password to be used when opening the certificate file. This is necessary when extracting the private key.

In case the PFX file is secured with a password, enter the password.

 

WindowsStorage
 Click here to expand...

Required settings when using WindowsStorage.

OptionWhat is itHow to use it
Subject common nameThe common name of the certificate subject, as listed in the certificate details under 'CN'.Enter the exact common name ('CN') of the certificate subject.
Issuer common nameThe common name of the certificate issuer, as listed in the certificate details under 'CN'.Enter the exact common name ('CN') of the certificate issuer.

 

PKCS11_Storage
 Click here to expand...

Required settings when using PKCS#11 storage.

OptionWhat is itHow to use it
PKCS11 DLL fileThe DLL file on the hardware device to be able to use the certificate, using the PKCS11 protocol.Indicate the absolute path to the PKCS11 DLL file.
PKCS11 slot indexWhich certificate to use, in case there are several certificates on the device. When stored, PKCS11 certificates are assigned a slot. Each slot is numbered.Enter an integer to reference the relevant certificate.
PKCS11 PINThe PIN is the access code required to be able to open the PKCS11 storage.Enter the PIN code.
Subject common nameThe common name of the certificate subject, as listed in the certificate details under 'CN'.Enter the exact common name ('CN') of the certificate subject.
Issuer common nameThe common name of the certificate issuer, as listed in the certificate details under 'CN'.Enter the exact common name ('CN') of the certificate issuer.

 

PKCS11_NSS_Storage
 Click here to expand...

Required settings when usingPKCS#11 NSS storage.


OptionWhat is itHow to use it
PKCS11 DLL fileThe DLL file on the hardware device to be able to use the certificate, using the PKCS#11 protocol.Provide the absolute path to the PKCS#11 DLL file.
PKCS11 slot indexWhich certificate to use, in case there are several certificates on the device. When stored, PKCS#11 certificates are assigned a slot. Each slot is numbered.Enter an integer to reference the relevant certificate.
PKCS11 PINThe PIN is the access code required to be able to open the PKCS#11 storage.Provide the PIN code.
NSS storage folderThe folder that contains the NSS PKCS#11 storage.Provide the absolute path to the folder.
Subject common nameThe common name of the certificate subject, as listed in the certificate details under 'CN'.Enter the exact common name ('CN') of the certificate subject.
Issuer common nameThe common name of the certificate issuer, as listed in the certificate details under 'CN'.Enter the exact common name ('CN') of the certificate issuer.

 

 

Document type specific options

OptionWhat is itHow to use it
Type of document to be signed

To indicate the type of document to be signed.

This option affects which other options you will need to configure next.

Select an option from the dropdown list:

  • PDF
  • EDIFACT
Type to be signedOptions
PDF
 Click here to expand...

OptionWhat is itHow to use it
Type of document to be signed.

To indicate the type of document to be signed.

This option affects which other options you will need to configure next.

Select an option from the dropdown list:

  • PDF
  • EDIFACT
Signature author(Optional field) Information to contact the author of the signature.Example: provide an e-mail address.
Signature reason(Optional field) Reason to sign the document.

Optionally, provide a reason for signing the document.

 Click here to expand...

Examples of reasons:

  • I am the author of this document.
  • I have reviewed this document.
  • I am approving this document.
  • I attest the accuracy and integrity of this document.
  • I agree to the terms defined by the placement of my signature in this document.
  • I agree to the specified parts of this document.
Signature location(Optional field) Information to indicate the location of the party that signed the document.

Enter a location. Examples:

  • Headquarters, franchise location name.
  • Country, state, city.
Make signature visibleWhether the information provided in these settings should be presented as a visible, textual watermark on the PDF.

(Un)check the options:

  • Unchecked - Do not add a visible signature (default).
  • Checked - Make the signature details humanly visible by printing them on the PDF.
Create MDP certificate

Feature to sign documents using MDP, a signature for Modification Detection and Prevention.

This is an outdated type of signature that is not recommended to be used.

(Un)check the options:

  • Unchecked - Do not add MDP (default).
  • Checked - Add and MDP certificate.

EDIFACT
 Click here to expand...


The implementation follows the GS1 Spain guidelines. Specific configurations can be created for dealing with specific Spanish parties, as Carrefour Spain.


Option

What is it

How to use it

Signature profile file path

The absolute path to the file containing the profile to be used during the EDIFACT signing process.

Select the file using the file picker.

Each segment on new line

Specifies whether the resulting EDI file should have line breaks after each segment.

(Un)check the option:

  • True/Checked - Start each segment on a new line.
  • False/Unchecked - Leave unmodified (default)

Add last UNT segment if missing

Specifies whether the system should add a UNT segment for the last message in the interchange, in case it is missing.

 Click here to expand...

Every EDIFACT document should end with a UNT segment, as UNT segment indicates the end of a document. A UNT segment contains the following information:

  • How many segments the document contains.
  • The same message reference number as indicated in the header (UNH).

(Un)check the option:

  • True/Checked - Add a UNT segment when one is missing.
  • False/Unchecked - Generate an error when missing a UNT segment (default).


All options

 Click here to expand...

Certificate location options


OptionWhat is itHow to use it
PKCS11 DLL fileThe DLL file on the hardware device to be able to use the certificate, using the PKCS#11 protocol.Provide the absolute path to the PKCS#11 DLL file.
PKCS11 slot indexWhich certificate to use, in case there are several certificates on the device. When stored, PKCS#11 certificates are assigned a slot. Each slot is numbered.Enter an integer to reference the relevant certificate.
PKCS11 PINThe PIN is the access code required to be able to open the PKCS#11 storage.Provide the PIN code.
NSS storage folderThe folder that contains the NSS PKCS#11 storage.Provide the absolute path to the folder.
Subject common nameThe common name of the certificate subject, as listed in the certificate details under 'CN'.Enter the exact common name ('CN') of the certificate subject.
Issuer common nameThe common name of the certificate issuer, as listed in the certificate details under 'CN'.Enter the exact common name ('CN') of the certificate issuer.

 


Document type specific options

OptionWhat is itHow to use it
Type of document to be signed 

Select from the dropdown list:

  • PDF (default)
  • EDIFACT

EDIFACT specific options


The implementation follows the GS1 Spain guidelines. Specific configurations can be created for dealing with specific Spanish parties, as Carrefour Spain.


Option

What is it

How to use it

Signature profile file path

The absolute path to the file containing the profile to be used during the EDIFACT signing process.

Select the file using the file picker.

Each segment on new line

Specifies whether the resulting EDI file should have line breaks after each segment.

(Un)check the option:

  • True/Checked - Start each segment on a new line.
  • False/Unchecked - Leave unmodified (default)

Add last UNT segment if missing

Specifies whether the system should add a UNT segment for the last message in the interchange, in case it is missing.

 Click here to expand...

Every EDIFACT document should end with a UNT segment, as UNT segment indicates the end of a document. A UNT segment contains the following information:

  • How many segments the document contains.
  • The same message reference number as indicated in the header (UNH).

(Un)check the option:

  • True/Checked - Add a UNT segment when one is missing.
  • False/Unchecked - Generate an error when missing a UNT segment (default).

Input Options

Option

What is it

How to use it

Current document

Use CurrentDocument to indicate which data you want to process with the current Activity.

This option only becomes relevant in case a preceding Activity generated new documents.

In general, leave at the default value.

  • In most cases you do not need to modify this option.

    • With the default value, the Activity will process the original document.
  • Only enter a custom alphanumeric ID when necessary to be able to process a newly generated document.

 

 Read more »

The only situation in which you might need to modify this option, is when your Workflow produces several new documents based on one incoming original document. Activities that use a single document to produce several documents:

These Activities produce several documents, and some of those might require additional, specific processing.

To be able to indicate which documents require different processing, you will need to have done the following:

  • Have SmartBridge assign an ID to the newly produced documents.
  • Within in the current Workflow, create a specific sequence of Activities for these documents.
  • Assign the documents to their sequence, by referring to their IDs.

Misc

OptionWhat is itHow to use it
DisplayNameName of the Activity.Leave at default, or edit the name to clarify the difference with a similar Activity.

PDF specific options

OptionWhat is itHow to use it
Type of document to be signed.

To indicate the type of document to be signed.

This option affects which other options you will need to configure next.

Select an option from the dropdown list:

  • PDF
  • EDIFACT
Signature author(Optional field) Information to contact the author of the signature.Example: provide an e-mail address.
Signature reason(Optional field) Reason to sign the document.

Optionally, provide a reason for signing the document.

 Click here to expand...

Examples of reasons:

  • I am the author of this document.
  • I have reviewed this document.
  • I am approving this document.
  • I attest the accuracy and integrity of this document.
  • I agree to the terms defined by the placement of my signature in this document.
  • I agree to the specified parts of this document.
Signature location(Optional field) Information to indicate the location of the party that signed the document.

Enter a location. Examples:

  • Headquarters, franchise location name.
  • Country, state, city.
Make signature visibleWhether the information provided in these settings should be presented as a visible, textual watermark on the PDF.

(Un)check the options:

  • Unchecked - Do not add a visible signature (default).
  • Checked - Make the signature details humanly visible by printing them on the PDF.
Create MDP certificate

Feature to sign documents using MDP, a signature for Modification Detection and Prevention.

This is an outdated type of signature that is not recommended to be used.

(Un)check the options:

  • Unchecked - Do not add MDP (default).
  • Checked - Add and MDP certificate.


Options for SmartBridge 2

 Click here to expand...

All options

Activity

Every Workflow Activity needs to have a name, and be configured to be either on or off. These generic properties are part of the Activity properties.

Option

What is it

How to use it

Name

 

A unique name for the Activity. Names are used for two reasons:

  • So you are able to identify the activity throughout the Workflow.
  • More importantly, a name is essential in case you want one Activity to refer to another, specific Activity.
  • Leave the generated name (default)
  • Or enter a unique name.

Description

Description of the activity, to give others some context about the Activity.

Enter an optional description.

Enabled

 


Specifies if the Activity should be enabled or not.

Disabled Activities will be skipped during Workflow execution and validation.

Select option from the dropdown:

  • True – Enables the Activity (default).
  • False – Disables the Activity.

Recommended: True

Certificate location options


OptionWhat is itHow to use it
PKCS11 DLL fileThe DLL file on the hardware device to be able to use the certificate, using the PKCS#11 protocol.Provide the absolute path to the PKCS#11 DLL file.
PKCS11 slot indexWhich certificate to use, in case there are several certificates on the device. When stored, PKCS#11 certificates are assigned a slot. Each slot is numbered.Enter an integer to reference the relevant certificate.
PKCS11 PINThe PIN is the access code required to be able to open the PKCS#11 storage.Provide the PIN code.
NSS storage folderThe folder that contains the NSS PKCS#11 storage.Provide the absolute path to the folder.
Subject common nameThe common name of the certificate subject, as listed in the certificate details under 'CN'.Enter the exact common name ('CN') of the certificate subject.
Issuer common nameThe common name of the certificate issuer, as listed in the certificate details under 'CN'.Enter the exact common name ('CN') of the certificate issuer.

 

PDF specific options

OptionWhat is itHow to use it
Type of document to be signed.

To indicate the type of document to be signed.

This option affects which other options you will need to configure next.

Select an option from the dropdown list:

  • PDF
  • EDIFACT
Signature author(Optional field) Information to contact the author of the signature.Example: provide an e-mail address.
Signature reason(Optional field) Reason to sign the document.

Optionally, provide a reason for signing the document.

 Click here to expand...

Examples of reasons:

  • I am the author of this document.
  • I have reviewed this document.
  • I am approving this document.
  • I attest the accuracy and integrity of this document.
  • I agree to the terms defined by the placement of my signature in this document.
  • I agree to the specified parts of this document.
Signature location(Optional field) Information to indicate the location of the party that signed the document.

Enter a location. Examples:

  • Headquarters, franchise location name.
  • Country, state, city.
Make signature visibleWhether the information provided in these settings should be presented as a visible, textual watermark on the PDF.

(Un)check the options:

  • Unchecked - Do not add a visible signature (default).
  • Checked - Make the signature details humanly visible by printing them on the PDF.
Create MDP certificate

Feature to sign documents using MDP, a signature for Modification Detection and Prevention.

This is an outdated type of signature that is not recommended to be used.

(Un)check the options:

  • Unchecked - Do not add MDP (default).
  • Checked - Add and MDP certificate.

EDIFACT specific options


The implementation follows the GS1 Spain guidelines. Specific configurations can be created for dealing with specific Spanish parties, as Carrefour Spain.


Option

What is it

How to use it

Signature profile file path

The absolute path to the file containing the profile to be used during the EDIFACT signing process.

Select the file using the file picker.

Each segment on new line

Specifies whether the resulting EDI file should have line breaks after each segment.

(Un)check the option:

  • True/Checked - Start each segment on a new line.
  • False/Unchecked - Leave unmodified (default)

Add last UNT segment if missing

Specifies whether the system should add a UNT segment for the last message in the interchange, in case it is missing.

 Click here to expand...

Every EDIFACT document should end with a UNT segment, as UNT segment indicates the end of a document. A UNT segment contains the following information:

  • How many segments the document contains.
  • The same message reference number as indicated in the header (UNH).

(Un)check the option:

  • True/Checked - Add a UNT segment when one is missing.
  • False/Unchecked - Generate an error when missing a UNT segment (default).

Document identification

In case you use the Clone Activity, SmartBridge will use this property to identify cloned documents.

Option

What is it

How to use it

Document Key

Only relevant for Workflows that contain a CloneDocument Activity.

The key of the cloned document to be used for processing.

 Click here to expand...

When creating a clone of the document (using the CloneDocument activity) you need to specify whether SmartBridge should process the clone or the original. When you have specified a Document Key, SmartBridge will assign the Document Key to cloned documents. With the Document Key assigned to cloned documents, you will be able to refer to the clones for further processing.

  • Leave empty if the activity should process the original document (default).
  • Enter or assign the Clone Document Key if the activity should process a clone document.

Recommended: Leave empty when you are not using a Clone Activity.

In SmartBridge 3 this option is replaced with 'Input Options'.

 

 

 

On this page