Appendix A. File Layout

When you unpack and start OpenIDM , you create the following files and directories. Note that the precise paths will depend on the install, project, and working directories that you have selected during startup. For more information, see Specifying the OpenIDM Startup Configuration.

openidm/audit/

OpenIDM audit log directory default location, created at run time, as configured in openidm/conf/audit.json

openidm/audit/access.csv

Default OpenIDM access audit log

openidm/audit/activity.csv

Default OpenIDM activity audit log

openidm/audit/recon.csv

Default OpenIDM reconciliation audit log

openidm/bin/

OpenIDM core libraries and scripts

openidm/bin/create-openidm-logrotate.sh

Script to create an openidmlog log rotation scheduler for inclusion under /etc/logrotate.d/

openidm/bin/create-openidm-rc.sh

Script to create an openidm resource definition file for inclusion under /etc/init.d/

openidm/bin/defaults/script

Default scripts required to run specific services. In general, you should not modify these scripts. Instead, add customized scripts to the openidm/script folder.

openidm/bin/defaults/script/info/login.js

Provides information about the current OpenIDM session.

openidm/bin/defaults/script/info/ping.js

Provides basic information about the health of an OpenIDM system

openidm/bin/defaults/script/policy.js

Defines each policy and specifies how policy validation is performed

openidm/bin/defaults/script/policyFilter.js

Enforces policy validation

openidm/bin/defaults/script/router-authz.js

Provides the functions that enforce access rules

openidm/bin/defaults/script/ui/*

Scripts required by the UI

openidm/bin/defaults/script/workflow/*

Default workflow scripts

openidm/bin/felix.jar, openidm/bin/openidm.jar, openidm/bin/org.apache.felix.gogo.runtime-0.10.0.jar, openidm/bin/org.apache.felix.gogo.shell-0.10.0.jar

Files relating to the Apache Felix OSGi framework

openidm/bin/launcher.bat, openidm/bin/launcher.jar, openidm/bin/launcher.json

Files relating to the startup configuration

openidm/bin/LICENSE.TXT, openidm/bin/NOTICE.TXT

Files relating to the Apache Software License

openidm/bin/MonitorService.bat, openidm/bin/prunmgr.exe, openidm/bin/amd64/prunsrv.exe, openidm/bin/i386/prunsrv.exe, openidm/bin/ia64/prunsrv.exe

Files required by the user interface to monitor and configure installed services

openidm/bin/startup/, openidm/bin/startup/OS X - Run OpenIDM In Background.command, openidm/bin/startup/OS X - Run OpenIDM In Terminal Window.command, openidm/bin/startup/OS X - Stop OpenIDM.command

Clickable commands for Mac OS X

openidm/bin/workflow/

Files related to the Activiti workflow engine

openidm/bundle/

OSGi bundles and modules required by OpenIDM. Upgrade can install new and upgraded bundles here.

openidm/cli.bat, openidm/cli.sh

Management commands for operations such as validating configuration files

openidm/conf/

OpenIDM configuration files, including .properties files and JSON files. You can also access JSON views through the REST interface.

openidm/conf/audit.json

Audit event publisher configuration file

openidm/conf/authentication.json

Authentication configuration file for access to the REST API

openidm/conf/boot/boot.properties

OpenIDM bootstrap properties

openidm/conf/config.properties

Felix and OSGi bundle configuration properties

openidm/conf/endpoint-*.json

Endpoint configuration files required by the UI for the default workflows

openidm/conf/jetty.xml

Jetty configuration controlling access to the REST interface

openidm/conf/logging-config.xml

Experimental log configuration

openidm/conf/logging.properties

OpenIDM log configuration properties

openidm/conf/managed.json

Managed object configuration file

openidm/conf/policy.json

Default policy configuration

openidm/conf/process-access.json

Workflow access configuration

openidm/conf/repo.orientdb.json

OrientDB internal repository configuration file

openidm/conf/router.json

Router service configuration file

openidm/conf/scheduler.json

Scheduler service configuration

openidm/conf/system.properties

System configuration properties used when starting OpenIDM services

openidm/conf/ui-configuration.json

Main configuration file for the browser-based user interface

openidm/conf/ui-countries.json

Configurable list of countries available when registering users in the user interface

openidm/conf/ui-secquestions.json

Configurable list of security questions available when registering users in the user interface

openidm/conf/workflow.json

Configuration of the Activiti workflow engine

openidm/connectors/

OpenICF connector libraries. OSGi enabled connector libraries can also be stored in openidm/bundle/.

openidm/db/

Internal repository files, including both OrientDB files and data definition language scripts for JDBC based repositories such as MySQL

openidm/felix-cache/

Bundle cache directory created when the Felix framework is started

openidm/logs/

OpenIDM service log directory

openidm/logs/openidm0.log.*

OpenIDM service log files as configured in openidm/conf/logging.properties

openidm/samples/

OpenIDM sample configurations

openidm/samples/customendpoint

Sample custom endpoint configuration. For more information, see Adding Custom Endpoints.

openidm/samples/infoservice

Sample that shows how to use the configurable information service. For more information, see Obtaining Information About an OpenIDM Instance.

openidm/samples/misc/

Sample configuration files

openidm/samples/openam/

Sample that shows how to protect OpenIDM with OpenAM

openidm/samples/provisioners/

Sample connector configuration files

openidm/samples/sample1/

XML file connector sample

openidm/samples/sample2/

OpenDJ connector sample with no back link

openidm/samples/sample2b/

OpenDJ connector sample with back link

openidm/samples/sample2c/

OpenDJ connector sample synchronizing users' LDAP group membership

openidm/samples/sample2d/

OpenDJ connector sample synchronizing LDAP groups

openidm/samples/sample3/

Scripted SQL connector sample for MySQL

openidm/samples/sample4/

CSV connector sample

openidm/samples/sample5/

LDAP to OpenIDM to Active Directory attribute flow sample using XML resources rather than actual directories

openidm/samples/sample6/

LiveSync sample for use with one or two LDAP servers

openidm/samples/sample7/

Sample exposing identities with a SCIM-line schema

openidm/samples/sample8/

Sample demonstrating logging in scripts

openidm/samples/sample9/

Sample showing asynchronous reconciliation with workflows

openidm/samples/schedules/

Sample schedule configuration files

openidm/samples/security/

Sample key store, trust store, and certificates

openidm/samples/taskscanner/

Sample sunset scanning task. For more information, see Scanning Data to Trigger Tasks.

openidm/samples/workflow/

Typical use case of a workflow for provisioning

openidm/script/

OpenIDM location for JavaScript files referenced in the configuration

openidm/script/access.js

Default authorization policy script

openidm/security/

OpenIDM security configuration, key store, and trust store

openidm/shutdown.sh

Script to shutdown OpenIDM services based on the process identifier

openidm/startup.bat

Script to start OpenIDM services on Windows

openidm/startup.sh

Script to start OpenIDM services on UNIX

openidm/ui/

OpenIDM graphical UI files

openidm/workflow/

OpenIDM location for BPMN 2.0 workflows and .bar files