Configuration Guide xrm1 Data Grid CRM 2013, 2015, 2016 and CRM Online

Transcription

1 Configuration Guide xrm Data Grid CRM 03, 05, 06 and CRM Online General Information Customizing the xrm Data Grid 3 Further information and Troubleshooting General Information This guide is about the configuration and customization of the xrm Data Grid. It was developed with the new Goldbright Technology. All necessary information about Goldbright are to be found on our website Listing Types The xrm Data Grid can handle two different listing types: Name Description Example Hierarchical listing a) for a specific root project: displays the records in a hierarchical structured way based on the selected root record b) in a global scope: displays the records in a hierarchical structured way with multiple root records a) Work Breakdown Structure in the Project entity b) Global Gantt Flat listing displays the records in a flat list Expense Calculator in the Receipts entity. Adding Data The behavior of the xrm Data Grid when adding records is based on the listing type. For the flat list, the Add -Button is available. For the hierarchical listing for a specific root project, the Add sub node -Button is available. For hierarchical listing in a global scope (e.g. Global Gantt), the Add - and Add sub node -Buttons are both available. Add -Buttons: Name Add Add sub-node Description Shows the MS Dynamics CRM form to create a new record based on the type of the view (saved query). Shows the MS Dynamics CRM form to create a new record based on the type of the view (saved query) and sets the value for parent relationship. Version Rollup 7 or higher / 5

2 .3 Editing Data The xrm Data Grid provides the ability to edit exiting records or to add new ones, based on a Microsoft Dynamics CRM View (Saved Query). Only unlocked fields and active records which don t have the locked symbol, can be used for editing. Active and inactive fields and records: Inactive fields are marked with a locked symbol field or the whole records is blocked for editing: The record is in an inactive state The related form of the displayed entity has a locked field The column referrers to a linked entity The field is locked based on field level security profiles and cannot be edited. There are multiple reasons why a If a field is active or inactive depends on the form. This means, e.g. a field in the WBS is active if it is not locked in the underlying project form. After deactivating a project node, all fields of the respective WBS row have a locked symbol. The xrm Data Grids provides the ability to display values to a related entity. For example, you want to display contact records and in addition, some fields of the account. Fields from the account cannot be edited in this case. Also you can define which fields are editable for specific users based on field level security profiles provided by Microsoft Dynamics CRM. Version Rollup 7 or higher / 5

3 Customizing the xrm Data Grid The xrm Data Grid is completely configured and customized by standard customization elements of Microsoft Dynamics CRM. Columns are configured by Views; Fields are configured by fields and forms. Version Rollup 7 or higher 3 / 5

4 . Adding a hierarchical xrm Data Grid in an entity form xrm Business Solutions for Microsoft CRM.. Adding the hierarchical grid to a form For adding the xrm Data Grid to another entity form, go to Settings --> click on Customizations --> select Customize the System --> enlarge Entities in the sitemap (see below, area ) --> enlarge the desired entity, e.g. Account (see below, area ) --> click on Forms (see below, area 3). Open the desired form, e.g. Information (see below, area 4). 3 4 Then go to the INSERT section and select the tab type you would like to add (see below, area ). When the new tab is highlighted (as seen in the screenshot above), click on Web Resource (see above, area ). Fill out the fields of the opening Add Web Resource window. Version Rollup 7 or higher 4 / 5

5 The following table was added as a guideline for entering correct values. Field Value Remark Web resource Name Enter what is named in the Remark column of this table Choose a unique name for your web resource xrm_/web/html/datagrid.html The name of the web resource must have the following format: WebResource_ xxx, e.g. WebResource_account_datagrid Label Enter the label name E.g. account_datagrid Visibility Custom Parameter (data) Mark as checked Pass the right arguments to the web resource. E.g. SavedQueryId= AA &ListType=Hierarchi cal&linkfromattributename=acco untid&linktoattributename=paren taccountid In order to pass the right arguments to the web resource, you need the GUID of the respective view (saved query), the list type and as you work with a hierarchical list two additional parameters: To get the GUID, go to Settings --> Customizations --> Customize the System --> enlarge Entities --> enlarge the desired entity, e.g. Account --> click on Views. Open the desired view, e.g. Account and go to Actions --> Copy a link. After pasting the link into a file of your choice, you can derive the ID from the link: Example GUID: Link: GUID: AA Version Rollup 7 or higher 5 / 5

