HCL Notes

Template for Personal address book

Prerequisite for the integration of the CTI functions in the Notes client are XPhone Connect Server and XPhone Connect Client with installed Notes integration:

To be able to use CTI functions in the Personal Address Book template of your Notes client, you have to create a Personal Address Book template that contains the corresponding design elements.

The necessary steps for this process are:

1. Create a new stencil copy of your own stencil

2. Opening the C4B Template

3. Copying the CTI functions from the template to your own template

4. Customizing the database scripts

5. Recompile LotusScript

This allows you to call the following functions in your template:

• Search contact (address book)

• Call:

  • Office

  • Mobile phone number

  • Private phone number

• Schedule XPhone Meeting

Depending on the Notes version (see System requirements) C4B delivers templates with CTI design elements (XPConnect_CTI_V[Notes_Version].NTF).

In the following all necessary steps for the adaptation of the address book template for Notes version 9 are described. In that case the supplied template XPConnect CTI V9 (XPConnect_CTI_V9.NTF) must be used.

If you are customizing for a different version of Notes, use the template provided to match.

Hint

When installing new clients, please make sure that the correct address book template is used or assign the new template to the personal address book afterwards and update the design.

Create personal address book

Use Domino Designer to create an Address Book template that contains the appropriate design elements.

1. Select the Personal Address Book template (pernames.ntf) to copy.

   File > Application > Open… > Personal Address Book (pernames.ntf)

   

   

2. Right-click on the application Personal Address Book > Application > New Copy.

   

3. When copying, enter a new title e.g.: Personal Address Book XPhone and the file name e.g..: pernames_xphone.ntf.

4. Use the folder icon to select the desired directory on the server where you want to save the template.

5. Use the Encryption button to select Do not encrypt this database locally and click OK.

   

6. Select the Application design only option and click OK.

   

7. In the application list you will now find two applications. You can remove your original template.

   

8. Finally, adjust the template name of your XPhone template.

   1. Click Edit… in the lower area and switch to the Design tab. (If you cannot find the button, right-click on your XPhone template and select Application > Properties).

      

   2. Change the template name.

      Important

      The name must not match the template name of the original template!

      

   3. Now save your changes by closing the Properties window and confirming with Yes.

Open template

The template-SchabloneXPConnect_CTI_V9.ntf can be found in the downloaded XPhone Connect package in the directory:

Software\Integrations\IBM Notes\Templates V9

1. Copy the template template to your local template directory (usually C:\Program Files (x86)\IBM\Notes\Data).

   Important

   Make sure that the template is not write-protected.

2. Open the template XPConnect CTI V9 (XPConnect_CTI_V9.NTF) in Domino Designer via File > Application > Open… and select the local directory where you copied the template via the Browse button.

You should now have two templates open in your Domino Designer:

Copy functions of the template to your own template

Now the CTI design elements are copied from the supplied template to the newly created custom template. For all copy operations you can either use the context menu via Right Click > Copy and Right Click > Paste or the keyboard shortcuts :kbd: CTRL+C` and :kbd: CTRL+V`.

After insertion into your template, various queries may appear asking whether elements should be automatically updated after insertion. Confirm these messages with Yes.

Copy these functions from the template template to your own template:

1. Code > Script Libraries

   Select all script libraries in the CTI template and copy them to the clipboard. Paste the script libraries into your template under Code > Script Libraries.

   Copy from the template:

   

   Paste into your template:

   

2. Code > Agents

   Copy the agents (XP\New XPhone Meeting) and (XP\Schedule XPhone Meeting) and paste them into your template under Code > Agents.

3. Code > Common Actions

   Open the grouping with the desired language and copy the following actions into your template here:

   • Office

   • Mobile phone

   • Search contact (address book)

   • Private phone number

   • XPhone Meeting (address book)

   • Schedule XPhone Meeting

4. Resources > Images

   Kopieren Sie alle Bilder in der CTI-Schablone und fügen Sie sie in Ihre Schablone unter Ressourcen > Bilder ein.

5. After the copy operations in your template, open the Code > Common Actions design group by double-clicking it. A new tab will open in the main area. Below you will find the Properties tab, open the Design tab there.

   Activate here the option Cannot be changed by updating or replacing the design

   

   Hint

   The properties window can be displayed collapsed at the bottom if necessary - if it is not present at all, open it via Windows > Show Eclipse Views > Properties.

