Logs

For Cloud installations, or On-Premise installations that use the Compliance Option, Process Director provides a number of logging functions, all of which are available through the Logs page of the IT Admin area's Troubleshooting section. Once you've navigated to the Troubleshooting section, you can open the Logs page by clicking the Logs button located in the upper right portion of the screen.

The most recent log files are available for view in this page's log reader. All of the log files are also available from within your Process Director installation in the %InstallationDirectory%\website\App_Data\logs folder.

Note The log files are saved in a comma-separated text format. If you change the file extension of the logs from ".log" or ".bkX" to ".csv", they can generally be opened in Excel for easier reading than opening the text log file in Notepad.

Available Logs

Process Director makes the following logs available:

LOG FILE	DESCRIPTION
Script Logs	Records information from scripts when using the bp.logs methods.
Internal logs	Records internal system status information.
Init Logs	Records when various components of functions are initiated.
Audit Logs	Records changes made to data or processes.
Email Logs	Records data about email messages sent from Process Director. (For users of the Compliance edition only.)

You can switch between each of these logs by using the dropdown control located above the Log Viewer, at the far left of the screen. To the immediate right of the log type dropdown is a log file dropdown that gives you access to the current log ("Main") and the four most recent backups. Process Director sets a default log file size of 2MB, so that, when the main log reaches 2MB, it is saved as backup 1, and a new empty Main log is started. Process Director saves the old backup 1 log as backup 2, and so on as the changes ripple down through the log backup numbers.

To the right of the log file dropdown, you'll see check boxes that you can use to select if you wish to see logged errors only, and which logging level you'd like to see. Logging is documented at six different levels, Level 0 through Level 5. Level 0 is the default level for logging. Each logging level creates logs at an increasingly detailed scale, with Level 5 being the most detailed level, and level 0 being the least detailed. Nearly all debugging you'll need to do on a regular basis can be done using Level 0 or Level 1 logging. On occasion, system problems may require more detailed logging, but you should be aware that higher levels of logging detail can impact system performance. Using higher levels of logging is usually done in conjunction with assistance from BP Logix, and isn't usually necessary otherwise.

Additionally, for users of the Compliance Edition, Cloud, or Subscription licenses, some audit logging is also sent to the Windows Event Log. From the Windows Event Log Viewer, you can configure automated actions, such as email notifications, to occur when certain events are logged. For information on this functionality, and how to edit the events sent to the Windows Event log, please see the Audit Logging Variables section of the Developer's Guide.

For Process Director v6.00 and higher, the date/time formats displayed for log events have been reformatted to use common date/time formats for greater readability.

Log Events #

Some standard events will show up in the log files, based on actions taken by either Process Director users, or by Process Director as processes move through their life cycle. The table below enumerates and describes these standard log events.

