System settings


This describes the possible values for each Bulksign settings.json configuration file.



  • DatabaseType
    Description : The type of database server. Supported values are "SqlServer" or "PostgreSql".
    Type : string
  • DatabaseConnectionString
    Description : The SQL Server database connection string
    Type : string
Tip

See also Database section for configuring the connection string with a trusted connection

  • DatabaseCommandTimeout
    Description : The database command execution timeout
    Type : integer
  • StorageLocation
    Description : The path of the location where documents are kept
    Type : string
Tip

See also Storage section for configuring the storage location with a network share

  • CompressionLevel
    Description : Sets the compression level for completed documents ZIP archive. Available values are 
                   0 : Optimal
                   1 : Fastest
                   2 : NoCompression
                   3 : SmallestSize
    Type : integer
  • FromEmailAddress
    Description : The email address used for sending emails.
    Type : string
    Note : This option can be overwritten <a href="PerOrganizationProviders.htm">per organization</a>
  • JobMaximumRetries
    Description : Value which determines how many times am internal BackgroundService job is retried when failing
    Type : integer
    Default Value: 5
  • JobsTimeoutSeconds
    Description : Determines how much time to wait before starting the DB query for executing jobs
    Type : integer
    Default Value: 5
  • JobsDailyTaskStartHour
    Description : The hour (in format 0 - 23) at which the daily tasks start running
    Type : integer
    Default Value : 0
  • AccountPasswordSalt
    Description: The salt used for hashing the user password before being written to DB. Please note that this SHOULD NOT be changed after setting the initial value because the user accounts will be invalidated.
    Type:string
  • TimeToKeepTemporaryFilesInMinutes
    Description : The timespan (in minutes) the documents uploaded with APIs AnalyzeFile/AnalyzeFileBase64 are kept.
    Type : integer
  • SignStepApiKeys
    Description : Set API keys to access the signing API. Leave this empty to entirely disable access to signing API for 3rd party applications.
    Type : string array
  • DashboardApiKeys
    Description : Global API authentication keys. These will supersede the organization API keys and user specific keys. Only enable this for GLOBAL Bulksign integrations which span multiple organizations.
    Type : string array
  • HttpRequestCommandTimeout
    Description : The HTTP requests timeout for all HTTP requests done from Bulksign (setting value is in seconds).
    Type : integer
  • ImageOutputFormat
    Description : The image format of the PDF pages. Can be "png" (the default) or "jpeg"
    Type : string
  • ReminderPeriodHours
    Description : Configures the number of minimum number of hours between signer reminders 
    Type : number
  • ImprintCustomFontNames
    Description : Allows the configuration of custom fonts to be used for signature imprints
    Type : string array
Important!

To be useable by Bulksign, the fonts need to be installed in the Windows Fonts folder. When installing the font make sure you're using "Install for all users"

  • EnableTriggerCustomEvents
    Description : Flag which enables sending signing events from WebSign when is hosted in a iframe. See <a href="iframe.htm">iframe integration</a> for additional details . Please note this is global, if its enabled, notifications will be sent for ALL sign steps. 
    Type : boolean

+RecaptchaSettings

    Description : Determines if Google Captcha v2 is enabled or not. The following values are available :

    Enabled: Flag which sets if the captcha is enabled or not. Set to true/false
    SiteKey: Set the Captcha site key 
    PrivateKey: Set the Captcha private key
    Score : The value of the captcha score which determines when the captcha score is valid. Value must be between 0 and 1.
    
    If enabled, the captcha will be used for the following pages :
    
    - login
    - register account
    - forgot password
    - access signing document with the access code
    - enter password to authenticate for signing

+IPBlock

    Description : determines of IP address autoblocking is enabled or not. The following values are available :
    
    Enabled: Flag which sets if the captcha is enabled or not. Set to true/false
    Hours: Period of time (in hours) for which the ip will be blocked
    InvalidRequests: Number of "invalid requests" allowed before the block is enabled.


EUTL Job

