The logging configuration file

eSign uses log4j to manage logging configurations, to customize the information logged by eSign one must alter the file log4j2.xml present in esign-home/configs.

In this file everything can be customized per the admin’s needs (within log4j possibilities).

For more details please visit log4j’s documentation.

Default xml

<!DOCTYPE project>
<configuration status="info">
	<Properties>
		<Property name="log-path">${sys:ESIGN_HOME}/logs</Property>
	</Properties>
	<appenders>
		<Console name="Console" target="SYSTEM_OUT">
			<PatternLayout pattern="%-5level [%t] %d{yyyy-MM-dd HH:mm:ss.SSS} %mdc{nb_esign_user} %mdc{nb_esign_artifact} %mdc{nb_esign_participant} %c - %m%n" />
		</Console>
		<RollingFile name="RollingFile" fileName="${log-path}/esign.log" filePattern="${log-path}/esign-%i.log" >
			<PatternLayout>
				<pattern>%-5level [%t] %d{yyyy-MM-dd HH:mm:ss.SSS} %mdc{nb_esign_user} %mdc{nb_esign_artifact} %mdc{nb_esign_participant} %c - %m%n</pattern>
			</PatternLayout>
			<Policies>
				<SizeBasedTriggeringPolicy size="20 MB" />
			</Policies>
			<DefaultRolloverStrategy max="10"/>
		</RollingFile>
	</appenders>
	<loggers>
		<logger name="novabase" level="debug">
			<appender-ref ref="Console" />
			<appender-ref ref="RollingFile"/>
		</logger>
		<root>
			<appender-ref ref="Console" level="error"/>
			<appender-ref ref="RollingFile" level="error"/>
		</root>
	</loggers>
</configuration>

Specific eSign values

Table 1. As per the xml exampled above there are some tags that refer to eSign specific values, these values can be freely used as long as log4j rules are followed:

nb_esign_user

the user performing the request

nb_esign_artifact

the affected document’s ID

nb_esign_participant

the participant associated to the session