Logging: The modification log database

Modification Logging allows any changes made with Ytria tools to be recorded in a Modification Log database.
Log entries can be recorded either in any database previously created within the Modification Log Database dialog or any copy or replica of the Modification Log database.

Be aware of the following:

  • If the database is locally encrypted, other users won't be able to open and view the logs.

  • All persons using Ytria tools must have at least Author access to the database in order to write logs.

  • By default, for optimal performance, you should use a local database. You can also share the database from a server, but you won't have the best performance result.


Setting up the Modification Log Database

To enable logging in any of the Ytria tools: go to Options > Modification Log Database.

global-features-Modification-log-db

The Modification Log Database dialogue lets you set the path to the database to use for logging.

You can:

  • Open the logging database that is currently set in the dialogue.

  • Select another logging database of your own choosing.

  • Create a new database for storing logs.

  • Clear a currently selected Modification Log database (thus disabling logging unless another log database is selected).

NOTE

Alternately you can enable logging by entering the following Notes.ini entry:

YtriaLogDatabase

The value of this entry must be the file path to the database, e.g:

CN=ServerName/O=MyDomainName!!MyDirectory\MyYtriaModificationLog.nsf


Additional settings

  • Modification Log Comment: You can document your changes by adding comments before applying your modifications. To do so go to Options > Modification Log Comment.

    global-features-Modificationlogdb-2

    NOTE

    The comment entered will be displayed the next time the Modification Log Comment's window will be opened.
    You can use the Clear button to remove the comment.


    Comments are then displayed in all product log reports.

    modification-log-DB-log-Report

  • Mandatory Logging: Logging can be enforced if desired. This can be set via the Restriction Settings (In this case the Modification Log's path cannot be changed).


The Modification Log Database

If you generate a Modification Log Database by clicking the Create button in the Modification Log Database window, your log database will use the design pictured below (The design of this database is not hidden so please feel free to customize it to fit your organization's needs).

NOTE

You can download the Modification Log Database and his template directly from our website.

The files are not up to date

v12-global-features-Logging-ModifLogDb-4-1


  • Open Database will open the associated database in IBM Notes.

  • Open in scanEZ will open the database in scanEZ and add the selected items in a new My Selection virtual folder.


Columns on Note view:

Who

User ID.

When

Date of the action.

Comment

Comment entered in the Modification Log Comment.

Server

Database Server.

File Path

Path of the database file.

DB Title

Notes Database name.

ReplicaID

Database replica ID.

NoteID

Particular note in a database.

Note Type

Display the value of the NoteType.

Note Title

Display the value of the NoteTitle.

UNID

Universal Note ID.

Nb

Number of the Item.

Items

Name of the Item.

Actions

Action on the Item.

Previous Updater

Name of the previous updater.

Previous Signer

Name of the previous signer.

Designer Comment

Comment set in Domino Designer.

Designer Version

Version of the Domino Designer.

EZ Tool

Ytria EZ tool (with version number) using the Log Database.


Columns on ACL view:

Who

User ID.

When

Date of the action.

Comment

Comment entered in the Modification Log Comment.

Server

Database Server.

File Path

Path of the database file.

DB Title

Notes Database name.

ReplicaID

Database replica ID.

ACL Entry

Name of the ACL entry.

Action

Action on the ACL entry.

EZ Tool

Ytria EZ tool (with version number) using the Log Database.


Columns on Other Actions:

Who

User ID.

When

Date of the action.

Comment

Comment entered in the Modification Log Comment.

Category

Action class.

Server

Database Server.

Actions

Action initiated.

Description

Action details.

EZ Tool

Ytria EZ tool (with version number) using the Log Database.

TIP

To analyze logged changes, you can either create a view in your log database, or simply look at the documents in scanEZ as pictured below:

v12-global-features-Logging-ModifLogDb-5-1

Item

Type

Description

$UpdatedBy

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

Actions

Text list

Explains the type of action performed with Ytria software (eg updated; added; or deleted).

Comment

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

DatabaseTitle

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

Description

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

EZTool

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

FilePath

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

Form

Text

The value 'Log' will be entered here.

IconBitmap

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

Items

Text List

Items affected.

ItemsActions

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

NoteDesignComment

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

NoteDesignerVersion

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

NoteID

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

NoteTitle

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

NoteType

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

Original ModTime

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

PrevSigner

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

PrevUpdater

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

ReplicaID

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

SaveOptions

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

What1

Number

NoteID of note affected.

What2

Note reference list

UNID of note affected.

WhatOther

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

When

Date

The date the changes were made.

Where1

Text

The path (Server!!FilePath) of the database where the changes were made.

Where2

Text

The Replica ID of the database where the changes were made.

Where

https://www2.ytria.com/icons/ecblank.gif
https://www2.ytria.com/icons/ecblank.gif

Who

Names

The user name used to make the changes.