WMS (OCLC) to Alma Data Delivery and Migration Guide
Migration Overview
- A step-by-step guide to filling out the WMS (OCLC) Migration Form. The Migration Form maps local data, such as location codes or user group codes, into codes that will be used in Alma, and provides a mechanism for customers to make individual decisions about their data migration which may vary from customer to customer.
- A description of the files expected from WMS, as well as an explanation of general migration rules.
- Indicate which local fields correspond to Ex Libris' expected fields using the WMS (OCLC) Field Mapping form, prior to data delivery (customer responsibility).
- Validate the flat files using Non-Ex Libris to Alma Validation Tool Excel. It is recommended that this step be done against a small sub-set of data to ensure that the header of each of your flat files and the filled in WMS (OCLC) Field Mapping form match each other.
- Extract the relevant data elements from WMS into flat files (customer responsibility).
- Upload the files to Ex Libris’ secure file server along with the WMS (OCLC) Delivered Files List and the executed/validated Non-Ex Libris to Alma Validation Tool (customer responsibility).
- Transform the data elements, based on the Field Mapping form, into an intermediate conversion XML format (Ex Libris responsibility).
- Load the transformed data into Alma (Ex Libris responsibility).
Recommendations for Using this Guide
- Inventory
- Fulfillment
- Acquisitions
- Physical to Electronic
- Files expected - an explanation of the files that are expected from WMS.
- Questionnaire Tab – Instructions for individual questions asked on the Questionnaire tab of the Migration Form.
- Individual Tabs – Instructions for how to fill in individual tabs on the migration form.
- 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 WMS (OCLC) 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.
- This document will also help you fill out the WMS (OCLC) Field Mapping form.
- Prerequisites: Basic knowledge of Alma key concepts and architecture, and the requirements (including the migration-related approach) described in Getting Ready for Alma and Discovery Implementation, as well as the Electronic Resource Handling in Alma Migration document. Additionally, knowledge of the concepts and architecture of WMS is essential.
- 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.
Files Requested from your ILS
- As you extract data from any area listed below, provide it to Ex Libris via the MFT server. This facilitates the transformation analysis and expedites the conversion process. For file delivery instructions, see Appendix A – File Delivery and Delivered Files Form.
- DO NOT OPEN/UPDATE any delimited file extracts you provide to Ex Libris in Excel. This may ruin the appropriate delimiter formatting and text formatting and may result in corrupted data.
Expected File Formats
- Bibliographic records (which are MARC standard files)
- MARC Holdings records
For all files, the maximum file size is 2GB.
WMS (OCLC) Field Mapping Form
WMS (OCLC) Delivered Files Form
Inventory
Bibliographic Records
Bibliographic record key
ocm00001466 | 1466
ocm00089585 | 89585
ocm41883537 | 41883537
on1442800701 | 1442800701
Suppressed Records
- titles on order
- missing or damaged titles where you want to keep the record but not show it to the public
- titles that are for internal management only, such as equipment
Boundwiths
Items that are shared by multiple bibliographic records are called boundwith items. Alma supports boundwiths by using standard bibliographic record relationships defined by Marc 21 linking fields. In general, the Alma migration process associates the shared item with a parent bibliographic record and creates links to the secondary bibliographic records via the standard 774 linking field.
WMS does not have functionality to maintain boundwith items, but some libraries may have reports from their previous systems that show bound with relationships. In this case, the customer may modify their reports from the previous system and put them into the following format.
Examples of boundwiths:
- Bound journals with a title change in the middle of the year. For example, if January – April is “Journal of Mathematics Education” and May – December is “Mathematics Educator”, and all 12 of the issues are bound in the same volume with a single barcode.
- Pamphlets or small volumes with similar content which were combined into the same item/barcode, either by binding or in a folder.
Provide boundwith information in a separate file as follows:
bib ID (host), bib ID, bib ID etc
456,457,458,459
In the above example, bib 456 has the shared item attached to it. The other bib IDs in the line are bound with the shared item. Since Alma supports standard bibliographic record relationships using Marc 21/UNIMARC/KORMARC linking fields at the bib level, the migration processing associates this shared item by linking the sharing bibliographic records via the standard linking fields. Therefore, the actual item that is shared is not necessary for migration processing.
Linked Bibliographic Records
Electronic Link Resolver Records
Holding Records
Provide MARC holdings records in a separate file from the MARC bibliographic records. Do not send the Bibs and Holdings in an interleaved (combined) file.
MARC Holdings
Holding Records from a Summary Statement in a Bibliographic Record
Expected Field Name | Value | Notes |
---|---|---|
SUMM_TAG | 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 | Multiple subfields allowed,for example, abz. May use # to indicate all subfields. | |
SUMM_CALLNO | Textual call number to be used in all newly generated holdings records, if desired. | |
SUMM_LIB_SUBF | A single subfield code (like 'a') which contains a library 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 | A single subfield code (such as a) 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_LIB_CODE | If SUMM_LIB_SUBF is not provided or the subfield is not found, this is used for all records as a default. Provide a library code in local ILS format. | |
SUMM_LOC_CODE | If SUMM_LOC_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_PUBLIC_NOTE_SUBF | Public note, is placed in 852 $z of the generated holding record. | |
SUMM_NON_PUBLIC_NOTE_SUBF | Non-public note, is placed in 852 $x of the generated holding record. |
Item Records
Ex Libris expects item records in CSV delimited format. Items that do not have a BIB key are not migrated.
Serial description information from tag in holding
Additionally, WMS stores serial description information (such as 'v. 1 no. 3 July 2017) in the holding record related to the item - not in the exported item record itself. Therefore, Ex Libris migration programs transfer the description from the holding to the associated item when there is a barcode in the 876 $p which matches the barcode from the item.
When an 876, 877, or 878 contains a $p with the item barcode, then one of the following will happen:
a) if the 876/7/8 contains $3 with a description field, it will be transferred directly to the item description field.
b) if the 876/7/8 contains $8 with a linking number, the programs will search for a related 853/4/5 and 863/4/5, and construct a description field from those paired tags for this item.
If the item has a field 'Textual Holdings', that field is preferred over bringing the description over from the serial holding record.
Suppressed Item Records
Item Record
Expected Field Name | Notes |
---|---|
Holding Location | use as Library in Alma Location mapping tab |
Shelving Location | use as Location in Alma Location mapping tab |
Temp Shelving Location | |
Item Type | use in Item Type mapping tab |
Call Number |
This field is used when generating a holding record. Further, if only bc is used in 852_subfields_for_hol, then this call number could* be placed in the ITEM_CALL_NUMBER field when multiple items are grouped together into a single holding record. * 'could' because Item Call Number will be placed in ITEM_CALL_NUMBER if present. If Item Call Number is NOT present, then Call Number 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. |
Item Call Number |
If this is present, then the value will be placed in ITEM_CALL_NUMBER. This value takes precedence over a possible value from Call Number, according to the descriptions in "Determining Groups of Holding Records" and "Changing the Holding Record Grouping" sections below. This field is only used if you have two different call number schemes, for example a subject call number and a shelf location (like Shelf 15 Box 2). If you have only one call number, use 'Call Number' and leave this one blank. |
Textual Holdings | maps to item's Description field |
OCLC Number | bib key |
Item Barcode | |
Current Status | use in Item Base Status mapping tab |
Issued Count |
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. |
Last Issued Date | |
Last Inventoried Date | |
Soft Total | maps to Total In House Use |
Soft Last Date | maps to Last In House Use Date |
Item Deleted Date | If this field has value '---' (no date) then the item is migrated. If there is a date present, the item is not migrated. |
LHR Item Shelving Scheme | use in Shelving Sheme map |
LHR Item Copy Number | |
REPLACEMENT_COST | Place a field name here ONLY IF this will be used an actual replacement cost for a lost item in Fulfillment. |
INVENTORY_PRICE | Place a field name here for information purposes about the original cost of the item. |
Material Format | use Item Material map in migration form |
Item notes
Note Name | Default Local Field |
---|---|
PUBLIC_NOTE | Shows to the public |
FULFILMENT_NOTE | Pops up at circulation activity. See section on Fulfillment notes above for an explanation on how to use this field. |
NON_PUBLIC_NOTE_1 | Internal notes |
NON_PUBLIC_NOTE_2 | |
NON_PUBLIC_NOTE_3 | |
STAT_NOTE_1 | Statistical notes |
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.
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 |
Customer Input - Inventory
Questionnaire Tab
Institution Code, Customer Code, Institution Name, Customer Name, Time Zone
MARC Organizational Code
List Prefix for bibs from SFX or other management systems
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
Limit exported records by location
Bib Key Prefix
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.
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
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
Incoming Library code | Incoming Location Code | Alma Library Code | Alma Location Code | Alma Location Desc | Alma External Loc Desc | Suppress from Externalization |
---|---|---|---|---|---|---|
ALMAME_ VALUE_NOT _FOUND |
ALMAME_VALUE_NOT_FOUND |
MAIN |
UNASSIGNED |
Problem location from Migration |
Problem: See Library Staff |
Yes |
Alma Location Name and Alma External Location Name
Alma 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 |
Alma 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
Incoming Location Code | Alma Library | Alma Location Code | Alma Location Name | Alma External Loc Name | Suppress from Externalization | Electronic Location |
---|---|---|---|---|---|---|
reserves |
MAIN |
RESERVES |
Reserves |
Reserve |
Yes |
No |
reservesElec |
MAIN |
RESERVES |
Reserves |
ReserveElec |
Yes |
Yes |
reservesShort |
MAIN |
RESERVES |
Reserves |
Reserve |
Yes |
No |
reservesPerm |
MAIN |
RESERVES |
Reserves |
Reserve |
Yes |
No |
Shelving Scheme Tab
Item Type Tab
Item Base Status Tab
Incoming item statuses which indicate no status
Material Type Tab
Use this tab to migrate the WMS (OCLC) Material Format to the Alma Material type.
WMS(OCLC) Material Format: The value in the material type field of the item coming from WMS (OCLC).
Material type Description: The description of the WMS material type, for information only. This column is not used during the mapping process.
Alma Material Type: The Alma value for the material type. Material types in Alma are fixed. You cannot add any new types to the list. Select the appropriate material type from the drop-down list.
If this field is not provided in the extract, Alma migration assigns the item material type based on the fixed fields in the bib as described in section Material Type from Bib Fixed FIelds section below.
Further Explanation – Inventory
Bibliographic Records
- Australian customers have ALL bibliographic records marked for Libraries of Australia Publish, if relevant.
- OCLC records (records with an 035 |a with an OCLC-official prefix) is marked for OCLC publish, if relevant.
- The LDR position 9 (character coding scheme) is set to a indicating Unicode.
Determining Groups of Holding Records
- Item 1, 2 in Location A
- Item 3, 4 in Location B
- Item 5 in Location C
Changing the Holding Record Grouping
Attaching Items to Existing Holding Records
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 <item barcode>-<item id>
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 from Bib Fixed Fields
Fulfillment/Patrons
Patrons
Field Name | Repeat-able? | Notes |
---|---|---|
Patron Given Name | N | |
Patron Family Name | N | |
Patron Middle Name | N | |
Patron Gender | N | |
Patron Date of Birth | N | |
Patron Borrower Category | N | use in User Group tab in migration form |
Patron Home Branch Name | N | use in Campus tab in migration form |
Patron Registration Date | N | |
Patron Last Modified Date | N | |
Patron Last Modified User | N | |
Patron Expiration Date | N | may be left empty |
Patron Blocked Flag | N | use in User Block tab in migration form |
User Identifiers
Alma Identifier Type | Local Field | Migration Form Value |
---|---|---|
UNIV_ID | UNIV_ID | |
BAR | BAR | |
ADDL_ID_1 | ADDL_ID_1 | |
ADDL_ID_2 | ADDL_ID_2 | |
ADDL_ID_3 | ADDL_ID_3 | |
ADDL_ID_4 | ADDL_ID_4 |
User Preferred Address
ExL Expected Field | Local Field | Instructions |
---|---|---|
Primary Address | ||
Patron Street Address 1 | If city, state, zip and country are all together on one line, you can put them into one of the ADDRESS_LINE_x fields | |
Patron Street Address 2 | ||
Patron City/Locality | ||
Patron State/Province | ||
Patron Postal Code | ||
Patron Address Type | ||
Address Type (Select): | Select one: HOME, WORK, SCHOOL, ALTERNATIVE, ALL | |
Secondary Address | ||
secondaryStreetAddressLine1 | ||
secondaryStreetAddressLine2 | ||
secondaryCityOrLocality | ||
secondaryStateOrProvince | ||
secondaryPostalCode | ||
Address Type (Select): | Select one: HOME, WORK, SCHOOL, ALTERNATIVE, ALL | |
Patron Phone Number | ||
Select type from dropdown --> | Select one: Home, Mobile, Office, OfficeFax, All | |
secondaryPhone | ||
Select type from dropdown --> | Select one: Home, Mobile, Office, OfficeFax, All | |
Patron Email Address | ||
Select type from dropdown --> | Select one: Personal, School, Work, All | |
secondaryEmail | ||
Select type from dropdown --> | Select one: Personal, School, Work, All |
User Statistical Categories
User Statistical Category | Local Field Name | Field Label |
---|---|---|
USER_STAT_CATEGORY | SCHOOL: | |
USER_STAT_CATEGORY | DEPT: | |
USER_STAT_CATEGORY |
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). In the Field Mapping form, 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.
Notes
Note Name | Information |
---|---|
LIBRARY_NOTE | |
BARCODE_NOTE | |
ADDRESS_NOTE | |
OTHER_NOTE | OTHER_NOTE is set to User Viewable by the migration programs. This is the only note which migration marks as user viewable. |
CIRC_NOTE | CIRC_NOTE is set to PopUp = Yes by the migration process. This is the only note which migration marks as PopUp. |
Loans/Circ Transactions
Field Name | Repeatable? | Notes |
---|---|---|
Item Barcode | N | links to item barcode in item file |
Loan Checked Out Date | N | |
Item Due Date | N | |
Item Long Overdue Date/Time | N | if a valid date is here, migration will set loan to LOST. If you *also* want to keep the date, then put this field in notes below. |
Patron Barcode | N | links to patron barcode in patron file |
Note Name | Default Local Field |
---|---|
NON_PUBLIC_NOTE |
Active Hold Requests
Field Name | Repeatable? | Notes |
---|---|---|
Item Barcode | N | links to item barcode in item file |
Hold Pickup Branch Name | N | |
Hold Expiration Date | N | |
Patron Barcode | N | links to patron barcode in patron file |
Note Name | Default Local Field |
---|---|
NON_PUBLIC_NOTE |
Fines/Fees
Field Name | Repeatable? | Notes |
---|---|---|
Item Barcode | N | matches barcode in item file. This is not mandatory for fines. |
Patron Barcode | N | matches barcode in patron file |
Fiscal Bill Reason | N | use in fine fee type map in migration form |
Fiscal Transaction Original Bill Date/Time | N | |
Fiscal Currency | N | |
Fiscal Transaction Outstanding Amount | N |
Note Name | Default Local Field |
---|---|
NON_PUBLIC_NOTE |
Course Reserves
Field Name | Repeatable? | Notes |
---|---|---|
CLASS_CODE | N | |
COURSE_NAME | N | |
PROFESSOR | N | This can only be used if the value in the field is an actual patron identifier; do not use if the field contains a name (text). If this is an identifier, type the identifier type (UNIV_ID, BARCODE, ORIGINAL_ID, ADDL_ID_1/2/3/4) in the note column of the field mapping form |
SECTION | N | |
OCLC | Y |
This is the bib key. Alma does not use individual item barcodes for course reserves migration, only the bib key. If providing multiple, separate by semicolon like: "field1","oclcA";"oclcB";"oclcC","field3" |
CAMPUS | N | use in Course Unit map |
Begin and End Dates |
Begin and end dates are required for courses, but we do not typically receive these from WMS. Therefore, default dates are assigned: begin = migration date end = migration date + 1 year If you want different default dates, inform your Ex Libris customer representative. |
Note Name | Default Local Field |
---|---|
NON_PUBLIC_NOTE |
Customer Input - Fulfillment
Questionnaire Tab
Enter a two-letter code for the default conversational language for your users
Which identifier should be 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
Currency for patron fines
Use a map for the patron campus to campus code migration?
Request Default Destination Library
Use Course Reserve CAMPUS to Course Unit Map?
Code: COURSE_UNIT_MAP
Default: No
Options: Yes or No. Answer Yes to this question if you are migrating courses and you have multiple staff units that manage different groups of courses. For example, the Law Library maintains a separate course reserve list from the Main Library and there is no sharing of courses or staff between them. When Yes, also fill out the mapping from the WMS (OCLC) Campus field to the Alma Course Unit field, on the Course Unit tab. When No, all courses are assigned the same course unit, accessible by all staff who are allowed to work with courses.
See also: Course Unit Tab
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
User Group Tab
- Which identifier should be used b as the patron's Primary Identifier?
User Stat Categories Tab
Before filling in this tab, specify in the Patrons tab of the Generic to Alma Field Mapping form which fields from your legacy ILS are migrated to statistical categories in Alma. You can include a label before each category to distinguish between categories in different fields. For example, you can have LAW in USER_CATEGORY1 and also LAW in USER_CATEGORY2. If desired, use a prefix to distinguish between the two, for example, CAT1: LAW and CAT2: LAW.
The migration engine adds a space between the label you specified in the Field Mapping form and the value. So if you included a label 'CAT:' in the field mapping, then use 'CAT: a' here (if 'a' is an incoming value).
User Block Tab
Campus Code Tab
Fines and Fees Tab
Course Unit Tab
Use this tab only if you answered Yes to the question on the Questionnaire tab: Use Course Reserve CAMPUS to Course Unit Map? This mapping is not mandatory if you do not have administratively separate course maintenance operations.
The Alma Course Unit is used to assign separate editing privileges to staff members who maintain course reserves information in administratively separate sections of the library. It is strongly recommended to use a single course unit unless there is a pressing need for multiples.
WMS (OCLC) Campus: The value of the WMS Campus field in the course reserves extract.
WMS Campus Description: A description of the Campus field, for information only. This field is not used in the mapping.
Alma service_unit/code: The desired code value for the course service unit in Alma. You can collapse the Campus values, if desired.
Alma service_unit/name: The name for the course service unit in Alma. This field is used to create a code table that is loaded into Alma.
Further Explanation – Fulfillment
Internal/External Patrons
Patron Identification Numbers
Acquisitions
Funds
Fund records are collected into an Excel migration form, then exported to CSV and loaded into Alma. Funds are not extracted from WMS directly. All funds must be listed on a single tab (the first tab on the spreadsheet) before exporting to CSV. You can submit separate CSV files, but they must be physically separate files and not multiple tabs on the same sheet. Each csv file must contain a header line with the field names, as described below.
In the fund file, LEDGER CODE, LEDGER NAME, FUND CODE, and FUND NAME are mandatory. Ledgers are mandatory and if your institution does not have ledgers in the current ILS, define one general ledger for use in Alma.
Note that fund codes and ledger codes are unique across the entire fiscal period, not just within specific hierarchies – so in the spreadsheet submitted, there should be no fund code or ledger code duplication since all of the funds go into a single active fiscal period. Ledger codes are included in the unique constraint; ledger codes cannot be the same as any fund code.
Funds are grouped under summary funds, and summary funds/funds are grouped under ledgers. Only one level of summary fund is allowed in the extract; however, it is a simple task in Alma to create a new summary fund after migration and drag other summary funds underneath it.
The funds in the input file are only created for the current fiscal year. Initial allocations for the migrated funds are created from the Allocation field of the Fund Input file.
The fund code in this file must match the fund codes used by order records to make an encumbrance transaction, and by invoices to make an expenditure transaction. Encumbrances and expenditures link orders and invoices to the related fund.
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 |
leave blank; currently all funds are set at the institution level |
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 |
Vendors
Provide this file in csv format.
Provide the vendor file in standard comma delimited format, as a standard WMS extract. The fields in the following table are expected. Indicate the local field names for the expected fields in the Vendors tab of the Field Mapping form.
Field Name | |
---|---|
VendorID |
VendorID |
VendorName |
|
VendorCustomerAccountNumber | |
VendorCurrency | Three letter code, for example USD or EUR |
VendorLanguage | Two letter code, for example en or de or fr |
VendorAddressStreet | |
VendorAddressPOBox | |
VendorAddressCity | |
VendorAddressStateProv | |
VendorAddressPostalCode | |
VendorAddressCountry | |
VendorContactPhoneNumber | |
VendorContactEmailAddress | |
VendorIdentifierURL | |
VendorContactName |
Note Name | Default Local Field |
---|---|
VENDOR_NOTE |
Orders
Provide orders in a csv file.
Field Name | Notes |
---|---|
OrderNumber | alphanumeric; PO Number at the header level |
OrderItemCreatedDate | |
OrderLastModifiedDate | |
OrderItemCreatedStaffFullName | |
OrderItemLastModifiedStaffFullName | |
PO_LIBRARY_ID | Library which owns the order; can be left empty to leave at the institution level |
PO_ENTRY_POINT | use PO Entry Point map in migration form |
VendorID | links to the vendor file |
OrderAccountNumber | not mandatory, but if present there should be the same account number on the vendor record |
BranchName | used for the POL Library, and also the intended inventory library |
OrderItemNumber | POL Number at the line level. Must be unique, and is used to link to invoice lines if present. |
OrderType | use in PO Acq Method map |
POL_LINE_TYPE | use PO Line Type map in migration form |
DiscountPercentage | expected as '15' which means a 15 percent discount |
CopyReceivedDate | |
OCN | Links to bib file/bib ID |
ShelvingLocation | intended inventory location |
CopiesOrdered | |
SubscriptionStartDate | |
SubscriptionEndDate | |
PurchaseStatus | NO_INVOICE, FULLY_INVOICED, PARTIALLY_INVOICED |
POL_SUM_LOCAL | |
InvoiceCurrency | three letter code, for example USD or EUR |
OrderItemTotalAmount | |
FundCode | links to fund file |
Note Name | Default Local Field |
---|---|
PO_NOTE (note on the purchase order header) |
|
POL_NOTE (note on the purchase order line) |
|
POL_RECEIVING_NOTE |
This line cannot be duplicated; place only one local field name here. |
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_NOTE_TO_VENDOR | This line cannot be duplicated; place only one local field name here. |
Invoices
Provide two files in csv: Invoice header file and invoice line file. The two files are linked by the System Invoice Number.
Invoice Header file
Field Name | Notes |
---|---|
SystemInvoiceNumber | alphanumeric; internal record number used to link the header to the line |
InvoiceItemCreatedDate | |
InvoiceLastModifiedDate | |
InvoiceCreatedStaffFullName | |
InvoiceNumber | must be unique per vendor |
InvoiceStatus | NEW or CLOSED. If invoice is cancelled use CLOSED and indicate the cancelled status in a note |
VendorID | links to vendor file |
APPROVE_DATE | |
InvoiceDate | |
InvoiceCurrency | three letter code, for example USD or EUR |
PaymentStatus | PAID or NOT_PAID |
InvoiceAmountIC | |
ShippingAmountPerUnit | |
ServiceChargesPerUnit | |
DiscountAmount |
Invoice Line File
Field Name | Notes |
---|---|
SystemInvoiceNumber | alphanumeric; internal system number used to link the header to the line |
InvoiceITEMCreatedDate | |
InvoiceITEMLastModifiedDate | |
InvoiceITEMCreatedStaffFullName | |
InvoiceITEMLastModifiedStaffFullName | |
InvoiceITEMNumber | |
OrderItemNumber | Links to order line |
InvoiceITEMQuantity | |
InvoiceAmountIC | |
InvoiceITEMTax1Percentage | |
InvoiceNumber | also used to link between invoice and invoice line |
FundCode | links to fund file |
BudgetPeriod | yyyy |
Note Name | Default Local Field |
---|---|
INV_NOTE (note on the invoice header) |
|
INVL_NOTE (note on the invoice line) |
Customer Input for Empty Acquisitions Environment
Questionnaire Tab
ACQ mode
Default currency for Ledgers and Funds
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.
- Select a year from the dropdown box.
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.
Customer Input when migrating Acquisitions
Default claiming period
Code: ORDER_CLAIM
Default: 90
Options: Default claim used for vendors and orders (if applicable), in days
Central Order Library
Code: CENTRAL_ORDER_LIB
Default: None
Options: See explanation below in Default Order Library
Default Order Library
Code: DEFAULT_ORDER_LIB
Default: First library found on the Alma Library list
Options for Central and Default Order Library: The PO_LIBRARY_ID field specifies the order location for orders in WMS. The migration attempts to map the incoming library field to the corresponding Alma Library. If you want to override this field and instead assign an order library to all orders migrated, fill in a value for the Central Order Library question. Otherwise, if you want to use the incoming library field to determine the order library, leave the Central Order Library blank and fill in a value in the Default Order Library question. In this case, the migration attempts to determine a library based on the incoming library field and only when a library is not specified or a mapping is not found does it use the Default Order Library as a second choice.
Renewal Date for Serials Subscriptions
Code: RENEWAL_DATE
Default: none
Options: Default renewal date for subscriptions. If your subscriptions are generally ordered on the same cycle, place that date here. If this question is not answered, then we use migration date + 1 Year. Note: WMS does not provide a renewal date in the order record.
Fund Prefix
Code: FUND_PREFIX
Default: none/blank
Options: If you are combining data from two or more separate databases into a single combined institution in Alma, indicate a prefix here that will be used to distinguish the former fund codes in Alma after migration. Provide a string to be used to prefix all fund codes in the database. A hyphen is NOT provided. For example, if your fund code is SCIENCE-MONO and you put UWS- here, the final fund code is UWS-SCIENCE-MONO. Leave this question blank to leave the fund code as is.
See also the similar BIB_KEY_PREFIX in Inventory and MERGE_PATRON_PREFIX in Fulfillment
PO Entry Point Tab
Use this tab to map values from the WMS EntryPoint field to the Alma PO Entry Point field. This tab is required.
The entry point value is used to determine where the PO falls in the Acquisitions workflow in Alma. The PO entry point is mandatory in Alma, so the ALMAME_VALUE_NOT_FOUND line is required to catch any ORDER_STATUS values that may not have been found in the map.
WMS EntryPoint: The value of the WMS entry point, found in the EntryPoint field of the WMS order extract.
EntryPoint Description: A description of the field, for information only. This field is not used in the mapping.
Alma PO Entry Point: The desired order status in Alma. Select from one of the values in the drop-down list. The following options are available:
- NEW – The order has been created, but has not been sent to the vendor. Orders can have status NEW for years while librarians are reviewing what to order, or they can be NEW for just 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 – The order is cancelled.
PO Line Type Tab
This tab is mandatory if you are migrating orders. Include a line for ALMAME_VAL_NOT_FOUND since this field is mandatory in Alma.
ProcessingType: Value of the processing type field in WMS, found in the ProcessingType field in your order extract.
Processing Type Description: A description of the field, for information only. This field is not used in the mapping to Alma.
poLineType: The Alma line type value. Select one of the following line types from the drop-down list:
- 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 the ‘Line Types and electronic orders’ section below.
- OTHER_SERVICES_CO: Other Services Subscription. This should only be applied to orders without inventory. For electronic resources, see the ‘Line Types and electronic orders’ section below.
Further Information: Use this tab to define the line type of the migrated order. The PO may move through Alma workflows differently according to what type of item is on order. For example, a monographic order is opened, sent to the vendor, received, invoiced, and closed. However, a serial order may be received and invoiced many times and may remain open indefinitely. Alma does have other PO Line types but they are not available for use in migration.
Line Types and Electronic Orders
The above line types are all descriptions based on a print order. WMS orders are migrated to Alma initially as print using the above line types, even if they are designated as electronic in WMS. The physical to electronic (P2E) process identifies orders attached to electronic bibliographic records and transforms the order to electronic. In other words, if an order migrates as PRINT_SO, is attached to a bibliographic record you identify as electronic and is in an electronic location, it is changed to the corresponding electronic standing order line type by the P2E process. See the section on Physical to Electronic Processing below for more information on the overall P2E process.
PO Acq Method Tab
Use this tab to determine the Acquisition Method of an order in Alma. The acquisition method is an indication of how the order is acquired.
OrderType: The value of the OrderType field in WMS, found in your order extract.
OrderType description: A description of the Order Type in WMS, for information purposes only. This field is not used in the mapping to Alma.
poLineAcqMethod: The Acquisition method in Alma. AcqMethod is mandatory in Alma. If not found, then use PURCHASE. Select one of the following values from the drop-down list:
- PURCHASE – normal workflow
- GIFT – not sent to vendor and no invoicing or payment
- EXCHANGE – not sent to vendor and no invoicing or payment
- APPROVAL – pre-established delivery plan - normal workflow except not sent to vendor
- VENDOR_SYSTEM – the order is placed at the vendor site so that sending it to the vendor is not required. The normal workflow is followed except that the order is not sent to the vendor.
- DEPOSITORY – usually from the government. The order is not sent to vendor and there is no invoicing or payment.
- TECHNICAL – no fund or amount required
- LEGAL_DEPOSIT – does not require fund or price, and uses a special version of the PO Line order letter
Comment: Add any comments about ORDR_TYPE for use while filling out this form. This field is not used by the migration programs.
Further Information: The PO Acq Method is mandatory in Alma, so the ALMAME_VALUE_NOT_FOUND line is required to catch any values that may not have been found in the map.
PO Reporting Code Tab
Use this tab if you wish to map values from the WMS format field to the Alma Reporting Code field. This tab is 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.
WMS Format: The value of the WMS order format, found in the FORMAT field in the order extract.
Format Description: A description of the FORMAT 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 FORMAT 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 Explanation – Acquisitions
"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.
Encumbrances
Transactions from active purchase orders are created as encumbrances in Alma when the orders fund reference is valid and exists. An active purchase order is defined as one in which the mapped PO entry point is NEW, SENT, or WAITING_FOR_INVOICE and is in the current fiscal year.
Encumbrances are not generated for orders in previous (inactive) fiscal years. The fund code is preserved in the PO Note for reference.
Transactions of Amount 0.00
WMS allows for transactions to be of value 0.00 for all purchase orders (encumbrances). In Alma, encumbrances or open orders of amount 0.00 are changed to 1.00. The following types of orders (Acq method) can be open with amount 0 on the order, but with with no transaction/link to fund: GIFT, DEPOSITORY, EXCHANGE, TECHNICAL, and orders with the 'no charge' flag set to Y.
Linked Inventory/Receiving Location for Monographic Orders
Monographic orders in Alma are linked to item records only (not holding records). Orders coming from WMS do not have a link to the item record, even though there may be an item on the linked bibliographic record. To indicate the expected inventory location (ShelvingLocation) in lieu of a linked inventory item, the migration programs place the inventory location codes into the PO line receiving note, which appears at the top of the summary screen on the Alma PO line.
After go-live, the receiving operator should do one of the following:
1. In the case that there is no item on the linked bibliographic record, and the expected item arrives, generate an item using the information from the receiving note prior to receiving the order.
2. In the case that there is an existing (migrated) item on the linked bibliographic record: these items do not appear on the Receving workbench. These items will have to be manually received by updating the item receiving date and then link the item to a POL.
Linked inventory for Continuous Orders
Continuous orders (standing orders and subscriptions) are linked to holdings records. The migration programs search for a holding record on the bib record with the expected inventory location (ShelvingLocation), so an order can be linked to an existing holdings record. If a linked holding record in the ShelvingLocation is not found, the expected inventory location (ShelvingLocation) is placed in the PO Line receiving note.
Alma allows only one order to be linked to a holdings record, while WMS may allow multiple orders linked to the same holdings record. The first order found links to the holdings record, and subsequent orders are simply linked to the bibliographic record with no linked inventory (holdings).
When an order does not have a linked holdings record, the receiving operator should either link the order to an existing holdings record or generate a holding record prior to receiving the order in Alma.
Physical to Electronic (P2E) Processing
Further, the P2E process attempts to identify an order related to the identified inventory for conversion to electronic. Similarly to items and holdings, orders are initially migrated as print and are transformed to electronic through the p2e process. See the guide https://knowledge.exlibrisgroup.com/Alma/Implementation_and_Migration/Migration_Guides/Electronic_System_Migrations/Electronic_Resource_Handling_in_Alma_Migration for more information.
Customer Input
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<blank> 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.
The space character operates the same way as an asterisk (*), for example: 8564 u is the same as 8564*u.
-
Special Request: If you need to specify multiple specific indicators, for example 85641 and 85642, it cannot be coded in the migration form but your ExL representative can make a special request to the migration team.
Which Holding or Bib field stores electronic link information
Which Holding or Bib field stores electronic link public note
Which Holding or Bib field stores electronic provider name information
Alma Location Tab
Electronic Location Column
Further Explanation – P2E
Number of 856 links in a bib record
In the P2E process, an electronic resource is made for each matching 856 tag found in the bib record, or holding record, if one was available there.
In the specific case of OCLC shared bibliographic records, there may be a very large amount of 856 tags in the bib record. Sometimes this results in an extraordinary number of portfolios created.
Customers should be advised to either limit the number of 856 tags in a bib record, or if that is not possible, reconsider providing a p2e file in case the number of extra tags is extraordinary.