6 Parameter for saved query: Description Parameter name Example View id (Saved Query) SavedQueryId SavedQueryId= AA Furthermore, you can determine the list type by the following parameter: Description Parameter name Example Hierarchical listing for a structured tree view ListType ListType=Hierarchical The hierarchical listing type will display the records based on a tree structure and requires two additional parameters: Description Parameter name Example for entity project MS Dynamics CRM schema name of primary key LinkFromAttributeName itarapro_projectid MS Dynamics CRM schema name of referenced parent LinkToAttributeName itarapro_project_project_id Don t forget to Save and Publish. After refreshing the screen, the xrm Data Grid will be included in your form... Configuration of the hierarchical data grid in a form... Adding records: Behavior based on listing type The behavior of the xrm Data Grid when adding records is based on the listing type. For the hierarchical listing for a specific root project, the Add sub node -Button is available. For hierarchical listing in a global scope (e.g. Global Gantt), the Add - and Add sub node -Buttons are both available. Add sub-node : When marking a row and clicking on the Add sub-node button, a new form opens where you can enter the respective data. After saving and closing this form and a refresh of the hierarchical grid, the new sub-node will be available under the parent node. However, only data that were entered in the fields of this sub-node form are shown in the grid. Thus, if you like to take content from the parent node in the sub-node, it is necessary to make field mapping, e.g. from project to project. Field mapping example: To take the Project risk content from the parent node to the sub-nodes, mark the line of the parent node and then go to Settings --> Customizations --> Customize the System --> enlarge Entities in the sitemap (see below, area ) --> enlarge Account (see below, area ) --> click on :N Relationships (see below, area 3) and select account_parent_account (see below, area 4). Version Rollup 7 or higher 6 / 5

7 3 4 Then, click on Mapping (see below, area ) in the sitemap --> then the New button (see below, area ). After that, select e.g. account_number as the Source Target field as well as the Target Entity Field. Version Rollup 7 or higher 7 / 5

8 Afterwards, click on OK --> Save and close --> Publish all Customizations.... Displaying values and formats All common value types are supported to be displayed in the xrm Data Grid and are based on the settings and formats of Microsoft Dynamics CRM. Thus, if you change a value or format in the customizing, this change is also proceeded in xrm Data Grid. Attribute type Description Used control DateTime Will display date or date and time DatePicker Decimal Simple Formatter Double Uses formatter Formatter Integer Uses formatter Formatter BigInt Uses formatter Formatter Money Uses formatter and transaction currency Formatter Memo String Simple text Simple text Lookup Lookup behavior EditableLookup Owner Lookup behavior EditableLookup Uniqueidentifier Lookup behavior EditableLookup Boolean Dropdown list Html select control for option sets State Dropdown list Html select control for option sets Status Dropdown list Html select control for option sets Picklist Dropdown list Html select control for option sets Version Rollup 7 or higher 8 / 5

9 ...3 Text for multiple languages The displayed texts are either coming from MS Dynamics CRM directly by using a specific view (saved query) or are stored in the xrm Global Option Sets. You will find this at Settings --> Customizations --> Customize the system --> Option Sets (see below, area ). Then click on the desired option set, e.g. xrm i8n Goldbright DataGrid (see below, area ). Examples: Name Schema name Description xrm i8n Goldbright Startpage xrm i8n Goldbright DataGrid xrm_i8n_goldbright_startpage xrm_i8n_goldbright_datagrid Contains labels about the environment. - Global Exception handling - Loading process -... Contains labels about the editable data grid. - Toolbar buttons - Data Grid itself...4 Date/Time A date/time value will be displayed based on the value type with just a date or a date with time. The format of the value itself can be configured in the personal options of MS Dynamics CRM. Just click on --> Options - -> Formats. The figure below shows the personal options which defines the format of the value. Version Rollup 7 or higher 9 / 5

10 Version Rollup 7 or higher 0 / 5

