SECTION 3 - INTRODUCTION This section explains how to install the Strategic Enterprise Management Application Programming Interface (semapi) software and how to use the ICICONF.EXE program to configure an INFI 90 OPEN interface for use with the semapi software. Refer to OVERVIEW for a list of the procedures required to install the semapi software. OVERVIEW The procedures required to install Windows NT/95 API software are: 1. Install the software key. Refer to Appendix N for details. 2. Invoke the installation program to create the directory structure and extract the semapi files from the distribution media. The semapi installation program, SETUP.EXE: a. Creates the semapi directory structure on the target disk device. b. Copies semapi library and setup files to the appropriate directories. 3. Use the ICICONF.EXE program to define the logical link between the INFI 90 OPEN communication modules as they are referred to in an application program and the actual physical port name for the interface module. It is recommended that the INFI 90 OPEN communication modules be set up and connected to the Windows NT/Windows 95 system prior to installation. SOFTWARE KEY The semapi software package comes with a software key that plugs into the termination device. The software key is required in order to use the semapi software. Refer to Appendix N for installation details. The following procedure installs the semapi software into the following directory hierarchy: \ICI Main ICI directory with several subdirectories. INTRODUCTION WBPEEUI350254A0 3-1
\ICI\LIB \ICI\EXE \ICI\EXE\WIN95 \ICI\EXE\WINNT \ICI\INCLUDE \ICI\SOURCE Library subdirectory containing the object libraries. Executable subdirectory containing the generic linked executable modules: TALK90 Executable subdirectory containing the linked executable modules specific to Windows 95 systems: DEVICE.EXE, ICI- CONF.EXE. Executable subdirectory containing the linked executable modules specific to Windows NT systems: DEVICE.EXE, ICI- CONF.EXE. Header subdirectory containing the header files for the semapi software package. Source subdirectory where user application source code can reside. A sample application program is included in this directory called SAMPLE.C. To install: 1. Insert Disk 1 into the 3.5-inch floppy disk drive. 2. Run SETUP.EXE, to load the software from the floppy disk drive. The setup program automatically updates older versions of the semapi software. 3. The setup program loads into memory and prepares to install the semapi software. The API Setup screen appears and displays the copyright notice (Fig. 3-1). Click the Next button to move on to the next installation step. Use Cancel to exit the installation procedure at anytime. Figure 3-1. semapi Setup Prompt Box 3-2 WBPEEUI350254A0
4. The setup type dialog box is displayed in Fig. 3-2. There are three types of setup procedures: typical, compact, and custom. Typical setup installs all programs, libraries, and other program development files. Compact setup installs only the test program TALK90.EXE, the device driver program DEVICE.EXE, and the logical ICI configuration program ICI- CONF.EXE. Custom setup allows the user to select which options to install. Figure 3-2. Setup Type Dialog Box Figure 3-3 shows the Select Component dialog box that opens if custom setup is selected. Select one or more of the listed items. Select Talk90 Application to install the test program, TALK90.EXE. Select ICICONF Configuration Utility Application to install the logical ICI configuration program, ICICONF.EXE. Select Device Driver Application to install the ICI device driver, DEVICE.EXE. Select Development System Files to install the library and include files. These files are required to develop semapi applications. Select Sample Files to install code for a sample semapi application. To continue with the installation procedure, select a setup type, and press N or click Next. 5.The setup program searches the system registry for any previously installed version of API software. If it finds existing API software, a prompt displays the existing API release number and asks for a response to upgrade, update, or overwrite the existing API release. Click Yes or press Y to begin the installation process. Click No or press N to exit the setup program. If yes is selected, Elsag Bailey applications may not be available for use unless they are re-installed. WBPEEUI350254A0 3-3
Figure 3-3. Select Components Dialog Box If the setup program detects that the existing API software has greater functionality than the API software being installed, a prompt appears. Figure 3-4 shows the prompt that appears when installing a data acquisition (DA) version of API software onto a machine where a supervisory control (SC) version of the API software already exists. Click Yes or press Y to begin the installation process. If the API upgrade release to be installed is incorrect, press N, or click No to exit the setup program. Figure 3-4. Setup Prompt (Overwrite SC with DA) 6. Elsag Bailey applications require a special version of the device driver. If the setup program detects that Elsag Bailey applications are installed which use the existing API software, Figure 3-5 appears to warn that the loaded Elsag Bailey applications may be disabled when the software is installed. Click Yes or press Y to begin the installation process and overwrite the existing semapi software used by the Elsag Bailey applications. If yes is selected and the existing semapi software is overwritten, any previously loaded Elsag Bailey applications may need to be re-installed. To avoid disabling any Elsag Bailey applications during the installation process, press N, or click No. From the prompt 3-4 WBPEEUI350254A0
shown in Figure 3-6, click OK to install the semapi software from the select components dialog box (Fig. 3-3). From the select components dialog box, disable the Device Driver Application option and continue with the installation process. Figure 3-5. Installation Prompt (Overwrite Elsag Bailey Applications) Figure 3-6. Installation Prompt (Select Custom Installation) 7. If there is no previous semapi software registered in the system registry, Figure 3-7 appears and displays a default directory for the semapi installation. Press N or click Next to use the default directory and move to the next prompt. Select Back or press B to return to the prompt shown in Figure 3-2 and Step 4 of the installation procedure. Figure 3-7. Choose Destination Location Prompt (Root Directory) WBPEEUI350254A0 3-5
Click Browse or press r to change the root directory at the prompt shown in Figure 3-8. Enter a directory path under Path: or select a destination directory under Directories: The destination directory entered becomes the root directory for all semapi development and configuration files. Figure 3-8. Choose Directory Dialog Box Select Network from the Choose Directory dialog box to display the dialog box shown in Figure 3-9. From this dialog box, the user can connect the computer to a network drive. This will enable the computer to install the semapi software on a network drive. NOTE: The INICI03 interface requires a software key. This software key is shipped with the semapi software. Each licensed software key is configured to support a limited number of simultaneous users. Additional copies of the semapi software and possibly additional INICI03 interfaces may be required to use this feature. Figure 3-9. Map Network Dialog Box 3-6 WBPEEUI350254A0
The prompt in Figure 3-10 is displayed if the setup program detects that semapi software is installed in the directory selected for executables. To install the semapi software on a system that has semapi software loaded and configured, press N, or click No. Since Elsag Bailey applications require a special version of semapi software, another prompt is displayed (Fig. 3-6). Select Custom from Setup Type prompt and disable Device Driver Application from the Select Components dialog box when installing the semapi software. Figure 3-10. Prompt (Overwrite Elsag Bailey Applications) Click Yes or press Y to begin the installation process and overwrite the existing Elsag Bailey applications. The Elsag Bailey applications may be disabled and require reloading. 8. Select a program folder into which the program icons should be installed. Figure 3-11 shows the Select Program Folder dialog box. The suggested default program folder is Elsag Bailey. Press N or click Next to use the default program folder directory and begin installing the software. To change the name of the program folder, enter the desired name in the Program Folder list box or select an existing folder from the Existing Folders list box and press N or click Next to begin installing the software. The setup program begins installing the software and displays its progress. After all the files are installed, the setup program updates the program registry. Click OK when prompted to exit the setup the program. The installation is complete. Refer to ICI INTERFACE CONFIGURATION for an explanation of how to use the ICICONF program to create a configuration file for the INFI 90 OPEN communication modules. The application program references INFI 90 OPEN modules using a logical ICI number. The configuration file cross references logical interface devices with physical device names. WBPEEUI350254A0 3-7
Figure 3-11. Dialog Box (Select Program Folder) ICI INTERFACE CONFIGURATION This procedure shows how to use the ICICONF program. The ICICONF program must be executed prior to the first time an application attempts to connect to the INICI03 interface. If the default directories were used during software installation, the setup program installed software into the directories listed under. ICICONF.EXE is in the executable subdirectory, and the install program built an icon for this program. Double click on the icon, or click on the application via the File Manger or Windows Explorer to execute the program. The first time ICICONF is executed, it creates a default configuration. The default configuration sets: The node name (Name/Address of Node) to the local computer node name. The physical device (Physical ICI Device) to COM2:. The communication protocol (Network Communication Protocol) to LOCAL. The device driver TCP/IP to 3001. Figure 3-12 shows the semapi Application Logical Definition dialog box. When any part of a configuration is changed, save it by clicking SAVE. Click RESET to return to the previously saved configuration and click QUIT to exit the ICICONF program. ICI INTERFACE CONFIGURATION 3-8 WBPEEUI350254A0
Figure 3-12. Dialog Box (Logical ICI Definition) The following steps explain each of the entries within the semapi Application Logical ICI Definition dialog box. 1. The Application Logical ICI is an assigned logical ICI number that is required by a client application. There are 20 selections available (20 possible ICI configurations) from the pop-down list box shown in Figure 3-13. When a new logical ICI is selected, the ICICONF program displays the settings for that logical ICI. To keep track of multiple ICI configurations, a text string describing each connection can be entered in the Connection Description list box. 2. Figure 3-14 shows the pop-down list box for Physical ICI Device. The system verifies which types of devices can be connected and displays the applicable devices. Select the appropriate ICI device to configure a particular ICI interface. COM1: and COM2: are always displayed. ENET: is displayed when the computer has TCP/IP software installed (for use with an INOSM01 interface). In the case of a SCSI INICI03 interface connection, the list box displays which INICI03 interfaces are currently connected to the computer and functioning properly. S003: is shown in the example (Fig. 3-14), meaning a SCSI INICI03 interface is connected to the computer on the first SCSI card on its first SCSI bus at address 3. 3. Set the Network Communication Protocol from the appropriate pop-down list box. This box lists the network communication protocol being used by client applications using this ICI INTERFACE CONFIGURATION WBPEEUI350254A0 3-9
Figure 3-13. List Box (Application Logical ICI) Figure 3-14. List Box (Physical Device Type) logical ICI and the device driver for the device listed in Physical ICI Device. Other unique logical ICIs using different network communication protocols can be defined to talk to the same physical ICI device. NOTE: When assigning a network communication protocol for one logical ICI, all other logical ICIs using the same physical ICI device will adopt the same network communication protocol. Enter the name or IP address of the computer node executing the device driver in the Name/Address of Node list box. ICI INTERFACE CONFIGURATION 3-10 WBPEEUI350254A0
If TCP/IP network protocol is the communication protocol between the client application and server tasks, then a service port number must be assigned for all physical ICI devices being used, whether serial or SCSI. The selection and assignment of a port number to each physical ICI device is arbitrary, but each port number must be unique and not already in use by other TCP/IP services. Port numbers must be greater than or equal to 1024 and less than or equal to 65535. Additionally, each logical ICI must have a unique port number. Enter the port number in the Device Driver TCPIP Communication Port list box. 4. The RS232 Serial Communication Parameters list box is enabled whenever physical ICI device COM1: or COM2: is selected. Figure 3-15 shows the Baud Rate pop-down list box. Enter the appropriate parameters for Baud Rate, Parity, Data Bits, and Stop Bits based on the dipswitch selections set on the INICIT03A module. Figure 3-15. List Box (Baud Rate) 5. When ENET: is the selected physical ICI device, all parameter list boxes are disabled except the Name/Address node list box. Enter the name or IP address for the INOSM01 interface handling the logical ICI. 6. When a SCSI INICI03 interface is the selected physical ICI device, the RS232 Serial Communication Parameters list boxes are disabled. Enter the appropriate parameters in the Name/ Address of Node, Network Communications Protocol, and TCP/ IP Port list boxes. When working with a previously configured SCSI INICI03 interface that was red-lighted or not connected to the computer on reboot, a warning prompt is displayed (Fig. 3-16). If the user ICI INTERFACE CONFIGURATION WBPEEUI350254A0 3-11
changes and configures the same SCSI physical ICI device, the pop-down list box does not display the physical ICI device nor can it be selected until the computer is rebooted with a functioning SCSI INICI03 interface. Figure 3-16. Warning Prompt COMPUTER INTERFACE SETUP Refer to Appendix N for computer interface module installation and setup information, and software key installation. COMPUTER INTERFACE SETUP 3-12 WBPEEUI350254A0