background image

Alcatel-Lucent Applications 
All Rights Reserved © Alcatel-Lucent 2007 

Alcatel-Lucent
OmniTouch Fax Server 
Application

System Administrator Guide 

8AL_90215_USAA ed.01 

Release 5 
June, 2007 

Summary of Contents for OmniTouch Fax Server Application

Page 1: ...Alcatel Lucent Applications All Rights Reserved Alcatel Lucent 2007 Alcatel Lucent OmniTouch Fax Server Application System Administrator Guide 8AL_90215_USAA ed 01 Release 5 June 2007...

Page 2: ...ademarks of Alcatel Lucent All other trademarks are the property of their respective owners The information presented is subject to change without notice Alcatel Lucent assumes no responsibility for i...

Page 3: ...ministrator Site Configuration 13 Internal Users 13 Creating an Internal User Account 13 Modifying a Internal User Account 15 Removing a Internal User Account 16 Profiles 17 Creating a Profile 17 Ente...

Page 4: ...ting destination 44 Removing a routing destination 45 Routing Table Entry Properties 46 Modifying a routing rule 47 Changing the priority of a routing rule 47 Removing a routing rule 47 Mail 48 Adding...

Page 5: ...n entry 82 Changing the priority of an action in a number modification entry83 Removing an action in a number modification entry 83 Modifying a number modification entry 84 Removing a number modificat...

Page 6: ...Uploading our OmniTouch Fax Server Cover sheets to the server 117 Chapter 7 Banner and Notification Templates 119 Banner and Notification Template Variables 120 Inbound Variables 120 Outbound Variabl...

Page 7: ...a default license is available for evaluation purposes This demo license enables one instance of each component and a total of two channels of any type T38 in evaluation mode The default license allo...

Page 8: ...y the other drivers borrowers respectfully Server Components The OmniTouch Fax Server server includes the following five components the Fax Manager the Driver and the Rasterization Services XML and SM...

Page 9: ...otus Notes Forms include two files Fax_Memo_Install nsf nsf stands for Notes Storage Facility These files represent typical Lotus Notes databases The installation database Fax_Memo_Install nsf contain...

Page 10: ...x Server System Administrator Guide 8AL_90215_USAA ed 01 faxes The web access utility is automatically installed with the fax manager Note The web access utility requires Internet Explorer 6 0 or late...

Page 11: ...hanged before proceeding any further There are two options for logging into OmniTouch Fax Server 1 Open a Web browser 2 Enter the URL designated by your system administrator The Login screen appears 3...

Page 12: ...b Administrator appears Normal Login 1 Open a Web browser 2 Enter the URL designated by your system administrator A Login page appears 3 Enter your Administrator Name and Password 4 Click Login Note I...

Page 13: ...ite you can configure Internal User Accounts Profiles Cover sheets Incoming routing table Notification destinations Notification profiles Internal Users The Internal User directory node allows the adm...

Page 14: ...appears 3 Enter the user s SMTP address a mandatory entry 4 Use Profile Name to associate the user with a specific profile A profile is mandatory If no other profiles exist you can choose Basic or No...

Page 15: ...AL_90215_USAA ed 01 15 7 When done click OK Modifying a Internal User Account 1 In the Web Administrator select Configuration Internal User 2 In the right panel of the Web Administrator select the che...

Page 16: ...de 8AL_90215_USAA ed 01 3 Make whatever modifications are required in the User and Sender Information tabs 4 Make whatever modifications are required in the User and Sender Information tabs 5 Click OK...

Page 17: ...with three retries if a connection cannot be immediately established while the No Faxing Rights profile does not allow the transmission of faxes You might also create any number of new profiles and as...

Page 18: ...e Name field enter the name of the profile 4 Click OK Entering Organization Information 1 In the Web Administrator select Configuration Profiles 2 In the right panel of the Web Administrator select th...

Page 19: ...information Note If an entry to a field is omitted here no other information is sent For example if you make an entry to the Organization field and leave all other fields blank only that entry is incl...

Page 20: ...6 Click OK Cover Sheets and Profiles Cover sheets are associated with profiles in one of two manners a default cover sheet or a simple association If a default cover sheet is specified in a profile us...

