Managing Custom Appearance

Managing Custom Appearance

SigningHub supports custom Signature Appearances that could best suit your organisational needs. This requires configurations at different ends, i.e

  1. ADSS Server

  2. Customise Signature Appearance Attributes

  3. SigningHub Installation Directory

  4. SigningHub Admin

  5. SigningHub Desktop Web - Enterprise User Role

  6. SigningHub Desktop Web - User's Personal Settings


Configurations Required in ADSS Server

  1. Create a new PDF Signature Appearance as per the requirement using the signature appearance designer in the ADSS Server.

  2. Once the new signature appearance is designed, open the signature appearance preview by clicking the View button and save the appearance image as a PNG file.

  3. Now click the Export button to get the signature appearance file (APP file).

  4. The appearance image file (PNG file) and appearance file (APP file) must have the same name, e.g. My_Signature_Appearance.app and My_Signature_Appearance.png You will need to customise the signature appearance file (APP file) to set the signature appearance according to the desired needs, as explained in the next step.


Customise Signature Appearance

SigningHub supports the following customisation in signature appearance attributes:

  1. Multi-line text

  2. Custom text

  3. Custom positioning of attributes

  4. Custom date time formats

  5. Time Zone abbreviations

  6. Font style

  7. Font Color

  1. The signature Appearance file should maintain a 2.5 aspect ratio to get the best result.


Multi-Line Text

SigningHub supports multiline text attributes up to two lines. If the text does not fit in two lines, then the extra text will be truncated.

  1. To enable multiline in Signature Appearance, you have to:

    1. Edit "my_signature_appearance" (.app file)

    2. Add a multiLine attribute with a value true in the SignatureAppearance root element

  1. SigningHub allows 100 characters for the signing reason attribute and also recommends setting the certificate common name (CN) within 100 characters.

  2. The administrator needs to adjust the font size accordingly to accommodate all the characters of the text attribute in the available width.

  3. It's recommended not to use Hand Signature and Company Logo images at the end of signature appearance in case of multiline signature appearance with more than two text attributes, e.g. Signed By and Signed Reason


Custom Text

SigningHub supports a custom text attribute if extra text needs to be added other than the default attributes.

  1. To add a custom text attribute user needs to follow these steps:

    1. Edit signature appearance file, e.g. my_signature_appearance.app

    2. Add an attribute with the name CUSTOM_TEXT in the appearance file and set its position and font elements accordingly.

    3. Custom text value needs to be added in the <Value> element.

  2. SigningHub reads this attribute in the signature appearance file and displays the value according to the defined parameters.


Custom Position of attributes

SigningHub supports the custom positioning of attributes defined in the signature appearance file.

  1. To achieve the custom positioning of an attribute user needs to follow these steps:

    1. Edit signature appearance file, e.g. my_signature_appearance.app

    2. User needs to update the following properties of the required attribute:

      • height: represents the height of an attribute

      • width: represents the width of an attribute

      • X: represents the starting position of an attribute

      • Y: represents the starting position of an attribute from the top


Custom date time format

SigningHub supports a custom date and time format.

  1. To achieve a custom date time format user needs to follow these steps:

    1. Edit signature appearance file, e.g. my_signature_appearance.app

    2. User needs to update <Value> of the SIGNING_DATE attribute and set the required date time format syntax.

    3. The user can update the custom date time format according to the examples mentioned below:

      • yyyy-MM-dd hh:mm:ss (2022-06-17 04:19:13 PM)

      • yyyy-MMM-dd hh:mm:ss (2022-Jun-17 04:19:13 PM)

      • MMMM-dd (June-17)

      • yyyy-MM-dd (2022-06-17)

      • dd MMM yyyy, HH:mm:ss tt (25 Jul 2022, 05:42:29 AM PKT)


Time zone abbreviations:

