Home
HCL Digital Experience Product Documentation
Welcome to the product documentation for HCL Digital Experience. Find information about how to install, configure, maintain, and use HCL Web Content Manager and HCL Portal Server, Enable, and Extend solutions.
HCL Digital Experience 8.5
Learn how to install, configure, troubleshoot, maintain, and use Version 8.5 of HCL Web Content Manager and HCL Portal Server, Enable, and Extend.
Setting up a website
Setting up a website includes, creating pages, adding navigation, setting up search, and adding content to the site. Themes are used to customize the portal's look-and-feel. Out-of-the-box templates and the site wizard can help you set up your portal site faster. You can add wikis and blogs to your site and let users tag and rate content on your site.
Setting up marketing campaigns
Use these tools and features to setup marketing campaigns for your website.
Personalization
Portal Personalization provides automatic customization of website content for individual users and user groups.
Personalization terms
The concepts and principles for working with Portal Personalization require an understanding of terminology.
Application object
An application object is a java object existing at a known location in the request context. Defining an application object involves specifying the object’s class name (as a Java class), and specifying a key (string key into a session attribute) to find it in the request context. Personalization calls methods on these objects during rule execution and uses their results in its decision making. Application Objects that implement the SelfInitializingApplicationObject interface are automatically instantiated as needed by Personalization.
Device application object
The Device application object displays content by device class or by location (city, country, latitude, and longitude).
Device Application Object: Location attributes
You can use location to tailor the content that displays. The Device application object contains five location attributes that you can use in rules that you create: latitude, longitude, country, state, and city.

HCL Digital Experience Product Documentation
Welcome to the product documentation for HCL Digital Experience. Find information about how to install, configure, maintain, and use HCL Web Content Manager and HCL Portal Server, Enable, and Extend solutions.
- HCL Digital Experience 9.5
- HCL Digital Experience 9.5 [Legacy Content]
- HCL Digital Experience 9.0
  Learn how to install, configure, troubleshoot, maintain, and use Version 9.0 of HCL Web Content Manager and HCL Portal Server, Enable, and Extend.
