Quick Start Guide Installation
You retrieve labeling XML files from Alma with a REST (REpresentational State Transfer) API call. Java is not required, which simplifies SpineOMatic’s installation and operation. It does require that you get a unique API key from the Ex Libris Developer Network, and insert that key into the “API Key” area in SpineOMatic’s “Alma Access” panel. You will also need to insert the Alma URL for your Alma installation.
NOTE: Because the RESTful XML files have a different layout than the SOAP files, SpineOMatic converts the RESTful XML into a format similar to the SOAP format. This ensures that your existing XML field names will work without extensive modification. To view the actual RESTful XML format, click the “Don’t convert XML” checkbox, and scan or type a barcode number. You will be taken to the Current XML panel, and the actual RESTful XML file will be visible. Labels will not be created while the “Don’t convert XML” box is checked.
Go to the download link provided (currently here). Installation consists of downloading the SpineOMatic application ("SpineLabeler.exe") and placing it into an empty folder on the workstation. Creating a folder named "C:\Spine" is recommended, but any folder will do as long as the folder has no security policy restrictions that would prevent SpineOMatic from reading, writing and deleting files, as well as running the necessary Java programs. Right-click the “SpineLabeler.exe” file name and click “create shortcut.” Drag the shortcut to the desktop, and name it “SpineOMatic”. Note: Don’t change the name of the “SpineLabeler.exe” file. If you do, the “Check for Updates” feature will not work properly.
SpineOMatic sends a barcode number to Alma via the “Ex Libris Label Printing Web Service,” and gets back an XML file containing information about the item that can be used to construct a label. It contacts Alma using a RESTful web service.
SpineOMatic is highly customizable, and comes with many default settings that you can change to suit your needs. To get started, you will need to select the label printer you'll be using, as well as a printer font. You'll also need to store your Alma credentials to give SpineOMatic permission to get the Alma label files. This need only be done once. All settings are made in the Setup Panels. These panels are visible when you start SpineOMatic for the first time, but you can open and close them as needed by clicking the blue arrowhead in the upper right of the user interface, or by pressing CTRL a.
- Click the printer dialog selection button (…), and select a label printer from the list of installed printers that will appear.
- Select a Text Font by clicking the font dialog selection button (…), and selecting a font from the list that will appear. The Barcode font is optional, and is required only if you create custom labels that include barcodes.
Select “Use RESTful API,” and enter the Alma URL and your API key.
The “Method” does not have to be changed.
Make sure the "Review" option is selected. Click the "scan" button. This button clears the Input Box and waits for a barcode label to be scanned or typed. When manually typing a barcode number, you must press the Enter key when done. Scanners are usually programmed to provide the “Enter” code automatically. In a few seconds a spine label should appear in the Output Box. Click the "Send to desktop printer" button to print the label.
Desktop label printers (such as Zebra, etc.) may need their Windows print driver settings adjusted, especially new ones out of the box. Every printer and every operating system (XP, Vista, Windows7, etc.) may offer different options.
Printer driver Defaults apply to all users. Preferences are specific to the user who is logged in. I try to make both sets of values the same.
Left and Top margin settings should be set to 0.00. Thermal printer “Burn Temperature”, ”Darkness” or “Print Density” should be set near the top of the range (darkest) and adjusted downward if needed.
Many other settings are available, depending on the printer. Typical settings include:
Media Type: Thermal Transfer (if you’re using a ribbon), or Thermal Direct (if you’re not) Paper format or Orientation: Portrait Size: the height and width of the labels you’re using Unprintable Area: “0.00” for all settings Adjustment: should generally be “0.00”
If you do make changes to the Windows print driver while SpineOMatic is running, make sure to CLOSE and RESTART SpineOMatic to pick up the new settings.