8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi<?xml version="1.0" encoding="UTF-8"?>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi<appendix xml:id='appendix-file-layout'

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi version='5.0' xml:lang='en'

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi xmlns='http://docbook.org/ns/docbook'

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi xmlns:xlink='http://www.w3.org/1999/xlink'

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi xmlns:xinclude='http://www.w3.org/2001/XInclude'>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <title>File Layout</title>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <variablelist>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>When you unpack and start OpenIDM <?eval ${docTargetVersion}?>, you

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi create the following files and directories.</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/audit/</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>OpenIDM audit log directory default location, created at run

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi time as configured in <filename>openidm/conf/audit.json</filename></para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

a23343e9e4e0b555b1bcfa99a7455e0e28117a3dJean-Noel Rouvignac </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/audit/access.csv</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>Default OpenIDM access audit log</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/audit/activity.csv</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>Default OpenIDM activity audit log</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/audit/recon.csv</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>Default OpenIDM reconciliation audit log</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/bin/</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>OpenIDM core libraries</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/bundle/</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>OSGi bundles and modules required by OpenIDM. Upgrade can install

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi new and upgraded bundles here.</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/bundle/json-crypto-cli-1.1.0.jar</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>Utility to encrypt and decrypt values in JSON objects</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/cli.sh</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>Script for exporting objects, exporting secret keys, and validating

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi configuration files</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/conf/</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>OpenIDM configuration files, including .properties files and JSON

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi views. You can also access JSON views through the REST interface.</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/conf/audit.json</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>Audit event publisher configuration view</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/conf/authentication.json</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>Authentication configuration view for access to the REST API</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/conf/boot/boot.properties</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>OpenIDM bootstrap properties</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/conf/config.properties</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>Felix and OSGi bundle configuration properties</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/conf/jetty.xml</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>Jetty configuration controlling access to the REST interface</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <varlistentry>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <term><filename>openidm/conf/logging-config.xml</filename></term>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi <para>Experimental log configuration</para>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </listitem>

8b806159078ce1308b27e676c0e8a6340f05e6e0Fabio Pistolesi </varlistentry>

<varlistentry>

<term><filename>openidm/conf/logging.properties</filename></term>

<listitem>

<para>OpenIDM log configuration properties</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/conf/managed.json</filename></term>

<listitem>

<para>Managed object configuration view</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/conf/provisioner.openicf-xml.json</filename></term>

<listitem>

<para>Sample XML connector configuration view. After evaluation,

replace this with your own connector configurations.</para>

<para>Each connector instance has a corresponding

<filename>provisioner.openicf</filename> configuration file. Each file

specifies connector configuration details such as network information,

credentials, attribute schema, and which OpenICF features are

supported.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/conf/repo.orientdb.json</filename></term>

<listitem>

<para>OrientDB internal repository configuration view</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/conf/router.json</filename></term>

<listitem>

<para>Router service configuration view</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/conf/scheduler-reconcile_systemXmlAccounts_managedUser.json</filename></term>

<listitem>

<para>Sample XML scheduler configuration view. After evaluation,

replace this with your own configurations.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/conf/sync.json</filename></term>

<listitem>

<para>Sample XML synchronization configuration view. After evaluation,

replace this with your configuration to describe all mappings used by

OpenIDM for synchronization and reconciliation.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/conf/system.properties</filename></term>

<listitem>

<para>System configuration properties used when starting OpenIDM

services</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/connectors/</filename></term>

<listitem>

<para>OpenICF connector libraries. OSGi enabled connector libraries can

also be stored in <filename>openidm/bundle/</filename>.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/db/</filename></term>

<listitem>

<para>Internal repository files, including both OrientDB files and data

definition language scripts for JDBC based repositories such as MySQL</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/logs/</filename></term>

<listitem>

<para>OpenIDM service log directory</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/logs/openidm0.log.*</filename></term>

<listitem>

<para>OpenIDM service log files as configured in

<filename>openidm/conf/logging.properties</filename></para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/samples/</filename></term>

<listitem>

<para>OpenIDM sample configurations</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/misc/</filename></term>

<listitem>

<para>Sample configuration files</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/provisioners/</filename></term>

<listitem>

<para>Sample connector configuration files</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/sample1/</filename></term>

<listitem>

<para>XML file connector sample installed with OpenIDM</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/sample2/</filename></term>

<listitem>

<para>OpenDJ connector sample with no back link</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/sample2b/</filename></term>

<listitem>

<para>OpenDJ connector sample with back link</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/sample3/</filename></term>

<listitem>

<para>ScriptSQL connector sample for MySQL</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/sample4/</filename></term>

<listitem>

<para>CSV connector sample</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/sample5/</filename></term>

<listitem>

<para>LDAP to OpenIDM to Active Directory attribute flow sample with XML

resources</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/sample6/</filename></term>

<listitem>

<para>LiveSync sample for OpenDJ</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/schedulers/</filename></term>

<listitem>

<para>Sample scheduler configuration files</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/sample/security/</filename></term>

<listitem>

<para>Sample key store, trust store, and certificates</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/script/</filename></term>

<listitem>

<para>OpenIDM location for JavaScript files referenced in the

configuration</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/script/router-authz.js</filename></term>

<listitem>

<para>Default authorization policy script</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/security/</filename></term>

<listitem>

<para>OpenIDM security configuration, key store, and trust store</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/shutdown.sh</filename></term>

<listitem>

<para>Script to shutdown OpenIDM services based on the process

identifier</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/startup.bat</filename></term>

<listitem>

<para>Script to start OpenIDM services on Windows</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/startup.sh</filename></term>

<listitem>

<para>Script to start OpenIDM services</para>

</listitem>

</varlistentry>

<varlistentry>

<term><filename>openidm/workflow/</filename></term>

<listitem>

<para>OpenIDM location for BPMN 2.0 workflows and .bar files</para>

</listitem>

</varlistentry>

</variablelist>

</appendix>