LOG EVENT	APPEARS IN A LOG WHEN
AddAppEvent	A new application event was added to a Form or Process Timeline definition.
AddGroupToPartition	A user group was added to a partition to enable access to that partition by members of the group.
AddUserToGgroup	A user is added into a group.
AddUserToPartition	A user was added to a partition to enable access to that partition.
AdminPageAccess	A user directly accesses an admin page from the installation server.
AdminPageUpdate	A change was made to an IT Admin page's data.
AdminReplaceUser	An administrator uses the "replace user" function.
AnonymousAccess	An anonymous user accessed the system.
AttachmentAdded	Any time an attachment is added to a Form instance (v5.34 and higher).
AttachmentRemoved	Any time an attachment is removed from a Form instance (v5.34 and higher).
AuthenticateFailed	A user types the wrong password when attempting to log in, or to access to admin page without privileges
CancelActivity	A Timeline Activity is canceled.
CancelDocumentCheckout	A user canceled an attempt to check out a document or document attachment.
CancelStep	A Workflow Step is canceled, e.g. an administrator right clicking on a step and clicking "Cancel".
CaseDataChange	The data stored in a Case instance was changed.
CaseModeEntered	A user opened a case instance in case context.
CheckoutDocument	A document or document attachment was checked out, usually for editing.
CreateGroup	A group is created (Group Admin).
CreateObject	A Content List object of is created or an object is created from an object instance.
CreateUser	A user is created (User Admin).
DelegateOff	A user ends delegation.
DelegateOn	A user sets delegation to other users.
DeleteAppEvent	An application event was deleted by a user.
DeleteGroup	A group is deleted (Group Admin).
DeleteObject	A Content List object of is deleted or an object is deleted from an object instance.
DeleteUser	A user is deleted (User Admin).
DownloadDocument	A user downloads documents from application.
ExportObjects	When an XML file is exported.
FormDataChange	When a Form is filled out by a user. This is used when form field auditing is active on a form instance. The log entry shows the changes to all the form fields, including the old values, the new values, and who changed the Form.
ImpersonateOff	When impersonate is off.
ImpersonateOn	When impersonate is on (Someone uses impersonate function).
ImportObjects	When an XML file is imported.
JumpToStep	A task is moved to non-connected task with a Jump to Step Custom Task.
Login	A user logs in
Logoff	A user logs off
MoveObject	A Content List object or an object from an object instance is moved.
NotSet	Not categorized into the following
ObjectLock	A Content List object was automatically locked for editing.
ObjectUnlock	A Content List object was automatically unlocked from editing.
ObjectUnlockOther	A Content List object was manually unlocked
PasswordChange	A user changes the password.
PermissionAdded	A permission is added to a user (User Admin).
PermissionDeniedAdmin	A user attempts to view admin pages to which the user doesn't have permissions.
PermissionDeniedDelete	A user attempts to delete object to which the user doesn't have permissions.
PermissionDeniedExecute	A user attempts to run an object to which the user doesn't have permission.
PermissionDeniedModify	A user attempts to modify an object to which the user doesn't have permission.
PermissionDeniedView	A user attempts to view object to which the user doesn't have permission.
PermissionGiven	An application elevates a user's permissions.
PermissionRemoved	A permission is removed from a user (User Admin).
PermissionReplicated	This occurs when the user clicks on the "Replicate Permissions to Child Objects" button.
PermissionUpdated	A user edits and updates an existing permission record.
ReInit	The Process Director installation was reinitialized, usually from a suspended state after period of inactivity.
RemoveGroupFromPartition	A user group was removed from a partition.
RemoveObjectFromParent	Any content object is removed from a parent, e.g. removing an attachment from a process.
RemoveUserFromGroup	A user is removed from a group.
RemoveUserFromPartition	A user was removed from a partition.
RestartActivity	A Timeline Activity is restarted.
RestartTimeline	A Process Timeline instance is restarted.
RestartWorkflow	A Workflow instance is restarted.
RollbackActivity	A Timeline Activity is rolled back.
RollbackDocument	An edited document or document attachment was rolled back to an earlier version of the document.
Signature	A user enters data into an eSign signature control on a Form.
StopStep	A Workflow Step is stopped without completing it.
StopWorkflow	A Workflow instance is stopped.
SyncEnd	Sync is finished.
SyncStart	Sync is run/started.
TaskCompleted	A process task is completed by a user.
TaskReassigned	A user is reassigned to a process task.
TaskRemoved	A running task is removed from a running process.
UpdateAppEvent	An application event was changed by a user.
UpdateDocumentProps	A user updated the properties of a document or document attachment.
UpdateObject	A Content List or object instance object is updated.
UpdateUser	A user profile is updated (User Admin).
UserDisabled	A user is disabled (User Admin/ Setting).
UserEnabled	A disabled user is enabled.
UserLockedOut	A user was locked out of the system, usually as the result of authentication failures.
ViewCaseData	A user viewed the data for a Case instance.
ViewForm	Any time a user opens a form instance. The flag fAuditFormViews must be enabled, i.e., set to "True" in the vars file, for this to appear. This may add strongly to the servers load when in use.
ViewFormData	When someone accesses form data other than through the normal viewing of a form instance (e.g. through SDK calls).
WebService	A web service is run (Process Director access to Web Service).

Searching the Logs #

At the top of the Log Viewer, to the right of the logging levels check boxes, you'll see a text box labeled Containing String. If you enter text into this text box, then hit the [ENTER] key, Process Director will search the current log for log entries that match the text you have typed into the text box.

Emailing Logs #

On occasion, you may run into issues that you requires assistance from BP Logix to debug. In those cases, a technical support representative may ask you to attach your log files to your technical support ticket. In this case, there is a button located below the log reader that is labeled Email Logs. Below this button, you'll see text boxes into which you can enter email addresses to which to send the logs from your Process Director installation. In addition, there is a text box for you to enter other information you'd like to appear in the text of your email. If these are filled out correctly, you can click the Email Logs button to send the logs in a zipped file.

Enter your email address, and send the logs to yourself. When you receive the email, download the zipped log files to your computer, then attach the zipped log files to your support ticket.

Log Markers #

At the bottom of the Log Viewer, you'll see an Insert Marker button. Clicking this button will insert a marker into the log file. You can fill in the text box next to the "Insert marker" button to include some custom text in the marker.

You may find it useful to insert a marker when dealing with logs that contain a lot of information, and which are updated frequently by Process Director. For instance, when testing a function, you might insert a marker with custom text before running the test. The marker makes it easier to return to the log and find where your test started.

The example above demonstrates two markers. The first marker is the default marker that is inserted in the log file when you click the Insert marker button. The second example is a marker where the following custom text has been inserted:

This is a test marker for the log file.

Documentation Feedback and Questions

If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.

Send Feedback to BP Logix