User guide documentation May-2020 - Technion Library Portal · 2020-05-10 · • Design templates...

1

Technion

Libraries Elyachar Central Library

User guide documentation

May-2020

2

Technion


Table of content

1. OVERVIEW............................................................................................ 4

Introduction .............................................................................................. 4

Main Features ........................................................................................... 4

Technologies ............................................................................................. 4

Contact Us ................................................................................................ 4

2. GETTING STARTED ................................................................................5

Create Account .......................................................................................... 5

Configure Alma API-KEYS ........................................................................... 5

Configure the Paper ................................................................................... 5

Create a Template...................................................................................... 5

3. USING LIBSTICK .....................................................................................6

Printing from Browser ............................................................................... 6

Barcode Scan ............................................................................................ 6

Import Alma SET ....................................................................................... 7

Board ....................................................................................................... 8

Edit Text ................................................................................................. 11

Label ...................................................................................................... 13

Template ................................................................................................ 14

Field ....................................................................................................... 18

Printing .................................................................................................. 21

4. CALL NUMBER ..................................................................................... 22

3

Technion


Alma Parsing - Recommended .................................................................. 22

LIBstick call number formats .................................................................... 23

LIBstick field Parsing ................................................................................ 24

5. ALMA EXTENSION ............................................................................... 25

Browser compliance ................................................................................. 25

Installation .............................................................................................. 25

Configuration .......................................................................................... 26

Usage ..................................................................................................... 27

6. ADMINISTRATION ............................................................................... 29

Manage Users ......................................................................................... 29

Manage Roles ......................................................................................... 30

Manage Images ....................................................................................... 30

Configure Alma API-KEY .......................................................................... 31

Manage sequence number ........................................................................ 32

Configure papers ..................................................................................... 32

Configure label layout .............................................................................. 35

Create JavaScript functions ...................................................................... 36

7. SECURITY ............................................................................................. 37

8. PRIVACY .............................................................................................. 38

9. APPENDIX ........................................................................................... 39

List of fields ............................................................................................ 39

Filter Functions........................................................................................ 40

4

Technion


1. Overview

Introduction

LIBstick is the next generation libraries printing solution.

The service was developed by Technion Library Information System team to answer the need for

a simple, quick, editable, template-based solution.

The service (SaaS) is accessible via browser, no installation needed.

Main Features

• Create, edit and share templates on the institute level

• Design templates with many options: image, sequence number, font, color, etc.

• Automatic generation of label based on barcode

• Automatic generation of multiple labels based on Alma set

• Manage privileges based on roles

Technologies

MaterializeCSS, jQuery, JavaScript, HTML, CSS, PHP, WordPress (CMS), MySQL, JSON, AJAX,

RESTful API

Label information is retrieved from Alma using a single dedicated printing API.

Contact Us

Please contact us, the Technion IS team via mail: [email protected]

mailto:[email protected]

5

Technion


2. Getting started

Create Account

The institute account is created by the LIBstick team. The institute will receive over mail:

• Link to the institute account:

https://libraries.technion.ac.il/[institute name]-libstick/

• Manager account details – name + password

More details on Manager account in "Administration" chapter

Configure Alma API-KEYS

Configure API KEYS connection to Alma in LIBstick administration screens - by the user

More details on API KEYS in "Administration" chapter

Configure the Paper

Papers configuration is performed according to the sticker paper used to print the labels. It is

possible to configure multiple papers and then use them with templates.

More details on Paper configuration in "Administration" chapter

Create a Template

Template defines how the labels will be displayed. The selected templates tell LIBstick engine

how to display the items retrieved from Alma. It includes which fields to display, in which order

and what styles to assign.

More details on Templates in "Using LIBstick" chapter

6

Technion


3. Using LIBstick

Printing from Browser

LIBstick is compatiable with Chromium broswers like Google Chrome.

See chapter 5.1 for more details about browser compliance.

Chromium broswers provide a variety of printing options that makes it

possible for LIBstick to support all kind of printers and sticker types. See

chapter 2.8 with details about printing.

Barcode Scan

The barcode menu on the left navigation bar

enables the user to insert the book barcode in two

