text;
stringlengths 5
32.6k
|
|---|
thank you for choosing an enterprise subscription to liferay digital experience platform dxp. liferay dxp allows you to create and connect personalized digital experiences across web, mobile, and connected devices liferay digital experience platform provides a dynamic module ecosystem for liferay application suites, applications available on marketplace, and custom extensions to liferay. liferay dxp allows for easy integration with back end systems while providing consistent user experiences across channels. to help you get started, we'll connect you with the liferay help center is the central location for access to liferay software downloads, updates, patches, documentation and support for liferay customers. to access the help center, sign in to url and look for help center in the drop down menu under resources, or directly access from here you will need to activate your liferay instance. when you run your new liferay installation for the first time, you will be prompted to input your activation key. you can find detailed information on the registration process in resources below the liferay help center provides a ticketing system with an exceptional user interface for simplifying the creation and management of support issues. with help center, users can easily create, track and escalate issues. its ability to issue multiple assignees also allows more people to work on a single ticket at the same time the ticketing system can be accessed from the top navigation menu by clicking on my requests on the right hand side or directly from here. to create a ticket, click on submit a ticket in the top navigation menu or from here. if you have issues accessing the ticketing system or issues creating tickets within help center, please email email liferay can be used in a variety of the most demanding mission critical deployments. the following services should be considered and evaluated prior to deployment as liferay digital experience platform is used in an extremely broad range of use cases, liferay global services provides professional services engagements for liferay dxp to support many services such as installation, customization, application development, integration, lifecycle management and more. for additional information, contact email. liferay global services can also provide the following recommended services the early phases of a project include such critical deliverables as information architecture design, capacity planning, high availability design, change management, and more. unfortunately, many software deployments suffer from improper planning and architectural choices that occurred at the start of their projects. these early missteps can cause delays, increase project costs, and increase complexity for future maintenance and expansion. the liferay kick-start program allows you to leverage information architecture, strategy, and other technical best practices crafted by the architects and designers of the liferay product. customers who leverage these services have a much greater chance of enjoying reduced project costs, achieving project milestones, and reducing execution risk architectural complexities, scalability bottlenecks, and missteps in initial design decisions can jeopardize a successful launch and vastly complicate your solution's future support. while many of these scalability and performance issues are best addressed early in a project lifecycle, liferay global services understands the time pressures faced by many of our clients and how these non-functional requirements are often delayed until shortly before launch. to help improve launch-time scalability and prevent performance issues, liferay global services offers enterprise subscription customers the liferay go-live program liferay digital experience platform dxp is licensed by liferay and its affiliates. your use of dxp is subject to the terms and conditions of an agreement between you, andor your company, and liferay or its affiliates the liferay trademark includes the logo and name liferay. its use is governed by the trademark policy posted at url. when using liferay in any form, this policy should be reviewed to understand if your use requires permission from liferay, inc. for further questions, please contact email.;;
|
"updated april 3, 2020 chrome is temporarily rolling back samesite cookie changes updated june 12, 2020 added information about the fixed versions of the saml 2.0 connector with the release of chrome 80 in february, the default behavior of how chrome is treating cookies without an explicit samesite attribute is changing these cookies will be handled as samesitelax which means that such cookies will only be sent from the browser to the server in first-party or same-site contexts and won't be sent with cross-site requests the current roll-out plan according to url is the following february 4, 2020 chrome 80 stable released. the enablement of the samesite-by-default and samesitenone-requires-secure enforcement will not be included in this initial chrome 80 stable rollout. please see the next item for more detailed information on the when samesite enforcement will be enabled for chrome 80 stable. february, 2020 enforcement rollout for chrome 80 stable the samesite-by-default and samesitenone-requires-secure behaviors will begin rolling out to chrome 80 stable for an initial limited population starting the week of february 17, 2020, excluding the us president's day holiday on monday. we will be closely monitoring and evaluating ecosystem impact from this initial limited phase through gradually increasing rollouts end-users can disable these settings via chromeflags -site-by-default-cookies and chromeflags -without-same-site-must-be-secure available as of chrome 76 to learn more about the samesite cookie settings and the changes in the default behavior please refer to the additional information section below note liferay instances configured as service providers sp and connecting to a non-liferay identity provider idp should consult with their provider to clarify if they are affected for every browser session, the first sp initiated sso request will continue to work, but require users to log into the liferay saml idp - even if they have an already authenticated session on the idp. this behavior is identical to when you configure the saml plugin to force re-authentication. the second sp initiated sso request will require users to relaunch the browser beforehand in order to succeed saml single logout does not work correctly with a liferay saml idp. the flow is terminated on the idp with a prompt stating you are signed in. from this point it can become difficult to log out from the sp without deleting all related cookie on the sp redirection back to the page you were on when you made an sso request on the sp works correctly. this is because the redirection url is propagated through a state url parameter and not kept in the liferay sp's guest session your environment may be affected if it meets all of the following criteria liferay implemented a logic that controls the attribute of the samesite cookies in lps-108070 the previous version of the first-party same-site cookie handling specification didn't define a means to explicitly declare that a cookie should support 3rd party contexts. this resulted in these browsers either completely rejecting cookies with samesitenone, or interpreting it as essentially the opposite to historic cookie behavior! for example, see this safari bug url it is worth highlighting that in the case of safari and browsers on ios devices, an os osx ios upgrade is needed in order to correctly handle samesitenone. this, of course, requires a lot more investment than simply upgrading a browser, making it more likely that incompatible versions remain in use the good news is that these same browserversions continue to support the old cookie behavior. so this provides an opportunity to fix the incompatibility with samesitenone through setting a 2nd cookie without any samesite attribute and falling back to reading this cookie when the primary cookie is not sent by the browser it is possible to rewrite the set-cookie response headers and add samesitenone; secure at the web server level, like for example, using the apache2 headers mod";;
|
starting from liferay 7.3, new upgrades for modules won't run automatically on startup by default the following options are available to run the upgrades we may include in fixservice packs there are a few exceptions that need to be considered please note that fix packs can only contain micro schema version changes which are optional, so you will only be required to run upgrades when installing service packs that contain minor upgrade processes, using one of the options discussed above. complete instructions will be published in help center when releasing fixservice packs this decision was made to unify the behavior between modules and core and to let users decide when to run upgrade processes if you need additional assistance regarding these points, please contact liferay support.;;
|
http archive har files are a format used to track information between a user's browser and site. it can be used to identify performance issues such as slow load times, page renders, or other bottlenecks. this is due in part, because the file tracks the load of resources and how long these resources take to loadrun it is a great diagnostic tool that liferay support may occasionally request. the following are steps that can be used to generate har files depending on the browser being used refresh the page to begin capturing the traffic between the browser to the server note please capture a full page load so we can review the requests made prior to the behavior internet explorer does not natively provide a har output file. as such, a third-party program such as can also be used instead use the f12 keyboard shortcut to access developer tools r efresh the page to begin capturing the traffic between the browser to the server note please capture a full page load so we can review the requests made prior to the behavior.;;
|
this article shows how to setup liferay dxp 7.3 to import users from an ldap server through the graphical user interface the steps are the basically the same as for earlier versions of liferay, but the ui options have changed in dxp 7.3.;;
|
this sample module source is attached to this page aims to provide minimal boilerplate code one can use to implement custom liferay saml 2.0 resolvers for each of the custom resolvers sets a higher url as a property in order to ensure that the custom resolvers will be used over the default ones shipped with liferay's saml 2.0 connector source optional you can download the maven-style source jars of the liferay connector to saml 2.0 modules through your purchased apps page from liferay marketplace or request it through liferay support by opening a ticket if you don't find the source of a given version compile see url in the attached source note the customization method should be the same for previous versions of the liferay connector to saml 2.0, as well 4.1 for dxp 7.1 and 3.1 for dxp 7.0. you just need to update the dependencies accordingly you should see log messages in the console like these as a quick test, you can create two virtual instances in your liferay dxp installation and configure them as a saml idp and sp respectively. when the sample module is deployed, you should see the following log messages in liferay dxp's console upon authenticating a user;;
|
insecure default configuration may allow remote attackers to enumerate users' email addresses via the forgot password functionality. this can be a risk in the case of public-facing deployments it is recommended to set the portal property url to true in your url on the specified product versions, this property defaults to false to avoid causing unwanted behavior change in existing deployments, liferay will not change this default setting in a fix packservice pack in liferay dxp 7.3 this property defaults to true.;;
|
liferay support does not recommend or endorse specific third-party products over others. liferay is not responsible for any instructions herein or referenced regarding these products. any implementation of these principles is the responsibility of the subscriber this article will describe how to set up on tomcat without using an external server like apache. there is an existing wiki on the public wiki page that is available, but what follows is a more user-friendly guide to setup create a self-signed certificate using keytool now, configure tomcat to use the certificate we just generated. uncomment the ssl section and add in the keystorefile parameter so that it looks like this now we'll be importing the certificate into the jvm's keystore. this tells the jvm that this is a trusted certificate so that when liferay makes requests to tomcat it will proceed without errors export the key from the keystore you generated in step 1. this extracts the certificate so that you can import it into the jvm's store import the cert into the jvm. cacerts is the filename of the jvm keystore. should be in javahomejrelibsecuritycacerts keytool -import -alias tomcat -file url -keypass changeit -keystore cprogram filesjavajre6libsecuritycacerts depending on your local configuration, you may have to change access permissions for the cacerts file you should now be able to access the website using;;
|
the compatibility matrix for multiple versions of liferay digital experience platform dxp lists edge latest as tested and compatible with liferay dxp. however, microsoft has two distributions of its edge browser edgehtml also called edge legacy and edge chromium edge chromium is the edge browser tested as compatible with liferay dxp 7.3 and above liferay will default to ensuring that edge chromium is tested as compatible with liferay dxp edgehtml or edge legacy is not tested as compatible with liferay dxp 7.3 and above. the resolution for issues reported while using liferay dxp 7.3 and above with edgehtml will be to use edge chromium liferay will default to ensuring that edge chromium is tested as compatible with liferay dxp. however, we understand adopting a new enterprise-wide browser takes time, planning, and user training liferay will maintain this level of effort until march 9, 2021. march 9, 2021 was the end of life date for edge legacy also called edgehtml. lifeary only tests compatibility with products in active life. since edge legacy has reached end of life only edge chromium will be tested for compatibility until september 10, 2021 liferay will seek to resolve issues reported while using liferay dxp 7.2 and below with edgehtml using a commercially reasonable effort and determined on a case-by-case basis. if the level of effort to resolve the issue is not commercially reasonable for liferay subscription services then liferay would seek to resolve the issue in edge chromium.;;
|
this article specifies the liferay support policy for activating 3rd-party paid apps from the liferay marketplace. currently, app licenses are not fully compatible with virtualized environments due to specific license requirements. the customer is responsible for fulfilling these requirements through system configuration activating a 3rd-party marketplace app can be done either through a .xml license file or through an online connection, by using an order id. both methods rely on the following server information the screenshot below shows where 3rd-party app customers can register their server to obtain a .xml license file the app will deactivate if the information listed above changes. this is common in virtualized environments, where the system is not running on the same physical servers in order to keep the paid app active in a virtualized environment, a customer can configure their system to have a static ip address. if the ip address is the only field that does not change, the customer will need to register with a .xml license file where the hostname and mac address fields are empty.;;
|
in order to continually improve our product offering, liferay mayon occasiondeprecate features and functionality in the platform. features are typically updated because there are new and better ways of solving the particular problem the feature was designed for for more information about why these items were deprecated or future plans, please open a support ticket. details about the status and support coverage for these items can be found here with the release of liferay dxp 7.3 the following items are newly marked as maintenance mode the following is a list of liferay items present in liferay dxp 7.2 and marked as deprecated for liferay dxp 7.3. these items are still present in the product the following is a list of liferay items present in liferay dxp 7.2 and removed from liferay dxp 7.3. some of these items are available on liferay marketplace as final versions. for more information please open a support ticket. unless released on liferay marketplace these items are classified as archived the following is a list of liferay marketplace apps available for liferay dxp 7.2 which will not be released for liferay dxp 7.3. previous versions will still be available for download on liferay marketplace. this classifies the marketplace apps as archived.;;
|
many versions of liferay portal and liferay digital experience platform dxp have an integration point with xuggler for video preview generation. however, many unmitigated vulnerabilities are present within the xuggler project. the xuggler project is also deprecated. for this reason, liferay does not recommend using xuggler as an integrated technology liferay dxp and liferay portal compatibility with xuggler is only tested using the pre-compiled libraries provided by xuggler. subscription services is not required to assist with integrating or configuring the product with xuggler if the xuggler pre-compiled libraries are not used integration with xuggler was officially deprecated in liferay dxp 7.3 and will be replaced in a future version with an alternate set of features integration with xuggler is possible, but discouraged given the security vulnerabilities and lack of mitigation in the project there is a known issue which prevents installing the xuggler library within the liferay docker image. for this reason, integrating liferay dxp with xugger while using a liferay provided docker image is not supported. subscription services will not assist with the integration and configuration of xuggler to work with liferay dxp if the instance of liferay dxp is running within a container generated from the liferay provided docker image or if the image operating system does not contain at least version 6 of the gnu libc.;;
|
with the release of jdk11, oracle's new java se support policy also see here brings changes to the java enterprise community. the following article outlines liferay's approach concerning the certification of jdk releases for existing versions of liferay digital experience platform and liferay portal moving forward, the only jdk major releases to be certified by liferay will be those marked for lts long term support liferay has chosen not to individually certify openjdk binaries. the compatibility of open source jdk binaries will depend on the java technical compatibility kit tck certification of that binary. meaning, if a jdk binary is java tck compliant or certified then that binary will be compatible for use with liferay all java technical compatibility kit tck compliant builds of java 11 and java 8 and specific jdks listed on the compatibility matrix all java technical compatibility kit tck compliant builds of java 8 and specific jdks listed on the compatibility matrix liferay is not testing any jdk 11 distributions open or otherwise. an upgrade of the osgi framework is necessary to certify jdk 11 as compatible with liferay dxp 7.0. these framework changes were included in liferay dxp 7.1. backporting these changes to 7.0 may compromise the stability of 7.0 and will not be performed for specific jdks please see the compatibility matrix. liferay is not testing any jdk 11 distributions open or otherwise;;
|
"elastic cloud ec offers elasticsearch service to host your elastic stack as a managed service. as we see an increasing demand for cloud-based deployments at liferay, we created this article to provide you information about the compatibility between liferay dxp and elasticsearch hosted on elastic cloud. this article addresses liferay dxp and elastic cloud compatibility. there are additional restrictions and known issues with elastic cloud to take into consideration when planning to host your elastic stack for liferay dxp on elastic cloud please consult with the available user settings for the elasticsearch service and check liferay dxp documentation to verify there are no conflicts between the elasticsearch configurations or elasticsearch-based features available in elastic cloud and those required by liferay dxp. some liferay dxp use-cases could require configurations or features which are not available through elastic cloud liferay enterprise search subscribers as indicated here, liferay enterprise search does not offer any licensing agreements with elastic for their elastic cloud service the elasticsearch 7 connector that is bundled with dxp 7.3 by default is using the java rest client which communicates with elasticsearch over this communication protocol does not require java serialization between dxp and elasticsearch. therefore, liferay dxp 7.3 deployments can connect to elasticsearch service on elastic cloud as long as your elasticsearch service is using a compatible version. liferay can't ensure the compatibility between dxp and elasticsearch hosted on elastic cloud due to the possible mismatch in the java versions and the additional restrictions for the transport client there are three factors that affect the compatibility and require consideration before deciding to move your elastic stack to ec when you report issues with liferay dxp and elasticsearch to liferay support, besides providing the usual information like liferay dxp patch level, connector version and config files; elasticsearchkibana versions and configuration files such as url and url; jdk version etc. please also indicate on your ticket that you are using elastic cloud if subscription services' investigation determines that the root cause of the issue is related to a jdk mismatch, then subscription services will be limited in resolving the issue this information can be obtained through the dev tools console in kibana refer to this article for an example configuration this article also applies to elastic cloud subscriptions billed through the marketplace of the available cloud providers amazon web services aws, google cloud platform gcp, microsoft azure as elastic cloud deployments are managed through elastic's cloud console please see this article for a technical overview of the elasticsearch connectors available for liferay dxp.";;
|
learn how page fragments make content creation easy;
|
learn how to set up notifications in liferay dxp;
|
learn how to connect your liferay project to ldap;
|
learn how to add tags and categories in liferay dxp;
|
learn how to structure and assign users to organizations;
|
learn how to connect sites from liferay dxp to liferay analytics cloud;
|
to configure mobile device rules, you need a way to find out the characteristics while some of the characteristics are provided by the device, for this reason, there are databases that contain information these databases make it possible to learn device details from the device type. liferay dxp's mobile device rules can connect to device databases so that you can use their device characteristics in important for the features described in this article to work, you must install the liferay mobile device detection lite lmdd app from liferay marketplace. this app provides the device detection database that's required to detect which mobile devices are accessing it you can develop plugins that integrate with other device databases. don't have a device database, you can still set up mobile device rules. won't, however, be effective until a database is deployed, because the portal won't have enough information about the devices being used to make page to access the mobile device families administrative page, to choose the site that you want to define mobile device rules for you can also add families for all sites by navigating to the control panel administrative page displays a list of defined families and lets you add more. to add rules, you must first add a family click on the name of the mobile device family to access the rules page figure 1 create a mobile device family so you can create rules the rules defined for a family, along with the priorities of the families selected for a particular site or page, determine which family's actions are from the new classification rule page for a specific rule set, you can add a rule by specifying an operating system, rule type, physical screen size, and screen resolution. many rules to a family as you need in order to classify the devices on which click on the add button to add a new rule select the classifications you want for this rule from operating system and type, physical screen size, and screen resolution you'll notice after saving the classification rule that it's characterized as a only simple rules are included with liferay dxp, but the rules are designed to be extensible, and additional rule types can be added by your figure 2 select the operating system and device type for your rule once you've created some mobile device families and added some rules to them, you're ready to create some actions. the actions defined for a family determine what happens to a request when the device is detected and the family has been you can add families to a site, individual page, or page set from their go to site builder pages in your site select the advanced tab and open the mobile device rules option in the click select to open the list of families that can be applied from the same page, you can access the configuration for an individual page, or you can configure mobile device rules for an entire site from configuration you can select multiple families for a particular site or page and order them by priority. the families are checked in decreasing order of priority the actions defined by the first family that applies are executed figure 3 you can select a mobile device family to apply for a site or page.;;
|
as you know, internet traffic has risen exponentially over the past decade, and this trend shows no sign of stopping. in addition, the bulk of internet traffic the mobile boom presents new obstacles and how will content adapt to different devices how can your grandma's gnarly tablet and your cousin's awesome new smart phone request the same information from your portal the device api detects the capabilities of any device making a request to your it can also determine what mobile device or operating system was used to make a request, and then follows rules to make liferay dxp render pages based on to use these features, you must first install a device detection database that can detect which mobile devices are accessing the portal. liferay dxp provides such a database in the liferay mobile device detection lmdd app from the liferay marketplace. for instructions on using liferay marketplace to find and install apps important on windows, liferay mobile device detection enterprise must be on all operating systems, liferay mobile device detection enterprise requires a jvm minimum memory setting of at least 2 gb you can create your own plugin that makes use of the device database. tutorial shows you some of the methods in the device api that you can use to retrieve device attributes and capabilities. one important thing that you'll want to get using the device api is the you can obtain it from the themedisplay object like this using some of the methods from the javadocs, here's an example that obtains a now your code can get the device object and the dimensions of a device. of course, this is just a simple example. you can acquire many other device attributes that help you take care of the pesky problems that arise when sending refer to the device javadocs mentioned above for next, you'll learn about retrieving some other device capabilities with the device api, you can detect the properties of a device making a request to your portal and then render content accordingly. to things that the requesting device can do. for example, you can determine the device's operating system, browser, form factor, and much more. can be retrieved with the getcapability and getcapabilities methods of the most of the properties of the requesting device can be detected, depending on the device detection implementation you're using. the brand name of the device with this code you can grab many other device properties, including hardwaremodel, hardwarename, releaseyear, and releasemonth. values like ismobile, istablet, and many more keep in mind the device api is an api. the underlying implementation of the you can also implement your own. property names are specific and proprietary to the underlying device api now that you know about the device api, you can use it to make sure that your grandma's gnarly tablet and your cousin's awesome new smart phone can make requests to your portal and receive identical content.;;
|
here's a quick scenario you already have a server hosting a liferay dxp if you require a second similar installation, then adding a virtual instance you can run more than one virtual instance on a single server with a shared database, but separate data and configurations. instances share an application server and osgi container, they also share these figure 1 add and manage virtual instances of liferay in the control panel's configuration virtual instances section follow these steps to create a virtual instance before you create a virtual instance, configure its domain name in your this opens the new instance form complete the new instance form as follows using the domain name is a common convention virtual host the domain name you configured in your network. directed to your server via this domain name, they'll be sent to the virtual instance that contains their data mail domain the mail host's domain name for the virtual instance. email notifications are sent from the instance using this domain max users the maximum number of user accounts the virtual instance enter 0 to support unlimited users active whether the virtual instance is active. virtual instances aren't accessible to anyone, even the administrator click save when you're done filling out the form now you can navigate to the instance using its domain name. what looks like a clean install of liferay dxp. this is your new virtual instance! you can configure it any way you like. the remaining articles in this section show you how to configure an instance's settings.;;
|
"starting with liferay dxp 7.2 service pack 1, new search tuning features are available for administrative users custom result rankings is one of them result rankings provides a brute force method for intervening into the relevance scoring of the search engine, by doing these things designate that certain results should appear at the top of the results if they are matched with a certain keyword. results to the top of the results list by contrast, hide results that shouldn't appear in certain searches at all add results that aren't normally returned by searching a certain keyword re-order pinned results with a drag-and-drop interface result rankings let you pin, hide, and add search results for a given set of these rankings apply only to searches using the newer search widgets the rankings you customize do not apply to the legacy search portlet results or to the individual application search bars use case at the lunar resort website, visitors often search for activities, entering keywords like rover races, atv rentals, and lunar golf. of these, the lunar resort always wants a certain content this is the activities page in the lunar resort where guests can find all of the resort's adventurous offerings, including lunar rover races, atv rentals, and information about golfing packages. the lunar resort does not want the legal liability waiver form to appear during a search for fun activities that's a bridge to be crossed when guests sign up it shouldn't pollute a search for fun activities, even though it contains many of the keywords users would search for. you pin the activities content page to the top of the results and hide the liability waiver web content article. in addition, a community member wrote a blog favorably reviewing the lunar resort, and you want that content added to searches for activities at the resort. this is a prime use case for result figure 1 the lunar resort wants to tweak these results pin the activities page to the top, and hide the legal content entirely search tuning features like result rankings are only supported when using elasticsearch as the search engine. if you're using solr, make sure you disable synonym sets and result rankings when you upgrade your installation to results rankings was added in liferay dxp 7.2 service pack 1 result ranking entries are configured in a virtual instance, but are not applied instead, custom rankings made in one virtual instance are shared across all virtual instances in the deployment, and even across separate deployments sharing an elasticsearch cluster in a multi-tenant therefore, result rankings shouldn't be used when connecting multiple liferay dxp deployments to the same elasticsearch cluster unless you intend for the same result rankings to apply to every liferay dxp deployment. an existing result ranking cannot be renamed. renaming requires recreating the to manipulate result rankings, create a new alias containing the keywordssearch terms you want to intercept. perform a search to get results you can also do a separate search if you want to grab results that haven't even been returned during a natural search for the alias keywords. results, choose to pin, hide, re-order, or add results as you please on the new ranking screen, enter one of the keywords or search phrases you want to intercept it can be a phrase, instead of just one word; and don't worry, you can add more later in the search query field the results are displayed and the tools for pinning, hiding, and adding results are made available. after at least one result is pinned. first, consider whether to add one or more the customize rankings screen is ready to use, but any intervention only applies to the search query you initially entered in the new ranking screen. apply the customized rankings to additional search terms, add them as aliases in the aliases field, enter the search term to add as an alias to submit the search term as an alias, click enter or a comma in the aliases you can add multiple aliases here figure 2 apply your custom rankings to matched results of additional search terms note that results not manipulated manually here are returned as usual when the alias term is queried for in the search bar now you can customize the rankings available as of liferay dxp 7.2, sp2 you can activate or deactivate existing aliases as you have need for them to take effect find the active alias and open its editor screen click the toggle switch currently labeled active duplicate active aliases are not allowed, but you can deactivate an alias and after deactivating an alias, you can only reactivate it after deactivating any active duplicates to pin or hide rankings, hover over the result of interest two icons appear, one for pinning and one for hiding. the actions button , and select pin once you select either option, it's applied a pinned result moves to the top of the list, and a hidden result repeat the action as many times as necessary if you're done customizing the results, click save, and it's applied figure 3 pin results to the top of the search results list to add a result that was not returned by searching for the first keyword or phrase, click the add result button and search for whichever asset you want to figure 4 add results that aren't normally returned click save if you're done customizing results to re-order pinned results results that are not pinned cannot be re-ordered, click the handle icon, drag the result, and drop it in the preferred location in figure 5 re-order the pinned rankings if you want to emphasize or de-emphasize certain results because configuration of result rankings happens at the virtual instance scope, there are scoping and permissions behaviors to be aware of scope is disregarded for pinned results pinned results existing in site a always appear in searches from site b, even if the search bar scope is set to search from result rankings is global when searching for results in result rankings admin, relevant results from all sites are returned permissions are applied as usual if a user doesn't have permission to see an asset, pinning it does not make it appear in the search results for that since both are new features without precedent in liferay dxp, there can be confusion over result rankings aliases and synonyms. expand the search to include results matched by additional synonymous keywords, so more results are returned if there are matches to the synonyms result rankings aliases are just keywords that also have the particular ranking interventions applied to them. only the searched keyword is matched to results, and then, the pins, hides, re-ordering, and additional results take of course, if you add a synonym set that includes an identical set of search terms as the result ranking you configure, the features all the synonymous terms return the same result set, with the customized rankings applied on top there are several known issues and planned improvements for result rankings.";;
|
starting with liferay dxp 7.2 service pack 1, new search tuning features are available for administrative users synonym sets is one of them synonym sets are mappings that you the admin create, so that if a user searches for a certain keyword or phrase, the synonymous terms in your mapping matches to synonyms keywords are scored equally to matches with the exact keyword by the search engine lunar resort use case multiple content creators at the lunar resort write blogs about a variety of topics. consistent terminology is a problem for some one writer might use the term rover for the vehicle that travels across the moonscape, while another uses lunar cart or moon atv. portal administrator, you must ensure that the search experience is such that searching for any of those keywords returns all relevant results. search tuning features like synonym sets are only supported when using elasticsearch as the search engine. if you're using solr, make sure you disable synonym sets and result rankings when you upgrade your installation to as of the initial release liferay dxp 7.2 sp-1, synonym sets work with fields indexed in two locales english and spanish. localization out-of-the-box work with synonym sets. synonym searches operate on fields indexed with the en and es suffixes. to learn which native liferay dxp assetsfields support localization in the search all asset types that index their data into english and spanish are analyzed with a synonyms-aware analyzer and can be found during a synonym supported in elasticsearch is not supported through the synonyms set ui create a synonym set by adding as many synonymous keywords to a set as you once the synonym set is saved, any searches in the same company scope that's any site from the virtual instance where the synonyms were configured figure 1 add as many synonymous keywords to a set as you'd like navigate to control panel search tuning synonyms enter the list of synonyms in the set. accomplished by clicking enter or by entering a comma when the list is finished, click publish the available synonym sets appear and can be managed in bulk or individually. the management options are to update a synonym set or delete one or more figure 2 synonym sets can be managed in bulk to edit or delete a single synonym set, click the actions button for the synonym set and choose edit when you have a synonym set defined, the synonyms are ready for use. them, find a search bar anywhere in the virtual instance and enter a keyword results matching the keyword and any synonym are returned in the search results widget figure 3 the blogs entry does not contain the word rover but it can be matched because of a synonym set mapping cart as its synonym. the synonym is even highlighted these are some of the most important ones reindexing permanently deletes all synonym sets. a way to backup and preserve restore synonym sets across reindex operations users can create duplicate synonym set entries and update other synonym sets unintentionally.;;
|
liferay digital experience platform 7.2 is only supported under the following certified configurations for more information on configurations and limitations with databases that are compatible with liferay dxp, please refer to the liferay user guide for more information on configurations and limitations with application servers compatible with liferay dxp, please refer to the liferay user guide for more information on configurations and limitations with desktop browsers that are compatible with liferay dxp, please refer to the support policy liferay will support access to information e.g. reading content and navigation through pages, navigation menus, and basic responsiveness of modules for the latest versions of mobile browsers only. for more information on liferay's mobile support policy, please refer to the help center jdk certification is for runtime only. jdk 8 is required to build or compile liferay dxp projects amazon ec2 and rds are only supported with environments on the liferay dxp 7.2 compatibility matrix refer to the search engine compatibility matrix for the detailed compatibility including the compatible connector versions and required patch levels liferay dxp does not restrict the use of vmcontainer strategy as long as the application server, database, jdk, and operating system are certified for use as indicated on the compatibility matrix above. subscribers will be responsible for configuring the vmcontainer appropriately;;
|
this article extends the search engine compatibility matrix to provide technical information about liferay's elasticsearch connectors notes on liferay enterprise search les the les connectors are omitted from this article as they are not server connectors they do not instantiate clients to communicate with elasticsearch nodes, but rather extend the capabilities of our elasticsearch connectors the information in this article applies to the versions listed below available dxp versions fix pack level or marketplace version unless indicated otherwise. this article will be updated as changes are required we mostly use the high level rest client, however, there are some currently unimplemented features that dxp needs so we obtain the low level rest client from the high-level client to build the necessary json for the requests refers to the client library version the connector uses. the version of the sidecar elasticsearch server started when the portal first starts and the connector is not yet configured for production mode may be using a newer minor version, but its version is never lower than the client version from elastic's documentation the high level client is guaranteed to be able to communicate with any elasticsearch node running on the same major version and greater or equal minor version. it doesn't need to be in the same minor version as the elasticsearch nodes it communicates with, as it is forward compatible meaning that it supports communicating with later versions of elasticsearch than the one it was developed for. regarding the low level client, elastic's documentation states that it is compatible with all elasticsearch versions. it is important to note that this compatibility refers to the elasticsearch client only. liferay conducts ad-hoc testing of the elasticsearch connectors with minor releases of elasticsearch to ensure that liferay dxp features are also compatible with newer minor versions. as these minor releases sometimes introduce breaking changes, the search engine compatibility matrix is updated only after successful iterations the java rest client communicates with elasticsearch over this communication protocol does not require java serialization between dxp and elasticsearch as opposed to the previous transport client-based connectors. your elasticsearch nodes can run on different jvm than what your dxp deployment is using refers to the client library versions the connector uses as dependencies at compile time. this also defines the version of the elasticsearch server started in embedded mode when the portal first starts and the connector is not yet configured for remote mode liferay conducts ad-hoc testing of the elasticsearch connectors with minor releases of elasticsearch. these minor releases sometimes introduce breaking changes at the low-level java api. therefore, both liferay and elastic recommend that the version of the server and the clients match. the client must have the same major version e.g. 2.x, or 5.x as the nodes in the cluster. clients may connect to clusters which have a different minor version e.g. 2.3.x but it is possible that new functionality may not be supported. ideally, the client should have the same version as the cluster. the transport client relies on java serialization. because of this, the major version and the vendor of the jvm used by dxp and elasticsearch must be the same. if subscription services' investigation determines that the root cause of the issue is related to a jdk mismatch, then subscription services will be limited in resolving the issue liferay connector to x-pack security elastic stack 6.x has been renamed to liferay enterprise search security in september, 2020 if subscription services' investigation determines that the root cause of the issue is related to a jvm mismatch, then subscription services will be limited in resolving the issue elastic, elasticsearch, and x-pack are trademarks of elasticsearch bv, registered in the u.s. and in other countries.;;
|
this article shows an example configuration only and assumes a familiarity with configuring liferay dxp with elasticsearch in a localon-premise deployment configuring liferay enterprise search monitoring to connect to your hosted kibana is not possible as the kibana service does not support required user settings such as url and url normally, the server's certificates in azure, aws and gcp are signed by a trusted ca thus, your jdk's default cacerts file should be enough. in case you experience connection issues nonodeavailableexception or similar try obtaining and importing the server's certificate and use it in the connector configuration in dxp not all features and configurations of elasticsearch and kibana are supported on elastic cloud. please refer to the article below for details depending on the cloud provider of your choice and your subscription method, additional restrictions may apply to your elasticsearch service deployments. please refer to the following resources to learn about which features are impacted please see this article for a technical overview of the elasticsearch connectors available for liferay dxp the patch level and marketplace versions inside the brackets indicate the versions used to create this article. please review the compatibility matrix for other compatible environments for this article, elastic cloud testing was conducted using google cloud platform and the four required analyzer plugins analysis-icu, analysis-kuromoji, analysis-smartcn and analysis-stempel on the deployment customization screen.;;
|
the purpose of this article is to clarify the compatibility of liferay dxp and the various hosted elasticsearch options available on the market liferay as an oem partner of elastic aims to provide compatibility with elastic's own elasticsearch releases and services. liferay dxp is not compatible with any other elasticsearch provider or service also applies to elastic cloud subscriptions billed through the marketplace of the available cloud providers amazon web services aws, google cloud platform gcp, microsoft azure as these elastic cloud deployments are managed through elastic's cloud console there are additional restrictions and known issues with elastic cloud to take into consideration when planning to host your elastic stack for liferay dxp on elastic cloud. please consult with the available user settings for the elasticsearch service and check liferay dxp documentation to verify there are no conflicts between the elasticsearch configuration or elasticsearch-based features available in elastic cloud and those required by liferay dxp. some liferay dxp use-cases may require configuration or features not available through elastic cloud why is elastic cloud the only service compatible with liferay dxp elastic, elasticsearch, and x-pack are trademarks of elasticsearch bv, registered in the u.s. and in other countries.;;
|
a search engine is a critical component of your liferay dxp installation. you're here, you probably know the basics already and want to configure a search engine for your liferay dxp deployment elasticsearch, a highly scalable, full-text search engine, is installed by default, as an embedded server. elasticsearch is well-supported and almost certainly meets any search and indexing need you have, but you must not use the embedded version in your production deployment learn to configure a remote elasticsearch server or cluster is another capable and popular search engine supported in liferay dxp learn to configure a remote solr server or cluster sure you understand the disparity in functionality between the supported search elasticsearch and solr are both supported, but there are limitations to to make use of some features, you must choose implementation for the following apis may be added in the future, but they are not currently supported by liferay's solr connector liferay commerce requires the termssetfilter implementation, only available another factor to consider in your search engine selection is jdk version. search engine and liferay dxp must use the same java version and distribution elasticsearch compatibility matrix liferay dxp compatibility matrix to learn more about supported jdk distributions and versions. is not necessary for solr, because no jvm level serialization happens between all communication occurs at the http level.;;
|
liferay has chosen not to individually certify openjdk binaries. the compatibility of open source jdk binaries will depend on the java technical compatibility kit tck certification of that binary. meaning, if a jdk binary is java tck compliant or certified then that binary will be compatible for use with liferay the java tck testing kit allows an organization to test their compiled java binaries and ensure the binaries comply with the java se standards. if everything passes then the organization will indicate that their binaries are compliant or certified jdk certification, java tck compliance, and liferay;;
|
"maintenance mode for a product, app or capability means we are no longer actively enhancing the product or capability with new features. maintenance mode does not necessarily mean that deprecation in a future liferay dxp version is planned for the product or capability; it only means that enhancements are not being made for the current liferay dxp development cycle liferay seeks to resolve unintended behavior with the product, app or capability in maintenance mode in accordance with the product defects support coverage. there is no support coverage difference between an item in active development and an item in maintenance mode before removal a product, app or capability should be marked deprecated for at least one liferay version. deprecation can be indicated in official documentation or the product source code. products, apps or capabilities can stay deprecated for multiple released versions until product teams are ready to remove the item. an item may be deprecated and archived within one version at the discretion of the product team from the initial version of deprecation, liferay may resolve unintended behavior within products, apps or capabilities which are deprecated on a case-by-case basis until the item is archived. for previous versions, items will receive support according to the product service life. for example, if an item was marked as deprecated with the release of liferay dxp 7.1, for liferay dxp 7.0 and below that item will receive full support coverage according to the dxp product life items which are deprecated can be released as a marketplace app. marketplace apps can also be marked as final version to indicate they are deprecated. unintended behavior for these deprecated or final version marketplace apps may be resolved on a case-by-case basis with respect to all deprecated items, liferay subscription services offers once marked as deprecated, capabilities or features can be archived. archived items are removed from a product with the next minor release non-maintenance release. archived capabilities or features are not required to be, but may be released as a marketplace app. if a capability or feature is removed from the bundle and released on liferay marketplace it is considered a deprecated app and not an archived item marketplace apps marked as final version and not released with the next minor version are considered archived liferay is not required to resolve unintended behavior or offer guidance concerning archived capabilities, features or apps. capabilities or features which have been released as a deprecated app on liferay marketplace are considered a deprecated app and not an archived item the following items were deprecated and archived, therefore removed from the release of liferay dxp 7.1. they are not available as a deprecated app on liferay marketplace. however, these specific apps will receive support coverage as a deprecated app according to the dxp 7.1 product life.";;
|
liferay marketplace is a hub for sharing, browsing, and downloading apps. marketplace leverages the entire liferay ecosystem to release and share apps in there are two ways to access the marketplace via the website using your favorite browser, navigate to the if you're new to marketplace, this is the easiest way to access it. browse marketplace without signing in with your url account via the control panel in the control panel, navigate to to view marketplace, you must sign in with your no matter how you access marketplace, you'll see the same content. download apps, you must have a url account and agree to the marketplace terms of use start with finding and purchasing the apps you want if you've used an app store before, marketplace should be familiar. apps in the center of the page, in the following sections featured apps liferay features a different set of apps each month new and interesting the latest apps added to marketplace most viewed in the past month the top 5 most viewed apps in the last month themes site templates apps that change your liferay instance's look and app categories communication, productivity, security, etc weekly stats the newest apps, latest apps updated, and trend chart for app each section's see all link shows more section info. page, you can search marketplace by category, liferay dxp version, and price. browse by category, click the categories menu at the top of the page figure 1 the liferay marketplace home page lets you browse and search for apps click an app to view its details. this includes its description, screenshots, price, latest version, number of downloads, a link to the developer's website, a link to the app's license agreement, and a purchase button labeled free or buy, you can also view the app's version history, read reviews, or write your own review the purchase button prompts you to choose a purchase type. app for your personal account, or for a liferay project associated with your if you have the necessary permissions, you can also create a new once you select a purchase type, accept the eula and terms of service, and click purchase figure 2 click an app to view its details once you purchase an app, you can download and install it warning not all apps are designed to be auto deployeddeployed while deploying that way can cause instabilities, such as class loading leaks and memory leaks. on production systems, avoid auto deploying apps whenever possible. best practices for managing apps in production an app downloads and installs immediately if you purchase it from the control if you purchase the app on the marketplace website, however, your receipt is displayed immediately after purchase. to download the app, click the see purchased button on the bottom of the receipt, and then click the app button alternatively, you can use marketplace from the control panel to download and install the app after purchase on the marketplace website. note that sometimes administrators disable automatic app installations so they can manage installations manually. in this case, marketplace apps downloaded from the control panel are placed in the deploy folder in liferay then manually install the app from this folder. manual install is also required if the server is behind a corporate firewall or otherwise lacks direct regardless of how the app is downloaded, the manual install for details, see the article installing apps important when uninstalling an app or module, make sure to use the same agent you used to install the app. for example, if you installed it with marketplace, uninstall it with marketplace. if you installed it with the file if you installed it with the app manager, however, use there are two places to manage your purchased apps your url account's home page. signing in, click the user menu at the top-right and select account home. note that your home page is distinct from your profile page. is private, while your profile page is public. apps from the menu on the left to view your projects. clicking an app lets you view its versions. can download the version of the app that you need. if you need a previous version of the app, or can't download the app from figure 3 you can manage your purchased apps from your url account's home page navigate to apps purchased to see your a button next to each app lets you install or uninstall the if the app isn't compatible with your liferay dxp version, not compatible is displayed in place of the button. notes are also shown, such as whether a newer version of the app is you can also search for an app here by project, category, and clicking the app takes you to its marketplace entry figure 4 you can also manage your purchased apps from within a running liferay instance to continue using a purchased app whose license terms are non-perpetual, you must renew your app subscription, register your server to use the app, and generate a new activation key to use on your server. click your profile picture in the upper right corner and select purchased the purchased apps page appears and shows your app icons organized by your app's details page appears select the most recent order id typically the order that has no the new app activation key to use on your server copy the activation key file to your deploy folder in your liferay home you can continue using the application on your server.;;
|
liferay support does not recommend or endorse specific third-party products over others. liferay is not responsible for any instructions herein or referenced regarding these products. any implementation of these principles is the responsibility of the subscriber this article will describe an example way to set up in tomcat without using an external server like apache. the following steps are for liferay dxp 7.3 though minor changes could be made to apply it to other versions of liferay dxp, the primary change is the contents of the tomcat's url configurations what is your first and last name what is the name of your organizational unit what is the name of your organization what is the name of your city or locality what is the name of your state or province what is the two-letter country code for this unit is cnjoe bloggs, ouliferay, oliferay inc, lchicago, stil, cus correct to do that use the following command from the same terminal as in step 3 keytool -export -alias tomcat -keypass changeit -file url -keystore keystore it is important to note that the terminal being used should be opened to the liferay bundle's tomcat folder. however the target of the command will be the jdk's cacerts file. an example keytool -import -alias tomcat -file url -keypass changeit -keystore usrlibjvmjava-8-oraclejrelibsecuritycacerts note - if this process has been completed previously the jvm may be expecting the previously used password, which may be changeit next update the tomcat's url file url with the following. as noted above the following is for the version of tomcat bundle with liferay dxp 7.3 older versions of tomcat may require different connector settings remove the following connector add the following and update the keystorefile and keystorepass values as needed to set the entire site to use set this in url url to set only the login page to be set this iin url url within an ssl production environment, if you receive a certificate error that defines your ssl certificate as not a trusted root, you may need to obtain a digital signature from a certificate authority provider.;;
|
the saml security assertion markup language adapter provides single sign on sso and single log off slo in your deployment. serves as either the service provider sp or the identity provider idp. identity provider is a trusted provider that provides single sign-on for users a service provider is a website that hosts applications and grants access only to identified users with proper credentials note a single liferay dxp instance is either the sp or the idp in your sso you can, however, use separate instances for both purposes for example, one instance is the sp and another is the idp below is background on how saml works. to jump right to its configuration, see setting up saml as an identity provider setting up saml as a service provider the instructions to make the conceptual magic from this article come to life! the 5.0.0 version of the application for liferay dxp brings some long-awaited note if you're migrating from a liferay saml adapter prior to version 3.1.0, your portal properties are automatically migrated to system settings configurations. article for details on settings for reference, here are a few important saml paths this url is the default location of the metadata xml file note that when configuring saml, no importing of saml certificates is required. liferay dxp reads certificates from the saml metadata xml file. third-party application like salesforce to read a liferay saml certificate, you can export the liferay dxp certificate from the keystore. both the idp and the sp can initiate the single sign on process, and the sso flow is different depending on each one. regardless of how it's initiated, sso is configured for between the sp and idp, so all transport-level saml requests are signed using certificates configured in liferay dxp, using the saml web browser sso profile as defined in cases, responses are sent using or preferred because it reduces the risk that the url is too long for a browser to consider idp initiated sso first sometimes a user enters the sso cycle by sending a request directly from the figure 1 identity provider initiated sso if liferay dxp is the idp, the idp initiated sso url for non-liferay dxp idps siteminder, adfs, etc., consult the vendor's documentation on constructing idp initiated sso urls if the idp determines that the user isn't authenticated, it prompts the user with the appropriate login screen upon successful authentication, the idp constructs a saml response. attribute statements configured in the designated service provider connection on setting up the spc in liferay dxp's saml adapter the idp sends the response to the assertion consumer service url. contains two parameters samlresponse and relaystate note the method for sending the saml response for example, and the assertion consumer service url are usually imported as part of the saml metadata xml provided by the sp. in liferay dxp, you import the sp's metadata in the saml adapter's service provider connections tab the sp validates and processes the saml response. requires signed samlresponse messages. this signature process ensures proper identification for the idp and prevents potential saml response spoofing if a relaystate is included in the saml response, the user is redirected to otherwise the home page of the sp is served most of the time, authentication requests come from the service provider figure 2 service provider initiated sso when the user's browser requests a protected resource or login url on the sp, it triggers the sp initiated sso process. when liferay dxp is the saml sp, sso is initiated either by requesting cportallogin url or a protected resource that requires authentication for example, a document not viewable by the guest if the user requests a protected resource, its url is recorded in the if the user requested cportallogin, the relaystate can be set by providing the redirect parameter. url is set to true, the last accessed path is set as for non-liferay dxp sps, consult the vendor documentation on the sp looks up the idp's single sign on service url and sends an when liferay dxp is the sp it looks up the configured saml identity provider connection and sends a saml authnrequest to the idp's single sign on service url as defined in the saml metadata xml document. sending and receiving the authnrequest using or if the user doesn't have an active session or if forceauthn was requested by the sp, the user must authenticate by providing credentials. the idp, authentication occurs in the login portlet. verifies the authnrequest before requesting the user to authenticate after authentication, a saml response is constructed, sent to the assertion consumer service url of the sp, and verified. the idp automatically makes this choice based on the sp metadata when liferay dxp is configured as the idp, any attributes configured on the service provider connection are included in the response as attribute statements. assertion consumer service url is looked up from the saml metadata xml of the when liferay dxp is configured as the sp, response and assertion signatures are liferay dxp requires the sender to be authenticated. whole message signature from the issuing idp. signature are considered unauthenticated and the response is rejected. non-liferay dxp sp or idp vendors, consult their documentation the user is redirected to the requested resource or to the url contained in the relaystate parameter for example, the last page the user accessed before the single log off request is sent from the user's browser to the idp or an sp, and the slo flow differs in each case. figure 3 identity provider initiated slo an idp initiated slo request is sent directly to the idp by the user's browser. when liferay dxp is the idp, the idp initiated sso url must specify the url if the user is signed on to any configured sp, the saml plugin takes over the logout process, displaying all the signed on services. displays the authentication status of each sp and whether any sps can't be logged out of for example, if the sp is down or doesn't support slo. non-liferay dxp idps siteminder, adfs, etc. consult the vendor's documentation on constructing idp initiated slo urls the idp sends a saml logoutrequest to the sp the sp delivers a logoutresponse to the idp the idp sends a saml logoutrequest to the second sp the second sp then delivers the logoutresponse to the idp. repeated for all sps the user is logged into. liferay dxp logs the user out after the last sp has delivered its logoutresponse figure 4 service provider initiated slo in sp initiated slo, the user's browser sends a logout request directly to the when liferay dxp is configured as the sp, the slo is initiated by requesting for other sps, consult the vendor's documentation on initiating slo a saml logoutrequest is sent to the single log out service url of the idp if liferay dxp serves as the sp, the logoutrequest is sent to the idp configured by the idp connections tab of the saml provider see the next to set up the idp connection and the slo service url defined in the saml when liferay dxp is the idp, if the user has logged on to other sps, the user is presented with a single logout screen with the status of each sp logout, flagging any that can't be looged out of some sps might not support slo or if there are no other sps to log out of, the saml session terminates and the idp destroys its session if the user is logged in to additional sps beyond just the initiating sp, the idp sends the saml logoutrequest to each one. when liferay dxp is the idp, the logoutresponse is sent using either or soap binding each sp delivers its logoutresponse to the idp. when liferay dxp is the sp, the logoutresponse is sent using either or direct after all additional sps deliver their logoutresponse s to the idp, the idp when liferay dxp is the idp, once the last sp has delivered its logoutresponse or has timed out, the idp destroys the liferay dxp finally, the idp sends a logoutresponse to the sp that initiated slo. initiating sp terminates its saml session and logs the user out.;;
|
learn how to set up liferay developer studio for liferay dxp so you can start developing;
|
a liferay workspace is a generated environment that is built to hold and this workspace is intended to aid in the management of liferay projects by providing various build scripts and configured cli for workspace, initialize a new liferay workspace, and download dev studio dxp liferay workspace is the official way to createmanage liferay dxp 7.2 projects you'll cover the following topics in this section liferay workspaces can be used in many different development environments, which makes it flexible and applicable to many different developers. liferay workspace easily integrates with eclipse and intellij, providing a seamless development experience. a liferay workspace for more information you'll learn about workspace's anatomy and development lifecycle next a liferay workspace offers a development environment that can be configured to properties are available to help manage default and this provides you the power to customize your workspace's folder structure any way you'd like. the top-level filesfolder of a liferay gradle workspace are outlined below if you're using a workspace generated for maven projects, your folder hierarchy is the same, except the gradle build files are swapped out for a url file visit your workspace's url file for a list of properties with descriptions you can define to adapt your workspace. if you'd like to keep the global gradle properties the same, but want to change them for yourself only perhaps for local testing, you can override the url file with your own url file next, you'll learn about workspace's development lifecycle liferay workspaces offer a full development lifecycle for your projects to make your liferay development easier than ever. the development lifecycle includes you'll learn about each lifecycle option next that you can use to create many different types of liferay projects. also provides development support for front-end portlets generated with the they're stored in the modules folder by default you can also configure where to generate certain projects modules, themes, these settings are documented in the url file. liferay workspace manages theme projects in two separate folders based on how liferay workspace offers an environment where developers can use the liferay theme generator to create themes and their work can be seamlessly integrated into their overall devops strategy. you can leverage the liferay theme generator create url themes inside workspace or you can leverage it externally and copy themes into workspace traditional java-based theme approach leveraging gradlemaven for those that can't use the liferay js theme toolkit's tools in their ci environment liferay workspace abstracts many build requirements away so you can focus on developing projects instead of worrying about how to build them. incorporating a slew of plugins under the hood to allow for easily sections for information on some of the plugins provided by workspace gradle-based workspaces also include a gradle wrapper in its root folder e.g., gradlew , which you can leverage to execute gradle commands. you can run familiar gradle build commands e.g., build, clean, compile, etc. from a liferay workspace without having gradle installed on your machine. for maven-based workspaces, maven build commands are supported e.g., package, liferay workspace lets you build your projects out-of-the-box without the hassle liferay workspace provides easy-to-use deployment mechanisms that let you deploy your project to a liferay server without any custom configuration. about deploying projects from a workspace, visit the liferay provides many configuration settings for liferay dxp 7.2. several different liferay dxp installations to simulatetest certain behaviors can become cumbersome and time consuming. with liferay workspace, you can easily organize environment settings and generate an environment installation with liferay workspace provides the configs folder, which lets you configure different environments in the same workspace. for example, you could configure separate liferay dxp environment settings for development, testing, and production the configs folder offers six subfolders common holds a common configuration that you want applied to all dev holds the development configuration docker holds the configuration for a docker container local holds the configuration intended for testing locally prod holds the configuration for a production site uat holds the configuration for a uat site you're not limited to just these environments. you can create any subfolder in the configs folder e.g., aws, test, etc. to simulate any environment. each environment folder can supply its own database, url, elasticsearch, etc. the files in each folder overlay your liferay dxp installation, which you generate from within workspace figure 1 the configscommon and configsenvironment overlay you liferay dxp bundle when it's generated when workspace generates a liferay dxp bundle, these things happen configuration files found in the configscommon folder are applied to the the configured workspace environment dev, local, etc. is applied on top of any existing configurations from the common folder setting environment configurations for liferay workspace liferay workspace does not provide a built-in release mechanism, but there are easy ways to use external release tools with workspace. is uploading your projects to a maven nexus repository. uploading projects to a remote repository is useful if you need to share them with other non-workspace projects. also, if you're ready for your projects to be in the spotlight, uploading them to a public remote repository gives other developers the chance to use them for more instructions on how to set up a maven nexus repository for your deploying liferay maven artifacts to a repository;;
|
in this tutorial, you'll learn how to generate a liferay workspace using liferay dev studio gives you a graphical interface instead of the command prompt, which can streamline your workflow. workspaces, visit its dedicated before creating your liferay workspace, you should understand the new perspectives designed for liferay dxp development the liferay workspace and if you plan on using a liferay workspace for your liferay dxp development, you should select the liferay workspace this offers development tools that are helpful when using the liferay plugins perspective is for developers using ant-based development tools such as the plugins sdk. only provided for liferay portaldxp 7.0 and older development, this should not be used for liferay dxp 7.1 development figure 1 by selecting liferay workspace, you begin the process of creating a new workspace for your liferay projects a new liferay workspace dialog appears, presenting several configuration follow the instructions below to create your workspace give your workspace project a name choose the location where you'd like your workspace to reside. use default location checkbox places your liferay workspace in the eclipse select the build tool you want your workspace to be build with i.e., gradle choose the liferay dxp version you plan to develop for i.e., 7.1 or 7.0 select the specific target platform version corresponding to the ga release you're developing for e.g., 7.1.0 7.1 ga1. target platform benefits, see the managing the target platform for liferay workspace check the download liferay bundle checkbox if you'd like to auto-generate a liferay instance in your workspace. you'll be prompted to name the server and provide the server's download url, if selected. generated the same way as described in the previous section note if you'd like to configure a pre-existing liferay bundle to your workspace, you can create a directory for the bundle in your workspace and configure it in the workspace's url file by setting the check the add project to working set checkbox if you want the workspace to be a part of a larger working set you've already created in dev studio. for more information on working sets, visit click finish to create your liferay workspace figure 2 liferay dev studio provides an easy-to-follow menu to create your liferay workspace a dialog appears prompting you to open the liferay workspace perspective. click yes, and your perspective will switch to liferay workspace note you can also create a liferay workspace during the initial start-up of you've successfully created a liferay workspace in dev studio! the liferay workspace perspective is intended for gradle or maven projects for since liferay workspaces are used for gradlemaven based development and the liferay plugins perspective is intended for the plugins sdk and ant based development, the two perspectives are independent of each other figure 3 the liferay workspace perspective is preferred for liferay dxp 7.1 and osgi module development you'll find your new workspace in the project explorer and your liferay server if you created it in the servers menu. it's important to note that an eclipse workspace can only have one liferay workspace project figure 4 a dev studio workspace only supports one liferay workspace project. if you create another, you'll be given an error message you can configure your workspace's module presentation by switching between the default hierarchical or flat views. to do this, navigate to the project select projects presentation and then select the presentation mode you'd like the hierarchical view displays subfolders and subprojects under the workspace project, whereas the flat view displays the workspace's modules figure 5 the hierarchical project presentation mode is set, by default if you've already created a liferay workspace and you'd like to import it into your existing dev studio, you can do so by navigating to file import browse for your workspace project. once you've selected you workspace, click figure 6 you can import an existing liferay workspace into your current dev studio session you've learned how to create and configure a liferay workspace now that your workspace is created, you can begin your browser does not support the video element.;;
|
"liferay dev studio dxp is a plugin for eclipse that provides many liferay-specific features and additional enterprise only features. existing eclipse environment, or liferay provides a bundled version. beginning the installation process, view dev studio's to get acquainted with its supported liferay versions and application servers in this tutorial, you'll learn the different methods available for installing environment, you must be on eclipse oxygen or newer. upgrading to oxygen, see eclipse's with this particular upgrade, you should also deactivate the current available available software sites menu to ensure a successful upgrade e.g., neon so you'll need it to run everything else. because you'll be developing apps for liferay dxp in liferay dev studio, the java development kit jdk is required. it is an enhanced version of the java environment used for developing new you can download the java se jdk from the java download liferay's latest 3.2.x project sdk with dev studio dxp executable that correlates to your operating system. you may be prompted for your url username and password before downloading the dev studio dxp installer. since dev studio dxp includes access to liferay dxp, you must verify that you have rights to use it your credentials are not saved locally; they're saved as a token in the the token is used by your dev studio's if you ever decide to redownload a liferay dxp bundle. liferay dxp bundle that was downloaded in your workspace is also copied to your url folder, so if you decide to initialize another liferay dxp instance of the same version, the bundle is not re-downloaded. adding a liferay bundle to a workspace for more information on this topic important the token generator sometimes has issues generating a token for workspaces built behind a proxy. if you're unable to automatically generate a workspace token, you can you may need to allow permission for the installer to run, depending on your operating system and where you want to install it select the java runtime to use for the installation process. click next to begin the installation process. folder for your liferay dev studio instance. figure 1 choose the folder your dev studio instance should reside input the liferay dxp activation key to set up the liferay dxp bundle packaged by default, which is a developer environment used to build and manage the installer automatically installs liferay workspace and its dedicated command line tool behind a firewall, you may want to configure the proxy settings. tutorials for more information. skip this step if you don't need this figure 2 configure your project sdk's proxy settings, if necessary click next to finish the installation process for your dev studio instance you've installed liferay dev studio dxp! to run dev studio, execute the developerstudio a liferay workspace has also been initialized in that same folder to install dev studio using an update url, follow these steps in eclipse, go to help install new software... in the work with field, copy in the url you'll see the dev studio components in the list below. accept the terms of the agreements. like other eclipse plugins, you must restart eclipse to use them liferay dev studio is now installed in your existing eclipse environment to install dev studio using a zip file, follow these steps from the drop-down menu, select developer studio updatesite in the add dialog, click the archive button and browse to the location of the downloaded liferay dev studio update site.zip file. figure 3 make sure to check all the dev studio components you wish to install accept the terms of the agreements and click next, and developer studio is you've installed liferay dev studio in your existing eclipse environment if you run into any issues with generating your token automatically, you can follow the steps below to manually create one navigate to url and log in to your hover over your profile picture in the top-right corner and select account select account settings from the left menu click authorization tokens from the right menu under the miscellaneous figure 4 you can manually create your workspace token in the authorization tokens menu select add token, give it a device name, and click generate. name can be set to any string; it's for bookkeeping purposes only create a file named url and copy the generated token into figure 5 the generated token is available to copy make sure there are no new lines or white space in the file. you've successfully generated your token manually and it's now available for if you haven't run the installer, you can do so now. if you've already run the installer, you can set the dxp bundle to download in the url file of your workspace.";;
|
the products, accounts, orders, warehouses entities now support nested fields, which means that requests to the get endpoints of these entities will return just the root object, instead of the root object and the nested entities would have previously produced a response like this starting with commerce 2.0.7, a response like this will now be produced it is also now possible to make the endpoint load the nested fields with the query parameter nestedfields valorized with the name of the desired nested property will produce a response like this finally it is also possible to request a list of desired nested properties to be loaded within the same request for example a request like this will now load both images and categories for the products the following are the supported nested properties for each entity that supports this mechanism.;;
|
there are multiple different settings used to set the language preferences for our web pages. what language is finally used when a user visits the site if url is set in url, liferay will use preferred languages defined in the user's browser according to the configured order, selecting the first one available on the current site. for example, the user's browser has two preferred languages, czech and spanish. if your site's available languages do not include czech, then spanish is used. in the event that the browser only has one preferred language that is not available on your site czech, in this example then it will jump directly to the default language defined in instance settings please note that the language used is stored in the guestlanguageid of the browser cookies. unless you delete them manually, it will be used for subsequent requests.;;
|
see breaking changes article for more information and affected properties;
|
while it is our hope that the naming conventions for liferay releases would be mostly self-explanatory, this guide is provided to help explain the various elements you see within the release names the diagram below explains the elements in the naming of fix packs for dxp 7.1 note for dxp 7.0 fix packs, release names contain de instead of dxp. for information on the security fix pack naming conventions, please see dxp security fix packs the diagram below explains the elements in the naming of service packs for dxp 7.1 note for dxp 7.0 service packs, the names also include digital-enterprise after dxp and before the the naming convention for community edition ce follows closely with that of service packs. see the example below which highlights the elements in ce releases that differ from service packs for more information on fix packs and service packs liferay patching overview;;
|
these articles show you how to monitor liferay dxp. such as java memory heaps, garbage collection, database connection pools, and the application server helps you optimize performance. better tuning and thus avoids dangerous runtime scenarios like out of memory you'll learn basic monitoring techniques, such as read on to learn more about monitoring liferay dxp!;;
|
in this section, you will learn more about how to monitor liferay dxp. vital statistics such as java memory heaps, garbage collection, database connection pools, and the application server itself means that administrators are able to optimize how liferay dxp runs. better monitoring means better tuning and thus avoids dangerous run time scenarios like out of memory failures and you'll learn basic monitoring techniques, such as read on to learn more about monitoring liferay dxp!;;
|
after a thorough evaluation, liferay has decided to deprecate the following features in the lcs platform on url these features have been discontinued. to view previously recorded metrics, you can request copies of the historic data recorded for your connected servers from liferay support what are your alternatives if you have been using these features to monitor the health of your liferay instances liferay support does not recommend or endorse specific third-party products over others. liferay is not responsible for any instructions herein or referenced regarding these products. any implementation of these principles is the responsibility of the subscriber to prepare a replacement, we recommend that you evaluate your monitoring needs and select an appropriate alternative as page analytics and snapshot metrics are no longer available in lcs, liferay dxp will not provide out-of-the-box monitoring features. on the other hand, you can choose from a variety of third-party tools to monitor liferay dxp instances for basic monitoring, consider keeping track of garbage collection, jvm performance, database connection pools, and application server threads. in liferay help center, you can find an introduction into basic monitoring using the visual vm tool advanced monitoring is required when looking for more detailed and more extensive information on the entire liferay dxp stack web server, browser, application server, and database dynatrace is an application performance management apm tool that can be used with a pre-configured profile, custom-tailored for liferay dxp environments the liferay dxp fastpack. with many dashboards out-of-the-box, and more dashboards included after deploying the fastpack developed for liferay dxp, dynatrace provides many advantages as an advanced monitoring tool this article mentions two options that you have at your disposal to monitor the health of your liferay dxp instances. depending on the liferay project's needs, its setup or the team's experiences, other tools may be a better fit for more information about performance monitoring guidance, please speak with your account executive or customer experience manager lcs admins may notice the following changes have been made to the lcs platform website official documentation - introduction to monitoring liferay dxp, by version;;
|
liferay does not endorse or support any specific third-party technologies. while we are not able to make changes or fixes for issues arising from third-party technologies, the following is presented as an attempt to provide some possible workarounds. any implementation of these workarounds are at your own discretion.;;
|
can the email notification that is sent for new form submissions be edited? additionally, when a form is submitted with uploaded files, can the email notification be configured to include those files as attachments to the email form submission email can't be updated the forms portlet doesn't currently provide a way ootb to edit the email template used to send notifications for new form submissions. t he template associated with this email is static in the forms code, hence there is no ui extension point to change it there are active feature requests regarding this functionality, which you can vote to see in a future release however, if it is necessary for you to change this email template, then you will need to customize the forms code following the instructions available on this article files uploaded through the upload field dxp 7.1 only on forms can't be sent as attachments on the notification email t he emails sent by portal are primarily intended to notify users about updates on the portal-side for example a new web content was created, an update on the date time of a calendar event, etc. this is the intended behavior of the email notifications feature and not intended to create an alternative way of accessing the content from those creationupdate events there is an active feature request regarding this functionality, as well, which you can vote to see in a future release;;
|
first, you will need to create a liferay module fragment, using the url osgi bundle as host. the purpose of this fragment is to export the internal package url, so you can extend the class responsible to send the email notification, and to store your new custom email template you can store your template on the next paragraph's module too, just be mindful of which class loader you should use to retrieve that resource and if that osgi bundle is providing that capability code example of a fragment's url file, using liferay dxp 7.3 ga1 once you have that created, go ahead and put your custom email template inside of your fragment's srcmainresourcesmeta-inf folder make sure to not use the same qualified path as the host's template. osgi is designed in a way that it first looks for resources inside the host before going through its fragments image example of custom email body template with that fragment completed, you can now create a new liferay service module. inside this module, you'll have a new class that should extend ddmformemailnotificationsender. set your new extension as an osgi component for the service url and bump the service ranking, so, whenever you startup your server, you guarantee that your custom service will have priority over liferay's remember that hot deploying the module may cause references to point to the default service code example of a custom ddmformemailnotificationsender service configuration now it's just a matter of customizing what you need in your custom service i.e. changing the template path. however, you might notice that just overriding the method gettemplateresourcestring templatepath from the super class to hardcode the template path and change the getclass call to url, in order for your customization to find the template from the correct class loader, won't work code this won't work on its own you'll encounter many nullpointerexceptions during execution if you try to fix one after the other. this happens because the super class methods use several liferay services that were not yet referenced in your custom extension by the time you first deployed it. therefore, you will need to reference those services and override all the methods that use them beforehand code services used in ddmformemailnotificationsender that need to be referenced by your service after that, you should be able to receive your custom email notifications you might want to speed up your development time, so a good tip is to copy the entire super class and paste it in your extension. just keep an eye on getclass calls that need to be pointing to the super class and on the private constant templatepath that needs to be pointing to your custom template path code example of getclass call in the original class that need to be replaced with url when copied to your custom one code original value of templatepath constant using soy template language and liferay's built-in template processing api, you don't need to compile your.soy file, since it's done during runtime. therefore, you can leave that out of your compiling script code if you use gradle, you can add this to your fragment's url file if you're using liferay workspace to develop your project, only set your service module url's import-package header if you intend to manually declare all the necessary packages in your bundle code example of a service module's url file that should work. bndtools automatically sets the import-package header in the final manifest.mf when you don't declare it;;
|
liferay dxp 7.2 service pack 1 sp1 includes changes that further improve data consistency within the liferay platform mvcc is a concurrency control method that helps provide better data consistency liferay's mvcc strategy utilizes hibernate's optimistic locking system to preserve data integrity during concurrent data modifications to implement mvcc, an additional column to track versioning was added to some tables in the database. the impacted tables are listed here liferay's service builder allows for services to easily implement mvcc the mvcc changes that are being implemented fit within our blue-green deployment strategy. therefore, applying this update should require zero downtime with this update, additional liferay services now will have mvcc enabled in order to support mvcc, new columns were added to some tables in the database. again, these changes are additive and will not break compatibility with existing code note mvcc may reveal concurrency bugs in customizations that are using these additional liferay services. for a list of impacted services and sample code which may guide you toward a resolution please see the following article a staleobjectstateexception is thrown when using a liferay service to apply these improvements to your liferay instance, please refer to our guide on running the database upgrade tool for your 7.2 sp1 update note after installing this service pack, the database upgrade tool will no longer be needed to apply updates that fit within the blue-green deployment strategy.;;
|
blue-green is a deployment technique in which you duplicate your production environment the blue environment and modify the duplicate the green environment with software and data changes. when you've successfully tested the green environment, you cut users over from the blue environment to the green blue-green eliminates system down time data schema and data changes require special attention. data schema changes that break compatibility with existing code must be introduced over several releases in which the data is transitioned and maintained in old and new columns until the old columns are unnecessary data and schema changes require these steps copy the data to the new column maintain both columns until the old column is no longer used by any cluster delete the column in the next release for more information, refer to these blue-green deployment articles implementing blue-green deployments with aws;;
|
a service's global information applies to all its entities. the default dependency injector is this makes service builder work consistently the way other modules do. versions of liferay used spring. the only difference is how you inject the declarative services dependency injector important when a project is created using the the declarative services dependency injector and its dependencies are configured for the project by default. dependency injector instead, create the project using the service builder template and the --dependency-injector spring option note prior to liferay dxp 7.2, spring was the sole dependency injector. spring beans referencing each other for example, spring bean a has a spring when spring is the dependency injector, the base services service builder generates include local service and persistence fields this causes circular references. declarative services doesn't accommodate circular references, service builder does not create these fields in the base classes when ds is the dependency the package path specifies the package where the service and persistence the package path for guestbook ensures that the -api module's service classes are generated in the url package. the persistence classes are generated in a package of the same name in the the service-builder element's mvcc-enabled attribute is false by default. mvcc for all of the service's entities. in systems, concurrent updates are without mvcc people may read or overwrite data from an invalid state with mvcc, each modification is made upon a given base version when hibernate receives the update, it generates an update sql statement that uses a where clause to make sure the current data version is matches the expected version, your data operation is based on up-to-date doesn't match the expected version, the data you're operating on is liferay dxp rejects your data operation and throws an exception, which you can catch to help the user handle the exception e.g., suggest important enable mvcc for all your services by setting service entity updates e.g., url , make sure to do so propagate rejected transactions to the ui for the user to service builder names the database tables using the service namespace. example, gb could serve as the namespace for a guestbook application service builder uses the namespace in the following sql scripts it generates in your srcmainresourcessql folder note the generated sql script folder location is configurable. example, if you're using gradle, you can define the sqldir setting in the project's gradle url file or maven url file, the same way the databasenamemaxlength setting is applied in the examples below service builder uses the sql scripts to create database tables for all the the database table names have the namespace prepended when they are created. since the example namespace value is gb, the database table names created for the entities start with each service builder project's namespace must be separate plugins should use separate namespaces and should not use a namespace already used by liferay entities such as users or groups . check the table names in liferay's database to see the namespaces already in warning use caution when assigning namespace values. strong restrictions on database table and column name lengths. plugin parameter databasenamemaxlength sets the maximum length you can use for here are paraphrased examples of setting databasenamemaxlength in build files as the last piece of global information, enter your name as the service's service builder adds annotations with the specified name to all the java classes and interfaces it generates. next, you'll add entities for your services.;;
|
after installing liferay dxp 7.2 service pack 1 or fix pack 2 a staleobjectstateexception is generated when a customization uses a liferay service to update or modify data a staleobjectstateexception is commonly thrown by hibernate when stale data is detected, such as when conflicting modifications are encountered general pattern if you update a model, but don't re-capture the return value, future updates to that same model, even within the same thread, may result in a staleobjectstateexception. to resolve this, make sure to store the return value of any methods that update the object example if you fetch a variable and then update it multiple times within different methods, this may also result in a staleobjectstateexception. this pattern often spans multiple classes something updated in one class's instance method is never returned, so another class never knows about the update. to resolve this, make sure that any method that updates a model object also returns that model object example if you fetch a variable and then store it in a shared memory location such as the or an internal cache of frequently accessed objects, this shared memory location may not know about any updates, which may also cause a staleobjectstateexception. to resolve this, you would make sure to reset the value in the shared location any time an update occurs additional examples from liferay source lps-86385 and lps-86695 as of liferay dxp 7.2 service pack 1 or fix pack 2, additional liferay services now have mvcc enabled liferay's mvcc implementation relies on hibernate's optimistic locking system. with this mechanism in place, modifications that hibernate identifies as conflicting will be revealed below is a list of additional liferay services that now have mvcc enabled;;
|
this article is intended to provide a list of all the liferay dxp 7.2 properties that can be used to connect the database of your choice to your liferay dxp 7.2 installation. to use any of them, uncomment the block of code you need, and paste it into your url file for example, to enable mysql, you should copy and paste the below into your url replace the connection settings in url with the name of your database replacing lportal, and inserting the username and password of your intended database user in the appropriate properties;;
|
this article aims to answer basic questions around how indexing works in liferay dxp. this information is applicable for all search platforms whether using elasticsearch, solr, or some other search. for a full developer's treatment of developing for the index, please see introduction to search liferay stores its information in a database, so why not search the database directly? why add the complexity of a search engine? first, because database table merges are expensive! documents in a search index often contain searchable fields from multiple tables in the database. traversing the date in this way takes too long in addition to the performance problem, search engines provide access to additional features, like relevance and scoring. by contrast, databases do not support features like fuzzy searching or relevancy. moreover, search engines can apply algorithms such as more like this to return similar content. search engines also support geolocation, faceting of search results, and multilingual searching here are the dxp entities that utilize search index out of the box to index custom entities, read the initial search index is initialized for each virtual instance the first time you start dxp with elasticsearch or solr. to fully index all entries you need to perform a reindex from the control panel see below by default, the search index is updated every time an indexable entity is there's a number of reasons you may need to create a new index from scratch. whether it's following an upgrade or it's just that the search isn't pulling up the correct results, we've made it simple to delete the existing index and create a new one please note that, depending on how many entities there are, the reindexing may be a time and memory-intensive operation. please plan the timing of your reindex accordingly we have documented exactly how a developer would do that in this article indexing framework;;
|
unless you're searching for model entities using database queries not recommended in most cases, each asset in liferay dxp must be indexed in the the indexing code is specific to each asset, as the asset's developers know what fields to index and what filters to apply to the search in past versions of liferay dxp, when your asset required indexing, you would implement a new indexer by extending composition instead of inheritance. if you want to use the old approach, feel free to extend baseindexer. liferay's original search api was built around the lucene search and indexing to this day, familiarity with lucene will jump-start your understanding however, starting with the 7.0 version of liferay dxp, the search api is being reworked, so that the parts closely tied to lucene are elasticsearch support was added in addition to solr, and most of the newer searching and indexing apis aim to leveragemap this means that in many cases for example the query types there is a one-to-one mapping between the liferay and elasticsearch apis in addition to the elasticsearch centered apis, liferay's search infrastructure includes additional apis serving these purposes to understand how search and indexing code makes your custom models seamlessly searchable, you must know how to influence each portion of the search and model entities store data fields in the database. during the cycle's indexing step, you prepare the model entity to be searchable by defining the model's fields that are sent to the search engine, later used during a search to control how model entity fields are indexed in search engine documents, classes specify which database fields are indexed in the model entity's search this class's contribute method is called each time the add and update methods in the entity's service layer are called classes configure the re-indexing and batch re-indexing behavior for the model this class's method is called when a re-index is triggered from the search administrative application found in control panel configuration search, or when a crud operation is made on the entity, if the modelindexed method is implemented in your contributor documentcontributor classes without any url component property or type parameter contribute certain fields to every index document, regardless of what base entity is being indexed. contributes the groupid and scopegroupid fields for all documents with a backing entity that's also a groupedmodel searches start with a user entering keywords into a search bar. keywords are processed by the back-end search infrastructure, transformed into a query the search engine can understand, and used to match against each search to control the way model entity documents are searched, classes contribute clauses to the ongoing search query. time and ensures that all the fields you indexed are also the ones searched. for example, if you index fields with the site locale appended to them titleenus, for example, you want the search query to include the same locale when the document is searched. if the search query contains another locale like titleeses or searches the plain field title , inaccurate to contribute query clauses to every search, regardless of what base entity is being searched, implement a keywordquerycontributor class registered without control how search results are filtered before they're returned from the search for example, adding the workflow status to the query ensures that an entity in the trash isn't returned in the search results to contribute filter clauses to every search, regardless of what base entity is queryprefiltercontributor is constructed only once under the root filter what's the difference between queryprefiltercontributor and queryprefiltercontributor is constructed only once under the root filter during a search, while modelprefiltercontributor is constructed once per model entity, and added under each specific entity's when a model entity's indexed search document is obtained during a search request, it's converted into a summary of the model entity to control the result summaries for model entity documents, classes get the summary object created for each search document, so you can manipulate it by adding specific fields or setting the length of the displayed classes control the visibility of model entities that can be attached to other asset types for example, file entries can be attached to wiki pages, in the one important step must occur to make sure the above classes are discovered by to register model entities with liferay's search framework, to define certain things about your model entity's which fields are used by default to retrieve documents from the search engine, and which optional search services are registered for your entity. occurs as soon as the component is activated during portal startup or if you're used to the old way of indexing custom entities extending baseindexer, the abstract implementation of indexer , the table below provides a quick overview about how the methods of the indexer interface were decomposed into several new classes and methods in addition, you can index expandobridge attributes. accomplished in baseindexer's getbasemodeldocument. in previous versions of liferay dxp, search was only permissions aware indexed with the entity's permissions and searched with those permissions intact if the application developer specified this line in the now, search is permissions aware by default if the new permissions approach, is implemented for an application having entities translated into database entities and search engine documents means that there's a possibility for a state mismatch between the database and for example, when a blogs entry is added, updated or removed from the database, corresponding changes must be made in the search engine. this, intervention must be made into the service layer. entities, this occurs in the localserviceimpl classes. it takes a type property that can have two commonly, a deleteentity method in the service the annotation is executed by liferay's spring infrastructure, so if you have a method with that annotation, you must call it using a service instance variable with the spring wrapped logic. default in service builder generated localserviceimpl classes because of this declaration in the parent localservicebaseimpl this means that in the localserviceimpl, you must not call the annotation won't be executed and you'll be left with a state mismatch between the search engine document and the database column. pattern in liferay dxp's code, using the service instance variable to call service for step-by-step instructions on indexing model entities, visit the search and indexing section of the developing a web application tutorials.;;
|
liferay stores its information in a database, so why not search the database why add the complexity of a search engine? documents in a search index often contain searchable fields from multiple tables in the database. traversing the date in this way in addition to the performance problem, search engines provide access to additional features, like relevance and scoring. support features like fuzzy searching or relevancy. apply algorithms such as more like this to return similar content. engines also support geolocation, faceting of search results, and multi-lingual this section contains information on extending liferay's search functionality, enabling your custom entities to be indexed and searched in liferay dxp, and configuring the developer-friendly embedded elasticsearch server to suit your first, some basic search concepts indexing during indexing, a document is sent to the search engine. document contains a collection of fields of various types string, etc.. search engine processes each field within the document. search engine determines whether it needs to simply store the field or if it needs to undertake special analysis index time analysis. can be configured for each field see mapping definitions for fields requiring analysis, the search engine first tokenizes the value to obtain individual words or tokens. following tokenization, the search engine passes each token through a series of analyzers. some remove common words or stop words e.g., the, and, or while others perform operations like lowercasing all characters searching searching involves sending a search query and obtaining results a.k.a. hits from the search engine. the search query may be comprised of both queries and filters more on this later. each query or filter specifies a field to search within and the value to match against. search query, the search engine iterates through each field within the nested during this process, the engine may perform special analysis prior to executing the query search time analysis. analysis can be configured for each field see mapping definitions search engines are semi-intelligent, automatically deciphering how to process documents passed to them. however, there are instances where it's desirable to configure explicitly how to process a field mappings control how a search engine processes a given field. if a field name ends in eses, we want to process the field values as spanish, removing any common spanish words like si in elasticsearch and solr, the two supported search engines for liferay portal, mappings are defined in url and url, the elasticsearch mapping json file can be seen in the liferay dxp in the portal-search-elasticsearch6 module the solr url can be seen in the portal-search-solr7 module's source code access the solr 7 module's source code from the liferay-portal repository these are default mapping files that are shipped with the product. further customize these mappings to fit your needs. to use a special analyzer for a custom inventory number field search engines already provide native apis. why does liferay provide search infrastructure to wrap the search engine? liferay's search infrastructure does index documents with the fields liferay needs entryclassname, apply the right filters to search queries e.g., for scoping apply permission checking on the results that's just a taste of liferay's search infrastructure.;;
|
the patching tool's separate command helps reduce the patched liferay dxp installation size. if the installation has been patched, you can make it smaller by moving the restore files out of it. the separate command is also used to create slim bundles this command produces a liferay-patching-files-separation-name.zip file in the patching tool's patches folder. it contains the necessary files and metadata for patching, verification, and validation. once you create this file, the patch files are removed from their default location and are now only available in this file. you can store this file elsewhere to reduce your installation's size warning if the product is separated from its patches in this way, you cannot run most of the patching tool commands until the patches are restored after the separation process only the following commands can be used any other command returns this when you need to patch liferay dxp again, you must restore the separated patch artifact. to do this, copy the liferay-patching-files-separation-name.zip back to the patching tool's patches folder and run patching-tool setup command the command finds the necessary patching artifact and restores the patch files to the installation. after that, the patching tool works like it did prior to separating the patches see also patching a slim bundle;;
|
starting in september of 2019 there will be an additional option to download slim bundles. slim bundles will be released for every fix pack and every service pack slim bundles are the very same code base as traditional bundles. however, they are one third of the traditional bundle in size because the patch source and patching information has been removed. slim bundles are recommended for demos and installations where disk space is limited or costly, making them ideal for cloud or container environments warning if you are using a slim bundle, you cannot run most of the patching tool commands until the patches are restored after creating the slim bundle only the following patching tool commands can be used slim bundles are created by using the patching-tool separate command. general fix pack installations can also be made slim using this same command. the patching-tool installs a patch using the patch file e.g. url or url and creates a url in the process. these files are necessary for the patching-tool to make any patch changes. the patching-tool separate command removes the url and the patch source placing them in a liferay-patching-files-file-name.zip file. removing these files reduces the size of the bundle slim bundles can still be patched, but requires the extra step of restoring the patch and patching files. the patching files for fix pack and service pack bundles are also made available with the release of the slim bundle;;
|
when attempting to patch a slim service pack bundle or slim fix pack bundle the following error is generated a slim service pack or slim fix pack bundle does not include the patching files necessary to change the fix pack level. restoring the patching files will make it possible to change the fix pack level or install a hotfix slim service pack or slim fix packs are the very same code base as traditional service packs with the patch and patching information removed. removing this information makes the slim service pack one third of the general sp in size. slim service pack and slim fix pack bundles are recommended for demos and installations where disk space is limited or costly. however, these bundles can be patched if necessary.;;
|
after lps-98420, there might be a mismatch between the real ldap import trigger time and import interval set on instance settings expected result the import trigger time is 3 minutes actual result the real import trigger time is 4 minutes the'ldap import interval' setting exists on both system settings level and instance settings level the'ldap import interval' on system settings level, after lps-98420, is considered a trigger timer. instead of triggering the ldap import, the'ldap import interval' on system settings level is used to trigger a check of whether or not there are any instances due for an import the'ldap import interval' on instance settings level, could be considered the real import trigger interval. however, you must consider the'ldap import interval' on instance settings together with the interval on system settings to determine the real ldap import time as in the example, if the system settings ldap import interval is 2 minutes, this means every 2 minutes, it will check if there are any instances which have ldap import enabled and are due for another import. let's say ldap is enabled and has an import interval of 3 minutes in the default liferay instance settings. the user may expect the ldap import occurs every 3 minutes as set in the instance settings however, due to the changes in lps-98420, in this scenario liferay will check whether or not there are any instances due for another import every 2 minutes but the import will not occur because it is set to take place every 3 minutes past the last import time instance settings level. while the instance is ready for import at 3 minutes, it cannot trigger itself and must wait for the scheduler to do so. therefore, the actual import will not occur until the next triggered check, thus making the real ldap import time on the second trigger, at 4 minutes in single-instance bundles, it's best to match the system and instance settings' interval values, so import is triggered and executed exactly as needed. in multi-instance bundles, specifically where ldap import intervals need to vary, it's best to set the system interval as the lowest common denominator of the instances take the example of a two-instance bundle where instance a has an interval of 20 minutes and instance b has an interval of 30 minutes. you would want to set the system interval to 10 minutes, which is the lowest common denominator of the two. the ldap importer will trigger at 10 no imports, 20 instance a, and 30 instance b minutes, and so on. this ensures both instances execute importation at their specified times.;;
|
there are two options to re-subscribe to help center announcements;
|
why am i not able to find a wildfly bundle download for dxp 7.1 starting with liferay dxp 7.1 sp2, liferay will no longer be releasing wildfly bundles. this will apply to all service packs and gas moving forward and all versions including the liferay dxp 7.2 release the reason for this is customer downloads and demand for the wildfly bundles has steadily decreased over time please note, wildfly is still certified as an application server for all liferay versions customers requiring a wildfly liferay bundle may follow either of these two approaches;;
|
please read about the following important changes in liferay digital experience platform 7.0 fix packs before installing lps-83079 makes changes to the upgrade process to fix sharding issues when upgrading from 6.2 lpe-16725 resolves a security vulnerability with web content article and folder permissions lpe-16717 resolves a stored cross-site scripting xss vulnerability that exists in the web content display widget lps-92789 makes changes to velocity template to cache velocity template resource lps-92256 makes changes to social upgrade process to successfully upgrade from 7.0 without losing blog entries that contained published trackbacks lps-92216 makes changes to the site settings portlet to check user permissions when groupid is present lps-92048 makes changes to upgradeasset and upgradeexpando classes to improve upgrade times while using postgres lps-91149 updates url files to fix issues when configuring a form field as'searchable.' lps-90362 updates url files to fix issues when trying to configure a web content structure as'not indexable.' lps-89365 updates url files to fix issues when indexing a form field that sets a'searchable' field property to'disabled.' lps-89362 updates the ui to allow users to choose if ddm field is indexable or not lps-88240 makes changes to url to successfully upgrade from 6.16.2 while using postgresql, db2, oracle, or sybase databases lps-84881 updates url to include a warning message about taglib usage in the cacheable templates help message lps-81837 makes changes to url to successfully upgrade from 6.16.2 without losing user avatar image lps-73136 adds a new setting in site admin that allows users to enable custom site languages with site template propagation as well as new language keys for the configuration property lps-68220 adds support for openam 13 lpe-16721 resolves a security vulnerability with the' url' bundle. the' url' bundle includes apache cxf 3.1.9 which has the following vulnerabilities cve-2017-5656, cve-2017-12624, cve-2017-3156, cve-2018-8039 and cve-2017-5653 lpe-16705 resolves a security vulnerability with the company key being exposed via templates lpe-16701 resolves a security vulnerability that allowed unauthorized users to view a site's site setting page via url manipulation lps-91059 adds missing parser to url to fix issues with url method lps-90404 upgrades the lib version for tikka and jempbox to resolve a console error that is thrown when a user tries to upload a mp3 file lps-84026 adds openid connect authentication support to 7.0.x. users can find configuration settings for openid connect under system settings foundation. please refer to the updated documentation and liferay dxp integrated technologies compatibility matrix lpe-16714 resolves a security vulnerability with elasticsearch. elasticsearch has a dependency on google guava 18.0, which has the following security vulnerability cve-2018-10237 lpe-16704 resolves a reflected cross-site scripting xss vulnerability that exists in the sign in widget and in user management lpe-16692 resolves the following security vulnerabilities with apache tika 1.19 cve-2018-11796 and cve-2018-17197 lps-91160 updates the french url to correctly translate blogs entry notifications in french lps-91026 adds a new configuration that allows users to set duration values when editing a password policy lps-90155 adds the ability to configure netmask accepting both cidr and dot notation. prior to this fix, only individual ips could be configured in url properties. below are examples of valid property configurations lps-88315 makes changes to theme styled in order to correctly position alloyeditor drag handles in ie11. customers using styled will need to use the new styled version 2.1.15 lpe-16681 resolves the following security vulnerability with apache pdfbox 2.0.9 cve-2018-11797 lpe-16680 resolves a security vulnerability with security antisammy. portal securty antisammy has a dependency on apache batik 1.7, which has the following security vulnerabilities cve-2018-8013, cve-2015-0250 and cve-2017-5662 lpe-16677 resolves a security vulnerability with open id. openid has a depency on apache 4.1 which has the following security vulnerabilities cve-2014-3577, cve-2011-1498 and cve-2013-4366 lpe-16670 resolves the following security vulnerability with jcraft jsch 0.1.51 cve-2016-5725 lpe-16659 resolves the following security vulnerabilities with spring core 4.19 cve-2018-1271, cve-2018-1272, cve-2018-1270 and cve-2016-5007 lpe-16664 resolves a security vulnerability with google sso. google sso has a dependency on guava-jdk5-17.0. guava-jdk5-17.0, which had the following security vulnerability cve-2018-10237 lpe-16660 resolves the following security vulnerabilities with netty 4.0.23 cve-2015-2156 and cve-2016-4970 lpe-16652 resolves a xss vulnerability with custom field configurations lpe-16641 resolves a path traversal vulnerability with poller lpe-16653 resolves the following security vulnerabilities with apache tika 1.18 cve-2018-11762, cve-2018-11761 and cve-2018-8017 lpe-16555 resolves a stored xss vulnerability with the back link in the asset publisher lpe-16596 resolves a security path traversal vulnerability in documents and media lpe-16386 resolves a security vulnerability with anonymous message board posts being displayed incorrectly this fix pack includes new api's that were added to the search module. this fix pack can be reverted to fix pack 60 and higher lps-84451 adds a new search functionality to the workflow tasks. to ensure all current and previous workflow tasks are displayed in the search results, please reindex manually lps-80931 fixes search results for non-default date formats lps-79348 adds filter attribute to asset publisher and search so that expired entries are not fetched lps-78857 implements a new query type from elasticsearch's query language called terms set query. terms set query returns any documents that match with at least one or more of the provided terms. - url lps-78738 changes the url locale to use a - instead of a as a separator between the language and the country. url's that have the old style will be redirected to the new url locale with a permanent redirect - 301 error. users that have done some url pre-processing in web servers may have their rules affected by this change lpe-16645 resolves a security vulnerability with site edit pages being accessible to users without permissions by checking view permissions when trying to render a view for specific groupid's lpe-16638 resolves a security vulnerability with the power user or site administrator role being able to view page configurations without view permissions by checking view permissions for specific groupid's lpe-16628 resolves security vulnerabilities in jackson-databind-2.6.7.1. jackson-databind-2.6.7.1 is a dependency of petra-json-web-service-client lpe-16607 resolves a security vulnerability that occurs when liferay dxp is configured with a distributed cache using jdbcpings lpe-16619 resolves a path traversal security vulnerability with include tag lpe-16577 resolves a security vulnerability that causes user password hashes and password reminders to be displayed in the logs when database errors occur lpe-16602 resolves an open direct security vulnerability with the language widget lpe-16600 resolves a security vulnerability with asset publisher permissions lpe-16597 resolves a security vulnerability with application default session timeout length by decreasing the timeout session from 30 minutes to 15 minutes lpe-16593 resolves a security vulnerability with websphere configurations defaulting to serving servlets by class name lpe-16590 resolves a security vulnerability that caused detailed error information to be displayed to the end user lpe-16558 resolves a security vulnerability that occurs with password reset token leaks and third party websites lpe-16580 disables tls 1.0 for inbound requests. please visit the customer knowledge base page for more information about this fix lsv-412 resolves a security vulnerability with remote code execution via deserialization of json data. a portal property, url has been added to control which classes are allowed to be deserialized from a json request. please refer to the'mitigation notes' section on the lsv page for more information lsv-407 resolves a path traversal security vulnerability that occurred with web content templates and application display templates lps-87429 removes the new upgrade logic that was added to url in 7.0 fp60. this added logic prevents customers with fix pack 60-63 installed to upgrade from 7.0.x to 7.1.x. removing the upgrade logic allows compatibility between 7.0.x and 7.1.x liferay versions lps-86744 modifies the relative level configuration's behaviour in the navigation menu in order to achieve a correct and consistent way of working. see the expected result described in lps-86744 lpe-16585 resolves a security vulnerability that allowed unauthorized users to access expired assets in the asset publisher lpe-16582 resolves a user login security vulnerability to csrf lpe-16576 resolves a security vulnerability that allowed unauthorized users can download lar files via url manipulation lpe-16523 resolves a xss security vulnerability with data type custom fields this fix pack includes a module upgrade process which executes on startup. this fix pack can be reverted to fix pack 50 and higher lps-84477 makes changes to the theme-styled module to update the css selector. customers will need to use the new styled version 2.1.13 lps-83963 makes changes in the blogs-service upgrade module that allows users to upgrade to 7.0 dxp without losing any small image data lps-83629 adds new properties to url file url and url. these properties allow users to disable javascript for layout and layoutset lps-83183 introduces two new admin tools for handling data erasure and data portability requests as required bythe gdpr. official documentation for these two features is available here lpe-16498 resolves an ldap injection vulnerability that exists with with user group names lpe-16485 resolves a security vulnerability with the aws access key appears in the logs lps-85722 increases the major version of util-bridges from 2.0.0 to 4.0.0. this should not cause any negative impact for customers that install de-59 lps-84223 updates the logic used when validating dl files. this will result in dl file links that were previously improperly validated to no longer pass validation. if a user tries to update a web content that contains a link to a non existing dl file, an error will now be thrown since the file does not exist lps-83736 adds url to url file. users can utilize this property to control whether or not string values are normalized for models lpe-16517 resolves a xss security vulnerability that exists with the forwardurl parameter lpe-16459 resolves a xss security vulnerability with document and media when directory indexing is enabled lpe-16456 resolves a security vulnerability that exists with portlet configurations not properly verifying user permissions lps-84003 moves url.productnavigationaccessibilityconfiguration from foundation to web experience lps-83658 fixes broken pdf previews while using pdfbox by updating the pdfbox version from 2.0.3 to 2.0.9 lpe-16507 resolves a vulnerability found with json web services lpe-16491 resolves a xss vulnerability with dynamic data list record sets lpe-16490 resolves a xss vulnerability with liferay's default sanitizer, owasp antisamy lpe-16487 resolves a vulnerability found with web content templates and application display templates lpe-16479 resolves an open direct vulnerability with blogs rss lpe-16478 resolves a xss security vulnerability that existed with virtual instances lpe-16462 resolves a xss security vulnerability that existed with page variations lps-82667 fixes improperly displayed profile images by increasing both url and url from 100 to 290 pixels in url lpe-16455 resolves a critical security vulnerability found in user permissions by allowing users without proper permissions to only have access to view the control panel layout lpe-16463 resolves a critical ssrf vulnerability that existed with pingbacks in blogs by only allowing pingback access to valid ip addresses and denying restricted ip addresses with an access denied error message lpe-16460 resolves a critical security vulnerability found with xsl content by enabling the secure processing by default. this fix is available by installing fp55 lps-82999 fixes the web content display portlet icons to display correctly after upgrading to the latest fix pack by adding a new system setting all available web content display actions in one menu under web experience web content display configuration. this new setting allows users to choose to display all the available actions in 2 different ways lps-83071 makes changes to the theme-styled module to make the numerical values for input fields when choosing more colors from the color chooser fully visible. customers will need to use the new styled version 2.1.10 lps-82592 makes changes to the theme-styled module to correctly display the modal window footer that is opened when using the text style menu in alloyeditor lpe-16453 removes the user password from showing up on the console log when a user tries to log into portal with ldap configured lps-76719 adds support to utf-8 encoding when compressing a folder in documents and media lpe-16443 updates url to resolve a stored xss vulnerability that existed with referer parameter lpe-16454 resolves a stored xss vulnerability that existed with wiki page attachments by only allowing content types based on whitelisted extensions lps-82316 makes changes to theme styled in order to properly display the portlet menu ellipsis while hovering over menu items. customers using styled will need to use the new styled version 2.1.8 this fix pack includes several module upgrade processes which execute on startup. this fix pack can be reverted to fix pack 40 and higher lps-81549 updates japanese language properties to correctly display document details in japanese lps-81408 adds a setting that users can configure to enable or disable comments to a portlet on a live site when staging is enabled. you can change this setting as a portal admin by going to control panelconfigurationsystem settingsweb experienceexportimport service and check the enable comments on live option lps-79390 removes the distinct clause from custom-sql in url to improve performance while accessing web content for users with a large database. users should no longer experience long loading times when navigating to the web content list via the control panel lps-79188 migrates url to be stored in both the layoutset and group table. storing url in the layoutset table allows url to be published on a staged site. an upgrade process was also added to the web-experience module to allow proper migration of existing url values to layoutsets table lps-72748 introduces custom fields logic to portal-search. this logic allows users to successfully search for text in custom fields of documents via the documents and media portlet lpe-16434 resolves a security vulnerability that caused blog titles to be visible to users without the appropriate view permission. this issue is resolved so only users with view permissions can view blog titles lpe-16433 resolves a stored xss vulnerability that was present in the forms application lpe-16019 resolves a security vulnerability that caused the password of a forms rest data providers to be disclosed. this issue is resolved so the password is now obfuscated lps-81028 removes the url portal property. after installation of fp47, this property will no longer be available to users lps-79799 changes the requirements of what is allowed to be passed to the liferay persistence layer. liferay models that have been proxied may no longer be able to pass through the persistence layer. if a user's code does not meet the new requirements, an exception will be thrown with an error message containing instructions on what to do next lps-79679 changes the module version of url from 3.0.5 to 3.0.6. since classloaderpool takes into account the version, it is not possible to find serialized objects class between different nodes with different module versions lps-79758 removes the 0-padding from the calendar event time slot when creating an event in japanese. users will no longer see the 0 displayed while selecting an event time lps-78519 changes the upgradesharding process order in the upgrade processes sequence. any shard that has been edited from the default value will no longer throw upgrade exceptions in the url file lps-76859 makes changes to the classic-theme module in order to properly display the edit ellipsis for a web content in the web content display portlet. users must update their url in their custom themes in order to execute this change. please refer to the steps below note this affects fp47 and up with these changes,at the time of writing this, the second ellipses should be visible, but its location is wrong. this issue is being fixed by lps-81659 in the styled theme. once this issue is closed, installing the updates from styled should fix this issue the following workaround will not work on ie9 or ie10. this is currently being worked on and will be updated when ready. in the meantime, adding the following css to the theme's url and recompiling the theme should fix this issue. when receiving the fix from styled theme it is important to remove this code to avoid any overwriting lps-74395 adds a new configuration entry in the search system settings located under system settings foundation called default search result permission filter. this added configuration provides the user with the ability to set the following parameters lps-69814 adds a new validation when uploading an image via the item selector. users can configure valid extensions under system settings collaboration documents and media image item selector view lpe-16436 fixes url to correctly call url by passing each arguments of the commands as separate elements to processutil lps-79404 updates gzip filter compression to be disabled by default. this will prevent breach attack vulnerability when using gzip filter lps-79249 removes tunnelingservletauthverifier class from url. this class has been renamed to tunnelauthverifier and is now configurable via osgiconfigs lps-77432 fixes url.unsafe api to be compatible with ibm jdk lpe-16381 is a security fix that limits web proxy portlets to administrators only lps-78517 allows users to export a serialized bean by a module and use it in multiple workflow states without losing servicecontext information lps-66371 removes actions in url that were vulnerable to csrf attacks. this will prevent attackers from creatingupdatingdeleting discussions, blogs, document library entries, message boards, and wikis lps-78858 fixes spanish language keys for notifications-list and requests-list. these keys were incorrectly updated in lps-77761 lps-77722 removes reflected xss attack that occurs after submitting a page in apijsonws. alert pop-ups no longer appear after a apijsonws page submission lps-69554 fixes an uncaught typeerror that occurs when editing the url properties. users can now edit wysiwyg properties without running into an uncaught typeerror in their browser console lps-77925 changes url to be a part of an upgrageprocess. a users console log will now show url.v007.upgradejournalarticledates instead of processing article resources for create and modified dates lps-77803 uses the correct cache name for webserverservlettoken cache. the webserverservlettoken cache can now be configured via the clustering portal properties lps-77739 changes the url to support long variable values instead of integer variable values. numeric values greater than 999999999 can now be inputted into the form text field lps-77654 fixes the duplicate key in ixb27a301f issue that was occurring while running the url.rsswebupgrade upgrade process. this will allow portal to start without exceptions. it will also prevent the gogo console from throwing any pending upgrade processes after executing upgradecheck lps-76675 due to the removal of mapping types in elasticsearch 6, administrators are now required to execute reindex all spell check indexes from the server administration if spell-check was enabled. this execution needs to be triggered even if you are still running on elasticsearch 2 server lps-75649 removes user information from the asset tag if the user isn't an admin this fix pack cannot be reverted lps-65331 changes the default value of url portal property that is used when generating a captcha image lps-71635 makes changes to the document library api file that allows developers to customize the versions and elements in the documents and media portlet lps-53392 increases emailaddress database column size. the maximum email address length allowed is 254 lps-77197 increases the description column size in the layoutprototype table lps-73770 improves performance for the upgrade process. groups can be upgraded without rebuilding the entire group tree lps-37417 proper handling of orphan data in expandorow lps-74532 increases the hostname column size in the virtualhost table. the maximum hostname length allowed is 200 lps-78134 changes read-write database settings. if you are using this functionality, please change your url configuration lps-72169 includes a new upgrade process in the module url which will modify the schema version. this will prevent customers from rolling back to a previous fix pack lps-76672 introduces a major version change that prevents importing older lar files into de-35. this will affect any lar file created from de-34 and below solution the lar files will need to be re-exported in de-35 to be imported into de-35 lps-76771 introduces a change that causes events to not be processed when a portlet issues a redirect during an action request. this does not occur if the portlet is specifically designed to send redirects during action requests add the property url to the annotation of the custom portlet if the customer has non-default log levels, they will see the following warning message in the log when making this modification and redeploying the portlet invalid property url for portlet. this warn message can be ignored and will be resolved in lps-77869 lps-77562 makes changes in schedulerresponse which will change the serialversionuid. this can cause issues applying fix packs in a clustered environment workaround stop all nodes, install the fixpack and start them sequentially lps-71501 causes an exception in the asset publisher adt. these changes implement freemarker language and allows liferay to wrap any implementations of list and map so that they are useable within liferayobjectwrapper users should make the following changes in any freemarker code .ftl files or other embedded areas lps-74946 - fixes url in the portal-template-freemarker module to run the correct logic when running a freemarker script. this change in logic may affect customer freemarker scripts and customers will need to update their script to properly run lpe-16252 - some changes were introduced in the management of the xuggler libraries and will require xuggler to be re-enabled. users who had xuggler previously enabled should follow the instructions below wildfly oom error - oom error is displayed when installing fix pack 33 on the liferay digital enterprise 7.0 wildfly bundle and publishing web content lps-56589 - changes the size of the smallimageurl column in the image table in order to accommodate longer urls lps-72541 - allows portal property configuration from operating system environment variables. please see official documentation for more information lps-72996 - properly removes ddm templates associated with journal articles upgraded from previous versions lps-73034 - removes the view and permissions permission from the guest role for calendarresources entries lps-73385 - changes the size of the smallimageurl column in the image table in order to accommodate longer urls lps-73461 - creates a new osgi bundle which will be deployed by default that leverages npm support to provide shims for url globals and modules. makes shims for url globals and modules available for use in javascript lps-73670 - changes url to url lps-73691 - changes url to markallnotificationsasread. changes class markasreadportletconfigurationicon to markallnotificationsasreadportletconfigurationicon. for more information on managing notifications please see official documentation lps-73692 - changes usernotificationeventcomparator constructor signature from string orderbycol, string orderbytype to boolean ascending. changes method signature of url userid, boolean actionrequired, string filterby, string orderbycol, string orderbytype, searchcontainersearchcontainer to url userid, boolean actionrequired, string navigation, string orderbytype,searchcontainer searchcontainer. changes class url to url lps-73695 - allows users to delete notifications, mark as read, and mark as unread. only affects clients whom have modifed this element changes class portalsettingscasformmvcactioncommand to casportalsettingsformcontributor. changes class portalsettingsfacebookconnectformmvcactioncommand to facebookconnectportalsettingsformcontributor. changes class portalsettingsgoogleformmvcactioncommand to googleportalsettingsformcontributor. changes class portalsettingsntlmformmvcactioncommand to ntlmportalsettingsformcontributor. changes class portalsettingsopenidconnectformmvcactioncommand to openidconnectportalsettingsformcontributor. changes class portalsettingsopenidformmvcactioncommand to openidportalsettingsformcontributor. changes class portalsettingsopenssoformmvcactioncommand to openssoportalsettingsformcontributor lps-74244 - creates a new field named multiple selection will be added to the forms portlet and it'll allow the creation of several check-boxes through this single field. lps-73967 - this change reintroduces build auto upgrade which lets you apply schema changes while developing. it is enabled by a new global property url in the liferayhome url file. please see the breaking changes for more information the wedeploy auth admin portlet will appear in the control panel. wedeploy is currently a beta product. the addition of this portlet will have no impact or security risk resolution the wedeploy auth admin portlet has been removed from the liferay digital enterprise 7.0 fix pack 28. customers who have applied fix pack 24, 25, 26, or 27 and wish to remove the wedeploy auth admin portlet can navigate to the customer knowledge base for further instructions please note that fix pack 27 includes a module upgrade process and cannot be reverted lpe-15776 - tomcat users will receive the following warning message at startup resolution append a new line with url in the tomcat url file url lpe-15725 - the tika and pdfbox libraries have been upgraded to tika 1.14 and pdfbox 2.0.3 in order to fix severe issues with the libraries, including improvements to localization support. customizations should not be affected by this change lps-58672 - the web content service configuration has been moved from url to system settings, allowing admin users to change the configuration through system admin ui if you were using a web content service fragment to add custom configuration for any of the next properties you should remove the fragment module and apply your config through system admin web content service lps-67469 extracts the private messaging portlet from the liferay collaboration suite and converts the portlet into a standalone app. those who would like to continue to use the private messaging portlet will need to install the portlet manually liferay private messaging can now be downloaded from marketplace. the standalone portlet is needed for users on fix pack 3 and above please note that the private messaging portlet is a lab application and will not be supported by the liferay subscription services team.;;
|
elasticsearch makes storing, searching, and analyzing your liferay dxp search data when it comes to securing that data, use elasticsearch's shield with liferay dxp, you need the enterprise search-standard subscription. subscription gives you access to an adapter plugin for configuring liferay dxp for with shield you can prevent unauthorized users from accessing the elasticsearch cluster, preserve data integrity, and create an audit trail to inspect this guide shows you the basics of how to install and configure shield, and then how to configure liferay dxp for shield, using a convenient shield adapter plugin note the shield plugin can only be used when you're running elasticsearch if you're not sure what that means refer to the configuring it's not possible to install shield into liferay dxp's default embedded elasticsearchand you shouldn't be using embedded elasticsearch in production here's the process for configuring shield these terms will be useful to understand as you read this guide first install the shield plugin on your elasticsearch cluster navigate to elasticsearch home and install the license plugin and the shield next, you need to prepare for shield to authenticate requests users making requests to an elasticsearch installation protected by shield must be part of the realm, a user database configured for shield. can use the native user management system built into shield, called esusers, or you can use an external system like ldap roles for shield are defined in elasticsearchhome url and include these admin has permission to perform any cluster or index action poweruser has permission to monitor the cluster and perform any index user has permission to perform read actions on any index so who is the user you need to configure for liferay? liferay dxp's elasticsearch client sends its authentication token in other words, its user name and password to since shield also has the authentication token stored in its user database, liferay is a recognized user and has no problems communicating from elasticsearch home, add an admin user named liferay to the esusers when prompted, enter the password liferay note of course you can change these values if desired. enter the password you configured, and you'll get a confirmation message to test that you have access to elasticsearch, enter and you'll see the elasticsearch node information printed in the console for more information on installing shield, see the elasticsearch once shield is installed, you can configure liferay dxp's shield adapter on the liferay dxp side of the equation, you need to configure the authentication token for the liferay shield user you created in the previous section. liferay dxp has a shield adapter plugin for this purpose first install the shield adapter plugin called liferay dxp 7.0 search once the plugin is installed, there's a new shield configuration entry in the system settings application control panel configuration system settings , under the foundation heading. configure it so that its user name and password match the liferay user you you can configure the shield adapter in the system settings section in the control panel, or through an osgi configuration file follow these steps to configure the shield adapter using an osgi configuration create a file named url in liferayhomeosgiconfigs for a description of all the shield adapter's configuration options, see the section available shield adapter configurations follow these steps to configure the shield adapter using system settings navigate to control panel configuration system settings, and click on the foundation heading. navigate to, or search for, the shield configuration entry and click on it set the password to liferay, check the requires authentication box, uncheck the requires ssl box, and make sure the user name is liferay. note if you set a different user name and password while configuring shield, make sure those match the user name and password you configure figure 1 you can configure the liferay dxp 7.0 search elasticsearch shield plugin from system settings now you can re-index against elasticsearch, and your data is secured by to re-index, go to the control panel's configuration section and click find the index actions heading and click execute next to reindex all search indexes for a complete list of the shield adapter's available configuration options, see your elasticsearch connection now uses shield to require authentication, but the authentication token is sent in plain text. for additional security, enable transport layer security tls encryption these instructions set up a wildcard certificate to be used across the entire alternative configuration approaches and more information note that for elasticsearch to access your keystore, it must be placed under the run the following commands under elasticsearchhomeconfig to configure ssl with an elasticsearch cluster running on localhost, for stop liferay dxp and elasticsearch set up a certificate authority ca for shield. refer to elastic's article on setting up a certificate authority note for windows in step 2 of the linked documentation on setting up a ensure that the serial file contains 01 with no quotation marks. you'll encounter errors when you follow the steps below on signing the csr use the java keytool command to create a new java keystore, import the ca that will issue the wildcard certificate create a private key in the java keystore create a certificate signing request csr for requesting a certificate from sign the csr using elastic's guide once the ca has signed the csr and returned the certificate in pem format, import it into the java keystore add the following lines to elasticsearchhome url here you're configuring shield's ssl properties, including pointing to the keystore file you just generated. for more information on these settings, update the shield adapter configuration file you created earlier in liferayhomeosgiconfigs by adding these lines now, in addition to enabling authentication, you're enabling ssl encryption and pointing liferay dxp at the keystore file you created for shield alternatively, you can configure these settings in system settings. will be more useful during development and testing start elasticsearch and liferay dxp now shield is fully configured, with both authentication and encryption elasticsearch's monitoring plugin, to visualize the health and performance of 1 this is, of course, a nod to all those fans of boaty mcboatface;;
|
the very first thing you must do to secure elasticsearch is enable x-pack after that you can begin configuring authentication and transport elasticsearch 6.x if you're using elasticsearch 6, you'll need a liferay enterprise search les subscription to use x-pack. connector to elasticsearch 7 available on liferay marketplace, x-pack security to enable security, add this setting in url now you can set up x-pack users in a system using x-pack security and x-pack monitoring, these built-in set the passwords for all x-pack's the setup-passwords command is the simplest method to set the built-in users' first-use passwords for the first time. to update a password subsequently, use the interactive argument sets the passwords for all built-in users. configuration shown in these articles assumes you set all passwords to of course, that's not recommended for production systems since you're securing elasticsearch, remember the elastic user's password enable transport layer security on each node the following instructions for enabling tls use liferay as the password use your own passwords for your installation important elasticsearch and liferay dxp must share the keys and certificates copy them between servers and point to the local copy in the corresponding configuration files alternatively, use a certificate authority to obtain node unzip the contents in the elasticsearch homeconfigcerts folder generate x.509 certificates and private keys using the ca from step 1 this generates another zip file. note the certutil command defaults to using the pksc format for since kibana does not work with pksc certificates, the --pem option generates the certificate in pem format is important if checkpoint you now have the following files in your elasticsearch homeconfigcerts folder enable transport layer tls with these settings in url for add the certificate, key and certificate authority paths to each node's the example paths above assume you added the certificate to elasticsearch homeconfig enable tls on the http layer to encrypt client communication configure the certificate, key, and certificate authority paths to each the settings on elasticsearch 6 were slightly different than those presented enable transport layer tls with these settings in url after x-pack is installed and tls is enabled, configure the x-pack security for ease of copying and pasting, here is the complete elasticsearch configuration url used in this guide with the elasticsearch 6 for both elasticsearch 6 and elasticsearch 7, the liferay connector settings if you have a liferay enterprise search subscription, the liferay enterprise search security app. file by copying it into the liferay homedeploy folder to configure the x-pack adapter, navigate to control panel find the search category and click you can enter the property values here, but it's deployed to liferay homeosgiconfigs. for the x-pack security connector, create a file the exact contents of the file depend on your x-pack setup. adapter according to the elasticsearch setup documented here, populate the file the password should match what you set during the x-pack password the certificate and key files referenced here are the same ones used on the copy them to the liferay dxp server and update their paths in the configuration accordingly enable authentication by setting requiresauthentication to true and providing the credentials for the elasticsearch user. for tls, enable transport tls, set the certificate verification mode and certificate format, and provide the path to the certificate, key, and certificate authority. depend on your x-pack configuration here's the complete list of configuration options for the x-pack connector when you're finished configuring x-pack security, restart elasticsearch. steps require a full cluster restart some elasticsearch apis used by liferay's elasticsearch 6 connector were deprecated as of elasticsearch 6.6 and 6.7. this can result warn log entries in elasticsearch's deprecation log when liferay dxp is configured with elasticsearch 6.8.x and x-pack security is enabled these warnings do not signal any functional issues, and can be disabled see;;
|
for securing and monitoring elasticsearch clusters. you should secure it with x-pack. the security features of x-pack include authenticating access to the elasticsearch cluster's data and encrypting elasticsearch's internal and external communications. security features for most production systems. subscription gets you access to both monitoring and security. liferay's sales department for more information compatibility to use x-pack security andor monitoring with elasticsearch 6.5 and liferay dxp, you must use the proper connector to elasticsearch the liferay connector to elasticsearch 6, version 1.1.0 is required to set up elasticsearch 6.5 with security and monitoring here's an overview of using x-pack to secure the data indexed in elasticsearch configure x-pack to require authentication and download and install the liferay enterprise search configure the les secuirty app with the proper credentials and encryption these steps require a full cluster restart following these instructions gives you a basic working installation of elasticsearch communicating freely with liferay dxp, but read elastic's documentation to learn about additional configuration options, features, and the in a system using x-pack security and x-pack monitoring, two of the built-in x-pack users are important kibana and elastic set the passwords for all x-pack's the setup-passwords command is the simplest method to set the built-in users' first-use passwords for the first time. to update a password subsequently, use the interactive argument lets you set the passwords for all built-in users. the configuraiton shown in these articles assumes you set all of the of course, that's not recommended for production systems see elastic's documentation on the since you're securing elasticsearch, make sure you keep track of the password we recommend enabling transport layer security on each node the following instructions for enabling tls use liferay as the password customize these as appropriate for your installation important elasticsearch and liferay dxp must share the keys and certificates copy them between servers and point to the local copy in the corresponding configuration files you can, of course, use a certificate authority toobtain node unzip the contents somewhere safe generate x.509 certificates and private keys using the ca from step 1. this generates another zip file. extract the contents somewhere in the note the certutil command defaults to using the pksc format certificates, so the --pem option to generate the certificate in pem format is important if you're using x-pack monitoring add the certificate, key and certificate authority paths to each node's the example paths above assume you added the certificate to elasticsearch homeconfig enable transport layer tls with these settings in url enable tls on the http layer to encrypt client communication after x-pack is installed and tls is enabled, configure the les security if you have a liferay enterprise search subscription, the liferay enterprise search security app. file by copying it into the liferay homedeploy folder. to configure the secuirty app, navigate to control panel find the foundation category and click on the x-pack security entry. you can enter the property values here, but deployed to liferay homeosgiconfigs. the exact contents of the file depend on your x-pack setup. according to the elasticsearch setup documented here, populate the file with the certificate and key files referenced here are the same ones used on the copy them to the liferay dxp server and update their paths in the configuration accordingly enable authentication by setting authentication to required and providing the credentials for the elasticsearch user. for ssl, enable transport ssl, set the certificate verification mode and certificate format, and provide the path to the certificate, key, and certificate authority. will differ if you configured x-pack differently here's the complete list of configuration options when you're finished configuring x-pack security, restart elasticsearch. steps require a full cluster restart.;;
|
help center is the place where you can access our world-class customer support and abundant self-service resources. here is a guide to help you get the most from liferay support through help center much of the information and resources you are looking have been made available through self-service channels. here are some of the most commonly used resources you may also ask for assistance through a support ticket. to ensure the fastest possible investigation and resolution, please include the following information when creating support tickets you can also refer to these articles that give specific steps before opening a;;
|
the following article outlines a short checklist of questions to ask and steps to take before opening a liferay connected services ticket in help center. by taking a moment to go through this checklist before opening a help center ticket, you will ensure the fastest possible resolution for your particular issue if you are facing an lcs connection issue, you can review lcs connection troubleshooting steps documented for dxp 7.0, dxp 7.1, and dxp 7.2 for any other incident, please test whether the issue can be reproduced when using please provide the exact version or create date of the items above when you create a ticket, as well as the lcs logs located in the liferay home url file if you are working with liferay support engineers on a performance, deployment or similar issue, and the affected server is registered with lcs, please confirm whether the liferay support engineers can join your project as environment viewer s in lcs having up-to-date information on the liferay system and server metrics will make it easier for our support engineers to assist you on the ticket.;;
|
the following article outlines a short checklist of questions to ask and steps to take before opening a searchindexing ticket in liferay help center. by taking a moment to go through this checklist before opening a help center request, you're ensuring the fastest possible resolution for the particular issue for each ticket, please make sure that the attached url file, and the output of patching-tool info is up to date. furthermore, please work through the following checklist and include the resulting information when you create a ticket;;
|
this article provides a short checklist of questions to ask and steps to take before opening a ui ticket in help center. by taking a moment to go through this checklist before opening a help center request, you're ensuring the fastest possible resolution for the particular issue for each ticket, please attach your url file as well as the output of the patching-tool info command specific to the environment for ui tickets specifically, please work through the following checklist and include the resulting information when you create a ticket;;
|
this article documents a short checklist of questions to ask and steps to take before opening a ticket related to accessibility in help center. by taking a moment to go through this checklist before opening a help center request, you are ensuring the fastest possible resolution for the issue you may be experiencing for each ticket, please attach your url file as well as the output of the patching-tool info command specific to the environment then please read through this checklist and include the following information when you create a ticket;;
|
for customers working on liferay dxp, liferay commerce or liferay portal, this article serves as a troubleshooting guide for activation key issues when an activation key fails, there will likely be an error on the screen. this section describes how to read the activation xml file you've just deployed and cross reference it with what the license manager page says symptom when first attempting to deploy your.xml activation key file, it's possible that the file is not deployed. a majority of the time, this issue is due to the.xml file not being placed in the correct directory if the xml is still sitting in deploy directory, check deployment conflict with existing activation keys if an activation key has been deployed in the past, you will have an .li file in url datalicense. if the current key is not being deployed there may be conflicts with this file if the error reoccurs, proceed to the next step, searching for the .li file up to liferay dxp 7.0 fix pack 53, activation through .xml keys is not compatible with liferay connected services activation. therefore it is mandatory to uninstall the lcs client before deploying the activation key these steps are optional for liferay dxp 7.2, 7.1 and 7.0 fix pack 54 or higher symptom if there is no .li in url datalicense, it is possible that the activation key has been deploying somewhere else. if this happens, there will be conflicts. this scenario will happen most with custom deployments of liferay portal if the error reoccurs, proceed to reading the server logs article symptom if after removing all.li files an activation key error persists, please check the logs common error logs that are generated please place the xml file into the url folder usually, url deploy . if you have confirmed that the xml file has been dropped in url , please refer to checking deploy directory article if this error if found within your logs, please refer to readwrite permissions article symptom an activation error message is still received after clearing the datalicense folder, removing all.li file, and confirming that the xml file has been dropped into url deploy directory there are two properties that control the directories involved in activation key deployment therefore, to check the involved directories, please note that you can configure these properties via url. however, in case your portal was running before changing url, you should move old url contents to the new location if the activation error message is still received, please proceed with opening a help center ticket and providing the following information one error that can occur in deploying activation keys is due to the permission settings on the operating system even though your user may have readwrite permissions on the directory and file, they may have the windows read only flag set in place. this setting will cause java to think that the file cannot be written to to check the permissions and to change the flag if the license error message is still received, please proceed with opening a help center ticket and providing the following information symptom for applications registered with an order id and an error message is received please open a help center ticket and provide the following information;;
|
the following article outlines a short checklist of questions to ask and steps to take before opening a larstaging ticket in help center. by taking a moment to go through this checklist before opening a help center request, you ensure the fastest possible resolution for your particular issue for each ticket, please attach your url file as well as the output of the patching-tool info command specific to the environment. for larstaging tickets specifically, please work through the following checklist and include the resulting information when you create a ticket note if this is the first time staging, understand that the entire site needs to be staged first, which, depending on the size of the site, can take a long time. please see staging publishing takes a long time we have published additional documentation that will help you prevent staging issues and complete your project in an efficient and timely manner. these are listed under the related articles heading at the top-right of this page. feel free to use these resources as a guideline to assist you in getting the most out of staging, whether local live or remote live remote staging setup for liferay portal 6.2;;
|
liferay support does not recommend or endorse specific third-party products over others. liferay is not responsible for any instructions herein or referenced regarding these products. any implementation of these principles is the responsibility of the subscriber a thread dump is a snapshot of the jvm's activity at a given time, so looking at a single thread dump does not provide useful information. when investigating threads, it is recommended to take 5-10 thread dumps at 20-30 seconds apart while the application server is slow or unresponsive to get the most useful dumps, as this will tell us how long each process takes and how many times it is executed so we can determine if there are any processes that are taking too long or executed too many times the first piece of information you will need to be able to obtain a thread dump is the java process's pid. the java jdk ships with the jps command which lists all active java process ids. you can run this command like this jps -v. the pid is listed as well as the jvm arguments, which will help you to identify which pid belongs to the application server running liferay portal 4752 is running liferay portal based on the jvm arguments note in linux and unix, you may have to run this command as sudo -u user jps -l, where user is the username of the user that the java process is running as ctrlshiftesc to open the task manager and find the pid under'processes' from the command prompt, execute netstat command netstat -noa this command will return a list of active connections. look for the connection that is using the port your application server is using. as an example, tomcat uses two connector ports 8080, 8005, and 8009. after executing netstat -noa command compare 4752 to the other lines and yes, this looks like the pid assigned to tomcat request a thread dump from the jvm. use jstack packaged with later versions of jdk 1.5 to create a thread dump. execute this command in the command prompt jstack url this full command requires the pid of your application server process and will print the stacktrace to the threaddumps log file if you see an error message, unable to attach to 32-bit process running under wow64, this is because you are trying to use the jstack tool from jdk 1.6 to take thread dumps from a process running on jdk 1.5. the bundled version of liferay tomcatjboss comes with a bundled 32-bit version jre. in a 64-bit environment, you need to remove the bundled jre and allow the application server to run on the system installed 64-bit jre in order for the 64-bit jstack tool to work successfully this indicates that you will need to run the jstack command as the user that the java process is running as. to do so, you may need to run this command as where is the user that the java process is running as. even running as root will not work if the user that is running the jvm isn't root.;;
|
liferay support does not recommend or endorse specific third-party products over others. liferay is not responsible for any instructions herein or referenced regarding these products. any implementation of these principles is the responsibility of the subscriber when a system runs into out of memory errors or other memory related issues it is helpful to have a heap dump a heap dump is a snapshot of all the objects that are currently in the jvm. the java heap is the space allocated to the jvm to create new objects in memory. when investigating mismanaged memory, one heap dump is usually good enough if the heap dump is generated when the jvm is experiencing or very close to experiencing an outofmemory error. the closer to the outofmemory the jvm is when the heap dump is taken, the more useful it will be for troubleshooting any potential java memory issues note heap dumps will take anywhere between ten seconds to several minutes. heap dumps are saved on disk and will be the same physical size as the jvm's current memory usage automatically generate a heap dump whenever out of memory exceptions occur by adding the following jvm arguments the first piece of information you will need to be able to obtain a thread dump is the java process's pid. the java jdk ships with the jps command which lists all active java process id's. you can run this command like this jps -v. the pid is listed as well as the jvm arguments, which will help you to identify which pid belongs to the application server running liferay portal 4752 is running liferay portal based on the jvm arguments ctrlshiftesc to open the task manager and find the pid under'processes' from the command prompt, execute netstat command netstat -noa this command will return a list of active connections. look for the connection that is using the port your application server is using. as an example, tomcat uses two connector ports 8080, 8005, and 8009. after executing netstat -noa command compare 4752 to the other lines and yes, this looks like the pid assigned to tomcat request a heap dump of the live objects from the jvm. from the command prompt execute if you do not use the live option, then jmap, by default, will take a snapshot of all of the memory in the jvm, which may take up to a few hours depending on the heap size if you see an error message, unable to attach to 32-bit process running under wow64, this is because you are trying to use the jmap tool from jdk 1.6 to take thread dumps from a process running on jdk 1.5. the bundled version of liferay tomcatjboss comes with a bundled 32-bit version jre. in a 64-bit environment, you need to remove the bundled jre and allow the application server to run on the system installed 64-bit jre in order for the 64-bit jmap tool to work successfully note in linux and unix, you may need to run this command as sudo -u user jmap -dumpformatb, url, where user is the user that the java process is running as.;;
|
the following article outlines a short checklist of questions to ask and steps to take before opening a performance ticket. by taking a moment to go through this checklist before opening a request, you're ensuring the fastest possible resolution for the particular issue for each ticket, please attach your url file as well as the output of the patching-tool info command specific to the environment for performance tickets specifically, please work through the following checklist and include the resulting information when you create a ticket note the analysis of the performance of a particular installation depends on many factors, not all of them strictly related to liferay portal. however, if you have reasons to believe that there is a performance issue in liferay portal, please include the analysis you may have done to point out the issue had its root cause in the product so the support service can start working based on your analysis liferay offers other kind of services that better suit these requests. please contact your account manager for more details.;;
|
in the process of reproducing customer issues, it is critical that the patches in a given environment be made available to the liferay support engineer who will be assisting you this article describes how to capture a list of the patches installed in your environment. the patch information can then be uploaded to help center when opening a ticket to output the patching information for your environment, the following command must be utilized from the patching-tool folder patching-tool info the fastest way to create a file that can be uploaded to the ticket is to please note that your instance of liferay portal may come with patches if it is downloaded from the customer portal. as this is the case, the patching information will be required from your first ticket;;
|
one of the most important pieces of information when resolving a customer issue is the url file for your environment. it is now possible to upload the url file before opening a ticket. this article describes what you need to know to locate your url files for upload to the ticket perhaps the most straightforward place to put the url file is directly into the liferayhome folder. however, the url file that is being read may also be located in other locations as well e.g. in tomcat, webappsrootweb-infclasses is a common location to determine the location of the url file that is being read by your portal, simply search your log file for url . within the log file should be the location of the url that was loaded by the portal keep in mind that url, url, and url can be set up to override your url see the include-and-override property in your url file to see if any additional properties files will need to be uploaded to the ticket in addition to the url.;;
|
developer keys are intended for local developer workstations only and are limited to five 5 concurrent user connections. this means the liferay dxp or liferay commerce instance can only serve minimal requests and cannot handle traffic beyond this limit developer keys are complementary with the purchase of a liferay enterprise subscription. there is no limit to the number of developer key copies server keys are intended for a server environment that requires an unlimited number of concurrent user connections server type activation keys are issued on an instance basis. each installation of liferay dxp or liferay commerce software and, for clarity, each cluster node will require one 1 activation key and is equivalent to 1 liferay dxp or liferay commerce instance you may request aggregate activation keys, which can validate multiple instances within a cluster there are 3 types of server activation keys for server environments, gold or platinum subscribers may request an activation key by submitting a ticket and selecting the activation key project administration component activation keys for developer copies of liferay dxp or liferay commerce can be downloaded on this page the instance sizing associated with your subscription for each liferay dxp or liferay commerce instance, at least one of the following server identifiers instance sizing determines the allowed number of processor cores, cpus or vcpus accessible to the liferay instance new activation keys are free of charge, provided they are within the number and type of subscriptions purchased for your liferay project you will need to request one or several new activation keys if you want to accomplish one of these tasks it is not necessary to request a new activation key if you need to activation keys for liferay dxp and liferay commerce are very similar. the only difference is that liferay commerce activation keys are not version specific. the same activation key can be used on all liferay commerce versions starting with liferay dxp 7.3 and liferay commerce 3.0, the activation keys used on the same instance are required to be of the same type. for example, on the same instance you can use a liferay dxp developer key and a liferay commerce developer key. however you cannot use a liferay dxp production key and a liferay commerce developer key you can deploy your activation key by following the instructions in this knowledge base article as the next step, please review our troubleshooting activation key issues article or submit a ticket in help center for assistance from our liferay support team.;;
|
workflows on liferay give the possibility of running assets like web content articles, wiki pages, or even users, through pre-determined review processes. for this you can utilize workflow statuses let's say, you, as an administrator, want to have control over all the comments that are made in a single blog post. for that, you could setup a workflow definition of your choice that every comment will have to go through before being approved and finally published. so, when you create that review process using liferay's workflow, you must define steps that assign statuses to these incoming comments in order to determine the acceptance, or rejection, criteria for them ie denied, pending, incomplete, etc. liferay gives a set of statuses, out-of-the-box, which you can find listed below or in our code's repository. a supported status must be used and be set correctly otherwise, your workflow definition might fail to process the assets as you intended here is an example of how to update the status correctly note if you misspell the status label like in the following, the asset will be set to status any by default for more information on how you can leverage liferay's script engine to enhance the workflow experience. please see leveraging the script engine in workflow.;;
|
for a full list of release notes, please navigate to jira please navigate to the official documentation for installation and upgrade instructions see breaking changes article for more information and affected properties;;
|
apache tomcat has recently released new versions to fix a vulnerability tracked as cve-2020-1938 also referred as ghostcat liferay recommends customers using any of the affected versions to read the referenced articles below and apply one of the following mitigations future service pack releases for liferay dxp will be bundled with a newer tomcat version where this vulnerability is already fixed.;
|
to get off to a great start using liferay digital experience platform dxp, refer to the official readme file on the liferay help center. it provides resources for launching and learning dxp, enterprise support information, descriptions of liferay's deployment services, and whitepapers on enterprise and mission critical deployments customers will be provided access to help center after purchase. to access help center, sign in to url and look for help center under your user icon in the top right drop down menu, or directly access from here. if you do not have access to help center, please email email if you do not have a url account, please create one from the create account link in the top right drop down menu at url liferay digital experience platform dxp is licensed by liferay and its affiliates. your use of dxp is subject to the terms and conditions of an agreement between you, andor your company, and liferay or its affiliates liferay, liferay digital experience platform and liferay dxp are trademarks registered by liferay in the united states, europe and various other countries. use of these trademarks is governed by the trademark policy posted at url. when using these trademarks in any form, this policy should be reviewed to understand if your use requires permission from liferay. for further questions, please contact email.;;
|
please note the above hyperlinked articles are unofficial articles that are shared to basic information. your use of those articles is completely at your discretion the headers described from 4 to 7 should be configured either at the application server or at the web server and both the platforms fall beyond the scope of liferay support.;
|
activation keys - request a key for your workstation and production environments downloads - get the archived service packs and fix packs for liferay portal 6.1 compatibility matrix - learn about the supported configurations for liferay portal 6.1 documentation - reference the product guides and whitepapers for liferay portal 6.1.;
|
liferay portal enterprise edition ee is only supported under the following configurations certified vs. supported environments certified products in the certified list have undergone automated regression and certification testing by liferay and are fully supported with a liferay enterprise subscription. supported products in the supported list have undergone automated regression testing by liferay and are fully supported with a liferay enterprise subscription versions of browsers that were released after a major liferay version release have not been tested and support for these newer browser releases will be provided as a commercially reasonable effort only and may be included in subsequent service releases at liferay's discretion. versions of browsers that were supported with an initial release of a liferay version that have reached the end of their product lifecycle are no longer tested in subsequent service releases and support for those older browser releases will be provided as a commercially reasonable effort only. quirks mode for all browsers is not supported. internet explorer compatibility modes for all relevant versions are not supported due to poor implementation. limited support shall be provided for internet explorer 6 on a case-by-case basis. internet explorer 6's performance limitations prohibit it from running the latest internet technologies effectively without experiencing performance degradation jboss 6.0 eap and jboss 7.1 as jboss domain mode is not supported with liferay 6.1 ee oracle jdk 7 and ibm jdk 7 are only compatible with liferay 6.1 ee ga2 and liferay 6.1 ee ga3. websphere 8 does not support oracle jdk 7 oracle jdk 5, ibm jdk 5, and websphere 6.1 oracle jdk 5, ibm jdk 5, and websphere 6.1 are not supported with liferay 6.1 ee ga3 oracle jdk 8 is compatible with 6.1.20 and a jdk 8 compatible app server;;
|
here are some frequently referenced patching troubleshooting how-to topics;
|
"to install fix packs and hotfixes on liferay dxp, customers must first download the latest patching tool. for more information on how to configure the patching tool, see using the patching tool important be sure to backup your liferay dxp installation and database regularly, especially before patching if the hotfix is not installed, or if you receive an error that is not covered in the documentation below, please open a help center ticket and provide the full patching-tool output note if there are any issues with the installed fixes, verify that there are no remaining files within the application server cache from the previous patch installation of a fix pack or hotfix. consult the platform vendor's documentation on where to find the cache during the installation, url and url files will be created and stored in the rootweb-inf folder the url file is necessary for installing future patches because patching tool reverts the previously installed fix packs before installing a new one. in order to revert the installed fix pack, the patching tool examines the contents of the url in order to determine what changes have been made that it needs to revert while removing the url file does not affect the patching tool's report of what is installed in the bundle, we do not recommend removing the file from the rootweb-inf because doing so will cause future installations to fail if there are any other hooks and plugins already installed, there is no need to remove them first. the patching tool updates the liferay product's core infrastructure first. if there are any liferay plugins installed, there is a separate command to update them. see the article updating plugins after applying a patch note patching a cluster requires additional considerations updating the patching tool when a patch you're trying to install requires a patching tool update, the patching tool will tell you. to update the patching tool, download the latest version from the download page. overwrite the existing patching tool by unzipping the new one to the patching-tool folder's parent folder database indexes if there are new database indexes created by the patch, the patching tool tells you to update them. to get the list, run this command since there's no database connection at patching time, the indexes must be created at portal startup. if the server has permissions to modify the database indexes, instruct liferay dxp to create the indexes automatically at startup by adding this setting to your url file otherwise, you must create the indexes manually. check the patching-tool index-info command output for more details handling hotfixes and patches hotfixes are on-demand fixes provided directly to specific customers, and fix packs are larger bundles of hotfixes provided to all customers at regular intervals. if you already have a hotfix installed and the fix pack that contains that hotfix is released, the patching tool can manage this for you. fix packs always supersede hotfixes; so when you install your fix pack, the redundant hotfix you already have is uninstalled and the fix pack version is installed in its place since fix packs are cumulative, the latest fix pack contains all of the updates from the previous fix packs for the same liferay version. you only need to install the latest one, and in most cases there is no need to manually uninstall the previous version fix pack dependencies most hotfixes depend on a certain fix pack. if you attempt to install a hotfix that depends on a certain fix pack, the patching tool notifies you. go to the downloads page and obtain the necessary fix pack. once all the necessary patches are available in the patches folder your hotfix and required fix pack, the patching tool installs them";;
|
the liferay support team creates and releases fixes to address issues discovered with the product. these are shipped in zipped packages, which are referred to as patches patches can be installed by utilizing the patching tool which is included in every liferay bundle. more information on installing patches may be found here liferay delivers fixes through these three types of patches a fix pack is a collection of the latest fixes bundled together. fix packs include fixes for both the core and the application suites that ship with the product. fix packs are cumulative and contain all the fixes from previous fix packs fix packs can be downloaded from our downloads page. with each fix pack, release notes are provided outlining important information, such as important changes, security fixes, and a changelog with more detailed information for each fix note for customers on dxp, there is also a release notes tool that makes it easy to compare all of the changes between different dxp fix pack and version levels, including module version changes. this is helpful in planning upgrades and identifying any potential impact to your customizations in cases when you encounter an issue which is not yet addressed in a fix pack, you can create a help center ticket to request a hotfix. liferay support will work together with you to determine if the issue is with the product, and provide a fix for any unintended behavior there are two types of hotfixes, standard and cumulative see below. the liferay version you are on determines the type of hotfix you will receive standard for dxp, cumulative for portal ee. these hotfixes are not publicly available for download, you need to contact our liferay support team to obtain them. hotfixes are installed with the patching tool and are specific to the individual customer. applying hotfixes from other customers may lead to conflicts and create further issues. hotfixes are available for gold and platinum customers standard hotfixes are built assuming a specific fix pack level, and must be installed with the corresponding fix pack present in the patches folder. at any given moment one hotfix and one fixpack may be installed together. a standard hotfix may contain more than one fix and even a complete fix pack if necessary for portal 6.2 ee, when a hotfix is created, all your currently installed fix packs are included in the hotfix. these hotfixes cannot be installed together with fix packs. the patching tool will automatically recognize and install the newer fix note our engineers will need to know which patches are installed on your system. when you contact liferay support requesting a hotfix please share this information as it is essential to build a hotfix. with the patching tool you can easily create a text file which contains all the necessary details using the support-info command a security issue may be fixed with a hotifx, a security fix, or a fix pack. for dxp, security issues please see dxp security fix packs for portal 6.2 ee, security issues may be temporarily fixed with a hotfix. security fixes are then released and delivered to all portal 6.2 ee customers in the next fix pack release. this fix pack will include the latest security fixes along with other fixes, as well if you are not planning to install all of the latest fix packs or security fix packs but still need the security fix, please create a help center ticket to request a hotfix periodically, the latest fixes and fix packs are merged together into a service pack. service packs are built on top of the original liferay ga major release, and bundled together with the most up-to-date service packs can be downloaded from our downloads page. if starting a new project, always start with the latest service pack. the service pack will contain all the fixes released at the time of release since the previous service pack. for existing installations, please follow the instructions on updating to the latest service pack level, here note in previous versions of liferay portal 6.0.12, 6.1.10, 6.1.20 the fix packs were not compatible with different service packs, they can only be installed by rebuilding the portal environment from the new bundles. fix packs were only compatible with one service pack or ga as they were called in 6.1 ee so they couldn't be installed on other versions liferay extensively tests all three types of fix packs to ensure high quality. fix packs go through both automated regression testing and manual testing. hotfixes receive similar automated testing, and the fix for the reported issue is tested by the support engineer who built the fix and the support engineer assigned to the help center ticket before releasing a service pack, additional test suites run on the packaged releases to ensure the quality of the packaging a conflict happens when a fix modifies the same file which has already been modified by a fix pack. the patching tool is not able to decide how to handle these so the case has to be verified and resolved by an engineer sometimes the logic has to be adjusted as well. this is called a merge because the new fix has to include the previous one as well. the patching tool looks for information in the patches so it knows how to install the various patches correctly previously with standard hotfixes, many combinations of conflicts emerged and needed to be handled which lead to slower and more error prone resolutions. also, every customer could have a completely different environment by releasing fix packs more often the need to handle these conflicts occurs only once in the newer fix pack. this way we can reduce the number of different environments our customers may have. from versions 6.1.30 and 6.2.10 ideally only the fix packs are used in a liferay installation. in case there is an urgent need to handle a malfunction a cumulative hotfix can be requested. after releasing and installing a cumulative hotfix there is still a possibility to go back to use fix packs if the fix is included in a fix pack later on important make sure to backup your liferay dxp installation and database regularly, especially before patching. the patching tool installs code changes and some of these make data changes if necessary automatically on startup certain fix packs service packs can include dataschema micro changesthey're optional and revertible. module upgrades and any micro changes they include are applied at server startup by default, or can be applied manually by disabling the autoupgrade property. server startup skips all core micro changes. instead, you can apply them using the upgrade tool before server startup please subscribe to our liferay support updates to stay informed on the latest releases.;;
|
to install fix packs and hotfixes, please download the latest patching tool if the hotfix is not installed or if you receive an error that is not covered in the documentation below, please open a help center support ticket and provide the full patching-tool output note if there are any issues with the installed fixes, verify that there are not any remaining files within the application server cache from the previous patch installation of a fix pack or hotfix for example, in tomcat, clear out the catalinahomework and catalinahometemp directories. the reason why these folders should be cleared out after the patch has been installed is to ensure that any temporary or cached files from the last patch level is not being utilized. clearing the temporary folders within the application server allows for the liferay platform to have a fresh start based on the new patch level during the installation, url and url files will be created and stored in the rootweb-inf folder do not delete the url and url files the url file is necessary for installing future patches. this is because the patching-tool reverts the installed fix pack before installing a new one. in order to revert the installed fix pack, it examines the contents of the url in order to determine what changes have been made that it needs to revert note the url file inside the web-inf folder will always be overwritten by the one inside the patch. any custom configurations made by system administrators will be lost. administrators should remember to add back custom configurations before restarting the application server while removing the url file does not affect the patching-tool's report of what's installed in the bundle, we do not recommend removing the file from the rootweb-inf because doing so will cause future installations to fail.;;
|
this article documents several possible solutions for updating plugins after a new fix pack has been installed. specifically, customers have found that a plugin's libraries are not patched at the same time as the portal. customers have also found that a customized plugin that modifies a certain file can clash with the patching tool's install commands run the command patching-tool list-collisions. this command lists all the differences collisions between installed patch files and the plugin's version of them. currently only hooks and ext are supported, theme collisions are not detected as of patching tool 2.0.9, patching-tool list-collisions lists only jsp file collisions in fragment bundles. unfortunately, this feature introduced a bug that was later fixed on patching tool 2.0.11. for more information about the resolution, please see the patching tool 2.0.11 article there are several possible solutions for updating plugins after a fix pack has been applied see the following documentation about updating plugins and using the auto discovery functionality;;
|
when patching tool is run on a windows machine, windows security can slow down the patch installation drastically due to the large amount of file operations being performed if you experience extreme slowdowns during patch installation, you may need to add your liferay dxp and patching tool folder to windows security exclude list you can do this using the following steps;;
|
liferay portal enterprise edition ee is only supported under the following configurations for more information on configurations and limitations with application servers and databases that are compatible with liferay portal, please refer to the liferay user guide certified vs. supported environments certified products in the certified list have undergone automated regression and certification testing by liferay and are fully supported with a liferay enterprise subscription. supported products in the supported list have undergone automated regression testing by liferay and are fully supported with a liferay enterprise subscription versions of browsers that were released after a major liferay version release have not been tested and support for these newer browser releases will be provided as commercially reasonable effort only and may be included in subsequent service releases at liferay's discretion. versions of browsers that were supported with an initial release of a liferay version that have reached the end of their product lifecycle are no longer tested in subsequent service release and support for those older browser releases will be provided as a commercially reasonable effort only. quirks mode for all browsers is not supported. internet explorer compatibility modes for all relevant versions are not supported. limited support shall be provided for internet explorer 6 and 7 on a case-by-case basis. internet explorer 6 and 7's performance limitations prohibit them from running the latest internet technologies effectively without experiencing performance degradation liferay will support access to information e.g. reading content and navigation through pages, navigation menus, and basic responsiveness of modules for the latest versions of mobile browsers only. for more information on liferay's mobile support policy, please refer to the liferay help center tomcat 8.5 does not support liferay social office and liferay chat because a required api was removed. tomcat 8.5 is only supported with jdk 8 liferay 6.2 compatibility matrix updated 11172020;;
|
the liferay commerce connectors are supported under the following configurations liferay commerce connector to punchout2go 1.0.0;
|
liferay commerce 1.1 is supported under the following configurations versions of browsers that were released after a major liferay version release have not been tested and support for these newer browser releases will be provided as a commercially reasonable effort only and may be included in subsequent service releases at liferay's discretion. versions of browsers that were supported with an initial release of a liferay version that have reached the end of their product lifecycle are no longer tested in subsequent service releases and support for those older browser releases will be provided as a commercially reasonable effort only. internet explorer compatibility modes for all relevant versions are not supported. customers may experience a memory leak when using the latest version of ie 11 and edge. please see the customer knowledge base for more information liferay will support access to information e.g. reading content and navigation through pages, navigation menus, and basic responsiveness of modules for the latest versions of mobile browsers only. for more information on liferay's mobile support policy, please refer to the help center amazon ec2 and rds are only supported with environments on the liferay dxp 7.1 compatibility matrix liferay commerce does not restrict the use of vmcontainer strategy as long as the application serverdatabasejdkoperating system are supported within our compatibility matrix. customers will be responsible for configuring the vmcontainer appropriately;;
|
this article specifies the liferay support policy for mobile devices when used with liferay digital experience platform, liferay portal ee, or liferay commerce the product. liferay support offers support coverage for mobile devices and mobile browsers based on the product and its release date. issues encountered while utilizing the mobile device detection application are covered under the marketplace applications policy for more information please see the browsers policy while using the product on safari or android mobile browsers it should be possible to access information. this includes navigation menus, content legibility and basic responsiveness of modules. this does not include access to administrative menus or views such as the control panel, site or page management, and other administrative tasks within the product. if an issue is encountered related to accessing information while using the product on safari or android mobile browsers, then the resolution of that issue is covered under the product defects policy.;;
|
this article describes a known issue specific to microsoft internet explorer 11 ie11 as documented on lps-73892 liferay has discovered a memory leak occurring in ie11 and edge. as the browser memory usage of the application increases, a page may render with mobile styling. after this symptom exhibits, the browser may run out of memory and crash. the browser may also unexpectedly crash without displaying these symptoms after research, liferay found the root cause of the issue to be within ie11. this memory leak is also reproducible on third party websites i.e. as of august 4th, 2017, lps-73892 is still reproducible using ie version 11.483.15063.0 kb4025252 or kb4025339 - july 11, 2017 cumulative security update for internet explorer anyone regularly experiencing this issue would benefit from the use of another browser, such as mozilla firefox or google chrome, as neither of these other browsers manifest the same memory leak issue if this is not possible, please update to the latest stable version of ie11. since this issue is resolved and slated for release, it is possible that the fix has been released in the latest version of ie if it is not possible to use a different browser, or update ie11, then there is a liferay specific workaround which minimizes the likelihood of the issue occurring by reducing browser memory consumption during a single user session. this workaround does not resolve the issue since the root cause lies ultimately with ie11 the workaround is as follows in the url set url lps-102605 introduces the possibility to disable single page application spa on internet explorer browsers andor internet explorer 11 only. the feature is available on the below patching levels and it can be activated through even with spa disabled, it is still possible to experience this known issue during long user sessions. disabling spa will negatively impact page load times and user experience. for more information on spa and its benefits please see the url documentation see lps-73892 for more information other js libraries have reported similar issues;;
|
"let's attempt some mind reading you're reading this because you need to build you're thinking about using liferay portal for your site, or you've already decided to use it and you want to learn all about it. you've come to the right place. what you'll find here is that liferay portal is the right decision, and we'll be happy to tell you all the reasons why. since you might be in a rush, we'll give you all the reasons in a nutshell right here, and then you can read the details in the rest of the chapter the reasons to use liferay portal for your website are simple it provides a robust platform to serve your site to all clients, be they desktop, mobile, or anything in between; it provides all the standard applications you need to run on your site; and it provides an easy to use development framework for new in addition to this, liferay portal is developed using an open source methodology, by people from around the world. is solid, and has been proved to be reliable and stable in mission critical deployments in diverse industries but don't just take our word for it. let us show you how liferay does all probably the first thing you want to do after you install liferay portal to manage your site is to get your content published. see how liferay portal handles that task.";;
|
activation keys - request a key for your workstation and production environments downloads - get the archived service packs and fix packs for liferay portal 6.0 compatibility matrix - learn about the supported configurations for liferay portal 6.0 documentation - reference the admin guide and whitepapers for liferay portal 6.0;
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.