Auditing Custom Variables

You can alter some of the auditing functions of Process Director by editing the custom variables listed in this section.

Link

This variable enables Process Director to log various events in the audit logs that are specific to anonymous access to Process Director. In most cases, the Process Director installation won't be accessed by outside users with anonymous access, so this variable is set to "false" by default. Setting this variable to "true" will turn on the audit logging for these events.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // This will turn on audit logging for anonymous access.
    bp.Vars.fAuditAnonAccesses = true;
}

Link

This variable, when set to false, prevents Process Director from auditing form field changes made by API calls.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // Do not audit form field changes made by API calls
    bp.Vars.fAuditFormAPICalls = true;
}

Link

This variable determines whether Process Director will write an audit log for all form views. This can result in a tremendous amount of audit logging when the value is set to "True". The default for this variable is "False".

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // Do not store audit logs when a user views
    // a Process Director Page. Setting this value to true may cause
    // excessive logging and impact system performance.
    bp.Vars.fAuditFormViews = true;
}

Link

This variable, when set to the default value of "true", stores the Audit log file in the file system only, in the /App_Data/log_archive/ folder. When set to false, the audit log is also stored in the Process Director internal database in addition to the file system.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // Allow Process Director to store the audit log in the
    // internal database, in addition to the log file.
    bp.Vars.fAuditLogFileOnly = true;
}

Link

This variable enables you to control the number of days that Process Director should retain its audit logs. Logs will be archived in the /App_Data/log_archive/ folder. This custom variable is available only with users who have the Compliance edition for on-site installations, or a cloud installation. The default value for this variable is "7".

Example

public override void PreSetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // archives logs for ten days
    bp.Vars.nAuditLogDays= 10;
}

Link

This variable enables you to set the maximum number of audit rows to display. The default is 1000.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // This will set the maximum number of audit rows.
    bp.Vars.nMaxAdminAuditRows = 1000;
}

Link

This string variable enables you to provide custom CSS styling for the appearance of audit fields.

Example

public override void PreSetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    //These are the default CSS styles for audit fields.
    bp.Vars.sAuditFieldStyle = "background-color:#FFFF99!important;";
}

Link

This string variable enables you to optionally list field names for fields you wish to skip when auditing by providing a comma-separated list of field names. This will also enable you to skip all fields in an array or section.

Example

public override void PreSetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    bp.Vars.sSkipAuditFields = "fieldname1, fieldName2";
}

Audit Logging Variables

For installations that use the Compliance Edition of Process Director, some audit logging items are sent to the Windows Event Log, in addition to the audit logging that you can access inside Process Director. The logging events sent to the Windows Event Log fall into two categories, Informational and Error entries.

Informational Entries

The following audit events are sent as informational entries to the Windows Event Log:

  • Login
  • SyncStart
  • PasswordChange
  • ReInit
  • DelegateOn
  • DelegateOff
  • ImpersonateOn
  • ImpersonateOff
  • UserDisabled
  • UserEnabled
  • AdminReplaceUser
  • CreateUser
  • DeleteUser
Error Entries

The following audit events are sent as error entries to the Windows Event Log:

  • AuthenticateFailed
  • UserLockedOut

Additional Audit log events can be added to the default events by using the EventLogInfoAudits or EventLogErrorAudits custom variable in the Custom Variables file.

Link

This variable enables you to add an event Enum type to the Windows Event Log as an Informational entry.

Example

public override void PreSetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    Vars.EventLogInfoAudits.Add(AuditType.AuthenticateFailed);
}

Link

This variable enables you to add an event Enum type to the Windows Event Log as an Error entry.

Example

public override void PreSetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    Vars.EventLogErrorAudits.Add(AuditType.UserDisabled);
}