ways.

After the barcode is submitted the system will

generate the label on the first available spot at the

board.

• Barcode scanner

Simply open the barcode collapsible menu and scan the barcode

on the book. No need to click Enter.

• Manually

Type in the barcode number and press enter or click on "ADD".

7

Technion


Import Alma SET

LIBstick not only enables the generation of individual stickers (automatically or manually), but

also enables the generation of a group of labels from Alma SET.

• Copy the Set ID from Alma - Physical items

SET, can be either Logical or Itemized.

• Go to LIBstick and click LOAD SET button.

• Enter the Alma SET id inside the “Load Alma

Set” window.

• Select the Page.

• Loading process.

8

Technion


Board

The board is the main grid on the right side of the screen which displays the labels.

The size of the grid, number of rows and columns is based on the selected template. The

selected template along with the selected paper also define the size of the labels and the

margins.

The 3 dots icon above the top right corner of the board is a menu:

• Clear board – removes all the labels and clear the board. Can be

used for example after printing is complete.

9

Technion


• Save board – Stores the board labels.

The first tab "Save

new" enable to save

the board with a

specified name.

By default, the

board is saved as

"Public" meaning it

can be loaded and

used by other users

in the institute.

In case the "Private"

check box is

selected, the board

will be available

only for the user

which created it.

The second tab

"Update exiting"

enable to override

and replace a

previously saved

version.

10

Technion


• Load board – Load labels that were previously saved.

The first tab "All

board" enable to select

and load public boards

in addition to boards

created by the user.

The second tab "My

board" enable to select

and load boards

created by the user.

By default, the labels of

on the screen are

cleared and fully

replaced by the loaded

board.

In case the "Add to

exiting board" check

box is selected the

exiting labels on the

screen will not be

cleared. The new loaded

labels will be added to

the board, after the

exiting labels.

11

Technion


• Sort board – Sort the labels according to the selected field.

The fields for selecting the sorting order are according to the fields in the template.

By default, the sorting order is ascending. In case the "Descending" check box is selected the

sorting order will be descending.s

Edit Text

The Edit Text menu on the left navigation bar enable editing the label text. The menu displays

list of text fields according to the selected template. The menu can be opened in two modes:

12

Technion


• Save mode – The menu is opened by clicking on the left menu

with no label in context. The user can populate the fields and click

on "Save". As a result, a new label is created.

• Edit mode – The menu is opened by clicking the "edit" icon on an

existing label. The menu is automatically populated with the text

of the label. The user can edit the text and click on a button:

• Update button – update the label with the new text.

• Close button – reset the relation with the label and change to

menu to Save mode.

13

Technion


Label

Label is a single representation of sticker on the board.

Labels are generated and added to the board when a barcode is submitted. All

the Labels can be edited and dragged to different locations. This feature can

save sticker pages by locating the label in the required location for printing.

When hovering over a label with the pointer the label menu appears:

• Edit – editing the current label fields.

o Click the edit button. An Edit text menu will open on the left

navigation bar.

o Edit the necessary fields.

o Press Update.

• Duplicate - duplicates the current label and adds it to closest free spot on the board.

• Delete - deletes the current label.

All Actions - opens the "All Actions" menu in a pop-up window:

s

• Edit - editing the current label fields

• Duplicate N times – drag the controller to indicate the number of times the selected label

should duplicate.

This option can be used to create multiple barcode labels with a sequence number.

• Delete current label – deletes the current label.

• Re order labels – empties out all the label spots that are located prior to the current label,

and puts them at the next free spots after the current label, makes the current label first.

14

Technion


Template

Template defines the fields of each label, their design and paper type.

There is always a selected template. Switching between templates

changes in real-time the labels on the board. The user can select

from the available templates and use the Actions menu to perform

different actions on the selected template:

• New – creates a new template:

o Click on "New" to lunch the new template menu.

o Enter template name and click "OK" to continue.

o "Edit template:" menu will be opened on the left navigation bar (Same menu that

opens when pressing the "Actions->Edit" button).

15

Technion


• Duplicate – duplicates the current template.

▪ Clicking "duplicate" will open the following window:

▪ Enter a name for the duplicate template and press OK.

▪ The Edit Template menu will appear with all the templates' settings.

▪ When done press the X button on the left navigation bar. Than press the

Actions→Save button to save your duplicate Template.

• Edit – edit the current template attributes

▪ Choose paper size and layout from the "Choose paper"

list – it will set the board layout for the selected

template. Paper types can be managed (create, edit,

delete) in the administration area.

▪ Choose label layout – there are 2 type

of layout:

▪ Built in ready to use – Includes

6 different options to choose

from. All options display the

fields in one single column.

See the screenshot example.

▪ Custom – label layout created

in the admin area. Each layout

can include multiple columns

and lines with variant sizes.

More details on label layout in

"Administration" chapter.

16

Technion


▪ Click "ADD FIELD" to add additional fields to the

template. This action will immediately affect all the

labels on the board. Each button press adds one title

field (that can later be changed to any other field

type.

▪ It is possible to change the order of the fields by

dragging them before or after additional field.

▪ The menu for each field enables to edit, duplicate

and delete the field. See chapter 2.6 for Field editing

• Rename – renames the current template

▪ Clicking "Rename" will open the following window:

▪ Enter a new name for the template and press OK.

• Save – saves the changes made to the current template & and saves new templates.

Please note that changes are not automatically saved.

▪ Click the save button every time a new template is created and

when changes are made to an existing template. A message will

appear notifying that updates were saved.

• Export – Export the selected template configuration into a LIBstick file which is saved locally.

The file is in JSON format. The LIBstick file can be shared between users in different LIBstick

accounts.

• Import – Import the LIBstick file to create the template.

Make sure that corresponding resources used in the template are available. For example:

Label layout, page, font, images.

• Delete – permanently deletes the current template.

17

Technion


▪ Clicking Delete will prompt the following dialog box:

▪ After successful deletion (based on role), the

following message will be displayed:

• Info – displays the templates' creation and updates log.

▪ Clicking Info will open the following window:

18

Technion


Field

Field is a placeholder for information related to the book. The template is constructed from a list

of fields. There is no limitation for the number of fields but the real-estate of the label is limited

based on the paper definition. The label height is divided equally

between the fields. Text that is extending the label size might not be

displayed.

The field customization options:

• "Choose field type" one of the following options:

o Alma – the value in the field will be based on a field

retrieved from Alma

o Image – display an image as part of the label.

More details on manager images in "Administration"

chapter.

More details on adding image to template in this chapter

o Sequence – display a number that is automatically incremental for every new

template

More details on sequence number configuration in "Administration" chapter.

• "Choose Source" sets the fields' source from a list of the available

sources that are retrieved in Alma.

Used only in "Alma" field type.

• "Choose Image Source" sets the fields' source from a list of upload

images.

Used only in "Image" field type.

• "Hide if empty" removes the height of the field if the value is

empty.

This feature is available for "default" (linear) label layout.

Foe example, there are 4 fields so each one gets 25% of the entire

label height. If field #2 is empty so each of the remaining fields will be assigned with 33.3%

of label height.

Used only in "Alma" field type.

19

Technion


• "Display as Barcode" displays the selected field value as barcode in

"CODE128" format.

The width and height of the displayable barcode can be configured

using the 2 dropdowns.

Used "Alma" and "Sequence" field types.

• "Choose font" sets the current fields' font from a pre-defined font

list.

Any font that is added by the administrator will be displayed on

top.

• "Choose text size" sets the current fields' text size starting from

8px up to 24px.

• "Choose text align" sets the current fields' text alignment.

The options are: Left, Center, Right, Justify

• "Bold\Italic\Underline" switches are used to set the current fields'

style.

• "Choose text color" changes the current fields' text color by

picking a color from the color picker or entering the colors' Hex

Code.

20

Technion


• "Margins" set custom margins for each field – top, left, bottom and

right margins.

• "Regex Filter" – enable users to update the value of the field.

This is an advanced feature.

For example, displaying the call number in multiple lines according

to some logic.

There are 3 ways to use assign filter:

o Built in functions that can be invoked from this field.

More details and the list of function in "Filter functions" chapter.

o Custom JavaScript functions.

In cases where there is a specific logic, it is possible to write JavaScript function and

invoke them for a specific field.

More details on JavaScript functions in "Administration" chapter.

o Regular expression.

The field excepts regular expressions which are executed once the focus of the field

changes.

More details on Regex: https://www.regular-expressions.info/quickstart.html

Regex examples:

Description Regex Input Output

Get last word after

space

[\s]+([a-zA-Z0-

9\u0590-\u05FF_]*)$

57 CHE CHE

Exclude first word ([a-zA-Z0-9\u0590-

\u05FF_.-\s]*)?\s

57 CHE TECH CHE TECH

• When done creating\editing the new template press the X button on the left

navigation bar and press the Actions→Save button to save your changes.

https://www.regular-expressions.info/quickstart.html

21

Technion


Printing

Once the required labels were created, and you are ready to print,

simply click on the print button on the top right corner of the screen.

The following validation screen will be displayed including 2 important

instruction to verify the configuration in the Chrome printing screen

that will be opened following this screen:

The Chrome printing screen will display a preview of the board on the right side and printing

options on the right:

• Destination – select the required printer

In case the printer is not in the list choose "See More…" to look it

up and add it

• Layout – verify that the layout either portrait or landscape is

aligned with the template and paper you would like to print. In

most cases the stickers are printed as portrait.

• Paper size - verify that the paper size is aligned with the template

and paper you would like to print.

• Margins – must be set to "None". In case there are margins on the

sticker page, they should be configured as part of the paper.

• Alternatively, it is also possible to use the system dialog that might

include additional options according to the selected printer.

Options like paper quality, tray and others. This option is available

by clicking the link at the bottom.

22

Technion


4. Call number

In LIBstick each part of the call number (after split) is displayed in a dedicated field.

There are 2 parsing options to split the call number:

Alma Parsing - Recommended

In Alma it is possible to select the required parsing routines for different call number types.

Alma is performing the parsing based on the configuration. The parsing results are then

retrieved by LIBstick and displayed on the label.

Creating a call number label:

1. Configure parsing routine in Alma:

https://knowledge.exlibrisgroup.com/Alma/Product_Documentation/010Alma_Online_Help_(

English)/040Resource_Management/080Configuring_Resource_Management/130Configuring

