Ace:Audit Manager User Guide - Revision history

Toaster at 15:23, 26 May 2009

2009-05-26T15:23:11Z

← Older revision		Revision as of 15:23, 26 May 2009
Line 154:		Line 154:

	==Status Reports==		==Status Reports==

			==Comparing Collections==
			[[Ace:Comparing Collections\| Comparing Collections]]

	==Managing Users==		==Managing Users==

Toaster at 21:14, 16 September 2008

2008-09-16T21:14:46Z

← Older revision		Revision as of 21:14, 16 September 2008
Line 156:		Line 156:

	==Managing Users==		==Managing Users==

			The Audit Manager supports configurable user accounts. Clicking on the 'Accounts' link at the top of the application will show the users window.
			===Create New User===

			# Click on the 'Accounts' link at the top of the web page. If any username appears in the 'Username' field, click the clear link.
			# Enter a new username and password for the account you want to create.
			# Select the appropriate permissions for the user.
			# Click 'Save' when finished.

			===Editing Users===

			# Click on the Accounts link at the top of the web page.
			# Enter a new password, or change permissions for the user.
			# Click 'Save' when finished.

			===User Permissions===

			* Status - View the status details for any collection
			* Modify Collections - Create, modify, or remove collection settings. This includes changing any collection connection information, audit frequency, or directory
			* Browse - Browse files in a collection and view details (checksum, last scanned, etc)
			* View Log Entries - View any log entries
			* Start or Stop Audits - Start or stop a file or token audit
			* Remove monitored files/directories - Remove individual files or directories from the audit manager
			* Manage Users - Modify, view, or add users
			* View Collection Reports - View reports for any collection
			* Download Tokens - Download integrity tokens from the browse window for any file.

Toaster at 20:55, 16 September 2008

2008-09-16T20:55:10Z

← Older revision		Revision as of 20:55, 16 September 2008
Line 100:		Line 100:

	Configuration Settings:		Configuration Settings:
	* Server:		* Server: iRODS server
	* Port:		* Port: port on irods server
	* Username:		* Username: irods username
	* Password:		* Password: account password
	* Zone: Zone your account resides in.		* Zone: Zone your account resides in.

			These settings should be the same you use in the irods explorer or your .irodsEnv configuration file.

	==Auditing Collections==		==Auditing Collections==
Line 119:		Line 121:

	Collections in the Audit manager may be periodically scanned to ensure nothing has changed. Setting up the periodic scan is done from the collection management screen.		Collections in the Audit manager may be periodically scanned to ensure nothing has changed. Setting up the periodic scan is done from the collection management screen.

	* When creating a new collection, you can enter how often you wish to audit the collection.		* When creating a new collection, you can enter how often you wish to audit the collection.
	* For existing collections, you can modify their settings. From the status screen, click on the collection you will be auditing and click the [[Image:Ace-edit.jpg]] icon. You can change your audit frequency and hit save		* For existing collections, you can modify their settings. From the status screen, click on the collection you will be auditing and click the [[Image:Ace-edit.jpg]] icon. You can change your audit frequency and hit save

			If you wish to disable automatic auditing, enter '0' for how often to audit the collection.

	==Hash Validation==		==Hash Validation==

			==Browse Collection==

	==Log Files==		==Log Files==

	The Audit Manager keeps a record of everything that has ever occurred during a files lifetime. This includes every audit of a ~~colleciton~~, when files were registered, any time they were found corrupt, etc. Since these logs can grow quite large, there is a method to filter log files based on the type of message, collection, item, and session.		The Audit Manager keeps a record of everything that has ever occurred during a files lifetime. This includes every audit of a collection, when files were registered, any time they were found corrupt, etc. Since these logs can grow quite large, there is a method to filter log files based on the type of message, collection, item, and session.

			===Reading Log Entries===
			The log window will have a list of log entries. Entries are listed with the oldest entries at the top and newest at the bottom. Each entry shows four items described below:
			* Entry ID - number identifying this log entry
			* Date - Date and time this log entry occurred.
			* Session - Number connecting related entries. All log entries from a particular audit will have the same session number.
			* Log type - Type of log entry. [[Ace:Log Messages\|Types of log messages]]

			Clicking on any of the log entries will show an expanded view. The expanded view shows details about which item and collection this entry is connected to, along with any message. Most log entries will show some or all of the following:
			* Collection - Which collection this log event is attached to.
			* Path - Location of affected item within a collection
			* Session - Number connecting related log entries
			* Event Type: Expanded desription of what occurred. [[Ace:Log Messages\|Types of log messages]]
			* Details - details for the event

			Clicking on any of the Path, Collection, or Session values will add a filter to show any related log entries.

	~~[[Ace:~~Log ~~Messages\|Types of log messages]]~~		===Log Filters===

	==Status Reports==		==Status Reports==

	==Managing Users==		==Managing Users==

