OrgDBOrgSettings tool for Microsoft Dynamics CRM 2011

Article ID: 2691237 - View products that this article applies to.
Expand all | Collapse all

Symptoms

Microsoft Dynamics CRM 2011 provides the OrgDBOrgSettings tool that gives administrators the ability to implement specific updates that were previously reserved for registry implementations. This article discusses the steps to extract the tool and update the settings.

Resolution

To use the OrgDBOrgSettings Tool, follow these steps:

  1. Obtain the latest build of the OrgDBOrgSettings tool. The tool is updated with each Update Rollup release, and can be downloaded from the Microsoft Download Center. The latest Update Rollup information and links to the Microsoft Download Center can be found in the following Microsoft website:
    Microsoft Dynamics CRM 2011 updates and hotfixes
    Note To use the OrgDBOrgSettingsTool on a Windows client, you have to install Windows Identity Foundation 3.5.
  2. When you download CRM2011-Tools-KB#######-ENU-amd64.exe, extract the files to any folder location, such as to the C:\OrgDBSettingsTool folder.
  3. Open the OrgDBOrgSettingsTool folder.
  4. Open the OrgDBOrgSettingsTool.exe.config file for editing.
  5. Update the URLs to relate to your environment (see the samples for Online or OnPremise configuration file in the more information section) and save the changes.
  6. Open a command prompt.
  7. Run the following command and locate the OrgDbOrgSettings folder:
    Cd C:\OrgDbOrgSettings
  8. You can use the following syntax to either retrieve or update the current settings:

    To update
    Microsoft.Crm.SE.OrgDBOrgSettingsTool.exe Update [/u] <OrgName> <SettingName> <Value>
    To retrieve
    Microsoft.Crm.SE.OrgDbOrgSettingsTool.exe Retrieve [/u]<OrgName>
    Note the /u symbol specifies that <Orgname> is the unique name. Without this option, <OrgName> is assumed to be the friendlyname.

    The options available to be retrieved or updated are as follows:
    Collapse this tableExpand this table
    Option NameDefault ValueTypeDescription
    ActivityConvertDlgCampaignUncheckedTrueBooleanControls the default value of the Record Closed Campaign Response option. When you convert an activity to an opportunity, this default option controls whether the source campaign is set or not.

    False- Record Closed Campaign Response checked and source campaign will be set.

    True - Record Closed Campaign Response not checked and source campaign is not set.
    ActivateAdditionalRefreshOfWorkflowConditionsFalseBooleanEnables an additional refresh of workflows that contain wait conditions and that may have to be resumed. This is required to be enabled to enable a fix that was originally released as a Critical On Demand hotfix, and was publically released starting with Update Rollup 13. When events in a Wait Until condition are met, the condition is not triggered as documented in KB 2918320.
    AddressBookMaterializedViewsEnabledFalseBoolean
    AutoCreateContactOnPromoteTrueBooleanDisables the ability of the organization to create contact records automatically when an email message is tracked in CRM. This option can also be disabled from the user settings area for each user.

    False - Disables the automatic creation of contacts.

    True - Enables the autoatic creation of contacts.
    BackgroundSendBatchSize10IntSets the number of email messages to download in one batch for the BackgroundSend API.
    ChangeDoubleQuoteToSingleQuoteFalseBooleanChanges double quotation marks to single quotation marks within KB articles when the article is viewed.
    ClientDisableTrackingForReplyForwardEmailsFalseBooleanEnables a user not to automatically track replies and forwarded email messages. Set this to "True" to disable tracking replies and forwarded email messages. 
    ClientUEIPDisabledFalseBooleanDisables the sending of customer experience feedback for the organization. This option can also be disabled from the user settings area for each user.

    False - Enables the sending of experience feedback.

    True - Disables the sending of experience feedback.
    DisableImplicitSharingOfCommunicationActivitiesFalseBooleanChanging this to "True" will disable implicit sharing of records to recipients that are added to existing activities.
    DisableInactiveRecordFilterForMailMergeFalseBooleanWhen you perform a mail merge, inactive records are not included. This option lets you override that functionality.

    False - Inactive records will not be included in the mail merge.

    True - Inactive records will be included in the mail merge.
    DisableMapiCachingFalseBooleanWhen this value is set to "True," users can still pin the views. However, the query is sent to the CRM Server to retrieve the results instead of to the local cache to prevent performance issues.  

    Note This value is not valid with CRM 2013.
    DisableSmartMatchingFalseBooleanDisables the smart matching functionality and relies on the tracking token on the incoming e-mails for email tracking.

    False - Enables smart matching.

    True - Disables smart matching.
    DoNotIgnoreInternalEmailToQueuesFalseBooleanIf you disable the "Track email sent between CRM users as two activities" setting, email messages from a CRM user to a queue are not delivered. Additionally, if a workflow rule sends an email message to a queue, email messages that are sent by the workflow rule are not delivered.

    False - Internal email messages to queues will not be delivered.

    True - Internal email messages to queues will be delivered.
    EnableQuickFindOptimization1IntFor more information, see the "Optimizing the Performance of Quick Find Queries" section in the Optimizing and Maintaining the Performance of a Dynamics CRM 2011 Server Infrastructure.
    EnableRetrieveMultipleOptimization1IntFor more information, see the "Optimizing the Performance of Queries against Large Datasets section" in the Optimizing and Maintaining the Performance of a Dynamics CRM 2011 Server Infrastructure.
    EnableReLinkingToExistingCRMRecord0IntEnables a user to re-track contact records.
    GrantSharedAccessForMergeToSubordinateOwner TrueBooleanTo turn this setting off, this must be set to false. Records are shared with inherited access to subordinate owners during merge. This will not occur when set to false.
    IdsCountBeforeUsingJoinsForSecurity1000IntNot documented in optimization paper.
    IdsCountForUsingGuidStringsForSecurity20IntNot documented in optimization paper.
    JumpBarAlphabetOverridenullStringHow to customize the Alphabet Bar for the CRM Application Grids for Microsoft Dynamics CRM 4.0
    JumpBarNumberIndicatorOverridenullStringHow to customize the Alphabet Bar for the CRM Application Grids for Microsoft Dynamics CRM 4.0
    LookupNameMatchesDuringImportFalseBooleanImporting a solution that was created from an upgraded 4.0 deployment fails. Changing this setting makes the import solution look up the names for forms, views, workflows and security roles.
    OverrideTrackInCrmBehaviour0IntWhen this option is Enabled, the "Track in CRM" button functions as the Set Regarding button.

    0 - Normal behavior of the "Track in CRM" button not having to set a Regarding record. 

    1 - The "Track in CRM" button functions as the "Set Regarding" button, and makes you select a regarding record.
    OverrideV5SenderConflictResolutionFalseBooleanWhen multiple records with the same email address exist in the Dynamics CRM Organization and email is automatically tracked, the email address is resolved to the record that was created first. This option lets you override that functionality.

    False - E-mails are tracked to the first record created.

    True - E-mails are not tracked automatically if there are multiple records with the same email address.
    RecordCountLimitToSwitchToCteSecuritySql75000IntFor more information see the Optimizing the Performance of Queries against Large Datasets" section in the Optimizing and Maintaining the Performance of a Dynamics CRM 2011 Server Infrastructure.
    RetrieveMultipleSharingCountThreshold1000IntFor more information, see the "Optimizing the Performance of Queries against Large Datasets section" in the Optimizing and Maintaining the Performance of a Dynamics CRM 2011 Server Infrastructure.
    SendEmailSynchronously0IntIf you have a plugin registered on the email send flow, you should change this setting to "1." 

    0 - Email is sent asynchronously.

    1 - Email is sent synchronously.
    SetRegardingLookupDefaultEntityTypenullStringChanges default entity for Regarding Lookup Dialog.
    SharingLimitForPOASnapshotTable10IntNot documented in optimization paper.
    SkipGettingRecordCountForPagingFalseBooleanDisables the record count query. This query is responsible for retreiving the total number of records returned for each view. This query can cause longer search times and may cause SQL timeouts or exceptions.

    False - Enables record depend on views.

    True - Disables record depend on views.
    SkipSuffixOnKBArticlesFalseBooleanDisables the suffix from being used on the automatically generated KB article numbers.

    False - Enables the suffix on KB articles.

    True - Disables the suffix on KB articles.
    UsePlainTextForEmailTemplateBodyFalseBooleanChanges the Email Template to use plain text where otherwise text with the following symbols would not appear <text>.
    VerboseErrorsOnPromoteToCRM0IntEnables verbose user error messaging when tracking items from Outlook to Dynamics CRM. By default, some error messages during the tracking are suppressed from being shown to the end-user, and this setting enables those errors to be shown.

    0 - Disables the verbose errors.

    1 - Enables the verbose errors.
    IntegratedAuthenticationMethod nullStringChanges the request sent to the ADFS server. This changes the authentication when users access the org by using the context https://internal.domain.com/org.
    Integrated - urn:federation:authentication:windows
    Forms - urn:oasis:names:tc:SAML:1.0:am:password
    IfdAuthenticationMethod nullStringChanges the request sent to the ADFS server. This changes the authentication when users access the org by using the context https://org.domain.com.
    Integrated - urn:federation:authentication:windows
    Forms - urn:oasis:names:tc:SAML:1.0:am:password