_Call_Number_Parsing

2. In LIBstick, create several fields according to the parsing routine

configured in Alma. For each field select call_number_parsed_x

as the source.

For example, Alma first parsing routine logic generate 5 lines

maximum. In this case there is a need to create 5 fields in LIBstick

and assign them the following sources:

o call_number_parsed_1





https://knowledge.exlibrisgroup.com/Alma/Product_Documentation/010Alma_Online_Help_(English)/040Resource_Management/080Configuring_Resource_Management/130Configuring_Call_Number_Parsing



23

Technion


LIBstick call number formats

For fields of type "Alma" with "call_number" selected as source

there is another menu: "Format".

The "Format" menu includes a list of predefined formats from

which it is possible to select the call number format.

The formats are configured behind the scense by the LIBstick

team. If you encounter a missing fomrat, please send 3

examples and if the request is generic and can server other

users it will be added.

The name of the formats is based on numbers. It is easier to watch the preview and select

the required format than to read a description. The last number of the name indicates the

maximum number of lines for that format. For example "Format 10-5".

Steps for implemntation:

1. Create new template or use and exiting one with "call number" field

2. Scan serveral barcodes of books with the required call number format so the labels will

be displayed on the board

3. From the "Actions" menu select "Edit"

4. Click the "Edit" icon on the

"call_number" field

5. Select different formats from the

"Choose Format" menu

6. The labels on the board will be updated automatically and displayed

according to the selected format.

7. Keep the format that is aligned with your needs

8. Select the required vertical alignment from the "Call number aligment"

menu

9. From the "Actions" menu select "Save" to save this template

configuration

• Pros - for using the call number formats

o Different call number format for each template

o Improved alignment

o The label layout will be much simpler because there is no need to

create a place holder for each call number field

