Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

CardioLog provides easily integrates personal user data into reports and 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, using existing user directories. The User Categories Updates service retrieves user information such as department, location, gender, and any other profile data is performed by the User Categories Updates service, which retrieves the data from Active Directory attributes or SharePoint User Profiles by defaultautomatically. In order to retrieve data, first configure Active Directory and/or SharePoint User Profile integration. The User Categories Updates service can also retrieve the also retrieve data from a custom source , using a separate web service that supplies the custom user information.

Contents

...

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. Browse CardioLog > Administration CardioLog Scheduling Service Active Directory Updates.
  5. Click Next.
  6. Enter the custom web service URL in the Web Service URL text box and then click the down arrow (acceptable file extensions: "aspx", "asmx", "xml").
  7. Click Save and restart the CardioLog Scheduling Service.
  8. Perform IISRESET on the CardioLog application server.
  9. After the next run of Active Directory Updates, your users and groups will be added to the Users and Groups filter of each report.

...

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="Windows-1252"?>

<xs:schema

elementFormDefault="qualified"

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

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

<xs:elementname="tree">

<xs:complexType>

<xs:sequence>

<xs:elementname="users">

<xs:complexType>

<xs:sequence>

<xs:elementmaxOccurs="unbounded"name="user">

<xs:complexType>

<xs:sequence>

<xs:elementname="accountName"type="xs:string" />

<xs:elementname="displayName"type="xs:string" />

<xs:elementname="userMail"type="xs:string" />

<xs:elementname="memberOf"type="xs:string" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:elementname="groups">

<xs:complexType>

<xs:sequence>

<xs:elementmaxOccurs="unbounded"name="group">

<xs:complexType>

<xs:sequence>

<xs:elementname="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.

 Sample Data:

 

<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>

...

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. Browse CardioLog Administration CardioLog Scheduling Service 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 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.

...

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

 

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

<xs:schemaid="CategoryXmlSchema"

elementFormDefault="qualified"

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

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

<xs:elementname="tree">

<xs:complexType>

<xs:sequence>

<xs:elementname="item"type="UserCategoryXmlNode"minOccurs="0"maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:complexTypename="UserCategoryXmlNode">

<xs:sequence>

<xs:elementname="userName"type="xs:string" />

<xs:elementname="categories"minOccurs="0"maxOccurs="1">

<xs:complexType>

<xs:sequence>

<xs:elementname="categoryValue"type="categoryNode"minOccurs="0"maxOccurs="unbounded" />

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

<xs:complexTypename="categoryNode">

<xs:sequence>

<xs:elementname="categoryName"type="xs:string"minOccurs="1"maxOccurs="1" />

<xs:elementname="categoryValue"type="xs:string"minOccurs="1"maxOccurs="1" />

</xs:sequence>

</xs:complexType>

</xs:schema>

Field Definitions:

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

Sample Data:

 

<tree>

<item>

<userName>MyCompany\james</userName>

<categories>

<categoryValue>

<categoryName>Region</categoryName>

<categoryValue>West</categoryValue>

</categoryValue>

<categoryValue>

<categoryName>Gender</categoryName>

<categoryValue>Male</categoryValue>

</categoryValue>

</categories>

</item>

<item>

<userName>MyCompany\dana</userName>

<categories>

<categoryValue>

<categoryName>Region</categoryName>

<categoryValue>North</categoryValue>

</categoryValue>

<categoryValue>

<categoryName>Gender</categoryName>

<categoryValue>Female</categoryValue>

</categoryValue>

</categories>

</item>

</tree>

categories adaptor. If you use multiple Active Directory networks, and/or multiple SharePoint farms, CardioLog can also integrate multiple sources, and allows you to customize all categories you would like to draw from for each service.

Contents

 

Image Added
User Category Management Main Window

Anchor
configure source
configure source
Configure a New Visitor Segmentation Source

In order to retrieve additional user information such as department, gender, title or any other category available from either Active Directory attributes, or SharePoint User Profiles, first begin by following these steps:

  1. From the navigation pane in CardioLog go to Administration CardioLog Scheduling Service User Category 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 Category Management from the main window. 

    Image Added
    System Configuration Main Window

  5. Click Add Categories Source in the top right-hand corner, and select either Active Directory or SharePoint.

    Image Added
    User Category Management: Select Source

Anchor
active directory
active directory
Configuring Visitor Segmentation by Active Directory Attributes

In order to retrieve additional user information, such as department, gender, etc. 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 -

<add key="adConnStr" value="[Active Directory FQDN]" />

<add key="delimiter" value="[delimiter]" />

<add key="attributeNames" value="[a delimiter separated list of attributes associated with the user]" />

[adConnStrvalue 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 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:

...

To integrate Active Directory Attributes into reports, first begin by configuring a new visitor segmentation source, and then continue by following these steps:

  1. Title your Active Directory source.
  2. Select a Users and Groups Source from the drop down menu if one isn't chosen automatically.

    Image Added 
    User Category Management: Active Directory Categories Service


  3. For Categories, click Add to include any additional category types you would like available in all relevant reports.

    Image Added
    Active Directory Categories Source - Add Category


  4. In the Active Directory Categories Service dialogue window, search for any category types you would like to add. 

    Image Added
    Active Directory Categories Source - Search Categories 


  5. Enable the check box next to all categories you would like to include. Click Save to continue.
  6. In the Active Directory Categories Service main window, check the box next to a category and click Remove to make the given category unavailable in all relevant reports and analysis. You may also perform this action at any time following configuration.
  7. Click Save to confirm any changes and return to the dashboard.
  8. Go to CardioLog Scheduling Service under Administration in the navigation pane and click Restart Service in the upper right hand corner. 
  9. After the next scheduled User Category Update, your Active Directory attributes will be made available in the Visitor Segments filter of each report, under User Categories.

...

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

Anchor
sharepoint
sharepoint
Configuring Visitor Segmentation by SharePoint User Profiles

In order to retrieve additional user information, such as department, gender, etc. from SharePoint User Profiles, 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 > 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:

...

To integrate SharePoint User Profiles into reports, follow these steps:

  1.  In the Administration section of the navigation pane, click System Configuration, and then select SharePoint Tree Adaptor.
  2. Select your SharePoint farm.
  3. In the SharePoint Tree Adaptor dialog, fill out the following fields:
    • SharePoint Profile Database Name - Add the db_datareader SQL permissions to the CardioLog service account for the SharePoint profile database.
  4. Configure a new visitor segmentation source.
  5. Title your SharePoint Category.
  6. Select the SharePoint Adaptor version you would like to access from the drop down menu if the correct one isn't chosen automatically.

    Image Added

    User Category Management - SharePoint Categories Service

  7. For Categories, click Add to include any additional category types you would like available in all relevant reports.

    Image Added
    SharePoint Categories Service dialogue window - Add Categories

  8. In the SharePoint Categories Service dialogue window, search for any category types you would like to add.

    Image Added 
    SharePoint Categories Service: Search Categories


  9. Enable the check box next to all categories you would like to include. Click Save to continue.
  10. In the Active Directory Categories Service main window, check the box next to a category and click Remove to make the given category unavailable in all relevant reports and analysis. You may also perform this action at any time following configuration.
  11. Click Save to confirm any changes and return to the dashboard.
  12. Go to CardioLog Scheduling Service under Administration in the navigation pane and click Restart Service in the upper right hand corner.
  13. 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.

...

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

 

Anchor
custom
custom
Configuring a Custom User Category Service

CardioLog also allows for custom user category management from other sources. For more information see Custom User Categories Adaptor for formatting and import options.

Image Added
User Category Management: Custom Source