Produced by Araxis Merge on 2/1/2017 2:57:37 PM Eastern Standard Time. See www.araxis.com for information about Merge. This report uses XHTML and CSS2, and is best viewed with a modern standards-compliant browser. For optimum results when printing this report, use landscape orientation and enable printing of background images and colours in your browser.
| # | Location | File | Last Modified |
|---|---|---|---|
| 1 | C:\Araxis_Merge_Comprasion\Pub_un\BTSSS_CIF_122016.zip\BTSSS_CIF_12_20_16\clean\CRM\trunk\SDK\Tools\WebResourceUtility | Readme.docx | Tue Dec 20 19:52:28 2016 UTC |
| 2 | Wed Feb 1 19:57:36 2017 UTC |
| Description | Between Files 1 and 2 |
|
|---|---|---|
| Text Blocks | Lines | |
| Unchanged | 0 | 0 |
| Changed | 0 | 0 |
| Inserted | 0 | 0 |
| Removed | 1 | 217 |
| Whitespace | |
|---|---|
| Character case | Differences in character case are significant |
| Line endings | Differences in line endings (CR and LF characters) are ignored |
| CR/LF characters | Not shown in the comparison detail |
No regular expressions were active.
| 1 | Microsoft Dynamics C RM SDK | |||||
| 2 | Web Resour ce Utility Readme | |||||
| 3 | ||||||
| 4 | The Web Re source Uti lity strea mlines the task of u ploading m any files as Micros oft Dynami cs CRM Web Resources in a cons istent man ner. | |||||
| 5 | Summary | |||||
| 6 | The follow ing provid es a brief overview of the too l’s functi onality an d implemen tation. | |||||
| 7 | Purpose | |||||
| 8 | This GUI d eveloper t ool is des igned to e xpedite th e process of locatin g and uplo ading file s as Web R esources i nto Micros oft Dynami cs CRM. Sp ecifically , the tool provides the follow ing functi onality: | |||||
| 9 | ||||||
| 10 | Create and save Micr osoft Dyna mics CRM s erver/orga nization i nformation locally. User will connect to a single destinatio n server/o rganizatio n to uploa d web reso urces. Use r can save as many s erver/orga nization c onfigurati ons as des ired. | |||||
| 11 | ||||||
| 12 | Choose an existing M icrosoft D ynamics CR M Unmanage d Solution to contai n the uplo aded Web R esources a fter conne cting to a server/or ganization . | |||||
| 13 | ||||||
| 14 | Create and save a “W eb Resourc e Packages ” locally. A package is simply a set of selected f iles relat ive to a r oot direct ory that c an be uplo aded as we b resource s. Folder Browser di alogs, Sea rch by Fil ename, and sortable grids help the user locate des ired files . User has multiple options to name and upload the Web Resou rces. See “Using the Utility” for specif ics. | |||||
| 15 | ||||||
| 16 | Technology | |||||
| 17 | The Web Re source Uti lity is cr eated usin g Windows Presentati on Foundat ion (WPF) in C# .NE T 4.0. The source co de follows a MVVM de sign patte rn, making use of Da ta Binding , Command Binding, d ata valida tion, LINQ to Object s, and LIN Q to XML. Data is re trieved an d stored i n two (2) XML files and Micros oft Dynami cs CRM usi ng the Org anizationS erviceProx y and Orga nizationSe rviceConte xt classes . | |||||
| 18 | ||||||
| 19 | See “CrmSe rviceHelpe rs” sample for more informatio n on conne cting to M icrosoft D ynamics CR M. | |||||
| 20 | ||||||
| 21 | Installati on | |||||
| 22 | The soluti on must be built in Visual Stu dio 2010 b efore runn ing. Doubl e-click th e “WebReso urceUtilit y.sln” to open the s ource code in Visual Studio 20 10. Open a nd view th e Solution Explorer. | |||||
| 23 | Solution D ependencie s | |||||
| 24 | This solut ion uses l inked file s and requ ires acces s to the f ollowing f iles in or der to com pile: | |||||
| 25 | In the Dat aAccess fo lder: | |||||
| 26 | sdk\sample code\cs\he lpercode\C rmServiceH elpers.cs | |||||
| 27 | sdk\sample code\cs\he lpercode\d eviceidman ager.cs | |||||
| 28 | sdk\sample code\cs\he lpercode\m yorganizat ioncrmsdkt ypes.cs | |||||
| 29 | sdk\sample code\cs\he lpercode\o ptionsets. cs | |||||
| 30 | You may ne ed to manu ally updat e the link s for thes e files be fore tryin g to build the solut ion or you may exper ience comp ilation er rors. | |||||
| 31 | This solut ion includ es referen ces to the following files: | |||||
| 32 | sdk\bin\mi crosoft.cr m.sdk.prox y.dll | |||||
| 33 | sdk\bin\mi crosoft.xr m.sdk.dll | |||||
| 34 | ||||||
| 35 | Build the Solution | |||||
| 36 | Right-clic k the “Web ResourceUt ility” SLN file in S olution Ex plorer and click bui ld. An EXE will be p roduced in the bin/D ebug folde r. | |||||
| 37 | Run Utilit y | |||||
| 38 | Double-cli ck the EXE in the bi n/Debug fo lder or pr ess F5 to debug dire ctly in Vi sual Studi o 2010. | |||||
| 39 | ||||||
| 40 | Using the Utility | |||||
| 41 | There are three (3) main tabs that play a role in the proces s of uploa ding web r esources: Connection s, Solutio ns, and We b Resource Packages. On each t ab there i s a Red/Gr een indica tor and te xt represe nting the user’s pro gress on t hat tab. T he user ma y only upl oad Web Re sources wh en all ind icators ar e Green an d contain text. | |||||
| 42 | ||||||
| 43 | Connection s | |||||
| 44 | This tab p rovides a list of se rver/organ ization co nfiguratio ns and pro vides the following four (4) a ctions: | |||||
| 45 | New – Crea tes a new connection . | |||||
| 46 | Delete – D eletes the selected connection . | |||||
| 47 | Save Conne ctions – S aves all c onnections in the li st. | |||||
| 48 | Connect! – Prompts t he user fo r password . This act ion causes authentic ation with CRM and r etrieval o f existing Unmanaged Solutions . Displays any error s that occ ur. Activa tes the se lected con nection if successfu l. The red indicator will turn green upo n success. | |||||
| 49 | Note: Allo w up to a minute for this proc ess to com plete. Whe n the proc ess comple tes, if th e query re turns a si ngle Unman aged Solut ion named “Default”, it will a uto-activa te the Sol ution and take the u ser to the Packages tab. Other wise, the user will be taken t o the Solu tions tab to choose an existin g Unmanage d Solution . | |||||
| 50 | ||||||
| 51 | Solutions | |||||
| 52 | This tab p rovides a list of Un managed So lutions an d a single action: | |||||
| 53 | Choose – A ctivates t he selecte d solution . Only one (1) can b e active a t a time. | |||||
| 54 | ||||||
| 55 | The Active Solution is the des tination c ontainer f or uploade d Web Reso urces. The Red indic ator will turn to Gr een when a solution is active. | |||||
| 56 | ||||||
| 57 | The Soluti on entity in CRM has a parent Publisher. The Publi sher has a field to store its customizat ion prefix , i.e., “n ew_”. The customizat ion prefix is always used in n aming Web Resources in the CRM user inte rface and is therefo re replica ted in thi s utility. | |||||
| 58 | Example: “ new_/MySam plesPackag e/ClientBi n/MySilver lightSampl e.xap” | |||||
| 59 | ||||||
| 60 | For more i nformation on soluti ons see “I ntroductio n to Solut ions” in t he Microso ft Dynamic s CRM 2011 SDK. | |||||
| 61 | ||||||
| 62 | Web Resour ce Package s | |||||
| 63 | This tab p rovides al l the func tionality to create and save p ackages, s earch for files, add web resou rces and u pload reso urces to D ynamics CR M. For rea dability, this tab i s broken d own into m ultiple se ctions. | |||||
| 64 | ||||||
| 65 | Packages s ection | |||||
| 66 | ||||||
| 67 | ||||||
| 68 | ||||||
| 69 | This secti on contain s a grid t hat displa ys all sav ed Web Res ource Pack ages and p rovides th ree (3) ac tions: | |||||
| 70 | ||||||
| 71 | Load Packa ge – Activ ates the s elected pa ckage and displays t he detail data. Only one (1) p ackage can be active at a time for edit/ upload. Us er must sa ve any cha nges to ac tive packa ge prior t o loading a new pack age. | |||||
| 72 | New Packag e – Create s a new Pa ckage in t he list. A uto-saves the Active Package a nd Activat es the new ly created package a llowing it to be edi ted. | |||||
| 73 | Delete – D eletes the package s elected in the list. If the pa ckage sele cted in th e list is also the A ctive Pack age, it wi ll still b e deleted. | |||||
| 74 | ||||||
| 75 | Package De tail secti on | |||||
| 76 | This secti on allows user to ed it and sav e Package details, s earch for files, add files as Web Resour ces, uploa d Web Reso urces to C RM and vie w upload r esults in an output window. | |||||
| 77 | ||||||
| 78 | Package In fo | |||||
| 79 | ||||||
| 80 | ||||||
| 81 | ||||||
| 82 | Package Na me – Suppl y a meanin gful name that descr ibes a set of Web Re sources. D on’t use s paces, hyp hens or do uble forwa rd-slashes . Only alp hanumeric, periods, underscore and singe forward-s lash are a llowed. | |||||
| 83 | Root Path – Use the Browse but ton to ope n a Folder Browser D ialog and select the folder co ntaining a ll web fil es. | |||||
| 84 | ||||||
| 85 | ||||||
| 86 | File Searc h | |||||
| 87 | ||||||
| 88 | ||||||
| 89 | ||||||
| 90 | ||||||
| 91 | ||||||
| 92 | ||||||
| 93 | ||||||
| 94 | ||||||
| 95 | ||||||
| 96 | Search by Filename – User can refine the list of f iles by en tering sea rch text. Text is ca se-sensiti ve and wil l match an y files wh ere the Pa th contain s the sear ch text. | |||||
| 97 | Search – U ser can re fresh the list of fi les shown by clickin g Search b utton. | |||||
| 98 | Add Files to Web Res ources – C onverts th e selected rows into the Web R esource Gr id. | |||||
| 99 | ||||||
| 100 | ||||||
| 101 | Web Resour ces | |||||
| 102 | ||||||
| 103 | ||||||
| 104 | ||||||
| 105 | ||||||
| 106 | ||||||
| 107 | ||||||
| 108 | ||||||
| 109 | ||||||
| 110 | ||||||
| 111 | Web Resour ce name pr efix – Thi s label sh ows what t he prefix of each We b Resource will be w hen upload ed to Micr osoft Dyna mics CRM. Web Resour ce name is a concate nation of the prefix and the N ame column . | |||||
| 112 | NOTE: the prefix, li ke “new_” will only display if there is an Active Solution f rom the So lutions ta b. The pre fix comes from the s olution’s publisher. | |||||
| 113 | Use Packag e Name as Web Resour ce namespa ce – This checkbox d etermines whether or not the P ackage Nam e is used on the end of the pr efix. It i s recommen ded to kee p related web resour ces under their own unique ‘na mespace’ t o help ass ure files names are unique. Co nsider the possibili ty that tw o differen t solution s have a j avascript file named “account. js” and pr ovide diff erent func tionality. Namespaci ng your fi les will h elp assure uniquenes s and prov ides a top -level vir tual folde r structur e under wh ich all we b resource s of a pac kage resid e. | |||||
| 114 | ||||||
| 115 | Example | |||||
| 116 | Publisher Prefix = “ new_” | |||||
| 117 | Package Na me = “CrmO DataSilver lightCrud” | |||||
| 118 | Name (edit able) colu mn = “/Cli entBin/Crm ODataSilve rlightCRUD .xap” | |||||
| 119 | Web Resour ce Name us ed when up loading / searching for duplic ates: | |||||
| 120 | “new_/CrmO DataSilver lightCrud/ ClientBin/ CrmODataSi lverlightC RUD.xap” | |||||
| 121 | ||||||
| 122 | Remove Web Resource – Removes one or mor e selected Web Resou rces from the grid. | |||||
| 123 | ||||||
| 124 | Editable c olumns – D isplay Nam e and Desc ription co lumns can be changed as desire d, without hesitatio n. There e xists a ra mification of changi ng the Nam e column f rom the de fault valu e. Changin g the name can break any relat ive refere nces betwe en individ ual web re sources. F or example , you may have an HT ML web res ource that has a scr ipt tag re ferencing a JS web r esource by relative path. Leav ing the de fault name s helps as sure refer ential int egrity. Ch anging the Name colu mn should be done so with this understan ding. | |||||
| 125 | ||||||
| 126 | ||||||
| 127 | Package co mmands | |||||
| 128 | ||||||
| 129 | ||||||
| 130 | ||||||
| 131 | Publish al l customiz ation afte r uploadin g web reso urces – Th is checkbo x determin es whether a Publish AllXmlRequ est messag e is execu ted after the applic ation has completed uploading all web re sources. P ublishing web resour ces ensure s their co ntent is u pdated and publicly available for use/te sting. | |||||
| 132 | Save Packa ge – Saves the detai ls of the Package to XML file, including the Packa ge Name, R oot Path a nd all Web Resources in the We b Resource s Grid. | |||||
| 133 | Upload All – Can onl y be click ed when al l tabs are active (g reen). Upl oads all W eb Resourc es in the grid to Dy namics CRM . The tool will prop erly creat e or updat e based on the Web R esources e xistence i n Dynamics CRM. Disp lays the o utput wind ow and dis ables all buttons un til proces s is compl ete. | |||||
| 134 | Upload Sel ected - Ca n only be clicked wh en all tab s are acti ve (green) . Uploads the select ed Web Res ources in the grid t o Dynamics CRM. The tool will properly c reate or u pdate base d on the W eb Resourc es existen ce in Dyna mics CRM. Displays t he output window and disables all button s until pr ocess is c omplete. | |||||
| 135 | Show Outpu t – Displa ys the out put window containin g the resu lts of upl oading Web Resources . | |||||
| 136 | ||||||
| 137 | ||||||
| 138 | XML Schema | |||||
| 139 | There are two (2) XM L files th at store d ata for th e utility. When you build the solution, the XML fi les will b e added to the bin/D ebug folde r along wi th the .EX E. | |||||
| 140 | configurat ions.xml – Store all connectio n informat ion from t he Connect ions tab. | |||||
| 141 | ||||||
| 142 | Example sc hema: | |||||
| 143 | <Configura tions> | |||||
| 144 | <Configu ration nam e="MaxusBe ta" | |||||
| 145 | server="ma xus-beta" | |||||
| 146 | orgName="A dventureWo rksCycle" | |||||
| 147 | userName=" administra tor" | |||||
| 148 | domain="ma xus-betado m" /> | |||||
| 149 | </Configur ations> | |||||
| 150 | ||||||
| 151 | ||||||
| 152 | packages.x ml – Store s all pack age and we b resource informati on from th e Packages tab. | |||||
| 153 | ||||||
| 154 | Example sc hema: | |||||
| 155 | <UtilityRo ot> | |||||
| 156 | <Package s> | |||||
| 157 | <Packa ge name="C rmODataSil verlightCr ud" rootPa th="C:\Sou rce\CrmSdk V5\CrmODat aSilverlig htCRUD\Crm ODataSilve rlightCRUD .Web" isNa mePrefix=" True"> | |||||
| 158 | <Web ResourceIn fo name="/ CrmODataSi lverlightC RUDTestPag e.html" | |||||
| 159 | filePat h="\CrmODa taSilverli ghtCRUDTes tPage.html " | |||||
| 160 | display Name="CrmO DataSilver lightCRUDT estPage.ht ml" | |||||
| 161 | type="h tml" | |||||
| 162 | descrip tion="" /> | |||||
| 163 | <Web ResourceIn fo name="/ ClientBin/ CrmODataSi lverlightC RUD.xap" | |||||
| 164 | filePat h="\Client Bin\CrmODa taSilverli ghtCRUD.xa p" | |||||
| 165 | display Name="CrmO DataSilver lightCRUD. xap" | |||||
| 166 | type="x ap" | |||||
| 167 | descrip tion="" /> | |||||
| 168 | <Web ResourceIn fo name="/ Silverligh t.js" | |||||
| 169 | filePat h="\Silver light.js" | |||||
| 170 | display Name="Silv erlight.js " | |||||
| 171 | type="j s" | |||||
| 172 | descrip tion="" /> | |||||
| 173 | </Pack age> | |||||
| 174 | </Packag es> | |||||
| 175 | </UtilityR oot> | |||||
| 176 | ||||||
| 177 | ||||||
| 178 | Known Issu es | |||||
| 179 | ||||||
| 180 | On the Con nections s creen, the “Connect! ” button s ometimes c auses an e rror, “Unk nown: 0x80 043455” to be displa yed. This is an exce ption aris ing in the DeviceIdM anager.cs file. To r esolve thi s sporadic error, si mply click Connect a gain and r e-enter yo ur passwor d. Repeat up to 3 ti mes. | |||||
| 181 | ||||||
| 182 | When uploa ding Web R esources t o CRM, the service i s ignoring the Displ ayName col umn on the Web Resou rces grid. It defaul ts the Web Resources ’ DisplayN ame equal to the Nam e. You ca n manually change th e DisplayN ame value on the ser ver. | |||||
| 183 | ||||||
| 184 | When conne cting to M icrosoft D ynamics CR M Online, use the fo llowing va lues to co nnect: | |||||
| 185 | ||||||
| 186 | Label | |||||
| 187 | Value | |||||
| 188 | Server | |||||
| 189 | crm.dynami cs.com | |||||
| 190 | Organizati on | |||||
| 191 | <your orga nization n ame> | |||||
| 192 | Username | |||||
| 193 | <your Live Id e-mail address> | |||||
| 194 | Domain | |||||
| 195 | <leave bla nk> | |||||
| 196 | ||||||
| 197 | When promp ted for yo ur passwor d enter yo ur Windows Live Id p assword. | |||||
| 198 | The applic ation incl udes logic to only a llow updat ing web re sources wh ere the Is Customizab le managed property equals tru e. The IsC ustomizabl e managed property i s supposed to be enf orced only when the web resour ce is part of a mana ged soluti on. The ad ditional c onstraint in this ap plication was added to fix an issue wher e the appl ication fa iled when attempting to update web resou rces in a managed so lution whe re it is n ot allowed . An unwan ted side e ffect is t hat the ap plication is now una ble to upd ate web re sources in an unmana ged soluti on where t he IsCusto mizable ma naged prop erty equal s false. I f you inte nd to set the IsCust omizable m anaged pro perty to t rue, the w orkaround is to wait until you have fini shed your developmen t using th is applica tion and s et the IsC ustomizabl e property just befo re you exp ort the so lution as managed. | |||||
| 199 | ||||||
| 200 | Troublesho oting | |||||
| 201 | Build erro r(s) | |||||
| 202 | If you get a build e rror when trying to build the utility, b e sure to assure all files and assembly references resolve p rior to bu ilding. | |||||
| 203 | Run-time e rrors | |||||
| 204 | If you are experienc ing errors when runn ing the sa mple, chec k the foll owing. | |||||
| 205 | Make sure the two XM L files ar e availabl e in the s ame direct ory as the EXE. | |||||
| 206 | Copyright | |||||
| 207 | This docum ent is pro vided "as- is". Infor mation and views exp ressed in this docum ent, inclu ding URL a nd other I nternet We b site ref erences, m ay change without no tice. You bear the r isk of usi ng it. | |||||
| 208 | ||||||
| 209 | Some examp les depict ed herein are provid ed for ill ustration only and a re fictiti ous. No re al associa tion or co nnection i s intended or should be inferr ed. | |||||
| 210 | ||||||
| 211 | This docum ent does n ot provide you with any legal rights to any intell ectual pro perty in a ny Microso ft product . You may copy and u se this do cument for your inte rnal, refe rence purp oses. | |||||
| 212 | ||||||
| 213 | © 2010 Mic rosoft Cor poration. All rights reserved. | |||||
| 214 | ||||||
| 215 | Microsoft, Active Di rectory, A ctiveX, Bi zTalk, Exc el, Great Plains, In ternet Exp lorer, JSc ript, Micr osoft Dyna mics, MSN, Outlook, PivotTable , PivotCha rt, Visual Basic, Vi sual Studi o, Windows , Windows Live, Wind ows Server , and Wind ows Vista are tradem arks of th e Microsof t group of companies . | |||||
| 216 | ||||||
| 217 | All other trademarks are prope rty of the ir respect ive owners . |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.