Toaster at 20:29, 16 September 2008

2008-09-16T20:29:23Z

← Older revision		Revision as of 20:29, 16 September 2008
Line 118:		Line 118:
	===Periodic File Scanning===		===Periodic File Scanning===

	Collections in the Audit manager may be periodically scanned to ensure nothing has changed. Setting up the periodic scan is done from the collection management screen. From the status screen, click on the collection you will be auditing and		Collections in the Audit manager may be periodically scanned to ensure nothing has changed. Setting up the periodic scan is done from the collection management screen.
			* When creating a new collection, you can enter how often you wish to audit the collection.
			* For existing collections, you can modify their settings. From the status screen, click on the collection you will be auditing and click the [[Image:Ace-edit.jpg]] icon. You can change your audit frequency and hit save


	==Hash Validation==		==Hash Validation==

Toaster at 20:26, 16 September 2008

2008-09-16T20:26:05Z

← Older revision		Revision as of 20:26, 16 September 2008
Line 110:		Line 110:
	There are several ways the integrity of collections in the Audit Manager are tested. First, is ensuring that no files have changed or gone missing. This scanning can occur manually, ie someone triggers a scan, or automatically, ie scan every 7 days. The second type of auditing involved checking to make sure the Audit Manager's own data is intact. This involves checking the integrity of every stored hash for a collection		There are several ways the integrity of collections in the Audit Manager are tested. First, is ensuring that no files have changed or gone missing. This scanning can occur manually, ie someone triggers a scan, or automatically, ie scan every 7 days. The second type of auditing involved checking to make sure the Audit Manager's own data is intact. This involves checking the integrity of every stored hash for a collection

	==Manual File Scanning==		===Manual File Scanning===

	==Periodic File Scanning==		Collections or folders in ACE can be audited on demand.
			; Collection Audit : From the Status screen, select the collection you with to audit. In the details box, click the [[Image:Ace-file-audit-start.jpg]] icon to start integrity checking of the entire collection.
			; Directory Audit : From the Status screen, select the collection you with to audit. Click the [[Image:Ace-browse.jpg]] icon to to open the collection browser. Select the folder you with to audit and click the ''Audit files'' link to check every file and directory in that folder.

			===Periodic File Scanning===

	Collections in the Audit manager may be periodically scanned to ensure nothing has changed. Setting up the periodic scan is done from the collection management screen. From the status screen, click on the collection you will be auditing and		Collections in the Audit manager may be periodically scanned to ensure nothing has changed. Setting up the periodic scan is done from the collection management screen. From the status screen, click on the collection you will be auditing and

Toaster at 16:05, 11 September 2008

2008-09-11T16:05:05Z