More information

An example on a onPremise configuration file:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <configSections>
        <sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" >
            <section name="OrgDBOrgSettingsTool.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
        </sectionGroup>
    </configSections>
    <applicationSettings>
        <OrgDBOrgSettingsTool.Properties.Settings>
            <setting name="OrgDBOrgSettingsTool_CrmService_CrmService" serializeAs="String">
              <!--- Please change CrmServer to your Crm Server Name -->
                <value>http://CRMServer:5555/MSCrmServices/2007/CrmService.asmx</value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_CrmDiscoveryService_CrmDiscoveryService"
                serializeAs="String">
              <!--- Please change CrmServer to your Crm Server Name -->
                <value>http://CRMServer:5555/XrmServices/2011/Discovery.svc</value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_SKU" serializeAs="String">
              <!--- Possible values here are Online/SPLA/OnPrem -->
                <value>OnPrem</value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_UserName" serializeAs="String">
              <!--- Please change the value below to your email Id/User Name for Online / SPLA -->
                <value>administrator</value>
            </setting>
          <setting name="OrgDBOrgSettingsTool_Domain" serializeAs="String">
            <value>CONTOSO</value>
          </setting>
          <setting name="OrgDBOrgSettingsTool_OrgServiceUri" serializeAs="String">
            <value>http://CRMServer:5555/{0}/XrmServices/2011/Organization.svc</value>
          </setting>
          <setting name="OrgDBOrgSettingsTool_RegistrationEndPointUri" serializeAs="String">
            <value></value>
          </setting>
            <setting name="OrgDBOrgSettingsTool_Partner" serializeAs="String">
              <!--- This is applicable only for Online -->
                <value></value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_Environment" serializeAs="String">
              <!--- This is applicable only for Online -->
                <value></value>
            </setting>
        </OrgDBOrgSettingsTool.Properties.Settings>
    </applicationSettings>