- HCL Digital Experience 8.5
  Learn how to install, configure, troubleshoot, maintain, and use Version 8.5 of HCL Web Content Manager and HCL Portal Server, Enable, and Extend.
  - Overview
    HCL Digital Experience (formerly IBM WebSphere Portal and IBM Web Content Manager) empowers you to create, manage, and deliver engaging omnichannel digital experiences to virtually all audiences with responsive content, targeted offers, seamlessly integrated applications, and consistent branding across channels (web, mobile. and hybrid mobile/web applications and more).
  - Roadmaps to deploy your system
    Review the roadmaps to understand the common deployment, configuration, migration, and integration patterns.
  - Roadmaps to create your website
    Review the roadmaps to understand how to create your website.
  - Online Help
    This Online Help is made available in the HCL Digital Experience Help Center for quick references on how to install, configure, maintain, and use HCL Digital Experience.
  - Installing
    HCL Digital Experience provides flexible deployment options that range from proof-of-concept where you can examine and test functionality to a highly available and scalable production environment. Review the planning information to learn more about hardware and software requirements, high availability, scalability, supported topologies, and much more. Select your operating system and then select the installation pattern that most reflects your business needs.
  - Configuring
    Run the following tasks after you install and deploy HCL Digital Experience. They address tasks that are typically run one time and have a global effect. Some configuration changes are made more frequently or do not have a global effect. These tasks are addressed in the Administering section.
  - Backup and restore
    Backup and recovery of data files and databases is an essential operation for any business system, particularly for data and applications that run in production environments. Create and follow a plan for backing up and recovering data on all tiers of your HCL Digital Experience deployment. IBM Installation Manager must also be included in backup and recovery planning. If you back up the HCL Portal file structure and then install a fix pack, your HCL Digital Experience and IBM Installation Manager become out of sync after you restore the HCL Portal file system. This condition is not recoverable.
  - Migrating
    Successful migration requires significant planning and preparation, understanding the tools that are involved, and careful execution of the appropriate steps in the order provided.
  - Integrating
    Integrate HCL Digital Experience with software such as HCL Sametime to enable your users to collaborate more easily. You can also use the unified task list portlet to integrate HCL with your backend business process software, such as IBM Process Server.
  - Administering
    Use the administration tools that are provided with the portal to do various day-to-day administration tasks. There are two methods for editing portal setup: using the administration portlets or the XML configuration interface. The administration portlets are a convenient way to make real-time updates to the portal's configuration. While the XML configuration interface is suited to more advanced administration, including batch processing of updates.
  - Securing
    Security tasks include setting up property extension databases and custom user repositories, configuring and activating SSL, and configuring authentication. In addition, tasks such as activating Federal Information Processing Standards (FIPS) and NIST SP800-131a security modules and configuring external security managers such as Security Access Manager might be required to secure your portal environment.
  - Monitoring
    HCL Portal includes tools and features to help you monitor the portal site.
  - Setting up a website
    Setting up a website includes, creating pages, adding navigation, setting up search, and adding content to the site. Themes are used to customize the portal's look-and-feel. Out-of-the-box templates and the site wizard can help you set up your portal site faster. You can add wikis and blogs to your site and let users tag and rate content on your site.
    - Website building blocks
      Unless you are familiar with the HCL Digital Experience and HCL Web Content Manager website model, review the building blocks. Building blocks are the different parts that make up the website framework, such as pages, navigation, themes, content, content libraries, and more.
    - Creating reusable assets
      Use reusable assets to store or generate content that is used in more than one place in your website.
    - Building the website
      Building a website includes creating libraries, pages, and web content. You also create links and navigation to your content, and assign access to different types of users, such as editors and viewers.
    - Authoring tools
      There are multiple ways to create and manage content including using the site toolbar, inline editing, and the authoring portlet.
    - Preparing for content authors
      Before content authors can create content you must prepare your site to be ready for content creation, including preparing the site toolbar, enabling inline editing, and creating templates.
    - Developing and managing content
      Use these tools and processes to develop and manage your website.
    - Delivering web content
      The type of delivery method you use to deliver web content to your viewers depend on the type of content that is being delivered, and the type of viewers your website is intended for.
    - Vanity URLs
      You can associate vanity URLs with portal pages and labels. Vanity URLs are short URLs that people can easily remember. They are shorter than full HCL Portal URLs. They are sometimes also called marketing URLs. You can publish vanity URLs for marketing campaigns through different channels, such as email or print. This way, you can use vanity URLs to direct customers to a specific portal page or content item. Interested site visitors who want to view your campaign can then remember or copy the short vanity URL and type it into the browser address field.
    - Social rendering
      HCL Digital Experience page editors can use social rendering to feature social data that is hosted on a remote HCL Connections server in the context of portal pages.
    - Setting up marketing campaigns
      Use these tools and features to setup marketing campaigns for your website.
      - Personalization
        Portal Personalization provides automatic customization of website content for individual users and user groups.
        How a site is personalized
        Use this topic to understand how to define a personalized list of new articles for a website, such as a section of an intranet site for targeted employee bulletins or where the content of the site is tailored to the particular user.
        Personalization terms
        The concepts and principles for working with Portal Personalization require an understanding of terminology.
        Resources, resource instances, and resource collections
        Before you can personalize HCL Digital Experience resources, you need to understanding the terms for portal objects stored in the content repository.
        User resources
        Your Web site visitors want to quickly access the Web content that meets their needs and interests. The needs and interests of the site visitors are stored as properties in the user profile data store.
        Content resources
        Web content resources consist of data that is formatted and displayed on Web pages. Examples include news articles, products, statistics and educational materials.
        Attribute Based Administration
        Attribute based administration provides a facility to customize the layout of a page for individual authenticated users by using rules to show or hide pages or portlets. This implementation tells the portal to show or hide pages and portlets based on dynamic characteristics that are determined at runtime. Attribute Based Administration is only available for authenticated users. For anonymous users, all pages are shown.
        Rules
        Rules are used to define how your Web site interacts with individual and groups of Web site visitors. Rules are composed of easy-to-read logic statements that, in their final form, specify how to evaluate various conditions and what actions to take based on those conditions.
        Content spots
        A content spot is a placeholder or slot for a rule on a Web page. When the page is viewed, the content spot uses its rule mapping to determine which rule to execute. When the rule is executed, any actions defined within the rule take place. Each content spot has a unique name. A content spot's content type must be defined when it is created and should not be changed.
        Rule spot mappings
        For a rule to be used on your Web site, it must be mapped to an existing content spot. A rule spot mapping is merely an association between a content spot and a rule. Changing the rule that is executed in the run-time environment is as easy as mapping a different rule to a content spot.
        Campaigns
        Campaigns are a means of organizing and implementing sets of personalization behavior. A useful analogy is an advertising campaign, which targets specific audiences with high-priority information for a specified period of time. Campaigns achieve this by allowing you to preferentially display campaign-related content in the content spots of a Web site. To accomplish such a goal, a campaign contains a set of rule-to-content spot mappings, start dates, and stop dates.
        Application object
        An application object is a java object existing at a known location in the request context. Defining an application object involves specifying the object’s class name (as a Java class), and specifying a key (string key into a session attribute) to find it in the request context. Personalization calls methods on these objects during rule execution and uses their results in its decision making. Application Objects that implement the SelfInitializingApplicationObject interface are automatically instantiated as needed by Personalization.
        Device application object
        The Device application object displays content by device class or by location (city, country, latitude, and longitude).
        Device application object: Device class attribute
        Site content can display differently for a smartphone, desktop, or other device by using the Device application object in rules. You do not have to restrict your content to fit across all devices. Use this object to enable your site to recognize the device that accesses your site and to target content that best displays for that device.
        Device Application Object: Location attributes
        You can use location to tailor the content that displays. The Device application object contains five location attributes that you can use in rules that you create: latitude, longitude, country, state, and city.
        Enabling the geolocation theme module
        Unlike the other application objects that are installed by default, the geolocation features of the Device application object are not enabled. To enable the geolocation features, you can modify the JSON profiles to include the geolocation theme module, provide a resolver JAR, or use both methods.
        Retrieving the location of users or devices
        To implement the geolocation interface, you must provide methods to resolve coordinates or IP address to one or more of the location attributes (country, state, or city). You can determine the location of a device by using reverse geocoding or by using service providers. Reverse geocoding converts latitude and longitude coordinates into a location (such as country, state, or city) by using a geolocation JAR that you provide or by using an external geolocation service provider.
        Example: Creating a segment that uses the state attribute
        Learn more about the Device application object through an example that uses a location attribute (state). In this example, you are creating two segments by using a profiler rule: North Carolina and California. Each segment views content that is based on the location of the device.
        Referrer application object
        You can target your content to users based on what site the user came from before the user accessed your site. You can also target your content by the search parameters that are entered by users in a search engine.
        Public Render Parameters application object
        The Public Render Parameter application object provides read and write access to public render parameters. Public render parameters allow portlets to share navigational state information and preserve this information across requests. Use this object in rules when you need your site to store a user's selection as a public render parameter during the action phase and have other portlets read this public render parameter during the render phase.
        Shared Data application object
        The Shared Data application object is used in rules to share complex data between web applications and HCL Digital Experience in a user's session.
        Request Context
        This is the interface used to access various attributes for rules. For HTTP contexts, it provides access to the HttpRequest and HttpSession attributes. For non-HTTP contexts, it provides the same interface to a surrogate for the request and session.
        Query framework
        The query framework is an object representation of a query. The framework is not specifically oriented toward querying either object or relational databases. A set of common operators is defined, but what an attribute represents is determined by the interpreter of the query.
        The Personalization interface
        The Portal Personalization user interface consists of three portlets: the Personalization Navigator, Personalization Editor, and the Personalized List.
        Publishing personalization rules overview
        HCL Portal Personalization sends published rules across HTTP to a servlet which resides on each personalization server. This servlet can receive publishing data or initiate new publishing jobs. When a user begins a publishing job from the personalization authoring environment, the local servlet is provided with the set of information necessary to complete the job. The local servlet contacts the destination endpoint servlet (which could be the same servlet) and sends its data to it. The destination servlet reports success or failure.
        The Web Content resource collection
        The Web Content resource collection is installed and configured out of the box. This predefined collection allows you to write rules that select lists of content from HCL Web Content Manager. Rules specify which Web content to show in a Portal Personalization component in Web Content Manager.
        The Portal User resource collection
        Portal Personalization comes with a Portal User resource collection. This collection uses public APIs provided by HCL Digital Experience to access user information.
        LikeMinds Recommendations
        Personalization contains a dynamic recommendation system based on LikeMinds. LikeMinds is software that is used with your e-commerce applications. LikeMinds analyzes user interactions that occur on your Web site and generates real time predictions and recommendations to your Web site users.
        Feedback and analytics
        Personalization provides a complete logging framework for collecting data on how visitors are using your Web site. If Feedback is enabled, data is automatically collected about each Personalization rule that is fired. In addition, development tools enable websites to collect a variety of data related to visitors' actions and behavior. By default this data is logged to a standard database schema for later analysis and reporting. The framework is also extensible, allowing websites to customize and supplement the way data is collected and stored to more fully meet their needs.
        Developing a personalized portlet
        This exercise demonstrates how to use Personalization features of HCL Portal and Rational Application Developer to build your first personalized portlet. Your final result is a working portlet that uses Personalization rules and content spots to display personal news based on user attributes (or profiles).
        Personalization programming reference
        HCL Digital Experience provides the programming model, processes, and APIs for the Personalization rules and resource engines.
        Personalization APIs
      - Social Media Publisher
        The Social Media Publisher for HCL Web Content Manager is an extension to HCL Web Content Manager that allows businesses to promote their web content on social networks, and provide some basic statistics about the promoted content.
    - HCL Web Content Manager Multilingual Solution
      The HCL Web Content Manager Multilingual Solution is a set of tools that are used to manage translated versions of localized and regionalized websites.
    - Syndicated Feed Portlet
      The Syndicated Feed Portlet for HCL Digital Experience offers enhanced feed subscription and presentation capabilities.
  - Staging to production
    During portal solution development, the solution is initially developed, tested, and refined on one server or a limited number of servers. The solution is deployed later on live systems, referred to as the production environment. The process of moving the solution from the development environment to the production environment is called staging.
  - Developing
    This section includes developer documentation on extending applications and development assets for HCL Portal and HCL Web Content Manager.
  - Troubleshooting
    This section helps you resolve problems, use diagnostic tools and tracing to capture HCL Digital Experience system errors.
  - Reference
    View information that can help you use the Digital Experience Help Center including directory conventions, terms of use, trademarks, a glossary, and more.
  - Glossary
    This glossary includes terms and definitions for HCL Digital Experience.
  - Content Template Catalog 4.4
    The Content Template (CTC) is a set of templates that accelerate the process of building a website.

Device Application Object: Location attributes | HCL Digital Experience

You can use location to tailor the content that displays. The Device application object contains five location attributes that you can use in rules that you create: latitude, longitude, country, state, and city.

About this task

To receive latitude and longitude information from a user's device:

You must enable the geolocation theme module on HCL Digital Experience.
The user that accesses your site must use a device that is location aware and selected to share location information about their device to your site.
The client software on the device (the browser) must support HTML5.

Country, state, and city attributes are resolved from the latitude and longitude coordinates of the user's device or from the IP address that is obtained by using a reverse geocoding service. A reverse geocoding service is not provided with HCL Portal. Use the geolocation interface and registration mechanism that is provided with HCL Portal to define how to deploy the service you use.