Sugar 7 Developer Release Training Part3

8/11/2019 Sugar 7 Developer Release Training Part3

1/94

2013 SugarCRM Inc. All rights reserved.

CONFIDENTIAL

Benefits of the enhanced

customization capabilities of SugarSugar 7 Developer Training


2/94

Filipe Guerra (aka @alias_mac)[email protected]

Joo Morais (aka @jcsmorais)

[email protected]


Introduction

2
mailto:[email protected]:[email protected]:[email protected]:[email protected]:[email protected]


3/94


Objectives

At the end of the session you will be able to:

3


4/94


Objectives


! Know about special features of Sugar

New platforms

New views FTS on REST API

Filter API and Relate API

Dashlets

3


5/94


Objectives


! Know about special features of Sugar

New platforms

New views FTS on REST API

Filter API and Relate API

Dashlets

! Tweak Sugar faster to achieve customers needs

3


6/94


Ability to create other clients

4


7/94



! Why?

4


8/94



! Why?

Because you might want di!erentmetadata to integrate with other platforms

4


9/94



! Why?


E.g.: website, ERP system

4


10/94



! Why?



! How can you create another client?

4


11/94



! Why?



! How can you create another client?

create !"#$%&'()!folder in your modules

or on $*+),"!folder

4


12/94



5


13/94



! Request myclient metadata:

5


14/94




Public metadata:https:///rest/v10/metadata/

public?platform=myclient

5
https://%3Csugar-url%3E/rest/v10/metadata/public?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata/public?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata/public?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata/public?platform=myclient


15/94




Public metadata:https:///rest/v10/metadata/

public?platform=myclient Private metadata:

https:///rest/v10/metadata?platform=myclient

5
https://%3Csugar-url%3E/rest/v10/metadata?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata/public?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata/public?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata/public?platform=myclienthttps://%3Csugar-url%3E/rest/v10/metadata/public?platform=myclient


16/94


What is the di!erence?

6


17/94



! Public:

No authentication needed

Provides public information for:! basic configuration values

! i18n labels location to download

! logo location to download or use as imagesource

6


18/94



7


19/94



! metadata: public layouts

public views

public fields

public modules

! components location (jssource) minifiedcontrollers: public layouts

public views public fields

public modules

7


20/94



8


21/94



! Private:

Authentication needed

Provides private information of:! basic configuration values (normally = public)

! i18n labels location to download (normally =public)

! logo location to download or use as image

source (normally = public)

8


22/94



! metadata: private layouts

private views

private fields

private modules

! components location (jssource) minifiedcontrollers: private layouts

private views private fields

private modules

9


23/94



! currencies available on the system

! module tab mapping (for mega menu)

!

hidden subpanels! relationships

! server information

10


24/94


New views

11


25/94


New views

! List view (Records)

11


26/94


New views


! Detail/Edit view (Record)

11


27/94


New views



! Create view (using Record view metadata)

11


28/94


New views




! Custom views (e.g.: about,administration, notifications)

11


29/94


New views





! Url to use di!erent layout (using custom

routing)

11


30/94


New views





! Url to use di!erent layout (using custom

routing)! Custom routing not supported on 7.0

11


31/94


New views

!-./,0*%'1 3 %4#,*)!5'$,50+!

!-./,0*%'1!.&01 3 %4#,*)!5'$,50!

!-./,0*%'1!$5'4)' 3 %4#,*)!$5'4)'!

!-./,0*%'1!%4#,*)!.%4#,*)6(4"'1 3%4#,*)!%4#,*)6(4"'

!-./,0*%'1!$,(7&8 3 %4#,*)!$,(7&8!

12


32/94


Full Text Search on REST API

! FTS requires ElasticSearch to beinstalled on 7.0

!9'45$: 7,5 ';'5#):&(8 ):4)