6. The previously copied Common Actions must now be pasted as buttons into the respective masks or views of your template.

Customize masks and views

In the first step, customize the Group mask and the Groups view:

1. Select the mask/view in your template and activate the optionCannot be changed by updating or replacing the design.

   Hint

   Do this first step right away for both the mask and the view.

   

2. Double-click on the mask/view. A new tab opens. In the right area, where among other things the buttons are listed, an action is now added via Right Click > Insert Common Action….

   

3. Select the Schedule XPhone Meeting action, insert it by Insert and confirm with Done.

   

4. The action Schedule Phone Meeting should be placed before the action Schedule Meeting By (Drag&Drop).

   

5. Copy the action Schedule Phone Meeting. Open the Group view by double-clicking and paste the action from the clipboard in the correct place.

   You should now see two tabs marked with a *. The asterisk means that something has been changed on these elements.

6. To save the changes you have just made, close these tabs by clicking on the cross and confirm the Save dialog with Yes.

   

In the next step, customize the Contact mask and the Last Contacts view:

1. Select the mask/view in your template and check Cannot be changed by updating or replacing the design.

2. Double-click on the view/mask. A new tab opens. In the right area, where among other things the buttons are listed, an action is now inserted via Right click > Create action with subaction….

   A window Action opens, which you close again directly. There is now an action unnamed with a subaction unnamed in the action list.

3. Double-click the top action untitled.

   A new Action window will open.

4. Change the name to Select.

   

5. Remove the bottom action unnamed by right-clicking > Delete.

   The Dial action should now be selected.

6. Right-click Select and click Insert Shared Action….

   A new window opens.

7. By holding down the CTRL key while selecting, highlight the actions

   • Office

   • Mobile phone

   • Private phone number

8. Insert the actions by pressing Insert and confirm with Done.

9. Insert the following actions on the same level via Right Click > Insert Common Action…:

   • Schedule XPhone Meeting

   • Search contact (address book)

   The Schedule XPhone Meeting action should be placed before the Schedule Meeting action.

   

10. You can now copy the actions Dial, Find contact (address book) and Schedule XPhone Meeting and paste them into the view (Recent contacts).

    

    Keep the marked actions in the clipboard, they are still needed for the next step.

11. Save the mask/view by closing the respective tabs.

Lastly, customize the following views:

• Birthdays and anniversaries

• My contacts

• By company

• By category

1. Select each named view in the left tree structure of your template and mark Not modifiable by updating or replacing the design.

2. Open the views by double-clicking and paste the action still in the clipboard on the right, as shown in the picture.

   

3. In a view, expand the top action New and insert a menu separator. Right-click on New and select Create action…* A new window opens. Select the type **Menu Separator and name the action accordingly. Then close the action window.

   

4. Now insert the XPhone Meeting (address book) button into your view. Right-click New, click Insert Shared Action… and use the Insert button to insert the XPhone Meeting (Address Book) action.

5. Use Drag&Drop to move the menu separator and XPhone Meeting (address book) to the end of the New menu.

   

6. Copy the actions Menu Separator and XPhone Meeting (Address Book) and paste them in the same place in the other views.

7. Save the views by closing the respective tabs and confirming with yes.

8. Lastly, click on your template (Personal Address Book XPhone) on the left side in the column of Applications and click Recompile LotusScript completely in the upper status bar under Tools.

   You should not get any errors after compilation. If the compile option is grayed out, you may not have marked the template correctly.

   

Customize database script

Note: Lines of code that need to be inserted are also located as a text document in the XPConnect_CTI_V9.NTF template under Resources > Files > XP_ScriptCode.txt.

1. Double-click in your template to open the Code > Database Script design element.

2. Open the Options object and insert the following text: Use “XP_CTI”

   

3. Open the Postopen object and insert the following text directly after the declarations: Call XP_DatabasePostOpen

   

4. Save the database script by closing the tab and confirm with Yes.

5. Recompile the new template completely via Tools > Recompile LotusScript and make sure that it does not contain any errors.

Mail template

Prerequisite for the integration of the CTI functions in the Notes client are XPhone Connect Server and XPhone Connect Client with installed Notes integration:

