Differences

This shows you the differences between two versions of the page.

--- pergamonmu:lookup:lookup_manager [2017/08/07 16:30]
admin
+++ pergamonmu:lookup:lookup_manager [2017/08/07 17:23]
admin
@@ Line 1: / Line 1: @@
-Lookup Manager
+====== Lookup Manager ======
 Tell me about:
@@ Line 16: / Line 16: @@
   * [[pergamonmu:lookup:how:modify lookup group or item|Modify lookup group or item]]
   * [[pergamonmu:lookup:how:remove a lookup group or item|Remove a lookup group or item]]
+  * [[pergamonmu:lookup:how:merge items|Merge lookup items into one]]
 Lookup Item Expansion Editors:
@@ Line 24: / Line 25: @@
   * [[pergamonmu:lookup:editor:media|Media advanced editor]]
   * [[pergamonmu:lookup:editor:groups|Groups advanced editor]]
-  * [[pergamonmu:lookup:editor:audience|Audience advanced editor]]
   * [[pergamonmu:lookup:editor:hid format|HID Format advanced editor]]
   * [[pergamonmu:lookup:editor:circulations profile|Circulations Profile advanced editor]]
   * [[pergamonmu:lookup:editor:closures|Closures advanced editor]]
-===== System Keys =====
-System keys are a method by which Pergamon is able to uniquely identify a lookup item or group, regardless of what text has been assigned for display.
-For example, if Pergamon requires to load all of the lookup items associated with '%AGENT% Locations' it can do so by asking for all '!BLOCATION' system key items - regardless of whether the actual plain-text description of the group is '%AGENT% Location', 'Client Location, 'Borrower Location' or a dozen other descriptions that may have been modified to suit the local needs of the user.
-Typically, System Keys (or SysKeys) are 10 digit alpha-numeric keys that can be assigned by the user or centrally by Esferico. In most cases however, system keys do not need to be assigned locally unless a customised script has been created that directly requires access to a specific lookup group.
-If system keys are used, it is essential that users do not prefix their key with the exclamation mark (!) as this marks the group as a centrally assigned system based group (created by Esferico) that must always be present within the application. As a result, as soon as the key is saved into the database, the lookup editor will prevent all further attempts to modify the key. Once set therefore, no modification is permitted.
-===== Standard Lookup Groups =====
-=== %AGENT% Age Range (!BAGERANGE / %AGENT% Popup) ===
-A list of age-range groupings used for special purposes or general grouping. Typical entries include 'Minor' and 'Adult'.
-%AGENT% Audience (!BAUDIENCE / %AGENT% Indexing)
-A grouping system proving a method by which access to %ITEMS% can be restricted. %ITEMS% are linked with the %ITEM% Audience group to provide restriction patterns.
-%AGENT% Circulation Profiles (!BPROFILE / %AGENT% Popup)
-Records that define rules by which %ITEMS% may be circulated.
-%AGENT% Gender (!BGENDER / %AGENT% Popup)
-Genders for individual %AGENT%.
-%AGENT% Groups (!BGROUPS / %AGENT% Popup)
-A general method by which %AGENT% can be grouped - in the case of an educational establishment, these groups may include class names.
-%AGENT% HID Formats (!%AGENT%HID / %AGENT% Popup)
-A method by which rules can be created that govern the formatting of the unique (human readable) identification numbers. In most cases, these rules come into play during the automated generation of of numbers when creating new records.
-%AGENT% Locations (!BLOCATION / %AGENT% Popup)
-Physical location of %AGENT%.
-%AGENT% Salulations (!BSALUTE / %AGENT% Popup)
-Prefixes for %AGENT% names.
-Booking Destinations (!BOOKDEST / System)
-Methods by which reserved or booked %ITEMS% should be delivered on completion of a advanced booking.
-Closure Days (!CLOSURES / System)
-Days and patterns defining when the library or collection agency is closed (i.e. not able to accept circulations).
-Equal Opportunites (!EQUALOPS / System)
-A list of records that may be utilised for equal-opportunity purposes. A common use of the system is the production of statistical reports ensuring shared use / access to the library contents.
-Equal Opportuity Types (!EQUALITY / System)
-Grouping methods for the Equal Opportunity records. These groups may include Race, Religion, Nationality and Disability Groups.
-%ITEM% Audience (!IAUDIENCE / %ITEM% Indexing)
-A method by which %ITEMS% can be allocated issue restriction types. In the case of audio/video media types, these may include the standard classification systems.
-%ITEM% Categories (!ICATEGORY / %ITEM% Indexing)
-%ITEM% Categories are a general method of grouping %ITEMS%. Groups may include the standard general literary-library types of 'Fiction' or 'Non-Fiction', or more specific such as 'Crime', 'Science Fiction' etc.
-%ITEM% Category Types (System)
-A method by which groups of %ITEM% categories may be grouped together.
-%ITEM% Contributor Types (%ITEM% Popup)
-A method by which contributors to the creation of an %ITEM% can be grouped together. Contributor types may include Authors, Editors, Actors etc.s
-%ITEM% Contributors (!ICONT / %ITEM% Indexing)
-Contributors to the %ITEM% creation. May include that names of authors, editors, actors etc.
-%ITEM% HID Formats (!%ITEM%HID / %ITEM% Popup)
-A method by which rules can be created that govern the formatting of the unique (human readable) identification numbers. In most cases, these rules come into play during the automated generation of of numbers when creating new records.
-%ITEM% Keyword Packages (%ITEM% Popup)
-A method of grouping keywords into packages. Rather than simply act as a grouping method in this case however, the keyword packages system is provided so as to be able to attach a large number of standard keywords in one assignment.
-%ITEM% Keywords (!IKEYWORDS / %ITEM% Indexing)
-A set of keywords that are relevant to an individual %ITEM%. Keywords are one of the principle indexing methods for use by library users.
-%ITEM% Languages (!ITEMLANG / %ITEM% Indexing)
-A range of languages which an individual %ITEMS% may support.
-%ITEM% Locations (!ILOCATION / %ITEM% Popup)
-Physical locations where an %ITEM% may be stored. Physical locations however, are general in nature (e.g. a building or room), whereas exact locations can be entered into an %ITEM% record directly.
-%ITEM% Media (!IMEDIA / %ITEM% Popup)
-A list of media types which can be assigned to %ITEMS% stored in the library. Partly an indexing method, media types also provide the facility to specify expansion editors. Each expansion editor provide a method of recording media specific information within each %ITEM%.
-%ITEM% Publishers (!IPUBLISH / %ITEM% Indexing)
-Originating publishers of %ITEMS% within the library.
-%ITEM% Series (!ISERIES / %ITEM% Popup)
-A series to which an %ITEM% may belong.
-%ITEM% Status (!ISTATUS / %ITEM% Popup)
-The current status of an %ITEM% - statuses may include normal, damaged, in-transit or other user created statues that are specific to the individual library.
-%ITEM% Subjects (!ISUBJECTS / %ITEM% Indexing)
-A higher level indexing method similar in nature to Keywords but dealing with more general terminology. While Keywords may include words such as 'France', '1939', 'Blitzkrieg' and 'Churchill', the Subject lookup group may include 'World War II' relevant to the same series of %ITEMS%.
-%ITEM% Title Prefixes (!IPREFIX / %ITEM% Popup)
-%ITEM% title prefixes are words that are typically not used to index an %ITEM% using traditional library indexing rules. Typicaly for example, 'The Bible' is actually indexed as 'Bible, The' so that the most relevant alpha-numeric character is listed first. Words that should be rotated to the end of the %ITEM% title are included in this lookup list - rotation takes place automatically when creating an %ITEM%.
-%ITEM% vendor (!IVENDOR / %ITEM% Indexing)
-Original vendor (supplier) of the %ITEM%.
-System Licenses (!LICENSES / System)
-The System Licenses lookup list contains all of the licenses for system functionality that have been 'purchased' (may include free licenses) from Esferico. By default, Pergamon is provided in 'demonstrator' mode - the addition of each license into this picklist opens further functionality and removes demonstrator restrictions.
-User Permissions (!USERPERM / System)
-The user permissions lookup list contains textual descriptions of permissions that may be assigned to a user in a 'true' / 'false' manner. In this case, the SysKey field is more important that the actual textual description as it is this field that is used by the application for language-insensitive identification of each permission.
-===== Qualifiers =====
-The qualifier system is a subtle modification of item and item type relationship, which is most easily understood using an example.
-Imagine a group called 'Contributor Types', and a second group called 'Contributors'. This second group contains the names of individuals who contributed to the creation of the %ITEM%, while the first group contains the roles that they played. It is therefore possible to create a series of names who are contained within a type called 'Authors', a second series of names within a type called 'Actors' and so on. This system is that used for both the equal opportunities and %ITEM% category indexing system.
-The problem comes however, when an item may need to occupy more than one group at different times. From common knowledge it would be simple to automatically declare 'Isaac Asmimov' for example, as being an author. What is not as widely known however, is that 'Isaac Asimov' was also a prolific editor of collections and compilations. Do you therefore create 'Isaac Asimov' as being part of 'Authors' or 'Editors'?
-This is where the Qualifiers system comes in. In the same way as groupings two item type are created however in this case, one is not made a sub-group of the other. In this case, as soon as one group is changed to have a Focus of 'Qualifier', the label next to the sub-group drop-down list box changes to 'Qualifies:' allowing the user to select which item type it will qualifiy.
-No further work is required within the Manage Lookup dialog other than creating a series of qualifier %ITEMS% within this group, and a series of conventional %ITEMS% within the associated type. The reason for this is that the qualification system is designed to determine a 'group' in real-time, at the point at which the item is used.
-In the case of the above example, we would therefore have two types containing:
-Contributors: 'Isaac Asimov'
-Contributor Qualifiers: 'Author' and 'Editor'
-The actual use of the qualifier is made when attaching 'Isaac Asimov' to an item using the Manage Index %ITEMS% dialog.
-----
-Create a New Lookup Group
-he qualifier system is a subtle modification of item and item type relationship, which is most easily understood using an example.
-Imagine a group called 'Contributor Types', and a second group called 'Contributors'. This second group contains the names of individuals who contributed to the creation of the %ITEM%, while the first group contains the roles that they played. It is therefore possible to create a series of names who are contained within a type called 'Authors', a second series of names within a type called 'Actors' and so on. This system is that used for both the equal opportunities and %ITEM% category indexing system.
-The problem comes however, when an item may need to occupy more than one group at different times. From common knowledge it would be simple to automatically declare 'Isaac Asmimov' for example, as being an author. What is not as widely known however, is that 'Isaac Asimov' was also a prolific editor of collections and compilations. Do you therefore create 'Isaac Asimov' as being part of 'Authors' or 'Editors'?
-This is where the Qualifiers system comes in. In the same way as groupings two item type are created however in this case, one is not made a sub-group of the other. In this case, as soon as one group is changed to have a Focus of 'Qualifier', the label next to the sub-group drop-down list box changes to 'Qualifies:' allowing the user to select which item type it will qualifiy.
-No further work is required within the Manage Lookup dialog other than creating a series of qualifier %ITEMS% within this group, and a series of conventional %ITEMS% within the associated type. The reason for this is that the qualification system is designed to determine a 'group' in real-time, at the point at which the item is used.
-In the case of the above example, we would therefore have two types containing:
-Contributors: 'Isaac Asimov'
-Contributor Qualifiers: 'Author' and 'Editor'
-The actual use of the qualifier is made when attaching 'Isaac Asimov' to an item using the Manage Index %ITEMS% dialog.
-===== Create a New Lookup group =====
-To create a new lookup group, enter the Lookup Manager and then select [New Type] from the [Manage Lookup] menu. On selection, a new type is created in the database with the descriptive text constructed of 'NewType' followed by the date and time that you created it.
-Note that at this point, the new group is fully created in the database and is 'active' even though it has not yet been tailored for use.
-Select the new group in the list on the left hand side of the dialog in order to display the current details that are stored for the new group. At the very least, immediately change the descriptive text of the group as users will be able to see the group in other functional areas of the application very quickly. Change other details to match the nature of the group required. To save the new details, click [Update].
-===== Create a New Lookup Item =====
-To create a new item, enter the Lookup Manager and then select the group in which you wish to create the item. After selecting this item, choose [New item] from the [Manage Lookup] menu. On selection, a new item is created in the database with descriptive text constructed of 'Newitem' followed by the date and time that you created it.
-Note that at this point, the new item is fully created in the database and is 'active' even though it has not yet been tailored for use.
-Select the new item in the list on the left hand side of the dialog in order to display the current details that are stored for the new item. At the very least, immediately change the descriptive text of the item to that required. Change other details to match the nature of the item required. To save the new details, click [Update].
-Note that if you are creating a new item which is within a sub-group, the descriptive text displayed in the left-hand list is constructed of the parent-group following by two colons and then the text of the item (e.g. 'Tanks:: Chieftan'), however only the text of the item is stored in the item record - the change to the longer title is for display purposes only and for easy reference.
-===== Modify a Lookup Group or Item =====
-In order to modify the details of a group or item, enter the Lookup Manager and wait for the list of groups and %ITEMS% to be displayed.
-Select the group or item to be modified (in order to display the item, click the '+' symbol next to the name of the group in which it resides), in order to display the details of the group or item on the right hand side.
-Change the details to those required, then select the [Update] button to save the changes into the database.
-===== Remove a Lookup Group or Item =====
-In order to remove a group or item from the database, enter the Lookup Manager and wait for the list of groups and items to display. Select the group or item (items can be displayed by clicking the '+' symbol next to the group in which it resides) that you wish to remove.
-Once selected, choose [Remove current type/item] from the [Manage Lookup] menu, then select [Yes] from the confirmation dialog. Note that once removed from the database, it can never be recovered in its original format.
-**Note**: Various levels of validation may take place before you will be permitted to delete the group or item - you will only be permitted to delete some items if they are not in use, while you will only be permitted to delete a group if it no longer contains any items.
-----
-Lookup Expansion Editors
-=== Audience Advanced Editor ===
-The Audience Editor allows managerial users to specify the types of %ITEM% Audience (also called Classification) that are accessible by different types of %AGENT% Audience.
-All of the currently existing %ITEM% Audiences are displayed in a list containing checkboxes. All %ITEM% Audiences that are accessible to the current %AGENT% Audience record should be checked.
-The %AGENT% Audience settings stored in this list are utilised by functions such as the Circulations Dialog to determine whether an %ITEM% can be circulated to the specified %AGENT%.
-=== Category Advanced Editor ===
-The %ITEM% Category expansion editor provides a means by which a textual description can added to the lookup record to qualify the nature of the category.
-The only field provided is a large-quantity text field.
-=== Contributor Advanced Editor ===
-The %ITEM% Contributor expansion editor provides a means by which a textual description can added to the lookup record to qualify the nature of the contributor. It can also be used to provide background information regarding the individual.
-The only field provided is a large-quantity text field.
-=== Media Advanced Editor ===
-The media expansion editor provides a means to record a textual description of the media type in a large-quantity text field, along with information regarding how the media type is used in other functional areas.
-==== Advanced Editor ====
-The advanded editor drop-down list provides a means to select a specialised Advanced Editor type to be made available to %ITEMS% of this media type when edited within the Manage %ITEMS% dialog.
-Within the Ptolomy release of Pergamon, three Advanced Editors are currently supported: The written word editor, The moving image editor, and The audio editor.
-==== Loan Days ====
-The loan days field provides a means to specify a default number of days for which any %ITEM% of this media type should be circulated. Normally however, a duration is already specified by the Circulations Profile records. If a specific duration is not required for this media type, set the 'Loan Days' field to 0.
-==== Priority ====
-The priority check box is used to state that the value in the 'Loan Days' field should override that in the Circulations Profile. This is a rare need however, and most media types should leave this field unchecked.
-=== Groups Advanced Editor ===
-The groups expansion editor provides a means to record a textual description of the group type in a large-quantity text field, along with information regarding how the group type is used in other functional areas.
-The advanded editor drop-down list provides a means to select a specialised Advanced Editor type to be made available to %ITEMS% of this group type when edited within the Manage %AGENT% dialog.
-Within the Ptolomy release of Pergamon, only one type of specialised editor is available: The general groups editor.
-=== HID Format Advanced Editor ===
-The HID Format editor provides the means to define the contruction of Human readable Identification (HID) formats for use in creating %AGENT% and %ITEMS%. Each advanced editor record consists of three components: a prefix, a body length, and a suffix.
-Prefix
-The prefix characters form the first part of an HID as well as being the key for calculation of new HID values. If a prefix is present, it is used to identify the last entry with this format in the database prior to calculating the next new entry.
-Body Length
-The body length is entered as a number of 0 digits. When an entry is identified in the database and the next number calculted, the new number is formatted to the length of digits displayed in this field.
-Suffix
-The suffix plays no part in the calculation of a new HID within any of the functional areas but is added to the end of the HID once the HID has been calculated.
-=== Circulation Profile Advanced Editor ===
-The Circulation Profile Editor is used to create the rules by which a circulation can take place between an %AGENT% and an %ITEM%. The editor contains four fields:
-Default loan days
-The default loan days field is used to set the duration that any %AGENT% with this circulation profile is permitted to posses an %ITEM%.
-Add closure days
-The Add Closure Days checkbox is used to determine whether days are added to the normal loan duration limit if the date on which the %ITEM% is due falls on a library closure day.
-Restrict
-The restrict checkbox is used to prevent any and all circulations to %AGENT% assigned to this circulation profile.
-Media Overrides
-The Media Overrides list displays all of the media types currently configured within the Pergamon database. Clicking on any row provides a means to set an override for %ITEMS% of that particular media type.
-Any %ITEM% with an override set is permitted a loan duration equal to the value set in this list. Any media type remaining at 0, uses the standard duration set for the circulation profile as a whole.
-=== Closures Advanced Editor ===
-The closure expansion editor allows the configuration of periods of time during which the circulation facilities of Pergamon are closed. In most cases, only a single record need be created for each type of closure as the advanced editor allows closure records to be configured in such a way as to repeat at known intervals.
-==== Workstations ====
-The workstations field allows the record to be configured only for a sub-set of workstations in a multi-user Pergamon environment. Within the Ptolomy release of Pergamon, only system-wide (i.e. All workstations) can be selected.
-==== Start date ====
-The start date is used to set the first day on which the closure begins.
-==== Duration ====
-The duration field is used to set the number of days that the closure covered, inclusive of the start-date.
-==== Repeat ====
-The Repeat drop-down list is used to set whether or not, and what type of repetition is implemented for this closure day record. The repeat drop-down currently supports No Repetition (for one-off closures), Weekly, Monthly and Yearly repeats.
-==== Example closure: Weekend closures ====
-Weekend closures can be configured by creating a record with the description of 'Weekend Closures' (or a similar useful description), and then setting the duration to 2 and the repetition option to 'Weekly'.
-The 'start date' should be set to the first applicable Saturday of the period from which the weekend closure days will run. Usually, this should be set to the first Saturday of the current year.

Pergamon Wiki

User Tools

Site Tools

Differences

Page Tools