mscrm-addons.com - Blog

IMPORTANT INFORMATION

This blog is deprecated since July 2020.The articles below are no longer maintained and might contain outdated information. 
You can find the most acutal and relevenat information in our Knowledge Base at support.mscrm-addons.com

News.mscrm-addons.com Blog

rss

Hello and welcome to our blog! What can we do for you? Are you looking for further technical information or step-by-step instructions to our products? Or would you like to read the latest news on mscrm-addons? Please feel free to browse our blog for detailed information and to share our posts!


Bäck Martin
Bäck Martin
Bäck Martin's Blog

How to check the existenz or the value of a SettingsKey in MS Dynamics 365

Sometimes you may be asked to check the existenz or the value of a new settingskey for one of our products (e.g. for troubleshooting of issue or when having special configuratinos, etc.). 

How to find a SettingsKey in MS CRM Dynamics 365

    1. Open CRM in your Browser.

    2. Navigate to Settings within the Dynamics365 navigation.
    Dynamics365 navigation

    Figure 1: Dynamics365 Navigation

    3. Within the settings, navigate to MSCRM-ADDONS.com Products in the Extensions-area of the sitemap.
    MSCRM-ADDONS.com Products

    Figure 2: MSCRM-ADDONS.com Products in the CRM settings

    4. Open the product record for which you should check its existenz or its value. This information should be provided as information along with the reference to this article.
    MSCRM-ADDONS.com Products

    Figure 3: List of MSCRM-ADDONS.com Products

    5. The product record contains a list of all settings for this prodcut (see Figure 5). Here you can check 

    MSCRM-ADDONS.com Products

    Figure 5: List of settingskeys-menu

Please note: If a value for a key is changed and the effected product is a client application like DocumentsCorePack or TelephoneIntegration, you need to restart the Client application. Otherwise, the setting will not be applied.

That’s it! We appreciate your feedback! Please share your thoughts by sending an email to support@mscrm-addons.com.


Template Explorer (Dynamics 365)

The DocumentsCorePack Template Explorer is a feature that allows you to easier navigate through your templates while designing and maintaining them. The Template Explorer displays all DocumentsCorePack pack fields in a schematic tree view. This Feature is available in Version 9.37 and higher. 

 

    Figure 1: Template Explorer open on a sample template

The Template Explorer only works on DocumentsCorePack Templates. For merged documents or non DCP templates you will not be able to open the Template Explorer.
You can enable or disable the Template Explorer with the new ribbon button "Template Explorer"   (Figure 2). 

After enabling the Template Explorer a new task pane will appear on the left of your document. The Template Explorer will list all fields that are used in your document in a tree view.

Nested elements or tables will be displayed as sub-nodes of the tree view. An additional context menu allows you to directly interact with the field (Figure 4) and by hovering over the element a tooltip shows information about the field (Figure 4).

    Figure 4: Context menu on the element (left) and tooltipinformation (right)

The context menu allows to directly open field properties, delete a field or context-specific actions like opening subtemplate.

At the bottom of the tree view you have 3 options additional options.  

     Analyze the Template
    This action tries to analyze the template for know issues like unused relationships or invalid table layouts.
    This operation is now performed before each 'save process'. It can be disabled in the Template Explorer Settings. Details ob this feature can be found here

    DocumentsCorePack Settings
    This button opens the standard DocumentsCorePack template settings. 

     Template Explorer Settings 
    The template explorer settings allow you to change single settings of ​this feature. More details can be found here.

That’s it! We appreciate your feedback! Please share your thoughts by sending an email to support@mscrm-addons.com.



Template Explorer Settings (Dynamics 365)

