From a903911387ca31e49f115f5eb2aa4605b7600aaf Mon Sep 17 00:00:00 2001 From: Angela Kilsdonk Date: Thu, 10 Aug 2017 12:08:34 -0700 Subject: [PATCH] Docs: Web Client Data Types Updated chart of data type icons in web client. Signed-off-by: Angela Kilsdonk --- docs/media/datatypes_bool.png | Bin 0 -> 815 bytes docs/media/datatypes_id.png | Bin 0 -> 470 bytes docs/media/datatypes_int.png | Bin 0 -> 995 bytes docs/media/datatypes_interval.png | Bin 0 -> 560 bytes docs/media/datatypes_link.png | Bin 0 -> 975 bytes docs/media/datatypes_money.png | Bin 0 -> 958 bytes docs/media/datatypes_orgunit.png | Bin 0 -> 697 bytes docs/media/datatypes_text.png | Bin 0 -> 908 bytes docs/media/datatypes_timestamp.png | Bin 0 -> 649 bytes docs/reports/reporter_template_terminology.adoc | 43 ++++++++---------------- 10 files changed, 14 insertions(+), 29 deletions(-) create mode 100644 docs/media/datatypes_bool.png create mode 100644 docs/media/datatypes_id.png create mode 100644 docs/media/datatypes_int.png create mode 100644 docs/media/datatypes_interval.png create mode 100644 docs/media/datatypes_link.png create mode 100644 docs/media/datatypes_money.png create mode 100644 docs/media/datatypes_orgunit.png create mode 100644 docs/media/datatypes_text.png create mode 100644 docs/media/datatypes_timestamp.png diff --git a/docs/media/datatypes_bool.png b/docs/media/datatypes_bool.png new file mode 100644 index 0000000000000000000000000000000000000000..c00b467ebe53114ad26a85f80fb580b07a4b8d82 GIT binary patch literal 815 zcmeAS@N?(olHy`uVBq!ia0vp^a~60+7Besim4Gngy)^j>prBBRYeY$Kep*R+Vo@rCdr@j?UU5c#Nn9ug zPz%#CPZ!6KinzD8H+nw~kU8-2_k1hXmOQ_*PH&eD{~Z=O3!b^A8T|5*O012=CDrbf z34H8M2X%vEUI{%^xbVat7Ku+w zr=59!cePnX*wuYS@1J{aYum3T8kqV~h-dDiozYXD@-&Mx_B*Lnoyr#U-SwLxfAg-% z9s#qi9GP<6vtaFRmlfIZ?3|JrUZ*DQ_+LNyM{?MFE)&_OI#TnQ&p))1cNfvKTcNR> zf3LIOF#4bJIT9EL*fd=Xw`khs^T6m!-`OpNwQ0j@3o( zl`s7Dx-#YPcUNAg#g}jHDKdJ?bkxrC5$l=Dp-URx`Ax2wGOm0T~p z>lvGQQlfrd-Otdr>#e}^sZQ}f)*G*hJPGgy;LR;lHET0Q@fm!Eu8d&IRn+Lm8qJNdS#6)t}7^fV#UkxbC;OWpm#t$mQBns| hLIE?6=WqVWo3qI0TH1e8Q($^#@O1TaS?83{1OTMgb-Dlm literal 0 HcmV?d00001 diff --git a/docs/media/datatypes_id.png b/docs/media/datatypes_id.png new file mode 100644 index 0000000000000000000000000000000000000000..df178e0a7fef465be41d44a134496a08b3258a92 GIT binary patch literal 470 zcmeAS@N?(olHy`uVBq!ia0vp^ML=xN!2~2XS8~q)QjEnx?oJHr&dIz4a#+$GeH|GX zHuiJ>Nn{1`ISV`@iy0V%Nq#w5)KdVtz2%n*NJc98@2B02A_FO*B;3od~k0;3WtQ11lQa> zQxi^VS)BYfW!gS|-~B55`4i>c7|(PWXdha`u~`X)p;UiuUCo>|->@2zP11W literal 0 HcmV?d00001 diff --git a/docs/media/datatypes_int.png b/docs/media/datatypes_int.png new file mode 100644 index 0000000000000000000000000000000000000000..3182ce0a37d4e7606afd8d6711876c25fbb2a1f1 GIT binary patch literal 995 zcmeAS@N?(olHy`uVBq!ia0vp^)j;gY!2~2HiJ$8OQjEnx?oJHr&dIz4a#+$GeH|GX zHuiJ>Nn{1`ISV`@iy0V%NQ6xrM+pg-Yy9ltGNLurY+6eyHJm9`VNnUB^tX} z7Fx*gvCov@vJ~KMXLntwP{P5%sCav?t$g<}^OgFh=YJP{uX$N;C7W6P{yw{(A5|9> zC>Or*kg*mz-gjgpG0YGl{vx&HS(F ziZZ@wULEcIWvnqqzUJ)37EAVs2-M4(Zi>CTd+ztT!-=V?@iq7C*?FgY*~ZU4ZA!_< zgc43M&8MfsHrvbiKXW{Av+MBn1iO!SZZ8Y9d*rz~|> z{Cf%>eqVP!_+jqO?wHuZy;;>s%CQpb9>iblP7g2r;rh{Ij`BKb-Ta+x{|i%2v#0O) z&9`=X-024^C;w=ySo)Tm{~Y)AGdCaqm@V?_?ct4+k0d`@W-T6bm*<*h_O0;g#yRVs zv%lBqeBUWDXa0vn7jwlwZ9V?~bj7aQ@y}KE?PvRXI*>tMHuS^ZjW^eLn+N~67MJs@ zC-<3(-2c_rXLEK>y?px{uYH=G&coT(t#O|p9G-mS@uOK`TaLdkj`Mn*IX(COgmX9h z!jgA$=)ZS))cz=^JEPY=>iNSj_l&ZReS4iH694Goj?kv~?c$xEkKF9Yu;=RU*sU7h zuTr>g$FixiA2-(APK$fu{>bxD&fL$(`}=3#TN0D6{xPL6EpMyLa^)XaHwEqSw28Ip z{#X8S@w)!`M(>U?99h!sUZ?(YQgmx*xu{E`>-;S$!a~5u?Jt|YM?uF9w z77OW9fzL#pe=$eum>wzI_9-d+Q^F5(*CUH>?q$@QsrvWlcHdPU?&tUR$lL3bsuyVN z)Kvag=52Sl)AdVRY1v9;IalrbetUX9>?~ULMR@-A5TW$9cV^qi&fnWueoI6+-Ijm7 zko+Z)_h(-H4eFS^be=`F?3ubdrg}Z6BzJI5*On0HO@GjBr`I)M(xd++Dt)q@$?lJC iOtdH?#LNr)!v1tEV~F>1OJ!glWbkzLb6Mw<&;$TFKhjkI literal 0 HcmV?d00001 diff --git a/docs/media/datatypes_interval.png b/docs/media/datatypes_interval.png new file mode 100644 index 0000000000000000000000000000000000000000..3c907fa274c40aa16f91eebb042d91020c141dea GIT binary patch literal 560 zcmeAS@N?(olHy`uVBq!ia0vp^xj<~n!2~3axPO`rq!^2X+?^QKos)S9a~60+7Besim4Gngy)^j>prBBRYeY$Kep*R+Vo@rCdr@j?UU5c#Nn9ug zPz&R7PZ!6KinzBo7M?!jAam^F_xh+PqaX4a7Z)WM@bV;yPWIG^I+7&eopfq4LXD7pIY+x&H}XJ4+%c_17q{hs^X;;s!B10U~W ze>R6@Z@gyU?}F{(Drw4D->kC!#B)quouQ?9x_piQ{m*lpQa)~48(y)qFRxm1|Hqv- pWzQGB?2iPBY+Xg;OXk;vd$@?2>|3a_%Z+h literal 0 HcmV?d00001 diff --git a/docs/media/datatypes_link.png b/docs/media/datatypes_link.png new file mode 100644 index 0000000000000000000000000000000000000000..559d756ca5474712f054d02e0e559ed4036deb1e GIT binary patch literal 975 zcmeAS@N?(olHy`uVBq!ia0vp^`9SQ#!2~23&ipw9BpHi?+?^QKos)S9a~60+7Besim4Gngy)^j>prBBRYeY$Kep*R+Vo@rCdr@j?UU5c#Nn9ug zPz$r0r;B4qMcmulhTg9OL=JrXKG%wsOO|E3pPyc7F;|I3Q=Z?^g*!?NyDdCq<1{?l z9w~6}8;QsqX?mh7*pk=iwBW+qyA}EIv+rd4KHXF8H}83Wa9-(;n{)0g`IUU|;L%wV zHmaqp;grmFI);lG>RxQtdo1yXca80F&sBUvtGQ<7FT8%QG;62S+I9AxSGZ5O#2VLr z;(O&4u=?W8-m9-OT%wF+zkj!1GR5-U1Obg$U*V_sUZ&pHl~ZBy3c2iKdFslg>5P#9 zU9+S$Qd1mHX4ZLWF6Q*|-mJ3p49lxu>$5~von}P`o+=4=uH$m&X7I&7OiR~rM7_5? zcXiTVkBnK{UM$r}tqizcAAJ0+yTj+J*N@#7n-aPC#i`KyKhK&@-u?KH?vBnPx%Tf9 zD;3Tya;$!$49kgJk@!AdzKkht+&Z|r&c5t^B}lugQ@t(1xs5(QXRin zC4Y96Gb}lK=RxpPmR#Nm$Crq;J+t9E_c!D1ktxmk;hGngnFngSY+AST&c`R~_h**; z6}>Q7a4r8Wo$O`(&+GkPA9`TiV0FAac4oAB7uTxo)_5mFBlsmg{#}|M;u8 z;_|nzr%PqS~ zs=Y?DnXmk_Ik@QAFJ`{)ub91xt(MLZ+94k$;e1I%`18^?CyWE-D*T^pd#BVr>+|ur zf0h1{0m4t~=HH8*aOPR42JiV#(F@KytajDhv{Liiz1H-@vmLbEH8-u+?D;a=LpVcJ z({-Dv>-?s$DM2j@G;c9P#d-<$Ejz(+YyTR9r5wJ&DGa(HnqGp-mTByJYcgey*j3$M zZ4*pgPab){jcdudyxZKFwmI6O`JOJi522WQ%mvv4FO#u5$z(4>1 literal 0 HcmV?d00001 diff --git a/docs/media/datatypes_money.png b/docs/media/datatypes_money.png new file mode 100644 index 0000000000000000000000000000000000000000..34d5f36cadf25577694e4559a5d030f926ef9a04 GIT binary patch literal 958 zcmeAS@N?(olHy`uVBq!ia0vp^*+6W|!2~2#xfnJADaPU;cPEB*=VV?2IV|apzK#qG z8~eHcB(eheoCO|{#S9EWB_ParFHODzC@56o8c`CQpH@Eakt5%>1i#_UG{G6z2Xo>agP6QUU>iI=i}+@?E!7!1(!mL0`JRMv=|9J;hmZAqW{;j zy5OnY3)n@Uyy{K+BllC$M$kWl#rghQv(uV8zJ6L-b=~!8hjW3I(YpQv8qPsW-}*g_ zZ*6xl_;N;@GiOuymAMRY4mpol@3Kn*wM8xJ z!`W4g9#fXowBL^Twb^3Mm%QL>rmu7B+;W;&@6QzT?7jEu(wz;n60cW3dTF`Tx-s~X zkha7ZsRY5RHSBlx$njM9T1b37`t4!Qh9g{lLGLx+O8RXuTfZWH^8dn1Vs-j=%n!~? zcb}bFapTbUGdoxwf8VOx^g`&5r%^_uP{@@zPlIN%7(e|V(wG^#a8;>nzE_hZx6E6X z1wo!apSrcO{Fkqmes|-t=#waC^LcFVxch2jj6OE$tdBlz6`nBb``(EkToZIensom6 zN7|pZi9aE~x<4WJ8qlB*?jWCB|Y<+dvoq_-;;db`M~J?%6apScgg9!nW=F4 z_eL8&&1n}D7X~=qH%w|4v#xZ%y=(R7w@>^64C5d6OlaZqTl3?#rd?cWuIL;~sW}~1 zDF>IdmRNTPr-|D&di^+ad_xx2o>F(!)TlJ^&*P3ol zw2N3X`|!^v39$we{9nGfwT4|;cw3Lj&E{os?AN3ERU5c^6G9{^oKI)0yjpBo zcw76#Qt!~}EipCCbtz37x2<1M=-RaBp(xL>a|`Te*#ArVm6WNwr|Gv4QYyt{#&5o9 ZU%ocXo>5?j3^02!c)I$ztaD0e0szE^xUv8M literal 0 HcmV?d00001 diff --git a/docs/media/datatypes_orgunit.png b/docs/media/datatypes_orgunit.png new file mode 100644 index 0000000000000000000000000000000000000000..bb11f53b96582a37208cc1f4b74b225de5e220a5 GIT binary patch literal 697 zcmeAS@N?(olHy`uVBq!ia0vp^1wd@e!2~3Kxm2wKQjEnx?oJHr&dIz4a#+$GeH|GX zHuiJ>Nn{1`ISV`@iy0V%NUj2ZIk=wi|L^74_={^@ZfU>S)_IdeEeZn@! zY*q)&THrd(=Kbv!ndKkPY^qb^+_m+K4gbkiQ{?1->RM>BGO~=qUPuAnk$=nmR`&Fxq0pzi@IKu47(M7;f1tK%3|bP0l+XkK9P~VL literal 0 HcmV?d00001 diff --git a/docs/media/datatypes_text.png b/docs/media/datatypes_text.png new file mode 100644 index 0000000000000000000000000000000000000000..e87683d6a0d1c00e396bcd53dbd30388bb2ccc04 GIT binary patch literal 908 zcmeAS@N?(olHy`uVBq!ia0vp^1wib;!2~3If23>#QjEnx?oJHr&dIz4a#+$GeH|GX zHuiJ>Nn{1`ISV`@iy0V%Nl^JBRR|1!!wJ`CN}?IeWN0Gx@T>EBkBCbG^OHg{4}b zsI*kgE#9<@3JG^+3cK7+D?s@)`3l4DiK0dMJ+TR70 zCKp;~6{ZC3{hq-p@xZB6=IY%v(;9b?+mkJIo0y_sM7Qh2eZA_wU2LEFr*|D;j*Pk{ zU5gE_{k`Yrm3%5cru?DpC{`}pcaJCVr7 zOUK%UcHR7Ug2iJ!i|2~I#mtQ_rZRBW?p-}$=Ar4Qwx6<(e|mmPOmOv#OXWA2-Btv~ zzLUJE>F>@^rK;id*y2|G^K(_4ig_PxdAk|Eu2A-k^H-V_Leep_k9P&7oLgWTl$|LU&=#DkYQro`=@S_ WT{1~f*A19i7(8A5T-G@yGywo$@SJ-9 literal 0 HcmV?d00001 diff --git a/docs/media/datatypes_timestamp.png b/docs/media/datatypes_timestamp.png new file mode 100644 index 0000000000000000000000000000000000000000..e2bb18c4a77bcc9209ccb70e8d281fa8f0b4ab98 GIT binary patch literal 649 zcmeAS@N?(olHy`uVBq!ia0vp^c|dHEakt5%>1iMsKD>nPVUSsjDj%aI`ECi?wN*Rb-VRz@F*H(myRb!-PYf^T@O| z2M!sQ=$t|hX2${x0j7uBru^PJPvu}@|9kH8^X;?i%JtdfZTRkeKAM)0*zR# zDgM~caxzz{*V~PAx=y{mwswn7yjS$sb?VDYjAw0n@6kBHctY_-pQvp*F`J`>Emukg zADZD|DZe$Z>)OoJr)KltIjHTQ<8IG&vv;}mgmYqH%e}tued(09qP=m-tg!TY{;u+MZI7P@zXK^RJUYdIEvT-Zw<_P3 z_jra{`IYANvMBB~ob@T}?dLY@9k18k&$I|~EsI;h9(>3^wddj#_n&Lub3J75e6vvM zX-bmp>eY*MeS%KeCVS0LS*l~6^7`S;jVU2nC(>MwTLv#?zd7&4m8+o_#nd!azi^ y(e>9{PfxLaeB=LX^K~8=1O2nVeoYIb6Mw<&;$UI{1tWp literal 0 HcmV?d00001 diff --git a/docs/reports/reporter_template_terminology.adoc b/docs/reports/reporter_template_terminology.adoc index dd131b460a..d12b2aa9a2 100644 --- a/docs/reports/reporter_template_terminology.adoc +++ b/docs/reports/reporter_template_terminology.adoc @@ -6,37 +6,22 @@ Data Types indexterm:[reports, data types] -The central column of the _Database Source Browser_ lists _Field Name_ and _Data -Type_ for the selected database table. - -image::media/view-output-2.png[view-output-2] - -Each data type has its own characteristics and uses: +The information in Evergreen's database can be classified in nine data types, formats that describe the type of data and/or its use. These were represented by text-only labels in prior versions of Evergreen. Evergreen 3.0 has replaced the text labels with icons. When building templates in _Reports_, you will find these icons in the Field Name Pane of the template creation interface. [options="header,footer"] -|==================================== -|Data Type |Description |Notes -|id |Unique number assigned by the database to identify a -record |A number that is a meaningful reference for the database but not -of much use to a human user. Use in displayed fields when counting records or -in filters. -|text |Text field |Usually uses the Raw Data transform. -|timestamp |Exact date and time |Select appropriate date/time transform. -Raw Data includes second and timezone information, usually more than is required -for a report. -|bool |True or False |Commonly used to filter out deleted item or patron records. -|org_unit |A number representing a library, library system, or -federation |When you want to filter on a library, make sure that the field -name is on an org_unit or id data type. -|link |A link to another database table |Link outputs a number that is a -meaningful reference for the database but not of much use to a human user. You -will usually want to drill further down the tree in the Sources pane and select -fields from the linked table. However, in some instances you might want to use -a link field. For example, to count the number of patrons who borrowed items you -could do a count on the Patron link data. -|int |Integer -|money |Number (in dollars) -|===================================== +|======================== +|Webby Icon|Data Type |Description |Notes +|image::media/datatypes_timestamp.png[] |timestamp |An exact date and time (year, month, day, hour, minutes, and seconds) |Select appropriate date/time transform. Raw Data includes second and timezone information, usually more than is required for a report. +|image::media/datatypes_link.png[] |link |A link to another database table |Link outputs a number that is a meaningful reference for the database but not of much use to a human user. You will usually want to drill further down the tree in the Sources pane and select fields from the linked table. However, in some instances you might want to use a link field. For example, to count the number of patrons who borrowed items you could do a count on the Patron link data. +|image::media/datatypes_text.png[] |text |A field of text |Usually uses the Raw Data transform. +|image::media/datatypes_bool.png[] |bool |True or False |Commonly used to filter out deleted item or patron records. +|image::media/datatypes_orgunit.png[] |org_unit |Organizational Unit - a number representing a library, library system, or federation |When you want to filter on a library, make sure that the field name is on an org_unit or id data type. +|image::media/datatypes_id.png[] |id |A unique number assigned by the database to identify each record |A number that is a meaningful reference for the database but not of much use to a human user. Use in displayed fields when counting records or in filters. +|image::media/datatypes_money.png[] |money |A monetary amount +|image::media/datatypes_int.png[] |int |Integer (a number) +|image::media/datatypes_interval.png[] |interval |A period of time +| | | | +|======================= [[field_transforms]] Field Transforms -- 2.11.0