From 66ddbd8b3e2296687f64bfe75da2a481fe17d807 Mon Sep 17 00:00:00 2001 From: woodjes Date: Mon, 21 Aug 2023 11:22:53 +0100 Subject: [PATCH] Documentation for entity overlay diagrams #CTCTOWALTZ-2784 #6688 --- .../entity-overlay-diagram-section-view.png | Bin 0 -> 31866 bytes .../entity-overlay-diagrams.md | 164 +++++++----------- 2 files changed, 58 insertions(+), 106 deletions(-) create mode 100644 docs/features/aggregate-overlay-diagrams/entity-overlay-diagram-section-view.png diff --git a/docs/features/aggregate-overlay-diagrams/entity-overlay-diagram-section-view.png b/docs/features/aggregate-overlay-diagrams/entity-overlay-diagram-section-view.png new file mode 100644 index 0000000000000000000000000000000000000000..56ccaa0115acfe8d6b71f7640cff7df6956db9df GIT binary patch literal 31866 zcmeFZc|6qZ+dn*#CM{DUim@bHWh-Iqgd}^4>`JmPLv~|G8)8TydnmF-_GM7^UDoWz zz77V1G2{6RUDvnky07p3+^^sLJip)bdS16b=4EEi&v_o_aUSdYIL-;sR98BAjPV!< z1UjjFOW_U(bQl5x9g;tK1o$MVL8k!(@|IIpkh|+{yf|zZ3hjxT@fuk!L*&wUeb1$- z;T`X1n?8viDd4JO;98t|APZSsu#u$bKarfPXSQfA`#6}U!Oy$Z9O|yad;k8LHRw3X zR`15q3mo0AXwJDXT?h>gedef=m3q^Hj;nOwgF(PY$|q_mem!#f#u<6I z?4J|V{4YH6h#w+N+A`Znl_4q*)`Mps)_33xo z$>#@S3(T)T)bBtKMku`x^rz+i^Q}DH!5VBdwfloXw-n&}13_oB4xaE;_}36QRu7k6 z&iO9nvh(NCH5JkHvgwK>k=Lb>OibQ_uu;3?r;1ber|CFSE0^7tc2b4quA8@2dg%wV zqR)CNBf5mx1>38&)oO0inJhm2BJ#uVVeR;|mM@EW4@fY5dif4CRvR2*vcjA2 zh-o^_hKY9lN_O~1*(238d&f5VkF;;xRD}!LbV#WUqCH>iB=Mih_PSpoz8nw89l)E^ zW4w^I&%&+p4wU$ zbj#H6rPUH2-3d^=^-#OgBL1Php#WZn?*x4DRJmQclA$cl^u~bTS3iC?d_T7*7A!- z11RU;Ta9ll50oesw7PE(~G1ZrrQJf?k`1ju+$fBP)qe8lVRe6h5U=D-Mw)ydtxMR z$YTrJQk(rnm1NcoO}N{xvp8g2KN|dbNoi^ugQ=~4;dqC6E8DXT|M7WYd7ytdHiNq| zrCn4$OOVz|11<=2uom>#!z`W3u+YiTrnE89YM0zKa`BIUg}m&8#Gh=Vj?^g8YSrHg zWV~N-t957o<9t`2(RrWiH|W881-af$cQ=TsOfyE;Oj?Z)`S1aHVZ2J|t>Qbwt1IjU z50^^EJXz2}<*Z2f%;kcw+vk!nrUO~?g&Ibm?BhPR?*)3Uu{e)_dx(8T>GpvUGC~W@ zZ7z#U-mqc^UGJsp*;PJm=T^H`cg~82eN{Moj1O`>RkGnOqa}AYljk?|+!sda9j$fy zJ*onW(F+CQA|LQ#i7!eooeE*m_HT1xxf`P`eTPN>0!dTsT30B!Ns!B)d6i6?c1zaK)-aM|A8Ydcc@4kBJaUwFkEE+E_^zjvm=Ym~smkP`YavM))b|UN~GhM|ZQQ@rjI%s?1l9g)9 z1}(bBx=y8Yi@ripPU=9Tl$~QRiOe1{Ndn&G7eusB3aKTv)xq=Uwzzu1_Vona+S`GY5r+p_BYQh8^= z=R;s$7MX^#j`U?~U!iZ)J=I>!2fJJ)joswjxym^-J$u;5pZY&(R?1m58uQZw~^AyVl~aeKvf+EX+Z3Ez(FG1{4+VRFUMP?4#g?Uv71vg;Kr#gTeGHc*Soj?fVi@pzPh6_d+am+Y8=tfpp_&dpf~zQ4Lt}=#Mt&;; z%{=u|zIm3wd~+5|@FmV5+(rZb#R12@K^&6+w-8HI5vw+%_fE-3%MY6}fUC`Jm$uG& zL1QshaVrboOuv7_J|BH&YVX|iZoXH7RR`4?bva%X#|-Xeko;s=i7go|nm8+5v`rNl zrlEFk)MQJVYM;@M?s~&bk*U=--{*{Znj?yvDM017Q{F1sQZ3W0Sx+VJJ<9*s6t=YX3piPLlfFX>Gen4GU7Hn zDPkCEg8W^Tpsy>FmfP<`7Y#|nD?!w$tyYrUt0)Is_tGd#;?(N_w1>a`b!^%Er%U5F zpS=O~I&uI4>ekJz_1oZPSQ5DL1TCm#%s)mCHmlc27ZshSCS54FC_cdEIGHj4AIqE( z9|%V}!A+eP2q%p@SpB}JFKhv1I%s~)KF&R}gWK{)nOwR}IdOZV|AovnAeMsx2Vsr>!Iz zN~JE4>b~;y5{m+``rC?JhSaG8rDA&wf=H6K~U-BKxzP{>Mf;c3+=)a?;uar zJt``M{#Tx;29tZCv|ic})qBpOgUw8M^Y2g>?G;JYdm17d3xzOP@{z~01o{Y(+`%A{ zb&XN;_74Rzc@0Tbn6cLbr6iM{pq!HuAN}B_dtdaw?wIt9@sD;MqOO%2i)EB@MQ`Bx zX*LGRUiR=4c%Ef%q4(Gp63oiATBFahjEn}@qz*F@UiqRfLF`L$4>nf5N9c{-D>8P| zb2rkq*AAL2+gVFKwqyBfFFj}Bwo84vxwYw%c){%4`T5>Uk!e@#EBSWQ{O=vPUTNug zdm@+5Tk&M3amr&v7ThbL^twAFs>H2JxSug7& zJlCfJO^gyn4Ek~%aMy&JWB0VRyVZo~KUbd|*E+LVf9?&}=D=owb2sy+v5r3YjJI$i z_f9AN^3Zzz_N)S=){kEDCQg?rsWMwoU|eipwcIxx;VWSS=zHje(Y6a4KK4pbOA85- z^Xr`z;>_}UM)dK~T$P@a_{>1HUa$CV_FB$HC1vu_fp!c|F@R6jt7l|kpNHdJ*K2$h z?iW^i`$B?wwTtFtVqgwI&iY%5uT69`nou|QAGw@d6hyi1OKGjO!ucxlvw;P#W>9bT zarDI4xWxC1SI{sU`T1Y76N50I^W@MWQ^52!g8QkY0C|SQ+dTUr7f6;pa9_Sbp|3Fe zQ-e5?U80H~yP}_5VUF{$GD&t~qu%|3&(p$e#RC%%+3p z15f4!m#jXq{oLUF?z$S>ak}Mv0dmhr_}aB3*X5yrz#j{`ITjV@B^McS@ut$8s};)| z=L9D(E%9z~jhypxIbQq8$hDHWAk5hMTvv6?16x~FW-%uPW+_j)vmg6%jN3i)()!8@ zz3}!fyIb&$P9@gQxS96k7we^cW>v3)#@u;(`(?l)=NQuOOl{l)NP@xmR8`ERo#8>=t5C%OFZ@*ZrZO0|ImZ{0x=8{2ZL1({*Pt~01v5+3+=SHQ8N^wO= z_KIfiZ!NU(R4s)keJzDI4`iOXSBm^h!{kd0ND7cAX*%!*WFelMbUj*=hx^7W!a=No z{+=&gG{_m&we1fu+4dxu@2Oh3itnY|G;Y6 z8Iy-=V*jM8hYvF1qthBk$n-SeN0k#74L24Cm!10fg}<2kG4^vtYP4kgQCTlPr6_22 z9_Tcpw5}d12_`TXnVLp=p;H#pLIW7UtZ7p+Mwz5}a71d6XIo@~TRcBTL=tuJ8X<1W zBdCNpqVW5Y@Ax1C>Kzhmg`S0K6rGoh?zbQ|?JPX13|wb1Nv-CWZEw_8&n8AMUpn?Q zVB=J8n%m^I^PQF&DPG7UWmA^qujO3g0+5k=IQwF`;m|R3WZfjyfPzV1c^&fm>xw4{ z&di>A7JXLci<~YAGtwiD-w~Hx-%WetD^j@JRS+?42i!f{c=0SBj2gGGIkK247uL zjwt2lTyO7mQA8~*^_vBbTIfBB!d%=!;x-qXYuX*+1@>@V#xu2Yu+Dh&G-bQh=Hv)c z8sTa4Q%6{0?iH03d~YsMpXDvhxK$qPXwb3tsZqTNx^v(@UR`8QG1?zP;-Uw~F9eLD zy;5#0=0-ble!0n4fsACQip&7ZR=)GsPA1D^x`Ni{7k;$xhMw2wD2HXcb` zS+__)^p*;&-eA+Qesz&2cIJv=eXX3}1$!Zylj^6q2bUiiF;GqCJ+SJC{t}dQA=-T~ z{DBvSWp@z0Z2HC_yB#?^;*_{#wMleQq49dis@^?;Qj?Cj4 z^I%~z7J{o7Hji&PxaD$7C(;`!579_?GgvC1DCiIl`-woGQH!5L4k{gg{W&t$T<1&( zhozC*6QtyfvxCf>_&P!qFE5Suur^+o96Fs(H|@=rb*ILYSD=+PbucnW2HQql{BrU) zPPJlW%jE^;sBOKk*;T5rCcGAHXHtE-wD30EHMa$q>%U2BF}ks>-nFM*8nUG@D)sb2 z^sG|zP?ymvPGRaL&zVP^W6!Uw7ScJ{lfVIx$KCHs^8``m;rZd3{9&YLjhMl#37o+;sQ(*4O zcHv5F?p(XM9P#|ez#eEf16nr&oNHVcRvYgT|NIZUb=&n(s9nlw_l_(j^-l$Ecu z+;Deu2?cFHDfZ)=_o%|ME?$goSrWr{mYP(zchXSzx(u-1b9Bh4xDiANr;~FpMl6ix zeqW0bzXHL$oHU^FmGbD@Q;%M8(}UKqD!C&OA8#$r9&a}bifhNY#}2wSQR6)#`#J*v zQzD(^Mv4i4B-UuBju}35!{@pjX()C~sc$Zp|Kf3qE3FsVpHfo1X=kVza)WpK8gLZX z%9T-q9^$K=D_UnX=@~IIHT4M>{<6(2t|h)riOtnB7fwsusZvc!2u4%NL0uE>9^z0P z@NecA7HFqAmfMw?e7I%f#i)>}$xW8`Y}^Z*L?_m=U7i;>*ktGVHWRm7(v07{xo>b! z$pNArqwKJ-u9MplEy&Hhi7g3vHkd2W6>S) zs8L)~I_q8GCmGFd49#aj;kM!kbJ;H;M-|y%w1z^; z#2U#)uxgCbr57?@)%Ht~GFcq+)U4#-2@v z9Rmy-_1D(;MR9D@OIlpN#A0tv|E04Ji)htfn~e&Xs?#Wt3^c+d(*7n*X085cwHX6{-p50$KPW4 zYzz+_F9S!1>u!gXxVw$MKiAy86*RcU{Gg+JiDH`w5^2XDJ6y9p^+;xucqAByX5ND- z?n*0+_Lwr$jG+mvm8|0lsMic zij{Fitk%DIjH#7-YFWs~J=$0+cS|E=Ne=9^R{|F549bu^-Er+h8>=q3Umw|oV%{xHL_qsZJ|)RjYi6H_Iv zvFMrHm6!7MAgH;qcC=RRUZa4)TP2lszuOF8yS?Zeev?X6*O<3E41l9d}E$ z<}xt8lPv!`gESy`JbmL8GZ$*(S-7AsE% zD8cRa)9VWk@eFj3HF1i>+rL)X2_bD&|7`c^ymVOn!||7?XrVDfQP5pQ;}7JtN!CPf zYv~@XcoSQIw6)yG5zt+^{Vx(3B(Hu#S7Kg8mrN!`vumiVp_1o6QGt8-PWF+WXqf$E zajD&1nK78g>P9x=l%`RJnuL(rlP61Nt_-a6&BPI|mYbJ*csk0|Yh=vDHz%Q=Sg~=F zJkFI*DbEyw5=W=blG8ZPYFe{-^gE^QmXAM!{0$;lv`)=8XIk!7!b^gXuD4pR%ZQSY z1lncu>lQbppA=rTlF5lTnU62J^#Jau(<<5=5wG)|^WC}GQ$T^jgT;z%PT>CAB5Dwk zH%AjFDQHHpqSCEY>U!2c4vahgsFd9G7@*xbdZ^u;w-gq&9i!#4`gHXR%>4!fcw#<+ zH6(pd_lYKScjX!559}5y_9!xhYh_#u^!TAnc06m}j2KhAC~R-eQE$<^*CS>oC|lPt zkkYwi7F~Uul}l3Cxp!?eVeS{+)^MpKDhZ4GHJu5Xt?o?>D5#Xs3^FFjb0fav#yZA(BNnuJ&)NBxZG zAMrtUX|bxT_fChe_Yz+t@p6lW+A`@Kmmv@FS6oZh2^w(CY@*4QpHPX0IeVmq<9r}f z903F(@*D^ty;oADw<@AAcku^z{de>8=n1y1jAK_I8FS6aI3<%1*b+64n{l|=a=Zq{ zFLE^mVOXuY_>}>?gl_0~90K~n$@1BBG<6kcUwt}ude5n5TIuW}N?f6DT;ldqOk$BC za*xnfBTY+NB6(3d8z2A?I?uzV0Jtf&tukC(&yKOel`n0k^FdMx+iLTpV zzB}5f#KsFtLkr>)OF74zX|5=G=YJCmq(EQ+lOz$oqY50<>-e2EUuP3QS@#bs?Wjwq zB1lszVe6UD=k^)}{`T4J!FcDwub>WxwI)R;KcIFAS_fNLFoDv?FhOz32re!skDE51 z_@4ZI%-3*4D_$r4b5{b`_xAlQymRcY!8-zC4NJVB^_cP-KyC2sgFwoPWa4w=R#vnp z{tjr?%b7GN@W-Ln2il(b!mo;PD77zQPU6*?+ow+tY zlOq1fPkfFe3@d;<_06jFlHRUPn;;E6I! z-rE)O^Lw$miU_A^^_gp+4vi5)lSVAH4-LfFE7Exo)FCh#3nR;yEEVvQR(c*^KBc-A zB#5ot%lMC9``;VAzo@#7%O|UX-62_-FlWpGcV*$AME*i=mqMZO_U|NtU0I@u?G=i3 zF){A8eU4I)cY8x)8OML>iIpRfh?OX!0ugVv1>nf;>u!}YF?eE+Gzu2s(@!7S*>Jc7 z0o@&lwxZpl4Q2uCG1Ll_c=>?RMCtf*+M_0Lg;ql+O|`I8&hz3Ko6KdVVj0uTIMt-> zi@k{RV&kzPJ6i*Y!5)l5MdFLfT{8>rei6?lw{8_AUd4rgABAUATIzf1pR6x*nd!l) zNX^9XZWg-j=122ufZ0()QfaOxd-4{8k+tI)=vIac?Ai63gc}p{+wj8Y4eAF}&rbwg zbs25CXg&SIwzeAZQ~oB5^74=M8kv@7BlR4SNpZX5d=tytnpQiS`b7T0=k4AjKdIG| zNAGn#_b*rPHq5unE#iKltk(;{Q44qTDt$+O&5~y{0?ncXyuEvR+6pxWwm-hN9$&f= zyC7S!G2~-XGnA8u1@F9!rJVsx-rYfzQcphTg!Rsyr7zK+gZ!t)+q>fXC*ms`N8s;L z6CNXa zH;2IUiPp9YPm|9)UAq57>}!RM{gv8{pU*9vCEN=O;%tk8dw7&PFI1dzcdF;#7_ZX* z$X~*-GN5+qbD#Y#vS*@bFQ}A6$ic1hxlfjlG7N5V+A@4y#8VAc)fI}mNSw@X5Q77O zfoy>koQLN)%etOthg2oaQYM#ugYb+|=`)iPxy;j(-@`;;C90>eS;%6?`T3zZ>){%ld*)SB6xM00|+4Xfrg|NS6DY` z;M0PT-kJy#ph?2)xSXHhr))?5nb8k+65|f|;~c4&L_J3L7^}NsB=;NfN{qL5j?+)s zC8?j`nm*698?Fs~OGF$en}Mivdz)!XB>gfXIy=aJ_FA=cf}(u}#i?IQ70xCf6VfgI z=toNX_7N45Zo|5P?32SpPI3?rSrLLR_~;j392!?T8@*ICbN%ic68m@i$}YBGe$K~3 zxCrOLv@lDiNji$wrN}b*xLvL1TUM(}X=2eArjn1LQPL@IkNe8OeFK_YDg_Feg9;HC z@6QATeF#jJ`ECNna`jhnFeb>40iSazwQMhSTaM?$MJXEHoZ-mByna|PqWUxEq z;#+}6E29x4F^z?&bx5pJ;G37pb^t)Y`~C+dP6P}+xUKBLrd6+Nmu(-0O5ufoQhrgz zB5yJ!kQm&yCm?!7oXT@sac56lA|ONpDWBXp(A)H-&J_*87fR=$I$bQoS)}Qr&U!i@ zq51gA6C)-HX%dM1>Sr=ZrtFbL)mmVl_#9u*nj(Pm*88v?`<2UqXh<}~mbS6F&B zKR2)EA&2^Q+yurLj!KfFYN3+$nh?pX;0@7s=Vi)Jfj~++6o4C}h|+YbzpUMQ;(?bx z7^tl~G&=;|H{YQ7U#11L9<_i)j=t}=V85uLQC)u)v@QXJxGvnl`X8NY{kAzNKmevg zl(4vy(4;^rqtrlHRBcaDf{4#BAlYFpXiANwavKB&I6n>VZ|}QPuZ8U`SG_ODsrUH_ z0<5+~%j1~zApd(d#`hLRhSEf^{hwV~VVRIP*n%MoXeVw6atG?p9^`L>F1k}u?#c{W zkHaHZ+uKsmeBmhxLgHmkRohgDLBt!&g4%%BU@BowfvqS2QX5&bc259Y$pcDEC?`w` z0DhZ2Jm37hH|$IAe|(?@aDFCdav%Q`hpTo8knb35H~7sl@CGd+YDef)VG^ ziLvJSk@`Xr65=jjLT9nziUUEib8SpK7~H+)uRPQK^OIQTl85?n+k0P`@N*;gl!m*W zHWw}z;Uxo5UP<2wv`F-)^q(>MsoU6>^dpgzUEDX(vRx4~Dj^B4C!E+bbI+h5$I7$L zZJ%3OjgUq^C5TU$7xX#n|8TcUUUTXPf79m~_I^|jTim0*=16Ac;&mxCXcD|1_&de%cfLZYm8 zKI=8qiF3og?$u&yj%g2jAL_YmwzxA)=+bA{v|631Gp65_@XYj}V_u_*E|e6_D-V0P zAS7-Q;c{B7$zowfSX@I;P6LKvb0@_V(ef`?o`}ZP_r4?EAL_fcusM-hYwVocCvW4u zRc}`gdlig*tV|P^x+;F6t`K3eG&A5uq{RdN(;_J$73EXWU!n$@Ra(Q_|2PozH~WIl zl?;2u9M9~97nZ(YrS@n^IT+YuKqC_838ZfoJ`0|)%0}Kv{k+#EA2kv9^SlO~u0`rY z8`!J(Ax{^axVLvkbKPE6U@sFOe4;bC*@YCk0Kb83)Ndb4= zw<~%*B#SK6UJWfUV80B6iwl*6DJeG$uAXJP8PgbrFJ;di#7o)}ZXFT(8CdBx?5Ucy zP=wWZf{ZDeQhzpq;zX-Te+qab(2+k?Vx~Hy09bVHUXJC@7GnBn6QG`>#CXv5 zAvJ^eoGsj0rsUiWTE6x?ND?)o5DWX_PsA3w<0EA;}(!gq))nr zVyeQEf+*Pny!}4$VLbxE7oy=I&sN?Z=j=37VF2w+9A`CgDbPNB%YsyykQTnsE71qo zA9f^`Yl#-<8cn;r@00+4XdXru6DbrX(dDqh;;XkKmm!M@tR-HWpJfO_K;)``aNM4n zANC@>9B>^yv4I<$P8-cZ8Y~UT)NP)Uooci*`-?jAKs4#eT!1`L3CS9Zypg{|Aol2H za8DB*g!ksC=J(JGqSh-}ZUCm%{d7p=pQ({8n(QZc8n_Kc{k~z^K+3m@WVNImeq#od znn6SV$>Mx~y>%=K{)?soLABoG@#}VC9eiSi00mXUe2-eIFuM!ZK|vvtl_NxiL;n?wR1iEQr5^PX1LbucOo?{4^Qpj z!%wTWwQ7N@IaD;Fl5mnD+)-a@M^+0)sa->Kj-sq@#g9GjyCT3EaniZl);XI0_~M`y zY1g+@H-VdncEC`VRbz*|d5^QTbt%cMo{?reu5Vi@t+z`(Uw=?<%mwQ7pk)B}`(067 zE<^Oq{iGfQaowFBCQX+Wx?UZVaQc9NpO#_#;4!}ZyCJUCa;!>c0;li-ciy=(nj#-+vlP%EG>|181`g=&A zToFh~Xg<;U=u$Hc*k|0OfXir;gID?jEq29|3qhXYUlS^08bDsE`9|3ItKHc!OD`jY z{ANc7fY>MC1DH6xBlH!x&Nhs$~p94(aNn2 z>Ri@7g>ES)1YP56sY_NKTB?)xo0=3tK4z+BBlc>k=kN_1S{!19PiGPUx6t|*E9S*o zF{lZpt5HyI%gg(>(>%HmdaqI`8^zw3dscD}V2`!>@BA4c%nrZ6B(iZiIYqo97IP&n zlQ;KxQCYb;=plRk9UU$wUUPHy<9?YtWGa;bW4WCQM6}LMzuCNw5hbh$9hmBBSoqfj zAQiQ{*x8Of@wrpzW%q@pmGrmDL&csxyH5w)G9Lig3=6NshZpPZ0}a$zj_hpma{E?_ zhs&vj>Sp2di58*WH}$c?Xh}1B_vT`^mc|>2=IGMhY^84DHm5*;zy$o$MyACCQeZr< z0;H}Qc)((d-(yUt#r7ur5?BBxkI_e_HG4 zTy3>*#!Q9{5RQsE*;2L30NGM>`0pC-(RTb2-mg@Du;+dK!X80S+M($#UlYn zB+UK0C&I-t+&Pdh0EI+GeDrfTlZt{_vd~LEiNLUN{=SosFe7%LP;$LaA82UBys3-j zJ}9ew36<%gPx{@B{=%c<*Z0zI?3P_0I14U4ceKvH_Vvd- z&Qp3vHKCIl|0wW+?H(6u<>XW+CwZ?B;A#rP!>9mJ;c}M|JUU^UDEUAZs02{qjyXq>t`X`;TX|gjlx+TF*|? ziitHh`54k_?HdfC&6JcW#j9avm#)x?MdV!zdoHU(Bu~%rk0)Y@O?G4Y#V?)BiRf3Q zWP|ZOmz$GMATR)`qW8Wb_wBm?-ottG|M&Lj*;^*^LS%~`bfYQQkX7;D1wpTv|7YO; zu;*`K`Tx^G;h6=KMf|ti|L^e!(7HXAzL$HG7)cQMtkE`fKK2wSy=6pXfbdKkYn+~4 zVj*kfgVp?^(I7%2dryq;O6)lXH2da{@I_}urCJ-xYp{Ao39yQMUyZyymc&B>K3PcuIxf**NxEA88!=kCn>YC^kqrT4Vx zdtm?Rq7c@62j>#O%jGpRjYl{*Fc<+jf~ z;cP?jBfjE{?i((E=PHngkL?F?+;9Mj10qRt2Jp^s0fSCOW<(C-Q8X0pF)>PMgG@Ch z5MP*j9R;~;)YY|;!=dMYBUptV>^X=Z7>k*Ab0}xtz4!d2LE&e$!M)SA$0-uq3W*PZ zrefcL#J}x-?JV$A5qyEQdvjc>I>D@4q6y^t-Fo!H#3JpXG%5h;Bxjsr0V)R>X9`Bv zf#4db@W2DjWV8;{shAf9K_XOT4eb-`GUXra&Oz9>-q}jhwWCKxg(#mj5D! zoN0hS9DmyjIj9GLZvBItf0EYcKiT~m|0Hm%mxhESo8Pr{_>6g@ydvpKX48EYEw5{(!zu;c8 zH~hbG{KUJ^MWYSh(#_J(SMk~6jC={nyx7S4$jsRpZj=3_>Ogi=_5%GSxs^O_M_WFp-TE1WkpWXF_|bNal|--R4S3zuSoX$e zcpuD5mHkrEy}rUZ;rnW&p{>hhD@lV`LI>dhoZ08J^4UQD-Zjg$_5RptiQUKSXI0~C zCBBYNdWJ-2ao_UvxZY{69{mv8Ye4G*Aj|Gdq<{!1zep6f^lF|%7n+68;HN|JfE6(w z$6L2-=Agbj3230lgEw4Nty6Kq87oe~@E*x5;m1q3mkU2wL?50|n5dIjjw3*2*y|*u zGn45a%g~S1Pup<0mh`So5~f%>&v@~-M4^^vDt6X{A~Hss25)=X(JAZ$DhJB6ZUSKA z>Whb};urH{92IG;rL2x?ptww&N)XJw3d-s~{2T8$db-uh?RsY=)4gGpFYmBq?lc{? zUzcno3|%=OF!nnsc}9m0tXKc81nn5ta8VUAb;J89KQ>%gWD;mK{#gpaZoNW{I=)FL zfQ1%aNnjKecR5NK#Ygn{iIxIH$Xsd~<*S+}d0x zt$v~IrErA)DEzd^GHW}D(8Jg_PJD%^m$Q9MSS~Yot#)J|raG|wKQwA7(iO@6HkoPl zVY9(aReF>6g37-U{ikE>{P-+cmrMI6YfRWaF!|rG@jWh1GsZ4X_1Wh<;w2mQQMteR zk!0}@RD!03F;YGbxeos*O`KBzN(-Soj;2}SK4Y((nQ1TlCR~4b#}Ja+;;a=J7~cWv zc5!dmT9qn|q2%^OiQk9M>p~Tf5p6rJ+l^Zh_zl!^W5VocJgz5z>^iYF7y-s- z$4KGNz$QBQBS@dCq||fGNisewsX0Sqbcf6ktUap}4>wK%s+htbl25#uO{Sl;d-OX!JP`i0iVPM@plTuUeOgj0 zS5RVyY2CHal*ErP1t3`m-0rC~uZ^Xat&cm(IOgfP8n}_oq4Pt_uj@9VFS4~vwF4!- z82khE73|NL$%$Fyuf=QSibK8weZ0r&V!1EVGcN3nSn^(1IfCGjb5?zyOB08D!P2bV zqd^keMZ#Y68kk9!5C23J)Rmk!7++v3KlPQh%dG2l{qjL`gQIKXwVA>nza3Wi03fq9 z8Nzx&T=zB=R5f~&u2mbesD68>beSV=?}qmeOQJ+IyY9&L%9mnbLC2*`Z*kUq*uS<@>RWWQ7rl?`DUD=-3?k? zOEC%`Ga2bqfOi4nKCb-9b;t(t|D5h#{1Se7R33o)pD+ z8M)qM$ZwjfObqm=4po$`erVEr?h4(3n)d}69Hwg~<=upLHyFOe-kI$S ziX)6&{EJ#$ivn73Tx;Z3Lf{LtuP%p?1NMz;KWqIEHGT+=?=^;7o$_syBh3o@*p39! zCN}o(6C6aXAtXmYFD)J>G$`;V`0}#qhW>*AQ9{B>fNr+W8gJ=5&?nR@3x1Xe0N@7@ zW&bS{-1$y!cMIQ9aGkv7F+yk2i(VdLQ2x#P{gDevYCJAa1~Hf{s?JM126{Q*fMNI= z&-t76`y=vQlN1X#nw*i@1zX%1y-HhBev%joo%D?OotZgj!6`%gfGQA&$8!sfm@s*3 z6G`|=rH~PW!j|{lZY>J@4iha*4q^*>2dKp#7P2OUoT-zU=aI)9WYd>@FQ<|u?zA@D zECBRIDsbsV7JaCEtCel>`!3e4;f}ZBoIL zz<~6QJ~Efd4iF5Z-N{@l_160n%EfU6QA+)+n2JPZ*n50(_S#&eHuS-EJd0}HlgW`5 z+Fyq|!L#Z8P!T84ssblBEsAf3nO$*j1>idnsOn++@v@U-#0!9v$uRLZ1@+mlO$%%0 zihlq_?cqf*_i2ZoKIGt+6rp+)>#5nkCWWYGlfBJ1)Qt;k9^%51i>k{(DSL-g4C|!< zU^B;KKXbUh=<%TF0~xyIJ?sOt;1&i)CFlZJCFHaG$>d~b?LdF{#_kqX0XE9jSgJBV z*LKcI7`i(o=)~>}cWlie853u0q*;r-3%p9DRwJ7!Gb$O3NZ6hk5l{6ZeiI!s{zi5P z?b;9FUnT+iB4j@JxGnmMJ0^|yFIcx756<1#T(Hg|=`nd}4QECw@*5VP-kNNQ3-g~Z z@wez%UVY(T-!ojDcX8f@=sfmzM-f*p5ffQyPdNTfpxcDF@y_~o*Atfl=XizzL-d25 z_35cS>vuCxfE^RM$~}OtlA{cdTb}efocT>?f1IkVZu=+%kb4TsUF81z&*BjcGpW1v6M?mQ~^`}$Q2tJm+Fkp(qI z_QB^%%Db+{c-7U#D*MpnvDhX4fvST*U;6*331neR-|3671DJ1I;Zk?#jz<~bib_q% z{gqsHKzDu$^?T$QuE_dKQv6QyTV>OIfg^h^Ne!TMb=J(FyD%+NoTE-R0%J;Q&=bDS zUN_Y7b2crqEyRgh?_;N3%{RUL!TrFggvMvc4|Un{ z7a>9Zl(|4$XJ-2-M*NBUy}_%Z$jKXvuPCLa7jrEV;;mW=#0IKZgq%Da9|a+5s)b2w zA7;JFP5sC%u+Leg-p&bJ>i+{D2Z8P{{sLUXyD@AJN{Gc!d5f5EQK_)-k8(R4>Xo<{ zL&pAa!IGhhcqcBn6rKg{0y)(T2 z)9fZciUGnIQc_nah+SjjIT;e~+H1r3s{jNrgZ{Uw&*D>AO=g6SE83nWcsFm8BUZpb3f<^W80igNx?f8}Es~01|o^~xu!x_?~guSjylzCed>t5nJ>Dl7XO#akBE{8*FJf)+;#T;XmjobS1+<}z%1B1$q zCD(oSIEF<4igx_}%On9688MGYvf^;h6#`gI2kRfwddL1xI~bk=>;Gzj68G6HE_L*S z!`=fj+R#|`7dOr3`sZ-kS~;u&VC2a(?f)p(0kGuT|1Z&|16R-jjE^mE{!1G0aKGwE zPW}Lnt*ZkwI<4{lB{n(0ddY|#4v3N@{)Z6A|3^4-0GjU~-BrCszVHI+-@>Rrvq@ad zque6Z-kpC61>3{VV`upkHAbfPJ7oTVyPDYdPn&}~bN1xF`%G9 zJE^w08z%rs>#;FD9$~hYb)R_qL%7>-R^ZPFusoPW`h$r5FwJXxtx9CZD6faQRGIfj z04a_wPl8hBppE+{js79XEI$ekiN9m;(hWR;XtnXTZp9wyv8fzAz59BtJQwbK;h$Ga zdd)16`~uH>qK;5!C(-?B33-$h>|{sy9zXOqT>*NR$bqBc4>Rw*4`$VmXe!JAT)4y@ z`Arpu9uJ~(a{YP8TAF=8GAhiF3f&c0>`_Duoj}Dv=TOtHw z4HeyH7Z$ji$m5i`Z_%sh7cWk~9iRgPwV1Tazrp#Sv@8GST?0@cm_PWn9ma!;O~BP5 zAV@e3yxA;zeF`gedQo!EbJf|p`kSJ4C&qk!n*rQCFPuZwOp%zblj#GL#ehFLFuEW3 zS(0&D>xo|G>NXtaV{?x~gk);G5&BLA?DVoGrR=+t|&!_Uj)_G9+a&U0We#mJ38YpP!K`qJGtbl7-{&6$GgRW`hBF-)o zXx?;?b(4G<6x2-zkc-C1c1g4lPB9;Mji*So-((h7CvQbl9;j#l7qRwick5Y~?*N>m z1zlE&qRH;MVS% zr0+}Kll_pSi%x^ii{+j^pJ%+or=Ky-zb8C3{-8oBw%Y!Ej88+n=y^1wIMX2aklSKr zv_QL%@+Su|fn}BN4b(HpFFddK&WHR%3{pyezn$Ctyke9~BPi;P%Mky$#pLA7Ln4Js zD*gN+`J3E>4%lylJR7g>ub(~OxTZn1gteVpL~BT{a2U$fvbAo|N0+|>9W{yg1s;90bU>p$dbjB^q*>7q_Njmkht`dYjD**&ZJ}Tb@Sw*IP6J zDNA9kV&WOCoBZ-{)7ydhqQO7Z!5n|Ay{0+TpE4Z3Vj$7nRyVk#7_JY!o})yvRcJP= zyw(5Urbym(Q;Ao$2lt&YO2=y2C%p47^ncoR3mr5<;UFeu?1u`HQ6jUm7mrZKlLlTr9y?e8mCvkl^a{ zROWoGpEHxJ_^-W~bqY{>y%clZin4fF+NyN+A(Kzn-T$k-Zx4q${rex;%AFBlEWnD!;qDbD9N#*11*!mT4!d6(ZOMaF&Ion$S@|x%ot;4 zp3hLbwfpl++~vyrjK1@WI>f9JZFK9QAx# z*`~fG%Md#&7a%G10Ug~)N#&kii(0T*diloMLt<>mYb=j@0Uvj&LJ>xMN-NLk)9n5e={I&UUxCV-kH6-xV`!~ev4_bc6|E}PM1l_b7LX=8CRz@%$CxY^}8qa+PfQ;f* zLL6mCG;U6L(%Nf4&8r))0R&%-xmF5*`;Qti18z}W)57uWzzM(;JgZ1ue0Lsa~O7u{- z%k62bn-spW3KR`n?YT6mWRu` zzT5$mz;0$TYZ~6|Xv5*gdci;U5-lf6*0p3;mnyx${ucYFZ@TT zyaXT+oEwgl_Iel}i7{T{T$t38%A@^j1jf6eEyI%iuJq(L4FZV-5V?Qz8*K#@o0OZ!cDEBipy2f)`q$mOS(^4dN z?8^IGRhwj*NSiV2%_>*<#yaFHwn~ac|5+K!4fK;hwGZ;vl>%L4|J4PE@KIk0Pf}YN z;Pm#%Mj)~;Vs`S60?|{F00HCulO{1bj3;m(aG`;7;5*PJJMaIxfwZ*!(cxPbn>7;( zf7x{ZHw$kY)fD5SKBX$r+h3U5?6u1)*m(MA!q2B<)xSCUK)DU>5mPojYWC9@Zl-rG z%jK%CN|=5yh5JW8j(5GYfoI4YBJm?xM*czVMsQc(sr-iqVWjql{(;84u#vDyxhOhl zyQ{Q@-2T@pPlLBhwMyU=FwiYZV?xZyYhZO%^Qe6QJOa=R`oU8A_S7NM1n@?;+raV? zq@#k@KZm{A8I(eg{zmyH;IhhphWZb${wFGfx&O!fXBeDoC_Rph#G$K;Fp;6Nd!E2R z%CHr!&cMk|YT2f%F8Ks7szgU@gl|d|Tx!N26or0lV!T@eceV7rO$WKXTd@kaP}k)- z4f41ls~ET3!~4_X#wlD5?6gg~7O{z_jU%Qzo)z}EUb|`=w5A^1nPQMT&#Sq?d5f%GZ5ezzeU$Gr@Ha$U_RKMot3?MEa zL@(3^=+Nn&yq9PA%E=ZuS_FoNphnl}*d$21t#b`onByK3o_^ZG%nqM4Y>SYee~`x8 z4>;m=ZH3Qrv-f5Y!lx-%?eHlLvYn3*%cwM*EuO7mQOlViciux@{j<<_4Xk3-Lw@rv ztfI(;J3;4^M!1y>POhNFwh7ebbun@E8l&a_T>G6Of*mq(G_D1vl zo65zP>o_g?MTEsc3YM_k`jD)`8-Y`0bOHm;TT{`bFhG>0!evsGHlxlwo>~X!)A&o+ zUu!u`5-yH2%FZG^t==}UsPc9^qeVXsleJtjAON}BrLV2fj^y_-2;yYI$94_3(#Vf# zo0y49r_Rv1Pl6ZTj=wDY)fv)a_v9Ppa(hVc2=}!b7QHYBZFfDjOflwKbF7THA7{Ly z%8C$edA9K8JX<9hX!R_c?2F(b$-bhI^dg>%xMILJM@l&X9W3DG|(8R`1?px5+|Zv44DfClew>CQ6%iA=r_9DjH z+6>kB$O|9(Xpl;6mSn z_`qPACyz6vL0+Fp^`3MNpw{py2*ZGR=LtQ3j?lcy@cI&c-o1UqhsE=px~^$if9Bzy z9P0Iv>}yqCSi(pf+11OCnvfrD0NZJ02dxh>_TtS(;A;y;xC2T>a7+hHmb^X}eW;w& zO(xL}vehEREQG7!m|mSd(>Ke&Zil{m-3V=B?3?C%m~wUdV0ndcl3*v8UD$wsGc?;@ z+}UO6h1I`XF;G3s@%8mae1JaDP_t}ln`z!HXAiS)CpV7|dBr8R$deS^z${9$9~0y} zBhXdpHv2&d|I(Xl!f_0s#{YTgAz`?7_|y~&taqORA@s$#kJ-0S_14eB7MuZzHA(Rq z%V9IUHRH<}+RKXUAf~g?9e!N_%zmHP*+sj>-%)ogqr$T-i(m10n)$(q*i>3U!7w?O zhmfA9w`z(b%V@1NfsoqHuH2-)oC>{d4^zc-c$L;-a&wxK&t>7yv7QQG&0gui8nuOZ*ky2OdVuug;iQ~c^esp zkC%x28&w9@lfDQXS3Y-NSG71vfMP6+&rA1RXyUg|*(s6^UxLPvOAL6tn#xeN@QP|~ zh2W_mV^~c^Kt@_ZFxZ2#jJ}w&;d!0I6dd)%6Y0 zd@|0@_Iw{+_7HEy_SYY(YWGR|O!pdt ztn9MUvL6j62a`8pb2Z@N4{Cq&NDcSM!cq5<2dyn>qh9gk{wgnAIo;X8p&5{FpQbv_ z$qTDn$Um6w>62P9uqYgh*%CN3-t_#y;*{0cF0KW@xqADEX+LwkZNzjovPeEsOdf9x zp3P^(6h~Z1I_5C3Mt83$D-l0HE74TmCQhuVKDG5GTdGER&`U9MiZvmKCCKuyHjv*0 z`eJ455j~^+_t4U<^1o`t)OvGFu?DwvRp*i({3C=OwR)6`l_iD8)4n8JURUOhPZlq0iGjfEI`E-23v z$KDheq-$;W+@I{ekVEN!gAbCQ5e3OK<72J0>2(+(w-_L?k1THi#wL$;%AHLHScN zOzNz#?h5OD8#&HN@Z0&|-TL493j*vHI1R8@nnh##>;)VZM_yhJ9>J!nc<1&-$P3z` z5Jg_yA{;d?bV9t$64YLU^bOsay>Qu0PVUtt;`uD5V`R{(sDYGQC|Z2I#EfCx)dtQH znRjKG5k7+l&{SC>jy-8kY}zmp=I!D6JaZ}^K(WQ?Ma(`S)etpF#+F?{2{Grx#QNHM zJx8O}v~5|0sb4t7z)1XsrZ7Yye#tE?w{KnBr3k3_WJ1ir@~724!`6`N8OMrC$b(lm zirNBbIl{#k)2!+On;(w)F29A^ke?*CwoN6ShLq}v5%WSbE!!ZtKH{*)w(dUT^C_A# zr?v(YrE;8f^kf_d(fC(RDi_!UCzaN5srn(7Ini`+u)FNiUdM8TZ$vKbDS#WSE*^PF zHy$YQh=e{6Ja_mLnh(2#i95&(7>7Nt`K%~clr!`RM>B9LEf>BxRZbr*FaZrDL-dTB;5AaPB zp}l~9OM_Q6BEG;o#(eZ5#&SCH;GL#KEMe|(Jt@<}A982vjd4fG6F!3oSXV2>)oBD5 zj!4hN;;l@!2J+Z}X#r^U8ahv!qT5F%{` z)DSq)M*^nMxEftJD2^1?T_@Q=;mUn{B{K-N3x}%-zG-}GB?BPYg`xdJjM3tW3!G7_ z+(KiKu#G%iPV;uZZI|b>IOOP5s0`k^L0G^hD_J43(qzJDzk6``nXl5z zy37({)*lDIzL7cBy_Ab>*Znq6TVj!G&OU{`>v#lngDHTw-IKewR#)ekgv-(Dz}CRo zXR!X1>nWNU(dv?1X>7a~5z~_yg#$0S#ck=XVRt6-xz3Os$J5`=e+%V93EY>)lQHZk2vu;z9&9XRT-K9?1g59H%Oahn25R30p2 z-GDcp@1|_Q#{KzFlsfz~M*gNLO2_yQY75&`tPZ@Nr0%FYbr`zt$mNl=${w`j_a>d) za;;{8*}=vi;KXRU+x{~mj*8e*qXR8ZHRmJIVJ~f${t#EjPsW_z-BH&axTL+Svl@4X zetUY)uFeeH=eA3ohlx$Fr!8A3HWoQ3m;9D3J!BMQ6)q^lB{=%a33~SYZ0%D!`_Fv*Z$RJ09>#eOWBBYwo^y72Bd97 zp0s;eA;xVafraT4d33i^S@Mb$uqNf3-SryY&%~eT zT_JqxueOQyvyj_IKG7>7e4mR7MO0^T7`lMSiUIuIWn=pT@>`ql?T0P~*(4L{5fNI4 zza0t@#WLo4*j4Z#?p4l~Qe8w;%F42MaOIBj?tR1qak{wj+pb2d!_?Mj1|7|VGNX+F;`qKR7D>}CJ_Ap)bqrk?Y&3l`J?)D4eN7rTy4f3y##qR2O{_Xge}_RdYHQ6y`6oG8eU^t$Dmp5d*D-23 z>Lw1lDJz;6ffJ`c);!pCbj&zbSoMW^s$Z@o@48&BQ%u9Nmj@W5W<8qD_=f$m(*w5J zDekCJbV#KiMhP5Hc1Zgyl1k}(F|iiSrxWVMD(o$e+7Dy}I2r*HmbkG(1dB~ZRY+9$ zlbSknG@aY=wL6U}?3Ma_Nl3Rno9>)}I5Ra54}K~Bc-i-h#?2}7H9bK#xn4$Nc|MuY z5>?~yuEkWwXu8sRc0OPF7@%>>(QakR#`md#1xHX_ex#&g@l>*OWQ})8D9>ng3pnW} zpZQ4P5;Iq^f8bc4AbR48g!R@E+g(6dI4{>Iwu41iP$`i|&+|?8X>ar- z!G6zuwowbQDl_HD5SCG^D-x z`?ALBL5U~1KjCuOP?)|^>CI)}+i>v}+^HHY(R67;Y}(rE!JfZZSk< zz2rLr7gqN%baB@{S?cOC-psYX;OfeCQ`rO6E~rwnrgKQ^IisF=_EicXK+y?*YgFma zsAvccseEQan&1FA5Lw{u$uU#t_RbcoUXuqgy*c9gy;b=wO$|lDpVpunUox>JDC-f| zLG;h;lX2Z&dz`e`YYn^QWXA`l>wk;A7FIT-DYw6bcP3qCilyZH?9Yj=_T>t@Yr14deKmV4u9#=(vDqOey&^IwJ(X$ZiE{v=)*8mVve z)$56~s@Xe33x8m`q>L3z=9ZOy;oMIc zUq2i!^J1QM#OD#Da<407rt2ng{z47ssIe$nI$Ms&7At?$h68C{WBwoEZ1b$P_CB4%kDZr0$Q2munLQ&^_As^_jHr zU2NEqu}`8}4FJ~;mzM^fB-o6?JV!V5rG4S0KbdK_=J$6V^I7M&siXXY$mw6ZlGVtu z5<;&3)#g8;F4wx_t9W+DOYE`>Bfq5GVM=Vu0`xo!oOJ$pd<+2#ScEqaVuo!HTpHjH zb=KvF*bQ2Wfk^jv$os49lX83+&ko^)L1{pgB^&^6277gfmtImmaC6r#IT0>PtXg?@ zBRI$|VgS7okw4qfmm%+S+W{no?gsfPo-wMqG#ffUPuvYT2YG&+-Sjx5OZmZl*kauk zQCR=47LXwqj)!=~-+y*Gt08(dW=~?fy2q4shaxsk{Bfs=u=V zD@o??NwH#PR^mj0G_mR8E1$o8T(0DIoplK@b9W^v$&%IouT0U+ZCH&YO!y>9Lp`msX6IKLP4R)(s@Af^H$J-2+bp0{k86RE~${j!=6DL@aygD)u z&ud_S;fqZ(5mAM~%X2S3cdTDxV99*;B+zkb%eT+0axo3-b#@_17#qkf$#egV_I*So ze|!K~M-c;fv-)8J@Tk8}(jUp#n;}*391}}Dx=J80FLAfr(beavGBJ8(fLpf|o~-`U zh7EUtBexa$fYscln|$h;aC&vBTer;jB}hw#2Ojlb|CI{< KQQR+XH~tGa_Pz=L literal 0 HcmV?d00001 diff --git a/docs/features/aggregate-overlay-diagrams/entity-overlay-diagrams.md b/docs/features/aggregate-overlay-diagrams/entity-overlay-diagrams.md index bab3695368..4d1310fc93 100644 --- a/docs/features/aggregate-overlay-diagrams/entity-overlay-diagrams.md +++ b/docs/features/aggregate-overlay-diagrams/entity-overlay-diagrams.md @@ -5,121 +5,73 @@ Overlay diagrams can be used in a number of ways. Depending on the `diagram_kind` specified, the `layout_data` will be rendered differently. This document will describe overlay diagrams of the kind `WALTZ_ENTITY_OVERLAY` which can be constructed using the diagram builder by system admin and rendered on group pages in the diagram section. -Entity Overlay Diagrams can are constructed of 'group cells' which may or may not be backed by an entity e.g. a measurable, person or data type. The cell contents can be overlaid with one of +Entity Overlay Diagrams are constructed of 'group cells' which may or may not be backed by an entity e.g. a measurable, person or data type. +The cell contents can show aggregated waltz data relating to the backing entity of the cell by selecting one of the overlays. -HERE! ## Model -There are 3 main tables for storing legal entity data +We make use of `aggregate_overlay_diagrams` for storing entity overlay diagram data. + +- `aggregate_overlay_diagram` - captured the diagram info and layout data +- `aggregate_overlay_diagram_Cell_data` - stores the backing entities for the diagram cells. The `cell_external_id` maps to the `id` field in the `layout data` on the diagram. + +### Visual Concepts + +![img.png](entity-overlay-diagram-section-view.png) + +| Name | Description | +|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Group Cell | A unit drawn on the diagram as a box (1). Constructed of two parts: a title (can be hidden), and a content box. Optionally can be backed by data (2), the backing entities can be a 'PERSON', 'MEASURABLE' or 'DATA_TYPE'. | +| Content Box | Area used to display the contents of the group cell (3). If this group contains children, these child groups will be displayed in the content box (4), otherwise the cell contents will be shown. Child groups can be a mixture of groups backed by different entity kinds and groups without a backing entity | +| Cell Contents | Data relating to the cell is shown in the cell contents. If there is no data associated to the cell then the group will appear empty (1). Otherwise the selected overlay will be shown (5), by defualt the backing entities are displayed. | +| Overlay | Visual produced by aggregating information related to the backing entity of the cell at the given vantage point (5). Overlays exist for all cells backed with data (although all may not be visible as child groups are shown). | + +### Layout Data + +A diagram is constructed of nested groups, stored as JSON in the `layout_data` field, with associated data linked to each group. Each group has the following attributes: + +| Name | Description | +|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| id | A GUID to uniquely identify the group | +| parent_id | A reference to the parent group | +| title | Text to be displayed in the title bar. When adding groups with data the title is defaulted to the name of the entity added | +| properties | Information to style the group cell. e.g. cell width, cell height, show title, show border, title color, background color etc. Defaults if not explicitly set. | +| data (optional) | An object containing the entity reference to the backing entity for this cell. Formally captured in the `aggregate_overlay_diagram_cell_data` but retained in the layout information in case of reconstruction from this object | | + +Example: +``` +[ + { + "title":"Demo Diagram", + "id":"08e5ffb6-ee04-4809-8357-49191b0ede14", + "parentId":null, + "props": { + "minHeight":5, + "minWidth":10, + "flexDirection":"row", + "showTitle":true, + "showBorder":true, + "bucketSize":3, + "proportion":1, + "titleColor":"#1F7FE0", + "contentColor":"#eef5fb", + "contentFontSize":0.7, + "titleFontSize":0.8}, + "position":1 + } + } +] +``` -- `legal_entity` - describes details of a legal entity -- `legal_entity_relationship_kind` - describes the type of relationship between a legal entity and a target entity kind -- `legal_entity_relationship` - links a legal entity to one or more target entities with a specified relationship kind - -Column remarks have been used to describe in further detail the purpose of each field. -![Model](images/legal_entity_model.png) ## Features -- Pages - - Legal Entity - - Legal Entity Relationship - - Legal Entity Relationship Kind - - Legal Entity Relationship Kind List -- Sections - - 'Legal Entity Relationships' - - Displayed on: Legal Entities, Apps, Org Units, App Groups, People, Measurables - - 'Relationships' - - Displayed on: Legal Entity Relationship Kind -- Bulk Editor - - Requires 'Bulk Legal Entity Relationship Editor' role - - Appears on the 'Relationships' Section for a Legal Entity Relationship Kind - - Allows users to add, update and remove legal entity relationships and assessments associated to them - - Detailed guide can be found here: -- Assessments - - Single and multi-valued assessments can be linked to legal entities, and their relationships - - Assessments marked as `PRIMARY` for legal entity relationships will be shown as part of the grid visible in the ' - Legal Entity Relationships' and 'Relationships' sections - - Assessments against legal entity relationships can be edited via the bulk editor - -## Bulk Editor - -Legal entity relationships can be managed in bulk via the editor screen of the 'legal entity relationship kind' page. - -### Input Data - -The supported columns are: - -| Column Name | Description | Example | -|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| -| Entity External Id | External Identifier of the entity (usually applications) | `ABCD` | -| Legal Entity External Id | External Identifier of the legal entity | `1234` | -| Comment | (Optional) Description to be added to the relationship record | `Some Comment` | -| Remove Relationship | (Optional) Indicates whether to remove this relationship | `X` | -| `{ASSESSMENT_DEFN_EXT_ID} / {RATING_EXT_ID}` | (Optional) Assessment to decorate the relationship. Values of 'Y' or 'X' will indicate alignment, other text is treated as a comment for that assessment rating | `A different comment` | - -There are multiple ways to designate assessment values: - -1) Use the `{ASSESSMENT_DEFN_EXT_ID} / {RATING_EXT_ID}` format in the header, this gives one column per rating outcome - and can be used to provide comments per assessment rating -2) Use the `{ASSESSMENT_DEFN_EXT_ID}` format in the header, the values for each of the rows is then interpreted as a `;` - separated list of rating codes. - -The editor is designed to allow copy and paste from an excel doc for easier management. - -There are two upload modes to select from: - -1) `Add Only` - This will only add or update values for relationships and assessments specified in the file -2) `Replace` - This will replace the detail for any relationships and assessments specified in the file e.g. If the - target entity and legal entity details are specified but a value in an assessment column has been removed, this will - delete that assessment rating. - -Note: `Replace` will not remove a relationship, only the assessment detail, to completely remove a legal entity -relationship place an 'X' in the 'Remove Relationship' column. - -Select 'Search' to continue. - -### Upload Preview - -After searching a resolve summary will be shown for the input data. -This lists out the operation for the relationship - `ADD`, `UPDATE` or `REMOVE` - and highlights any errors with the -input data. -You can hover over the warning symbol for more detail on the error. - -Example errors: - -- An unrecognised Entity External Id -- An unrecognised Legal Entity External Id -- A command to remove a relationship that does not exist -- An assessment column header that cannot be identified -- An assessment rating value that cannot be identified -- A breach of a single-valued assessment definition cardinality by defining multiple ratings - -You can either correct the errors in the input by selecting 'Edit Input' or select the 'enable save' button in order to -proceed; any relationships with errors will be ignored. - -![Upload Preview](images/upload_preview.png) - -Select 'Save Relationships' to continue. - -### Upload Summary - -After saving the upload preview a summary is shown. - -![Upload Summary](images/upload_summary_result.png) - -Select 'Done' to close the editor. - -### Relationships Section - -The updates to relationships and assessments should immediately be visible in the table view. +### Builder -![Assessments Table](images/le_rel_assessment_table.png) +Available via the 'System Admin' page. Users with admin privileges can create / edit diagrams. -### Example Input +### Section -| Entity External Id | Legal Entity External Id | Comment | Remove Relationship | -|--------------------|--------------------------|----------------------|-----------------------| -| `ENTITY_EXT_ID` | `LEGAL_ENTITY_EXT_ID` | `COMMENT` (optional) | `X` or `Y` (optional) | +A list of active diagrams can be selected from in the diagrams section. \ No newline at end of file