SigningHub supports time zone abbreviations in custom date and time formats.

  1. To achieve this user needs to follow these steps:

    1. Edit signature appearance file, e.g. my_signature_appearance.app

    2. If the time zone offset "zzz" is not provided in a custom date time format, the system will display the time zone abbreviation instead of a numeric value, e.g. PKT, SGT

    3. If the time zone offset "zzz" is provided in a custom date time format, the system will display the numeric representation of the time zone.

  1. If the provided date time format is not valid, the system will fallback to the default ISO-8601 date time format yyyy-MM-dd hh:mm:ss zzz.


Font Style:

SigningHub supports different font styles. Supported font styles are:

  1. Arial

  2. Lucida Sans Unicode

  3. Susie's Hand

  4. Tahoma

  5. Tahoma Bold

  6. Verdana

If the user is required to use Susie's Hand or Verdana font style for text attributes, the following steps need to be followed:

  1. Edit signature appearance file, e.g. my_signature_appearance.app

  2. User needs to update the font style name against each text attribute.


Font Colour:

SigningHub supports custom font colour.

  1. To achieve text attribute font colour, the user needs to follow these steps:

    1. Edit signature appearance file, e.g. my_signature_appearance.app

    2. The user needs to update the RGB value in <Color> the element against each text attribute.

  1. Font colour will not be applicable in Signature Appearance while performing a signature on any PDF/A document with "CMYK" colour space ​​to ensure PDF/A compliance.

User needs to place both (My_Signature_Appearance.png and My_Signature_Appearance.app) files in the SigningHub Installation Directory.


Configurations Required in SigningHub Installation Directory

After configuring all attribute properties of signature appearance user needs to follow these steps to be able to use the custom signature appearance:

  1. Navigate to the path [SigningHub-Installation-Directory]\default\appearances, and place both ( My_Signature_Appearance.png and My_Signature_Appearance.app#8202;) files.

  2. Navigate to the path below paths and edit the JSON file of particular language e.g. en-US.json:

    • [SigningHub-Installation-Directory]\admin\wwwroot\assets\i18n]

    • [SigningHub-Installation-Directory]\admin-api\wwwroot\Languages]

  3. Add a comma (,) at the end of the last line, and add a new entry of the language text to be displayed in SigningHub Admin: "MY_SIGNATURE_APPEARANCE": "My Custom Signature Appearance". User needs to provide signature appearance file name in capital letters e.g. "MY_SIGNATURE_APPEARANCE". Save and close the language file.

  4. Navigate to the path [SigningHub-Installation-Directory]\web\wwwroot\assets\i18n], and edit the JSON file of particular language e.g. en-US.json.

  5. Add a comma (,) at the end of the last line, and add a new entry of the language text to be displayed in SigningHub Web: "MY_SIGNATURE_APPEARANCE": "My Custom Signature Appearance". User needs to provide signature appearance file name in capital letters, e.g. "MY_SIGNATURE_APPEARANCE". Save and close the language file.


Configurations in SigningHub Admin

After completing the above-mentioned steps, the user needs to perform the following steps:

  1. Log in to SigningHub Admin.

  2. Navigate to the Service Plan screen.

  3. Edit the service plan and add the new signature appearance under the Signatures Tab.


Configurations in SigningHub Desktop Web - Enterprise Role

After configuring the signature appearance in Service Plan, user needs to follow these steps to configure it in Enterprise Role:

  1. Log in to SigningHub Desktop Web with enterprise admin credentials.

  2. Navigate to the Configurations > Enterprise Configurations > Roles.

  3. Edit the enterprise role, and navigate to the Signature Appearance Preferences tab.

  4. Select the newly added signature appearance (i.e. My Custom Signature Appearance) from the Signature Appearance drop down. Save and close the role after editing.


Configurations in SigningHub Desktop Web - User's Personal Settings

After configuring the signature appearance in the enterprise role, users need to follow these steps to configure the newly added signature appearance in Personal Settings:

  1. Log in to SigningHub Desktop Web.

  2. Navigate to Configurations > Personal Configurations > Signatures> Signature Appearance Design tab and select the newly added signature appearance (i.e. My Custom Signature Appearance) from the Signature Appearance Design drop-down. Save these configurations. Signature appearance configured in personal settings will be used as the default appearance in the signing dialogue when the user performs a signing operation.

Last updated