In order to use CTI functions in the Mail template of your Notes client, you have to create a Mail template that contains the corresponding design elements.

The necessary steps for this process are:

1. Create a new stencil copy of your own stencil

2. Opening the C4B Template

3. Copying the CTI functions from the template to your own template

4. Customizing the database scripts

5. Recompile LotusScript

This allows you to call the following functions in your template:

• Search contact (mail)

• Schedule XPhone Meeting

• Configure meeting options

Depending on the Notes version (see System requirements) C4B delivers multilingual templates with CTI design elements (XPConnect_CTI_V[Notes_Version].NTF).

In the following all necessary steps for the adaptation of the address book template for Notes version 9 are described. In the case the provided templateXPConnect CTI V9 (XPConnect_CTI_V9.NTF) is to be used.

If you are customizing for a different version of Notes, use the template provided to match.

Hint

When installing new clients, please make sure that the correct mail template is used or assign the new template to the mail database afterwards and update the design.

Create mail template

Use Domino Designer to create a mail template that contains the appropriate design elements.

1. Select the Mail template (mail9.ntf) for copying.

   File > Application > Open… > Mail (mail9.ntf)

   

   

2. Right-click on the application Mail > Application > New Copy.

   

3. When copying enter a new title e.g.: Mail XPhone and the file name e.g..: mail_xphone.ntf.

4. Use the folder icon to select the desired directory on the server where you want to save the template.

5. Use the Encryption button to select Do not encrypt this database locally and click OK.

   

6. Select the Application design only option and click OK.

   

7. In the application list you will now find two applications. You can remove your original template.

   

8. Finally, adjust the template name of your XPhone template.

   1. Click Edit… in the lower area and switch to the Design tab. (If you cannot find the button, right-click on your XPhone template and select Application > Properties).

      

   2. Change the template name.

      Important

      The name must not match the template name of the original template!

      

   3. Now save your changes by closing the Properties window and confirming with Yes.

Open template

The template templateXPConnect_CTI_V9.ntf can be found in the downloaded XPhone Connect package in the directory:

Software\Integrations\IBM Notes\Templates V9

1. Copy the template template to your local template directory (usually C:\Program Files (x86)\IBM\Notes\Data).

   Important

   Make sure that the template is not write-protected.

2. Open the template XPConnect CTI V9 (XPConnect_CTI_V9.NTF) in Domino Designer via File > Application > Open… and use the Browse button to select the local directory where you have copied the template.

You should now have two templates open in your Domino Designer, one of them is the XPConnect_CTI_V9.NTF.

Copy functions of the template to your own template

Now the CTI design elements are copied from the supplied template to the newly created custom template. For all copy operations you can either use the context menu via Right Click > Copy and Right Click > Paste or the keyboard shortcuts :kbd: CTRL+C` and :kbd: CTRL+V`.

After insertion into your template, various queries may appear asking whether elements should be automatically updated after insertion. Confirm these messages with Yes.

Copy these functions from the template template to your own template:

1. Code > Script Libraries

   Select all script librariesin the CTI template and copy them to the clipboard. Paste the script libraries into your template under Code > Script Libraries.

   Copy from the template:

   

   Paste into your template:

   

2. Code > Agents

   Copy the agents XPhone Connect Profile and (XP \ New XPhone Meeting Mail) and paste them into your template under Code > Agents.

3. Code > Common Actions

   Open the grouping with the desired language and copy the following actions into your template here:

   • Search contact (mail)

   • Configure meeting options

   • XPhone Meeting (Mail)

4. Resources > Images

   Kopieren Sie alle Bilder in der CTI-Schablone und fügen Sie sie in Ihre Schablone unter Ressourcen > Bilder ein.

5. Masks

   Copy only the XPhoneConnectSettings mask and paste it into your template under Masks.

6. After the copy operations in your template, open the design group Code > Common Actions by double-clicking it. A new tab will open in the main area. Below it you will find the Properties tab, open the Design tab there.

   Activate the option Cannot be changed by updating or replacing the design here.

   

   Hint

   The properties window can be displayed collapsed at the bottom if necessary - if it is not present at all, open it via Windows > Show Eclipse Views > Properties.