</configuration>
An example on a onPremise IFD configuration file:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <configSections>
        <sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" >
            <section name="OrgDBOrgSettingsTool.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
        </sectionGroup>
    </configSections>
    <applicationSettings>
<OrgDBOrgSettingsTool.Properties.Settings>
            <setting name="OrgDBOrgSettingsTool_CrmService_CrmService" serializeAs="String">
              <!--- Please change CrmServer to your Crm Server Name -->
               <value>https://org.domain.com:port/MSCrmServices/2007/CrmService.asmx</value>
            </setting>
           <setting name="OrgDBOrgSettingsTool_CrmDiscoveryService_CrmDiscoveryService"
                serializeAs="String">
              <!--- Please change CrmServer to your Crm Server Name -->
                <value>https://dev.domain.com:port/XrmServices/2011/Discovery.svc</value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_SKU" serializeAs="String">
              <!--- Possible values here are Online/SPLA/OnPrem -->
                <value>Online</value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_UserName" serializeAs="String">
              <!--- Please change the value below to your email Id/User Name for Online / SPLA -->
                <value>crmadministrator@domain.com</value>
            </setting>
          <setting name="OrgDBOrgSettingsTool_Domain" serializeAs="String">
            <value>domain.com</value>
          </setting>
          <setting name="OrgDBOrgSettingsTool_OrgServiceUri" serializeAs="String">
            <value>https://org.domain.com:port/XrmServices/2011/Organization.svc</value>
          </setting>
          <setting name="OrgDBOrgSettingsTool_RegistrationEndPointUri" serializeAs="String">
            <value>https://login.live.com/ppsecure/DeviceAddCredential.srf</value>
          </setting>
            <setting name="OrgDBOrgSettingsTool_Partner" serializeAs="String">
              <!--- This is applicable only for Online -->
                <value>Crm.Dynamics.com</value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_Environment" serializeAs="String">
              <!--- This is applicable only for Online -->
                <value>INT</value>
            </setting>
        </OrgDBOrgSettingsTool.Properties.Settings>
    </applicationSettings>
</configuration>


