DXHUserConnectionManager

The DXHUserConnectionManager class manages connections between the Digital Experience Hub (DXH) and other applications.

Namespace

Ektron.Cms.Framework.Settings.DxH.DxHUserConnectionManager

Constructors

  • DxHUserConnectionManager()
  • DxHUserConnectionManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • DxHUserConnectionDataService. Gets instance to DxHUserConnectionManager.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Settings.UrlAliasing.DataObjects.RedirectData)

Adds a DxHUserConnectionData object with the newly created ID.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * DXH Connection Code

Parameters

Returns

Returns added DxHUserConnectionData object.

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            DxHConnectionManager dxhconnectionManager = new DxHConnectionManager();

            if (uxAdapterName.Text.Trim() == "" || uxConnectionName.Text.Trim() == "")
            {
                MessageUtilities.UpdateMessage(uxMessage, "Enter the required fields", Message.DisplayModes.Error);
            }
            else
            {

                DxHConnectionData dxhConnectionData = new DxHConnectionData()
                {
                    AdapterName = uxAdapterName.Text,
                    ConnectionName = uxConnectionName.Text,
                    EndPoint = uxEndPoint.Text,

                };
                dxhconnectionManager.Add(dxhConnectionData);
                MessageUtilities.UpdateMessage(uxMessage, "DxConnection property added with Id " + dxhConnectionData.Id, Message.DisplayModes.Success);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int64)

Deletes a DxHUserConnectionData object in the CMS.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * ID

Parameters

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxDxHUserConnectionIdLabel" AssociatedControlID="uxDxHUserConnectionId"
            CssClass="span-4 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxDxHUserConnectionId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Settings.DxH;
using Ektron.Cms.Framework.Settings.DxH;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long ID = long.Parse(uxId.Text);
        DxHConnectionManager dxhconnectionManager = new DxHConnectionManager();
        DxHConnectionData dxhConnectionData = dxhconnectionManager.GetItem(ID);
        bool result = Information.IsNumeric(uxId.Text);
        if (dxhConnectionData != null)
        {
            dxhconnectionManager.Delete(ID);
            MessageUtilities.UpdateMessage(uxMessage, "DxHConnection deleted.", Message.DisplayModes.Success);
        }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "DxHConnection does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(System.Int64)

Retrieves a RedirectData object by RedirectId.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Redirect ID

Parameters

  • Redirectid. The ID of the task category to retrieve.

Returns

Returns a RedirectData object.

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            DxHConnectionManager dxhconnectionManager = new DxHConnectionManager();
            long ID = long.Parse(uxID.Text);
            DxHConnectionData dxhConnectionData = dxhconnectionManager.GetItem(ID);

            if (dxhConnectionData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for user DxHConnection Property with ID " + dxhConnectionData.Id.ToString() + " are below", Message.DisplayModes.Success);

                uxAdapterName.Text = "AdapterName : " + dxhConnectionData.AdapterName;
                uxConnectionName.Text = "ConnectionName : " + dxhConnectionData.ConnectionName;
                uxEndPoint.Text = "EndPoint : " + dxhConnectionData.EndPoint;
                uxCreateDate.Text = "CreateDate : " + dxhConnectionData.CreateDate;
                uxModifiedDate.Text = "uxModifiedDate : " + dxhConnectionData.ModifiedDate;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "DxHConnection Property does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(Ektron.Cms.Common.Criteria)

Retrieves a list of DxHUserConnectionData objects based upon the supplied criteria.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * DXH User Connection Property
  • * Object Value

Parameters

Returns

Returns a list of DxHUserConnectionData objects.

Criteria use

The DataProperty enum works with its criteria class and defines the properties that the Manager class uses to filter and order. Specify zero (0) or more criteria to retrieve the objects you want. The criteria object also lets you set the number of items to return, define paging data, and modify sorting.

Criteria objects
  • Condition. The Logical operator to apply to the filters. The default value is "AND". The criteria condition controls the operator for the default filter group and the AND-ing\Or-ing the filter groups together.
    public Ektron.Cms.Common.LogicalOperation Condition { set; get; }
  • FilterGroups. Gets a list of filter groups. Filter groups can be created to do filter grouping (that is, parentheses in the where clause). The groups use the criteria's condition like other filters, but can use their own condition internally.
    public 
  System.Collections.Generic.List<CriteriaFilterGroup<ActivityCommentProperty>> 
  FilterGroups { get; }
  • Filters. Lists of filters defined in this criteria object. To add new Filters, you can add them here or use the AddFilter method (recommended).
    public 
  System.Collections.Generic.List<CriteriaFilter<ActivityCommentProperty>> 
  Filters { get; }
  • GroupByField. The group by field to apply to the results.
    public 
  Ektron.Cms.Activity.ActivityCommentProperty 
  GroupByField { set; get; }
  • OrderByDirection. Sets the order direction (ascending or descending).
    public EkEnumeration.OrderByDirection 
  OrderByDirection { set; get; }
  • OrderByField . Set the property used to order the results.
    public Ektron.Cms.Activity.ActivityCommentProperty 
  OrderByField { set; get; }
  • PagingInfo. By default, page size is 50 for improved performance. Example paging Info: 
    PagingInfo pageinfo = new PagingInfo();
pageinfo.CurrentPage=1;
pageinfo.RecordsPerPage = 100;
criteria.PagingInfo = pageinfo;
Constructor(property, orderbyDirection)

Sorts the results by a property in ascending or descending order.

AddFilter(property, operator, value)

Filters the results based on the conditions defined in this method.

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo, Objectvalue);
LogicalOperation Condition