Page 21: ...appears 4 In the Default Coversheet section select a default cover sheet in the Cover Sheet field or none if you do not want to associate a default cover sheet to the profile 5 Click OK Assigning othe...

Page 22: ...he cover sheet 3 Select Properties The Profile dialog appears 4 Click the Cover Sheets tab 5 In the Default Coversheet section select a default cover sheet in the Cover Sheet field or none if you do n...

Page 23: ...iority The server then restarts the polling from scratch If no new faxes to send are found the server then polls for faxes that have only been tried once If some are found they are sent according to t...

Page 24: ...e same as in the Default field For example a user with a default of Normal and a maximum of Normal can only select Low or Normal High will not be available 7 Click OK Setting the number of retries 1 I...

Page 25: ...1 In the Web Administrator select Configuration Profiles 2 In the right panel of the Web Administrator select the profile for which you would like to set the fax resolution 3 Select Properties 4 Clic...

Page 26: ...itting is not completed within that time the transmission is cancelled Enter a different value if desired 6 If required enter the user s Call Station ID in the CSID field A Call Station ID should not...

Page 27: ...ing the maximum number of digits the variable can occupy If the value of the variable is longer it is truncated to number_of_digits If the value is smaller it is padded at the right with enough spaces...

Page 28: ...ar SenderFirstName SenderSubBillingCode SenderCity SenderLastName SenderTitle SenderCompany SenderPager SenderZipCode SenderCountry SenderPhone RecipientAddress Recipiente mail RecipientPhone Recipien...

Page 29: ...es already specified Note When adding a variable you may include a comma and specify the number of digits as specified above Also whether you specify text variables or a combination of both the width...

Page 30: ...rator select the checkbox of the profile for which you would like to apply security settings 3 Select Properties 4 Select the Security tab 5 Uncheck the User Is Allowed To Fax box to prevent users ass...

Page 31: ...hem are sent using the default values specified for the profile If this option is selected the sections in SendFAX and the Forms for MS Outlook that enable these types of changes are grayed out 9 In t...

Page 32: ...fication Profile selection box and then click Add These notification profiles are originally defined in the Notification Profiles node of the Web Administrator Refer to Notification profiles on page 5...

Page 33: ...ions from the Search results area that you would like to include in the additional notification destination list By default the original user always receives an e mail notification 10 Click Add to Lis...

Page 34: ...file Lookup Table holds a set of rules used by the system to determine a user s Profile These rules are based on the Attributes provided by the Directories Integration and can be applied once the user...

Page 35: ...e rule is always applied Conditions are linked with the logical operator AND For example a Condition such as the one shown in the following screenshot can be defined in the Conditions of a Profile Loo...

Page 36: ...Chapter 3 Web Administrator Site Configuration 36 OmniTouch Fax Server System Administrator Guide 8AL_90215_USAA ed 01 1 Select Internal Users and then select Properties...

Page 37: ...e 3 To add Custom Attributes select Add 4 Enter an Attribute Name and from the Name in Directory drop list select the directory in which the attribute will reside 5 Click Ok The new attributes appear...

Page 38: ...ute and Relation e g SmtpAddress and Match Wildcards respectively and type in the Value e g mycompany com 3 Click Ok Cover sheets After installation the Cover Sheets option in the Web Administrator li...

Page 39: ...ver sheet file that you want to add and double click on it or select it and click Open 4 Click Ok The cover sheet now appears in the Cover Sheet list Renaming a cover sheet 1 In the Web Administrator...

Page 40: ...e 4 In the appearing dialog click Ok to confirm the deletion or click Cancel if you changed your mind The cover sheet will disappear from the list Incoming routing table Incoming routing delivers inco...

Page 41: ...ing DID is an analog service provided to subscribers by the telephone company The subscriber first obtains a DID trunk line a block of fax numbers typically 20 or 100 and a fax board with at least one...

Page 42: ...ndow appears 3 Check the Use this destination for misrouted faxes box to enable the use of a default routing address 4 In the Type field select either User Mail or Printer 5 In the User field select t...

Page 43: ...the first four check boxes enter the routing string to look for In the case of CSID routing the routing string is the call station ID used by the remote fax sender In the case of ANI DTMF and DNIS DI...

