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 which allows administrators the ability to implement specific updates that were previously reserved for registry implementations. This article will discuss the steps to extract the tool and update the settings.

Resolution

To use the OrgDBOrgSettings Tool, follow these steps:

  1. Obtain latest build of the OrgDBOrgSettings tool. The tool is updated with each Update Rollup release and can be downloaded from the Microsoft download site. The latest Update Rollup information and links to the Microsoft download site can be found here: http://support.microsoft.com/kb/2555051. ** Note: To use the OrgDBOrgSettingsTool on a Windows client, Windows Identity Foundation 3.5 will need to be installed.
  2. Once you have obtained the latest Update Rollup download page download the CRM2011-Tools-KB#######-ENU-amd64.exeand extract the CRM2011 Tools to any folder location. Example: C:\OrgDBSettingsTool
  3. Open the OrgDBOrgSettingsTool folder.
  4. Open the OrgDBOrgSettingsTool.exe.config file for editing.
  5. Update the URLs to relate to your environment. (see attached samples for Online/OnPremise examples) and save the changes.
  6. Open a command line prompt.
  7. Navigate to the OrgDbOrgSettings folder.
    Cd C:\OrgDbOrgSettings
  8. You have the option either retrieve the current settings, or update the settings.
    The syntax to retrieve the results will appear as follows:
    Usage:
    ToUpdate: Microsoft.Crm.SE.OrgDBOrgSettingsTool.exe Update [/u] <OrgName> <SettingName> <Value>
    To Retrieve: Microsoft.Crm.SE.OrgDbOrgSettingsTool.exe Retrieve [/u]<OrgName> 
    /u Specifies that <Orgname> is the unique name. Without this option <OrgName> is assumed to be the friendlyname.
  9. The options available to be retrieved or updated are: 
    Collapse this tableExpand this table
    Option NameDefault ValueTypeDescription
    ActivityConvertDlgCampaignUncheckedTrueBooleanControls the default value of the Record Closed Campaign Response option. When converting 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.
    AutoCreateContactOnPromoteTrueBooleanDisables the ability for the entire organization to create contact records automatically when an email is tracked in CRM. This option can also be disabled from the user settings area for each user.
    False - Disables the auto creation of contacts.
    True - Enables the auto creation of contacts.
    BackgroundSendBatchFile10Int
    ClientUEIPDisableFalseBooleanDisables 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.
    True - Disables the sending.
    DisableInactiveRecordFilterForMailMergeFalseBooleanWhen performing a mail merge inactive records are not included in the mail merge. This option allows you to override that functionality.
    False - Inactive records will not be included in the mail merge.
    True - Inactive records will be included in the mail merge.
    DisableSmartMatchingFalseBooleanDisables the smart matching functionality and relies on the tracking token on the incoming e-mails for e-mail tracking.
    False - Enables smart matching
    True - Disables smart matching
    DoNotIgnoreInternalEmailToQueuesFalseBooleanIf you disable the "Track e-mail sent between CRM users as two activities" setting, e-mail messages from a CRM user to a queue are not delivered. Additionally, if a workflow rule sends an e-mail message to a queue, e-mail messages that are sent by the workflow rule are not delivered.
    False - Internal e-mail messages to queues will not be delivered.
    True - Internal e-mail 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
    IdsCountBeforeUsingJoinsForSecurity1000Intnot documented in optimization paper
    IdsCountForUsingGuidStringsForSecurity20Intnot documented in optimization paper
    JumpBarAlphabetOverridenullStringKB 2494984
    JumpBarNumberIndicatorOverridenullStringKB 2494984
    LookupNameMatchesDuringImportFalseBooleanImporting a solution that was created from an upgraded 4.0 deployment fails. Changing this setting makes the import look up the names for forms, views, workflows and security roles.
    OverrideTrackInCrmBehaviour0IntWhen this option is Enabled the Track in CRM button will function like the Set Regarding button.
    0 - Normal behavior of the Track in CRM button not having to set a Regarding record.
    1 - Track in CRM will function like the Set Regarding and make you choose a regarding record.
    OverrideV5SenderConflictResolutionFalseBooleanWhen multiple records with the same e-mail address exist in the Dynamics CRM Organization and e-mail is auto tracked the e-mail is resolved to the record that was created first. This option allows you to 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 e-mail address.
    RecordCountLimitToSwitchToCteSecuritySql75000Intor 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 e-mail send flow you will want to update this setting to 1.
    0 - E-mail is sent asynchronously
    1 - E-mail is sent synchronously
    SetRegardingLookupDefaultEntityTypenullStringChange default entity for Regarding Lookup Dialog
    SharingLimitForPOASnapshotTable10Intnot documented in optimization paper
    SkipGettingRecordCountForPagingFalseBooleanDisables the record count query. This query is responsible for getting the total number of records returned for each view. This query can cause longer search times and may lead to SQL timeouts or Exceptions.
    False - Enables record count on views.
    True - Disables record count on views.
    SkipSuffixOnKBArticlesFalseBooleanDisables the suffix from being used on the auto generated KB article numbers.
    False - Enables the suffix on KB articles.
    True - Disables the suffix on KB articles.
    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 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 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>

Note This is a "FAST PUBLISH" article created directly from within the Microsoft support organization. The information contained herein is provided as-is in response to emerging issues. As a result of the speed in making it available, the materials may include typographical errors and may be revised at any time without notice. See Terms of Use for other considerations.

Properties

Article ID: 2691237 - Last Review: April 19, 2013 - Revision: 17.0
Applies to
  • Microsoft Dynamics CRM 2011
Keywords: 
kbmbsmigrate kbsurveynew KB2691237

Give Feedback