Administrator manual 0.10 - Revision history

Evelyn: /* Users */

2013-09-11T00:51:17Z

Users

Evelyn: /* Users */

2013-09-11T00:48:47Z

Users

Courtney: /* Format Policy Registry (FPR) */

2013-07-17T19:48:15Z

Format Policy Registry (FPR)

Courtney: /* Format Policy Registry (FPR) */

2013-07-17T19:47:33Z

Format Policy Registry (FPR)

Mjordan: /* CONTENTdm DIP upload */

2013-06-12T21:02:53Z

CONTENTdm DIP upload

Mjordan: /* CONTENTdm DIP upload */

2013-06-12T18:49:26Z

CONTENTdm DIP upload

Mjordan: /* CONTENTdm DIP upload */

2013-06-12T18:41:39Z

CONTENTdm DIP upload

Mjordan: /* CONTENTdm DIP upload */

2013-06-12T18:33:27Z

CONTENTdm DIP upload

Mcantelon: /* Elasticsearch */

2013-05-23T19:08:14Z

Elasticsearch

Courtney: /* Format Policy Registry (FPR) */

2013-05-07T21:52:46Z

Format Policy Registry (FPR)

@@ Line 231: / Line 231: @@
 Users can be also created, modified and deleted from the Administration tab. Only users who are administrators can create and edit user accounts.
-You can add a new user to the system by clicking the "Add new" button on the user administration page. These users won't have administrator capability. By adding a user you provide a way to access Archivematica using a username/password combination. Should you need to change a user's username or password, you can do so by clicking the "Edit" button, corresponding to the user, on the administration page. Should you need to revoke a user's access, you can click the corresponding "Delete" button.
+You can add a new user to the system by clicking the "Add new" button on the user administration page. By adding a user you provide a way to access Archivematica using a username/password combination. Should you need to change a user's username or password, you can do so by clicking the "Edit" button, corresponding to the user, on the administration page. Should you need to revoke a user's access, you can click the corresponding "Delete" button.
 === CLI creation of administrative users ===

