CardioLog Analytics provides the ability to segment authenticated visitors by their user names and the groups they belong to. The organizational hierarchy of users and groups is monitored by the Active Directory Updates service, which retrieves the data directly from Active Directory by default. 

The Active Directory Updates service can also retrieve the data from external sources (any human resource management system or even custom databases), using a designated web service which supplies the desired organizational structure of users and groups. 

Develop the Custom Users and Groups Web Service

In order to load your user and group organization structure to CardioLog, you are required to specify a web service that the Active Directory Updates service will gather the organization's data from. This is done through the CardioLog Administration user interface:

  1. Develop the custom organization structure web service for your organization.
  2. Verify that your custom organization structure web service returns a valid XML response, according to the XML schema,
  3. Confirm the CardioLog Scheduling Service user account has sufficient read request permissions to access the web service.
  4. From the navigation pane in CardioLog go to Administration > System Configuration > Users and Groups Management.
  5. Click Add Source > Custom.

     
    System Configuration - Users and Groups Management - Custom
     
  6. Enter a name for the custom users and groups source in the Title textbox
  7. Enter the custom users and groups web service URL in the Website URL textbox (Acceptable file extensions are "aspx", "asmx" or "xml").
  8. Select Is Web Service = Yes and enter the custom users and groups web service method name in the Web Method Name textbox (in case of using "asmx").
  9. Click Set and enter user credentials if required in order to access the web service.
  10. Click Save and restart the CardioLog Scheduling Service.
  11. After the next Active Directory update, your users and groups will be added to the relevant Users and Groups filter of each report.

Custom Users and Groups Web Service Schema

The Users and Groups web service should be exposed by a web page which provides a XML string response according to the following schema:


<?xmlversion="1.0"encoding="utf-8" ?>

<xs:schema

elementFormDefault="qualified"

xmlns:mstns="http://tempuri.org/ADXmlSchema.xsd"

xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:element name="tree">

<xs:complexType>

<xs:sequence>

<xs:element name="users">

<xs:complexType>

<xs:sequence>

<xs:element maxOccurs="unbounded" name="user">

<xs:complexType>

<xs:sequence>

<xs:element name="accountName" type="xs:string" />

<xs:element name="displayName" type="xs:string" />

<xs:element name="userMail" type="xs:string" />

<xs:element name="memberOf" type="xs:string" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="groups">

<xs:complexType>

<xs:sequence>

<xs:element maxOccurs="unbounded" name="group">

<xs:complexType>

<xs:sequence>

<xs:element name="groupName" type="xs:string" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>

Field Definitions:

User accountName: the user account name (a unique user ID).
User displayName: the user display name.
User userMail: the user email address.
User memberOf: a semicolon separated list of group names associated with the user.

 


<tree>

<users>

<user>

<accountName>MyCompany\james</accountName>

<displayName>James Wright</displayName>

<userMail>james.wright@mycompany.com</userMail>

<memberOf>Administrators;Marketing</memberOf>

</user>

<user>

<accountName>MyCompany\dana</accountName>

<displayName>Dana Cohen</displayName>

<userMail>dana.cohen@mycompany.com</userMail>

<memberOf>Sales</memberOf>

</user>

</users>

</tree>