Versions Compared

Old Version 7

changes.mady.by.user Sigalit Hassid

Saved on

compared with

New Version 8

changes.mady.by.user Sigalit Hassid

Saved on

Key

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

...

  1. Develop the custom tree web service for your web site.
  2. Verify that the custom tree 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. From the navigation pane in CardioLog go to Administration > System Configuration > Custom Tree Adaptor > Click Add.


    System Configuration - Custom Tree Adaptor
     
  4. Enter the name of your website in the Name textbox
  5. Enter the custom tree web service URL in the Website URL textbox . (Acceptable file extensions are "aspx", "asmx" or "xml") and enter the name of your website in the Website Name textbox.
  6. Enter the custom tree web service method name in the Web Method Name textbox (in case of using "asmx").
  7. Click Save and restart the CardioLog Scheduling Service.
  8. After the next run of Portal Tree Updates, the tree structure will be displayed in the Analysis Center (Object Explorer) and will be available for reports that allow content drilldown. 

...

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. 

Anchor
retrieving users groups
retrieving users 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 Web Service Website URL text box textbox (acceptable Acceptable file extensions : are "aspx", "asmx" , or "xml").
  8. Confirm all other details are accurate.
  9. 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").
  10. Click Set and enter user credentials if required in order to access the web service.
  11. Click Save and restart the CardioLog Scheduling Service.
  12. After the next Active Directory update, your users and groups will be added to the relevant Users and Groups filter of each report.

Anchor
creating structure
creating structure
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:

Info
iconfalse
titleXML 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.

 

Info
iconfalse
titleSample 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>

Anchor
Custom User Categories Adaptor
Custom User Categories Adaptor
Custom User Categories Adaptor - Importing User Attributes from External Sources

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

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 designated web service that supplies the user information.

...

  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 Category Management.
  4. Click Add Categories Source > Custom.


    System Configuration - User Category Management - Custom
     
  5. Enter a name for the custom user categories source in the Title textbox
  6. Enter the web custom user categories web service URL in the Website URL field textbox (acceptable Acceptable file extensions : are "aspx", "asmx" , or "xml").
  7. Select Is Web Service = Yes and enter the custom user categories web service method name in the Web Method Name textbox (in case of using "asmx").
  8. Click Set and enter user credentials if required in order to access the web service.
  9. Click Save and restart the CardioLog Scheduling Service.
  10. 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.

Anchor
creating user info
creating user info
Custom User Categories Web Service Schema

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

Info
iconfalse
titleXML Schema


<?xml version="1.0" encoding="utf-8" ?>

<xs:schema id="CategoryXmlSchema"

elementFormDefault="qualified"

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

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

<xs:element name="tree">

<xs:complexType>

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:complexType name="UserCategoryXmlNode">

<xs:sequence>

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

<xs:element name="categories" minOccurs="0" maxOccurs="1">

<xs:complexType>

<xs:sequence>

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

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

<xs:complexType name="categoryNode">

<xs:sequence>

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

<xs:element name="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 designated category name.
categoryValue: the assigned category value.

 

Info
iconfalse
titleSample 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\taylor</userName>

<categories>

<categoryValue>

<categoryName>Region</categoryName>

<categoryValue>North</categoryValue>

</categoryValue>

<categoryValue>

<categoryName>Gender</categoryName>

<categoryValue>Female</categoryValue>

</categoryValue>

</categories>

</item>

</tree>