@@ Line 229: / Line 229: @@
 The dashboard provides a simple cookie-based user authentication system using the [https://docs.djangoproject.com/en/1.4/topics/auth/ Django authentication framework]. Access to the dashboard is limited only to logged-in users and a login page will be shown when the user is not recognized. If the application can't find any user in the database, the user creation page will be shown instead, allowing the creation of an administrator account.
-Users can be also created, modified and deleted from the Administration tab. Here you can manage which users have access to Archivematica and what level of access they have. Standard users are able to access all sections of the interterface except for the administration section.
+Users can be also created, modified and deleted from the Administration tab. Only users who are administrators can create and edit user accounts.
 You can add a new user to the system by clicking the "Add new" button on the user administration page. These users won't have administrator capability. By adding a user you provide a way to access Archivematica using a username/password combination. Should you need to change a user's username or password, you can do so by clicking the "Edit" button, corresponding to the user, on the administration page. Should you need to revoke a user's access, you can click the corresponding "Delete" button.

@@ Line 260: / Line 260: @@
 * Subscription to the FPR will allow the Archivematica project to notify users when new or updated preservation and access plans become available, allowing them to make better decisions about normalization and migration strategies for specific format types within their collections. It will also allow them to trigger migration processes as new tools and knowledge becomes available.
-*New Archivematica installations will attempt to connect to the FPR Server as part of the initial configuration process.  The FPR Server is a web application hosted by Artefactual, on a secure server in Toronto.  During the last step of the intsallation process, Archivematica attempts to send the following information to the FPR Server, over an encrypted connection:
+* New Archivematica installations will attempt to connect to the FPR Server as part of the initial configuration process.  The FPR Server is a web application hosted by Artefactual, on a secure server in Toronto.  During the last step of the intsallation process, Archivematica attempts to send the following information to the FPR Server, over an encrypted connection:
 #Agent Identifier (supplied by the user during registration while installing Archivematica)
@@ Line 268: / Line 268: @@
 #current time
-If Archivematica is not able to connect to the FPR Server during installation, no further attempts are ever made. However, the Preservation Planning tab in the Archivematica dashboard has a 'check for updates' button. This button initiates a connection from the FPR Server, where Archivematica asks for and receives a full set of Format Policy Rules from the FPR Server.  No information is sent to the FPR Server during this process.  The rules are processed locally by Archivematica, and used to update the local Format Policy Registry.   The FPR Server is able to log each https request that is sent to it, but no authentication takes place, and only IP address and current time is logged (not agent name and agent identifier).
+* If Archivematica is not able to connect to the FPR Server during installation, no further attempts are ever made. However, the Preservation Planning tab in the Archivematica dashboard has a 'check for updates' button. This button initiates a connection from the FPR Server, where Archivematica asks for and receives a full set of Format Policy Rules from the FPR Server.  No information is sent to the FPR Server during this process.  The rules are processed locally by Archivematica, and used to update the local Format Policy Registry.   The FPR Server is able to log each https request that is sent to it, but no authentication takes place, and only IP address and current time is logged (not agent name and agent identifier).
-In the 0.10 release, no information about the local format policy rules is sent to the FPR Server. Other than the initial connection during installation, where the Agent information is uploaded, all communication with the FPR Server is one-way, from the FPR Server to  Connection to the FPR Server is voluntary, any organization using Archivematica that does not want to connect to the FPR Server can either:
+* In the 0.10 release, no information about the local format policy rules is sent to the FPR Server. Other than the initial connection during installation, where the Agent information is uploaded, all communication with the FPR Server is one-way, from the FPR Server to  Connection to the FPR Server is voluntary, any organization using Archivematica that does not want to connect to the FPR Server can either:
 ** a) make sure the Archivematica machine cannot reach the FPR Server by putting it behind a firewall, or disabling it's internet connection, or
 ** b) modify the source code of Archivematica and comment out the FPR connection attempt
-For any organization not wishing to have their Archivematica installations communicate in any way with the FPR Server, opting out can be as simple as disconnecting the network cable from the host machine while filling out the Agent information screen during installation, and making sure not to click the 'check for updates' button on the preservation planning tab.
+* For any organization not wishing to have their Archivematica installations communicate in any way with the FPR Server, opting out can be as simple as disconnecting the network cable from the host machine while filling out the Agent information screen during installation, and making sure not to click the 'check for updates' button on the preservation planning tab.
-The only functionality lost in blocking access to the FPR Server is the ability to update the local Format Policy Registry with new Format Policy Rules published by Artefactual.  It would still be possible to get those rules when new versions Archivematica are released, but not between releases.
+* The only functionality lost in blocking access to the FPR Server is the ability to update the local Format Policy Registry with new Format Policy Rules published by Artefactual.  It would still be possible to get those rules when new versions Archivematica are released, but not between releases.
 * In future versions of Archivematica, Artefactual intends to increase the functionality provided by the FPR Server, including allowing organizations to share their [[Format_policies|format policies]].  Participation will be entirely optional, and we will provide a method for organizations to share their format policies anonymously.  Users will also be able to turn off FPR updates.

@@ Line 256: / Line 256: @@
 * The Format Policy Registry (FPR) is how Archivematica manages preservation planning using format policies. A format policy indicates the actions, tools and settings to apply to a file of a particular file format (e.g. conversion to preservation format, conversion to access format). Format policies will change as community standards, practices and tools evolve.
