INSTALLING


Setting up Notes installation using scriptable setup

The scriptable setup option uses the CONFIGFILE= setting in the NOTES.INI file to provide user information for the setup phase of the Notes® installation program.

The CONFIGFILE= setting in the NOTES.INI file points to a text file (for example ConfigFile=C:\Program Files\HCL\Notes\Data\setup.txt) that contains the Notes users' setup parameters that you want to pass to the installer for use in configuring the user after installation is complete. The Notes installer processes the contents of this file to complete the user's setup. The user is able to bypass any install screen panels or prompts for which parameters have been provided in the setup.txt file.

The settings that you can configure in the text file are as follows:

Note: For more information about using scriptable setup, see the related topic Example: Applying scriptable setup using a transform file during Notes install as well as Tech Note 1112835, How to set up a Notes client without user intervention using a scriptable setup.

Note: Support for direct dialup modem (X.PC) connections is not available after Domino® 8.5.

Table 1. Configurable text file settings
Setting Description
UsernameUser's hierarchical name -- for example, John Smith/Acme
KeyfileNameDirectory path to the user's ID file name --for example, c:\program files\ibm\notes\data\jsmith.id
Domino.NameDomino server in the same domain as the user name. You do not need to enter a hierarchical name.
Domino.AddressAn address for the Domino server, such as the IP address of the server, if needed, to connect to the server. For example, server.acme.com or 123.124.xxx.xxx
Domino.PortPort type, such as TCPIP
Domino.Server1 to connect to the Domino server, 0 for no connection
AdditionalServices1 forces display of the "Additional Services" panel even if sufficient information is provided for these services; the Additional Services panel lists Internet, proxy, and replication settings.
AdditionalServices.NetworkDialTo configure a network dialup connection to Internet accounts created via Additional Services dialog box
Mail.Incoming.NameIncoming mail account name, a friendly name used to refer to these settings
Mail.Incoming.ServerIncoming mail (POP or IMAP) server name
Mail.Incoming.Protocol1 for POP; 2 for IMAP
Mail.Incoming.UsernameMail account user name or login name
Mail.Incoming.PasswordMail account password
Mail.Incoming.SSL0 to disable; 1 to enable the TLS protocol for incoming Internet mail
Mail.Outgoing.NameOutgoing mail account name, a friendly name used to refer to these settings
Mail.Outgoing.ServerOutgoing mail (SMTP) server name
Mail.Outgoing.AddressUser's Internet mail address, such as user@isp.com
Mail.InternetDomainInternet Mail domain name such as isp.com
Directory.NameDirectory account name, a friendly name used to refer to these settings
Directory.ServerDirectory (LDAP) server name
News.NameNews account name, a friendly name used to refer to these settings
NetworkDial.EntryNameName of remote network dialup phone book entry
NetworkDial.PhonenumberDial-in number
NetworkDial.UsernameRemote network user name
NetworkDial.PasswordRemote network password
NetworkDial.DomainRemote network domain
DirectDial.PhonenumberPhone number of Domino server
DirectDial.PrefixDialup prefix, if required. For example, 9 to access an outside line.
DirectDial.PortCOM port to which the modem is connected
DirectDial.ModemFile specification of modem file
Proxy.HTTPHTTP proxy server and port -- for example, proxy.isp.com:8080
Proxy.FTPFTP proxy server and port -- for example, proxy.isp.com:8080
Proxy.GopherGopher proxy server and port -- for example, proxy.isp.com:8080
Proxy.SSLTLS proxy server and port -- for example, proxy.isp.com:8080
Proxy.HTTPTunnelHTTP tunnel proxy server and port -- for example, proxy.isp.com:8080
Proxy.SOCKSSocks proxy server and port -- for example, proxy.isp.com:8080
Proxy.NoneNo proxy for these hosts or domains
Proxy.UseHTTPUse the HTTP proxy server for FTP, Gopher, and TLS security proxies
Proxy.UsernameUser name if logon is required
Proxy.PasswordUser password
Replication.ThresholdTransfer outgoing mail if this number of messages held in local mailbox
Replication.ScheduleEnable replication schedule
IM.ServerInstant messaging server name required unless you have set the NOTES.INI variable IM_NO_SETUP= 1.

