ITWU Simple Signature Documentation V2Lotus Notes Domino Server version 8.5.3 and higher Lotus Notes...

23
IT works unlimited ITWU Simple Signature Documentation – V2.0 _________________________________________________________________________ IT works unlimited GmbH & Co. KG Stettiner Straße 26, D-33106 Paderborn Fon +49 5251 288 16 - 0 Fax +49 5251 288 16 - 29 mailto:[email protected] http://www.notes-signature.com http://www.itwu.net _________________________________________________________________________

Transcript of ITWU Simple Signature Documentation V2Lotus Notes Domino Server version 8.5.3 and higher Lotus Notes...

  •  

     

     

     

     

     

     

     

    IT works unlimited‐ ITWU Simple Signature Documentation 

    – V2.0    

     

     

     

     

       _________________________________________________________________________

    IT works unlimited GmbH & Co. KG Stettiner Straße 26, D-33106 Paderborn Fon +49 5251 288 16 - 0 Fax +49 5251 288 16 - 29 mailto:[email protected] http://www.notes-signature.com http://www.itwu.net

    _________________________________________________________________________  

  • Inhaltsverzeichnis 

    1  Introduction ..................................................................................................................................... 4 

    1.1  Benefits of Signature Distribution ........................................................................................... 4 

    1.2  How Does ITWU Simple Signature Work? ............................................................................... 5 

    2  System Requirements ..................................................................................................................... 5 

    3  Installation ....................................................................................................................................... 6 

    3.1  Enable Multi‐Signatures: Customize Mail File ......................................................................... 8 

    4  Create and Assign Signatures .......................................................................................................... 9 

    4.1  Overview of Configuration Documents ................................................................................... 9 

    4.2  Create Signatures .................................................................................................................... 9 

    4.3  Select Signature Type ............................................................................................................ 11 

    4.4  Create a Rich Text Signature ................................................................................................. 11 

    4.5  Create a Form Signature ........................................................................................................ 13 

    4.6  Create Assignments ............................................................................................................... 14 

    4.7  Signature Add‐ons ................................................................................................................. 15 

    4.8  Wildcards ............................................................................................................................... 17 

    5  Preview Signatures of a User ......................................................................................................... 18 

    6  Reset User ..................................................................................................................................... 19 

    7  Manually Start Distribution Agent / Review Log ........................................................................... 20 

    8  Using Multi‐Signatures .................................................................................................................. 21 

    9  FAQ ................................................................................................................................................ 22 

    9.1  Why is there no signature in my e‐mails? ............................................................................. 22 

    9.2  Why is no signature attached automatically in new e‐mails? ............................................... 22 

    9.3  Why are some or all of the wildcards in the signature empty? ............................................ 22 

    9.4  Why has somebody from the same organization / group a different signature than me? .. 22 

    9.5  A log contains errors, because the distribution agent cannot open a mail file. ................... 22 

    10  Contact ...................................................................................................................................... 23 

     

  • Abbildungsverzeichnis 

    Figure 1 ‐ ITWU Simple Signature application ......................................................................................... 7 Figure 2 ‐ Administration ......................................................................................................................... 7 Figure 3 – Configure the server of the Domino Directory ....................................................................... 8 Figure 4 – Create signature ..................................................................................................................... 9 Figure 5 – The signature document....................................................................................................... 10 Figure 6 –Result of example Rich Text signature .................................................................................. 12 Figure 8 – Example form opened in Domino Designer ......................................................................... 13 Figure 9 – The assignment document ................................................................................................... 14 Figure 10 – Signature add‐on document ............................................................................................... 16 Figure 11 – Wildcard document ............................................................................................................ 17 Figure 12 – Signature preview ............................................................................................................... 18 Figure 13 –Reset User............................................................................................................................ 19 Figure 14 – Switch to the administration area ...................................................................................... 20 Figure 15 –Multi‐signature menu items ................................................................................................ 21 

  • 1 Introduction

    1.1 BenefitsofSignatureDistributionDo not let your employees waste time and effort on taking care of their e‐mail signature. Instead you should hand that over to ITWU Simple Signature  in order to  integrate personal contact  information into your signatures, to provide multiple predefined signature templates to each user and to attach announcements of current events or new products to your signature.  

    ITWU Simple Signature enables you  to  simply create and specifically assign one or more signature templates to a person, a group or an organization. These templates are automatically filled with the appropriate personal  contact  information  from within  the Domino Directory  in order  to  receive  a standardized  but  personalized  signature. With  graphics  and  formatted  text  you  can  design  your signature templates to represent your Corporate Identity and to serve as a free marketing platform. As soon as users open a new e‐mail the signatures are automatically generated and attached to that e‐mail. 

    A new  feature  in version 2.0  is  the ability  to manage multiple signatures per person. For example, individuals who occupy multiple roles within the company or work for various contractors can choose between different signatures. 

     

  • 1.2 HowDoesITWUSimpleSignatureWork?Variety of design options 

    The signature templates may be designed either within a Rich Text field in ITWU Simple Signature or with a form in the Domino Designer. 

    Within the Rich Text field you can implement logos and other graphics as well as formatted text and wildcards for the personal contact information deriving from the Domino Directory. You can define wild cards for yourself to better suit your individual requirements.  

    The flexible signature add‐ons in ITWU Simple Signature give you the opportunity to inform your customers and business partners about current trade shows or other events and newly announced products of yours. Selecting a start and end date for these signature add‐ons you can automate  the  time‐limited placement of  the add‐ons. Thus you do not need  to attach and delete the add‐ons from the signatures by yourself. 

    Easy Integration of Personal Contact Information 

    The signature of each employee is automatically filled with his contact information from the Domino Directory. 

    ITWU Simple Signature already contains a list of wildcards for the personal data from the Domino Directory. A wildcard can contain just the name of a field from the person document or a complex formula. These wildcards can be changed and customized as required. 

    Whenever personal contact information alters you just need to update them within the Domino Directory. The signatures are automatically updated. 

    Easy management and distribution of e‐mail signatures 

    The signatures are automatically copied to the preferences in the Notes client and are thus already attached at the opening of a new e‐mail. 

    Using the multi‐signature feature end users can set their default signature or choose which signature they want to use ‐ depending on which department, organization or company they need to represent. 

    The signatures can be assigned to individuals, groups or organizations.  The preview and reset features also enable you to constantly control your signatures and to 

    instantly take action as soon as they do not work properly.  

    2 SystemRequirements Lotus Notes Domino Server version 8.5.3 and higher  Lotus Notes Client and E‐Mail Template version 8.5.3. and higher  The Simple Signature distribution agent requires editor access to all affected mail files and reader 

    access to the Domino Directory (names.nsf) on your server.  The use of multiple signatures requires an adjustment of the mail template (see section 3.1). 

     

  • 3 Installation1. ITWU Simple Signature is distributed as a Lotus Notes database (. nsf). Place the application 

    anywhere in the data directory of your Domino e‐mail server. The database already includes some configuration documents. If you make a new copy of the database, make sure to copy both, the design and the configuration documents.  

    2. The Access Control List (ACL) of the application should contain a role „Admin“. Users with this role are allowed to do the following:  Create new signatures  Edit the configuration of the application  Manually start the signature distribution agent   View the agent log 

    Best Practice:  

    ACL Entry  Access Rights ‐Default‐  NoAccess Anonymous  NoAccess Domain Server  Manager with  option 

    „Delete Documents“ Administrators  Manager with Role [Admin] 

    and option „Delete Documents“ 

    Users who should be able to configure the application 

    Editor mit Rolle [Admin] und Recht „Dokumente löschen“ 

    Users who should be able to create signature forms in Lotus Domino Designer 

    Designer with Role [Admin] and option „Delete Documents“ 

     

  • 3. Now open the application. The one‐time setup of the preferences document is necessary:  

     Figure 1 ‐ ITWU Simple Signature application 

    Click the tool icon in the navigation bar (see Fig 1.) at the bottom and open the application preferences (see Fig. 2): 

     Figure 2 ‐ Administration 

    Enter the appropriate server for your address book (names.nsf) in the field “Server Name (Domino Directory)” (see Fig.3). 

    The support for multiple signatures can be enabled with the option “Multi‐Signatures”. For the use of multiple signatures it is necessary to customize the mail template (see section 3.1). 

  •  Figure 3 – Configure the server of the Domino Directory 

     

    4. Now you have to sign the distribution agent of the  ITWU Simple Signature application "Update Signatures" with an appropriate Notes ID. This agent needs read access to the Domino Directory and write access to all mail databases and should run once a day at a certain time. 

    Best Practice:  Let  the agent  run each day at midnight. Because of  caching  issues  in  the  Lotus Notes client the changes are not always updated immediately during the day. 

     

    3.1 EnableMulti‐Signatures:CustomizeMailFileTo use multiple signatures, you must customize the design of your mail files. If you make these adjustments yourself, you will find the necessary design elements in the file ISS200_MailElements_EN.nsf. 

    Be sure to create a backup of your mail template before changing the design! 

    Copy the following design elements into your mail template: 

    Script Library “ITWU_Simple_Signature“  Shared Action “ITWU ChooseSignature”  Shared Action “ITWU SetDefaultSignature” 

    Delete and replace the following design elements in your mail template: 

    Form „Message“  Form „Reply“  Form „Reply with History & Attachments” 

    Refresh the design of your mail files. 

       

  • 4 CreateandAssignSignatures

    4.1 OverviewofConfigurationDocumentsThe signatures are managed using the following configuration documents: 

    SignatureTemplates

    Signature documents define the presentation of a signature. Here the content and layout of a signature can be determined. Wildcards (see below) may be used to include data from the person document of the Domino Directory. 

    Assignments

    Assignments define which users (or groups) will receive which signatures. Each assignment selects individuals, groups or organizations as recipients of the signatures. These receivers are then assigned to one or more signatures. Optionally signature add‐ons can be assigned as well (see below). 

    SignatureAdd‐Ons

    Signature add‐ons in ITWU Simple Signature give you the opportunity to inform your customers and business partners about current trade shows or other events and newly announced products of yours. Signature add‐ons always have a start and an end date. Within this period of time, the signature add‐ons are automatically attached to the signatures. 

    Wildcards

    Wildcards can be used to include personal data from the Domino Directory in the signature. The wildcards can be used in the signature templates using the format " ". At runtime, the distribution agent evaluates the wildcard definition against the appropriate person document and inserts the result into the signatures. 

    4.2 CreateSignaturesOn the home screen of the application select the menu item "signatures". Now you can create new signature documents using the "Create Signature" button.  

     Figure 4 – Create signature 

       

  • The signature document looks like this: 

     Figure 5 – The signature document 

       

  • The following fields in the signature document must be completed:  Field  Description Title  Title of the signature (is used for selection of signatures  in the mail file,  if

    multi‐signatures are enabled). Signature type  Rich‐Text  =>  Formatted text and graphics  

    Form     =>  All formatting options of the Lotus Domino        Designer 

    Description  Free text / Description of the signature Enforce automatic signature 

    If  this  option  is  enabled,  the  signature  is  automatically  inserted  when composing a new e‐mail. 

    Signature  Contents of the rich text signature (only for type „Rich Text“) Template form name  The name of the form to be used in Domino Designer (only for type "form") 

    4.3 SelectSignatureTypeThere are two ways to create signatures: 

    1. Use Rich Text to combine graphical elements and formatted text in conjunction with wildcards 2. Design a Form in Domino Designer (Lotus Notes developing skills needed) 

     

    4.4 CreateaRichTextSignatureSelect the type "Rich Text" in the signature document. This type supports graphical elements and text formatting. By inserting wildcards you can import field values, e.g. telephone number, department, et cetera from the Domino Directory. All available wildcards are shown in the signature document in the section "Available wildcards". The wildcards must be entered in the format  , for example:    

    Example: Rich Text Signature 

    Kind regards

    Fon: Fax:

     

  • Result: 

     Figure 6 –Result of example Rich Text signature 

     

    Best Practice: Create a table using the menu "Create / Table" in order to arrange text and graphic elements.  

    Using  the properties of the created table  (Right click on Table / Properties) you can hide the black border lines (see example above). Use the button “Set All To 0” on the second tab. 

     

    You  can  also  set  the  column  width  of  each  column  of  your  table  on  the  first  tab.  Select  the appropriate column with a right click and then open the properties of the table. 

     

    Figure 1‐ Set table borders

  • 4.5 CreateaFormSignatureThe  signature  type  “Form”  uses  a  Domino  Designer  form  as  a  template  for  signatures.  Thus,  all formatting options that are available in Domino Designer are supported. 

    In  the  signature  document  you  have  to  specify  the  name  of  your  template  form.  This  form  can contain fields, which must have the same names as the corresponding fields in the person document of the Domino Directory. ITWU Simple Signature will insert the appropriate contents for each person from the Domino Directory. 

     Figure 7 – Example form opened in Domino Designer 

     

    Best Practice: See section 4.4 (Create a Rich Text Signature) 

     

     

     

  • 4.6 CreateAssignmentsOn the home screen of the application select the menu item "Assignments". Now you can create new assignment documents using the "Create Assignment" button. It is possible to assign a signature to one or more persons, groups or organizations. 

    The following fields in the assignment document must be completed:  

    Field  Description User type  Select Person, Group or Organization. Name      ‐ Person  Select one or more persons.    ‐ Group  Select one or more groups.    ‐ Organization  Enter an organization using the following format: 

    */ OrganizationUnit /Organization/Country Example:   */ Developer/ ITworks /DE      or     */ITworks/DE 

    Signature(s)  You can assign one or more signatures. Use the buttons „+“ and „‐“ to add and remove signatures. 

    Signature Add‐on Categories 

    Signature add‐ons (see section 0) are assigned to a category (for example "trade fairs", "special offers" or similar). This field may contain one or more of these categories. The corresponding add‐ons will be automatically attached to all signatures of this assignment once the start date of the signature add‐on is reached. To add or remove categories use the "+" and "‐" buttons. The order in which the signature add‐ons should be attached can be set using the two arrow buttons. 

     

     Figure 8 – The assignment document 

     

  • Important note about the user type (only relevant, if multi‐signature is disabled): 

    Assignments with user type “Person” take precedence over user type “Group” and assignments of type “Group” take precedence over type “Organization”. 

    For example: There is an assignment of type „Person“ for user John Smith/CompanyXYZ/DE. There is an additional assignment of type „Organization“ for  */CompanyXYZ/DE. 

    Result: John Smith receives the signature defined in the assignment of type “Person”. 

    4.7 SignatureAdd‐onsSignature add‐ons are temporary notes, which are automatically attached to signatures. For example, this can be announcements of tradeshows, special offers or similar. Signature add‐ons always have a start and an end date. Within this period, the add‐ons are automatically attached to the normal signatures. 

    On  the  home  screen  of  the  application  select  the menu  item  "Signature Add‐ons". Now  you  can create new signature add‐on documents using the "Create Signature Add‐on" button. The following fields in the signature add‐on document must be completed: 

    Field  Description Title  Name of the signature add‐on Description  Free text /description  Category  The category, which is used to assign the add‐on to signatures. Start date  Start of the validity period End date  End of the of the validity period Signature Add‐on  Content of the signature add‐on (Formatted text/ pictures/ attachments 

    and so on are possible).  

  •  Figure 9 – Signature add‐on document 

     

    Note about the category: 

    The assignment of the add‐ons is made by categories. This way it is possible to configure new signature add‐ons without having to adjust the assignment document every time. If you want to add for example announcements for trade shows to your signatures on a regular basis, you should create a signature add‐on for each additional trade show appointment. Then you give all these signature add‐ons the same category, for example "trade show". Then you only need to add this category once to your assignment documents (see section 4.6). 

     

  • 4.8 WildcardsA wildcard can be used to include personal data from the Domino Directory into signatures. A wildcard consists of a name and a calculation formula. The formula always refers to the person document in the Domino Directory. In the simplest case the formula can be just a field name. 

    On the home screen of the application select the menu  item "Wildcards". Now you can create new wildcard documents using the "Create Wildcard" button. The following fields in the wildcard document must be completed: 

    Field  Description Name  The name of the wildcard. This name  is used to  insert the wildcard  into a 

    signature (see below). @Formula / Field  Calculation formula for the wildcard. It must be either a field name of the 

    person document or an @Formula that is calculated based on the person document in the Domino Directory. 

     

     Figure 10 – Wildcard document 

    You can insert wildcards into signatures using the format „“. At runtime the distribution agent will compute the wildcard formulas and insert the results at the corresponding position. 

     

  • 5 PreviewSignaturesofaUserUsing the preview feature, you can inspect the signatures assigned to a specific user before the runtime of the distribution agent. 

     

    Figure 11 – Signature preview 

    Click on the action button “Preview Signature” and select the user in the dialog window. Then all valid signatures for the selected user will be calculated and displayed in a dialog window. 

    Notice: In calculating the signatures, apart from the user name, the respective groups and organizational affiliation of the user are always taken into account as well. Therefore, it is not possible to show a general preview for an entire group or for an entire organization. 

     

  • 6 ResetUserIn case of any issues with the signature of a specific user, you can reset all the signature fields in the user's mail file.  

    Use the action "Reset User". This will open a dialog window where a user's name must be selected.  

    All signature fields in the user’s mail preferences will be removed, so the user will no longer have any signature available. You have to run the distribution agent so that the signatures are re‐written for the user (see Section 0). 

     Figure 12 –Reset User 

     

  • 7 ManuallyStartDistributionAgent/ReviewLogTo view the log and to manually start the distribution agent, first click on the tool icon in the lower left corner of the home screen.  

     Figure 13 – Switch to the administration area 

    In the administration area you see all log entries sorted by date. Logs are created for three different actions: Signature update, preview and reset of a user. 

    Every log entry shows the execution date and time, the action and an overview of errors. 

    The button “Start Signature Update” runs the distribution agent on the server. After the agent finished, the result is visible as a new log entry. 

     

  • 8 UsingMulti‐SignaturesIf your mail file is customized to support multi‐signatures (see section 3.1), you will see two additional menu items under “Signature”:  

    Change Signature 

    Select the new signature in the dialog box. If the e‐mail already contains a signature, it is replaced by the selected signature.  

    Set Default Signature 

    Using this action you can define, which signature is inserted automatically in new e‐mails. The setting becomes effective in the next e‐mail you open. To switch the signature in the currently opened e‐mail, use the function “Change Signature” (see above). 

     

    Figure 14 –Multi‐signature menu items 

     

  • 9 FAQ

    9.1 Whyistherenosignatureinmye‐mails?This can have different reasons: 

    You forgot to run the distribution agent.  Check the log of the signature update in the admin area. Perhaps the signer of the agent has 

    no access rights to a specific mail file?   Changes to the signature are often not effective until you restart the Lotus Notes client.  Check if the user has a Notes Client and a mail file template of version 8.5.3 or higher. 

    9.2 Whyisnosignatureattachedautomaticallyinnewe‐mails? Check the option “Enforce automatic signature” in the signature document. 

    9.3 Whyaresomeorallofthewildcardsinthesignatureempty? Check if the corresponding data exist in the person document in your domino directory.  Check if the wildcard name is spelled correctly in the signature document. Wildcard names 

    are case‐sensitive! 

    9.4 Whyhassomebodyfromthesameorganization/groupadifferentsignaturethanme?

    The user types of signature assignments are hierarchical. Assignments with user type “Person” take precedence over user type “Group” and assignments of type “Group” take precedence over type “Organization” (see section 4). 

    9.5 Alogcontainserrors,becausethedistributionagentcannotopenamailfile.

    The distribution agent is not signed correctly / has missing access rights to mail files. See section 2 and 0.   

  • 10 ContactMailing address:  IT works unlimited GmbH & Co. KG 

    Stettiner Straße 26 33106 Paderborn  

    Germany 

    Phone:  +49 (0) 5251 / 28816‐0 

    Fax:  +49 (0) 5251 / 28816‐29 

    Website:  http://www.itwu.net 

    E‐mail:  [email protected] 

    Registered office:  33102 Paderborn Registry court Paderborn HRA 2387 

    Personally liable  shareholder: 

    IT works Verwaltungsgesellschaft mbH 33102 Paderborn Registry court Paderborn HRB 7958 

    Managing directors:  Carl Goos Stephan Schramm 

    Tax number:  339/5732/1640 

    VAT registration number:  DE210979009 

       

    /ColorImageDict > /JPEG2000ColorACSImageDict > /JPEG2000ColorImageDict > /AntiAliasGrayImages false /CropGrayImages true /GrayImageMinResolution 300 /GrayImageMinResolutionPolicy /OK /DownsampleGrayImages true /GrayImageDownsampleType /Bicubic /GrayImageResolution 300 /GrayImageDepth -1 /GrayImageMinDownsampleDepth 2 /GrayImageDownsampleThreshold 1.50000 /EncodeGrayImages true /GrayImageFilter /DCTEncode /AutoFilterGrayImages true /GrayImageAutoFilterStrategy /JPEG /GrayACSImageDict > /GrayImageDict > /JPEG2000GrayACSImageDict > /JPEG2000GrayImageDict > /AntiAliasMonoImages false /CropMonoImages true /MonoImageMinResolution 1200 /MonoImageMinResolutionPolicy /OK /DownsampleMonoImages true /MonoImageDownsampleType /Bicubic /MonoImageResolution 1200 /MonoImageDepth -1 /MonoImageDownsampleThreshold 1.50000 /EncodeMonoImages true /MonoImageFilter /CCITTFaxEncode /MonoImageDict > /AllowPSXObjects false /CheckCompliance [ /None ] /PDFX1aCheck false /PDFX3Check false /PDFXCompliantPDFOnly false /PDFXNoTrimBoxError true /PDFXTrimBoxToMediaBoxOffset [ 0.00000 0.00000 0.00000 0.00000 ] /PDFXSetBleedBoxToMediaBox true /PDFXBleedBoxToTrimBoxOffset [ 0.00000 0.00000 0.00000 0.00000 ] /PDFXOutputIntentProfile (None) /PDFXOutputConditionIdentifier () /PDFXOutputCondition () /PDFXRegistryName () /PDFXTrapped /False

    /CreateJDFFile false /Description > /Namespace [ (Adobe) (Common) (1.0) ] /OtherNamespaces [ > /FormElements false /GenerateStructure false /IncludeBookmarks false /IncludeHyperlinks false /IncludeInteractive false /IncludeLayers false /IncludeProfiles false /MultimediaHandling /UseObjectSettings /Namespace [ (Adobe) (CreativeSuite) (2.0) ] /PDFXOutputIntentProfileSelector /DocumentCMYK /PreserveEditing true /UntaggedCMYKHandling /LeaveUntagged /UntaggedRGBHandling /UseDocumentProfile /UseDocumentBleed false >> ]>> setdistillerparams> setpagedevice