Product Training Program EIPLATFORM Deploying to the eiPlatform

Deploying to the eiPlatform This section will cover deploying the developed Interface to an eiPlatform. Sections: 1. Working Directory Structure 2. Configuring the “eipServer.conf” 3. Configuring logging levels 4. Deploying the “My First Interface” Interface 5. Deploying the eiPlatform WAR file

Working Directory Structure A “Working Directory” is the filesystem representation of an Interface and its sub-Interfaces. / The root directory; “eip-root” by convention /data An optional directory for storing samples, documentation, etc /formats Format definitions, with one sub-folder per Format (“Format A”) /lib eiPlatform modules, in “classes” or in JAR files /routes Route definitions, with one sub-folder per Route (“Route A”) /interfaces Sub / Child Interfaces (structure is recursive) /environment-settings.conf A Java Properties file containing “environment variable” definitions

Configuring “eipServer.conf” The eipServer.conf file stores the eiPlatform configuration settings, including transactional metadata logging options, threading, logging configuration, and the target Working Directory. The user should first copy the provided “eipServer.conf” file to the desired location, such as “C:\PilotFish\conf\” The file can be edited using any normal text editor. Three values should be set: com.pilotfish.eip.logConfigFile - The location of “logConfig.xml” com.pilotfish.eip.configDirectory - The location of the working directory (typically “eip-root”) com.pilotfish.eip.database.plugin - The logging database type (“pilotfish:Null”)

Configuring “logConfig.xml The eiPlatform uses the Log4J library to facilitate its logging. The Log4J instance used is configured in the “logConfig.xml” file. Log4J is defined through Appenders and Categories. An Appender is an implemention of the Log4J “Appender” interface. The provided default is a “DailyRollingFileAppender,” which is a file-based Appender that “rolls over” at midnight. Categories define specific loggers (such as admin, modules, etc), their logging level (as “priority”), and which Appenders they're associated with. Users will only need to modify the “file” parameter of the provided Appender to set the desired log file, such as “C:/PilotFish/logs/eip.log”

Deploying an Interface The eiPlatform references a single working directory, which will contain the Interface, Route, and Format definitions, as well as any sub-Interfaces and their various components. To deploy to this working directory, the user need only copy their working directory structure (from the eiConsole, from a source repository, etc) into it. To deploy the “My First Interface” Interface, create the following structure in the specified working directory: Then create a directory under “interfaces” named “My First Interface” with that Interface's file contents underneath it /data /formats /lib /routes /interfaces

Deploying “eip.war” For application containers, the eiPlatform is provided as a WAR file. To deploy the eiPlatform server, the user will need to copy this WAR file to that container's deployment directory, which is typically “webapps.” Some application containers offer or require a GUI to perform the deployment. Once copied, the user may either manually extract the “eip.war” file to an “eip” directory or allow the application container to do it (Tomcat will do this automatically once started). The user will then need to configure eip/WEB-INF/web.xml: “com.pilotfish.eip.servlet.displayLog” should be set to the “eip.log” file location “com.pilotfish.eip.servlet.eipConfigFile” should be set to the “eipServer.conf” file location Finally, start the application container.