File and Directory Infrastructure

Manage cluster configuration, project deployment, security and options like failover, affinities, and high availability using configuration files and directories.

These are the files and directories you use most often in managing SAP Sybase Event Stream Processor.

Note: In a multinode cluster whose nodes are installed on different hosts, some files and directories must be stored on a shared drive accessible to all nodes. Shared drive requirements are listed in the table under Needs shared drive?

Event Stream Processor Files and Directories
Name	Description
<base-directory>	Base directory to which managers in this cluster deploy projects. Holds workspaces, project instances, project working directories, and log stores. By default, the base directory in a local (Studio) cluster is the same as the workspace. See also workspace and project working directory. Needs shared drive? – Yes Default location – Remote cluster: ESP_SHARED/cluster/projects/<cluster-name> The <base-directory> is defined in the controller section of the cluster node configuration file, ESP_HOME/cluster/nodes/<node-name>/<node-name>.xml. Local (Studio) cluster: <user's-home-dir>/SybaseESP/5.1/workspace You set the location of the workspace directory during installation. In Windows, <user's-home-dir> defaults to the My Documents folder. If no home directory is configured in UNIX, the base directory location defaults to /SybaseESP/5.1/workspace. The <base-directory> for Studio is defined in Studio’s cluster configuration file, <ESP_HOME>/studio/clustercfg/localnode.xml.
cluster.key	The cluster key file, which is used to encrypt SSL files and passwords in <node-name>.xml. Needs shared drive? – For security purposes, SAP does not recommend storing cluster.key on a shared drive. SAP recommends permissions settings that allow only the user who launches the node to access this file. Default location – ESP_HOME/cluster/keys/<cluster-name>
cluster.log	Cluster node log. Captures node-level and cluster-level errors and event messages; each node’s log is unique to that node. Resides in the node working directory, the same directory as <node-name>.xml and cluster.log.properties. Needs shared drive? – Must not be shared Default location – ESP_HOME/cluster/nodes/<node-name>/cluster.log
cluster.log.properties	Cluster node log configuration file. cluster.log.properties is a log4j properties file; it resides in the directory where the the node is started (the node working directory). Needs shared drive? – No Default location – ESP_HOME/cluster/nodes/<node-name>/cluster.log.properties
csi_boe.xml csi_kerberos.xml csi_ldap.xml csi_native_nt.xml csi_native_unix.xml csi_role_mapping.xml csi_rsa.xml	Security configuration files. See also security directory and examples directory. Needs shared drive? – Optional; typically shared in a multinode cluster where the security directory is shared Default location – ESP_SHARED/security
ESP_HOME	Represents the Event Stream Processor installation directory. ESP_HOME is also an environment variable and a configuration file macro. See the Configuring a Cluster topic for information on defining macros. Needs shared drive? – Must not be shared Default location – Windows: C:\Sybase\ESP-5_1 UNIX: /opt/sybase/ESP-5_1
esp_metadata	Metadata directory that holds the metadata log store for the project if you are using the guaranteed delivery feature. Needs shared drive? – Yes Default location – <base-directory>/<workspace-name>.<project-name>.<instance-number>/esp_metadata
ESP_SHARED	A configuration file macro for resources that need to be on a shared drive. After moving these resources, set the macro path to the shared location. See the Configuring a Cluster topic for information on defining macros. Needs shared drive? – Yes Default location – ESP_HOME
esp_server.log	Project log. Captures errors and events in a running project. Resides in the working directory for the project. Needs shared drive? – Optional; typically shared in a multinode cluster where the base directory is shared Location – <base-directory>/<workspace-name>.<project-name>.<instance-number>/esp_server.log
examples	Examples directory. Stores sample configuration files including <node-name>.xml, policy.xml, persistence.xml, log properties files, and authentication files. Needs shared drive? – No Location – ESP_HOME/cluster/examples
Input files for projects	Anything a project needs at runtime—for example, input CSV files, ODBC drivers, or queueing clients. Needs shared drive? – Optional. If you set controller affinities to limit which nodes the project can run on, you can store input files on the specified nodes only. But if the project needs to be able to fail over to a controller on another machine, put the input files in a shared location. Recommended location – Working directory for the project: <base-directory>/<workspace-name>.<project-name>.<instance-number>
Log store	Log store. Saves project input and output data in case of failover. Needs shared drive? – Yes Default location – <base-directory>/<workspace-name>.<project-name>.<instance-number>/<logstore-name>
<node-name>.xml	Cluster node configuration file. Created automatically for clusters configured at installation, manually for clusters created after installation. Defines a node as a manager, a controller, or both, and configures security, port communication, and caching. Needs shared drive? – No Default location – ESP_HOME/cluster/nodes/<node-name>/<node-name>.xml
Node working directory	Directory from which the node is started. cluster.log.properties must reside in this directory; cluster.log and <node-name>.xml reside here by default. Not to be confused with workspace or project working directory. Needs shared drive? – No Default location – ESP_HOME/cluster/nodes/<node-name>
<persistence-directory>	Persistence directory. Saves project and workspace information when a node shuts down. The cluster configuration file, <node-name>.xml, sets the persistence directory’s path. All managers in a cluster must use the same persistence directory. Needs shared drive? – Yes Default location – ESP_SHARED/storage
policy.xml	Policy file. Defines access control policies that specify user roles, the actions available to each role, and the resources on which the actions can be performed. Needs shared drive? – Yes (SAP recommends a shared drive for the security directory) Default location – ESP_SHARED/security/policy.xml
<project-name>.ccl	Definition of a project in Continuous Computation Language. A project has one <project-name>.ccl file. When you edit the project in Studio, you modify the CCL or an ancillary file. (The ancillary files store information about the visual presentation of the project in Studio.) Needs shared drive? – N/A Default location – Local (Studio) cluster: <user's-home-dir>/SybaseESP/5.1/workspace/<project-name>/<project-name>.ccl
<project-name>.ccr	Project configuration or CCR file. An XML file that contains runtime and deployment configuration for the project, including adapter, parameter, and binding definitions, A project can have multiple CCR files, allowing you, for example, to specify different adapters in different deployment environments, or to change run-time parameter values. Needs shared drive? – N/A Default location – Local (Studio) cluster: <user's-home-dir>/SybaseESP/5.1/workspace/<project-name>/<project-name>.ccr
<project-name>.ccx	The compiled CCL file. You must supply the path to the CCX file when you deploy a project to a remote (non-Studio) cluster. You do not need to view or edit the CCX file. Needs shared drive? – N/A Default location – Local (Studio) cluster: <user's-home-dir>/SybaseESP/5.1/workspace/<project-name>/bin/<project-name>.ccx
Project working directory	Contains files generated by the project. May also contain input files the project needs. Not to be confused with node working directory or workspace. Needs shared drive? – Optional; typically shared in a multinode cluster where the base directory is shared. Note: Put the project working directory on a shared drive if you are using guaranteed delivery, unless you elected to locate the metadata log store elsewhere. Metadata log stores for guaranteed delivery are stored by default in esp_metadata in the project working directory. Metadata log stores require a shared drive. Default location – <base-directory>/<workspace-name>.<project-name>.<instance-number>
security	Security directory. Stores Java keystores for RSA, policy files for access control, and the csi_cluster.xml file for specifying security authentication on the local cluster server. All components in a cluster are subject to the security rules defined in the cluster configuration file. To easily maintain consistent security configurations among all nodes, SAP recommends that multiple cluster managers running in the same cluster share a security folder. Needs shared drive? – Yes Default location – ESP_SHARED/security
service.xml	Service configuration file. Contains database service definitions, including all the properties and parameters required for the database connections needed by the projects that run on this node or in this cluster. Every node needs access to a service configuration file. Needs shared drive? – No Default location – ESP_HOME/bin/service.xml
server.key server.crt	Unencrypted SSL files. The ESP installer lays down only the encrypted (.enc) versions of the SSL files; you need to provide unencrypted versions only if you disable SSL encryption. Needs shared drive? – For security purposes, SAP does not recommend storing unencrypted SSL files on a shared drive. Default location – ESP_HOME/cluster/keys/<cluster-name>
server.key.enc server.crt.enc	Encrypted SSL files. ESP requires a set of encrypted SSL files (by default) or a set of unencrypted SSL files, but not both. Needs shared drive? – No Default location – ESP_HOME/cluster/keys/<cluster-name>
stdstreams.log	Standard streams log. Captures output written to stdout and stderr, including SySAM licensing information and messages from third party applications. Resides in the working directory for the project. Needs shared drive? – Optional; typically shared in a multinode cluster where the base directory is shared Location – <base-directory>/<workspace-name>.<project-name>.<instance-number>/stdstreams.log
workspace	Directory where ESP Studio stores project files. You set the location during installation. By default, the workspace in a local (Studio) cluster is the same as the base directory. See also <base-directory>, node working directory, and project working directory. Needs shared drive? – No Default location – Local (Studio) cluster: <user's-home-dir>/SybaseESP/5.1/workspace In Windows, <user's-home-dir> defaults to the My Documents folder. If no home directory is configured in UNIX, the base directory location defaults to /SybaseESP/5.1/workspace.