Virtua (III and VTLS) to Alma Data Delivery and Migration Guide
- A step-by-step guide to filling out the Virtua (VTLS) Migration Form.
- A list of files required from Virtua/VTLS in order to migrate your data to Alma, including information about individual fields and how they map to Alma.
- Further explanation of the migration rules for Virtua to Alma which do not require any customer input.
Recommendations for Using this Guide
- Inventory
- Fulfillment
- Acquisitions
- Physical to Electronic
- File Validation: Information on files that are expected from Virtua and where incoming fields are mapped in Alma, including functional implications.
- Migration Form: Questionnaire Tab – Instructions for individual questions asked on the Questionnaire tab of the Migration Form.
- Migration Form: Individual Tabs – Instructions for how to fill out individual tabs on the Migration Form. (Examples: Alma Library Tab, User Group Tab, PO Line Type Tab).
- Further Explanation – Explanations of migration processes that need more explanation and/or do not need customer input.
Related Documentation
- This document is intended to complement the Virtua (VTLS) Migration Form- an Excel spreadsheet that is read by the migration programs. It provides further information regarding the migration process and the steps required for migration to Alma.
- Prerequisites: Basic knowledge of Alma and Virtua key concepts and architecture, and the requirements (including the migration-related approach) described in the Getting Ready for Alma and Discovery Implementation as well as Electronic Resource Handling in Alma Migration.
- It is recommended that you view the Introduction to the Alma Configuration Process video session before completing your migration form, as the mapping and migration of libraries and locations have implications for subsequent configurations.
Migration Overview
The procedure for migrating from III/VTLS' Virtua to Ex Libris’ Alma consists of the following steps:
Data Files
- Extract the relevant data elements from Virtua into flat files (customer responsibility).
- Validate the extracted flat files using Ex Libris’ Migration File Validation Tool. Depending on the size of the extracts, customer may choose to validate small sub-set of data to ensure that the data format is valid, including the header and field information, prior to validating the entire extract.
- Also using the Migration File Validation Tool, indicate which fields from Virtua map to Ex Libris expected fields (customer responsibility). The files and field names below can be used as a reference during this process.
- Confirm that the number of records in each file, as determined by the Migration File Validation Tool, matches the number of records exported from Virtua.
- Once the files are validated and the record counts are confirmed, upload the files to Ex Libris’ MFT server, using the Migration File Validation Tool and the customer MFT credentials.
- Transform the data elements, based on the Field Mapping as indicated in the Migration File Validation Tool, into an intermediate conversion XML format (Ex Libris responsibility).
- Load the transformed data into Alma (Ex Libris responsibility).
For all files, the maximum file size is 2GB.
The Migration File Validation Tool is new in January 2019. Customers who used the legacy Field Mapping Form in their testload should continue to use it for their cutover. Check with your Ex LIbris consultant to use the Field Mapping form.
Expected Files from Virtua
Migration Form and Validation
Complete the Virtua Migration Form prior to the actual delivery of the data. The lead time depends on your project schedule. The Virtua (III-VTLS) form is used by the migration programs to convert your data for use in Alma. Therefore, it is important that the data entered by the customer is valid so that the migration can continue on schedule.
Inventory
Bibliographic Records
- Bibliographic records with embedded items – Bibliographic records are expected in MARC format. The item records associated with each bibliographic record are expected in a tag in each bibliographic record.
- Physical Inventory (item) records – Alma stores physical inventory records that are generated from the embedded items in the bibliographic record file.
- Holdings records – Alma requires MARC Holdings records. We expect to receive a MARC Holding file from Virtua that contains holdings records for some, but not all bibliographic records. For items that do not have an existing holding record, holding records are generated upon conversion from location and call number information from the item records.
- Electronic Resources (E-Resources) – Most non-Alma ILS systems store records for both physical and electronic items in the same format, which is a physical format. Alma has different record formats for electronic and physical items. Provide a list of bibliographic records that represent electronic materials so they can be converted to electronic format after migration to Alma. The possible types of electronic resources are packages, databases, and portfolios.
- Australian customers will have ALL Bibs marked for Libraries of Australia Publish, if relevant.
- OCLC records (records with an 035 |a with an OCLC-official prefix) will be marked for OCLC publish, if relevant.
- The LDR position 9 (character coding scheme) is set to a indicating Unicode.
- The Alma library is placed in the 852‡b field.
- The Alma location is placed in the 852‡c field.
Incorrect field length error in Bib Validation
There is a small problem with some end-of-field markers in Virtua which causes the bib validation to think the field is longer than the MARC record states. In this case, the validator and MarcEdit show an error like 'array field length 44 not equal to dirFieldLength', or 'Field Length doesn't match the recorded lengths'. These errors can be ignored in Virtua - the migration programs can ignore this extra character when transforming the file to marcxml.
Be sure to submit the original bib files to the MFT along with the validated file package.
Suppressed Records
Holdings
- MARC Holdings – records are delivered in MARC format. Holdings are generated for any item records with no related MARC holdings.
- From Bib – Summary statement embedded in a bib tag.
- None – No holdings records are delivered. In this case, holdings records are generated from item information.
MARC Holdings Records
Holdings from a Bib Tag – Serials
Expected Field Name | Mandatory | Notes |
---|---|---|
SUMM_TAG | Yes | Five characters; tag+2 indicators. May use # as wildcard, for example, 866## or 86#3#. Wildcard allowed for third digit and indicators but not first two digits. To indicate a space character, use b, for example 866b1. |
SUMM_SUBFIELDS | Yes | Multiple subfields allowed, e.g. abz. May use # to indicate all subfields. |
SUMM_CALLNO | No | Textual call number to be used in all newly generated holdings records if desired. |
SUMM_LIB_SUBF | No | upper level of location. Virtua has only one incoming level of location, so use this. This should be a single subfield code (like 'b') that contains a location code in local ILS format. Do NOT enter a different bib tag. The migration program searches for a subfield within the SUMM_TAG bib tag. |
SUMM_LOC_SUBF | No | do not use for Virtua migrations |
SUMM_LIB_CODE | Yes | If SUMM_LIB_SUBF is not provided or the subfield is not found, this is used for all records as a default. Provide a location code in local ILS format. |
SUMM_LOC_CODE | Yes | do not use for Virtua migrations |
SUMM_PUBLIC_NOTE_SUBF | No | Public note, will be placed in 852 $z of the generated holding record |
SUMM_NON_PUBLIC_NOTE_SUBF | No | Non-public note, will be placed in 852 $x of the generated holding record |
Holdings from a Bib tag – Non-Serial
Expected Field Name | Mandatory | Notes |
---|---|---|
HOLREC_TAG | Yes | Can be tag+indicators like 090## |
HOLREC_CALL_H | Yes | Information that will be put in 852 call number subfield h (call number first part) |
HOLREC_CALL_I | No | The rest of these are subfields for 852 - other call number parts. See http://www.loc.gov/marc/holdings/hd852.html for usage |
HOLREC_CALL_J | No | |
HOLREC_CALL_K | No | |
HOLREC_CALL_M | No |
Determining Groups for Holding Record Creation/Matching
- Item 1, 2 in Location A
- Item 3, 4 in Location B
- Item 5 in Location C
Changing the Holding Record Grouping/Matching
Call Number Type
Items
- In tags embedded in the bibliographic record. Indicate which tag contains the item on the Embedded Items section of the Migration File Validation Tool. MARC holdings are not normally expected when the items are embedded in the bibliographic record, but any type of holding can be provided (MARC or from-a-tag-in-bib).
- In a separate CSV file, containing one item record per line. Indicate the local field names of your local item CSV file in the Items section of the Migration File Validation Tool. MARC holdings may or may not be expected if the items are delivered in an external CSV file.
Items Embedded in the Bib Record
Expected Field Name | Expected Subfield | Notes |
---|---|---|
LOCATION | D | use Alma Location map. If only one level of location provided, use this one. |
Copy Number | F | |
Item Class (Item Type) | X | use Item Type map |
Item Barcode | 6 | |
Call Number 1st part | a | |
Call Number 2nd part | b | |
Accession number | e | |
Item Call Number | a | Be aware that if the 852_subfields_for_hol is set to 'bc' then the item call number may be filled in with a non-matched call number, and this field (and the next) may not be able to be used. |
Item Call Number | b | |
Item Status | s | use Item Base Status map |
Units | 9 | This is an item description, for example: Vol 1 No 12 (Dec 2017) |
RECEIVE_NUMBER | Optional - In order to use the Receiving Number in Alma, you must configure an item sequence of type Receiving Number (Config menu -> Resources -> General -> Item Sequences). See Configuring Physical Item Sequences. | |
NO_LOANS |
Optional – to pass the number of loans for the item. To see this value in Alma, search for the item under 'Physical Items' and on the results list click 'Other details'. Alma increments the loan count for items currently on loan, so it is recommended that you send (loans - 1) for currently loaned items. |
|
LastCircTransactionDate |
Optional – to pass the last loan return date YYYMMDD of the item. To see this value in Alma, search for the item under 'Physical Items' and on the results list click 'Other details'. Note: the actual field in Alma is "Last Loan Date", which is not exactly the same as the "Last Return Date". There is no "Last Return Date" field in Alma, so this is the best option for this value. |
|
Inhouse Use | Optional – to pass the number of inhouse uses (browse) for the item. To see this value in Alma, search for the item under 'Physical Items' and on the results list click 'Other details'. | |
Inventory Number | Optional | |
Weeding number | optional | |
Weeding date | optional | |
Copy ID | optional | |
CreateDate | This is used in the Arrival date. Alma requires migrated item data to use migration date as the |
Note Name | Default Local Subfield | Note Label |
---|---|---|
PUBLIC NOTE | p | Public note |
FULFILMENT_NOTE | q | Check-in note |
FULFILMENT_NOTE | r | Check-out note |
NON_PUBLIC_NOTE_1 | o | Internal Note |
NON_PUBLIC_NOTE_2 | ||
NON_PUBLIC_NOTE_3 | d | EPN |
STAT_NOTE_1 | ||
STAT_NOTE_2 | ||
STAT_NOTE_3 |
Item Statistics Notes (STAT_NOTE_*) can use controlled vocabulary when statistics_note_controlled is set to true. For more information, see Configuring Item Statistics Notes.
Items in CSV
Expected Field Name | Notes |
---|---|
ITEM_ID | |
PARENT_TYPE | Usually “Holdings”, so that the item will inherit the holding record’s library and location |
PARENT_ID | This is a Holding record id, which is only used if the customer provides MARC holding records and the items are directly linked to MARC holdings. |
BIB_ID | |
BARCODE | |
ITEM_CLASS | Use item type map (first column) |
STATUS | Use itemBaseStatus map, and item type map (second column) |
UNITS | Textual description of the item, for example, Vol. 1 No. 3 (Mar 2015) |
LOCATION | Used in Alma Location Tab, Location column |
CALL_NUMBER_H CALL_NUMBER_I CALL_NUMBER_J |
The fields here are used to construct a call number for use to either match the item to the holding record or to create a new holding record, like this: $h CALL_NUMBER_H $i CALL_NUMBER_I $j CALL_NUMBER_J If any value is not filled, the subfield indicator will not be used, so for example if you have only one call number string, put it in CALL_NUMBER_H. If a holding record is present, then the final call number string is used to match an item to a holding, if $h, $i, and/or $j are included in 852_subfields_for_hol. If a holding record is not present, then the final call number string is used when generating a holding record. Further, if only bc is used in 852_subfields_for_hol, then this call number string could* be placed in the ITEM_CALL_NUMBER field when multiple items are grouped together into a single holding record. * 'could' because ItemCallNumber will be placed in ITEM_CALL_NUMBER if present. If ItemCallNumber is NOT present, then this call number string is placed in the ITEM_CALL_NO according to the descriptions in "Determining Groups of Holding Records" and "Changing the Holding Record Grouping" sections below. |
ItemCallNumber |
If this is present, then the value will be placed in ITEM_CALL_NUMBER. This value takes precedence over a possible value from the call number string constructed from CALL_NUMBER_H, CALL_NUMBER_I, and CALL_NUMBER_J, according to the descriptions in "Determining Groups of Holding Records" and "Changing the Holding Record Grouping" sections below. |
SHELFLOCATION | If this location is different than the LOCATION, then this will be set as the item's temporary location. If your library does not operate this way and SHELFLOCATION is simply the only location, then put SHELFLOCATION in the LOCATION field in the Migration File Mapping tool, and do not provide a mapped field for SHELFLOCATION. |
CIRCCOUNT | |
INHOUSE_USE | |
copyNumber | |
INVENTORY_NUMBER | |
lastInventoryDate | |
Weeding Number | |
Weeding Date | |
The same Virtua field may be mapped to both PURCHASE_PRICE and REPLACEMENT_COST, if desired
|
|
PURCHASE_PRICE | Inventory price |
REPLACEMENT_COST | Use this only if the value is an actual replacement cost, which is used as a fine amount for a lost item |
Note Name | Local Field Name | Note Label |
---|---|---|
PUBLIC NOTE | NUMBER_OF_PIECES | Public note |
FULFILMENT_NOTE | PUBLIC_NOTE | Check-in note |
FULFILMENT_NOTE | Check-out note | |
NON_PUBLIC_NOTE_1 | STAFF_NOTE | |
NON_PUBLIC_NOTE_2 | ||
NON_PUBLIC_NOTE_3 | EPN | |
STAT_NOTE_1 | ||
STAT_NOTE_2 | ||
STAT_NOTE_3 |
Item Statistics Notes (STAT_NOTE_*) can use controlled vocabulary when statistics_note_controlled is set to true. For more information, see Configuring Item Statistics Notes.
Enrich Items with Information from 853/863 from MARC Holdings
- The barcode in the 863 $p of the holding record must match the barcode in the item.
- Attach the item to the holding record with the corresponding 863 $p. (We are not going to go looking for an 863 $p. We expect it to be on the attached holding.)
- If there are multiple 853s in a single holding record, the $8 is used to link between the 853 and its 863s.
- The description is generated as follows: 853 $a + 863 $a + 853 $b + 853 $b etc., for all of the subfields abcdefghijklm. Spaces are placed between the data elements for readability. When there are parentheses around the word in the 853, do not show the word.
- The original 853/863 is left in the holding record when it is loaded into Alma, but the 863s will no longer be used (you are encouraged to remove them post go-live). The 853 may be used in the future for serial prediction.
Secondary Item File
You may want to provide item descriptive information in a secondary file. For example, you have a description in the format Vol. 12 No. 2 (2015 February), but Alma recommends that enumeration and chronology information are without labels and are in separate fields. You can provide your description in a secondary item file.
With the exception of the item_key and barcode, all other fields will force blank if an empty field is provided. In other words, if you have an item description in Alma, and you provide a blank description in this file, the incoming blank will be 'written' to Alma, meaning the Alma description will be deleted.
We recommend that EnumX and ChronX fields contain only numbers, for example '12' instead of 'Vol. 12' and '2' instead of 'Feb'. However, it is programmatically time-consuming to distinguish between an invalid use (Vol. 12) and a valid use (12A), so in the interest of processing quickly, we allow any string in EnumX and ChronX fields. Do not provide a full date in a single field. Split any dates into three, for example 4 Feburary 2020 is ChronI=2020, ChronJ=2, ChronK=4.
Even though it is not recommended, if for any reason you need to provide a full date in a single field, put a tick (') before the date in the Excel cell so that it is treated like text (instead of the Excel date format).
Provide the secondary item file in Excel format (xls or xlsx) format, with the following fields:
Expected Field Name | Notes |
---|---|
item_key |
Provide either item_key or barcode, but not both. If both are provided, item_key is preferred Always provide both fields, even when one is empty. E.g. |
barcode | |
description | Provide in a format such as: Vol. 12, No. 6 (February 2015) |
enumA | For example, “12”. |
enumB | For example, "6". |
enumC | |
enumD | |
enumE | |
enumF | |
enumG | |
enumH | |
chronI | For example, "2015" |
chronJ | For example, "2". |
chronK | |
chronL | |
chronM |
Item Barcodes
- If the barcode is empty, leave as empty in Alma.
- If the barcode exists, but is not unique:
- First item barcode encountered – migrate as is.
- Second and subsequent item barcodes encountered – migrate as <barcode>-<itemID>
Because it is possible to use the barcode as the link between item and loan, request, or fine, if one of those is linked to an item with a duplicated barcode, it will be linked to the item with the unsuffixed barcode.
Material Type
Areas/Fields Not In Scope
Inventory – Migration Form
Questionnaire Tab
Institution Code, Customer Code, Institution Name, Customer Name, Time Zone
List Prefix for bibs from SFX or other management system
MARC Organizational Code
Do you use internal system numbers in Linked Entry fields?
Indicate if you use internal system numbers in linking fields. Internal system numbers from your legacy system are not continued in Alma, and therefore should be changed to MMSID (the Alma internal system number).
MARC fields: $w subfield for tags 76x-78x, 80x, 81x, and/or 83x
Unimarc fields: $1 subfield with prefix 001 for fields 423, 461, 462, 463, 464 [example: bib key 99999 in tag 461 = 461 $100199999]
Code: LINKED_ENTRY_W
Default: No
Options: If you answered Yes to this question, the internal system numbers in the subfield $w or $1001 of the specified tags are converted from the former system number to the Alma system number.
Internal record designation for Linked Entry fields $w
Code: LINKED_ENTRY_PREFIX
Default: Blank
Options: If you answered Yes to the previous question and the internal system numbers have a prefix, enter the value to be matched to identify the local system number. If the system numbers in $w or $1001 do not have a prefix, or if you answered No to the previous question, leave this question blank.
Further information on LINKED_ENTRY_W and LINKED_ENTRY_PREFIX: When bibliographic records are related to each other, such as a journal title that is superseded by a second journal title, your previous ILS may store the information in bibliographic fields 76x-78x, 80x, 81x, and 83x $w for MARC, and 423, 461, 462, 463, 464 for Unicode. If the number in the $w or $1001 of the linking tags is the internal legacy ILS system number, these numbers must be changed to the Alma representation of the system number. If your library does not use the internal system number to link and instead relies on more general identifiers such as the ISBN, ISSN, or shared cataloging DB (OCLC or DLC), these numbers are not modified.
In Alma, the system numbers in the linking field are used to link two related bibliographic records together using the related records process. Related records can be found by clicking the More Info link on the Alma Search Results page. For more information on configuring related records, see Configuring Related Records for Physical Inventory.
Indicate which 852 subfields to use to determine unique holding records
Do you want to use a call number in the generated holdings records?
Code: CALL_NO_IN_HOL
Default: Yes
Options: Yes or No
Further Information: You may choose to generate holding records without any call number, so that the 852 contains only $b (library) and $c (location). Values in the incoming Item Call Number field are placed in the Alma Item Call Number, and AltCallNo is not used when this is set to Yes. Further, customers should only use ‘bc’ for the 852_CALL_NO_FOR_HOL question when this is No.
Move 852$c to Another Subfield
Limit exported records by location
Bib Key Prefix
Add institution suffix to Bib ID
Code: BIBID_INST_SUFFIX
Default: No
Options: When moving the legacy bibliographic identifier to the 035 or 935, you can choose to add the institution code to the end of the string, like 12345-34ABC where 12345 is the legacy bib ID and 34ABC is the institution code. This may be used in conjunction with other bib identifier options, such as BIB_KEY_PREFIX and MARC_OC.
Yes = include suffix
No = do not include suffix
Move 001/003 to 035 or 935
Code: 001_035_935
Default: 035
Options: If your incoming bibliographic records have a number in the 001, then the migration programs move it elsewhere as (<003>)<001>. For example: (OCoLC)12345. To move to the 035, which is the default, then select 035 in the dropdown. If you are part of a consortium and are using OCLC numbers to determine matching records when linking to the NZ, you may wish to move this number to the 935 so that the moved number does not interfere with another matching key you may be using. If you are not linking to the NZ, then this question is likely not useful. Default: 035
Ex Libris marks the moved 035 or 935 with $9 ExL to indicate that the migration programs generated this field.
Further information: If an 035 exists in the record already with the identifier that was in the 001, then a second (duplicate) tag is NOT made. Also, when checking if the identifier already exists, the migration programs compare to the $a only. Meaning, if an existing tag contains
001 12345
003 OCoLC
035 $a(OCoLC)12345 $z (OCoLC)54321
then the existing 035 $a is considered a duplicate and a second tag is not created.
Use subfield indicators in item call number (AltCallNo)
Code: ITEM_CALLNO_SUBFIELD
Default: Yes
Options: When generating an Item Call Number field (also known as AltCallNo), you can decide if the string contains subfield indicators. Default = Yes
Yes = $h PZ3.A93 Pr16 $i A975
No = PZ3.A93 Pr16 A975
For more information on when an Item Call Number is generated, see the section Changing the Holding Record Grouping, which depends on the question 852_SUBFIELDS_FOR_HOL.
Add $9 LOCAL to specified tags
Code: NZ_LOCAL_TAGS
Default: empty
Options: Add $9 LOCAL to specified bib tags, for use in consortia where an IZ environment links to an NZ. Tags marked as Local will be kept in the IZ, and not moved to the NZ.
Format for this input: tag + indicator. Use # for any/wildcard, and b for the space character. Separate with semicolon.
Example: 59###; 69###;960##;970##;090b#
The wildcard works only for the third digit of the tag and the indicators. Examples:
CORRECT: 95###
INCORRECT: 9####
Also, 900-949 cannot be used here, as described in the Migration Considerations for Consortia guide
Alma Library Tab
Alma Location Tab
ALMAME_VALUE_NOT_FOUND
Virtua Upper Level Location | Virtua Lower Level Location | Alma Library | Alma Location Code | Alma Location Desc | Alma External Loc Desc | etc |
---|---|---|---|---|---|---|
ALMA_ME_ VALUE_NOT _FOUND | MAIN | UNASSIGNED | Problem location from Migration | Problem: See Library Staff |
Alma Location Name and Alma External Location Name
Library | Alma Location Code | Alma Location Name | Alma External Location Name |
---|---|---|---|
Library A | stacks | Main Stacks | Main Stacks |
Library B | stacks | Main Stacks | Main Stacks |
Library A | archa | Archives A | Archives |
Library B | archa | Archives B | Archives |
Library A | archstk | Archives Stacks | Archives |
Library A | archref | Archives Reference | Archives |
Library | Alma Location Code | Alma Location Name | Alma External Location Name |
---|---|---|---|
Library A | archstk | Archives | Archives |
Library A | archref | Archives | Archives |
- The Alma library is placed in the 852‡b field.
- The Alma location is placed in the 852‡c field.
Collapsing Locations
Virtua Upper Level Location | Virtua Lower Level Location | Alma Library | Alma Location Code | Alma Location Name | Alma External Loc Name | Suppress from Externalization | Electronic Location |
---|---|---|---|---|---|---|---|
MAIN | reserves | MAIN | RESERVES | Reserves | Reserve | Yes | No |
MAIN | reservesElec | MAIN | RESERVES | Reserves | ReserveElec | Yes | Yes |
MAIN | reservesShort | MAIN | RESERVES | Reserves | Reserve | Yes | No |
MAIN | reservesPerm | MAIN | RESERVES | Reserves | Reserve | Yes | No |
Item Base Status Tab
Item Type Tab
Fulfillment/Patrons
- Patrons – generated from a patron extract from Virtua. In order to migrate any area of fulfillment (fines/ fees, loans, requests), all patrons must be migrated.
- Loans – generated from the circulation transaction extract for active loans only.
- Hold requests - provide only active hold requests where the item is on the hold shelf waiting to be picked up.
- Fines/Fees - active (open) transactions only
Ex Libris does not expect to receive course reserve information. If your library wants to migrate course details, consult your Ex Libris project manager.
Patrons
Patrons
Field Name | Notes |
---|---|
PatronId | |
NameLast | |
NameFirst | |
NameMiddle | |
NameTitle | |
Organization | Also known as: Home Library or Institution Name. This is used in the Campus Code map |
PatronCode | use in user group map |
ExpirationDate | |
LastActivityDate | |
RegistrationDate | this is moved to a note; Alma sets the create date to migration date for all migrated patrons. |
BirthDate | |
EMailAddress | In the Validation tool, select email address type: Personal, School, Work, All |
AltEmailAddress | In the Validation tool, select email address type: Personal, School, Work, All |
UpdateDate | |
Phone1, Phone2, Phone3, Phone4, Phone5 | Up to five different phone numbers are allowed in migration. For each phone, select a type: Home, Mobile, Office, OfficeFax, All |
Language | Expected in a two-letter code as defined in ISO 639-1. Consult the codes from https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes. |
Gender | |
UNIV_ID |
Identifiers may be assigned here or in the patron barcode file, below. It is unlikely that BAR is used in this file, but just in case you store your barcode here, it is available. After assigning identifiers to the list of identifiers used in Alma migration, select the primary ID on the questionnaire tab, using one of the identifier names on the left. |
BAR | |
ADDL_ID_1 | |
ADDL_ID_2 | |
ADDL_ID_3 | |
ADDL_ID_4 |
Patron Address
Field Name | Notes |
---|---|
PatronId | required to link to the main Patron file |
AddressType | Incoming values in VTLS are: "Primary" and "Secondary". When the value here is "Primary", then the Alma Preferred Address flag is set to 'true'. |
StreetOne | |
StreetTwo | |
City | |
State | |
PostalCode | |
Country | The migration programs do not make an attempt to standardize the country field. |
Patron Barcode
Field Name | Notes |
---|---|
PatronId | required to link to the main Patron file |
Barcode | This is likely the only identifier assigned in this file, but all identifiers are availble if needed. |
BarcodeType | Primary or Alternate |
Barcode Note | Any fields not assigned above may be placed in the barcode note. |
Patron Block
Field Name | Notes |
---|---|
PatronId | required to link to the main Patron file |
BlockCode | use in userBlock map |
ExpireDate | |
Note |
Patron Notes
Field Name | Notes |
---|---|
PatronId | required to link to the main Patron file |
NoteType |
Currently, all notes are assigned to the same type of note. Inform your Ex Libris representative what type of note should be used here. The options are: LIBRARY_NOTE |
TypeofAlert | not currently functional |
Note Name | Default Local Field |
---|---|
LIBRARY_NOTE | NOTE |
LIBRARY_NOTE | NOTE_TYPE |
BARCODE_NOTE | |
ADDRESS_NOTE | PREFIX |
ADDRESS_NOTE | NOTICE_DELIVERY_PREF |
ADDRESS_NOTE | |
CIRC_NOTE | CIRC_NOTE is marked by the migration programs as a popup note. This is the only user note which migration marks as a popup note. |
OTHER_NOTE | This note is marked as user viewable by migration. This is the only note which migration marks as user viewable. |
User Stat Categories
There may be a number of fields in the patron record that function as a statistical category only, for example, a student’s department or major. The way the student borrows can be determined by the PATRON TYPE, but you may want to track the department, so that you can get more detailed statistics on how Law students borrow, for example. We provide you the option to map the data from any field to the User Statistical Categories in Alma.
If you have categories which overlap, such as LAW as department and LAW as major, you can prefix the category in the Migration File Validation tool, using the 'prefix' input box to the right of the mapped field. For example you can say DEPT: LAW and MAJ: LAW. The validation tool will not provide a colon, so if want the colon be sure to include it , e.g. 'DEPT:', but it does provide a space between the label and the value.
If you use this prefix, be sure to use the prefix again in the Migration Form Mapping tab for User Stat Categories, in column A (incoming data).
You may provide up to 10 statistical categories.
In the Migration File validation tool, provide labels to the right of the field:
Then, in the migration form, use that label as a prefix to the values in the field. Be sure to put a space between the label and the code:
In the case above, you can see that if there were no prefix to the fields, it would not be possible to distinguish between 'b' from PC1 and 'b' in PC2.
Identification Numbers
A | B | C |
---|---|---|
|
UNIV_ID |
|
BARCODE |
BARCODE |
BAR |
|
ADDL_ID_1 |
|
|
ADDL_ID_2 |
|
|
ADDL_ID_3 |
|
|
ADDL_ID_4 |
Active Loans
Field Name | Notes |
---|---|
BARCODE | matches barcode |6 in bib/item file |
CHECKOUT_DATE | |
DUE_DATE | |
PATRON_ID | matches PATRON_ID in patrons |
Renewals | This value is only checked to set the loan status (if number > 0, then status = RENEWED). If you want to keep the original number of renewals, also put this value into a note. |
Note Name | Default Local Field |
---|---|
NON_PUBLIC_NOTE | CHECKOUT_LOCATION |
NON_PUBLIC_NOTE | NAME |
NON_PUBLIC_NOTE | LOCATION |
NON_PUBLIC_NOTE | SHELFLOCATION |
NON_PUBLIC_NOTE | CHECKOUT_TYPE |
NON_PUBLIC_NOTE | LAST_NOTICE_DATE |
Fines/Fees
Field Name | Notes |
---|---|
ITEMID | Matches item ID in item file |
BALANCE | |
DESCRIPTION | Use in Fine Fee Type map |
ITEM_DUE_DATE | This is mapped to the Alma Fine Fee Create Date. Alma does not store the Item Due Date in the fine. |
LOCATION_ID | |
PATRON_ID | Matches user ID in patron file |
Note Name | Default Local Fields |
---|---|
FINE_FEE_COMMENT |
Requests
Field Name | Notes |
---|---|
ITEM_ID | Matches item ID in items |
LOCATION | |
DATE_PLACED | |
PATRON_ID | Matches user ID in patrons |
DATE_SET | Date item was trapped and placed on hold shelf |
EXPIRATION_DATE | If no local field, then put a constant for the number of days after DATE_SET for expiration. For example, if you put '10' then the expiration date will be 10 days after the DATE_SET |
Note Name | Default Local Fields |
---|---|
NON_PUBLIC_NOTE |
Courses
Courses are migrated if the customer purchased the Premium migration package.
Courses are typically delivered in three csv (quotes/commas) files: Reserve List, Reserve Items, and Reserve Instructor. They are all joined by the ReserveListId.
Reserve List
Field Name | Notes |
---|---|
ReserveListId | links to ReserveItem and ReserveInstructor files |
CourseId | Course code |
Section | |
CourseTitle |
Reserve Items
Field Name | Notes |
---|---|
ReserveListId | Matches reserve list ID in Reserve List file |
ItemId | Matches an ItemId in the provided item file. In Alma, the reserve list is managed at the bibliographic level, so this item id is translated to the related bib ID for migration into Alma. |
BeginDate | course start date. This is required in Alma; if not supplied the migration date is used. |
EndDate | course end date. This is required in Alma; if not supplied the migration date + 1 year is used. |
ReserveState | status of the reserve item |
Reserve Instructor
Field Name | Notes |
---|---|
ReserveListId | Matches reserve list ID in Reserve List file |
PatronId | links to a patron record |
Fulfillment/Patrons – Migration Form
Questionnaire Tab
Which identifier should be used as the patron's Primary Identifier?
How should we handle duplicate identifiers in the same patron?
Code: DUP_ID_SAME_PATRON
Default: DISCARD
Options: Alma does not allow duplicate identifiers anywhere, even in the same patron. If the patron has the same number in two or more different identifier types, we can either not migrate the second one, or disambiguate it with -1, -2 etc.
DISCARD: do not migrate the second and subsequent identifiers
ADD_SUFFIX: add -1, -2, etc
Default: DISCARD
Enter a two-letter code for the default conversational language for your users (for example en or fr)
Currency for patron fines
Use a map for the HOME_LIBRARY to campus code migration?
Request Default Destination Library
Merge Patron Prefix
Code: MERGE_PATRON_PREFIX
Default: No
Options: If you are combining data from two or more separate databases into a single combined institution in Alma, then indicate a prefix here that will be used to distinguish the incoming patron record original IDs. This prefix is only added to the internal patron identifier, it is not added to barcodes or usernames or UNIV_ID. If you are not merging institutions, leave this question blank.
See also: BIB_KEY_PREFIX and FUND_PREFIX
User Group Tab
- Which identifier should be used as the patron's Primary Identifier?
Campus Code Tab
Fine Fee Type Tab
Acquisitions
- Vendors – migrated from the vendor extract.
- Funds – generated for the current fiscal year based on a single list of funds; allocation transactions are generated for the current fiscal year only.
- Purchase Orders – migrated from the purchase order extract. Encumbrance transactions are generated for the current fiscal year only.
Vendors
Field Name | Notes |
---|---|
VENDOR_ID | |
NAME | |
ADDRESS_1 | |
ADDRESS_2 | |
ADDRESS_3 | |
CITY | |
COUNTY_OR_PARISH | |
STATE_OR_PROVINCE | |
POSTAL_CODE | |
COUNTRY_CODE | |
TELEPHONE_NUMBER | |
FAX_NUMBER | |
CONTACT | not repeatable |
EMAIL_ADDRESS | |
CLAIM_INTERVAL | |
ORDER_LEAD_TIME | |
PREFERRED_LANGUAGE | |
URL | |
FINANCIAL_SYSTEM_CODE |
Note Name | Default Local Fields |
---|---|
VENDOR_NOTE | CLAIM_INTERVAL |
VENDOR_NOTE | RECLAIM_INTERVAL |
VENDOR_NOTE | ORDER_CURRENCY |
VENDOR_NOTE | INVOICE_CURRENCY |
VENDOR_NOTE | PAYMENT_CURRENCY |
Funds
Field Name | Notes |
---|---|
LEDGER CODE | May be repeated across lines to group funds under a single ledger |
LEDGER NAME | May be repeated across lines to group funds under a single ledger |
SUMMARY FUND CODE | Not mandatory, may be repeated across lines |
SUMMARY FUND NAME | Not mandatory, may be repeated across lines |
FUND CODE | Alphanumeric, not repeatable (This is the fund code that links to the fund code in the extracted order record.) Must be unique, even across ledgers. |
FUND NAME | Alphanumeric, repeatable |
LIBRARY | Must be in the Alma Library List on the Virtua Migration Form. The library code must match the code in the migration form exactly – match is case-sensitive. There can be multiple libraries here, separated by a semicolon. This field can be left empty, which means that all libraries in the institution can use the fund.
If the central order library is used in the migration form, this field is ignored and all funds are set to the institution level, meaning that all libraries in the institution can use the fund.
|
EXT ID | External ID for linking to an external source, if one exists. |
ALLOCATION | Allocation, in dollars, of the current fiscal year’s funds. |
FY | Fiscal Year YYYY |
NOTE | optional note for the fund |
Encumbrances
Transactions of Amount 0.00
Orders
Field Name | Notes |
---|---|
PURCHASE_ORDER_ID | Purchase order header number. It is used to group multiple purchase order lines together. |
BIBLIOGRAPHIC_ID | |
PRICE | |
DATE_DUE | |
QTY_ORDERD | |
CURRENCY | |
QTY_INVOICED | |
SUBSCRIPTION_BEGINS | |
SUBSCRIPTION_ENDS | |
CANCEL_DATE | |
FUND CODE | Links to a fund code in the fund file. This can be provided in multiples, separated by a semicolon. For example: “...”,“fund1”;”fund2”;”fund3”,”…” |
LOCATION_ID | |
INTERNAL_LINE_ID | Purchase order line number. |
ORDER_STATE | Use in the PO Entry Point map |
VENDOR_ID | Links to the vendor ID in the vendor file. |
ORDER_TYPE | Use in the PO Line Type map |
REQUESTOR_ID | Only provide a local field name here if the local field contains an identifier that links to the patron file. Otherwise, put the information in the notes. |
ACQ_METHOD | This must either contain Alma Acq Method values of PURCHASE, APPROVAL, GIFT, VENDOR_SYSTEM, DEPOSITORY, EXCHANGE, TECHNICAL, LEGAL_DEPOSIT, or be left blank. If blank, all are set to PURCHASE. |
ACCOUNT_PERCENT | Percentage of fund distribution. When there is one fund code, this is assumed to be 100 percent. When there are multiple fund codes, the number of values should match the number of values in FUND_CODE. For example: “...”,“25”;”25”;”50” |
REPORTING_CODE_1 |
Use the PO Reporting Code map to map values to the Alma Reporting Code field. The values in columns C and D are used to make the 1st Reporting Codes code table. No prefix is necessary here since the PO Reporting Code map allows only one incoming value. Note: this needs to be manually filled in until the Migration File Validation Tool is updated. |
REPORTING_CODE_2 |
Use the PO Reporting Code 2 map to map values to the Alma Reporting Code 2 field. The values in columns C and D are used to make the 2nd Reporting Codes code table. No prefix is necessary here since the PO Reporting Code 2 map allows only one incoming value. Note: this needs to be manually filled in until the Migration File Validation Tool is updated. |
REPORTING_CODE_3 |
Use the PO Reporting Code 3 map to map values to the Alma Reporting Code 3 field. The values in columns C and D are used to make the 3rd Reporting Codes code table. No prefix is necessary here since the PO Reporting Code 3 map allows only one incoming value. Note: this needs to be manually filled in until the Migration File Validation Tool is updated. |
Note Name | Default Local Field |
---|---|
POL_VEND_REF_NO | This line cannot be duplicated; place only one local field name here. |
POL_ADDL_NO | This line cannot be duplicated; place only one local field name here. |
POL_RECEIVING_NOTE | This line cannot be duplicated; place only one local field name here. |
PO_NOTE | INTERNAL_PURCHASE_ORDER_ID |
PO_NOTE | VENDOR |
PO_NOTE | PURCHASE_REQUEST_STATUS |
POL_NOTE | SUBJECT_CODE_ID |
POL_NOTE | SUBJECT |
POL_NOTE | ISBNISSN |
POL_NOTE | TITLE |
POL_NOTE | AUTHOR |
POL_NOTE | PUBLISHER |
POL_NOTE | PLACE_OF_PUBLICATION |
POL_NOTE | PUBLICATION_DATE |
POL_NOTE | MUSIC_NUMBER |
POL_NOTE | PRIORITY |
POL_NOTE | QTY_PAID |
POL_NOTE | COVERAGE |
POL_NOTE | HOLDINGS_ID |
POL_NOTE | REQUESTOR_ID |
POL_NOTE | REQUESTOR |
POL_NOTE | SOURCE_ID |
POL_NOTE | SOURCE_OF_SELECTION |
Orders from the HOL Tag
Field Name | Notes |
---|---|
$a Vendor-ID | Purchase order header number. Used to group multiple purchase order lines together. |
$b Vendor Title Number | |
$c P.O. # | |
$e Order Date | |
$i Claim Interval | |
$m Subject Code | |
Defaults: There are no inputs expected from the data, so all orders will have the same selected value. Select from the available choices from the drop-down lists. | |
Acquisition Method | PURCHASE, APPROVAL, GIFT, VENDOR_SYSTEM, DEPOSITORY, EXCHANGE, TECHNICAL |
PO Line Entry Point | NEW, SENT, CLOSED, CANCELLED |
PO Line Type | PRINTED_BOOK_OT, PRINTED_JOURNAL_CO, PRINTED_BOOK_SO, PRINT_OT, PRINT_CO, PRINT_SO, PRINT_SO_NONMON, OTHER_SERVICES_OT, OTHER_SERVICES_CO |
Subscription Interval | Constant (days) |
Expected Receipt Date | Constant (date) |
Notes
Note Name | Default Local Field |
---|---|
POL_NOTE | |
POL_NOTE | |
POL_NOTE |
Acq - Further Information
POL Copies/Inventory Handling
- One Time Orders
- One time orders generally do not link to any specific item in source ILS systems. Only with a specific item id in hand can the location/copy information on such POLs be created.
- Since there is generally no such connection, we pass only the intended library/location and quantity in the POL receiving note, which most source systems do provide. This information allows the receiving/purchase operator upon receipt to:
- Open the POL and add the relevant copy which is being received - presuming the item wasn't created prior to the receipt.
- At this point, the item can be received normally.
Less common case instead of 2a. in case the item was pre-created before receipt, open the item editor and link to the relevant POL, then proceed to step 2b. - Ongoing Continuous/Subscriptions/Non-monographic Standing Orders
These order types often link to a specific holding record in source ILS systems. If they do, receiving occurs in Alma as usual. This is why a location/copy for continuous orders (which means an actual holdings record ID association was made to the order) are related to such orders.
- Alma supports only one order line per holding, while source systems may allow more than one order per holding. Therefore, in migration processing, the most recent open order is chosen for holdings that has more than one order line reference.
- Older orders will not have copy information and will also not undergo P2E.
- Some orders do not have any holding relationship in the source system.
- If the holding to receive upon exists – From the holding editor, link the holding to a specific order (taking into account that it is limited to one order from that holding).
- If the holding to receive upon does not yet exist – From the PO line edit page, select Add holding/copies to create and link a new holding to the order. This allows the receiving of new items.
POL Material Types
PO Invoice Status
- NO_INVOICE
- PARTIALLY_INVOICED
- FULLY_INVOICED
PO Acquisition Method
- PURCHASE
- APPROVAL
- GIFT
- VENDOR_SYSTEM
- DEPOSITORY
- EXCHANGE
- LEGAL_DEPOSIT
"In Review"
The migration programs fill out the following elements based on incoming data:
- PO Line type
- PO Entry Point
- PO Invoice Status
- Send date
- Expected receiving interval/date
Alma can have a further status of 'In Review'. Migration does not set the 'In Review' status, but rather the 'In Review' status is set by a series of rules using the elements above and possibly other elements. The initial set of rules used to determine these further statuses is not controlled by the customer; it is controlled by Alma Development. Customers are often frustrated by the statuses set for NEW orders:
- when NEW and OT (one time), the status is set to 'In Review'
- when NEW and CO or SO (continuous), the status is set to 'Waiting for Renewal'
You can find out more about the PO Review Rules, and how to turn rules on or off, by consulting the page Configuring Purchasing Review Rules.
Acqusitions – Migration Form
Questionnaire Tab
ACQ mode
Central or Default Order Library
Options for Central and Default Order Library: The LIBRARY_ID field specifies the order location for orders in Virtua. The migration attempts to map the LIBRARY_ID field to the corresponding Alma Library. Select only one of the following choices - either Central or Default, but not both.
Very briefly, filling in Central says: use this library for all orders, regardless of what is in the order. Filling in Default says: try to get a library from the order first, and if you can't then use this default library instead
Central Order Library
Code: CENTRAL_ORDER_LIB
Default Order Library
What is your currency?
Enter a default language of conversation with vendors
Fiscal Period Cycle Pattern
Which year do you use to name the fiscal year?
- second – if fiscal period runs July 1 2014 through June 30 2015, then the fiscal year is named 2015.
- first – if fiscal period runs July 1 2014 through June 30 2015, then the fiscal year is named 2014.
Current Fiscal Year
- Determine by date of conversion – The conversion program uses the fiscal period that includes the date of conversion.
- 2013-2014 – Select this option if the date of conversion is later than the fiscal period to which you want your orders to migrate. For example, if the migration date is July 3, 2014, and the previous fiscal period ended on June 30, 2014, select this to put all of your orders in the fiscal period that ended on June 30, 2014. Select this option if you want to run fiscal period close in Alma instead of in your old system.
- 2014-2015 – If the date of conversion is earlier than the start date of the desired fiscal period, select this option. For example, if the migration date is June 15, 2014, and the next fiscal period begins on July 1, 2014, select this option to put all of your orders in the next fiscal period. Select this option if you want to perform the fiscal period rollover in your legacy ILS prior to conversion.
Accrual Accounting
- No, do not make an additional fiscal year.
- Yes-No Funds – make an additional fiscal year but leave it empty. The library will then need to create funds for this fiscal year after go-live.
- Yes-duplicate funds – make an additional fiscal year and also fill it with funds that are the same codes as the funds in the current fiscal year. No allocations are made.
Default claiming period
Renewal Date for Serials Subscriptions
Fund Prefix
Currency Code Tab
PO Line Type Tab
- PRINT_OT – printed book one time. This is used for one time or infrequent orders of specific items, for example, a printed book, E book, or a musical score, that is not published repetitively. The order is at the item level. If the only physical items that you order are books, this type is essentially the same as Print Book - One Time.
- PRINTED_BOOK_OT: Print Book One Time
- PRINT_CO – journal/continuation. This is used for orders that are repeated on a regular basis. An example is monthly subscriptions to physical or electronic material such as journals. The order is at the holding level, and items in the holding record are received periodically.
- PRINTED_JOURNAL_CO: Print Journal - Subscription
- PRINT_SO – standing order monograph. This is used for orders that are not repeated on a frequent or regular basis. For example, this type of PO line is used for purchasing all the printed books by a particular author when they are published or where a series of books are being published, but not necessarily on a regular basis. The receipt of new material involves a new bibliographic, holdings, and item record. If the only physical items that you order are books, this type is essentially the same as Print Book - Standing Order.
- PRINTED_BOOK_SO: Print Book – Standing Order
- PRINT_SO_NONMON – Standing Order Non-Monograph – Similar to continuous orders.
- OTHER_SERVICES_OT: Other Services One Time – Various non-inventory orders for services purchased from a vendor. Both one-time behavior and repetitive behavior are available. This should only be applied to orders without inventory. For electronic resources, see PO Line Types and Electronic Orders.
- OTHER_SERVICES_CO: Other Services Subscription. This should only be applied to orders without inventory. For electronic resources, see PO Line Types and Electronic Orders.
PO Line Types and Electronic Orders
PO Entry Point Tab
- blank – any line type is fine
- *OT – One-Time (monographic) line types
- *SO or *CO – Standing Order or Continuous Order (Serial) line types
- NEW – The order has been created, but not sent to the vendor yet. Orders can have status NEW for years while librarians are reviewing what to order, or they can have status NEW for a short while if the acquisitions staff created the order to send to the vendor immediately.
- SENT – The order has been sent to the vendor and funds have been encumbered/committed. The item has not been received yet for one-item orders, or the item has been received for continuous orders. Continuous orders that continue to be invoiced/received remain with SENT status (which can be considered as a sub-status of waiting for renewal within Alma) until they are closed.
- WAITING_FOR_INVOICE – Use only for one-time orders. The item has been received, but not the invoice. Invoice status must not be FULLY_INVOICED.
- CLOSED – The order has been received and invoiced. Nothing else will be received on this order. (Do not use for open continuous orders that you are still receiving.)
- CANCELLED – Cancelled order.
PO Reporting Code Tabs
Use these tabs if you wish to map values from Virtua to the Alma Reporting Code fields. These tabs are not required.
When an encumbrance transaction is created in Alma, the acquisitions staff can classify the transaction with a reporting code. Later, reports can be used to retrieve transactions with the same reporting code. Reporting codes are often (but not always) used to classify a purchase as serial, monograph, or electronic, for state or nation-wide reporting purposes.
Virtua incoming field: The value in the incoming Virtua field. A typical incoming field is $m Subject Code.
Description: A description of the incoming field, for information only. This field is not used in the mapping.
Alma Reporting Code: The desired code value for the reporting code in Alma. You may choose to collapse incoming values if desired.
Alma Reporting Code Description: The name for the reporting codes in Alma. This field is used to create a code table that is loaded into Alma. This value can be easily changed after migration.
Further Information: Alma has three Reporting Code code tables: 1st Reporting Code, 2nd Reporting Code, and 3rd Reporting Code. The three mapping tabs correspond to the respective code tables.
REPORTING_CODE_1 (Virtua) -> PO Reporting Code Tab -> 1st Reporting Code code table
REPORTING_CODE_2 (Virtua) -> PO Reporting Code Tab 2 -> 2nd Reporting Code code table
REPORTING_CODE_3 (Virtua) -> PO Reporting Code Tab 3 -> 3rd Reporting Code code table
Since each incoming field from Virtua maps to a single mapping tab and code table, a prefix is no longer necessary to distinguish between different incoming values.
Physical to Electronic (P2E) Processing
Questionnaire Tab
- Specific indicators: 85641u – only tags with 41 as the indicator is used.
- No indicator (# is used for a blank character, for example: 8564#u) – only tags with 4
as an indicator are used. - All possible indicators: 8564*u – tags with 4 as the first indicator are used. The second indicator is not taken into account.