Follow

Service Configurations List and Creation (Cobalt Staff)

Service Configurations (service configs) are CRM records used to establish connections to other services. Service Configurations are associated with an organization's Settings record. When creating Web Element and SSO configurations, first navigate to the association's settings record to confirm what service configs they have. Often, external web developers will begin asking for configuration changes without knowing what already exists and how they need to be changed to accommodate additions. You should confirm what services an association is using (Clareity, WordPress, Higher Logic, etc) and if the current service configs no longer serve a purpose or if you must account for them in your new configuration.

To create one:

1) Navigate to the Settings record

2) Open the Associated records dropdown. You should see a link to the integration Services view and to the SSO Services view.  Select one of them (all ge/SSO Service Configs should be present in both views).

 

3) Click Add new Service Configuration in the toolbar

4) In the newly opened record, add the appropriate values for Assembly Name and Class Name then Save. Appropriate values can be seen below under Service Configuration Library. if the Integration Settings and SSO Settings fields do not auto-populate with the lookup to the Settings record, add them yourself.

 

5) In the now saved Service Config, click the + Icon in the upper right-hand corner of the Service Configuration Properties sub-grid to create a Service Configuration Property. Add all of the necessary values and Save. Repeat this process for each of the needed Service Configs.

Service Configuration Library

Below is a list of all known Service Configurations used by Cobalt as well as their usual Service Configuration Properties:

 

Widget Site Service - This Service Configuration (Service Config) defines the widget site and is needed in order make use of Web Elements

Assembly Name- Cobalt.Components.Crm.Integration

Class name - Cobalt.Components.Crm.Integration.WidgetSiteConfigurationService

Service Configuration Properties

1. Enabled

Name - Enabled

Type - System.Boolean

Value - True

Encrypt value - No

2. GenericWidgetUrlFormat

Name - GenericWidgetUrlFormat

Type - System.String

Value - The URL of the page where the association has embedded the Login Web Element*