11 . Adding a flat xrm Data Grid in an entity form.. Adding the flat grid to a form For adding the xrm Data Grid to another entity form, go to Settings --> click on Customizations --> select Customize the System --> enlarge Entities in the sitemap (see below, area ) --> enlarge the desired entity, e.g. Account (see below, area ) --> click on Forms (see below, area 3). Open the desired form, e.g. Information (see below, area 4). 3 4 Then go to the INSERT section and select the tab type you would like to add (see below, area ). When the new tab is highlighted (as seen in the screenshot above), click on Web Resource (see above, area ). Fill out the fields of the opening Add Web Resource window. Version Rollup 7 or higher / 5

12 The following table was added as a guideline for entering correct values. Field Value Remark Web resource Name Enter what is named in the Remark column of this table Choose a unique name for your web resource xrm_/web/html/datagrid.html The name of the web resource must have the following format: WebResource_ xxx, e.g. WebResource_my_contacts_data grid Label Enter the label name E.g. my_contacts_datagrid Visibility Custom Parameter (data) Mark as checked Pass the right arguments to the web resource. E.g. SavedQueryId= AA &ListType=Flat In order to pass the right arguments to the web resource, you need the GUID of the respective view (saved query) and the list type. To get the GUID, go to Settings --> Customizations --> Customize the System --> enlarge Entities --> enlarge the desired entity, e.g. Contacts --> click on Views. Open the desired view, e.g. My Active Contacts and go to Actions --> Copy a link. After pasting the link into a file of your choice, you can derive the ID from the link: Example GUID: Link: GUID: AA Version Rollup 7 or higher / 5

13 Parameter for saved query: Description Parameter name Example View id (Saved Query) SavedQueryId SavedQueryId= AA Furthermore, you can determine the list type by the following parameter: Description Parameter name Example Flat listing ListType ListType=Flat Don t forget to Save and Publish. After refreshing the screen, the xrm Data Grid will be included in your form... Configuration of the flat data grid in a form... Adding records The behavior of the xrm Data Grid when adding records is based on the listing type. For the flat list, the Add -Button is available. When marking a row and clicking on the Add button, a new form opens where you can enter the respective data. After saving and closing this form and a refresh of the flat grid, the new node will be available.... Add Button visibility It is possible to hide the Add button. To do this, just add the respective parameter to the web resource properties. Description Parameter name Example Forces the add button to be displayed or hidden IsAddButtonVisible IsAddButtonVisible=false IsAddButtonVisible=true Then, the custom parameter would look like this e.g.: SavedQueryId= AA &ListType=Flat&IsAddButtonVisible=false...3 Displaying values and formats All common value types are supported to be displayed in the xrm Data Grid and are based on the settings and formats of Microsoft Dynamics CRM. Thus, if you change a value or format in the customizing, this change is also proceeded in xrm Data Grid. Attribute type Description Used control DateTime Will display date or date and time DatePicker Decimal Simple Formatter Double Uses formatter Formatter Integer Uses formatter Formatter BigInt Uses formatter Formatter Money Uses formatter and transaction currency Formatter Version Rollup 7 or higher 3 / 5

14 Memo Simple text String Simple text Lookup Lookup behavior EditableLookup Owner Lookup behavior EditableLookup Uniqueidentifier Lookup behavior EditableLookup Boolean Dropdown list Html select control for option sets State Dropdown list Html select control for option sets Status Dropdown list Html select control for option sets Picklist Dropdown list Html select control for option sets...4 Text for multiple languages The displayed texts are either coming from MS Dynamics CRM directly by using a specific view (saved query) or are stored in the xrm Global Option Sets. You will find this at Settings --> Customizations --> Customize the system --> Option Sets (see below, area ). Then click on the desired option set, e.g. xrm i8n Goldbright DataGrid (see below, area ). Examples: Name Schema name Description xrm i8n Goldbright Startpage xrm_i8n_goldbright_startpage Contains labels about the environment. - Global Exception handling - Loading process -... Version Rollup 7 or higher 4 / 5

15 xrm i8n Goldbright DataGrid xrm_i8n_goldbright_datagrid Contains labels about the editable data grid. - Toolbar buttons - Data Grid itself...5 Date/Time A date/time value will be displayed based on the value type with just a date or a date with time. The format of the value itself can be configured in the personal options of MS Dynamics CRM. Just click on --> Options - -> Formats. The figure below shows the personal options which defines the format of the value. Version Rollup 7 or higher 5 / 5