• Cons - for using the call number formats

o Not all formats are supported

24

Technion


LIBstick field Parsing

In LIBstick there is a dedicated filter functions: "getCallNumber" (see appendix) for call

number parsing.

The function returns a sub string of the call number according to the index divided into 4

parts.

For example, displaying the call number after parsing in 4 lines.

The full call number is: "CA025.5877D866V 2009"

Function Result

getCallNumber(0) CA

getCallNumber(1) 025.5877

getCallNumber(3) D866V

getCallNumber(4) 2009

The template fields of the:

The formatting in the first call number field:

25

Technion


5. Alma Extension

Alma extension is a browser extension that adds LIBstick buttons in Alma screens.

The buttons enable to send physical items and entire sets from Alma directly to LIBstick.

Browser compliance

The extension can be installed on any chromium browsers:

Click here for an updated list of chromium browsers.

Installation

The extension can be installed in one click directly from the official Chrome store:

https://chrome.google.com/webstore/detail/libstick/cicjlffkhpekfdchiogaamjiplicggdf

https://www.google.com/search?q=chromium+browsers+list&rlz=1C1EJFC_enIL837IL837&oq=chromium+brows&aqs=chrome.1.69i57j35i39j0l6.5484j0j4&sourceid=chrome&ie=UTF-8

https://chrome.google.com/webstore/detail/libstick/cicjlffkhpekfdchiogaamjiplicggdf

26

Technion


Configuration

After the extension was added to the browse, the LIBstick icon should be displayed on the top

right corner.

1. Click on the LIBstick icon

2. Select "Options"

3. In the LIBstick configuration screen enter the link to your LIBstick account

You need to replace the name of the institute marked in red:

For example: https://libraries.technion.ac.il/technion-libstick/

4. Click "Save" button

27

Technion


Usage

After the extension is added to the browser LIBstick buttons will be automatically displayed in

the following Alma screens:

Physical Items search results screen

28

Technion


Physical Item Editor screen

Set Details screen

29

Technion


6. Administration

Manage Users

The account administrator is responsible to create users and assign them with the relevant role.

Create user

1. Click "Add New" in the admin menu

2. In the Username field enter a unique user name

3. In the Email field enter the user's email

4. Select a role. Detailed information about the roles in the next chapter

5. "Skip Confirmation Email"

By default the user is fully created only after the new user confirms the account by

clicking a link in the mail.

By selecting this check box it is possible to skip this confirmation by the user. The user is

fully created immediately after clicking "Add New User"

6. "Add New User" button to create the user. A welcome mail is sent to the user

Edit user

The administrator can delete and edit users. In the edit screen it is possible to update the name,

password, role and other attributes.

30

Technion


Manage Roles

New, dedicated LIBstick account is created for each institute. In some cases, more than one

account is per institute.

The institute assigns a focal point to manage as the account administrator with the role

"manager".

The "manager" can create additional users, assign them roles and perform different activities.

The following table describes the functionality available for each role:

Capability \ Role Name: Maker Designer Manager

Manage Self Profile + + +

Manage Users - - +

LIBstick – APIKEY - - +

CRUD Template - + +

Upload Fonts - + +

Upload Logo - + +

Manage Papers - + +

1. Manage Self Profile (Maker, Designer, Manager): update first name, last name, change

the display name, update the email address, update the password and more.

2. Manage Users (Manager): create, edit and delete users with following roles: Maker,

Designer and Manager.

3. LIBstick – APIKEY (Manager): update, check and save the API-KEY of the institute account.

The API-KEY from Alma need to have only READ permission.

4. CRUD Templates (Designer, Manager): manage templates - create, read, update and

delete templates for the institute account.

5. Upload Fonts (Designer, Manager): upload new fonts for the institute account.

6. Upload Logo (Designer, Manager): upload new logo for the institute account.

7. Manage Papers (Designer, Manager): manage (update and create new ones) paper types

attributes for the institute account.

Manage Images

31

Technion


Images can be used as part of the template to display for example the institute logo.

To upload a new image:

1. In LIBstick screen on the top right select Settings from the menu.

2. In the settings are select Media → Add New from the top left menu.