Page 44: ...er User Mail or Printer The search results area displays all current possibilities for the selected Type The default placeholder did transmits the incoming number The asterisk represents any combinati...

Page 45: ...d until a match is found The fax is then routed to the user whose facsimiletelephonenumber field contains the match 5 In the Mail field select a notification destination Site users are defined in the...

Page 46: ...ose cases the number is represented by the placeholders ani dtmf and csid It is also possible to provide format specifications using the question mark For example did A semi colon serves as the delimi...

Page 47: ...a routing rule 1 In the Web Administrator select Configuration Incoming Routing Table of your site 2 Select the checkbox for the routing rule you want to modify 3 From the lower right area select Pro...

Page 48: ...ion Settings section choose a notification profile in the Notification Profile selection box These notification profiles are originally defined in the Notification Profiles node of the Web Administrat...

Page 49: ...log click Yes to confirm the deletion or click No if you change your mind The mail notification destination disappears from the list 4 Click OK Note An administrator will be prevented from modifying o...

Page 50: ...his destination available to all users for forward operation 4 Use Paper Selection to indicate the paper settings 5 Use Paper Selection to indicate the paper settings Select Automatically Determine Pa...

Page 51: ...tab appears 4 Make whatever modifications are required 5 Click OK Notification format for printer destinations 1 In the Web Administrator select Configuration Notification Destinations Printers 2 Sel...

Page 52: ...s on page 52 or Banner and Notification Template Variables on page 120 Removing a printer notification destination 1 In the Web Administrator select Configuration Printers 2 Select the checkbox of the...

Page 53: ...the type of notification attachments either tiff or PDF The default is tiff 5 In the Outbound Attachment Name box enter the appropriate outbound name 6 In the Inbound Attachment Name box enter the ap...

Page 54: ...efore only explain the procedure to configure the Outbound Success notification options This procedure may then be applied similarly to the configuration of the other event notification options 1 In t...

Page 55: ...dicates on which pages of the notification the banner should appear Choose between None First or All Default is First for both outbound and inbound faxes Note This selection box does not appear in the...

Page 56: ...to modify and then select Properties The Notification Options tab appears 3 Make whatever modifications are required Profile Name refers to the designated profile name Message Body Format select the a...

Page 57: ...el of the Web Administrator select the checkbox of the notification profile that you want to delete and then select Remove 3 In the appearing dialog click Yes to confirm the deletion or click No if yo...

Page 58: ...ox and then enter a value in the Clean out faxes older than days field to delete incoming faxes after a certain number of days 4 Check the Backup faxes box to archive faxes before deletion 5 In the Ou...

Page 59: ...following system components Incoming routing table Modification table System administrator accounts Deletion policy General settings Driver Driver properties for a particular host include General Opt...

Page 60: ...the default Choosing Low Level logs as much information as possible choosing Fatal Error logs only fatal errors 3 Check the Enable Log Archiving to automatically logs for future support use Enter the...

Page 61: ...splay Name field 6 Click OK Configuring the T 38 gateway and gatekeeper options VOIP settings allow you to configure the H 323 protocol or the SIP protocol For H 323 you can specify both a primary and...

Page 62: ...ult port is 5060 Enter a new port if the gateway is changed 7 Select the Print SIP Messages option to write those messages to the OmniTouch Fax Server driver log files 8 In the Option section select E...

Page 63: ...atekeeper in the Primary Host Gatekeeper field 5 The port used by the primary gatekeeper is 1718 Enter a different port only if the gatekeeper uses a different port 6 Enter the host name of a secondar...

Page 64: ...e sent by a particular gateway Adding a gateway entry to the peer list The first step is to add the additional gateway or gateways to the peer list 1 In the Web Administrator select Configuration Driv...

Page 65: ...n the peer list Leaving this unchecked will mean that all inbound faxes will be trusted 9 Click OK Modifying a gateway entry in the peer list 1 In the Web Administrator select Configuration Driver The...

Page 66: ...Remove The gateway disappears from the list 4 Click OK Note An administrator will be prevented from deleting a gateway from the peer list if it is already added to a dial plan It must first be remove...

Page 67: ...r Pattern field The numeric pattern must specify the entire fax number anticipated Wildcards can be entered The asterisk specifies any number of digits the question mark specifies a single digit For e...