*This Value requires this suffix: ?cobaltsrc={0} (i.e. https://garealtor.com/portal?cobaltsrc={0} )

Encrypt value - No

3. HomePageUrl

Name - HomePageUrl

Type - System.String

Value - The association websites Homepage URL

Encrypt value - No

4. LoginUrlFormat

Name - LoginUrlFormat

Type - System.String

Value - The URL of the page where the association has embedded the Login Web Element*

*This Value requires this suffix: ?cobaltsrc={0} (i.e. https://garealtor.com/portal?cobaltsrc={0} )

Encrypt value - No

5. LogoutRedirectUrlFormat

Name - LogoutRedirectUrlFormat

Type - System.String

Value - The URL where members are redirected on Logout form the Web Elements. This is often the Homepage or the Login page

Encrypt value - No

6. SiteRootUrl (This is ONLY required if using the MiniOrange Plugin)

Name - SiteRootUrl

Type - System.String

Value -  The association websites Homepage URL

Encrypt value - No

7. LoginRedirectUrlFormat (This is ONLY required if using the MiniOrange Plugin)

Name - LoginRedirectUrlFormat

Type - System.String

Value - URL to redirect the user after login. This is usually the CMS/LMS login page (i.e. https://newsite.garealtor.com/wp-login.php)

Encrypt value - No

 

API Service   - This Service Config is needed if the client is using our API to pull information, for instance, if they're using Sitefinity as their CMS

Assembly Name- Cobalt.Components.Crm.Integration

Class name - Cobalt.Components.Crm.Integration.ApiService

Service Configuration Properties

1. SecurityKey

Name - SecurityKey

Type - System.String

Value - The API Security key for that association*

Encrypt value - Yes*

*Create an unencrypted value and copy that value into the Value field while the Encrypt Value field is set to No. Save the record and then set the Encrypt Value field to Yes and Save again to encrypt the value.

SAML Identity Provider Service - This Service Config is needed to establish Dynamics as the SAML Identity Provider (Do not use this if integrating with Clareity)

Assembly Name- Cobalt.Components.Common.Web

Class name - Cobalt.Components.Common.Web.Authentication.SAMLIdentityProviderService

Service Configuration Properties

1. ClientAssertionConsumerUrl

Name - ClientAssertionConsumerUrl

Type - System.String

Value - Provided by SAML Plugin

Encrypt value - No

2. ClientCertificateFile

Name - ClientCertificateFile

Type - System.String

Value - Provided by SAML Plugin. Open the metadata file or link received and copy the Certificate value (string of letters, numbers and symbols) into this field.

Encrypt value - No

3. ClientCertificatePassword

Name - ClientCertificatePassword

Type - System.String

Value - Leave this blank (unless specified)

Encrypt value - No

4. ClientId

Name - ClientId

Type - System.String

Value - Leave this blank (unless specified)

Encrypt value - No

5. ClientLogoutUrl

Name - ClientLogoutUrl

Type - System.String

Value - Provided by SAML Plugin

Encrypt value - No

6. Enabled

Name - Enabled

Type - System.Boolean

Value - True

Encrypt value - No

7. ServerCertificateFile

Name - ServerCertificateFile

Type - System.String

Value - MIIDATCCAemgAwIBAgIQdPDr/iI1jbhDMTj5VYya+TANBgkqhkiG9w0BAQsFADAW MRQwEgYDVQQDEwt3d3cuaWRwLmNvbTAeFw0xMzExMjIwODIwNTJaFw00OTEyMzEx NDAwMDBaMBYxFDASBgNVBAMTC3d3dy5pZHAuY29tMIIBIjANBgkqhkiG9w0BAQEF AAOCAQ8AMIIBCgKCAQEAi0XJRLDrcbSyqUd8XG4BgxObQMYLAkENlmJOsAEpl1xM abUiq1X4v0Fc8ZaCpUE3fFGENMEWgBjnQUUE0WtVUh5JPMsukolf9qljbJkCkvHX H3O4Uen7vA2oNQWt4bK96SpXADpZKFvpk4D7btKOgU/NamjiqwHI4fI8kFJKwKBJ chRPUQdC4ljRRmGIrSnpY+t25/d3KGXwbe9Z2MGGy2hyA0tgOWuchIK+1vAKKBUh 9nDEXfr80+xW680w5TqHyDcqbWvQsXXhH0yZLfINKNS6/IojHPsBy7tf36Ck9H5P w+1PPu6NzBFSz5ZkC8KzrS6vuZXc/ImYrnheMQsqqQIDAQABo0swSTBHBgNVHQEE QDA+gBD4dY4MCPEmG4sxZrcni8vtoRgwFjEUMBIGA1UEAxMLd3d3LmlkcC5jb22C EHTw6/4iNY24QzE4+VWMmvkwDQYJKoZIhvcNAQELBQADggEBABhak2aR84MCdyXO 4AKOQvZybsCMdhRq2i1i0WhD4/xe7Ry5haC6TeXIp8Q4cC3MzsrDal74xHI714BW 0loafpHAsXfd9EvkKTVaJ+1Zpe16+SsTL4upS1cGydigqwUzsdpGck4wI1moJ947 7O+46If2gF27u9Cdk7Onxe/5dwLIxWmkVRdbQIH5GsKUeAjOdRQmy+X1MX6KyRoa CwWGYwxi5Sa+r+3AtDvD4BX0EJGKFZeeM3J/yMpYh/75aN0cFQfDEdJ7C5NE0von idE0QtIFvsoWtZUtur2fiW7yBxse38TPQsi2r6A6c/TZsZ5bq31yh3gr3kSN62H8 iVKLQLA=

Encrypt value - No

8. ServerCertificatePassword

Name - ServerCertificatePassword

Type - System.String

Value - password

Encrypt value - No

9. ServerCertificatePrivateKey

Name - ServerCertificatePrivateKey

Type - System.String

Value - MIIEpAIBAAKCAQEAi0XJRLDrcbSyqUd8XG4BgxObQMYLAkENlmJOsAEpl1xMabUi q1X4v0Fc8ZaCpUE3fFGENMEWgBjnQUUE0WtVUh5JPMsukolf9qljbJkCkvHXH3O4 Uen7vA2oNQWt4bK96SpXADpZKFvpk4D7btKOgU/NamjiqwHI4fI8kFJKwKBJchRP UQdC4ljRRmGIrSnpY+t25/d3KGXwbe9Z2MGGy2hyA0tgOWuchIK+1vAKKBUh9nDE Xfr80+xW680w5TqHyDcqbWvQsXXhH0yZLfINKNS6/IojHPsBy7tf36Ck9H5Pw+1P Pu6NzBFSz5ZkC8KzrS6vuZXc/ImYrnheMQsqqQIDAQABAoIBACHvikBbn7MgJZyL 16iqAWJQB7d7yjjtYwMuxx+p2NmR2uizA1SeaTMpGR2g4AqmXn/DWSSFnBbweoDz 8V2Z+rs8t/nBRILeSGzRD3Hpwq/Nj+6RAuuqyPUkmsT4skrZg97puzNKBGmKI9sW Ra3WTnUB3fq8veaPU8SCgvFjq+VNjSAo+cZKkyOdix9RYzffCP1WEaC2XgV1CrIg fu7QIQNRFQKZVZZwLvjJcp9rTeXFt5LTvCL0Y3ZDQnzdW2VQo3/rLlfAZkvQHy3u Pn/X7tcHYbKNHq0DfScLXYUDXpLEB/WfQvMQrE7DbuQL7b0Du643T2gdMbuq6NZz jpSJiYUCgYEAtXG1b7zk28ABVMpHPhJinb1UcnRXjagHDnnEasTX6Sc9TD7NNsml woVfS8ArOwuo45C7DofFf45JCD9GDomE0FEDSTkRX4YhYLLAx4ay3VHJMvy154Js 8mOhxDTvsfho+M65EyDxU9zZcvJPIXXTVDsHXnyDoQEJaTT60ksQqPsCgYEAxIAC HmJR/f/ZFed8kbry4t2jvyMJXmMAL0jv16rgRcB6VfItAngAHi1dhgYU5ScKpB8m 9Ex6SbjC7LCqlzrclDRTgTpF23/3pl5iSqeDLf8/VP1UxCd3HfhnQOSQq1LdpvVY Q3RCI0qlxd7N4FknW7IJmg+U25scl6eW5B2i8asCgYEAsOgO+MT5dnB8W8llMNYI JLfmUDmy68C6MJj0swz9XqwNjftlZlexMDmNsnPJMqapokcIuqASJc360vmuOppG Tj3OsGPd1n8WqAtg/qkMV9FYFEhkqzZ1NteBb6YVVjZXUs9rj4T9BsE7mmE6Weth gqyTAMLyK9aw8EzhiIv70GUCgYAojVZimN3c8nEFoTlHBfLcOOtzJbLoRLwkBgRh WMVh/7//frQlP0ie8bPMVfL3+5+pkThD0IioMDYiDK+X+DDPcSEOmU0TaIxeTDoy t/FNi9CxJHra5F4j1EDS1pi4kqhlrVpiyVpg2CXv+PQ56YxC0zJCFhcdXxx+e7qb JzaacwKBgQCiu6562aat9cRQyKi80ePagN6LBt9L33xNmwMAoT3AL9xb8BliiruU sRDHUHhCkFqP0oLYjhNOcDcj4TtKlsqjj2ZRM0BAPbqJJzMypEzIDeVDWURolCI6 pphLXtModYBHN93SaCp+GI6L4WjPHU8z2YlKXEHi5N+zFPrXEvg1EA==

Encrypt value - No

10. ValidNotBeforeOffsetMinutes

Name - ValidNotBeforeOffsetMinutes

Type - System.Int32

Value - -300

Encrypt value - No

11. ValidNotOnOrAfterOffsetMinutes

Name - ValidNotOnOrAfterOffsetMinutes

Type - System.Int32

Value - 300

Encrypt value - No

SAML Single Signon Service - This Service Config is needed to establish Dynamics as the SAML Service Provider, specifically for a Clareity integration

Assembly Name- Cobalt.Components.Common.Web

Class name - Cobalt.Components.Common.Web.Authentication.SAMLSingleSignonService

Service Configuration Properties

1. ClientLoginUrl

Name - ClientLoginUrl

Type - System.String

Value - ~/Authentication/SAML/Login.aspx

Encrypt value - No

2. ClientLogoutUrl

Name - ClientLogoutUrl

Type - System.String

Value - ~/Authentication/SAML/Logout.aspx

Encrypt value - No

3. DisplayImage

Name - DisplayImage

Type - System.String

Value - /9j/4AAQSkZJRgABAQEAYABgAAD/4QBoRXhpZgAATU0AKgAAAAgABAEaAAUAAAABAAAAPgEbAAUAAAABAAAARgEoAAMAAAABAAIAAAExAAIAAAASAAAATgAAAAAAAABgAAAAAQAAAGAAAAABUGFpbnQuTkVUIHYzLjUuMTAA/9sAQwAQCwwODAoQDg0OEhEQExgoGhgWFhgxIyUdKDozPTw5Mzg3QEhcTkBEV0U3OFBtUVdfYmdoZz5NcX

Encrypt value - No

4. DisplayName

Name - DisplayName

Type - System.String

Value - Clareity

Encrypt value -

5. Enabled

Name - Enabled

Type - System.Boolean

Value - True

Encrypt value - No

6. ReceiveLoginRequestBindingType

Name - ReceiveLoginRequestBindingType

Type - System.String

Value - HTTPPost

Encrypt value - No

7. SendLoginRequestBindingType

Name - SendLoginRequestBindingType

Type - System.String

Value - HTTPRedirect

Encrypt value - No

8. ServerRecoverPasswordUrl

Name - ServerRecoverPasswordUrl

Type - System.String

Value - http://safeaccess.gvfv.clareitysecurity.net/forgotpwd/forgotfixedpwd-step1.jsp

Encrypt value - No

9. ServerSingleLogoutServiceUrl

Name - ServerSingleLogoutServiceUrl

Type - System.String

Value - Same value as ServerSingleSignonServiceUrl below (using SLO instead of SSO)

Encrypt value - No

10. ServerSingleSignonServiceUrl

Name - ServerSingleSignonServiceUrl

Type - System.String

Value - Provided by Clareity metadata

Encrypt value - No

11. X509CertificateFile

Name - X509CertificateFile

Type - System.String

Value - Provided by Clareity metadata

Encrypt value - No

 

FLEX MLS SSO Hotfix - This Service Config is needed to establish Dynamics as the SAML Service Provider, specifically for a Clareity integration with a Flex MLS Identity provider (i.e. FBS)

Assembly Name- FlexMlsSsoHotfix

Class name - FlexMlsSsoHotfix.SAMLSingleSignonService

Service Configuration Properties

1. ClientLoginUrl

Name - ClientLoginUrl

Type - System.String

Value - ~/Authentication/SAML/Login.aspx

Encrypt value - No

2. ClientLogoutUrl

Name - ClientLogoutUrl

Type - System.String

Value - ~/Authentication/SAML/Logout.aspx

Encrypt value - No

3. DisplayImage

Name - DisplayImage

Type - System.String

Value - /9j/4AAQSkZJRgABAQEAYABgAAD/4QBoRXhpZgAATU0AKgAAAAgABAEaAAUAAAABAAAAPgEbAAUAAAABAAAARgEoAAMAAAABAAIAAAExAAIAAAASAAAATgAAAAAAAABgAAAAAQAAAGAAAAABUGFpbnQuTkVUIHYzLjUuMTAA/9sAQwAQCwwODAoQDg0OEhEQExgoGhgWFhgxIyUdKDozPTw5Mzg3QEhcTkBEV0U3OFBtUVdfYmdoZz5NcX

Encrypt value - No

4. DisplayName

Name - DisplayName

Type - System.String

Value - Clareity

Encrypt value - No

5. Enabled

Name - Enabled

Type - System.Boolean

Value - True

Encrypt value - No

6. ReceiveLoginRequestBindingType

Name - ReceiveLoginRequestBindingType

Type - System.String

Value - HTTPPost

Encrypt value - No

7. SendLoginRequestBindingType

Name - SendLoginRequestBindingType

Type - System.String

Value - HTTPRedirect

Encrypt value - No

8. ServerRecoverPasswordUrl

Name - ServerRecoverPasswordUrl

Type - System.String

Value - http://safeaccess.gvfv.clareitysecurity.net/forgotpwd/forgotfixedpwd-step1.jsp

Encrypt value - No

9. ServerSingleLogoutServiceUrl

Name - ServerSingleLogoutServiceUrl

Type - System.String

Value - Same value as ServerSingleSignonServiceUrl below (using SLO instead of SSO)

Encrypt value - No

10. ServerSingleSignonServiceUrl

Name - ServerSingleSignonServiceUrl

Type - System.String

Value - Provided by Clareity metadata

Encrypt value - No

11. X509CertificateFile

Name - X509CertificateFile

Type - System.String

Value - Provided by Clareity metadata

Encrypt value - No

11. ContactCrmUserNameField

Name - ContactCrmUserNameField

Type - System.String

Value - cobalt_username

Encrypt value - No

11. ContactFlexMlsUserNameField

Name - ContactFlexMlsUserNameField

Type - System.String

Value - ramco_nrdsid

Encrypt value - No

11. FlexMlsUserNameAttribute

Name - FlexMlsUserNameAttribute

Type - System.String

Value - flexmls_nrds_id

Encrypt value - No

 

Higher Logic Integration Service - This Service Config is needed if the client is using our API to pull information, specifically for Higher Logic

Assembly Name- Cobalt.Components.Crm.Integration

Class name - Cobalt.Components.Crm.Integration.Social.HigherLogic.IntegrationService

Service Configuration Properties

1. ApiGetAcceptedFriendsUrl

Name - ApiGetAcceptedFriendsUrl

Type - System.String

Value - https://api.connectedcommunity.org/api/v2.0/Friends/GetAcceptedFriendRequests?daysBack={0}

Encrypt value - No

2. ApiGetContactUrl

Name - ApiGetContactUrl

Type - System.String

Value -https://api.connectedcommunity.org/api/v2.0/Contacts/GetContact?contactKey={0}

Encrypt value - No

3. ApiHliamKey

Name - ApiHliamKey

Type - System.String

Value - Leave this blank (unless specified)

Encrypt value - No

4. ApiHost

Name - ApiHost

Type - System.String

Value - api.connectedcommunity.org

Encrypt value - No

5. ApiPassword

Name - ApiPassword

Type - System.String

Value - Leave this blank (unless specified)

Encrypt value - No

6. ApiSearchEventsUrl

Name - ApiSearchEventsUrl

Type - System.String

Value - https://api.connectedcommunity.org/api/v2.0/Events/SearchEvents

Encrypt value - No

7. ChangedMemberActivityTypeNames

Name - ChangedMemberActivityTypeNames

Type - System.String

Value - ProfileUpdate,MemberProfileUpdate

Encrypt value - No

8. CommunityUrl

Name - CommunityUrl

Type - System.String

Value - Provided by Higher Logic

Encrypt value - No

9. Enabled

Name - Enabled

Type - System.Boolean

Value - True

Encrypt value - No

10. FriendConnectionRoleName

Name - FriendConnectionRoleName

Type - System.String

Value - Friend

Encrypt value - No

11. FriendRequestsDaysInThePast

Name - FriendRequestsDaysInThePast

Type - System.Int32

Value - 30

Encrypt value - No

12. GenericWidgetUrlFormat (Only create if there is no existing Widget Site configuration and if Web Elements are being used)

Name - GenericWidgetUrlFormat

Type - System.String

Value -The URL of the page where the association has embedded the Login Web Element*

*This Value requires this suffix: ?cobaltsrc={0} (i.e. https://garealtor.com/portal?cobaltsrc={0} )

Encrypt value - No

13. HomePageUrl (Only create if there is no existing Widget Site configuration and if Web Elements are being used)

Name - HomePageUrl

Type - System.String

Value - The association websites Homepage URL

Encrypt value - No

14. LoginRedirectUrlFormat (Only create if there is no existing Widget Site configuration and if Web Elements are being used)

Name - LoginRedirectUrlFormat

Type - System.String

Value - https://[WIDGET SITE URL]/Authentication/HigherLogicLogin.ashx?RedirectURL={2}

*Use the above format, making sure to replace the actual widget site URL

Encrypt value - No

15. LoginUrlFormat (Only create if there is no existing Widget Site configuration and if Web Elements are being used)

Name - LoginUrlFormat

Type - System.String

Value - The URL of the page where the association has embedded the Login Web Element*

*This Value requires this suffix: ?cobaltsrc={0} (i.e. https://garealtor.com/portal?cobaltsrc={0} )

Encrypt value - No

16. MeetingBeginDateDaysInThePast

Name - MeetingBeginDateDaysInThePast

Type - System.Int32

Value - 30

Encrypt value - No

17. MeetingEndDateDaysInTheFuture

Name - MeetingEndDateDaysInTheFuture

Type - System.Int32

Value - 365

Encrypt value - No

18. SecurityKey (this property should still be created, even if the org has an existing API Service config with a security key)

Name - SecurityKey

Type - System.String

Value - The API Security key for that association*

*Create an unencrypted value and copy that value into the Value field while the Encrypt Value field is set to No. Save the record, set the Encrypt Value field to Yes and Save again to encrypt the value.

Encrypt value - Yes*

19. LogoutRedirectUrlFormat (Create, even if Web Elements are not being used)

Name - LogoutRedirectUrlFormat

Type - System.String

Value - http://[COMMUNITY URL]/HigherLogic/security/logout.aspx

*Use the above format, making sure to replace the actual Community site URL

Encrypt value - No

 

NOTE: An Object Moved to Here page that appears persistently when accessing the Widget Site URL may indicate competing Service Configurations. Refer to this article for troubleshooting tips.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk