Logging and Retention

📘

Deployment Availability

Some logging settings are restricted depending on deployment architecture.

Logs providing diagnostic and auditing information are kept by SmartIQ, available to authorized administrators. The logs are categorized based on their type, for example, a system error is different to audit records such as a change of password. How long each category of logs is stored is configured in Retention Settings.

📘

Personally Identifiable Information (PII) and Encryption

Documents, files and text data containing PII are all encrypted before storage.

Retention Settings

Retention settings determine the length of time the logs are kept. This setting can be changed in Manage > Settings > Retention.

Each setting has a default as seen in the screenshot below.

For more information on each setting:

• Version History Maximum
• Generation Logs
• Audit Logs
• Event Logs
• Keep Workflow History and Workflow Logs
• Store Location Data

📘

Retention period changes

If retention periods are reduced, the new value will apply immediately to all existing data. At the next scheduled clean-up, all data that lies outside the new retention values will be removed.

Version History Maximum

Sets the maximum number of revisions to Projects and Content Items to retain, allowing a rollback where necessary.

📘

Project major and minor versions

Each save to a project in Design represents a minor version, whereas a major change is defined as when the project is closed and the designer is prompted for version comments (optional).

Generation Log

Records within then generation log track a progress once a user has opened a new form or workflow state. The record tracks:

• General metadata such as user, date started updated, etc.
• Whether the user exited the form unexpectedly, allowing recovery.
• The latitude and longitude of the user (where configured)
• The current user’s (or culmination of users where a workflow is involved) final response to each question within the form at the time the record was

Generation logs can be demanding on storage. Where possible, the default of 365 should be reduced.

Management Console displays information or errors associated with generation logs, such as an error encountered when attempting to run an Action. These logs can be accessed from Manage > Management.

Click View for additional information.

Event Logs

The Event log tracks errors, warnings, and other events useful to system administrators. Records are viewed from Manage > Event Logs by administrators with the "View event log" permission.

The default number of days that SmartIQ keeps Event logs is 90 days.

Keep Workflow History and Workflow Logs

Granular logs pertaining to each state within a workflow are kept by SmartIQ. Each records tracks the user, create date, updated date, state within the workflow, completeness and, most importantly, the actual responses made during the state. These records allow the tracking of changes throughout a workflow. For example, user1 responded with Apple and user2 changed the response to Banana.

Enabling the keep workflow setting will keep the completed records after the workflow has been completed in full.
Workflow data can be large in volume thus, by default, completed workflow records are removed. When configured to be kept an appropriate workflow logs retention should be considered.

Store Location Data

When configured, stores IP/location upon user login.

Audit Logs

🚧

Caution

Enabling audit logs can potentially add large volumes of data to a SmartIQ environment Therefore, auditing should only be enabled as part of an investigation and not left on as a matter of course.

Additionally, audit Log require database access which may not be available in multi-tenant deployment.

Audit Logs record administrative activities and accesses within SmartIQ that are security related and can provide evidence for compliance and auditing admin activity. Logs include activities such as: Login/Logout attempts, updates to users, other system entities etc. Each record contains data such as the user and date of the event it is tracking.

Auditing is enabled or disabled from Manage > Settings > General > Enable Auditing.

Audit logs are not available from the Manage interface and require database access to the AuditLog table. Enabling audit logs add large volumes of data and should only be enabled when necessary with an appropriate retention setting.

The following table indicates what actions are logged into the Audit Log.

*This applies to the client API: any action with user impersonation enabled