Umbria Logs
Each log provides a Filter option that allows you to narrow the entries shown to a particular set of results. You can also export the content of any log to Excel, or click the icon in the Copy column to copy the log entry contents onto your clipboard. This can be helpful when contacting Support regarding an issue.
Application Log
The application log contains information on actions taken within Umbria, including process information, errors, traces of services started, and application warnings. Four different types, or levels, of entries are displayed:
- Debug- Any scripts that are used for debugging processes.
- Error- All errors will show up here, regardless if they are application, SQL, or IIS-specific.
- Info- Any information or generic notes regarding certain commands. For example, an entry for the Entity Cleanup processor might read "1 old entry deleted."
- Trace- Starting or stopping time for a system service.
- Warning- Indication that a component is not functioning properly or is delayed, which may or may not be tied to an error.
You can set up each type of entry to trigger an email notification to a specified recipient on the Application Log Settings tab in Global Settings. You can set the log retention days in the Maintenance tab in Global Settings. In Text Log panel, click Settings to auto delete the agent log file once it exceeds the size specified in the Text Log Retention field. Select the check box for Backup Before Delete to back up the file before deletion. A Caliban.Log file is saved in your local system. This setting is added as a measure to free the disk drive space from large agent log files.
Audit Log
Entries in the audit log represent changes made to system tables. Available operation types include Create, Update, and Delete. In the instance that the change was an update, you can select it to view the New Values and Old Values in the panes on the right. You can set the log retention days in the Maintenance tab in Global Settings.
Command Log
The command log displays information on commands executed in Umbria, including the time executed, the executing user, and the status of each. Possible statuses include Success, Retry, Queued, Failed, Executing, Canceling, Canceled, and Interrupted. For failed commands, you will also see the number of attempts left and a Message describing the failure. You can set the log retention days in the Maintenance tab in Global Settings.
Index Log
The index log shows information regarding when and what was indexed within the Umbria tables (data indexed is shown in JSON form). You can filter to see indexing information for just a single table or single field.
Entity Change Log
This node displays records of changes made to entities, including information on when the change happened and the affected table. If the change was the removal of an entity, the checkbox in the Deleted column is selected.
Email Log
The email log shows all emails sent for Umbria matters. You can select a record in the log to see a preview of the email message below the list. You also have the option to forward or resend any of the emails listed.You can set the log retention days in the Maintenance tab in Global Settings.
Scheduled Background Tasks
This node lists all background tasks scheduled for future execution, along with the next run time and the affected table/entity. Additional information regarding background processes is available at the end of this topic.
SSIS Log
This node displays information regarding SSIS changes that were made and when they occurred. SSIS changes can have a status of Completed, Unknown, Started, or Error.
Publish Log
This node displays information for the Publisher Module. This log shows all information regarding when the data was last pushed from Umbria to an external system. You can export the details to an Excel or PDF file.
Activity Log
The Activity Log includes two tabs: the User Activity Log and the Activity Graph.
The Activity Log tab lists all instances of a user accessing either the Umbria system or a certain page in the system, while the Activity Graph shows a bar graph of the most frequently accessed pages. You can set the log retention days in the Maintenance tab in Global Settings.
Stat Job
This node allows you to create and execute a Statistics Job. In 2019, Statistics is using the Stored procedure option, so there is no statistics setting. In the event of a job or import failure, then this node allows you to continue from the point where the job failed. The entire job needs not be reprocessed. To add and execute the job, follow the steps below:
- Click on Create Job to add a job. You can create a job for a specific matter, or select a client and run the job for all the matters of the selected client, or create a job for a planning phase id etc. Any option with List, allows for multiple ids comma separated.
- Set the start and end date to include the selected criteria.
- The number of retries are for when a failure occurs on the job, to retry a certain number. The minimum retry number is 1.
- By default the batch size is set to 100 (100 entities ) will be processed in a run, you can edit the settings.
- If running special statistics you can set:
- Process incremental: To process an incremental import based on the last imported entries.
- Debug: If debugging import failure messages, check this.
- Force update: If a forced record update for the statistics is needed, check this. Even if the data hasn't changed, the record will be updated.
- Click Save. The Stat Job is added to the list.
- Select the job from the left panel and click Execute to run the job.
- The panel on the right will display all the queued jobs and the log reports.
Adding a Usage Log
In IIS, you can perform the following steps to create a log that tracks information on who is using the system.
- Open IIS and browse to the Umbria site.
- Click the Logging icon.
- Set a directory and log file to save and the event type. Click Apply. The file now contains a log of the IIS request usage.
Tip: You can alternatively set the logging at the server level.
Background Jobs and Processors
Umbria is an n-tier application and can be scaled horizontally. To spread the processing load, Umbria agents (Windows Services) can be installed across multiple machines. To support multiple users in a load-balanced environment, Umbria can be installed on multiple Web servers. At minimum, Prosperoware recommends one front-end Web server and one Service server for Umbria. More servers can be added based on features used, number of users, and transaction volume.
- Umbria Web server: The Umbria Web server is the primary server that users interact with. It serves the Umbria pages for both Admin and end users. There can be more than one front-end server, but at least one is required. The front-end server can also run background jobs and processors.
- Umbria Agent: The Umbria Agent is a Windows Service used to run background processes. Depending on design and scalability requirements, certain background processes be distributed to the Agent. The Umbria agent is optional for a demo or POC environment, but required for a Production environment.
- Agent Jobs: These are background processes that need to be run on all instances of Umbria servers (Web servers and Umbria Agents). Agent jobs are continuously running.
- Processors: These are similar to Agent jobs but can be scheduled for a specific time, and do not need to be run on all instances. You can dedicate a server or agent to run specific processes.
| Agent/Processor | Description | Continuously running? | Required on all servers and agents? |
|---|---|---|---|
| Audit Log |
Inserts audit entries into the audit table when key entities (e.g., matter, client, or employee records) are changed. Unlike database and email logging, this table is permanent and stores entries for all time. This job has to run on all instances. If this job is turned off on a server, there will not be audit entries for operations performed by other jobs on that server. |
Yes | Yes |
| Command Processors |
This job processes commands from an Umbria queue. In Umbria, many post-back operations or user actions are executed as two steps. A user action within Umbria is submitted to the server, and the server in turn schedules a background job with all parameters, which is executed by the command processors. For example, when a user uploads a document into Umbria, the Umbria controller creates a command to import the document to WorkSite and return a response to the user. The command processor picks up the job from the queue and executes it. The command processor queue is multi-instance friendly. If this is enabled on more than one server, the next available server will pick up the next unprocessed command. |
Yes | No (though recommended to run on all Agents for performance improvements) |
| Database Logging and Email Logging |
These jobs store log information in the application table. By default, log entries are kept for 14 days. Any entries older than 14 days are deleted. |
Yes | Yes |
| EmailResponseChecker | This job is constantly listening to a designated mailbox. The subject and body of each incoming email are processed into Umbria and update the Umbria database. and process the subject line and email body of incoming emails in that mailbox and update Umbria database accordingly. This is used to monitor users’ replies to Umbria-generated emails (e.g., task assignments, task comments, budget approvals, etc.). | Yes | No |
| EntityChangeProcessing | The EntityChangeProcessor executes actual jobs that are based on changes such as indexing. | Yes | No |
| EntityChangeTracking | EntityChangeTracking tracks changes and maintains them in a queue for other processors to act upon. | Yes | Yes |
| ActiveDirectoryPush | If enabled, all user and group changes made within Umbria are also made in Active Directory. | No, scheduled. | No |
| EntityCleanUp | This process deletes related temporary data from the Umbria database whenever a matter or opportunity is deleted. | No, scheduled. | No |
| EntityIndexer |
EntityIndexer is a job responsible for actually indexing (full text indexing) changes made to matters, employees, and documents. EntityChangeProcessing and EntityChangeTracking must also be enabled. |
No, scheduled. | No |
| TaskScheduler And ScheduleTask | This job is responsible for creating background jobs, which are then executed by the ScheduleTask job at the scheduled time. For example, if a matter profile email needs to be sent out 30 days after a matter opening, the task is scheduled by TaskScheduler the day that the matter opens, and executed by ScheduleTask 30 days later. | No, scheduled. | No |