-* Hosted at [http://fpr.archivematica.org fpr.archivematica.org], the FPR stores structured information about normalization format policies for preservation and access. These policies identify preferred preservation and access formats. These default format policies can all be changed or enhanced locally by individual Archivematica implementers. For information about how default format policies were selected, see the analysis of significant characteristics and tools here: [[Format_policies|Format policies]]
+* Hosted at [http://fpr.archivematica.org fpr.archivematica.org], the FPR server stores structured information about normalization format policies for preservation and access. These policies identify preferred preservation and access formats. These default format policies can all be changed or enhanced locally by individual Archivematica implementers. The purpose of the FPR Server is to provide a mechanism for organizations to collaborate on the very difficult problem of Preservation Planning for the long tail of diverse digital file formats, that exist now, and will exist in the future.  By providing a central online location where different organizations can review, compare, and adopt format policies, Artefactual hopes to make a significant contribution to the productivity and effectiveness of the digital preservation efforts of Archivematica users.  For information about how default format policies were selected, see the analysis of significant characteristics and tools here: [[Format_policies|Format policies]]
 * Subscription to the FPR will allow the Archivematica project to notify users when new or updated preservation and access plans become available, allowing them to make better decisions about normalization and migration strategies for specific format types within their collections. It will also allow them to trigger migration processes as new tools and knowledge becomes available.
 = Customization and automation =

@@ Line 96: / Line 96: @@
 Archivematica can also upload DIPs to [http://www.contentdm.org/ CONTENTdm] instances. Multiple CONTENTdm destinations may be configured.
-For each possible CONTENTdm DIP upload destination, you'll specify a brief description and configuration parameters appropriate for the destination. Paramters include <code>%ContentdmServer%</code> (full path to the CONTENTdm API, including the leading 'http://' or 'https://', for example http://example.com:81/dmwebservices/index.php), <code>%ContentdmUser%</code>, and <code>%ContentdmGroup%</code> (Linux user and group on the CONTENTdm server, not a CONTENTdm username).
+For each possible CONTENTdm DIP upload destination, you'll specify a brief description and configuration parameters appropriate for the destination. Paramters include <code>%ContentdmServer%</code> (full path to the CONTENTdm API, including the leading 'http://' or 'https://', for example http://example.com:81/dmwebservices/index.php), <code>%ContentdmUser%</code>, and <code>%ContentdmGroup%</code> (Linux user and group on the CONTENTdm server, not a CONTENTdm username). Note that only <code>%ContentdmServer%</code> is required is you are going to produce CONTENTdm Project Client packages; <code>%ContentdmUser%</code>, and <code>%ContentdmGroup%</code> are also required if you are going to use the "direct upload" option for uploading your DIPs into CONTENTdm.
 When changing parameters for a CONTENTdm DIP upload destination simply change the values, preserving the existing format they're specified in. To add an upload destination fill in the form at the bottom of the page with the appropriate values. When you've completed your changes click the "Save" button.

@@ Line 95: / Line 95: @@
 == CONTENTdm DIP upload ==
-Archivematica can also upload DIPs to [http://www.contentdm.org/ CONTENTdm] websites. Multiple CONTENTdm destinations may be configured.
+Archivematica can also upload DIPs to [http://www.contentdm.org/ CONTENTdm] instances. Multiple CONTENTdm destinations may be configured.
-For each possible CONTENTdm DIP upload destination, you'll specify a brief description and configuration parameters appropriate for the destination. Possible paramters include <code>%ContentdmServer%</code>, <code>%ContentdmUser%</code>, and <code>%ContentdmGroup%</code>.
+For each possible CONTENTdm DIP upload destination, you'll specify a brief description and configuration parameters appropriate for the destination. Paramters include <code>%ContentdmServer%</code> (full path to the CONTENTdm API, including the leading 'http://'), <code>%ContentdmUser%</code>, and <code>%ContentdmGroup%</code> (Linux user and group on the CONTENTdm server, not a CONTENTdm username).
 When changing parameters for a CONTENTdm DIP upload destination simply change the values, preserving the existing format they're specified in. To add an upload destination fill in the form at the bottom of the page with the appropriate values. When you've completed your changes click the "Save" button.

@@ Line 290: / Line 290: @@
      print "Error deleting index or index already deleted."
 </pre>
 = Data backup =