3. Click on "Select Files" to browse for the image or drag the image to

the screen.

4. After uploaded the image will be available in the Media → Library

screen

Configure Alma API-KEY

LIBstick retrieves automatically details from Alma is regards to items or SETs.

This is performed by an API call and is based on the API-KEY. The call will not work without the

API-KEY.

Steps to configure API-KEYs in LIBstick:

1. Login to Alma developer site:

https://developers.exlibrisgroup.com/manage/keys/

2. Create API-KEY (read only) for BIBs

3. Create API-KEY (read only) for Configuration

4. Open LIBstick administration screen → LIBstick menu → API's Keys

5. In this screen copy and paste both API-KEYS:

Screen Elements

o Region – the region of the institute.

32

Technion


o Bibs API KEY – required to retrieve item details from Alma

o Configuration API KEY – required for Alma SET import

o Save Keys – stored the API KEYS in LIBstick

o Check Keys – it is recommended to test that the keys are valid before saving

6. Click "CHECK KEYS" to check the keys

7. Click "SAVE KEYS" to save the changes

Manage sequence number

Sequence number is auto incremental (by 1) each time it is displayed in a label.

In the admin open LIBstick → Sequence Number screen to view and configure the value.

Configure papers

Papers configuration is performed according to the sticker paper used to print the labels. It is

possible to configure multiple papers and then use them with templates.

33

Technion


Screen Elements

o Name – the name of the paper. This name will be displayed in a dropdown in the

template configuration screen.

o Width – the entire width of the paper including margins.

The width is in millimeters.

Example #1, A4-portrait – width: 210 mm, height: 297 mm

Example #2, A4-landscape – width: 297 mm, height: 210 mm

o Height – the entire height of the paper including margins.

The height is in millimeters.

o Columns – the number of columns in the sticker paper.

o Rows – the number of rows in the sticker paper.

The number of columns multiplied by the number of rows indicates the number of

labels in each paper.

34

Technion


Screen Elements

o Margin horizontal – Margin in millimeters between rows.

It does not affect the margin between the first row and the top edge of the paper.

It does not affect the margin between the last row and the bottom edge of the paper.

o Margin vertical – Margin in millimeters between columns.

It does not affect the margin between the first column and the left edge of the paper.

It does not affect the margin between the last column and the right edge of the

paper.

Screen Elements

o Margin top – Margin in millimeters from the top of the paper.

If there is no margin, the value should be zero.

o Margin right – Margin in millimeters from the right of the paper.


35

Technion


o Margin bottom – Margin in millimeters from the bottom of the paper.


o Margin left – Margin in millimeters from the left of the paper.


Configure label layout

The label layout enables to configure complex layouts within the label.

This configuration is optional. By default, the fields in the label will be organized according to

order one after the other. All fields will have the exact same size.

1. In LIBstick admin click on "Label Layouts" in the right navigation

menu

2. Create new or edit an existing label layout

3. Add the title and click to launch the layout generator

4. In the layout generator you can

perform the following actions:

• Add new rows and columns

• Remove rows and columns

• Split cells

• Combine cells

5. There is no meaning to the name

of each cell

6. Always use percentage to indicate

the width and height

7. The total accumulation of the

width percentage should be 100%

8. The total accumulation of the

height percentage should be

100%

9. Once done, click the big save

button on the left

10. In the admin page, click on

"Publish" to save the configuration

36

Technion


Create JavaScript functions

Users with JavaScript knowledge can create custom function

to update the fields value.

The functions are created in the

admin area and invoked by name

in the field Regex configuration.

• Enter only the function body. The function deceleration

along with the opening and closing brackets will be added

automatically.

• The function name must start with "get".

• Input includes 2 parameters:

• str - the initial value according to the field source (e.g.

call number)

• param - the string that is populated in the Regex field

• The function should return a string

37

Technion


7. Security

• LIBstick is running on a secured domain - SSL (Secure Sockets Layer) certificate (HTTPS).

• LIBstick website successfully passed the Acunetix Security Audit.

• LIBstick is hosted on the Technion's secured computing department servers.