This article describes the settings for the Template Explorer. This feature is part of the DocumentsCorePack Client version 9.37 or higher.

    Figure 1: Template Explorer Settings

      DocumentsCorePack field selection
      Define wich DCP fields you would like to see in the tree view. 

       Word field selection
      Define if you want to see all Word field functions or only conditions. 
      Please Note DCP Conditions are not the same as Word Conditions

      ❸ Analyze Template Before Save
      A template will be analyzed by default before saving. If you do not want this happen you can disable this option.
      Details about the DocumentsCorePack Analyze Template Feature can be found here.

       Jump to Field on Click
      As soon as you click on the field in the tree view you will directly jump to this element in the Document.
      If you don't want to jump to the field directly you can disable this setting. You will be able to jump to the field on demand by using the context menu in the Template Explorer.

    That’s it! We appreciate your feedback! Please share your thoughts by sending an email to support@mscrm-addons.com.


    Analyze Template Feature (Dynamics 365)

    The Analyze Template Option will be executed automatically before you save a template back in your Dynamcis 365 system with the latest version of the DocumentsCorePack Client (9.37 or higher). Additionally it can be executed on demand while designing a template by calling it from theTemplate Explorer window. 
    The warnings are just an information and no actual errors. False positve can occur but can be simply ignored.
    You can turn this feature of by disabling this functionality. How to disable this is describe here: Template Explorer Settings

    Details ab the functionality will be added shortly to this blog article, so please check again in a few days. 


    Template Versioning (Dynamics 365)

    Template Versioning  saves a backup of each template instead of simply overwriting it.
    This feature requires at least version 9.25 of the client and version 2017.184 of the server or service. This functionality is disable by default. If you want to enable the versioning functionality you have to create a new settings key for DocumentsCorePack manually, like described here, with the following name and value:
    Name: EnableTemplateVersioning
    Value: true

    If the setting as described above is enable you will see an additional button (1) int the menu bar. When you select a template and use this button 

      Figure 1: Recover button

    After using the "Recover Template" button a new window will appear with all available versions. The "Created On" column should be used identify the version that you want to recover. The versions are sorted from top to bottom from new to old. 

      Figure 2: Recover Dialog

    Tipp: Use the standard properties for keywords, subject, etc. to store additional information about the performed changes in your templates. 

    Within this dialog you can select a preview version (1) and recover this version by using the "Recover" button. 

      Figure 3: Select und Recover

    After you have chosen to recover a specific file the said file will be opened in Word. 
    The opened file will have the current document name and a current time stamp as name. Nothing was change


      Figure 4: Recovered template

    From this point on it is up to you how to proceed with this  recovered file. Nothing has changed yet in the live template. If you want to go ahead and make the recovered template your new live template you have to overwrite the existing template with this recovered template. 

    PLEASE NOTE:
    - Template versions are not  imported or exported with the DocumentsCorePack import/export functionality. Only the latest live version will be exported. 
    - The limit of versions is set to 25 by default. To decrease or increase this limit you can set a settingskey manually with the name "TemplateVersioninglimit", and the amount of records as value. When setting its value to "0" the limit is disabled and unlimited copies will be stored (not recommended!).

    That’s it! We appreciate your feedback! Please share your thoughts by sending an email to support@mscrm-addons.com.

    Related content:
    Template Preview (Dynamics 365)
    DocumentsCorePack Template Designer - New Features


    Template Preview (Dynamics 365)

    The Template Preview functionality of the DocumentsCorePack Template Designer allows you to see a thumbnail of your templates when opening or saving them.
    This new feature requires at least version 9.25 of the template designer and version 2017.184 of the server or service. 
    The preview section (1) is embedded at the right hand side of the open or save Template Dialog 

      Figure 1: Preview Section

    You can enable or disable the preview you using the magnifier icon in the control menu bar (1).
    By using the "View Detailed Image" (2) you can enlarge the thumbnail to its full size. Additional scrollbars will allow you to view the enlarged image.

      Figure 2: Preview Controls

    There are only preview images available for templates that are saved since the new required version was installed. Any old templates will not have a preview yet. 
    If you completely want to remove this functionality please set the following settings key for DocumentsCorePack manually, like described here, with the below key name and value.
    Name: DisableTemplatePreviewImageUpload
    Value: true

    That’s it! We appreciate your feedback! Please share your thoughts by sending an email to support@mscrm-addons.com

    Related content:
    Template Versioning (Dynamics 365)
    DocumentsCorePack Template Designer - New Features


    Conditional Formatting (Dynamics 365)

    The Conditional Formatting is an additional feature to the Condition functionality of DCP. While the standard Condition functionalty either removes or keeps a field on your document the conditional formatting keeps the current format or applies a different format based on a Word style sheet. The description of the normal condition functionaltiy can be found here.
    This functionality requires version 9.24 or higher of the client and version 2017.169 of the server (or service). 

     
    1. Insert a new Condition Field
      Figure 2: Insert Condition field

      If you are not sure how to get to the insert fields option, please take a look at this article first.

    2. Give your condition a descriptive name
      A descriptive name makes it easy to re-use existing conditions in a template.
    3. Select "Conditional formatting"
      You have to switch the condition type from Conditional block (if statement) to Conditional Formatting (❶)
      Condition field dialogFigure 3: Conditional Formatting

      PLEASE NOTE:  If you do not see this option please ensure you are having the required version installed. How to theck your current version is described here.

    4. Style section
      After you’ve selected the conditional formatting you can use the style section (❶). You only can use custom styles in this selection, so if the dropdow is not enabled you have to create a least a new style as described in the next step. 
      Condition field dialog
      Figure 4: Style selection section 

    5. Create new style
      This will bring up the standard word [Create New Style from Formatting] – dialog. 
      Condition field dialogFigure 5: Create a new style

      The "Create New Style from Formatting" – dialog has a lot of options so please make sure you read the following part very carefully.

       ❶ Name: Please define a name that will indicate what this style is used for. (You can re-use styles for all your conditions) 
       ❷ Style type: This is one of the most important steps during the creation of a Style.
      Within this selection field, you have 5 options to choose from, we support 3 of them. 
      Paragraph: The style will be applied to the whole Paragraph which contains this condition field 
      Character:  The style will be applied to the content within this condition field
      Table: This style type will enable the second selection field [Format – Apply to], where you can decide how it should be applied.
       ❸ Style based on: A base style template can be selected to create the custom style based on an existing style.

      Besides these three settings, you can use all given options to create your desired output style. 
      After you have the wanted style click on [OK] to save it.
       
      PLEASE NOTE:  
      - Do not change the Stylename! We have not option to identify a change of the name and the condition will not longer be able to find the style. 
      - Not all options available in the standard style sheet configuration of Word are applicable, and might be not applied dependend on the used style and the context.

    6. Select your Style
      Since you have created your style, the [Format – Style] selection is now enabled.
      Condition field dialogFigure 6: Select Style

      Choose your style and your conditional formatting field is ready to use.
      Character should be used when you want to apply the format to a single Word in a Paragraph while Paragraph should be used when you want to apply the formatting to the whole word paragraph.
    7. Apply table format
      If your selected style is a table style the "Format – Apply to" field gets enabled. This provides you the possibility to pick one out four ways how your table style should be applied.
      Condition field dialog
      Figure 7: Format - Apply to

      - First Table Inside Field: 
      This option will apply your style to the first table within your condition field.
      - Parent Table: 
      When your condition field is within an table, this option will apply the style to this table.
      - Parent Cell: The selected style will be applied to the cell which contains your condition field.
      - Parent Row: The selected style will be applied to the row which contains your condition field.

    8. Please click on [OK] to insert the condition field
      If you want to know more about the conditional formatting feature, please take a look at this step by step description. Click here

    That’s it! We appreciate your feedback! Please share your thoughts by sending an email to support@mscrm-addons.com.


    Add a Hyperlink to an existing "Picture-Link-Field"

    This article outlines how to add a hyperlink to a insert "Picture-Link-Field”. The result after the merge will be a clickable image in your generated document.
    How to insert a Picture-Link-Field is described in here “Insert”-button

    Image Layout Settings

    Figure 1: Example of a clickable link in Word

    ​1. Open the properties of an inserted picture link field
    Select any picture-link field (1) and hit the "Field properties" button in the ribbon (2). A new window with and additional option so setup a link will be opened (3)

    Image Layout Settings

    Figure 2; Inserted picture link field​ and new edit option

    2. Define a link 
    Based on the DocumentsCorePack Property Syntax you can setup a link (1)  and apply your changes with a click on OK (2)
    Image Layout Settings Figure 3: Example of setup link pattern

    That’s it! We appreciate your feedback! Please share your thoughts by sending an email to support@mscrm-addons.com.

     

     


    Claim a DocumentsCorePack Template Designer (per User) license

    This blog article outlines how you can claim yourself a DocumentsCorePack Template Designer (per User) License.

    If you are using the DocumetnsCorePack Template Designer for DocumentsCorePack ServerBased or when you are using the DocumentsCorePack Client with a per user license you might come across the following message. With version 9.19 or higher of the client you have an additional option to get rid of this message. 

    Image Layout Settings

    Figure 1:"Access Denied" License Message

    The access denied message  indicates that your user does not have a license applied. As long as the per User license count is higher than the system value number 
    you can claim a license to yourself you can use the "Claim License" button  at the bottom right corner. This option is only visible if you actually have a per User lincense. For any other license type this option will not be available. 

    Image Layout Settings  ​Figure 2: License screen with access denied 

    If the claiming process is successfull you will see a message like below.  ❶ 
    In case the claim attempt fails you will receive an error message. The message will contain details of what failed. 

    Image Layout SettingsFigure 3: Confirmation message after sucessfull claim process

    After that you will see an update license screen with the latest numbers update. 
    To proceed simply click "Close" to end this dialog. ​

    Image Layout Settings

    ​ ​Figure 4: Updated license screen

    PLEASE NOTE: If you do not have this option or if you are not sure if you should claim yourself a license please get in touch with your CRM Administrator.

     That’s it! We appreciate your feedback! Please share your thoughts by sending an email to support@mscrm-addons.com.

     



    Step-by-Step: How to set up User-Prompts

    This blog article covers a Step-by-Step example on how to set up user-prompts in DocumentsCorePack Template Designer. 

    Prompts enable the user to add or modify document elements without opening the document. The additional options for prompts are displayed in an additional window of the DocumentsCorePack dialog. 


    Figure 1: Prompts within the DCP Dialog

    The following steps contain a description of how to set up such prompts in your templates. 

    Step 1: Create a Prompt
    A prompt is defined in a template within the advanced template settings. To access the prompts settings navigate to ❶ "Insert MailMerge Fields" to open the DocumentsCorePack Taskpane. Go to ❷ "Advanced Template Settings" and select  "Prompts".


    Figure 2: MSCRM-ADDONS.com AutoMergeWorkingItems properties

    The Prompts-Editor allows you to ❶ create, ❷ edit and ❸ delete prompts. Also, the ❹ sort order of how the prompts should appear can be modified as well. 


    Figure 3: Prompt Editor

    Step 2: Add a prompt 
    You can add a prompts by using the add button. Each prompt requires a name (special certain chars are not allowed).


    Figure 4: Add Prompt 

    There are 3 different types of different prompts that you can select: 

    •  Text (as single or multiline)
        A text allows the user to enter additional text in the DCP dialog that will be added to the generated document.
        A text prompt can be a simple single line of text or also a text box by using the allow line breaks option. 
        By setting the required checkbox you can define if a user has to enter data.

    • Checkbox
        A checkbox prompt enables you to either add or remove optional content in the document. 
        A checkbox is by default mandatory. 

    • Select
        A select prompt enables you to keep only one specific section, out of several setup blocks in the document. 

      

    Each prompt also requires at least one label. A label is a text that is displayed in the DocumentsCorePack Dialog in front of the actual control (see Figure 1). If a label for the current user language in Dynamics 365 is set this translation will be displayed. If there is no label that matches the current user's language, the first one in the list is displayed. 


    Figure 5: Label

    After you have set up the prompts in the settings, you are able to insert them into your document. 

    Step 3: Insert a prompt in your document
    You will find an additional selection in the "Insert Field" -> "Computed Item" -> ❶ "Prompt Field". Each entry represents a prompt that you have created previously. 



     Figure 6: Insert prompt


    A ❶ text box does not require any further septs as it will be replaced with the text entered by the user. For prompts of the type ❷ checkbox and ❸ select, you will have to replace the current placeholder text with your desired content.


     Figure 7: Template before and after replacement of placeholders

    Step 4: Save your template
    Before you can use or test your template you have to save it. Use the Save template-option of the DocumentsCorePack client in order to publish the template to Dynamics 365. 

    Please Note: Prompts do not work with the Template Designer, only by using the DocumentsCorePack Server Dialog  ("Create Document").

    That’s it! We appreciate your feedback! Please share your thoughts by sending an email to support@mscrm-addons.com.