Page 68: ...hen the same numeric pattern is specified for two or more peer gateways The gateway with the highest preference is used If that gateway is not available the gateway with the next highest preference is...

Page 69: ...Number Pattern Properties dialog appears 4 In the Peers section select a peer gateway reference and click Properties The Peer Properties dialog appears 5 Modify the peer gateway reference settings as...

Page 70: ...lan tab 3 In the Dial Plan section select a number pattern and then click Properties The Number Pattern Properties dialog appears 4 In the Peers section select the checkbox of the peer gateway referen...

Page 71: ...tab 3 In the Dial Plan section select a number pattern and then click Properties The Number Pattern Properties dialog appears 4 Modify the dial plan settings as needed 5 Click OK Changing the priorit...

Page 72: ...select the checkbox of the number pattern whose priority you want to change and then select Move Up or Move Down 4 Click OK Removing a dial plan 1 In the Web Administrator select Configuration Driver...

Page 73: ...e Status field select Enabled or Disabled 3 Click OK Directories Integration Directories Integration holds a set of rules that allow the system to find Attributes based on queries made against interna...

Page 74: ...ies Use the OmniTouch Fax Server Internal Directory 1 Under Configuration select Directories Integration 2 Select Add Internal Directory from the context menu The Directories Integration Properties wi...

Page 75: ...you are using an Active Directory server or a global catalog server An Active Directory server will listen on port 389 whereas a global catalog server listens on port 3268 4 If the server requires au...

Page 76: ...s configuration is similar to what you would configure for a file search Search Base The Search Base indicates where in the tree the search begins It should be used to narrow the search to the locatio...

Page 77: ...this Attribute between dollar signs The OmniTouch Fax Server Attribute that corresponds to the user s SMTP Address is SmtpAddress For example a filter that searches for the Active Directory object wi...

Page 78: ...tom Attributes 1 Click the Add button and then enter the Attribute Name 2 For the Name in Directory field either select a name from the drop down list or for an LDAP Directory type in the Name in Dire...

Page 79: ...pattern a condition and the expected number of digits The second component specifies an action that is the modification to be applied to the number or pattern Modifications can remove digits insert d...

Page 80: ...t must appear in the fax number entered by the user to qualify for number modification Assuming the pattern 1212 a condition of Equal and 11 digits would apply the pattern to faxes addressed to number...

Page 81: ...end of the number in the Start From field 5 Enter the digit offset value from which the modification will be made in the Offset field The offset is from left to right when starting from the beginning...

Page 82: ...ure 7 Click OK 8 Click OK Modifying an action in a number modification entry 1 In the Web Administrator select Configuration Modification Table 2 Select the number modification entry that you want to...

Page 83: ...Configuration Modification Table 2 Select the checkbox of the number modification entry that you want to modify and then click Properties The Modification Table Entry Properties dialog appears 3 In th...

Page 84: ...e Modification Table Entry Properties dialog appears 3 Select the action that you want to delete and then click Remove It will disappear from the list 4 Click OK Modifying a number modification entry...

Page 85: ...then select Remove 3 Click Yes in the dialog that appears to confirm the deletion or click No if you changed your mind The number modification entry will disappear from the list 4 Click OK Administrat...

Page 86: ...er does not verify that the name entered here is a valid user 5 Click Create or click Cancel if you decide not to create the administrator account right away Changing an administrator account password...

Page 87: ...the user to change his administrator account password the next time he or she logs into OmniTouch Fax Server 5 Click OK Deletion policy The deletion policy is used to remove faxes from the archive dat...

Page 88: ...ion Time field 3 In the Incoming Faxes and Outgoing Faxes fields browse to select where the backup files should be saved before being deleted from the archive database 4 Click OK General settings The...

Page 89: ...ry should be changed only if a different mail server is to be used 5 The Outgoing and Incoming options allow you to specify the maximum number of faxes allowed in the outgoing or incoming fax queue Th...

Page 90: ...tion cannot be delivered successfully the default pattern 1 1 1 5 5 30 30 60 will result in to the first 4 attempts to be separated by 1 minute then the next 2 by 5 minutes then next 2 by 30 minutes a...