• LIBstick is built on top of WordPress CMS. The account is monitored and frequently updated

with the latest versions available.

• Safe login with CAPTCHA

• Login and activity auditing

38

Technion


8. Privacy

• We don't hold any sensitive information (passwords) about the institutes and the users. For each

user we store the email address, first name and last name.

• We don't share any of the information we have about the institutes and the users.

• We don't use the information we have for any commercial purposes.

39

Technion


9. Appendix

List of fields

Field name Area

1. mms_id bib_data

2. title bib_data

3. author bib_data

4. place_of_publication bib_data

5. date_of_publication bib_data

6. publisher_const bib_data

7. holding_id holding_data

8. call_number holding_data

9. accession_number holding_data

10. pid item_data

11. barcode item_data

12. creation_date item_data

13. modification_date item_data

14. physical_material_type item_data

15. year_of_issue item_data

16. enumeration_a item_data

17. enumeration_b item_data

18. enumeration_c item_data

19. enumeration_d item_data

20. enumeration_e item_data

21. enumeration_h item_data

22. library item_data

23. Library_desc item_data

40

Technion


24. location item_data

25. Location_desc item_data

26. alternative_call_number item_data

27. storage_location_id item_data

28. internal_note_1 item_data

29. edition item_data

30. imprint item_data

31. language item_data

32. call_no_parsed_1 item_data







39. title_abcnph item_data

Filter Functions

Filter functions are built-in functions that can be invoked by name in the field Regex configuration.

Function name Description Example

Syntax Input output

getFirstWord() Return the first

word

getFirstWord() 681.3 06

HTML

MOR

681.3

getSecondWord() Return the second

word

getSecondWord() 681.3 06

HTML

MOR

06

41

Technion


getThirdWord() Return the third

word

getThirdWord() 681.3 06

HTML

MOR

HTML

getWord(index) Return the N word,

starting from zero

getWord(3) 681.3 06

HTML

MOR

MOR

getFirstPlusSecond

IfThree()

Return the first

and the second

word if there are 3

words. If not

return only the

first word

getFirstPlusSecon

dIfThree

681.3 06

HTML

MOR

681.3

getStaticValue(stri

ng)

Return the string

sent as parameter

and ignore the

initial value

getStaticValue(Ce

ntral library)

681.3 06

HTML

MOR

Central

library

getStaticValueBefo

re

(string)

Return the string

sent as parameter

as prefix before

the initial value

getStaticValueBef

ore(Central )

681.3 06

HTML

MOR

Central

681.3 06

HTML

MOR

getStaticValueAfte

r

(string)

Return the string

sent as suffix after

the initial value

getStaticValueAft

er( Central)

681.3 06

HTML

MOR

681.3 06

HTML

MOR

Central

getSubString(start,

end)

Returns sub of the

string according to

the input

parameters:

Sstart - Required.

The position where

to start the

extraction.

getSubString(3,8) 681.3 06

HTML

MOR

.3 06

42

Technion


End - Optional.

The position (up

to, but not

including) where

to end the

extraction.

getSubStr(start,

length)

Returns sub of the

string according to

the input

parameters:

Start - Required.

The position where

to start the

extraction. First

character is at

index 0.

Length - Optional.

The number of

characters to

extract.

getSubStr(4,9) 681.3 06

HTML

MOR

.3 06

HTML

getBetweenCharact

ers(charStart,

charEnd)

Returns sub from

the first to the end

character

getBetweenChara

cters(.,!)

681.3 06

HTML!

MOR

.3 06

HTML

getConcatFields(fie

ld_A,field_B, …)

Concatenate

multiple fields

after the exiting

one. Each

concatenated field

will be displayed in

a new line.

The name of the

fields should be

based on the

names in

Appendix 1.

getConcatFields(ti

tle,author)

43

Technion


The names will be

separated by

comma with no

spaces nor quotes.

getCallNumber Returns sub string

of the call number

divided to 4

Click here for

example

Date post:	23-May-2020
Category:	Documents
Upload:	others
View:	0 times
Download:	0 times

User guide documentation May-2020 - Technion Library Portal · 2020-05-10 · • Design templates...

Documents