16 .3 Adding a hierarchical Global xrm Data Grid to the Sitemap xrm Business Solutions for Microsoft CRM.3. Adding a Hierarchical Global xrm Data Grid To add a global grid, you need the xrm Toolbox, which is available on After opening the program, click on Connect to CRM and then on New connection. Fill out the Connection dialog and click on OK. Important: Select the right organization! Then click on Sitemap Editor and then on Load Sitemap (see below, area ) button. Select the desired area and group (see below, area ). After a right-click (!), choose Add subarea. Fill out the properties. Version Rollup 7 or higher 6 / 5

17 Field Value Remark Id Enter an Id of your choice E.g. TempId_ Pass Params Mark as checked Url Either select a value by clicking on and then add parameters or Type in the URL, beginning with $webresource: In any case, be aware that the & has to be written as %3d and the = has to be written as %. E.g. $webresource:xrm_/web/html/ DataGrid.html?data=SavedQueryId %3df70acf5-b6f4-e4-b e6c9b%6ListType%3dHie rarchical%6linkfromattributena me%3dbusinessunitid%6linktoat tributename%3dparentbusinessuni tid Finally, click on Save and then on Update Sitemap. After a refresh, the grid will be included in the sitemap..3. Configuration of a Hierarchical Global xrm Data Grid.3.. Adding records: Behavior based on listing type The behavior of the xrm Data Grid when adding records is based on the listing type. For the hierarchical listing for a specific root project, the Add sub node -Button is available. For hierarchical listing in a global scope (e.g. Global Gantt), the Add - and Add sub node -Buttons are both available. Add sub-node : When marking a row and clicking on the Add sub-node button, a new form opens where you can enter the respective data. After saving and closing this form and a refresh of the hierarchical grid, the new sub-node will be available under the parent node. However, only data that were entered in the fields of this sub-node form are shown in the grid. Thus, if you like to take content from the parent node in the sub-node, it is necessary to make field mapping, e.g. from project to project. Field mapping example: To take the Project risk content from the parent node to the sub-nodes, mark the line of the parent node and then go to Settings --> Customizations --> Customize the System --> enlarge Entities in the sitemap --> enlarge Project (see below, area ) --> click on :N Relationships (see below, area ) and select itarapro_project_project_referring (see below, area 3). Version Rollup 7 or higher 7 / 5

18 3 Then, click on Mapping (see below, area ) in the sitemap --> then the New button (see below, area ) and afterwards, select e.g. itarapro_risk as the Source Target field as well as the Target Entity Field. Afterwards, click on OK --> Save and close --> Publish all Customizations..3.. Displaying values and formats All common value types are supported to be displayed in the xrm Data Grid and are based on the settings and formats of Microsoft Dynamics CRM. Thus, if you change a value or format in the customizing, this change is also proceeded in xrm Data Grid. Attribute type Description Used control DateTime Will display date or date and time DatePicker Decimal Simple Formatter Version Rollup 7 or higher 8 / 5

19 Double Uses formatter Formatter Integer Uses formatter Formatter BigInt Uses formatter Formatter Money Uses formatter and transaction currency Formatter Memo Simple text String Simple text Lookup Lookup behavior EditableLookup Owner Lookup behavior EditableLookup Uniqueidentifier Lookup behavior EditableLookup Boolean Dropdown list Html select control for option sets State Dropdown list Html select control for option sets Status Dropdown list Html select control for option sets Picklist Dropdown list Html select control for option sets.3..3 Text for multiple languages The displayed texts are either coming from MS Dynamics CRM directly by using a specific view (saved query) or are stored in the xrm Global Option Sets. You will find this at Settings --> Customizations --> Customize the system --> Option Sets (see below, area ). Then click on the desired option set, e.g. xrm i8n Goldbright DataGrid (see below, area ). Examples: Version Rollup 7 or higher 9 / 5

20 Name Schema name Description xrm i8n Goldbright Startpage xrm i8n Goldbright DataGrid xrm_i8n_goldbright_startpage xrm_i8n_goldbright_datagrid Contains labels about the environment. - Global Exception handling - Loading process -... Contains labels about the editable data grid. - Toolbar buttons - Data Grid itself.3..4 Date/Time A date/time value will be displayed based on the value type with just a date or a date with time. The format of the value itself can be configured in the personal options of MS Dynamics CRM. Just click on --> Options - -> Formats. The figure below shows the personal options which defines the format of the value. Version Rollup 7 or higher 0 / 5