$,()4&(+ +,"'):&(8 !+'45$:?@3.(''0%'1

!A5 ,(%# ,( +,"' ",0*%'+

!+'45$:?@3.(''0%'1B",0*%'C%&+)3.",0*%'C%&+)1

13


33/94


FTS on REST API

GET /search?q=units

{

"next_o!set": 20,

"records": [{

"id": "f8ac0bbd-aa3f-fec3-7fa5-5246447f23a4",

"name": "Send units example",//...

"_module": "Tasks",

"_search": {

"score": 1

}

}, {

"id": "fed00b88-3e85-6b08-dd19-5246454519e7", "name": "Q.R.&E. Corp - 268 Units",

//...

"_module": "Opportunities",

14


34/94


Filter API

! Do searches like a SQL pro! !.",0*%'1?7&%)'5DEF

D7&'%0CGF3;4%*'CGB7&%)'5DGF

D%&(HC(4"'I7&'%0CJF3;4%*'CJ! Or more readable:

!.",0*%'1?7&%)'53D

KL7&'%0CGMN L;4%*'CGMOPKL%&(HC(4"'I7&'%0CJMN L;4%*'CJMO

F

15


35/94


Filter API

GET /Accounts?filter[0][billing_address_state]=CA&filter[1][cases.status]=New

{

"next_o!set": -1,

"records": [{

"id": "f01e2bde-4284-e3ec-2379-524644b976fd", "name": "T-Squared Techs",

//...

"_module": "Accounts"

}, {

"id": "eeea02c2-6171-f506-035b-5246440e0fdc", "name": "Calm Sailing Inc",

//...

"_module": "Accounts"

16


36/94


Relate API

17


37/94


Relate API

! Get related records easily

17


38/94


Relate API

! Get related records easily !.",0*%'1!.&01!%&(H!.%&(HC(4"'1

17


39/94


Relate API


! And you can filter them also

17


40/94


Relate API



!.",0*%'1!.&01!%&(H!.%&(HC(4"'1?

7&%)'53

17


41/94


Relate API



!.",0*%'1!.&01!%&(H!.%&(HC(4"'1?

7&%)'53

! Same rules of filter api (easy)

17


42/94


Relate API

!Q$$,*()+!7EG'JR0'6SJTS6'U'$6JUVW6XJSYSSRWVY70!%&(H!$4+'+

K

Z('[)C,77+')ZNJEP

Z5'$,50+ZNDK

Z&0ZNZ7U$GYJTT60YXE6JW0Y6TY'76XJSYSSTW07WEZP

Z(4"'ZNZ\''0 ), ]*5$:4+' 400&)&,(4% %&$'(+'+ZP

!!III

!Q$$,*()+!7EG'JR0'6SJTS6'U'$6JUVW6XJSYSSRWVY70!%&(H!$4+'+?7&%)'5DEFD+)4)*+F3\'^

K

Z('[)C,77+')ZN6GP

Z5'$,50+ZNDK

Z&0ZNZUEJ4EJYR6R'SV6UWG'6V$WX6XJSYSSGXVYXWZP

Z(4"'ZNZ_45(&(8 "'++48' ^:'( *+&(8 ):' ^5,(8 R5,^+'5ZP!!III

Z$4+'C(*"R'5ZNTYP

Z+)4)*+ZNZ\'^ZP

18


43/94


Yes, you can still do retrieves...

! Get any record based on the module and id: !.",0*%'1!.&01

!Q$$,*()+!7EG'JR0'6SJTS6'U'$6JUVW6XJSYSSRWVY70

K

Z&0ZN Z7EG'JR0'6SJTS6'U'$6JUVW6XJSYSSRWVY70ZP

Z(4"'ZN Z>69@*45'0 >'$:+ZP

!!III

19


44/94


Slim payload

! On all of them you can slim the amount of fieldsretrieved

! Pass 7&'%0+3(4"'to just get the name field

!

You will always get some fields (even if youdont request them)

id

date_modified

_acl

following

_module

20


45/94


Tweaking Sugar faster

21


46/94



! Provided documentation on viewcontrollers (e.g.: +*845$5"!$%&'()+!R4+'!;&'^+!)4RR'0604+:%')!)4RR'06

04+:%')I`+)

21


47/94




04+:%')I`+)

! Able to create views/layouts withmetadata only

21


48/94




04+:%')I`+)

! Able to create views/layouts withmetadata only

! Able to do quicker tweaks withjust I:R+files

21


49/94



22


50/94



! By making metadata driven changes:

22


51/94



! By making metadata driven changes: Save JS components re-minification

22


52/94




Metadata changes triggers 412 code

22


53/94





Upgrade safe and less error prone:

22


54/94





Upgrade safe and less error prone:! avoids breaking the app

22


55/94






! avoid 500 and 404 errors

22


56/94







Components can:

22


57/94







Components can:

! reuse metadata

22


58/94







Components can:

! reuse metadata! read metadata from di!erent locations and mix

them to achieve final UI

22


59/94



23


60/94



! See how it looks like before changingand deploying

23


61/94




Change metadata on browsers console

Q]]I"')404)4I8')/,0*%'abQ$$,*()+bcI;&'^+I5'$,50I"')4I]4('%+DJFI$,%*"(+ 3 U

23


62/94






Change templates on browsers consoleQ]]I)'"]%4)'I+')d&'%0!+')e&'^!+')f4#,*)

23


63/94






Change templates on browsers consoleQ]]I)'"]%4)'I+')d&'%0!+')e&'^!+')f4#,*)

Call 5'(0'5acor navigate to the view again

(to see applied changes)

23


64/94



24


65/94



! Integrations are faster

24


66/94



! Integrations are faster use browsers console to call remote code

24


67/94




use %,40g4)4acto make remote calls

24


68/94





pass remote information to the 5'(0'5acifnot disposed

24


69/94





pass remote information to the 5'(0'5acifnot disposed

I:R+file can be used to show the remote

data or a remote template can be used tokeep the template updated from remoteservice

24


70/94


Dashlets

! 7.x Views that use Dashlet plugin

25


71/94


Dashlets


25


72/94


Dashlets


25


73/94


Dashlets


25


74/94


Dashlets


25

X


75/94


Dashlets


25

X


76/94


Dashlets


25


77/94


Dashlets

! 7.x Anatomy

! View

26

.h66 III!$%&'()+!R4+'!;&'^+!"#604+:%')!"#604+:%')I:R+ 661

.:X1i'%%, ^,5%0 Nc.!:X1

.:Y1_'%$,"' ), =/=Q j45)('5 9*""&) JEGU.!:Y1


78/94


Dashlets

! 7.x Anatomy

! Controller

27

!! III!$%&'()+!R4+'!;&'^+!"#604+:%')!"#604+:%')I`+

