-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathlibilsws.yaml.sample
268 lines (268 loc) · 11.2 KB
/
libilsws.yaml.sample
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# Validation types and rules used in field definitions
#
# blank => 'b', // must be blank
# date1 => 'd:YYYY-MM-DD',
# date2 => 'd:YYYY/MM/DD',
# date3 => 'd:MM-DD-YYYY',
# date4 => 'd:MM/DD/YYYY',
# email => 'e',
# timestamp1 => 'd:YYYY/MM/DD HH:MM',
# timestamp2 => 'd:YYYY-MM-DD HH:MM',
# integer => 'i:1,99999999', // integer between 1 and 99999999
# JSON => 'j', // JSON
# number => 'n:1,999', // decimal number between 1 and 999
# regex => '/^[A-Z]{2,4}$/' // Regular expression pattern
# string => 's:256', // string of length <= 256
# url => 'u', // URL
# value_list => 'v:01|11', // list('01', '11')
#
# List of fields to include in new and modified records. Do not include unused fields or user categories.
# For every field there are five possible values:
# validation: Required validation rule
# alias: Alternate name of the field in the patron array if different from the internal field name
# default: Default value in overlay or new records
# type: Use "address" to flag all address fields
# For new_fields, you must also include the
# required: true|false
#
# Set debug to true for various types of debug messages
debug:
config: false
connect: false
fields: false
query: false
register: false
update: false
# API connection parameters
ilsws:
username: USERNAME
password: PASSWORD
hostname: HOSTNAME
port: PORT
webapp: WEBAPP_NAME
app_id: APP_ID
client_id: CLIENT_ID
user_privilege_override: OVERRIDE
timeout: 60
max_retries: 3
max_search_count: 20
# Configuration for PHPMailer
smtp:
smtp_host: 'smtp.host.domain'
smtp_port: 587
smtp_protocol: 'tls'
smtp_autotls: true
smtp_timeout: 30
smtp_username: USERNAME
smtp_password: PASSWORD
smtp_from: 'webmaster@host.domain'
smtp_fromname: 'SENDER NAME'
smtp_replyto: 'no-reply@host.domain'
smtp_allowhtml: true
smtp_default_subject: 'Welcome to Multnomah County library'
# SirsiDynix Symphony parameters. For the most part, these must match values you have configured in
# your Symphony system.
symphony:
# Use this setting to determine the default fields to return from the search_patron function
default_patron_include_fields: 'profile,birthDate,library,lastActivityDate,alternateID,firstName,middleName,displayName,lastName,address1,barcode,category01,category02,category07,category11,lastActivityDate'
# Make Libilsws validate each field included in a $field_list variable
# or includeFields parameter against the API. Set the item to false to
# increase performance for production systems, once testing is complete.
validate_catalog_fields: true
# Set the following item to true to validate patron search indexes against the API. Set the item to false for
# better performance with production code.
validate_patron_indexes: true
# The age_ranges are used to map a particular age range to a profile. If you don't use age based profiles,
# set 1-120 to your default profile
age_ranges:
1-12: '1_MULT_Y'
13-120: '0_MULT'
# If you set this value, it will be used to set the days before expiration of online accounts
online_account_expiration: 90
# Template path (www user must have read access)
# template_path: '~/web/themes/custom/multcolibtheme/templates/content'
template_path: '/Users/johnh3/Documents/php/ilsws/templates'
# Template cache (www user must have write access)
#template_cache: '~/web/sites/default/files/php/twig'
template_cache: '/Users/johnh3/Documents/php/ilsws/templates/cache'
# The overlay_fields section defines the fields that may be used in the update_patron and register_patron functions.
# The order of fields does not matter, but all address fields must get the "type: address" attribute. Other types are
# not required as of this version, but may be added later. Empty fields sections or attributes will cause errors.
overlay_fields:
key:
alias: 'patron_key'
validation: 'i:0,99999999'
profile:
validation: "v:0_MULT|1_MULT_Y|2_METRO|3_METRO_Y|PASSPORT|PASSPORT_Y"
default: '0_MULT'
pin:
alias: 'password'
validation: 'r:/^.{4,25}$/'
language:
validation: 'v:ARABIC|CHINESE|DUTCH|ENGLISH|FRENCH|FRENCH-AF|GERMAN|HUNGARIAN|JAPANESE|ROMANIAN|RUSSIAN|SOMALI|SPANISH|VIETNAMESE'
default: 'ENGLISH'
library:
alias: 'home_library'
validation: 's:4'
firstName:
validation: 's:25'
middleName:
validation: 's:25'
lastName:
validation: 's:60'
birthDate:
validation: 'd:YYYY-MM-DD'
barcode:
alias: 'patron_id'
validation: 'r:/^[A-Z0-9]{6,20}$/'
STREET:
alias: 'street'
validation: 's:128'
type: 'address'
CITY/STATE:
alias: 'city_state'
validation: 'r:/^[[:word:] ]{4,128}$/'
default: 'Portland, OR'
type: 'address'
ZIP:
validation: 'v:97002|97003|97004|97005|97006|97007|97008|97009|97010|97011|97013|97014|97015|97017|97019|97022|97023|97024|97027|97028|97030|97031|97032r97034|97035|97036|97038|97041|97042|97044|97045|97049|97055|97056|97060|97062|97064|97067|97068|97070|97071|97075|97076|97077|97078|97079|97080|97086|97089|97106|97109|97113|97116|97117|97119|97123|97124|97125|97129|97133|97140|97144|97201|97202|97203|97204|97205|97206|97207|97208|97209|97210|97211|97212|97213|97214|97215|97216|97217|97218|97219|97220|97221|97222|97223|97224|97225|97227|97228|97229|97230|97231|97232|97233|97236|97238|97239|97240|97242|97250|97251|97252|97253|97254|97255|97256|97259|97266|97267|97268|97269|97271|97272|97280|97281|97282|97283|97286|97290|97291|97292|97293|97294|97296|97298|97362|97375|98601|98602|98603|98604|98605|98606|98607|98610|98613|98616|98617|98619|98620|98622|98623|98628|98629|98635|98639|98642|98648|98650|98651|98660|98661|98662|98663|98664|98665|98666|98668|98670|98671|98672|98673|98674|98675|98682|98683|98684|98685|98686|98687|99322|99356'
EMAIL:
alias: 'email'
validation: 'e'
type: 'address'
PHONE:
alias: 'telephone'
validation: 'r:/^(\d{3})(-{0,1})(\d{3})(-{0,1})(\d{4})$/'
type: 'address'
# This element is used to configure SMS phone numbers only, and requires a fixed parameters array. See test scripts for details.
phoneList:
alias: 'sms_phone'
category01:
alias: 'county'
validation: 'v:0_MULT|1_CLACK|2_WASH|3_HOOD|4_OTHER_OR|7_CLARK_WA|CAMAS_WA|KLICK_WA|OTHER|SKAMA_WA|UNKNOWN'
category02:
alias: 'notice_type'
validation: 'v:EMAIL|PHONE|TEXT|UNKNOWN|US_MAIL|Z_NONE'
category03:
alias: 'school_district'
validation: 'v:YES|NO|UNKNOWN'
category04:
alias: 'filter'
validation: 'v:YES|NO|UNKNOWN'
category05:
alias: 'library_news'
validation: 'v:YES|NO|UNKNOWN'
category06:
alias: 'friends_notices'
validation: 'v:YES|NO|UNKNOWN'
category07:
alias: 'program'
validation: 'v:BOOKS2U|CONNECT|EVERYCHILD|LISTOS|PCO|RR_AGENCY|SCHOOL_OUT|SCHOOLCORP|WSYL|UNKNOWN'
category08:
alias: 'mailings'
validation: 'v:YES|NO|UNKNOWN'
category11:
alias: 'online_update'
validation: 'v:YES|CHECK'
default: 'YES'
category12:
alias: 'los'
# This section defines the fields used by the register_patron function to create new patron records.
# Note: the fields here *must* match those selected in the ILSWS Self-Registration Configuration.
# However, you may make the aliases the same as those in the previous section. Fields in this section
# must include the boolean required attribute. The order of fields in the configuration does not matter.
new_fields:
barcode:
alias: 'patron_id'
required: false
validation: 'r:/^[A-Z0-9]{6,20}$/'
profile:
validation: "v:0_MULT|1_MULT_Y|2_METRO|3_METRO_Y|PASSPORT|PASSPORT_Y|ONLINE"
default: 'ONLINE'
required: true
library:
alias: 'home_library'
validation: 's:4'
default: 'CEN'
required: true
language:
validation: 'v:ARABIC|CHINESE|DUTCH|ENGLISH|FRENCH|FRENCH-AF|GERMAN|HUNGARIAN|JAPANESE|ROMANIAN|RUSSIAN|SOMALI|SPANISH|VIETNAMESE'
default: 'ENGLISH'
required: false
# This element is used to configure SMS phone numbers only, and requires a fixed params array
phoneList:
alias: 'sms_phone'
required: false
pin:
alias: 'password'
validation: 's:25'
required: false
firstName:
alias: 'firstName'
validation: 's:25'
required: true
middleName:
alias: 'middleName'
validation: 's:25'
required: false
lastName:
alias: 'lastName'
validation: 's:60'
required: true
birthDate:
alias: 'birthDate'
validation: 'd:YYYY-MM-DD'
required: true
STREET:
alias: 'street'
validation: 's:128'
required: true
type: 'address'
CITY/STATE:
alias: 'city_state'
validation: 'r:/^[[:word:] ]{4,128}$/'
default: 'Portland, OR'
required: true
type: 'address'
ZIP:
alias: 'postal_code'
validation: 'v:97002|97003|97004|97005|97006|97007|97008|97009|97010|97011|97013|97014|97015|97017|97019|97022|97023|97024|97027|97028|97030|97031|97032r97034|97035|97036|97038|97041|97042|97044|97045|97049|97055|97056|97060|97062|97064|97067|97068|97070|97071|97075|97076|97077|97078|97079|97080|97086|97089|97106|97109|97113|97116|97117|97119|97123|97124|97125|97129|97133|97140|97144|97201|97202|97203|97204|97205|97206|97207|97208|97209|97210|97211|97212|97213|97214|97215|97216|97217|97218|97219|97220|97221|97222|97223|97224|97225|97227|97228|97229|97230|97231|97232|97233|97236|97238|97239|97240|97242|97250|97251|97252|97253|97254|97255|97256|97259|97266|97267|97268|97269|97271|97272|97280|97281|97282|97283|97286|97290|97291|97292|97293|97294|97296|97298|97362|97375|98601|98602|98603|98604|98605|98606|98607|98610|98613|98616|98617|98619|98620|98622|98623|98628|98629|98635|98639|98642|98648|98650|98651|98660|98661|98662|98663|98664|98665|98666|98668|98670|98671|98672|98673|98674|98675|98682|98683|98684|98685|98686|98687|99322|99356'
required: true
type: 'address'
EMAIL:
alias: 'email'
validation: 'e'
required: false
type: 'address'
PHONE:
alias: 'telephone'
validation: 'r:/^(\d{3})(-{0,1})(\d{3})(-{0,1})(\d{4})$/'
required: false
type: 'address'
category01:
alias: 'county'
validation: 'v:0_MULT|1_CLACK|2_WASH|3_HOOD|4_OTHER_OR|7_CLARK_WA|CAMAS_WA|KLICK_WA|OTHER|SKAMA_WA|UNKNOWN'
default: '0_MULT'
required: false
category02:
alias: 'notice_type'
validation: 'v:EMAIL|PHONE|TEXT|UNKNOWN|US_MAIL|Z_NONE'
default: 'US_MAIL'
required: false
category03:
alias: 'school_district'
validation: 'v:YES|NO|UNKNOWN'
required: false
category05:
alias: 'library_news'
validation: 'v:YES|NO|UNKNOWN'
required: false
category06:
alias: 'friends_notices'
validation: 'v:YES|NO|UNKNOWN'
required: false
category11:
alias: 'online_update'
default: 'CHECK'
validation: 'v:YES|CHECK'
required: false