21 .4 Adding a flat xrm Data Grid to the Sitemap.4. Adding a Flat Global xrm Data Grid To add a global grid, you need the xrm Toolbox, which is available on After opening the program, click on Connect to CRM and then on New connection. Fill out the Connection dialog and click on OK. Important: Select the right organization! Then click on Sitemap Editor and then on Load Sitemap (see below, area ) button. Select the desired area and group (see below, area ). After a right-click (!), choose Add subarea. Fill out the properties. Version Rollup 7 or higher / 5

22 Field Value Remark Id Enter an Id of your choice E.g. TempId_ Pass Params Mark as checked Url Either select a value by clicking on and then add parameters or Type in the URL, beginning with $webresource: In any case, be aware that the & has to be written as %3d and the = has to be written as % E.g. $webresource:xrm_/web/html/ DataGrid.html?data=SavedQueryId %3df70acf5-b6f4-e4-b e6c9b%6ListType%Flat Finally, click on Save and then on Update Sitemap. After a refresh, the grid will be visible in the sitemap..4. Configuration of a Flat Global xrm Data Grid.4.. Adding records The behavior of the xrm Data Grid when adding records is based on the listing type. For the flat list, the Add -Button is available. When marking a row and clicking on the Add button, a new form opens where you can enter the respective data. After saving and closing this form and a refresh of the flat grid, the new node will be available..4.. Add Button visibility It is possible to hide the Add button. To do this, just add the respective parameter to the sitemap editor URL. Description Parameter name Example Forces the add button to be displayed or hidden IsAddButtonVisible IsAddButtonVisible=false IsAddButtonVisible=true Then, the URL would look like this e.g.: $webresource:xrm_/web/html/datagrid.html?data=savedqueryid%3df70acf5-b6f4-e4-b e6c9b%6listtype%flat%3disaddbuttonvisible=false.4..3 Displaying values and formats All common value types are supported to be displayed in the xrm Data Grid and are based on the settings and formats of Microsoft Dynamics CRM. Thus, if you change a value or format in the customizing, this change is also proceeded in xrm Data Grid. Attribute type Description Used control DateTime Will display date or date and time DatePicker Decimal Simple Formatter Double Uses formatter Formatter Version Rollup 7 or higher / 5

23 Integer Uses formatter Formatter BigInt Uses formatter Formatter Money Uses formatter and transaction currency Formatter Memo Simple text String Simple text Lookup Lookup behavior EditableLookup Owner Lookup behavior EditableLookup Uniqueidentifier Lookup behavior EditableLookup Boolean Dropdown list Html select control for option sets State Dropdown list Html select control for option sets Status Dropdown list Html select control for option sets Picklist Dropdown list Html select control for option sets.4..4 Text for multiple languages The displayed texts are either coming from MS Dynamics CRM directly by using a specific view (saved query) or are stored in the xrm Global Option Sets. You will find this at Settings --> Customizations --> Customize the system --> Option Sets (see below, area ). Then click on the desired option set, e.g. xrm i8n Goldbright DataGrid (see below, area ). Examples: Name Schema name Description Version Rollup 7 or higher 3 / 5

24 xrm i8n Goldbright Startpage xrm i8n Goldbright DataGrid xrm_i8n_goldbright_startpage xrm_i8n_goldbright_datagrid Contains labels about the environment. - Global Exception handling - Loading process -... Contains labels about the editable data grid. - Toolbar buttons - Data Grid itself.4..5 Date/Time A date/time value will be displayed based on the value type with just a date or a date with time. The format of the value itself can be configured in the personal options of MS Dynamics CRM. Just click on --> Options - -> Formats. The figure below shows the personal options which defines the format of the value. Version Rollup 7 or higher 4 / 5

25 3 Further information and Troubleshooting For more information about xrm Business Solutions or advanced configurations (similar to your specific requirements), we recommend taking a look at our standard xrm User Manuals, located on the website: Select the desired product. You will find the related user manual in the Resource Center of the product. If you are still facing problems, please contact our xrm Support. Version Rollup 7 or higher 5 / 5