7. The previously copied Common Actions must now be pasted as buttons into the respective masks or views of your template.

Customize masks, views and folders

The following masks, views and folders are adjusted:

Views			Masks	Folder
($ALL)	($Meetings)	(tasks/ done)	_Calendar entry	($Inbox)
($Calendar)	($MeetingsAllByDate2)	(Tasks/ Group)	(Notice)
($Drafts)	($MeetingsOnMyCalendar)	(Tasks/ By category	Tasks
($EntriesOnMyCalendarByCategory)	($Sent)	(Tasks/ Not completed)	Message
($Follow-Up)	($ToDo)	(Tasks/ Personal)
($IMTranscripts)
($BySender)

1. Select the mask/view/folder in your template and enable the Cannot be changed by updating or replacing the design option.

   Note: Do this first step right away for all views, masks and folders from the table above.

   

   After you have set the Cannot be changed by updating or replacing design option for all views/masks/folders, next edit the views/folders individually. We recommend starting with the view ($ALL).

2. Double click on the view ($ALL). A new tab will open. In the right area, where among other things the buttons are listed, an action is now added via Right Click > Insert Common Action….

   

3. Select the actions Search Contact (Mail) and XPhone Meeting (Mail) (you can highlight both by pressing the STRG key), insert them by Insert and confirm with Done.

   

4. The action Search contact (mail) should be placed before the action More (or Chat, if More is not available) by drag&drop.

   

5. Immediately before the action XPhone Meeting (Mail) you should create the action of type Menu Separator. To do this, right-click New and select Create action… A new window will open. Select the type Menu Separator and name the action Menu Separator. Then close the action window.

   

   Both actions Menu Separator and XPhone Meeting (Mail) should be placed at the end of the New menu. Via Drag&Drop the actions can be moved to the right place.

   

6. Now copy the actions Menu Separator, XPhone Meeting (Mail) and Find Contact (Mail) and paste them into the remaining Views and Folders (see table above). Move the actions to the correct place after pasting.

7. To save the changes you have just made, close these tabs by clicking on the Cross and confirm the Save dialog with Yes.

   Tip

   Before closing the last tab, copy the action Find Contact (Mail) for the next step.

   

8. After the actions have been completely inserted in the views and folders, the masks are now edited. Insert the action Find contact (Mail) in all masks and place it before the action Chat. If you followed the tip from the step before, you can simply insert the action, otherwise insert the action again via Insert common action….

9. The mask _Calendar entry gets one more addition: Insert the action Meeting options into this mask via Right click > Insert common action… and place it in front of the just inserted action Search contact (Mail).

   

10. Save the mask by closing the tab.

11. Lastly, click on your template (Mail XPhone) on the left side in the column of Applications and click Recompile LotusScript completely in the upper status bar under Tools. You should not get any errors after the compilation. If the compile option is grayed out, you have not marked the template correctly.

    

Customize database script

Hint

Lines of code that need to be inserted are also located as a text document in the XPConnect_CTI_V9.NTF template under Resources > Files > XP_ScriptCode.txt.

Code > Database Script

1. Double-click in your template to open the design element Code > Database Script.

2. Open the object (Options) and insert the following text:

   Use "XP_CTI"
   

   

3. Open the Postopen object and insert the following text directly after the declarations:

   Call XP_DatabasePostOpen
   

   

4. Open the object RemoveThisDocumentand insert the following text:

   Call XP_ConferenceRemove(notePlaceHolder)
   

   (see lines of code in Resources > Files > XP_ScriptCode.txt)

5. Save the database script by closing the tab and confirm with Yes.

Masks > _Calendar entry

1. Double-click in your template to open the _Calendar entry mask.

2. Open the (Globals)Appointment section, select the (Options) object and insert the following text:

   Use "XP_CTI"
   

   

3. Open the Postsave object and paste the following text:

   Call XP_ConferencePostSaveAppointment(Source)
   

   (at the end of postsave, see lines of code in Resources > Files > XP_ScriptCode.txt)

   

4. Save the mask

Masks > (Notice)

1. Double-click in your template to open the (Notice) mask.

2. Open the (Globals)Notice section, select the (Options) object and insert the following text:

   Use "XP_CTI"
   

   

3. Open the Postsave object and paste the following text:

   Call XP_ConferencePostSaveNotice(Source)
   

   (at the end of postsave, see lines of code in Resources > Files > XP_ScriptCode.txt)

   

4. Save the mask.

5. Compile the new template via Tools > Recompile LotusScript completely and make sure that it does not contain any errors.

Meeting Invitation Email Templates

Invitations to meetings scheduled in Notes are sent to the participants as Notes meetings. The HTML templates for these invitations are installed with the Notes integration of the XPhone Connect client:

C:\Program Files (x86)\C4B\XPhone Connect Client\MailTemplates\System

The templates are available in two variants per language - depending on whether the integration of the URL for web meeting is desired or not:

You can use your own templates for the invitations. To do this, copy them to the parent directory with the file names shown above:

C:\Program Files (x86)\C4B\XPhone Connect Client\MailTemplates

These data can be changed directly in the template, the changes must be made per language (e.g. for the location of the meeting “Munich” in the German and “Munich” in the English version of the file):

• Location of the meeting (default XPhone meeting)

  <meta name="Location" content="XPhone-Meeting">
  

• Company logo

  <img src="C:\Program Files (x86)\C4B\XPhone Connect Client\MailTemplates\Firmenlogo.gif" alt="Firmenlogo">
  

• Content, headings, formatting

  Hint

  Notes unterstützt nur einige HTML-Elemente, XPhone Connect verwendet die Notes-Aktion NotesUIDocument.Import, eine Beschreibung dazu finden Sie in der Domino Server Dokumentation.

The following placeholders are replaced when generating the invitation and can also be used in your own templates:

• ActivationDeltaPre (meeting activation in minutes before the start of the meeting).

• WebMeetingUrl (link to call web meeting)

• DialIn_all (all configured dial-in numbers)

• DialIn_en (dial-in number for DE)

• DialIn_en (dial-in number for EN)

• DialIn_it (dial-in number for IT)

• DialIn_fr (dial-in number for FR)

Automatic calendar synchronization

The following points must be observed when installing XPhone Connect for automatic calendar synchronization with Notes.

On the XPhone Connect Server

Configure presence management settings on XPhone Connect Server for Notes calendar synchronization.

On the XPhone Connect Client

1. Überprüfung, ob Notes als Standard-Mailprogramm eingetragen ist

2. Installation of XPhone Connect with Notes calendar synchronization. Here the dlls XPNotesExtMgrAddin and XPNotesMenuAddin are installed in the Windows directory, but are not yet connected to Notes.

3. Exit the Notes client and add the following entries to notes.ini:

   AddInMenus=XPNotesMenuAddin.DLL
   EXTMGR_ADDINS=XPNotesExtMgrAddin.DLL
   

   Important

   Bei dem Eintrag EXTMGR_ADDINS muss darauf geachtet werden, dass dieser Eintrag vor einem ggf. bereits vorhandenen Eintrag steht. z.B. EXTMGR_ADDINS=XPNotesExtMgrAddin.DLL;<vorhandener Eintrag>

4. Neustart des Notes Clients. Der Menüpunkt Kalenderabgleich starten sollte nun im Notes Client unter Menü Aktionen sichtbar sein.

Hint

If the Notes extensions are not available for some reason, the DLLs can be manually connected to Notes via XPSyncNotes.exe -install (located in the XPhone Connect Client installation directory), i.e. entered into notes.ini. Prerequisite for this is that Notes has been started before. If the @categories are not available, they can be added to Notes manually using XPSyncNotes.exe -updatecategories. Again, make sure that Notes is started first.

Periodic calendar synchronization

If the option Automatic calendar synchronization is activated, a periodic calendar synchronization with Notes takes place if no changes have been made in the Notes calendar after approx. 120 sec.

In addition, an hourly synchronization of all appointments takes place, the interval of the periodic synchronization can be changed via the Windows Registry:

1. To do this, open the key:

   HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\C4B\XPNotesExtMgrAddin
   

2. Create a new string / string value here: PeriodicSync

3. As value you store the desired interval in seconds. In the standard this is 3600 (= one hour).

Matching the new categories

XPNotesExtMgrAddin enters the new categories when the Notes client is started.

Have you found an mistake on this page?

Please send us a hint about this error by mail to doku@c4b.de. Thank you very much!