PACKAGE IDs and ENTITY IDs

PACKAGE IDs

Data sent to FCLA for loading must be in "packages" (folders). Every package must have a unique identifier or "package ID". The package ID is the name of the directory (folder) containing the package, and is also contained in the MXF as the "id" attribute of the <packageDesc> element. If you are using the MXF client, this is the name you give the highest (package) level node.

Before you create a new package, you must decide what the package control number will be. The package control number is meant to identify a transmission (that is, a bunch of stuff FTPed together at some point in time). The package itself only exists for the length of time it takes to be created, transmitted, and processed. After a package control number is used once, it should not be used again, unless the entire package is re-transmitted for some reason (for example, if there was an error in the original package that prevented processing).

The standard format is a 2- or 3- character alpha prefix followed by a unique 8-character alphanumeric string. The prefix must be assigned to you by FCLA (see Package and Entity ID Prefixes), but the value of the 8-character string is up to the assigning institution. It is the responsibility of the institution to assign only unique package IDs. It is recommended that numeric strings be assigned sequentially and a record kept of the highest number used.

Some examples of valid package IDs are:

UF00001234
UFE00001234
NF80000001

ENTITY IDs

An entity is a logical bibliographic unit, and ordinarily corresponds to the unit for which a catalog record would be created. Typical entities include books, pamphlets, theses, dissertations, serial titles, newspaper titles, photographs and maps.

Every entity must have a unique identifier called an "entity ID". In the MXF, this is contained in the "id" attribute of the <entityDesc> element. If you are using the MXF client, it is the name of the Entity level node.

When a single entity is sent in a package, the entity ID should be identical to the package ID. When multiple non-serial entities are sent within a package, each entity should have the next highest sequential ID, e.g.

Package ID = FS00000022
Entity ID (first entity) = FS00000023
Entity ID (second entity) = FS00000024

If the entity is a serial, the entity ID should always be "SN" followed by the 8-character ISSN of the serial title. If the title does not have an ISSN, one can be obtained retrospectively from the ISSN office, or a pseudo-ISSN can be created. (See Creating Pseudo-ISSNs)

Entity ID (serial) = SN0004554X

When different issues of a serial are sent in separate packages, the package ID of each package must be unique, but the entity ID for the serial remains the same:

Package ID = UF0000986
Entity ID = SN00340087

Package ID = UF0000987
Entity ID = SN00340087