← Older revision		Revision as of 16:05, 11 September 2008
Line 10:		Line 10:
	The first page you will be greeted with is the status screen. This will likely be located at <nowiki>http://www.your_installation_server.com:8080/ace-am</nowiki>. Your sysadmin or whomever installed the software should be able to give you the URL to the Audit Manager.		The first page you will be greeted with is the status screen. This will likely be located at <nowiki>http://www.your_installation_server.com:8080/ace-am</nowiki>. Your sysadmin or whomever installed the software should be able to give you the URL to the Audit Manager.

	~~<a href="%ATTACHURLPATH%/status-screen~~-~~closed.jpg"><img src="%ATTACHURLPATH%/~~status-screen-closed~~-small.jpg" alt="status-screen-closed-small~~.jpg~~" border=0 width="500" height="277" /></a>~~		[[Image:Ace-status-screen-closed.jpg\|thumb]]

			If this is your first time using the Audit manager, you will not see any collections listed. See [[#Registering New Collections\|Registering New Collections]] below for information on registering your files.
	If this is your first time using the Audit manager, you will not see any collections listed. See [[#~~Adding~~ Collections]] below for information on registering your files.

	* State: Current state of the collection		* State: Current state of the collection
	** ~~<img src="%ATTACHURLPATH%/~~running.jpg~~" alt="running.jpg" width="16" height="16" />~~ Audit is in progress		** [[Image:Ace-running.jpg]]Audit is in progress
	** ~~<img src="%ATTACHURLPATH%/~~stopped.jpg~~" alt="stopped.jpg" width="16" height="16" />~~ No Audit is in progress		** [[Image:Ace-stopped.jpg]] No Audit is in progress
	** ~~<img src="%ATTACHURLPATH%/file~~-~~ok.jpg" alt="~~file-ok.jpg~~" width="16" height="16" />~~ Collection was successfully audited and contains no errors.		** [[Image:Ace-file-ok.jpg]] Collection was successfully audited and contains no errors.
	** ~~<img src="%ATTACHURLPATH%/error.jpg" alt="~~error.jpg~~" width="16" height="16" />~~ Collection contains errors, view report to see errors.		** [[Image:Ace-error.jpg]] Collection contains errors, view report to see errors.
	** ~~<img src="%ATTACHURLPATH%/file~~-~~bad.jpg" alt="~~file-bad.jpg~~" width="16" height="16" />~~ Collection has never fully completed an audit		** [[Image:Ace-file-bad.jpg]] Collection has never fully completed an audit

	* Collection Name: Descriptive name of the collection.		* Collection Name: Descriptive name of the collection.
Line 29:		Line 28:
	Clicking on the name of any collection will show details for the collection. You can close the the details for a collection by clicking the 'x' next to the collections name in the upper left hand of the details window.		Clicking on the name of any collection will show details for the collection. You can close the the details for a collection by clicking the 'x' next to the collections name in the upper left hand of the details window.

	~~<a href="%ATTACHURLPATH%/status-screen~~-~~open.jpg" border=0><img src="%ATTACHURLPATH%/~~status-screen-open~~-small.jpg" alt="status-screen-open-small~~.jpg~~" border=0 width="500" height="409" /></a>~~		[[Image:Ace-status-screen-open.jpg\|thumb]]



	* Audit Status: One of the following three options		* Audit Status: One of the following three options
Line 53:		Line 50:

	The line of icons listed below a collection can be used to audit, browse, view logs and other stuff with the collection. If an audit is in progress, you may not see all of these listed.		The line of icons listed below a collection can be used to audit, browse, view logs and other stuff with the collection. If an audit is in progress, you may not see all of these listed.
	* ~~<img src="%ATTACHURLPATH%/file~~-~~audit-start.jpg" alt="~~file-audit-start.jpg~~" width="15" height="13" />~~ Audit files in the collection		* [[Image:Ace-file-audit-start.jpg]] Audit files in the collection
	* ~~<img src="%ATTACHURLPATH%/token-audit~~-~~start.jpg" alt="~~token-audit-start.jpg~~" width="16" height="16" />~~ Audit tokens in the collection		* [[Image:Ace-token-audit-start.jpg]] Audit tokens in the collection
	* ~~<img src="%ATTACHURLPATH%/~~stop.jpg~~" alt="stop.jpg" width="16" height="16" />~~ Stop an in-progress audit		* [[Image:Ace-stop.jpg]] Stop an in-progress audit
	* ~~<img src="%ATTACHURLPATH%/edit.jpg" alt="~~edit.jpg~~" width="16" height="16" />~~ Modify collection settings		* [[Image:Ace-edit.jpg]] Modify collection settings
	* ~~<img src="%ATTACHURLPATH%/~~delete.jpg~~" alt="delete.jpg" width="16" height="16" />~~ Remove a collection		* [[Image:Ace-delete.jpg]] Remove a collection
	* ~~<img src="%ATTACHURLPATH%/browse.jpg" alt="~~browse.jpg~~" width="16" height="16" />~~ View the contends of a collection		* [[Image:Ace-browse.jpg]] View the contends of a collection
	* ~~<img src="%ATTACHURLPATH%/~~log.jpg~~" alt="log.jpg" width="16" height="16" />~~ View all log entries for a collection		* [[Image:Ace-log.jpg]] View all log entries for a collection
	* ~~<img src="%ATTACHURLPATH%/report.jpg" alt="~~report.jpg~~" width="16" height="16" />~~ View report of any missing or corrupt files		* [[Image:Ace-report.jpg]] View report of any missing or corrupt files

Toaster at 15:53, 11 September 2008

2008-09-11T15:53:16Z

Show changes

Toaster at 17:54, 10 September 2008

2008-09-10T17:54:35Z

New page

Not yet migrated
http://adaptwiki.umiacs.umd.edu/twiki/bin/view/Main/AceV3Usage