{"title":"Table 5330 CRM Connection Setup, procedures","url":"https://jonas-paprotka.de/ref/table/5330-crm-connection-setup/procedures/","author":"JOP-AL","license":"Metadata from Microsoft's symbol packages. AL source MIT, Copyright (c) Microsoft Corporation. Selection and wording © 2026 JOP-AL. https://jonas-paprotka.de/licenses/","subject":"Microsoft Dynamics 365 Business Central","checked":"2026-11-20","changed":"2026-10-05","object":{"type":"table","id":5330,"name":"CRM Connection Setup","app":"Base Application","versions":"17-29","url":"https://jonas-paprotka.de/ref/table/5330-crm-connection-setup/","json":"https://jonas-paprotka.de/ref/table/5330-crm-connection-setup.json"},"aspect":"procedures","total":53,"rows":[{"name":"EnsureCDSConnectionIsEnabled","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"LoadConnectionStringElementsFromCDSConnectionSetup","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"DeployCRMSolution","sig":"(Boolean)","named":"(ForceRedeploy: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(ForceRedeploy: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CountCRMJobQueueEntries","sig":"(var Integer, var Integer)","named":"(var ActiveJobs: Integer; var TotalJobs: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(var ActiveJobs: Integer; var TotalJobs: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"HasPassword","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetPassword","sig":"(Text)","named":"(PasswordText: Text)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use SetPassword(PasswordText: SecretText) instead.","tag":"25.0"},"range":"17-27","first":17,"last":27,"obsoleteSince":25,"spans":[{"from":17,"to":24,"named":"(PasswordText: Text)","returns":"","kind":"procedure","access":"public","obsolete":null},{"from":25,"to":27,"named":"(PasswordText: Text)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use SetPassword(PasswordText: SecretText) instead.","tag":"25.0"}}]},{"name":"DeletePassword","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"UpdateAllConnectionRegistrations","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"This functionality is not in use and not supported","tag":"20.0"},"range":"17-22","first":17,"last":22,"obsoleteSince":20,"spans":[{"from":17,"to":19,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null},{"from":20,"to":22,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"This functionality is not in use and not supported","tag":"20.0"}}]},{"name":"UpdateIsEnabledState","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"This functionality is not in use and not supported","tag":"20.0"},"range":"17-22","first":17,"last":22,"obsoleteSince":20,"spans":[{"from":17,"to":19,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null},{"from":20,"to":22,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"This functionality is not in use and not supported","tag":"20.0"}}]},{"name":"RegisterConnection","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"RegisterConnectionWithName","sig":"(Text)","named":"(ConnectionName: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(ConnectionName: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"UnregisterConnection","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"UnregisterConnectionWithName","sig":"(Text)","named":"(ConnectionName: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(ConnectionName: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetConnectionStringWithCredentials","sig":"()","named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the GetSecretConnectionStringWithCredentials procedure instead.","tag":"25.0"},"range":"17-27","first":17,"last":27,"obsoleteSince":25,"spans":[{"from":17,"to":24,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null},{"from":25,"to":27,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the GetSecretConnectionStringWithCredentials procedure instead.","tag":"25.0"}}]},{"name":"RegisterUserConnection","sig":"()","named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use RegisterConnection instead.","tag":"20.0"},"range":"17-22","first":17,"last":22,"obsoleteSince":20,"spans":[{"from":17,"to":19,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null},{"from":20,"to":22,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use RegisterConnection instead.","tag":"20.0"}}]},{"name":"GetIntegrationUserID","sig":"()","named":"()","returns":"Guid","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Guid","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetPassword","sig":"()","named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the procedure GetSecretPassword instead.","tag":"25.0"},"range":"17-27","first":17,"last":27,"obsoleteSince":25,"spans":[{"from":17,"to":24,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null},{"from":25,"to":27,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the procedure GetSecretPassword instead.","tag":"25.0"}}]},{"name":"GetJobQueueEntriesObjectIDToRunFilter","sig":"()","named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"PerformTestConnection","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"VerifyTestConnection","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"TestConnection","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"TestIntegrationUserRequirements","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"TryReadSystemUsers","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsVersionValid","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsCurrentUserMappedToCrmSystemUser","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"This functionality is not in use and not supported","tag":"20.0"},"range":"17-22","first":17,"last":22,"obsoleteSince":20,"spans":[{"from":17,"to":19,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null},{"from":20,"to":22,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"This functionality is not in use and not supported","tag":"20.0"}}]},{"name":"UpdateFromWizard","sig":"(var Record CRM Connection Setup, Text)","named":"(var SourceCRMConnectionSetup: Record \"CRM Connection Setup\"; PasswordText: Text)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the procedure that receives PasswordText as SecretText instead.","tag":"25.0"},"range":"17-27","first":17,"last":27,"obsoleteSince":25,"spans":[{"from":17,"to":24,"named":"(var SourceCRMConnectionSetup: Record \"CRM Connection Setup\"; PasswordText: Text)","returns":"","kind":"procedure","access":"public","obsolete":null},{"from":25,"to":27,"named":"(var SourceCRMConnectionSetup: Record \"CRM Connection Setup\"; PasswordText: Text)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the procedure that receives PasswordText as SecretText instead.","tag":"25.0"}}]},{"name":"EnableCRMConnectionFromWizard","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"RestoreConnection","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetCRMSOPEnabled","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetCRMSOPDisabled","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetCRMSOPEnabledWithCredentials","sig":"(Text[250], Text, Boolean)","named":"(AdminEmail: Text[250]; AdminPassword: Text; SOPIntegrationEnable: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17","first":17,"last":17,"obsoleteSince":null,"spans":[{"from":17,"to":17,"named":"(AdminEmail: Text[250]; AdminPassword: Text; SOPIntegrationEnable: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetUserAsIntegrationUser","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"RefreshDataFromCRM","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":17,"spans":[{"from":17,"to":17,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Function scope will be changed to OnPrem","tag":"15.1"}},{"from":18,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"PerformWebClientUrlReset","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SynchronizeNow","sig":"(Boolean)","named":"(DoFullSynch: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(DoFullSynch: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"PromptForCredentials","sig":"(var Text, var Text)","named":"(var AdminEmail: Text; var AdminPassword: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(var AdminEmail: Text; var AdminPassword: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"DoReadCRMData","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetDefaultCRMConnection","sig":"(Text)","named":"(ConnectionName: Text)","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(ConnectionName: Text)","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"UpdateConnectionString","sig":"()","named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"UpdateCRMJobQueueEntriesStatus","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetConnectionString","sig":"()","named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetConnectionString","sig":"(Text)","named":"(ConnectionString: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(ConnectionString: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsEnabled","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetUseNewestUI","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetCRMSOPEnabledWithCredentials","sig":"(Text, Text, Boolean)","named":"(AdminEmail: Text; AdminPassword: Text; SOPIntegrationEnable: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(AdminEmail: Text; AdminPassword: Text; SOPIntegrationEnable: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"RefreshDataFromCRM","sig":"(Boolean)","named":"(ResetSalesOrderMappingConfiguration: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(ResetSalesOrderMappingConfiguration: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"PromptForCredentials","sig":"(var Text, var Text, var Text)","named":"(var AdminEmail: Text; var AdminPassword: Text; var AdminADDomain: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(var AdminEmail: Text; var AdminPassword: Text; var AdminADDomain: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsBidirectionalSalesOrderIntEnabled","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"21-29","first":21,"last":29,"obsoleteSince":null,"spans":[{"from":21,"to":29,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetProxyVersion","sig":"()","named":"()","returns":"Integer","kind":"procedure","access":"internal","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"()","returns":"Integer","kind":"procedure","access":"internal","obsolete":null}]},{"name":"SetPassword","sig":"(SecretText)","named":"(PasswordText: SecretText)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(PasswordText: SecretText)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetSecretConnectionStringWithCredentials","sig":"()","named":"()","returns":"SecretText","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"()","returns":"SecretText","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetSecretPassword","sig":"()","named":"()","returns":"SecretText","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"()","returns":"SecretText","kind":"procedure","access":"public","obsolete":null}]},{"name":"UpdateFromWizard","sig":"(var Record CRM Connection Setup, SecretText)","named":"(var SourceCRMConnectionSetup: Record \"CRM Connection Setup\"; PasswordText: SecretText)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(var SourceCRMConnectionSetup: Record \"CRM Connection Setup\"; PasswordText: SecretText)","returns":"","kind":"procedure","access":"public","obsolete":null}]}]}