Page 91: ...1 Viewing the license 1 In the Web Administrator select Configuration General Settings 2 Select the License tab 3 Click View The content of the license file displays in Notepad You can view informatio...

Page 92: ...Chapter 4 Web Administrator System Configuration 92 OmniTouch Fax Server System Administrator Guide 8AL_90215_USAA ed 01...

Page 93: ...e Column Heading Definition ANI indicates the recipient s automatic number identification Archived Time indicates the time the fax was archived Channel Number indicates the channel that received the f...

Page 94: ...r description reported by the component that generated the error The information is of a technical nature and is useful for support purposes Pages Received indicates the number of pages actually recei...

Page 95: ...n or out or rotate the fax image 4 Close the window when you re done by clicking the button located in the upper right corner of the window or by selecting File Exit Forward a Fax The Forward option e...

Page 96: ...orward button to send your fax to the selected destination Click the Cancel button to cancel the operation Searching inbound history records The fields and options in the search toolbar allow you to e...

Page 97: ...criteria You can specify another number of record returns in the Maximum Search Hit field 5 Click OK 6 In the left hand data entry field of the search toolbar enter the expression that you wish to se...

Page 98: ...search toolbar choose a fax status The default is All You can choose either Failed or Sent Received 9 Click Search Matching faxes if any will be displayed in the right hand panel of the Web Administr...

Page 99: ...ministrator Level Information The information includes an error code and a more precise description of the problem and a proposed solution Low Level Information The information is a low level descript...

Page 100: ...Server System Administrator Guide 8AL_90215_USAA ed 01 4 To view the routing information of the fax click the Routed To tab The routing information includes the Type of destination the Destination id...

Page 101: ...smission was completed or was acknowledged as a failed transmission Duration indicates the duration of the transmission Error Code indicates the error generated by a component Low Level Error Messages...

Page 102: ...cod Sending Driver indicates the OmniTouch Fax Server driver that sent the fax Site ID indicates the unique ID of the sender s site internal to OmniTouch Fax Server which can be used for searching si...

Page 103: ...Resubmit To dialog appears 3 Enter the new recipient s fax number in the Please enter the recipient s fax number field 4 Click OK Viewing a fax 1 In the Web Administrator select the System Monitor Out...

Page 104: ...ystem Monitor Outbound History The search toolbar appears at the top of the right hand panel in the Web Administrator window 2 If you wish to change the search fields click Options located to the righ...

Page 105: ...among the following options Last Hour Last 6 Hours Last 12 Hours Last Day Last Week Last Month Last 3 Months and Custom Custom displays a Custom Date dialog in which you can specify a range consisting...

Page 106: ...ies window appears The information is only displayed and cannot be modified 3 Click the More button to view the Error Code and Solution There are three levels of Error Description Error Description Ad...

Page 107: ...atus applied For example status for a fax in the outgoing queue might progress from Waiting to Send to Sending to Sent Low Level Information The information is a low level description of the above err...

Page 108: ...r description reported by the component that generated the error The information is of a technical nature and is useful for support purposes First Sending Time indicates the time at which the driver t...

Page 109: ...ing code Sending Driver indicates the driver through which the fax is to be transmitted Site ID indicates the unique ID of the sender s site internal to OmniTouch Fax Server which can be used for sear...

Page 110: ...mind The outgoing broadcast faxes will disappear from the queue Viewing a fax The program used to launch a tiff file may vary from one Operating System to another or depending on file association 1 In...

Page 111: ...n items Search performed by exact match on selected properties 4 By default OmniTouch Fax Server returns a maximum of 100 records that meet the search criteria You can specify another number of record...

Page 112: ...n the second selection box of the search toolbar choose a fax priority The default is All You can choose either High Normal or Low 9 Click Search Matching faxes if any will be displayed in the right h...

Page 113: ...e are three levels of Error Description Error Description Administrator Level Information The information includes an error code a more precise description of the problem and a proposed solution Low L...

Page 114: ...nformational and cannot be modified The variables displayed are Channel Current Page Destination DNIS DID Local CSID Remote CSID Site Status Time Start Total Pages and User Column headings in the disp...