An example of a CRM Online configuration file:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" >
      <section name="OrgDBOrgSettingsTool.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
    </sectionGroup>
  </configSections>
  <applicationSettings>
    <OrgDBOrgSettingsTool.Properties.Settings>
      <setting name="OrgDBOrgSettingsTool_CrmService_CrmService" serializeAs="String">
        <!--- Please change CrmServer to your Crm Server Name (OnPremise)-->
        <value>http://CRMserver:PORT/MSCrmServices/2007/CrmService.asmx</value>
      </setting>
      <setting name="OrgDBOrgSettingsTool_CrmDiscoveryService_CrmDiscoveryService"
          serializeAs="String">
        <!--- Please change CrmServer to your Crm Server Name OnPremise-->
        <value>https://dev.crm.dynamics.com/XrmServices/2011/Discovery.svc</value>
      </setting>
      <setting name="OrgDBOrgSettingsTool_SKU" serializeAs="String">
        <!--- Possible values here are Online/SPLA/OnPrem -->
        <value>Online</value>
      </setting>
      <setting name="OrgDBOrgSettingsTool_UserName" serializeAs="String">
        <!--- Please change the value below to your email Id/User Name for Online / SPLA -->
        <value>user1@live.com</value>
      </setting>
      <setting name="OrgDBOrgSettingsTool_Domain" serializeAs="String">
        <value>DOMAIN</value>
      </setting>
      <setting name="OrgDBOrgSettingsTool_OrgServiceUri" serializeAs="String">
        <!--- Please change crmsupport to your Crm Organization Name Online-->
        <value>https://crmsupport.api.crm.dynamics.com/XrmServices/2011/Organization.svc</value>
      </setting>
      <setting name="OrgDBOrgSettingsTool_RegistrationEndPointUri" serializeAs="String">
        <value>https://login.live.com/ppsecure/DeviceAddCredential.srf</value>
      </setting>
      <setting name="OrgDBOrgSettingsTool_Partner" serializeAs="String">
        <!--- This is applicable only for Online -->
        <value>Crm.Dynamics.com</value>
      </setting>
      <setting name="OrgDBOrgSettingsTool_Environment" serializeAs="String">
        <!--- This is applicable only for Online -->
        <value></value>
      </setting>
    </OrgDBOrgSettingsTool.Properties.Settings>
  </applicationSettings>
</configuration>

An example of a CRM Online with Office 365 configuration file:


<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <configSections>
        <sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" >
            <section name="OrgDBOrgSettingsTool.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" />
        </sectionGroup>
    </configSections>
    <applicationSettings>
        <OrgDBOrgSettingsTool.Properties.Settings>
            <setting name="OrgDBOrgSettingsTool_CrmService_CrmService" serializeAs="String">
              <!--- Please change CrmServer to your Crm Server Name -->
                <value>http://CrmServer/MSCrmServices/2007/CrmService.asmx</value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_CrmDiscoveryService_CrmDiscoveryService"
                serializeAs="String">
                <value>https://disco.crm.dynamics.com/XrmServices/2011/Discovery.svc</value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_SKU" serializeAs="String">
              <!--- Possible values here are Online/Office365/SPLA/OnPrem -->
                <value>Office365</value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_UserName" serializeAs="String">
              <!--- Please change the value below to your email Id/User Name for Online / SPLA -->
                <value>myemailid@hotmail.com</value>
            </setting>
          <setting name="OrgDBOrgSettingsTool_Domain" serializeAs="String">
            <value>crmdom</value>
          </setting>
          <setting name="OrgDBOrgSettingsTool_OrgServiceUri" serializeAs="String">
            <value>https://{0}.crm.dynamics.com/XrmServices/2011/Organization.svc</value>
          </setting>
          <setting name="OrgDBOrgSettingsTool_RegistrationEndPointUri" serializeAs="String">
            <value>https://login.live.com/ppsecure/DeviceAddCredential.srf</value>
          </setting>
            <setting name="OrgDBOrgSettingsTool_Partner" serializeAs="String">
              <!--- This is applicable only for Online -->
                <value>Crm.Dynamics.com</value>
            </setting>
            <setting name="OrgDBOrgSettingsTool_Environment" serializeAs="String">
              <!--- This is applicable only for Online -->
                <value></value>
            </setting>
        </OrgDBOrgSettingsTool.Properties.Settings>
    </applicationSettings>
</configuration>

Properties

Article ID: 2691237 - Last Review: March 18, 2014 - Revision: 25.0
Applies to
  • Microsoft Dynamics CRM 2011
Keywords: 
kbqfe kbmbsmigrate kbexpertiseinter kbsurveynew kbhowto KB2691237

Give Feedback

 

Contact us for more help

Contact us for more help
Connect with Answer Desk for expert help.
Get more support from smallbusiness.support.microsoft.com