When this variable is set to 1, the IM Configuration dialog box does not display during new client setup or client upgrade, and all IM variables in a scriptable client setup are ignored. If the user wants to configure IM, they can leave the NOTES.INI variable out of their NOTES.INI file or set it to 0 (IM_NO_SETUP= 0).

IM.PortInstant Messaging server port (any positive number)
IM.ConnectWhen(Optional setting) Defines when to connect to Instant Messaging:
  • 0 -- At Notes login (default)
  • 2 -- Manually
IM.ProtocolUse one of these:
  • 0 -- Directly to Instant Messaging server
  • 1 -- Directly to Instant Messaging server using HTTP protocol
  • 2 -- Directly to Instant Messaging server using IE HTTP settings
  • 3 -- Use a proxy
IM.ProxyTypeRequired if IM.Protocol is set to 3. Use one of these:
  • 0 -- SOCKS4 Proxy
  • 1 -- SOCKS5 Proxy
  • 2 -- HTTPS Proxy
  • 3 -- HTTP Proxy
IM.ProxyServerRequired if IM.Protocol is set to 3. Name of Instant Messaging proxy server
IM.ProxyPortRequired if IM.Protocol is set to 3. Port of Instant Messaging proxy server (any positive number)
IM.ServerNameResolveOnly used if IM.ProxyType is 1 (SOCKS5) but it is not required. Use one of these values:
  • 0 -- Disable IM.ServerNameResolve
  • 1 -- Enable IM.ServerNameResolve
IM.ProxyUsernameRequired if IM.Protocol is set to 3 and IM.ProxyType is not SOCKS4

Sample scriptable setup file

This is a sample scriptable setup file for a LAN connection. All options are used in this sample file. Username = Joe Employee

KeyFileName=G:\shareddrive\userid\jemployee.id

Domino.Server=1

Domino.Name=servername/domain (For example, server1/sales/enterprise)

Domino.Port=TCP/IP

IM.Server=servername.misc.domain.com

IM.Port=12345

IM.ConnectWhen=2

IM.Protocol=3

IM.ProxyType=2

IM.ProxyServer=sametimeproxy.domain.com

IM.ProxyPort=789

IM.ServerNameResolve=0

IM.ProxyUsername=joeemployee

AdditionalServices=0

Mail.Incoming.Protocol=2

Mail.Incoming.Name=INCOMING INET MAIL

Mail.Incoming.Server=servername.misc.domain.com

Mail.Incoming.Username=jemployee

Mail.Incoming.Password=xyz123

Mail.Incoming.SSL=0

Mail.Outgoing.Name=OUTGOING INET MAIL

Mail.Outgoing.Server=servername.misc.domain.com

Mail.Outgoing.Address=joeemployee@domain.com

Mail.InternetDomain=misc.domain.com

AdditionalServices.NetworkDial=1

NetworkDial.EntryName=TEST 1 Dial-up Connection

NetworkDial.Username=jemployee

NetworkDial.Password=xyz123

NetworkDial.Phonenumber=area code-phone-number (For example, 508-123-4567)

NetworkDial.Domain=domainname

News.Name=NEWS SERVER ACCOUNT

News.Server=server.domain.com

Directory.Name=LDAP DIRECTORY SERVER ACCOUNT

Directory.Server=name.misc.domain.com

Proxy.UseHTTP=0

Proxy.HTTP=proxy.domain.com:8080

Proxy.FTP=proxy.fake.com:8080

Proxy.Gopher=proxy.fake.com:8080

Proxy.SSL=proxy.fake.com:8080

Proxy.SOCKS=proxy.domain.com:1080

Proxy.HTTPTunnel=proxy.domain.com:8080

Proxy.None=domain.com

Replication.Threshold=3

Replication.Schedule=1

Parent topic: Automating a customized or default Notes deployment using silent install

Related concepts
Customizing Notes installation
Automating a customized or default Notes deployment using silent install
Example: Sharing command line utilities for installing Notes

Related tasks
Example: Applying scriptable setup using a transform during Notes install
Obtaining a tuner and creating a transform file to customize Notes installation
Example: Creating and providing a batch file for Notes silent install

Related information
How to set up a Notes client without user intervention using a scriptable setup