By default for on-premise version the EUTL job which updates the EU CA root certificate details is disabled for security purposes (to prevent hundred of outbound connections). The job can be enabled by setting IsEnabled : true in the following section : 

   "Jobs":[{
        "Name":"EutlJob",
        "IsEnabled" : "false"
    }]
URLs
  • WebSignUrl
    Description : The external URL of the signing application (Bulksign WebSign). The URL is used in the emails sent to signers.
    Type : string
  • DashboardUrl
    Description : The external URL of Bulksign Dashboard application. The URL is used in the notification emails.
    Type : string
  • WebSignUrl
    Description : The external URL of Bulksign WebApi application. The URL is used for internal application notifications about cache evictions.
    Type : string
  • DashboardServerEndpoints, WebSignServerEndpoints and WebApiServerEndpoints
    Description : This is only used when Bulksign runs in a load balanced scenario. The cache notifications are sent to each internal server url
    Type : string array
  • LogOffRedirectionUrl
    Description : URL to which Bulksign will redirect when a user logs off  (this is optional). This option can be overwritten <a href="PerOrganizationProviders.htm">per organization </a>
    Type : string


License Settings
  • license warning notifications can be enabled from here, the following settings are available : 
LicenseNotification
{
    "Enabled" : "true"
    "PercentageWarning" : "10"
}

  • "Enabled" : enable/disable the license notifications

  • "PercentageWarning" : Recommended value is "10". This means that warning emails will be sent to ALL organization administrators when your remaining number of envelopes reached 10% or lower from the total number of licensed envelopes.

Functionality settings
  • FeatureFlags
    Description : Configures the global feature flagsfor the application. The flags entered here will be usable for ALL organizations.
    Type : string array

    **List of all available flags** :

    "CertificateCustomization" :  enable custom signing certificate per organization
    "EmailTemplates" :  enable customizing the email templates 
    "OTPSign" : enables support for OTPSign
    "RecipientAuthenticationSMS" : enable recipient authentication with SMS OTP
    "SignNotificationSMS" : enable support for signing notifications being sent by SMS
  • CertificateHubPort
    Description : Configures the port used by the CertificateHub application.  If you change the default value please keep in mind the port values must also be changed in the CertificateHub config file (this should be done in CertificateHub.app.config file).
    Type : number
    Default Value : 4811
  • AuditTrailFontLanguages
    Description : This setting allows you to configure the font used when generating the AuditTrail. You can either configure same font to be used for all languages, or each language to use different fonts. 
    Type : array

    Example : 

        "AuditTrailFontLanguages" :[
        {
            "Language" : "en-US",   // the language for which the font will be used
            "Path" :"c:\\Windows\\Fonts\\SourceSansPro.ttf",   // the path to the font file
            "FontName" : "Source Sans Pro" // the font name 
        },
        {
            "Language" : "fr-FR",   // the language for which the font will be used
            "Path" :"c:\\Windows\\Fonts\\Roboto.ttf",   // the path to the font file
            "FontName" : "Source Sans Pro" // the font name 
        }
    ],
Important!

