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

Username

User's hierarchical name -- for example, John Smith/Acme

KeyfileName

Directory path to the user's ID file name --for example, c:\program files\ibm\notes\data\jsmith.id

Domino®.Name

Domino® server in the same domain as the user name. You do not need to enter a hierarchical name.

Domino®.Address

An 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®.Port

Port type, such as TCPIP

Domino®.Server

1 to connect to the Domino® server, 0 for no connection

AdditionalServices

1 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.NetworkDial

To configure a network dialup connection to Internet accounts created via Additional Services dialog box

Mail.Incoming.Name

Incoming mail account name, a friendly name used to refer to these settings

Mail.Incoming.Server

Incoming mail (POP or IMAP) server name

Mail.Incoming.Protocol

1 for POP; 2 for IMAP

Mail.Incoming.Username

Mail account user name or login name

Mail.Incoming.Password

Mail account password

Mail.Incoming.SSL

0 to disable; 1 to enable the SSL protocol for incoming Internet mail

Mail.Outgoing.Name

Outgoing mail account name, a friendly name used to refer to these settings

Mail.Outgoing.Server

Outgoing mail (SMTP) server name

Mail.Outgoing.Address

User's Internet mail address, such as user@isp.com

Mail.InternetDomain

Internet Mail domain name such as isp.com

Directory.Name

Directory account name, a friendly name used to refer to these settings

Directory.Server

Directory (LDAP) server name

News.Name

News account name, a friendly name used to refer to these settings

NetworkDial.EntryName

Name of remote network dialup phone book entry

NetworkDial.Phonenumber

Dial-in number

NetworkDial.Username

Remote network user name

NetworkDial.Password

Remote network password

NetworkDial.Domain

Remote network domain

DirectDial.Phonenumber

Phone number of Domino® server

DirectDial.Prefix

Dialup prefix, if required. For example, 9 to access an outside line.

DirectDial.Port

COM port to which the modem is connected

DirectDial.Modem

File specification of modem file

Proxy.HTTP

HTTP proxy server and port -- for example, proxy.isp.com:8080

Proxy.FTP

FTP proxy server and port -- for example, proxy.isp.com:8080

Proxy.Gopher

Gopher proxy server and port -- for example, proxy.isp.com:8080

Proxy.SSL

SSL proxy server and port -- for example, proxy.isp.com:8080

Proxy.HTTPTunnel

HTTP tunnel proxy server and port -- for example, proxy.isp.com:8080

Proxy.SOCKS

Socks proxy server and port -- for example, proxy.isp.com:8080

Proxy.None

No proxy for these hosts or domains

Proxy.UseHTTP

Use the HTTP proxy server for FTP, Gopher, and SSL security proxies

Proxy.Username

User name if logon is required

Proxy.Password

User password

Replication.Threshold

Transfer outgoing mail if this number of messages held in local mailbox

Replication.Schedule

Enable replication schedule

IM.Server

Instant 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.Port

Instant 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.Protocol

Use 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.ProxyType

Required if IM.Protocol is set to 3. Use one of these:

  • 0 -- SOCKS4 Proxy
  • 1 -- SOCKS5 Proxy
  • 2 -- HTTPS Proxy
  • 3 -- HTTP Proxy

IM.ProxyServer

Required if IM.Protocol is set to 3. Name of Instant Messaging proxy server

IM.ProxyPort

Required if IM.Protocol is set to 3. Port of Instant Messaging proxy server (any positive number)

IM.ServerNameResolve

Only 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.ProxyUsername

Required 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