User Categories Management

CardioLog provides advanced visitor segmentation capabilities by integrating both external and internal personal user data into reports.

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 a custom source, using a designated web service which supplies the desired organizational structure of users and groups. Retrieval of additional user information, such as department, gender, and other profile data is performed by the User Categories Updates service, which retrieves the data from Active Directory attributes or SharePoint User Profiles by default. The User Categories Updates service can also retrieve the data from a custom source, using a separate web service that supplies the user information.

Contents

• Retrieving Users and Groups From a Custom Source
• Creating the Custom User and Group Structure Web Service
• Retrieving User Information From a Custom Source
• Creating the Custom User Information Web Service
• Configuring Visitor Segmentation by Active Directory Attributes
• Configuring Visitor Segmentation by SharePoint User Profiles
• User Categories Updates

Retrieving Users and Groups From a Custom Source

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. Create 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 and in System Configuration select Users and Groups Management.
5. Click on the desired database you would like to edit.
6. Enter the custom web service URL in the Web Service URL text box (acceptable file extensions: "aspx", "asmx", "xml").
7. Confirm all other details are accurate.
8. Click Save.
9. Perform IISRESET on the CardioLog application server.
10. After the next Active Directory update, your users and groups will be added to the relevant Users and Groups filter of each report.

Creating the Custom User and Group Structure Web Service

The Users and Groups web service should be exposed by a web page which provides a XML string response according to the following 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.

 Sample Data:

Retrieving User Information From a Custom Source

In order to load additional user information from a web service, specify a web service from which the User Categories Updates service will extract the user data. This is done through the CardioLogAdministration user interface:

1. Create the custom user information web service for your organization.
2. Verify that the custom user information web service returns a valid XML response, according to the XML schema, and that the CardioLog Scheduling Service user account has sufficient permissions to access (request) the web service.
3. In the navigation pane in CardioLog go to Administration > System Configuration > User Categories Updates.
4. Click Next.
5. Enter the web service URL in the Categories Web Service URL field (acceptable file extensions: "aspx", "asmx", "xml").
6. Click Save and restart the CardioLog Scheduling Service.
7. Perform IISRESET using the IIS Manager on the CardioLog application server.
8. After the next run of the User Categories Updates service, your user categories will be added to the Visitor Segments filter of each report, under User Categories.

Creating the Custom User Information Web Service

The user information web service should be exposed by a web page which provides an XML string response, according to the following format: 

Field Definitions:

username: the user account name (should match the accountName field in the organization structure)
categoryName: the designated category name.
categoryValue: the assigned category value.

Sample Data:

Configuring Visitor Segmentation by Active Directory Attributes

In order to retrieve additional user information such as department, gender, title or any other category available from Active Directory attributes, perform the following steps:

1. Edit the following keys in the [CardioLog Installation Folder]\VisitorSegments\web.config file, located in the <appSettings> section -

[adConnStr] - value should show the fully qualified domain name (ex: "mycompany.com") 
To retrieve your domain name, open Administrative Tools > Active Directory Users and Computers

[delimiter] - a delimiter for attribute names.

[attributeNames] - a list (delimiter separated) of user attributes which should be imported into CardioLog Analytics.
To view the available user attributes: open ADSIEdit and connect to your domain. Right click and select Properties on a user object to see its list of attributes.

2. Add visitor segmentation by Active Directory attributes to the User Categories Updates service:

1. From the navigation pane in CardioLog go to Administration > CardioLog Scheduling Service > User Categories Updates.
2. Set the service Scheduling Type to Daily at 00:00.
3. Click OK.
4. From the Administration navigation pane, select System Configuration, and then select User Categories Management from the main window. 
5. Click on the user category you would like to edit.
6. Enter the VisitorSegments web application URL in the URL field as follows (Enter your CardioLog server name and port):
   
   http://[CardioLog server name]:[port]/VisitorSegments/ADCategories.aspx
   

• Click Save and restart the CardioLog Scheduling Service.
• Perform IISRESET on the CardioLog application server.
• After the next run of the User Categories Updates service, your Active Directory attributes will be added to the Visitor Segments filter of each report, under User Categories.
• You can modify how the attribute names will be displayed in the Visitor Segments filter from the CardioLog database: Edit the tab_category_categories table and modify the Category_DisplayName column.

Note: The User Categories filter can only be applied once the User Categories Updates is configured, not retroactively. In order to map usage data history to user categories please contact us.

Configuring Visitor Segmentation by SharePoint User Profiles

In order to retrieve additional user information such as department, gender, title or any other category available from Active Directory attributes, perform the following steps:

1. Edit the following keys in the [CardioLog Installation Folder]\VisitorSegments\web.config file, located in the <appSettings> section -

[sspDBConn] - a list (delimiter separated) of connection strings for the desired SharePoint User Profile Service database.

[sspDelimiter] - a delimiter for property names (sspPropertyNames) and database connection strings (sspDBConn). Delimiter for sspDBConn and sspPropertyNames.

[sspPropertyNames] - a list (delimiter separated) of user properties which should be imported into CardioLog Analytics.

To view the available user property names go to SharePoint Central Administration > Shared Service Administration > User Profiles and Properties > View Profile Properties.
To retrieve the property name, click the desired property and select Edit > Name field.
You can also view the raw property names directly in the Shared Services database > table PropertyList > column PropertyName.

2. Add visitor segmentation by SharePoint User Profiles to the User Categories Updates service:

1. From the navigation pane in CardioLog go to Administration > CardioLog Scheduling Service > User Categories Updates.
2. Set the service Scheduling Type to Daily at 00:00.
3. Click OK.
4. From the Administration navigation pane, select System Configuration, and then select User Categories Management from the main window. 
5. Click on the user category you would like to edit.
6. Enter the VisitorSegments web application URL in the URL field as follows  (Enter your CardioLog server name and port):
   
   http://[CardioLog server name]:[port]/VisitorSegments/SSPProfiles.aspx
   
   
7. Click Save and restart the CardioLog Scheduling Service.
8. Perform IISRESET on the CardioLog application server.
9. After the next run of the User Categories Updates service, your SharePoint User Profile properties will be added to the Visitor Segments filter of each report, under User Categories.
10. You can modify how the attribute names will be displayed in the Visitor Segments filter in the CardioLog database: Edit the tab_category_categories table and modify the Category_DisplayName column.

Note: The User Categories filter can only be applied once the User Categories Updates is configured, not retroactively. In order to map usage data history to user categories please contact us.

User Categories Updates