Notes :

  • to configure the same custom font for all languages, use an empty string for "Language"

  • when using a custom font, the font itself will NOT be embedded in the audit trail PDF. So the font needs to be installed on the machines where the PDF will be viewed.

  • DashboardFileFilter
    Description : Allows the configuration of the file selector when uploading documents. If there is no PDF file selector is recommended to allow only PDFs.
    Type : string
    Default Value : .pdf
    With PDF Converter : .pdf,.txt,.html,.ods,.odt,.doc,.docx,.xls,.xlsx,.pptx,.ppt,.jpg,.png,.bmp
  • WebSignAttachmentFileFilter
    Description : Allows the configuration of the file selector for the signer attachments.  
    Type : string
    Default Value : ".jpg,jpeg,.bmp,.png
  • EnableAccessCodes
    Description : If enabled, this will allow users to access signing documents by entering its access code received by email.
    Type : boolean
  • ForgotPasswordValidity
    Description : Determines how long the forgot password link will be available (value is in number of hours).
    Type : integer
    Default Value : 24
  • MaximumEnvelopeAvailabilityDays
    Description : The maximum number of days that a envelope can be valid (value is in number of days)
    Type : integer
    Default Value : 36
    Note : This option can be overwritten <a href="PerOrganizationProviders.htm">per organization</a>
  • MaxEnvelopeRestartsAllowed
    Description : The maximum number of times a envelope can be restarted after expiration
    Type : integer
    Default Value : 3
  • MaximumAttachmentSizeBytes
    Description : The max allowed size (int bytes) for file attachments. If the attachment size is higher that this value, it will be rejected.
    Type : integer
  • MaximumEmailAttachmentSizeBytes
    Description : The maximum allowed size (in bytes) for attachments sent to ReceiveCopy recipients : 

    - if the value is set to 0, the documents will always be sent as attachments no matter their size.

    - if the attachment size is smaller than this configured value, the files will be sent as attachment.

    - if the attachment size is larger than this configured value , the recipient will receive a link by email which will allow him to download the files.

    Type : integer
  • MaximumAttachmentsPerEnvelope 
    Description : The maximum number of attachments that can be added to a envelope
    Type : integer
    Note : Set value to "0" to disable this check.
           This setting can be <a href="PerOrganizationProviders.htm">overwritten at the organization level </a>
  • DefaultLocalizationCulture
    Description : Set the default application UI language for Bulksign
    Type : string
    Default : en-US
    Allowed Values : <a href="translation.htm">list of supported languages</a>
  • AllowAdministratorViewOtherUsers
    Description : If enabled, allows the organization administrators to view the list of users belonging to the other organizations
    Type : boolean
    Note : This flag only work on the on-premise version of Bulksign
  • DaysUntilExpiringSoon
    Description : The number of days before the envelope is moved to the "Expiring Soon" filter
    Type : integer
    Default Value : 5
  • IsSignupEnabled
    Description : If enabled, allows users can sign-up for new accounts
    Type : boolean
  • MaximumAttachmentSizeBytes 
    Description : The maximum size of file that can be attached by a signer (value is bytes)
    Type : integer
    Note : This option can be overwritten <a href="PerOrganizationProviders.htm">per organization</a>
  • MaximumAttachmentsPerEnvelope
    Description :  The maximum number of file attachments allowed per envelope
    Type : integer
    Note : This option can be overwritten <a href="PerOrganizationProviders.htm">per organization</a>
  • ItemsPerPage
    Description : The number of items to show in any list that supports paging
    Type : integer
  • AllowDocumentAccessAfterFinish
    Description : Flag which determines if the signers are allowed access to re-download the documents if they re-open the signing link later.
    Type : boolean
    Default Value : false
Important!

Enabling this PREVENTS the removal of intermediary files, so ALL files signed by ALL recipients will be kept.If enabled, this will GREATLY INCREASE the number of stored files


SMS OTP specific settings


  • OTPValidityMinutes
    Description : The number of minutes that user is allowed to enter the OTP code, after it was sent by SMS
    Type : integer
  • OTPLength
    Description : The number of characters for the generated OTP
    Type : integer
  • MaximumSMSAllowedPerRecipient
    Description : The maximum number of SMSes allowed to be sent to each signer.
    Type : integer
    Note : Set to 0 to disable this and allow unlimited SMSes to be sent
           This option can be overwritten <a href="PerOrganizationProviders.htm">per organization</a>
Important!

If the max number is exceeded, authentication with SMS PIN will be disabled


Cloud providers
  • DropboxKey
    The integration key used to connect to  Dropbox. Leave empty to disable Dropbox integration.
  • Box key
    The integration  key used to connect to Box. Leave empty to disable Box integration.
  • OneDriveClientId
    The OneDrive client id . Leave empty to disable OneDrive integration.


Important!

Please note that when the configuration file is updated, the Bulksign IIS application pools and Bulksign background service will be restarted so the new changes can be loaded.


ActiveDirectory integration
Tip

See Single SignOn with Active Directory section for details on how to configure Active Directory integration