aK

]%*8&(+N Dbg4+:%')bF

Oc


79/94


Dashlets

! 7.x Anatomy

! Metadata

28

!! III!$%&'()+!R4+'!;&'^+!"#604+:%')!"#604+:%')I]:]k;&'^0'7+DbR4+'bFDb;&'^bFDb"#604+:%')bF 3 4554#a

b04+:%')+b 31 4554#a

4554#a

b%4R'%b 31 bflfC/mCgQ9if=>bP

b0'+$5&])&,(b 31 bflfC/mCgQ9if=>Cg=9nopj>pA\bP

b$,(7&8b 31 4554#acP

b]5';&'^b 31 4554#acP

cP

cP

cq


80/94


Dashlets

29


81/94


Dashlets

29


82/94


Dashlets

30

!! III!$%&'()+!R4+'!;&'^+!"#604+:%')!"#604+:%')I`+

aK

]%*8&(+N Dbg4+:%')bFP

%,40g4)4N 7*($)&,( ac K

;45 '(0],&() 3 b:))]+N!!4`4[I8,,8%'4]&+I$,"!4`4[!+'5;&$'+!+'45$:!('^+?;3GIEbP

@*'5# 3 b+*845$5"bP

%&"&) 3 Xq

kI4`4[aK *5%N '(0],&() r bB@3b r @*'5# r bB5+s3b r %&"&)P

04)4>#]'N b`+,(]bP

+*$$'++N 7*($)&,( a04)4c K

&7 a):&+I0&+],+'0c K

5')*5(q

O

CI'[)'(0a):&+P 04)4cq

):&+I5'(0'5acq

OP

$,()'[)N ):&+

Ocq

O

Oc
https://ajax.googleapis.com/ajax/services/search/news?v=1.0%27https://ajax.googleapis.com/ajax/services/search/news?v=1.0%27


83/94


Dashlets

31

.h66 III!$%&'()+!R4+'!;&'^+!"#604+:%')!"#604+:%')I:R+ 661KK-&7 5'+],(+'g4)4I5'+*%)+OO

KK-'4$: 5'+],(+'g4)4I5'+*%)+OO

.0&; $%4++3Z('^+645)&$%'Z1

.:X1.4 :5'73ZKK):&+I*('+$4]'0t5%OOZ1KKK):&+I)&)%'\,d,5"4))&(8OOO.!41

.!:X1 aKKK):&+I]*R%&+:'5OOOc

.]1KKK):&+I$,()'()OOO.!]1

.!0&;1

KK!'4$:OO

KK'%+'OO

.0&; $%4++3ZR%,$H67,,)'5Z1KK+)5 ZflfC\ACgQ>QCQeQpfQlf=ZOO.!0&;1

KK!&7OO


84/94


Dashlets

32


85/94


Handlebars

33


86/94


Handlebars

! Wrap-up

33


87/94


Handlebars

! Wrap-up Simple conditions

33


88/94


Handlebars


this.* completely available on view

33


89/94


Handlebars



Avoid using {{{

33


90/94


Handlebars



Avoid using {{{

Use Handlebars.SafeString() with care

33

dl b


91/94


Handlebars



Avoid using {{{

Use Handlebars.SafeString() with care

Sugar7 + Sidecar have a set of Handlebars

Helpers

33

i


92/94


Questions?

34

P i


93/94


Practice

! Download latest version! Build Sugar

! Start customizing using metadata only

! Create some modules/dashlets

! Check for memory leaks (usingChrome)

35

Q i ?


94/94

Questions?

Documents

Sugar 7 Developer Release Training Part3