Filters the array of items based on the logical condition set in the AddFilter properties. 

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo,Objectvalue);
List<CriteriaFilterGroup> FilterGroups

Binds data to a listview or gridview.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxDxHUserConnectionPropertyLabel" AssociatedControlID="uxDxHUserConnectionProperty"
            CssClass="span-6 last" runat="server" Text="* DxHUserConnectionProperty:" />
        <asp:DropDownList ID="uxDxHUserConnectionProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>ConnectorName</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-6 last"
            runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" />
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxDxHUserConnectionDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        Visitor Id
                    </th>
                    <th>
                        Connector Name
                    </th>
                    <th>
                        Connector Object Name
                    </th>
                    <th>
                        Connector Id
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("VisitorId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ConnectorName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ConnectorObjectName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ConnectorId")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Common;
using Ektron.Cms.Settings.DxH;
using Ektron.Cms.Framework.Settings.DxH;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
         object Objectvalue;
        DxHConnectionManager dxhconnectionManager = new DxHConnectionManager();
        DxHConnectionCriteria dxhConnectionCriteria = new DxHConnectionCriteria();
        string Property = uxDxHConnectionProperty.SelectedItem.Text;

        Objectvalue = uxObjectValue.Text;    

        if (Property == "Id")
        {
            dxhConnectionCriteria.AddFilter(DxHConnectionProperty.Id, CriteriaFilterOperator.EqualTo, Convert.ToInt64(Objectvalue));
        }
        else if (Property == "AdapterName")
        {
            dxhConnectionCriteria.AddFilter(DxHConnectionProperty.AdapterName, CriteriaFilterOperator.EqualTo, Objectvalue);
        }
        else if (Property == "ConnectionName")
        {
            dxhConnectionCriteria.AddFilter(DxHConnectionProperty.ConnectionName, CriteriaFilterOperator.EqualTo, Objectvalue);
        }
        else if (Property == "EndPoint")
        {
            dxhConnectionCriteria.AddFilter(DxHConnectionProperty.EndPoint, CriteriaFilterOperator.EqualTo, Objectvalue);
        }
       

        //Get Activity List for given Filter
        List<DxHConnectionData> dxhConnectionlist = dxhconnectionManager.GetList(dxhConnectionCriteria);

        uxDxHConnectionlist.Visible = true;
        uxDxHConnectionlist.DataSource = dxhConnectionlist;
        uxDxHConnectionlist.DataBind();

        uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.Settings.UrlAliasing.DataObjects.RedirectData)

Updates the supplied DxHUserConnectionData object in the CMS.

Authenticated users

  • CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

  • * Redirect ID
  • Redirect Code
  • Original URL
  • New URL
  • Active

Parameters

Returns

Updated the DxHUserConnectionData object.

Remarks

Validate the redirect item with GetItem() before you update the properties. Then, call Update with your modified DxHUserConnectionData object.

NOTE: You cannot change all properties after the initial Add event, such as the DxHUserConnectionData.Type.

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            DxHConnectionManager dxhconnectionManager = new DxHConnectionManager();
            long Id = long.Parse(uxId.Text.Trim());
          
            DxHConnectionData dxhConnectionData = dxhconnectionManager.GetItem(Id);
            if (dxhConnectionData != null)
            {
                if (uxAdapterName.Text.Trim() == "" || uxConnectionName.Text.Trim() == "")
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Enter the required fields", Message.DisplayModes.Error);
                }
                else
                {
                    dxhConnectionData.AdapterName = uxAdapterName.Text;
                    dxhConnectionData.ConnectionName = uxConnectionName.Text;
                    dxhConnectionData.EndPoint = uxEndPoint.Text;
                    
                    dxhconnectionManager.Update(dxhConnectionData);
                    MessageUtilities.UpdateMessage(uxMessage, "DxHConnectionManager updated", Message.DisplayModes.Success);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "DxHConnectionManager does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

DxHUserConnectionData

Namespace

Ektron.Cms.Settings.DxH

Properties

  • ConnectionName. Gets or Sets the ConnectionName for DxHUserConnectionData object.
    public string ConnectionName { set; get; }
  • ConnectorName. Gets or Sets the Connector Name for DxHUserConnectionData object.
    public string ConnectorName { set; get; }
  • ConnectorObjectName. Gets or Sets the Connector Object Name for DxHUserConnectionData object.
    public string ConnectorObjectName { set; get; }
  • ExternalUserKey. Gets or Sets the Id for the user in the external system.
    public string ExternalUserKey { set; get; }
  • Id. Gets or Sets the Id for DxHUserConnectionData object.
    public long Id { set; get; }
  • VisitorIdGets or Sets the VisitorId for DxHUserConnectionData object. 
    public string VisitorId { set; get; }