Page 115: ...fax indicates that the channel is retrieving information and is applying fax options Establishing call indicates establishing a data transmission connection between two endpoints Sending indicates th...

Page 116: ...L_90215_USAA ed 01 1 In the Web Administrator select System Monitor Channels 2 Select the checkbox of the channel whose status variables you want to view and then select Properties The Channel Status...

Page 117: ...assigned to the cover sheet is offered by default Note Cover sheet names must be unique Enter a new name if the cover sheet you are saving already resides in the location The default extension cse can...

Page 118: ...Touch Fax Server System Administrator Guide 8AL_90215_USAA ed 01 4 You can then edit the Faxing Profiles to either set this cover sheet as the default coversheet or to allow users to select this cover...

Page 119: ...rofiles To do this edit the files located in opt ofs Config NotificationTemplatesForNewSite on every computer running the XMConfigManager service The XMConfigManager service needs to be restarted afte...

Page 120: ...must be spelled exactly as indicated here Banner and Notification Template Variables The variables you can specify in banners and mail notification templates fall into two main categories those appli...

Page 121: ...lFaxDestination represents the number the fax sender entered General Variables General variables include the following SenderAddress Sendere mail SenderPhone SenderBillingCode SenderFax SenderSalutati...

Page 122: ...but number_of_digits is specified an equivalent number of spaces will be appended in the resulting string Note The comma and number_of_digits part of the variable format is optional If it is not spec...

Page 123: ...01 123 sent or received and attaches it to the displayed notification content The AttachmentPlaceHolder variable is specified within a table You can move it within the HTML template or delete it TABL...

Page 124: ...Chapter 7 Banner and Notification Templates 124 OmniTouch Fax Server System Administrator Guide 8AL_90215_USAA ed 01...

Page 125: ...w to configure the system so that only users listed under the Internal Users node of a Site can access the system i e users who are part of the OmniTouch Fax Server Internal Directory This is the easi...

Page 126: ...not listed in the OmniTouch Fax Server Internal Directory Unlisted users will be able to send and receive faxes via their e mail clients but they will not be allowed to access the Web interface to id...

Page 127: ...d Profile Attributes for all users listed in the OmniTouch Fax Server Internal Directory 2 Under Site Lookup Table add three rules Rule 1 This rule will direct all listed users to their respective Sit...

Page 128: ...Company Refer to Creating an Internal User Account on page 13 Additional information The Profile Lookup Table of Consultants can be configured exactly like the Profile Lookup Table of Company This all...

Page 129: ...Active Directory it will allow the system to find users based on their SMTP Addresses The default mapping of the Attributes should be adequate for an Active Directory If not you need to review the At...

Page 130: ...unts Configuration 1 Under Directories Integration add an OmniTouch Fax Server Internal Directory The default mapping of the Attributes is adequate You do not need to create Conditions 2 Under Directo...

Page 131: ...cess cover sheet editor 9 cover sheets 38 40 117 adding 39 and profiles see profiles copying 40 creating and editing 117 distributing 117 name extension 117 removing 40 renaming 39 CSID 41 routing usi...

Page 132: ...ry 93 incoming routing see routing internal users 13 accounts modifying 15 removing 16 L LDAP methods default 46 supported 46 routing using 46 47 M manual overview 7 who should read it 7 Microsoft Out...

Page 133: ...24 O overview of the manual 7 P peer list see driver Profile Assign users 37 Profile Lookup Table 34 Conditions 35 Order 35 Profile User Attributes 35 profiles 17 adding fax headers 28 Basic 17 cover...

Page 134: ...onfiguring 89 license updating 90 viewing 91 monitoring 93 116 channels status variables 114 viewing properties 115 inbound history 93 101 fax re routing 94 viewing 94 properties 98 101 searching reco...

Page 135: ...ver System Administrator Guide 8AL_90215_USAA ed 01 Index 135 Test Lookup Table 38 U Unicode 120 Use Cases 125 users 13 accounts creating 13 undefined 13 V VoIP settings 61 W web access 9 who should r...

Page 136: ...Index 136 OmniTouch Fax Server System Administrator Guide 8AL_90215_USAA ed 01...

Page 137: ......

Page 138: ...Alcatel Lucent Applications Page 3 www alcatel lucent com...

Reviews: