Users_Guide

Jason Pell edited this page Jun 21, 2013 · 1 revision

Table of Contents

The Main Menu

Add Items

NOM PRENOM RUE VILLE CODE POSTAL

List My Items

List other Items

Import My Items

See Adding Items: Importing Items below.

Export my items

Item Search

Statistics

Edit My Info

Allows you to change your personal information, contact information, and site theme.

Change My Password

Change your login password.

Logout

Logs you out of OpenDb.

Adding Items

You can add items to your collection with the add item link in the sidebar.



There are several ways to add items to your collection:

  • With a site plug-in
  • Manual Entry
  • Importing Items

With a site plug-in

A plug-in can query another site (such as the IMDb) for information about an item based on search criteria you provide. This is the fastest way to add an individual item, but the item you are adding to your collection must be available from one of these sites. OpenDb will search the chosen site for your item and return results matching your criteria. If you see your item in this list, click the title, and OpenDb will display a form with the information provided by the site already filled in. Check the information and click 'Save Item' to add the item to your collection.

Manual Entry

If your item isn't listed with one of the site plug-ins you can manually enter the information into a form. Select the item type for the item you would like to add and click 'Add New Item'. You will be presented with a form for describing the item you would like to add. After completing the form click 'Save Item' and your item will be added to your collection.

For both the site plug-in and manual entry methods, the Copy Info tab is where you change the Status Type, Status Comment, and Default Borrow duration of the item you are inserting / updating.

Importing Items

This is done in the 'Import my Items' dialog, accessible from the sidebar.

Before reading any further, click the 'Import Items' button without a file specified. The 'Import Preview' page opens and you get to see how the import function works.

  1. Enter your data into a spreadsheet program like Excel with one item per row and one column per attribute (e.g., 'Title', 'Director', 'Year'). The first row should be column headings. Save this file in CSV (comma-separated values) format. These columns don't need to be in any special order and the headings don't have to exactly match the OpenDb attributes' names (see 4).
  2. On the 'Import my Items' page, click the 'Browse' button and find your CSV file. Open this file and click the 'Import Items' button. This brings you to the 'Import Preview' page.
  3. There are three check boxes.
    1. Include first line
    2. Ignore Duplicate Titles
    3. Trial Run (default is checked)
  4. Check the first box if your CSV file doesn't have column headings (as was suggested above) and your first item is in your first row. If you check the second box, titles you have already imported aren't re-imported (see Copy vs Clone Item at the bottom of the page).
  5. The first column of options allows you to identify which column in your file should be associated with which attribute in OpenDb. If there is a column whose heading matches the name of an attribute then OpenDb will guess for you. Go down the column and set each selector to the appropriate heading title.
  6. The second column allows you to define default values to attributes (e.g., if all your movies star Keanu Reeves, or you're just importing cookbooks).
  7. When everything is set properly, click on 'Import Items' at the bottom of the page. The next page shows the results of the import function. If everything is as it should be, click 'Import Items' one last time.
  8. If you get errors (in red) go back and fix those values in your Excel/CSV file, and then go back to 2. :(

Common Problems

If you get errors (in red), values you are trying to enter for an attribute don't match the expected format. For instance: you haven't given a value for a required field or your date isn't formatted correctly.

Make sure you have upload privileges to your web server.

For more solutions check the help forum Try searching for CSV.

Customizing

To customize the look and feel of the user interface, change the theme. Click the 'Edit User Info' button in the sidebar and select one of the themes the Administrator has provided.

Reservation

A reservation is a way for a user to indicate they want to borrow an item (i.e. have the item checked out to them).
The borrower reserves the item, the owner of that item then can check out the item to the borrower.

A quick check out allows an owner to check out an item to a borrower without a pre-existing reservation.
Once the item is checked out to a borrower, an owner can send reminders to that borrower if the item is overdue.
Once the borrower returns the item to the owner (physically returned I mean), the owner will then 'check in' the item in OpenDb.
Once the item is checked back in, it's available for check out again.

The Borrow Status column in item_display and listings indicates what the status of the item is. It can be one of three statuses:

  • Borrowed – the item has been checked out to a borrower.
  • Reserved – the item has been reserved by at least one borrower, but is NOT checked out to anyone.
  • N/A – no current reservations exist for this item, which also indicates it's not checked out to anyone.

Item Status vs. Borrow Status

The 'Status' of an item is different to the 'Borrow Status'. The status (not borrow status!) indicates the status of an item without regard to whether it's borrowed or not. The status will also indicate in some instances whether the item can be borrowed or not.

For instance if an item has a status of 'Wishlist' or 'Ordered', it indicates the item cannot be reserved, because the owner does not actually physically own it yet. The item may be 'Inactive' which indicates the owner does not wish to have it available for reservations. An owner can also set an item to 'hidden' which means only the owner and Administrators can see the item.

Site Plugins

Input Fields

  • CueCat / UPC Search support
It is possible to enable UPC / CueCat search support for Amazon.com. Previously this functionality has only worked for BOOK by configuring the ASIN / ISBN input field to accept CueCat scan codes. However it has recently been made known that Amazon.com and DVDEmpire accept a UPC in the title field.

This section will briefly explain what you need to do to take advantage of it with your cuecat. Normal title searches will still continue to work as normal.

  1. Access the System Admin Tools from the menu
  2. Open the 'Site Plugins' tool
  3. Choose the 'Input Fields' option for the amazon or dvdempire plugin
  4. Change the Field Type of the 'title' field from 'text' to 'scan-upc'. This will enable support for parsing that field for any cuecat scans that are entered. This should work for both clawed and declawed CueCat scanners.
Its probably a good idea to change the field prompt from 'Title Search' to 'UPC / Title Search' too

CueCat sample

The following CueCat code will resolve to Halloween

.C3nZC3nZC3n3CNfXDhr6CxnX.fHmc.C3jWCNbYC3T6DxPY.

Frequently Asked Questions

How can I relate more than one movie to one single item in my collection?

There is an 'Add Related Item' in the Linked Item(s) tab when you edit the main item.

The Purpose/Use of the 'Add Related Item'

Related items are for box sets, etc.



For instance if you have Alien Box set and you want to have a main item for the "Alien Box Set", and then relate each of 'Alien','Aliens',Aliens 3' to this top level item, as related items.




Copy vs Clone Item

(From http://sourceforge.net/forum/message.php?msg_id=2874258)

The 'New Copy' and 'Clone Item' functions are available from the 'Copy Info' tab of the item display screen.

'New Copy' actually creates a new instance of the item, but all the item attributes, etc are unchanged. Its just a way to represent multiple copies of the one item.

'Clone Item' actually makes a copy of the item and assigns it to a new item_id. There is no reference to the original item, following this procedure.