Datasets:

gorkemsevinc
/

european-language-grid

Dataset card Data Studio Files Files and versions Community

Split (1)

train · 5.64k rows

text; stringlengths 5 32.6k
liferay portal 5.2 is software to help enterprise it deliver engaging business solutions by providing a lightweight platform that can be quickly deployed and provides many of the capabilities and tools needed to build compelling user engagement experiences activation keys - request a key for your workstation and production environments downloads - get the archived service packs and fix packs for liferay portal 5.2 compatibility matrix - learn about the supported configurations for liferay portal 5.2 documentation - reference the admin guide for liferay portal 5.2;
this article documents some of the most frequently asked questions regarding the use of lightweight directory access protocol ldap to manage users in liferay dxp. specifically, the aim of this article regards common configuration issues that have arisen in this product version what's the difference between configuring the ldap in instance setting versus the system settings in the control panel although most ldap configuration can be done from instance settings, there are several configuration parameters that are only available in system settings. in previous liferay portal versions, certain system scoped settings for ldap were set in the url file and modified using a url file. in liferay dxp, modify the following settings in the system settings lastly, configurations made in the system settings will control all instances up to a certain point. if virtual instance a was created before a change e.g. error password history keywords was made in the system settings, virtual instance a will not inherit those changes. therefore, if virtual instance b was created after those changes, then virtual instance b but not a will have the updated error password history keywords if a user has to update his password in dxp, how can the sys administrator update the ldap? that is, if the password was changed, how does the listener retrieve the actual password and not its hash one solution is to build a custom module or portlet to pass in password changes made in the control panel to import into the ldap server such as ms active directory. because changes to the password must be done over ssl, the two servers must be configured to communicate over ssl. in the url file, enter the following the listener will retrieve the unencrypted password using this class what's the difference between the difference between enable import and enable import on startup these are actually two different processes and should not be enabled at the same time. each process is a massive use of cpu resources especially if there are tens of thousands if not hundreds of thousands users. enable import in general will import users from the ldap server. enable import on startup also imports users from the ldap server whenever the server starts or restarts administrators should consider disabling import in a clustered environment so that there are no massive imports whenever a node starts up.;;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable this article documents a known issue where users are able to deactivate the default liferay portal site, which then prevents access to any existing live site with a public page. the basic functionality is that as long as there is one live site with a public page, users should be able to log in. however, there is a bug where users see a warning message, this site is inactive. please contact the administrator, when they attempt to access the control panel this issue exists on legacy liferay portal 6.1 ee and 6.2 ee at this point, the error message appears in order to gain access to the control panel once more, administrators must reactivate the default guest site this issue has been resolved in liferay portal fix pack portal-151. the fix pack introduced a new change in functionality so that the default guest site cannot be deactivated if the platform has an single sign-on or single log-out ssoslo like saml or shibboleth enabled, the sso settings will override and redirects to the sso specified identity provider url this known issue is also found in liferay portal 6.1 ee. because this version has reached eosl, only subscribers with extended premium support will receive a fix if they request one.;;
this article outlines known issues that exist in the audience targeting ee plugin for liferay 6.2 and includes links to their respective tickets for more up-to-date progress on the particular issues please note that the following issues are related to the setup and usage of the audience targeting ee plugin. these corresponding tickets are listed with the known issues further information on these particular issues can be found in the links to the tickets themselves if you encounter any of the above issues, please request a hotfix describing the encountered behavior and our support team will be glad to provide a resolution.;;
"the server administration application accessed by clicking control panel related to the liferay dxp server. clicking the link displays a graph showing the figure 1 server administration is where you configure and monitor many aspects of the server note liferay dxp customers can use liferay connected services lcs to obtain additional performance metrics. if you're a dxp customer, see the the server administration functionality is broken into several tabs the resources tab contains several server wide actions that an administrator can these include the following items the direct servlet context optimizes jsp serving performance by caching and accessing the generated servlets directly instead of accessing them over the application server's dispatcher chain. this function is only suitable for cases where no filter is required for the jsps; it should be enabled for production mode to improve performance, but disabled for development mode to allow jsp servlets to be reloaded on the fly. see the direct servlet context section of 1 caching occurs at multiple levels. layers aren't aware of lower caching layers. lowest most granular layer possible, even if you've already cleared a higher here, you can make dynamic modifications of log levels for any class hierarchy custom objects not on the list can be added with the add changes to the log level near the top of the class hierarchy such as at url also changes log levels for all the classes under modifications unnecessarily high in the hierarchy generate too liferay and the jvm contain many settings which are defined as properties. properties tab has two sub-tabs system properties and portal properties the system properties tab shows an exhaustive list of system properties for the jvm, as well as many liferay dxp system properties. for debugging purposes or to check the currently running configuration the portal properties tab shows an exhaustive list of the current portal property values, so you don't have to shut down liferay dxp or open the properties portal properties are customizable; you can peruse the full list captcha is designed to thwart bots from registering for accounts. liferay dxp ships with its own captcha service alternatively, google's recaptcha service can be enabled from the captcha tab of check the enable recaptcha box, enter your public and private keys into the provided fields, and click save. recaptcha instead of the native captcha solution this tab is for upgrading liferay dxp or migrating its data from one system to another without writing custom scripts the first section, under migrate data from one database to another. was useful in past versions of liferay dxp for copying the entire liferay dxp database to a new however, the database migration tool cannot be used in the current version of liferay dxp and will be removed in the next version of liferay dxp the second section, migrate documents from one repository to another, helps you migrate your documents to a new repository on a different disk or in a new format. since liferay dxp allows users to upload files in various places, you may want to restrict the type and size of files users are allowed to upload. uploads tab lets you set the overall maximum file size and then grant exceptions to that limit for specific applications. you can also limit the allowed file extensions generally or by application instead of using a url file to configure a mail server, you can configure a mail server from the mail tab. you can connect a pop mail server. notifications to users, you can connect to an smtp server. note that if you configure mail server settings here in the control panel, these settings override any mail server settings in your url liferay dxp lets users upload and share content via the documents and media library, a customizable and permissions-enabled online repository for files. users can upload files of any type to the documents and media library. ships with pdfbox for generating automatic previews for certain types of you can install three additional tools that offer higher quality previews and document conversion functionality openoffice or libreoffice, with liferay dxp configured to use these tools, you can generate automatic previews for many types of files including text files, office suite files, pdfs, images, audio files and videos. conversion functionality to download documents in a variety of formats. article on publishing files in liferay dxp imagemagick, and xuggler is available here choose the correct versions of these applications for your operating system. recommend that you install the latest stable versions. imagemagick must be installed manually, but you can install xuggler from tip if you're running liferay dxp on a linux server and experience a problem glibc to version 2.6 or later in order for xuggler to work once you've installed these tools, you can use the control panel's external services tab to configure liferay dxp to use them openoffice and libreoffice are open source office suites which are usually run in graphical mode to create documents, but they can also be run in server when run in server mode, openoffice and libreoffice can be used to convert documents to and from all of the file types it supports. liferay dxp uses this feature to convert content on the fly automatically. install openoffice or libreoffice on the same machine where liferay dxp is running or you can connect to a separate host note running openoffice or libreoffice in server mode on a remote host is not recommended for converting documents in liferay dxp, and is not fully to avoid unexpected behavior during document conversions, you should run openoffice or libreoffice in server mode on the same machine as liferay dxp you can start libreoffice or openoffice in server mode with the following once openoffice or libreoffice is installed and running in server mode, configure liferay dxp to use it either in url or from the if openoffice or libreoffice is running on another server or on a non-default port, you must also specify these values. the default values are as follows by default, when liferay dxp uses openoffice or libreoffice to perform the first time a document is converted, a copy is saved in the liferay dxp temp folder liferaydocumentconversion. liferay dxp receives a conversion request, it checks this folder to see if the converted document already exists. if the converted document is found, liferay dxp otherwise, it performs a fresh conversion and saves if the cache is turned off, liferay dxp always regenerates the file even if a previously existing conversion already exists in you can turn the cache off by setting the following property to configure liferay dxp to use openofficelibreoffice from the control panel, navigate to the server administration external services page and check the enabled box for openoffice. if openofficelibreoffice is running on a non-default portthe default is port 8100you must also specify the port if you have something else running on this port, find an open port and specify it both in the command to start openofficelibreoffice in server mode and on the control panel's external services configuration page. now liferay dxp can perform many types of document before configuring imagemagick to generate image and pdf previews, install it and its dependency, ghostscript. this differs by operating system on linux, both are likely already installed. they are not likely to be installed on download and install imagemagick download and install ghostscript once installed, enable imagemagick through the control panel or a following lines and make sure the search path points to the directories containing the imagemagick and ghostscript executables. configure the path for fonts used by ghostscript when in mac or unix to enable imagemagick from the control panel navigate to the server administration external services page check enabled for imagemagick and verify the paths to the imagemagick and ghostscript executables are correct some older versions of imagemagick don't run properly with liferay dxp. the case, update to the latest version imagemagick 6.7.9-6 2012-09-25 q16 or to check for the latest imagemagick versions, visit see lps-30291 for information on efforts to identify incompatible application versions with liferay dxp from the control panel, navigate to the server administration from the dropdown, select the xuggler.jar file that after installing, restart your application server and enable xuggler for your you can enable xuggler either from the control panel or by specifying the portal property that enables xuggler to enable xuggler from portal properties, add the following line to your url file and restart your application server to enable xuggler from the control panel, navigate to the server administration external services page, check enabled, and click you've successfully configured documents and media to use xuggler for the script tab includes a scripting console for executing migration or the groovy scripting language is supported out of the box. for more information on how to use the scripting console and examples if you ever need to shut down your liferay dxp server while users are logged in, you can use the shutdown tab to inform your logged-in users of the impending you can define the number of minutes until the shutdown and a custom liferay dxp displays the message at the top of users' pages for the duration of when the time expires, all pages display a message saying at this point, the server must be restarted to next, let's examine how to manage multiple portal instances.";;
a good user experience is the measure of a well-designed site. the last thing you want is for someone to grow frustrated with your site because of constant page reloads. a single page application spa is single page applications drastically cut down on load times by loading only a single html page that is dynamically updated as the user interacts and navigates through the site. this provides a native-app experience in liferay dxp, spa is enabled by default in your apps and sites and requires no changes to your workflow or code! this tutorial covers these key topics let's say you're surfing the web and you find a really rad site that happens to page load times are blazin' fast. site, scrolling along, when you find this great post that just speaks to you. you copy the url from the address bar and email it to all of your friends with the subject'your life will change forever.' you get a response back almost immediately. this is a rad site, but what post are you talking about? it reads you were in so much of a hurry to share this life-changing content that you neglected to notice that the url never updated when you clicked the post. you click the back button, hoping to get back to the post, but it takes you to the site you were on before you ever why have you failed me site? you cry if only there was a way to have a single page application, but also be able to cake and eat it too, thanks to sennajs sennajs is liferay dxp's spa engine. sennajs handles the client-side data, and ajax loads the page's content dynamically. while there are other javascript frameworks out there that may provide some of the same features, senna's only focus is spa, ensuring that your site provides the best user experience sennajs provides the following key enhancements to spa seo bookmarkability sharing or bookmarking a link displays the same search engines are able to index this content any time, allowing progressive enhancement. you can use your preferred method to render the server side e.g. html fragments or template views state retention scrolling, reloading, or navigating through the history of the page takes you back to where you were ui feedback the ui indicates to the user when some content is requested pending navigations ui rendering is blocked until data is loaded, and the content is displayed all at once timeout detection if the request takes too long to load or the user tries to navigate to a different link while another request is pending, the request history navigation the browser history is manipulated via the history api, so you can use the back and forward history buttons to navigate through the cacheable screens once a surface is loaded, the content is cached in memory and is retrieved later without any additional request, speeding up your page resources management scripts and stylesheets are evaluated from additional content can be appended to the dom for security reasons, some browsers won't evaluate therefore, sennajs extracts scripts from the content and parses them to ensure that they meet the browser loading you can read more about sennajs as well as see examples at url now that you have a better understanding of how sennajs benefits spa, you can learn how to enable and configure options for spa within liferay dxp next deployed and enabled, and you're all set to use spa. included with liferay dxp by default, you shouldn't have to do anything spa is enabled by default in your apps and sites, and requires no changes to your workflow or existing code! next you can learn how to customize spa settings to meet your own needs depending on what behaviors you need to customize, you can configure spa options spa caching and spa timeout settings can be configured in if you wish to disable spa for a certain link, page, or portlet in your site, you can do so within the corresponding element itself. configuration options are covered here to configure system settings for spa, follow these steps in the control panel, navigate to configuration system settings select the foundation tab at the top of the page note in prior versions of liferay, all spa render requests that didn't belong to a portlet no ppid in the url were cached indefinitely. confuse users, as the content they view is cached rather than the latest fresh since liferay portal ce 7.0 ga2 and liferay dxp 7.0 ga1, administrators can use the cache expiration time property to set an expiration time for the the following configuration options are available cache expiration time the time, in minutes, in which the spa cache is a negative value means the cache should be disabled request timeout time the time, in milliseconds, in which a spa request a zero value means the request should never timeout user notification time the time, in milliseconds, in which a notification is shown to the user stating that the request is taking longer than expected. zero value means no notification should be shown now that you know how to configure system settings for spa, you can learn how to disable spa for elements in your site next certain elements of your page may require a regular navigation to work properly. for example, you may have downloadable content that you want to share with the in these cases, spa must be disabled for those specific elements to disable spa on a portal wide basis, you can add the following line to your if there is a portlet or element that you don't want to be part of the spa, you to blacklist a portlet from spa, follow these steps set the url property to false if you prefer, you can set this property to false in your url instead by adding the following property to the alternatively, you can override the issinglepageapplication method to disable spa for a form or link follow these steps add the data-senna-off attribute to the element that's all you need to do to disable spa in your app now that you know how to disable spa, you can learn how to specify how resources by default, liferay dxp unloads css resources from the element on javascript resources in the, however, are not removed on this functionality can be customized by setting the resource's follow these steps to customize your resources select the resource you want to modify the default behavior for add the data-senna-track attribute to the resource set the data-senna-track attribute to permanent to prevent a resource alternatively, set the data-senna-track attribute to temporary to unload note the data-senna-track attribute can be added to resources loaded outside of the element as well to specify navigation behavior the example below ensures that the js resource isn't unloaded during navigation next you can learn about the available spa lifecycle events next during development, you may need to know when navigation has started or stopped sennajs makes this easy by exposing lifecycle events that represent state changes in the application. the following events are available beforenavigate fires before navigation starts. object with the path to the content being navigated to and whether to update the below is an example event payload startnavigate fires when navigation begins. endnavigate fired after the content has been retrieved and inserted onto this event passes the following json object these events can be leveraged easily by listening for them on the liferay global for example, the javascript below alerts the user to get ready to navigate to the url that has been clicked, just before spa navigation begins the alert takes advantage of the payload for the beforenavigate event, retrieving the url from the path attribute of the json payload object the above code results in the behavior shown below figure 1 you can leverage spa lifecycle events in your apps due to the nature of spa navigation, global listeners that you create can become problematic over time if not handled properly. you'll learn how to handle these spa provides several improvements that highly benefit your site and users, but there is potentially some additional maintenance as a consequence. traditional navigation scenario, every page refresh resets everything, so you don't have to worry about what's left behind. in a spa scenario, however, global listeners such as url or url or body delegates can become every time you execute these global listeners, you add yet another listener to the globally persisted liferay object. invocations of those listeners. this can obviously cause problems if not to prevent this, you need to listen to the navigation event in order to detach for example, you would use the following code to detach the event listeners of a global category event now you know how to configure and use spa in liferay dxp! configuring modules for liferay portal's loaders using es2015 modules in your portlet;;
you've successfully created a site for your liferay instance, but you may need to add new pages or edit existing pages. navigation section of the menu, your site pages can be accessed and if you're not currently on the site you'd like to edit, click the site selector button next to your current site name in the menu and select your desired site. to your pages are only made to the scope you've selected in the menu figure 1 the pages menu allows you to edit your site pages as a whole to add new pages to your site, click the options icon you'd like to add a page to and select add public page. select add private page to add a private site page. of options from the navigation menu including page name, page layout, and page you can also edit pages from the navigation menu. from the options icon next to a page or page set, which allows you to edit the page's basic information and configuration options figure 2 the options button next to a page or page set allows you to add a child page, edit the existing pages, or delete the pages in summary, the navigation menu is used to navigate to pages, create new pages, and note that you can also switch to managing a set of pages in click on public pages or private pages if private pages exist in your site to manage that page group liferay dxp's page groups are always associated with sites. pages are part of their personal sites. all pages belong to one of two types of page sets public pages and private pages. accessible to anyone, even non-logged in users guests. accessible only to users who are members of the site which owns the pages. means the private pages of an organization's site would only be viewable by site members and members of the organization regardless of whether the pages are public or private, liferay dxp uses the same you'll look at this interface more closely next from the navigation sub-menu in the main menu, you can add a page or child page to any existing page or page set by clicking the add page button. pages is selected on the left, clicking add page here adds a top level page making it a sibling page of the welcome page. you can, however, nest pages as to create a sub-page under the welcome page, select the add child page button next to welcome the add child page button lets you create child pages underneath the page you can nest pages as deep as you like but for every page below the top level hierarchy you should provide navigation to it via a navigation or breadcrumb app, at least with most themes including the default. can create themes which have cascading menu bars which show the full hierarchy. some examples of that are in liferay's plugin repositories note the navigation menu app lets you configure a root page. building navigation menus based on the page hierarchy under a specific page. you're given options in the navigation menu app's configuration menu to specify the root page, root page level, and included pages once you've selected the add page or add child page button, you're directed to an add new page interface that lets you configure the page to your liking. if you later decide you don't like the order of your pages, you can drag and drop them in the list to put them in whatever order you want note you're not forced to define the page hierarchy in a page's friendly therefore, child page friendly urls are not required to include their for example, a parent page named parent and its child page named child could have the urls siteurlparent and siteurlchild, the default friendly url given to a page is based only on the page name and not the hierarchy. if you wish to modify a generated friendly url, you can do so by following the go ahead and add another top level page and name it community figure 3 you can add a page to your site by giving it a name, page template, and page type when you create a new page, you can create either a blank page or a page prepopulated with apps from a page template. of the page, you can select from a list of page templates that are currently you can learn more about page templates and how to use them in the to view the page you've added, click the page name from the left panel. by default, all pages are created as an empty page but in some situations, you might want to use one of the other options. you can take a look at all the page options you have below, along with their respective descriptions empty page the default pages that are used. can drag and drop portlets into. this page type creates an empty page with content display page are used to search available content, explore related content with tags, and browse content catagories. dedicated to managing web content from a page blog display content related to blogs. this is a specialized page dedicated to creating, editing, and viewing blogs wiki display content related to wikis. dedicated to creating, managing, and viewing wiki articles from a page page set exists as a container that holds child pages. because the page holds no content and has no purpose but to hold other child pages, there is no friendly url for this page. cannot serve as a landing page for a site panel can have any number of portlets on them, as selected by an administrator, but only one will be displayed at a time. portlet they want to use from a menu on the left side of the page and the selected portlet takes up the entire page link to url are redirects to any url specified by an administrator. use url pages to create links to pages belonging to other sites of your liferay instance or to pages of an external site. use url pages cautiously since blind redirects create a poor user experience embedded display content from another website inside of your instance. an administrator can set a url from in the page management interface and that page will appear in the context and within the navigation of your liferay to embed an external website, you must provide the protocol in the url full page application creates a page with one column that displays a single link to a page of this site creates a page which functions as an immediate redirect to another page within the same site. you can select which page to link to from a dropdown in the page management interface. page of this site to place a deeply nested page in the primary navigation menu copy of a page of this site displays a copy of a pre-existing page in your now that you know the basics of adding site pages, you can start working on the if you're not currently on the site you're interested in adding pages to, navigate to site administration in the menu, select the compass icon next to the current site name, and select the site you wish to edit if you're creating a site with many pages and sub-pages, the side panel view may in the navigation menu, you have the option to expand the pages view to allow for more room to work. select the page set's options icon and select expand to see a full view of your page hierarchy figure 4 expanding your page view gives you much more room to visualize your page hierarchy as stated previously, if you ever need to modify the page you've created for your site, select the configure page button from the options button from the when configuring a specific page, you're given more options than when you were creating a new page. configuring specific pages are covered in more detail later in this section there are also configuration options that are only available for either indiviual pages or page groups only. you'll learn about options available for you should be able to define and manage pages in liferay at this point so next, you'll look at the options you have available for configuring your public or private pages as a whole, and the individual pages residing within those groups when you select configure for a page set, it defaults to the look and feel on this tab, you're presented with an interface that allows you to choose a themes can transform the entire look of the portal. they are created by developers and are easily installed using the liferay since you don't have any themes beyond the default one installed yet, you'll use the default theme for your pages figure 5 the look and feel interface allows you to choose a theme for the current site you can apply themes to individual pages as well by selecting the configure page option for a page and selecting the define a specific look and feel for this page option under the look and feel figure 6 you can define a specific look and feel for a page many themes include more than one color scheme. existing look and feel while giving your site a different flavor. schemes option is not available for the default theme there are a few more configurable settings for your theme. bullet style between dots and arrows and you can choose whether or not to show maximizeminimize application links by default. enter custom css that will also be served up by your theme. tweak a theme in real time by adding new styles or overriding existing ones the next option configures the logo that appears for your site by default, the liferay logo is used for your site pages' logo. use your own logo for a specific site, use the logo tab. is easy select the logo tab from the configure interface and browse make sure your logo fits the space in the top left corner of the theme you're using for your web site. up with a site that's difficult to navigate, as other page elements are pushed in the logo tab, you can also choose whether or not to display the site name on if you check the box labeled show site name, the site name will this option is enabled by default and cannot be disabled if the allow site administrators to set their own logo option is removing the site name is not available for the default site only newly created sites and user pages have the option to have if you click on advanced for a page set either public pages or private pages, you'll find a window where you can enter javascript code that will be executed at the bottom of every page in the site. javascript as is usually the case, it's best to add custom javascript code to the theme and not in this window. this way, all of your site's javascript code using the javascript window may be useful if your site's theme does not use in this case, the javascript window will contain all of your site's javascript and you can add some dynamic features to your site's pages next, you'll look at an advanced features of the configure interface merging the current site's pages with the pages of the default site if you click on advanced advanced from the edit public pages interface, you'll find an option to merge the public pages of your instance's default site with the public pages of the current site. option, the pages of the default site appear in the current site's navigation menu, along with the current site's pages. also, the pages of the current site appear in the navigation menu of the default site, along with the default site's this merging of pages only affects the list of pages in the default site's and the current site's navigation menus. navigate from the current site to the default site, and vice versa. can be enabled for the public pages of both personal sites and regular sites note that this merging of pages is not a hard merge. the site administrators of twenty different sites on your liferay instance all enabled the merge liferay public pages option. different sites be merged into each site's navigation menu? instead, liferay dxp keeps track of the current scopegroupid the id of the current site and the previous scopegroupid the id of the previously visited if the merge liferay public pages option is enabled for either the current site or the previous site, the pages of the default site are merged in for example, suppose that your liferay instance has three sites the default site, site a, and site b. all three sites have some public pages. logs in, he's directed to the default site. the scopegroupid is that of the default site and there is no previous scopegroupid, so no additional pages appear in the default site's navigation menu. then suppose the user navigates to site a. site a has the merge liferay public pages option enabled, so the default site's pages are added to site a's navigation menu. back to the default site, site a becomes the previous site so site a's pages are added to the default site's navigation menu. if the user navigates to site b, no additional pages appear in site b's navigation menu because site b does not have the merge liferay public pages option enabled. to the default site, site b becomes the previous site, and, again, since site b does not have the merge liferay public pages option enabled, no additional pages are added to the default site's navigation menu you can configure your page set for mobile devices by selecting the advanced tab and selecting mobile device rules option. the ability to modify themes for regular browsers and mobile devices can only be accomplished by using this mobile device rules are inherited from your public pages, but you can with the ability to define different rules per page, you can edit the look and feel of specific pages for mobile devices, if you're using virtual hosting for this site, you can configure url rules for the domain by selecting the robots option from the advanced tab. the robots page gives you the option to configure your url for both public and private pages on a site. if you don't have virtual hosting set up, if you select the sitemap option from the advanced tab for a page set, you can send a sitemap to some search engines so they can crawl your site. the sitemap protocol, which is an industry standard. to yahoo or google and their web crawlers will use the sitemap to index your liferay dxp makes this very simple for administrators by generating the sitemap xml for all public web sites by selecting one of the search engine links, the sitemap will be sent to them. it's only necessary to do this once per site. periodically crawl the sitemap once you've made the initial request if you're interested in seeing what is being sent to the search engines, select the preview link to see the generated xml next, you'll learn how to customize individual site pages when you decide to customize a single page, some different options that were not available when initially creating a page appear. customizing a specific page can be done by navigating to the navigation menu in the main menu and selecting the options icon next to the specific page you'd like to edit from the navigation from the options dropdown, select configure page. that the options for customizing a specific page can be defined under. learn what each group offers for your site pages managing your page's content drastically improves your page's organization and the site page's configuration options offers some oppurtunities you can explore ways to tag and categorize your page by clicking the seo tab, which shows how the categorization options by default. administrators organize the page and allows for users to easily find your page and its content through search and navigation. organizing content with tags and categories custom fields lets you edit the custom fields you already have configured for the page resource, which is accessible from the advanced tab. have any custom fields configured in your site, this option is not available. you don't have any custom fields configured for the page resource, you can navigate to the control panel custom fields located under the these are metadata about the page and can be anything you like, such as author or creation date. for more information on custom fields, one of the most important tasks for administrators is ensuring the user experience is easy and enjoyable. there are configuration options that aid in providing a seamless user experience for your site page the first option you're given and the default option selected when customizing an individual page is details. this option lets you name the page for any localizations you need, set whether the page is hidden on the navigation menu, set an easy to remember, friendly url for the page, and select the page type. plus you can specify how apps are arranged on a page. installed templates to modify the layout note if you require a more complex page layout, you can install the liferay layout templates app from liferay marketplace to access four additional layout templates it's easy for developers to define custom layouts and add them to the list. is covered more thoroughly in the tutorial layout templates with the liferay theme generator the look and feel option lets you set a page-specific theme. what you already have configured for your page sets' theme, or you can uniquely customizing the look and feel of site pages this option allows you to apply rules for how this page should be rendered for you can set these up by navigating to your site administration dropdown menu and selecting configuration mobile device this option only appears if you have embedded one or more portlets on previous to liferay dxp 7.0, you were able to embed portlets on a page by acquiring their portlet id and using a runtime-portlet tag in the web content display app to embed a portlet on a page. applications can now be embedded on a page via web content template. also, you can embed a portlet in themes programmatically. if you're interested in learning more about this, visit the this configuration option located in the advanced tab lets you mark specific sections of the page you want users to be able to customize. about page customizations in the your page's configuration options offers several opportunities to improve your page's data optimization and javascript, among others. intelligence, configure the options described below seo provides several means of optimizing the data the page provides to an indexer that's crawling the page, which is accessible from the seo tab. can set the various meta tags for description, keywords and robots. a separate robots section that lets you tell indexing robots how frequently the page is updated and how it should be prioritized. can select a box to make liferay dxp generate canonical links by language. want to set some of these settings for the entire site, you can specify them from the sitemaps and robots tabs of the manage site settings dialog box see in previous versions of liferay, it was possible that a single page could be indexed multiple times. in liferay portal 6.1, all urls that direct to the same page will only create one entry in the index. versions of the url which provided additional information about the referring page had different entries in the index. point of view, this will make your pages rank higher since any references to variations of a specific url will all be considered references to the same if you click on advanced javascript, you'll find a window where you can enter javascript code that will be executed at the bottom of your page. your site's theme uses javascript as is usually the case, it's best to add custom javascript code to the theme and not in this window. your site's javascript code remains in one place this configuration option is also available for page sets like public pages and section for more information on doing this for page sets the advanced option contains several optional features. string to provide parameters to the page. this can become useful to web content templates, which you'll see in the next chapter. page so that it either pops up in a particularly named window or appears in a and you can set an icon for the page that appears in the navigation next you'll learn how to add applications to a site page liferay dxp pages are composed of applications. all of your site's functionality, from blogs to shopping, is composed of apps. displayed through web content display apps. to add an app to a page, just click from the top menu and select you can either browse through the categories of available apps until you find the one you're looking for or you can search for once you've found an app, click the add button to add it to the once it's been added to the page, you can drag it to a new alternatively, you can drag the app directly from the applications menu to a specific location on the page. follow the steps below to add some collaboration apps to the lunar resort site see how easy it is to add applications to your pages? app and blogs aggregator app to a page figure 7 your page layout options are virtually limitless with a slew of application and layout combinations it's easy to make your pages look exactly the way you want them to. default layout options provided aren't enough, you can even develop your own. for more information about developing custom layout templates, see the tutorial next, you'll practice personalizing pages using page customizations! administrators can designate pages or sections of pages to be customizable. a user visits such a page, a notification appears stating that the user can users can make customizations only in the sections of pages customizations are based on the rows and columns page customizations are only visible to the user who made the by default, site members can make page customizations but non-site members and guests can't to enable page customizations as an administrator, first click configure page from the options button next to the page you'd like to let site members then select the advanced tab at the top of the page, expand the customization settings area, and click on the customizable selector button figure 8 to enable page customizations, click on the configure page button next to the page, expand the customization settings area, and click on the customizable button once you've enabled the customizable selector, you can select the sections of the page you'd like to enable customization for, depending on the layout enable one or more of the customizable sections to allow site members to customize certain sections of the page. you've designated as customizable are colored blue when site members visit your customizable page, they'll see an extended control menu with a notification saying you can customize this page. toggle whether to view or hide the customizable regions. selector to view customizable regions, the regions on the page are color-coded to help distinguish customizable vs. non-customizable sections of the page figure 9 customizable regions are colored green and non-customizable regions are colored red site members can also choose between viewing their customized page and viewing the default page by selecting the options button clicking the view page without my customizations or view my customized page there's also a reset my customizations option available from the options button that restores a user's customized page to match the default page. allows users to discard one set of customizations and start a new set without having to manually undo each customization that they'd previously made note that non-administrator site members can access the add menu from the top right side of the screen when viewing their customizable page even if they don't ordinarily have permission to view this menu. this allows them to add apps to the sections of the page that they're allowed to customize. page without my customizations, the add menu will disappear from the menu since they're not allowed to modify the default page administrators of customizable pages have the same two views as site members the default page view and the customized page view. default page affect all users, whereas changes made to the customized page affect only the administrator who made the changes. administrators to non-customizable sections in the default view are immediately changes made by administrators to customizable sections, however, do not overwrite users' customizations users can make two kinds of customizations to customizable regions. can configure applications within the customizable regions. apps to or remove apps from the customizable regions figure 10 customizable areas are highlighted green when organizing apps on the page liferay dxp doesn't allow users to change a non-instanceable app's configuration inside a customizable region since those kinds of apps are tied to the site to if this were allowed, the customization would affect all users, not just the one who customized the region. app configuration in a customizable region are only possible for instanceable apps, whose app configuration only affects that one user for example, suppose that you, as an administrator, selected the right column of the welcome page of the lunar resort site to be customizable. lunar resort site could take the following steps to make a personal customization of the welcome page the language selector application is useful to have on your homepage if you expect users who speak different languages to access your instance. select their language in the language selector app to view a translation of your site into their native language. after closing the configuration dialog box of the language selector app, the customized welcome page looks like this figure 11 in this example, the user added the language app, and changed the display style from icons to a select box to allow users to customize a page, administrators must grant users permission to customize pages under the site section. this can be achieved by assigning permission to a role, then assigning this role to the appropriate users. example, if you want any logged user to be able to customize your customizable pages, you could assign the customize permission to the role user. want site members to be able to customize the customizable pages of their sites, you would accept the default setting. by default, the customize permission is assigned to the role site member in addition to granting the ability to customize app configurations, the customize permission allows users to customize the look and feel of apps and to import or export app settings. next, you'll look at how to change page by default, public pages are just that public. and private pages are really only private from if someone has joined your site or is a member of your organization, that person can see all the private pages. modify the permissions on individual pages in either page group so only certain suppose you want to create a page only for administrators to see. this with the following procedure figure 12 the permissions offer a plethora of options for each role you've changed the permissions for this page so only site any users you add to this role can now see the page. other users, even members of this site, won't have permission to see it pages in liferay dxp are as flexible as pages you'd create manually without a using a point and click interface, you can define your site you can create and remove pages, export and import them, set their layouts, define how they are indexed by search engines, and more you now understand how to manage pages in liferay dxp. to further customizing those pages for mobile devices and building standardized;;
as you've now seen, creating pages can be repetitive. you could create multiple pages from a single template? templates in liferay dxp let you do exactly that! they also inherit future changes now you'll use page templates in the lunar resort. template, then you'll use it to create several pages. to the template and see liferay dxp propagate those changes to the pages you use these steps to create a page template open the main menu and select control panel sites page the page templates page lists all the page templates in the three page templates come bundled with liferay dxp. and wiki are example layouts for the blogs and wiki applications. display page serves a special function that you'll work with later figure 1 the page templates page you to the page template creation page name the template lunar guide page for the description, enter page with information about a lunar guide this takes you back to the list of page templates, where you can see the new template in the list editing a page template is similar to editing any page. applications onto the page and reposition or remove them as desired. difference is that you can't directly add content, and some configuration and display options are disabled it's a template, after all. edit the page template you just created in the list of page templates, click lunar guide page. figure 2 click the page template to edit it in the page template's edit toolbar click the add button on the upper right and expand the applications collaboration category. close the page template's edit tabwindow. liferay dxp automatically saves next, you'll create a page with this template follow these steps to use the template to create a page open the main menu and select the lunar resort navigation in the navigation menu, click the options button for public pages and select name the page cody cody is one of our lunar guides this selects your page template as leave inherit changes set to yes. this lets you edit this page in the future by editing the template, but removes the ability to edit the page liferay dxp then creates the new page from your template. of these pages, one for each lunar guide cody is awesome, but he can't do note, however, that cody's page is in the navigation bar to get his page and those of the other lunar guides under the lunar guides page, you must nest the pages.;;
liferay dxp's documents and media features provide tools for uploading, organizing, and displaying various types of documents and media, including for example, you can use documents and media for collaborating on files like text documents or spreadsheets, managing collections of images, or simply storing the images that your web content references you've been using documents and media without knowing it. when creating web content were automatically added to the documents and media but there's a more efficient way to add images to documents and media. you can add many images at once, directly in the documents and media library. this saves you a step when creating content that uses those images. directly in the documents and media library also lets you organize your files in folders just as you would on a traditional desktop environment now you'll take advantage of these features in the lunar resort you still need to create more content in the lunar resort, and this content you'll upload all these images now in the documents and media media screen appears and displays the documents and media library's home note that the images you added while creating figure 1 the documents and media library's home folder contains the lunar resort's existing images at the bottom-right of the page and use the add multiple documents screen to add the images you can either drag and drop the files from your file system to the box, or click select files to select the files via a if you wish, you can also categorize and describe the click publish to complete the upload figure 2 the documents and media library lets you add multiple documents at once the lunar resort's documents and media library now contains more imagesenough to warrant organizing them in folders your documents and media library is now a bit more crowded. besides basic file organization, you can also use folders for managing access to files via permissions follow these steps to add some folders to the lunar resort's documents and media return to the documents and media library's home folder name the folder web content images, and give it the description images used in lunar resort web content this returns you to the documents and media library's home folder, where your new folder is now available repeat the steps above to folders named frontpage images and lunar guides to the home folder the lunar resort's documents and media library now contains two folders. you'll use them to organize images next before moving your files into the new folders, it's important to know that you can move files that are currently in use, without issue. of web content uses an image, and you move that image to a different documents and media folder, you don't need to update that web content with the image's new liferay dxp maintains such file connections for you follow these steps to move files to your new folders return to the documents and media library's home folder and check the boxes on the images url, url, and url drag and drop the selected images to the web content images folder figure 3 the documents and media library lets you drag and drop files into a folder the next screen lets you review and confirm the move. change which files are included, and their destination. repeat these steps to move the guide images to the lunar guides folder and the home folder's remaining files to the frontpage images folder now your documents and media library contains the images you need you also learned how to upload and manage files in next, you'll learn about creating more complex content and styles using structures and templates.;;
things we use every day are made of carefully designed, created, and tested for example, a car has an engine, suspension, and air conditioner. teams of engineers, machinists, and technicians make these subsystems the best they can be separately before combining them to create a high quality car. is modularity in actioncreating things from smaller well-designed, well-tested it comprises code modules created and tested it's a platform on which modules and modular applications are installed, started, used, stopped, and uninstalled. components use the osgi modularity standard these tutorials demonstrate developing osgi services and components to customize liferay dxp and create applications on it. as liferay's developers used modules to create liferay dxp and its applications, you and your teammates can enjoy developing your own modules, applications, and customizations in parallel on;;
"an administrator can access the look and feel configuration menu of any liferay dxp application by clicking on the options icon at the top right corner of the app and selecting look and feel configuration. icon may vary, depending on your theme. liferay apps' look and feel dialog boxes after making customizations on any tab, remember to click the save button to to see the effect of your changes, you may have to refresh if you don't like the effect of your changes, click the reset on the general tab, you can enable the use custom title selector to the value you enter in the title box will be displayed at the top of the app's window on the page. a language from the app title drop-down menu. key translation for the language you select, then your app's title will be displayed in the selected language figure 1 to illustrate using a custom title, the asset publisher's default title has been replaced with a more appropriate heading if you select a page in the link portlet urls to page drop-down menu, all urls inside the portlet link to the context of the page you selected. includes pagination links created by the portlet. this is intended to be an elegant way to show web content articles' full view from the asset publisher. if you use the view in a specific portlet feature or web content articles' display page attribute, you must be careful since it redirects all links and not just links to assets. you can also choose whether or not to apply application decorators to your app. decorators can be used to add contrast between your app and the page. three decorators available barebone, borderless, and decorate. decorate application decorator is applied by default. app borders off; some themes assume that app borders are turned on and may not display correctly with them turned off figure 2 the general tab of the look and feel configuration menu allows you to define a custom app title, link app urls to a specific page, and select the app contrast option using decorators the text styles tab allows you to configure the format of the text that appears the fonts you can choose from include arial, georgia, times new roman, tahoma, trebuchet ms, and verdana. text to bold, italics, or both. you can set the font size anywhere from 0.1 em to 12 em, with 0.1 em increments. color to any six digit hex color code. if you'd like help choosing a color, click on the text box to open the color palette. to left, center, right, or justified. justified text is both left and right you can set an underline, overline, or strikethrough as the text the default text decoration is none figure 3 the text styles tab lets you configure the format of the text that appears in the app you can set the word spacing anywhere from -1 em to 0.95 em, with 0.05 em you can set the line height anywhere from 0 em letter spacing anywhere from -10 px to 50 px, with 1 px increments. the background styles tab allows you to specify the app's background color. when you select the text space, you're given a color palette to choose your background color or you can manually enter any six digit hex color code figure 4 the background styles tab lets you specify the app's background color on the border styles tab, you can configure your app's border width, style, and for each of these attributes, leave the same for all selector enabled to apply the same settings to top, right, bottom, and left borders figure 5 the border styles tab lets you specify a border width, style, and color for each side of the app border style, you can select dashed, double, dotted, groove, hidden, inset, for border color, you can enter any six digit hex color code, just like for the text color and background color. the margin and padding tab allows you to specify margin and padding lengths for just like for border styles, leave the same for all selector enabled to apply the same settings to each side top, right, bottom, figure 6 the margin and padding tab allows you to specify margin and padding lengths for the sides of your app for both padding and margin, you can specify any value, em value, or px the advanced styling tab displays current information about your app, including your app's liferay id and css classes figure 7 the advanced styling tab displays your app's liferay id and allows you to enter css code to customize the look and feel of your app on this tab, you can also enter custom css class names for your app and custom clicking the add a css rule for just this portlet or add a css rule for all portlets like this one links adds the css code shells into your custom if you check the update my styles as i type box, your css code will be dynamically applied to your app so you can see the effects of your next, you'll learn about exporting and importing app data.";;
liferay follows the owasp top 10 2013 and cwesans top 25 lists to ensure that liferay dxp is as secure as possible. following these recommendations protects the portal against known kinds of attacks and security vulnerabilities. example, liferay dxp's persistence layer is generated and maintained by the service builder framework which prevents sql injection using hibernate and parameter to prevent cross site scripting xss, user-submitted values are escaped on to support integration features, liferay dxp doesn't encode input. stored in the original form as submitted by the user. protection against csrf attacks, local file inclusion, open redirects, uploading and serving files of dangerous types, content sniffing, clickjacking, path traversal, and many other common attacks to stay on top, liferay dxp also contains fixes for state-of-the-art attacks and techniques to improve product security. liferay dxp also contains mitigation for quadratic blowup xxe attack, rosetta flash vulnerability, reflected file download, and other kinds liferay dxp user authentication can take place using any of a variety of prepared note although liferay's sso solutions are incompatible with webdav, they can be used in conjunction with liferay sync. article for more information on webdav and liferay sync remote application authentication and authorization can be done using the both user authentication and remote application authentication are extensible developers can create custom login portlets and plugins, extend the default login portlet url, create autologin extensions for sso, or create custom authverifier implementations there are several adjustable authorization layers in place to prevent unauthorized or unsecured access to data liferay dxp supports other features, too. liferay dxp users can be assigned to sites, teams, user groups, or organizations. custom roles can be created, permissions can be assigned to those roles, and those roles can be applied to users. are scoped to apply only with a specific context like a site, an organization, see liferay dxp's roles and permissions not yet written documentation for more information note liferay dxp relies on the application server for sanitizing crlf in you should, therefore, make sure this is properly configured in your application server, or you may experience false positives in reports from automatic security verification software such as veracode. exception to this for resin, which does not have support for this feature. this case, liferay dxp sanitizes http headers there are additional security plugins available from liferay marketplace. audit plugin for tracking user actions or an antisamy plugin for clearing html liferay dxp provides plenty of configuration options that allow its various security features to be fine-tuned or disabled. these kinds of configuration actions liferay dxp also provides tools to fight vulnerabilities in code for secure development, it's important to have security-mined colleagues in these individuals should consider the security aspects of each stage it's important to start a discussion about security early in the project-planning stage so that threats to user privacy, data, and later, during the implementation phase, developers can use the following list of apis to address some of the most common vulnerabilities. be used consistently across liferay dxp before releasing a product, it's important to hack yourself first. should conduct penetration tests or source code reviews to catch the low-hanging security-flavored fruit. external penetration testing is also an it's becoming a more popular and less expensive here's short list of liferay dxp security apis liferay dxp is built using the secure by default concept in mind. liferay dxp's default configuration is already very secure. disable built-in protections or to allow all values in security white-lists. such acts may lead to security misconfiguration and an insecure liferay dxp for more information about securing a liferay dxp installation, please see and the resources listed on those pages also, liferay dxp customers are advised to deploy security patches as described on the customer portal for community and ce deployments, the only way to stay secure is to use always the latest community version, which contains all previous security patches. until a new version is released, the community security team issues patches for;;
mobile device families allow you to configure sets of rules to alter the behavior of the instance based on the device being used to access liferay dxp. proportion of mobile device users browsing the web has been steadily increasing, so it's important to be able to handle different kinds of devices appropriately. for instance, you can configure the look and feel of liferay pages accessed by smartphone or tablet users differently from those accessed by pc users both sites and individual pages can be configured with any number of mobile a family is designed to describe a group of devices. contain one or more rules that describe a category of devices, such as all android devices or all ios tablets. you can define as many rules in a family as you need to classify all the devices for which you'd like to define actions. families can be prioritized to determine which one applies to a given page in order to configure mobile device rules, you need a way to find out the while some of the characteristics are provided by for this reason, there are databases that contain information about thousands of devices. these databases make it possible to learn every detail about a device from the device type, which is included in liferay dxp's mobile device rules can connect to device databases so that you can use their device characteristics in your rules important for the features described in this article to work, you must install the liferay mobile device detection lmdd app from the liferay this app provides the device detection database that's required for your liferay dxp instance to detect which mobile devices are accessing it. that if you're running liferay dxp, you must install for instructions on using liferay marketplace to find and install apps it's possible to develop plugins that integrate with other device databases. even if you don't have a device database, you can still set up mobile device they 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 to learn how to tap into liferay dxp's device api, see the using the device recognition api you can access the mobile device families administrative page from the configuration section of site administration. you can also add families for all sites by navigating to the control panel the mobile device families administrative page displays a list of defined families and lets you add more. family, select the device family name and select the add button figure 1 you can manage device rules by clicking on a mobile device family 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 you'll notice after saving the classification rule that it's characterized as a simple rule. by default, only the simple rule the rules are designed to be extensible, and additional rule types can be added by your developers 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'll be ready to set up some actions. the actions defined for a family determine what happens to a particular request when the device is detected and the family has been found to apply tip the audience targeting application offers a device rule that evaluates whether the user is accessing content using a particular device this rule is integrated with the mobile device families app. the liferay audience targeting rules you can add actions to a family from the navigation menu of site administration. select a page set's e.g., public pages options then select the advanced tab and the mobile device rules option in the use the select button to select families to be applied either to a page group or to a single page. if you select the page group itself from the left-hand menu, the selected family applies to all the pages of the site by if, however, you select an individual page and then click the select button, the families apply only to that page. you can select multiple families for a particular site or page and order them by priority. checked in decreasing order of priority the actions defined by the first family figure 3 you can select a mobile device family to apply for a site or page from the navigation section of site administration to add actions to a selected rule group, use the actions by default, there are four kinds of actions that can be configured for mobile families layout template modifications, theme modifications, url redirects, and site redirects. let you change the way portlets are arranged on pages delivered to mobile devices, and themes modifications let you select a specific look and feel. makes more sense for you to create separate mobile versions of certain sites or pages, you can use a redirect to make sure mobile device users get to the right to define a url redirect, you need to specify a url. redirect, you need only specify the site name and page name of the page to which like mobile device rules, mobile device actions are designed your developers can define custom actions in addition to the four actions provided by default to review, if you'd like to configure an action or actions that take place when mobile device requests are received, take the following steps create a mobile device family to represent the group of devices for which to define one or more rules for your family that describe the group of devices represented by your family apply your family to an entire page set of a site all the public pages of a site or all the private pages or to a single page define one or more actions for your family that describe how requests should to see how this might work in practice, you'll study a few examples of how you first, suppose you have a separate version of a site on your liferay instance that's specifically designed for mobile phones for this example, you'll make a site called androidbada liferay and you'll configure the default liferay site to redirect incoming requests from android or bada mobile phones to the androidbada liferay yur first step is to create the androidbada liferay site go to the sites option of the control panel and click add androidbada liferay and click save. then add a page called welcome to now your androidbada liferay site has a public welcome page just next, select the default liferay site in the site selector of the menu, navigate to site administration configuration, and click on mobile and bada mobile phones, and click save click the device family link to configure the rule group to apply only to mobile phones running android or bada. system, select android and bada os hold down control to make multiple selections, select other devices under tablet since you want your family to apply only to mobile phones, and click save. now you just need to define the redirect action for your family. navigate to navigation, select options next to public pages and click on advanced mobile device rules in the figure 3.31 to apply a mobile device family to a page set of a site, click on mobile device rules, click select, and select the desired rule group click select and then click the android and bada mobile phones device family once you've selected your device family, click on your device family's actions manage actions. enter the name androidbada liferay redirect, and select redirect to site under the site dropdown menu that appears, select androidbada liferay and under the page dropdown menu that appears, select the welcome bada mobile phone users are redirected to the androidbada liferay site from the now you'll look at one more example of using mobile device rules before you move suppose you'd like to create another rule so that when a site is accessed by an android or ios tablet, a different layout is used. to follow the same four steps described above. liferay site by checking in the site selector of the menu. mobile device families page of site administration. called android and ios tablets. add a classification rule called rule 1, select android and iphone os under the operating system heading, select tablets under the device type heading, then click save. previous example, you only need one rule to describe your device family next, click on navigation in site administration, select mobile device rules, and select the android and ios tablets device family. you've now selected two rule groups for the liferay site's public pages and they've been assigned priorities. if a device making a request belongs to both of the device families represented by the rule groups, the priority of the rule groups determines which rule group's actions are executed. example, the first rule group contains only mobile phones and the second rule group contains only tablets, so no devices can belong to both rule groups. you just need to define an action for your android and ios tablets rule group to use a different layout on the edit page of your page group, click on mobile device rules, and then on actions manage actions next to click on add action, enter the name layout template modification, and select the layout template modification action type. lastly, select the 1 column layout template or whichever one you like and now the liferay site's pages are presented to android and ios tablet users with the 1 column layout template.;;
liferay home is one folder above jboss's install location download and install jboss as 7.1.x into your preferred directory. directory is referred to as jbosshome throughout this section download the latest version of the liferay portal.war file now that you have all of your installation files, you are ready to start installing and configuring liferay on jboss let's work with the dependency jar files first create the folder jbosshomemodulescomliferayportalmain. the liferay portal dependencies zip file and copy the.jar files to this download your database driver.jar file and copy it into the same folder. for example, for mysql, download the mysql connectorj driver from url and put its.jar file into the jbosshomemodulescomliferayportalmain check the database vendor's documentation to be sure you're using the liferay portal ships with default drivers that may or may not be matched to the version of the database you're using jbosshomemodulescomliferayportalmain folder and insert the following make sure to replace version with the correct version of the mysql jdbc if you are using a different database, replace the mysql jar with the driver jar for your database jboss 7.1 can be launched in either standalone mode or domain mode. mode allows multiple application server instances to be managed from a single a collection of such application servers is known as a domain. for more information on standalone mode vs. domain mode, please refer to the section on this topic in the jboss 7.1 admin guide. liferay fully supports jboss 7.1 when it runs in standalone mode but not when it you can run liferay on jboss 7.1 in domain mode, but this method is not fully in particular, liferay's hot-deploy does not work, since jboss 7.1 cannot deploy non-exploded.war files in domain mode. are in the domaindatacontent directory. deployments are only possible using this prevents many liferay plugins from working as for example, jsp hooks don't work on jboss 7.1 running in domain mode, since liferay's jsp override mechanism relies on the application server reloading customized jsp files from the exploded plugin.war file location. other plugins, such as service or action hooks, should still work properly since they don't require jboss to access anything such as jsp files from an exploded.war file on the file system note this does not prevent liferay from running in a clustered environment you can set up a cluster of liferay instances running on jboss 7.1 servers running in standalone mode. configuring liferay for high availability for information on setting up a liferay cluster let's make some adjustments in your configuration to support using liferay you can specify the jboss server instance's configuration in the xml file modifications to your configuration and startup scripts found in the lastly, you'll need to make some modifications in let's start with the changes to url make the following modifications to url add the following system properties between the and add a timeout for the deployment scanner by setting deployment-timeout240 as seen in the excerpt below add the following jaas security domain to the security subsystem disable the welcome root of the web subsystem's virtual server default host by specifying enable-welcome-rootfalse insert the following element inside the web subsystem now it's time for some changes to your configuration and startup scripts make the following modifications to your standalone domain's configuration script file url url on windows found in your these modifications change the following options make the following edits as applicable to your operating system on windows, comment out the initial javaopts assignment as demonstrated in then add the following javaopts assignment one line above thejavaoptsset line found at end of the file on unix, merge the following values into your settings for javaopts, replacing any matching attributes with the ones found in the assignment make sure you replace the jbosshome references with the appropriate you'll notice some java security options. the java security options in the security configuration section lastly, navigate to the url file and insert the following path names inside the... element the added paths resolve issues with portal deployment exceptions and image uploading problems on a liferay portal instance running on jboss 7.1.x warning there are a few known issues with jboss 7.1.1 that should be noted when using your liferay instance with it the prescribed script modifications are now complete for your liferay next you'll configure mail and the database if you plan on using the ibm jdk with your jboss application server, follow the if you plan on using another type of jdk, you can currently, there are bugs in the additional steps to ensure a successful deployment with liferay insert the following dependency within the element next, you'll need to include a patch from liferay's source code for one of this can be done by downloading the liferay-portal repository's zip file by clicking download zip on the you've downloaded the liferay source, unzip the source into a temporary folder. this location will be referred to as liferaysource in summary, you'll need to update the url file in the jboss-as-jbossversion url file to specify the ibm jdk. steps to insert the patch can be referenced below copy the jboss-as-jbossversion url file from jbosshomemodulesorgjbossasservermain to the in a command prompt and enter the following statement this command inserts the url file into the orgjbossasserverdeploymentmodule folder. official documentation for updating a jar file at copy the jboss-as-jbossversion url file back to its original lastly, you'll need to make a few changes in your jbosshomemodules create the folder jbosshomemodulesibmjdkmain. insert the following contents into the your jboss application server is now configured to use the ibm jdk. learn about managing a data source with jboss if you want jboss to manage your data source, follow the instructions in this if you want to use the built-in liferay data source, you can skip this modify url and add your data source and driver in the element of your data sources subsystem first, add your data source inside the element be sure to replace the database name i.e. lportal , user, and password the appropriate values add your driver to the element also found within the your final data sources subsystem should look like this now that you've configured your data source, the mail session is next if you want jboss to manage your mail session, use the following instructions. if you want to use the built-in liferay mail session, you can skip this section specify your mail subsystem in url as in the following example next, you'll make sure liferay can connect using your new mail now that your data source and mail session are set up, you need to ensure first, navigate to the liferay home folder, which is one folder above jboss's if you're using jboss to manage your data source, add the following configuration to your url file in your liferay home to if you're using liferay portal to manage your data source, follow the instructions for using the setup wizard if you're using liferay portal to manage your mail session, this configuration is done in liferay portal. portal as described in the deploy liferay section, go to control panel server administration mail and enter the settings for your if you're using jboss to manage your mail session, add the following configuration to your url file to reference that mail before you deploy liferay portal on your jboss app server, you should enable and configure java security so you can use liferay's plugin security manager with your downloaded liferay applications when you're ready to begin using other people's apps from marketplace, you'll want to protect your portal and your jboss server from security threats. so, you can enable java security on your jboss server and specify a security policy to grant your portal access to your server remember, we set the url and url java options in the url file earlier in the configuring jboss the url java option enables security on likewise, the url java option lists the permissions for your server's java security policy. options, you'll need to do so before using java security this configuration opens up all permissions. you can tune the permissions in create the url file and add the for extensive information on java se security architecture, see its also, see section understanding plugin security management in the developer's guide to learn how to configure liferay plugin if you plan on using jsf applications in your application server, follow the in this section, you'll learn how to upgrade mojarra and weld so your app server's versions are identical to the versions used by liferay some versions of jboss 7.1.x are not bundled with the correct mojarra version necessary to use liferay faces. for example, jboss as 7.1.1 comes with mojarra you'll need to download a newer version of the url and url and copy it to the following location comment out the reference to the version of the jar that comes with the add a reference to the new jar in the same url file add the following module to the section you've officially upgraded mojarra! that you're using the correct version of mojarra at runtime, download the you should see a bulleted list of version info at figure 1 make sure the mojarra version displayed is the one you configured during the upgrade mojarra 2.1.21 next you'll learn how to upgrade weld some versions of jboss 7.1.x are not bundled with the correct weld version for example, jboss as 7.1.1 comes with weld since liferay faces uses weld 1.1.10, you'll need to download a newer version of the url artifact you've successfully upgraded your weld version. configuring cdi for your jsf portlets running on jboss, you'll need to configure for more information on configuring cdi, visit the configuring jsf portlets to use cdi now you're ready to deploy liferay portal if the folder url already exists in your jboss installation, delete all of its subfolders and files. unzip the liferay.war file into the url folder in the url file, open the url dependency with the following configuration this allows osgi plugins like audience targeting to work properly, by exposing the portal api through the osgi container in the same url file, find the tag and update the 1.0 number within the to trigger deployment of url, create an empty file named url in your jbosshomestandalonedeployments folder. on startup, jboss detects the presence of this file and deploys it as a web hibernate persistence provider is used instead of the one provided in the now it's time to start liferay portal on jboss! start the jboss application server now you are truly the boss when it comes to deploying liferay portal on jboss!;;
liferay dxp includes an antisamy module that protects against malicious code that when creating content, users can include malicious code either intentionally or unintentionally. specific htmlcss fragments and removes suspect javascript code from them. to enforce a content policy that's been effective for the online auction site the antisamy module adds an owasp antisamy implementation to your portal's list of existing sanitizer implementations. antisamy sanitizer and any existing configured sanitizers to scrub user input to blogs entries, calendar events, message boards posts, wiki pages, and web at the time of this writing, liferay dxp's antisamy module uses owasp antisamy to configure the antisamy module, navigate to liferay dxp's control panel, go to system settings, open the foundation category and click on antisamy sanitizer figure 1 liferay dxp's antisamy configuration options allow you to specify both a blacklist and a whitelist using both a blacklist and a whitelist allows you to easily define subsets of entities that should be sanitized or not sanitized. sanitized except for journalarticle. journalarticle is the entity name for web content articles in liferay dxp. but suppose you don't want to sanitize liferay dxp this might be reasonable if your portal only allows message boards posts to be created or updated by untrusted remember to use both the whitelist and the blacklist. you would need to configure the whitelist to include everything except;;
this article documents an issue where liferay digital experience platform dxp 7.0 stores the locale e.g. fr of a guest session that is, no one has signed in yet and then keeps the same locale even after a user has signed in authenticated. users might still see fr in the url even if they are english or japanese, or spanish users the root issue is that liferay dxp 7.0 stores information in a cookie called guestlanguageid to resolve this issue, delete the cookie in the browser settings. g oing to a url with the desired locale will also change the cookie to that locale for example, if someone goes to localhost8080fr, the cookie will default to french as the preferred locale for guests on that machine. either delete the cookie, or go to localhost8080en. this will change the cookie to have a default language of english note system administrators always have the option to enable only the locales they want using the url property in the url file.;;
the project details page is where you will find all information related to your liferay subscription. this can be accessed by going to the mega menu, and clicking on project details on the right hand side of the menu the overview page will show you details regarding your environments associated with your liferay subscription you will be able to update your server details as well as upload portal-ext and patching tool files. all information here will be used by the customer support engineer when assisting you on a support ticket, so it is important to have this information updated on a regular basis team member contact information will also be located here. you will be able to have on hand who is associated with the account. if any updates need to be made, please submit a support ticket so that a member of the liferay support team can assist you. the component for this request is activation key project administration. lastly, the liferay contacts tab will list who your sales representative is as well as any other liferay contacts your organization may be working with if you have any questions regarding your liferay subscription, you can find the contact information here.;;
searching is something that has always been a priority for our subscribers. we wanted to make it efficient as well as a simple process after logging into help center, you'll find that there is a search bar front and center of the home page. our goal is to provide our subscribers with accessible resources at the tips of their fingers for example, when searching with the keyword clustering, you'll find a drop down menu of top article suggestions that the page will provide for you. if you see an article that is related to what you're looking for, go ahead and click on the link. if not, then continue to search by hitting enter the search results page will show you all of the articles with the searched keyword bolded so it's easier to spot after finding the article you're looking for, there's a feedback question available for you. it's a simple yes or no question and it would help tremendously to receive feedback so that we may continue to improve our documentation after reading through article and assistance is still needed, please feel free to submit a help center support ticket.;;
for best practices on creating support tickets, please see here to access the ticketing home page, you will need to log into the help center after doing so, there are two access points to get to the ticketing home page. on the far right side of the mega menu, there will be a link labeled submit a ticket, and the other is towards the bottom of the home page in the still need help section this is what the ticket form will look like next will be to select a product the component list will provide an exhaustive list related to the selected product the system status will be discerned by the environment whether it's non-production, production or backup along with determining whether the server is unstable or completely inoperable in the subject line, a brief description of the issue can be provided here for the description, this is where the additional information will be provided. this will include a more detailed description of the issue, steps to reproduce as well as what tests have already been conducted. the purpose of providing the steps to reproduce is so that the customer support engineer will be able to try and replicate the exact steps when assisting on the support ticket lastly, if there is any additional information that can be provided, including any third party applications or anything outside of the liferay box, please provide it on the ticket if there are any files that can be included to aide in the investigation, they can be added to the ticket form. please note that the maximum file size is 20mb. if you have a file that is larger than that, there will be a way to add the larger files after submitting the ticket after submitting a ticket, this is what the page will look like as you look to the bottom of the page, there is an option to attach files. as previously mentioned, files larger than 20mb can be uploaded from here the customer support engineer will be corresponding with the subscriber on the ticket, and an email will also be sent with each update. a nice feature with the new ticketing system is that when responding to an automated email, it will automatically copy the response to the ticket so that the subscriber will not need to log back in to leave a comment. please note that this will only work for developers commenting after a ticket has been created.;;
"liferay dxp fully supports ldap as a user store. settings's authentication page to connect liferay dxp to an ldap directory. can be imported into liferay dxp from ldap or exported to ldap from liferay dxp. organization already stores user information on an ldap server, it's convenient for both users and administrators to simply have the ldap user information importing ldap user information to liferay dxp means that users don't have to remember an extra set of credentials for liferay dxp. ldap user information to liferay dxp also means that administrators don't have to create a whole new set of user accounts for liferay dxp. learn how to connect liferay dxp to an ldap server and how to configure import settings, export settings, and related ldap configuration settings to access liferay dxp's ldap configuration settings, navigate to control panel configuration instance settings, then scroll down and expand the liferay dxp to an ldap directory you configure the global values from the ldap tab of the authentication page enabled check this box to enable ldap authentication required check this box if ldap authentication is required. won't allow a user to log in unless he or she can successfully bind to the ldap uncheck this box if users with liferay dxp accounts but no ldap accounts can log in to liferay dxp ldap servers liferay dxp supports connections to multiple ldap servers. the add button beneath this heading to add ldap servers. the following configuration options importexport you can import and export user data from ldap directories enable import checking this box to cause liferay dxp to do a mass import leave this unchecked to keep the default behavior, which synchronizes users only when they log in. unchecked if you are working in a clustered environment. your nodes would try to do a mass import when each of them starts up enable export check this box to enable liferay dxp to export user accounts liferay dxp uses a listener to track any changes made liferay dxp pushes updates out to the ldap server whenever note that by default on every login, fields such when export is enabled, this has the effect of causing a user export every time the user logs in. to users' lastlogindate fields from triggering ldap user exports by setting the following property in your url file enable import on startup checking this box instructs liferay dxp to run the ldap user import when it starts up. note this box only appears if you check the enable import box described above use ldap password policy liferay dxp uses its own password policy by default. this can be configured on the control panel's password policies page. use ldap password policy box if you want to use the password policies defined once this is enabled, the password policies tab states that you are not using a local password policy. directory's mechanism for setting password policies. these policies; the best it can do is pass through the messages returned by your it does this by parsing the messages in the ldap controls the by default, liferay dxp is configured to parse the messages returned by the fedora directory server. must customize the messages in system settings foundation system once you've finished configuring ldap, click the save button although most ldap configuration can be done from instance settings, there are several configuration parameters that are only available in system settings. previous versions of liferay dxp, system scoped settings for ldap were and modified using a url file. if you need to change any of these options, navigate to control panel go to the foundation section and find the entries with ldap in the title specify the virtual instance id in the source, the variable name is companyid in the exported configuration file, because servers are defined at the instance scope, not the system scope. to do this, specify the virtual instance id somewhere in the file like this you can find your virtual instance id in control panel configuration on the ldap auth page, you can set the authentication method and the password the bind authentication method is preferred by most vendors so you don't have to worry about encryption strategies. compare does exactly what it sounds like it reads the user's password out of ldap, decrypts it and compares it with the user's password in liferay dxp, syncing if you use password compare, you can also choose the encryption algorithm to use for the comparison on the ldap import page, you can configure import one example is the import methods. liferay dxp imports all users from the specified portion of the ldap tree. set this to group, liferay dxp searches all the groups and imports the users in each if you have users who do not belong to any groups, they are not imported use the system ldap configuration entry to manage error properties like error password age keywords which lets you set a list of phrases from error messages which can possibly be returned by the ldap server. binds to ldap, the server returns controls with its response of success or these controls contain a message describing the error or the information that is returned with the response. though the controls are the same across ldap servers, the messages can be different. here contain snippets of words from those messages and work with red hat's if you are not using that server, the word snippets may not work with your ldap server. if they don't, you can replace the values of these properties with phrases from your server's error messages. note when you make a change in system settings, it takes effect for the if after changing a setting you create a new virtual instance, that virtual instance inherits the settings of the one it was for example, say you have virtual instances named a, b, and c. from a, you modify error password history keywords. appears only in a, not in b or c. then from a, you create virtual instance d. the change to error password history keywords appears in d not b or c, since d defaults to a's settings because you created it from a in summary, if there's a configuration you need to set up liferay dxp with ldap, and you don't find it in instance settings, look in the ldap system settings click on the add button beneath the ldap servers heading to add an ldap if you have more than one ldap server, you can arrange the servers by order of preference using the updown arrows. server, you must provide several pieces of data so liferay dxp can bind to that ldap server and search it for user records. regardless of how many ldap servers you add, each server has the same configuration options server name enter a name for your ldap server default values several leading directory servers are listed here. are using one of these, select it and click the reset values button. of the form will be populated with the proper default values for that connection these settings cover the basic connection to ldap base provider url the link to the ldap server. make sure the liferay dxp server can communicate with the ldap server. if there is a firewall between the two systems, check to make sure the appropriate ports are opened base dn the base distinguished name for your ldap directory. usually modeled after your organization. for a commercial organization, it may look similar to this dccompanynamehere,dccom principal by default, the ldap administrator user id is populated here. you have removed the default ldap administrator, you will need to use the fully qualified name of the administrative credential that you use instead. you need an administrative credential because liferay dxp uses this id to synchronize user accounts to and from ldap credentials this is the password for the ldap administrative user this is all you need to make a regular connection to an ldap directory. of the configuration is optional. the default attribute mappings usually provide enough data to synchronize back to the liferay dxp database when a user attempts to to test the connection to your ldap server, click the test ldap before proceeding to fine tune liferay dxp's ldap connections, ensure the following steps have been taken the ldap connection has been enabled in the control panel. your needs, ldap authentication may be required so that only users who have been exportimport for users in a clustered environment, this should be disabled so that there are no massive imports on every node upon start up when adding the ldap server, the server name, default values, it is always a good idea to click the test if you are running your ldap directory in ssl mode to prevent credential information from passing through the network unencrypted, you must perform extra steps to share the encryption key and certificate between the two systems for example, if your ldap directory is microsoft active directory on windows server 2003, you'd share the certificate like this click start administrative tools certificate authority. highlight the machine that is the certificate authority, right-click on it, and from the general menu, click view certificate. details view, and click copy to file. use the resulting wizard to save the you will also need to import the certificate into the the import is handled by a command like the following the keytool utility ships as part of the java sdk once this is done, go back to the ldap page in the control panel. ldap url in the base dn field to the secure version by changing the protocol to ldaps and the port to 636 like this your liferay dxp now encrypts its authentication to ldap users this section contains settings for finding users in your ldap authentication search filter the search filter box can be used to determine the search criteria for user logins. addresses for their login names. if you have changed this setting, you must modify the search filter here, which has been configured to use the email address attribute from ldap as a search criterion. liferay dxp's authentication method to use screen names instead of the email addresses, you would modify the search filter so it can match the entered log import search filter depending on the ldap server, there are different the default setting is usually fine if you want to search for only a subset of users or users that have different ldap object classes, you can change this user mapping the next series of fields allows you to define mappings from ldap attributes to liferay dxp fields. though your ldap user attributes may be different from ldap server to ldap server, there are five fields liferay dxp requires to be mapped for the user to be recognized email address e.g., mail or email first name e.g., name or givenname note if you intend to create or import users with no email addresses, then with this set, liferay auto-generates an email address combining the user id plus the suffix defined in the property finally, make sure to set liferay and ldap authentication to something other than email address the control panel provides default mappings for commonly used ldap attributes. you can also add your own mappings groups this section contains settings for mapping ldap groups to liferay dxp import search filter this is the filter for finding the ldap groups that you want to map to liferay dxp user groups. enter the ldap group attributes you want retrieved for this mapping. following attributes can be mapped. the group name and user fields are required, the description is optional test ldap groups click the test ldap groups button to display a list of the groups returned by your search filter export this section contains settings for exporting user data from ldap users dn enter the location in your ldap tree where the users will be when liferay dxp does an export, it will export the users to this user default object classes when a user is exported, the user is created with the listed default object classes. to find out what your default object classes are, use an ldap browser tool such as jxplorer to locate a user and view the object class attributes stored in ldap for that user groups dn enter the location in your ldap tree where the groups will be when liferay dxp does an export, it exports the groups to this location group default object classes when a group is exported, the group is created classes are, use an ldap browser tool such as jxplorer to locate a group and view the object class attributes stored in ldap for that group once you set all your options and tested your connection, click save. here, you can add another ldap server or set just a few more options that apply to all of your ldap server connections note if a user changes a value like a password in liferay dxp, that change is passed to the ldap server, provided liferay dxp has enough schema access to make now you know how to connect an ldap server to liferay dxp and how to configure user import behavior, export behavior, and other ldap settings";;
"once you have an installation of liferay dxp running, you should implement a in case some kind of catastrophic hardware failure occurs, you'll be thankful to have backups and procedures for restoring liferay dxp isn't very different from other java web application that might be running on your application server. there are some specific components you should include in your backup plan the recommended backup plan includes backing up these things if you have extended liferay dxp or have written any plugins, they should be stored in a source code repository such as git, subversion, or cvs, unless you're linus torvalds, and then tarballs are okay too that's a joke. should back up your source code repository on a regular basis to preserve your this probably goes without saying in your organization since nobody wants to lose source code that's taken months to produce. include source code in your liferay dxp backup plan next, let's examine the liferay dxp installation items you should back up stores liferay dxp's properties configuration files, such as portal-setup- url and url. you should absolutely back them in fact, it's best to back up your entire application server and liferay liferay dxp stores configuration files, search indexes, and cache information in if you're using the file system store or the advanced file system store, the documents and media repository is also stored it's always important to back up your data folder the files that comprise liferay dxp's osgi runtime are stored in liferay home's it contains all of the app and module jar files deployed to the osgi folder also contains other required jar files, configuration files, and log files. it's also important to back up your osgi liferay home's logs folder contains liferay dxp's log files. occurs on liferay dxp, the liferay dxp log files often provide valuable information for determining what went wrong. the data, osgi, and logs folders are all contained in the liferay home folder. thus, if you're backing up both your application server folder and your liferay home folder, you're in good shape remember that if you've configured the document library to store files to a location other than the default location, you should also back up that location that covers the liferay dxp file system locations you should back up. discuss how to back up liferay dxp's database liferay dxp's database is the central repository for all of the portal's it's the most important component to back up. database live if your database allows this or by exporting dumping the database into a file and then backing up the exported file. ships with a mysqldump utility which lets you export the entire database and this file can then be backed up. database you can import this file into the database to recreate the database state to that of the time you exported the database if you're storing liferay dxp's documents and media library files to a jackrabbit jsr-170 repository database, you should back it up. index into a database not recommended; see the article for information on using cluster link or solr, you should back up that if you wish to avoid re-indexing your content after restoring your database, this is easiest to do if you have a separate elastic or solr environment on which your index is stored. clustered configuration and you're replicating indexes, you'll need to back up restoring your application server, your liferay home folder, the locations of any file system-based media repositories, and your database from a backup system should give you a functioning portal. restoring search indexes should avoid the need to re-index when you bring your site back up after a catastrophic failure. good, consistent backup procedures are key to recovering successfully from a";;
"this article is designed to show how to regenerate image and document previews in case they are corrupted or missing for best results, be sure to use imagemagick and ghostscript; here are the imagemagick configuration instructions that will guide you through generating previews and thumbnails.";;
this article documents the basic instructions for how to deploy your activation key via the.xml file. the steps will vary slightly depending on the version of the liferay platform you are using. please note that if you encounter any problems along the way, we have created a separate article specifically for troubleshooting common issues liferay dxp production-grade server instances can also be activated using liferay connected services. to activate a dxp instance using the.xml key file, you can deploy an activation key with the following steps for liferay portal version 6.1 and 6.2, you can follow the steps below to deploy note 1 for best results, please be sure that there are no pre-existing.li files in the datalicense folder prior to deploying the.xml file note 2 when deploying activation keys in liferay with amazon web service aws, please know that liferay portal versions 5.2 ee sp5 to 6.0 ee slightly varies with which folder the.xml file is deployed into an activation key for liferay portal version 5.4 sp4 and lower is based off the server id or server mac address and utilizes a license key gold or platinum customers may request an activation key by opening a support ticket. limited customers may submit an activation key request by completing the activation key request form on customer portal. if you have any questions, please feel free to contact email;;
liferay dxp core and portlet module language.properties files implement site they're fully customizable, too. demonstrates this in the following topics translations of your application's user interface but you can also override the default language keys globally and in other applications including your own. here are the steps for overriding note many applications that were once part of liferay portal 6.2 are now their language keys might have been moved out of liferay's language properties files and into one of the application modules. overriding a module's language keys is different from the process for overriding global language keys so how do you find global language keys? they're in the languagexxxx.properties files in the source code or your liferay dxp bundle all language properties files contain properties you can override, like the there are also many simple keys you can override to update default messages and for example, figure 1 shows a button that uses liferay's publish default figure 1 messages displayed in liferay's user interface can be customized next, you'll learn how to override this key once you know the keys to override, create a language properties file for the locale you want or the default url file in your module's in your file, define the keys your way. example, you could override the publish key to enable your change, you must create a resource bundle service component to in your module, create a class that extends url.resourcebundle for the here's an example resource bundle class for the the class's resourcebundle field is assigned a resourcebundle. parameter is the language file's qualified name with respect to the module's the second parameter is a control that sets the language syntax of the resource bundle. liferay's syntax, import liferay's url.utf8control class and set the second the class's annotation declares it an osgi resourcebundle service it's url property designates it for the enus locale the class overrides these methods handlegetobject looks up the key in the module's resource bundle which is based on the module's language properties file and returns the getkeys returns an enumeration of the resource bundle's keys your resource bundle service component redirects the default language keys to your module's language key overrides note global language key overrides for multiple locales require a separate each module's resourcebundle extension class like the myenusresourcebundle class above must specify its locale in the url component property definition and in the language file qualified name parameter. for example, here is what they look like for the spanish locale uses language keys from another module overrides any of that other module's keys, make sure to use osgi headers to specify the capabilities your module requires this lets you prioritize resource bundles from the modules to see your liferay language key overrides in action, and visit the portlets and pages that use the keys figure 2 this button uses the overridden publish key that's all there is to overriding global language keys what do you do if the language keys you want to modify are in one of liferay's applications or another module whose source code you don't control? language keys are in the respective module, the process for overriding a module's language keys is different from the process of overriding global language keys list the bundles and grep for keywords that match the portlet's display name. language keys are in the portlet's web module bundle. find the bundle, note its id number to find the blogs portlet, for example, your gogo commands and output might look list the bundle's headers by passing its id to the headers command note the bundle-symbolicname, bundle-version, and web-contextpath. web-contextpath value, following the , is the servlet context name important record the servlet context name, bundle symbolic name and version, as you'll use them to create the resource bundle loader later in the for example, here are those values for liferay blogs web module next find the module's jar file so you can examine its language keys. follows this module jar file naming convention for example, the blogs web version 1.0.6 module is in here's where to find the module jar the language property files are in the module's identify the language keys you want to override in the languagexx.properties files checkpoint make sure you have the required information for overriding the next you'll write new values for the language keys create a new module to hold a resource bundle loader and your custom language in your module's srcmainresourcescontent folder, create for each locale whose keys you want to override. next you'll prioritize your module's language keys as a resource bundle for the now that your language keys are in place, use osgi manifest headers to specify the language keys are for the target module. to compliment the target module's resource bundle, you'll aggregate your resource bundle with the target module's you'll list your module first to prioritize its resource bundle over the target module resource bundle. url prioritizing its resource bundle over target module url's resource bundle let's examine the example provide-capability header declares that the module provides a resource bundle whose base name is specifies the list of bundles whose resource bundles are aggregated, the target bundle, the target bundle's resource bundle name, and this service's to see the language keys you've overridden tip if your override isn't showing, use to check for competing resource bundle services. to check for competing resource bundle services whose aggregates include url's resource bundle, for example, execute this search the results for resource bundle aggregate services whose ranking is now you can modify the language keys of modules in liferay's osgi runtime. remember, language keys you want to override might actually be in liferay's upgrading core language key hooks;;
if there are any reproducible and unintended issues encountered while using liferay digital experience platform, liferay portal ee, and liferay commerce the product in a compatible environment and fault is found to be with the product, then liferay subscription services will seek to resolve the issue through patching or configuration changes according to the product service life there are several areas of the product usage which have specific support coverage, including web accessibility refers to the usability of websites by people of all abilities and disabilities the product is tested for compliance with wcag 2.1 standard and attempt to satisfy all aa requirements for end user facing uis and interactions. if specific elements of the product violate the standard, then the resolution of those issues would fall under the product defects policy product accessibility requests will be addressed if the reported issue is for guest users and concerns basic navigation e.g., keyboard navigation, focus management or screen reader issues liferay is not required to address accessibility issues concerning portal or portlet administration, authenticated user experience, application administration or control panel issues text or contrast issues are the responsibility of the customer to resolve through theming or further customization the revised standards for section 508 is wcag 2.0 conformance. as such, issues dealing with section 508 of the rehabilitation act of 1973 or americans with disabilities act ada standards will be approached as compliance with the wcag 2.0 aa standard liferay products are not ensured as fully compliant with section 508 of the rehabilitation act of 1973 or americans with disabilities act ada standards. compliance can be achieved through customization of the product. any customization of liferay dxp or liferay portal ee made in order to achieve section 508 or ada compliance will fall under the customizations support coverage due to the complexity of accessibility issues, the resolution of those issues will be on a case-by-case basis with regards to third-party integrations, liferay dxp and liferay commerce have been designed to work with a wide array of html text editors. this article outlines product compatibility with these third-party integrations the product has several themes included. themes included with the product should not be utilized in a production environment. issues with the included themes will be reported to the product team and may be resolved on a case-by-case basis. the resolution of that issue will be included in a future version of the product issues reported concerning the theme infrastructure, the styled theme or the unstyled theme may be resolved according to the product defects policy liferay is committed to producing software products that are enterprise-grade with respect to security as well as quality and features. we understand that it is essential for our enterprise customers to keep their it stack free of security vulnerabilities ideally, security issues will be reported with steps to reproduce in a clean product instance. issues which arise on a security scan can also be reported. please share the entire report when disclosing security issues to subscription services. security issues discovered through an automated scan deemed by subscription services to be false positives or unexploitable will be handled on a case-by-case basis within 72 hours of discovering or being notified of a potential vulnerability, liferay will attempt to reproduce the issue using the supplied information. if the vulnerability is reproducible and if a ticket does not already exist for the vulnerability, then a private non-public ticket will be created. the ticket will be classified into one of the pre-defined severity levels and the details of the vulnerability will be documented in the ticket for more information regarding our security policy and known vulnerabilities please see our security advisories page.;;
page analytics, fix pack management, and portal properties have been discontinued. please read the lcs feature deprecation update to learn more about their removal this article documents how to activate your server with liferay connected services lcs by listing server registration steps in most cases, deploying and configuring the lcs client is simple. if, however, you connect to the web through a proxy or have specific network requirements, please make sure to read through the lcs preconfiguration requirements. once you've done that, you are ready to register your liferay dxp instance with lcs if the occasion calls to decommission a server and free its activation key for reuse, please follow the steps below what happens when lcs is not reachable? will the liferay installation think it does not have an active registration?;;
web content management wcm helps users who are not web developers publish content with a simple point and click interface, while enabling developers to create complex templates with dynamic elements. deployed into liferay dxp, your non-technical users can use them to manage complex content as easily as they would manage basic content web content editor a complete html editor for modifying fonts, adding color, inserting images, and much more structure editor define fields for structured content and more advanced template editor import template script files or create your own template to inform the system how to display the content within the fields determined by the web content display place web content on pages in your site asset publisher aggregate and display different types of content together this is covered in more detail in scheduler schedule when content is reviewed, displayed or removed. workflow integration run your content through a review process. staging use a separate staging server or stage your content locally so you can keep your changes separate from the live site. these tools streamline the content creation process for end users and are also integrated with liferay's services so advanced template developers can use them to query for data stored elsewhere on your website to demonstrate liferay dxp's web content management features, you'll create and manage content on liferay for the ambitious and fictitious lunar resort the lunar resort project specializes in facilitating lunar vacations. it provides space shuttle transportation from the earth to the moon and back, offers the use of a state-of-the-art recreational facility enclosed by a large, transparent habitat dome, and even rents out lunar rovers.;;
now that you've performed the steps needed to prepare for your you're ready to install liferay dxp! since bundles are the easiest way to complete an installation, all the installation steps below assume you're installing a if you plan to install liferay dxp manually, please refer to the article for your app server of choice, and then come back here to complete the you've created a blank database for liferay dxp and have gathered the credentials you need for your mail server. liferay dxp bundles contain the same folder structure regardless of application the top-level folder is named for the liferay dxp release. this folder is usually the application server's parent this is why liferay dxp bundles place the application server inside the on a manual installation, the location of this folder in a bundle, it's part of the bundle. doing a manual installation, please refer to the article covering that app liferay home has folders for various purposes application server the name of this folder varies depending on this folder contains the application server in which liferay dxp has been installed data stores an embedded hsql database, liferay dxp's file repository, and liferay dxp's search indexes. liferay dxp is initially configured to use the embedded hsql database but the hsql database is primarily intended for demonstration and trial purposes. sets the hypersonic embedded hsql database location deploy to auto-deploy liferay dxp plugins, copy them to this folder. legacy style.war files, liferay dxp 7.1 style.jar files, and.lpkg files from liferay marketplace are supported. license liferay dxp's copyright and version files are here logs this folder contains liferay dxp's log files. liferay dxp's log files can be quite valuable for system administrators, especially when trying to diagnose a problem. url file sets the location for to override the log file location, you must use an url file in an ext plugin osgi all the jar files and a few configuration files for liferay dxp's osgi runtime belong in this folder. patching-tool liferay dxp only this folder contains patches for liferay dxp and files for installing the patches tools for liferay dxp upgrade and target platform indexer if liferay dxp is unable to create the resources it needs in the liferay home folder or if it finds itself running on certain application servers, it creates a folder called liferay in the home folder of the operating system user that in this case, the liferay folder becomes liferay home. for example, if the operating system user's name is jbloggs, the liferay home folder is homejbloggsliferay or cusersjbloggsliferay getting a liferay dxp bundle up and running involves uncompressing the archive, possibly copying a jdbc driver, and then starting the application server. use the liferay dxp tomcat bundle as an example you've extracted liferay dxp, and it's ready for use. easier than doing a manual installation on an app server. what you need to do, please at this point click the link on the left and go through the installation procedure for your app server of choice. finished with the installation and before you've started liferay dxp for the first time, come back to this spot, because you must hook it up to your you can connect to your database with jndi on your app server or the data source shipped with liferay dxp recommended. refer to the article on your app server for the internal data source, you can configure it by specifying the configuration in a url file or the create a url file in your liferay home folder copy a relevant example data source configuration from portal properties reference's jdbc section and paste it into the url file customize the configuration with the proper host name and user and password credentials for your database, and save the file you're ready to start liferay dxp next, start your app server, or start the liferay dxp app in your app server. liferay dxp writes log files to folder liferay homelogs the first time liferay dxp starts, it creates all of its database tables. has successfully started, it automatically launches a web browser that displays if for some reason your browser doesn't load the basic configuration page, launch it and navigate to your app server's address and port for example, the setup wizard runs when you start liferay dxp for the first time. the setup wizard page is basic configuration. this page provides a convenient way to make an initial configuration there are two sections of the wizard the portal and the administrator. portal, you need to supply the following information portal name the name of the portal you're powering with liferay dxp default language choose the default locale of your portal for the administrator, you need to supply the following information first name the first name of the default administrator user last name the last name of the default administrator user email the email address of the default administrator user note the administrator user's email domain is used as the liferay dxp instance's default domain i.e., the figure 1 supply the information for your portal and your portal's default administrator user on the basic configuration page the basic configuration page also includes a checkbox labeled add sample data. if you check this box, sample data is added to your database. users, sites, and organizations. the sample data is for demo purposes. installing liferay dxp on your own machine to explore its features, the sample if, however, you're installing liferay dxp on a real server, once you've filled out the form, click finish configuration. creates a url file which stores the settings that when you begin customizing your portal's configuration, however, use the url file you created earlier. possible properties that can be placed in this file are documented in tip the wizard is an extremely helpful tool, especially if you're setting up liferay dxp for the first time. if you're a veteran and you already have your various properties set up, you can disable the setup wizard. the setup wizard, you must configure everything manually from the to disable the setup wizard, enter property values in url the file created in liferay home by the setup wizard override property values in url after you've entered the information requested by the basic configuration page, you should set up your mail configuration next log in as the administrative user you created in the setup wizard. menu icon and then go to control panel server administration mail, and have your mail credentials ready you're asked for the following information incoming pop server the hostname for a server running the post office liferay dxp checks this mailbox for incoming messages, such as message incoming port the port on which the pop server is listening use a secure network connection use an encrypted connection when connecting user name the user id liferay dxp should use to log into the pop server password the password liferay dxp should use to log into the pop server outgoing smtp server the hostname for a server running the simple mail liferay dxp uses this server to send emails, such as password change emails and other notifications outgoing port the port on which the smtp server is listening user name the user id liferay dxp should use to log into the smtp server password the password liferay dxp should use to log into the smtp server manually specify additional javamail properties to override the above configuration if there are additional properties you need to specify, supply when you're finished setting up your mail configuration, click save your next step is to convert the search implementation from its default demo;;
this article describes and provides links for for a description of language coverage as well as the list of translations available out of the box, please see translation and language support to customize the language keys in your own instance, see the instructions for overriding language keys. this allows you to set custom language keys and provide translations for languages that aren't covered out of the box to contribute to languages that fall outside of subscription coverage, navigate to url. here you can check the translation statuses for a number of languages and upon creating a crowdin account, you may contribute translations for your desired language note these translations will appear in the next major version of liferay e.g. 7.0, 7.1, etc.;;
this article documents four portal properties that are often used to configure redirection urls for users the four descriptions below include the properties, their descriptions, and examples for this property sets the default home url of the portal when a guest user hit the host name. please use a public page url as guest users do not have permission to view private pages it can also be set via control panel configuration instance setting home url. the value defined in instance setting takes precedence the following are a few example scenarios first, create a page called test navigating to would show the home page navigating to would show the test page property with description from url this configuration can also be set via control panel configuration instance setting default landing page this configuration can also be set via control panel configuration instance setting default logout page please note that the value configured for default landing pange and default logout page in instance settings will be stored in portalpreferences table, which will overwrite the value defined in url permanently this page should be a public page containing a sign-in portlet and users will be redirected to this page to log in the portal.;;
the liferay help center is our new site for all things related to our liferay customers. you'll be able to find documentation for specific products, simpler navigation and so much more to enhance your experience with your liferay subscription you can access the help center by going to url at the top right of the page is where you will be logging in with your liferay credentials. you can continue to use the same username and password as you are currently using for the customer portal. if you have not yet created an account, please do so and you will be receiving an email as part of the 2-step verification to confirm your account after logging in, there is a search bar front and center of the page. this is to provide easy access to the user when looking for specific documentation or knowledge base articles right away the mega menu at the top of the page is where subscribers will be able to find information and resources for your specific liferay product under products, all of the liferay products are listed including dxp, analytics cloud and commerce. having all products listed in one location provides ease of accessibility resources is where you will be able to locate the knowledge base articles as well as official documentation to assist with any questions that may arise regarding your liferay product. downloads will also be housed in this section which will include bundles and the products itself under security, liferay policies as well as known vulnerabilities will be located here along with providing lsv downloads and recommended action items lastly, the support section includes information regarding the liferay support coverage, faqs and other helpful information related to your subscription;;
this article is intended to provide a list of all the liferay dxp 7.0 database properties that can be used to connect your dxp 7.0 installation to various databases. 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 lportal in url with the name of your database, uncommenting the four properties, and inserting the username and password of your intended database user in the appropriate properties;;
"json web services are enabled in liferay by default. them, specify this portal property setting in a url file this tutorial presents other such properties that you can use to fine-tune exactly how json web services work in your liferay instance. the portal properties reference documentation. as with the preceding property, you should set portal properties in a first, you'll learn about setting whether json web services are discoverable via by default, json web services are discoverable via the api page at to disable this, set the following next, you'll learn how to disable http methods when strict http method mode is enabled, you can filter web service access based on http methods used by the services. for example, you can set your liferay instance's json web services to work in read-only mode by disabling http methods with this setting, all requests that use delete, post, or put http methods next, you'll learn how to restrict public access to exposed json apis all json web services are mapped to either get or post http methods. service method name starts with get, is or has, the service is assumed to be read-only and is bound to the get method. by default, liferay doesn't check http methods when invoking a service call; it works in non-strict http method mode, where services may be invoked if you need the strict mode, you can set it as follows when using strict mode, you must use the correct http methods to calll service when strict http mode is enabled, you still might need to disable http each service method knows whether a given user has permission to invoke the if you're concerned about security, you can restrict access to exposed json apis by explicitly permitting or restricting certain json web the property url denotes patterns for json web service action paths that are allowed. set a blank pattern to allow any service service action paths that aren't allowed even if they match one of the patterns note that these properties support wildcards. url,has,is, liferay makes all read-only json methods publicly accessible. all other json methods are secured. access to all exposed methods, you can leave the right side of the symbol to enable access to all exposed methods, specify . path matches both the url and url property takes precedence";;
this tutorial provides examples of invoking liferay's json web services via to illustrate the differences between these, the same two use cases getting a user and adding a user are shown in each example. an example of using javascript to invoke liferay's json web services from a liferay web pages use the alloyui javascript framework. objects created for each liferay page is a liferay object. includes a service function that you can use to invoke liferay's api. invoke liferay web services via liferay.service..., your javascript context must include the alloyui javascript framework. you're working in a jsp, you can load the alloyui taglib and wrap your by default, the tag includes the base aui module. specific aui modules, specify them via the use attribute. the aui node and event modules, wrap your code like this if you're not working in a jsp, you won't have access to taglibs. create an aui context manually. for example, use the following html fragment to load the aui seed and css files then you can create an aui context like this now you're ready to invoke liferay's json web services first, examine the following json web service invocation, written in javascript if you run this code, the email user json object is logged to the the liferay.service... function takes three arguments the callback function takes the result of the service invocation as an argument here's an example json web service invocation, also written in javascript, that it requires many more parameters than the one for retrieving a the servicecontext object assigns the test tag to the newly created user. note that you can use json syntax to supply values for objects and arrays. example, to supply a value for the servicecontext object, you use curly to supply a value for the assettagnames array, you use servicecontext assettagnames 'test' indicates that servicecontext is an object containing an array named assettagnames, which contains the string you can adapt the example from the previous section for use in a liferay app. for example, the jsp page below creates a form that lets the user specify a first name, middle name, last name, screen name, and email address. user clicks the add user button, the app uses these values to create a new in this example, it's assumed that the jsp page is part of a web module with a portlet class that extends liferay's mvcportlet class. the code uses the mvcpath url parameter. it's also assumed that the jsp code is in a file named url, and that there are also url and url files in the same directory here's a simple json web service invocation via url that returns the user with this web service invocation returns the email user. service via liferay's jsonws api page, the url provided when you click on the url example tab omits the pauth url query parameter. you'll add this parameter yourself. remember that you must be logged in as a user with the required permission to invoke a web service. token that corresponds to your session, see the if you read that tutorial, you know that you can supply parameters as either url in the preceding example, the company id and email address are supplied as url path parameters. next, you'll consider an example that requires many more parameters! here's an example json web service invocation via url that adds a new user with and here's the same example using url query parameters instead of url path here's an example json web service invocation via the curl tool that returns the user with the specified email address note that curl is a command line tool. you can execute this command from a here's an example json web service invocation via the curl tool that adds the user with the specified attributes now you've seen how to invoke liferay's json web services from;;
to use json web services, you send a request that defines a service method and parameters, and you receive the result as a json object. this seems, it can be improved. in this tutorial, you'll learn how to use json web services more efficiently and pragmatically consider the following example. you're working with two related objects a user and its corresponding contact. with simple json web service calls, you first call the user service to get the user object, and then you use that object's contact id to call the contact service. requests to get two json objects that aren't even bound together. contact information in the user object i.e. no url . is suboptimal with respect to performance sending two http calls and usability manually managing the relationship between two objects. had a tool to address these inefficiencies. fortunately, the json web service liferay's json web service invoker helps optimize your json web services use. the following sections, you'll learn how the invoker is accessible from the following fixed address it only accepts a cmd request parameterthis is the invoker's command. command request parameter is missing, the request body is used as the command. so you can specify the command by either using the request parameter cmd or the invoker command is a plain json map that describes how json web services are called and how the results are managed. here's an example of how to call a simple service using the invoker the service call is defined as a json map. the key specifies the service url i.e. the service method to be invoked and the key's value specifies a map of service parameter names i.e. userid and param1 and their values. example above, the retrieved user is returned as a json object. command is a json string, null values can be specified either by explicitly using the null keyword or by placing a dash before the parameter name and leaving the value empty e.g. -param1'' the example invoker calls functions exactly the same way as the following next, suppose that you're running liferay locally on port 8080. following example of a real liferay json web service invoker call. you're signed in to liferay as the default admin user whose email address is email and whose user id is 20127. your pauth authentication token is htxjvt5d. following url to obtain a json representation of your user object this url uses the following json map. note that it's supplied in the url by note in the url that the double quotes are url-encoded. what your user id is, you can find it in the user menu under my account if you're not sure what the value of your pauth liferay's json web services api page and click on any method in the list. the value of your pauth token appears under the execute heading along with any other parameters of the selected api method you can use json syntax for supplying values for objects and arrays that you to supply a value for an object, use curly to supply a value for an array, use square brackets suppose as before that you're signed in to liferay as an admin user and that the value of your pauth authentication token is htxjvt5d. suppose that two vocabularies have been created with vocabulary ids of 20783 here's a liferay json web service invoker example that demonstrates how to pass an array as a parameter this url uses the following json map as before, the double quotes in the url are url-encoded. vocabularyids parameter is an array, so its value is supplied as a json array finally, here's one more liferay json web service invoker example that demonstrates how to pass an object containing an array as a parameter the servicecontext is the object containing an array in this example. contains the array assettagnames of course, the json web service invoker handles calls to plugin methods as well the code above calls the fictitious suprasurf application's remote service you can use variables to reference objects returned from service calls. names must start with a dollar sign, . in the previous example, the service call returned a user object you can assign to a variable the user variable holds the returned user object. user's contact id using the syntax url next, see how you can use nested service calls to join information from two with nested service calls, you can bind information from related objects you can call other services within the same http request and nest returned objects in a convenient way. this command defines two service calls the contact object returned from the second service call is nested in i.e. injected into the user object, as a now you can bind the user and his or her contact now you'll see what the invoker does in the background when using a single http request to make the preceding nested service call note you must flag parameters that take values from existing variables. next, you'll learn about filtering object properties so that only the properties you need are returned when you invoke a service many of liferay's model objects are rich with properties. handful of an object's properties for your business logic, making a web service invocation that returns all of an object's properties is a waste of network with the json web service invoker, you can define a whitelist of properties only the specific properties you request in the object are returned here's how you whitelist the properties you need in this example, the returned user object has only the firstname and emailaddress properties it still has the contact property, too. whitelist properties, you simply place the properties in square brackets e.g., whitelist immediately following the name of your variable next, you'll learn about making calls in batch when nesting service calls, the intent is to invoke multiple services with a using a single request for multiple service calls is helpful for gathering related information from the service call results, but it can also be advantageous to use a single request to invoke multiple unrelated the invoker lets you batch service calls together to improve it's simple just pass in a json array of commands using the the result is a json array populated with results from each command. commands are collectively invoked in a single http request, one after another now you know how to use liferay's json web service invoker to simplify;;
this article documents a known issue with the embedded elasticsearch 6.5 connector. elasticsearch 6.5 is now the default embedded es connector in dxp 7.1 after applying dxp 7.1 fix pack 5 it was discovered that after applying fp5, there is a startup error in platforms deployed on websphere 9 that uses liferay connected services lcs to manage subscription and patches. the root cause is because the lcs boot delegation property conflicts with es 6.5. this is the stacktrace from the console add the property url to the existing property inside url note before making any changes to liferay dxp, shut down the application server. this is especially true in ibm websphere. always use a url file to make changes to the portal after applying this property, the elasticsearch related errors are resolved and the platform starts without errors.;;
due to vulnerabilities in the transport layer security v1.0, liferay has disabled tls 1.0 for inbound secure connections on all systems and services on january 11, 2019 the vulnerabilities in tls 1.0 and ssl protocols include poodle and drown. due to these security risks, liferay decided to disable tls 1.0, as many other companies have done moving to tls 1.1 and higher will allow users to keep communications between liferay and url secure we will support tls 1.1 and above there are liferay portal and dxp functionalities and applications that make outbound connections to remote servers including liferay services and websites. server administrators should review their deployment configurations and adjust them if needed to enable initiating secure connections using a higher tls protocol version and to prevent falling back to tls 1.0 as a result of these, liferay portal and dxp deployments are affected differently liferay dxp 7.0, 7.1, and 7.2 liferay dxp requires java 8, so these deployments have tls 1.1 and 1.2 enabled by default and ensure that outbound connections can use higher secure protocol versions. to improve your server's security, liferay recommends disabling tls 1.0 for clients outbound connections using the system property mentioned above liferay portal 6.1 and 6.2 ee liferay portal 6.2 ee and 6.1 ee ga3 versions support java 8, which has tls 1.1 and tls 1.2 enabled by default. as with liferay dxp installations, liferay recommends disabling tls 1.0 for clients outbound connections using the system property mentioned above liferay portal 6.1 and 6.2 ee deployments running on java 7 should consider moving to java 8 there is a known issue which prevents manually configuring the url system property to control the allowed tls protocols for outbound connections users can access the fix for lpe-16580 through the following methods liferay also recommends that server administrators disable support for tls 1.0 and enable higher tls protocols for inbound traffic on all liferay portal and dxp deployments. the actual settings to enable and configure tls can vary on each deployment, so system administrators should consult with their application server's documentation and apply the necessary changes.;;
this article documents a list of known issues in liferay dxp 7.1 fix packs and service packs dxp 7.1 fix packs and service packs contain the following known issues, which will either be resolved through workarounds or in future fix packs. see our downloads page for the latest liferay dxp 7.1 fix packs and service packs;;
this article documents a list of known issues that exist in liferay dxp 7.0 fix packs and service packs liferay dxp 7.0 fix packs and service packs contain the following known issues, which will either be resolved through workarounds or in future fix packs. see our downloads page for the latest liferay dxp 7.0 fix packs and service packs due to packaging issues, the liferay dxp 7.0 sp5 downloads were removed from customer portal. we are working on addressing these issues in the upcoming sp6 release. fix packs are not affected by these issues, so existing users can also keep their systems updated by installing the latest fix pack, marketplace apps, and patching tool users who have downloaded sp5 can follow the workarounds listed below to resolve the known issues. please note that these issues will not occur when deployed on custom setups. instead, users will only encounter these problems when using the tomcat and wildfly bundles, as well as the admin tools file.;;
this article documents several changes with the clustering feature that will take effect in liferay portal ce 7.0 and digital experience platform 7.0. in addition, this article details changes that may affect community edition users the clustering module is available for enterprise subscriptions to liferay dxp 7.0 and only portal 7.0 ce ga5 onwards;;
blacklists are used for good and evil. liferay dxp's osgi module blacklists and component blacklists are files dropped in a folder to prevent particular modules from installing and particular components from enabling, saving you from the uninstalling and disabling them individually with the application manager, using the control panel's bundle blacklist screen and component blacklist configuration screen are the best ways to create blacklist files note blacklisting osgi modules appears in dxp digital enterprise 7.0 fix pack 30 and liferay ce portal 7.0 ga5 note blacklisting osgi components appears in dxp digital enterprise 7.0 fix pack 40 and liferay ce portal 7.0 ga6 follow these steps to blacklist modules in the control panel, navigate to configuration system settings in the bundle blacklist screen, add the bundle symbolic names see the table below for the osgi module jars, lpkgs, or wars to uninstall. figure 1 this blacklist uninstalls the url osgi module, liferay marketplace lpkg, and to export the blacklist to a file, click the bundle blacklist module's the blacklist configuration file here are contents from an example file add the bundle symbolic names of any modules not already listed that you want to prevent liferay from installing important configuration values must not contain any extra spaces. spaces can short-circuit lists or invalidate the configuration entry copy the configuration file into the note blacklisting an lpkg uninstalls all of its internal modules liferay dxp removes installed modules on the blacklist. the liferay dxp log reports each module uninstallation to reinstall and permit installation of blacklisted modules, follow these steps remove the symbolic names of the modules, lpkgs, or wars from the blacklistbundlesymbolicnames list and save the file to reinstall all the blacklisted modules execute one of these options note to temporarily reinstall a module that's been blacklisted, you can remove its symbolic name from the bundle blacklist module in system settings and if you want the module to install on subsequent liferay server startup, make sure to remove the module's symbolic name from any existing module blacklist configuration file in the the liferay dxp log reports each module installation follow these steps to blacklist components add the names of components to disable and click on the update button figure 2 this blacklist disables the components to export the blacklist, click on the component blacklist configuration add the names of any components not already listed e.g., components of modules not yet installed that you want to prevent liferay from activating copy the configuration file into the liferayhomeosgiconfigs folder to to re-enable and permit enabling of blacklisted components, follow these steps remove the names of the components from the blacklistcomponentnames list to enable all the blacklisted components remove the configuration file note to temporarily reactivate a component that's been blacklisted, you can remove its name from the component blacklist configuration module in system settings and click the update button. if you want the component to activate on subsequent liferay server startup, make sure to remove the component's name from any existing component blacklist configuration file in the now you know how to use the blacklisting features for modules and components.;;
the jasper jspc gradle plugin lets you run the liferay jasper jspc tool to compile the javaserver pages jsp files in your project. the plugin has been successfully tested with gradle 4.10.2 to use the plugin, include it in your build script the jasper jspc plugin automatically applies the java since the plugin automatically resolves the liferay jasper jspc library as a dependency, you have to configure a repository that hosts the library and its the liferay cdn repository hosts them all the plugin adds two tasks to your project the generatejspjava task is automatically configured with sensible defaults, if the war plugin is applied url otherwise the first resources directory of the main source set by default, srcmainresources the compilejsp task is also configured with the following defaults tasks of type compilejsptask extend javaexec, so all its properties and methods, such as args they also have the following properties set by default the properties of type file support any type that can be resolved by there are additional configurations that can help you use jasper jspc the plugin creates a configuration called jspc and adds several dependencies at the end of the configuration phase of the project if necessary, it is possible to add more dependencies to the jspc by default, the plugin creates a configuration called jspctool and adds a dependency to the latest released version of the liferay jasper jspc. possible to override this setting and use a specific version of the tool by manually adding a dependency to the jspctool configuration;;
the liferay util taglib is used to pull in other resources into a portlet or theme, it can be used to dictate which resources need to be inserted at the bottom or top of the html source a list of the available liferay util tags can be found here. to use the liferay util taglib library in your apps, you must add the following the liferay util taglib is also available via a macro for your freemarker theme each taglib has a list of attributes that can be passed to the tag. these are required and some are optional. to view the requirements for each tag since each of the liferay util taglibs is unique, each tag is covered briefly in the tag is not a self-closing tag. placed between the opening and closing of this tag is moved to the bottom when something is passed using this taglib, the is passed markup and outputs in this jsp. below is an example configuration for the tag between the opening and closing of this tag is moved to the top of the when something is passed using this taglib the url the opening and closing of this tag is saved to the value of the var attribute. this allows a developer to build a piece of markup that can be reused in a jsp the tag allows you to register some content with you can read more about the osgi service registry it's easier for modules using the osgi registry to use the content that you the tag scrapes the url provided by the url attribute. if a value is provided for the var attribute, the content from the screen scrape is scoped to that variable. otherwise, the scraped content is displayed where the taglib is used below is a basic example configuration for the tag here is an example that uses the var attribute placed between the opening and closing of this tag will be moved to the bottom between the opening and closing of this tag is moved to the head tag. the tag can be used to include other jsp files in a this can increase readability as well as provide separation of below is an explanation of some of the available attributes page this attribute is required. the value of this attribute is the path to the jsp or jspf to be included servletcontext refers to the request context that the included jsp should passing to this attribute allows the included jsp to use the same request object and other objects that might be set in the prior the tag can be used to add a parameter value to a url. this tag is best used when combined with the tag for the new parameter can then be used in url like this the tag is used for removing all whitespace from whatever is included between the opening and closing of the tag below is an example configuration for the now you know how to use the liferay-util taglib! loading modules with the aui script in liferay;;
do you want to develop liferay dxp themes without having to redeploy to see your use liferay dxp's developer mode! in developer mode, all caches are removed, so any changes you make are visible right away. reboot the server as often in developer mode how does developer mode let you see your changes more quickly? liferay dxp is optimized for performance. here is a list of developer mode's key override settings that trigger them if applicable note there are two known issues lps-71350 changes from being applied to the page and the control panel and product menu to break when using developer mode. both these issues are fixed in liferay portal ce 7.0.3 ga4 and liferay dxp fixpack de 13 individual file loading of your styling and behaviors, combined with disabled caching for layout and freemarker templates, lets you see your changes more these developer settings are defined in the to use these settings, you can include them in your url file or copy them over to your url file and override specific these configurations are covered in this tutorial first, you can explore how it's done in developer studio to enable developer mode for your server in developer studio, follow these steps double-click on your server in the servers window and open the select custom launch settings and check the use developer mode option save the changes and start your server figure 1 the use developer mode option lets you enable developer mode for your server in developer studio warning only change the server settings from the runtime environment's for liferay portal servers below version 6.2 e.g., liferay v6.1 ce server, liferay v6.0 ce server, developer studio enables developer mode by default. starting your liferay dxp server for the first time, it creates a url file in your server's directory. contains the property setting url, most of the configuration is provided by the url file, but you still have to configure the freemarker template setting. section to configure the freemarker template cache if you're not using developer studio, manual configuration for developer mode is covered to set developer mode manually, you must point to url folder of your app server's bundle and add the following line developer mode is enabled upon starting your app server. url provides the majority of the settings you'll need to disable the cache for freemarker templates, you must update the system setting covered in the next section freemarker templates for themes and web content are cached by default. any changes you make to your freemarker theme templates aren't immediately you can change this behavior through system settings. open the control panel and go to configuration system settings click the foundation tab and select freemarker engine by default, the resource modification check the time in milliseconds that the template is cached is set to 60. your freemarker templates are ready for development. can improve javascript file loading for development by default, javascript fast loading is enabled in developer mode this loads the packed version of files listed in url to false in your url, or you can disable fast loading by setting the url parameter jsfastload to 0 note javascript fast loading is retrieved from one of three places the request determined by the current url on or...?jsfastload0 off, the session, or the portal property liferay dxp gives preference in the order of request, session, and then portal properties. jsfastload's value from the default in url without having to manually re-enter jsfastload into the url upon every new page load you've set up your liferay dxp server for developer mode. modify your theme's file directly in your bundle, you can see your changes applied immediately on redeploying your theme! creating layout templates manually creating themes with developer studio;;
you can change the adt for an individual widget through its own configuration, but to configure the default adt for all widgets of that type, you must go to in the system settings you can find a configuration for any widget that supports adts has a display style group id and a display style option figure 1 the adt configuration in system settings lets you change the display style display style group id the site id where the adt is located. display style the adt's template key to enter a display style, you first need the template key for the template to get the template key, go to the application display template list for a given site and retrieve it from the adt listing. enter the display style as ddmtemplatetemplate-key for example, configure the language selector adts like this using the site selector, select the global site find the icon language selector template and click on it open details and find the template key - language-icon-ftl figure 2 system settings shows where you can find the template key now that you have the id, you can change the template from system settings once you have the id, go to the control panel system settings find localization under the platform heading and select language selector from the options on the left in the display style field, enter ddmtemplatelanguage-icon-ftl now any language selector widgets are added to a page use the new defaults. this doesn't affect widgets already added to a page and configured figure 3 you can see the new default configuration.;;
if you have proxy server requirements and want to configure your proxy to work with liferay dev studio, follow the instructions below set the active provider drop-down selector to manual under proxy entries, configure both proxy http and by clicking the field and selecting the edit button figure 1 you can configure your proxy settings in dev studio's network connections menu for each schema http and enter your proxy server's host, port, and note do not leave whitespace at the end of your proxy host or port once you've configured your proxy entry, click ok ok if you're working with a liferay workspace in dev studio, you'll need to configure your proxy settings for that environment too. setting proxy requirements for liferay workspace you've successfully configured dev studio's proxy settings! some eclipse plugins do not properly check the url proxy infrastructure therefore, you may need to configure additional to do so, open the url file associated with your eclipse installation after saving the file, restart eclipse. now your additional proxy settings are;;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable several propertysettingjobfactory warn messages are logged with a clustered liferay liferay portal, by default, stores information to jobdatamap within the quartzschedulerengine class. however, only fields are expected within url.propertysettingjobfactory. to resolve the warning messages, enabling the logging levels for the class should be set to the error level.;;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable when narrowing down search results using liferay portal 6.1 ee ga2, the portal does not continue to constrain results by the original query when another facet is selected. for example, this issue can be produced with the following steps to resolve this issue, simply open a ticket and mention the lps.;;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable this article describes an issue inherent in the pdfbox library that causes a jvm crash upon image conversion if you're unable to properly use imagemagick, you may need to update to the latest version imagemagick 6.7.9-6 2012-09-25 q16 or later. see lps-30291 for information on efforts to identify incompatible application versions with liferay portal lps-32257 pdfbox 1.6 cause tomcat crash on big pdf files.;;
"the isomorphic npm portlet sample provides a portlet that uses can run from client andor server side on the client side figure 1 this sample portlet displays the results of running code designed for the server in the browser this portlet showcases running code designed to execute in the server note that this portlet does not run javascript code in the server; it's executing isomorphic javascript code in the browser note the minifier fails on liferay dxp 7.0 when jsdoc is present in a this process may take a long time, depending on the number of files that require an update important this sample works for liferay dxp fix pack 44 and liferay portal npm development workflow support you can do many things with isomorphic code. isomorphic code cannot run server-side because liferay dxp is java based and cannot execute javascript that way. this sample portlet shows how liferay's npm bundler can transform server-side code to make it work in the client e.g., emulates some of url' apis in the client this sample uses the npm registry to download project to bundle the project dependencies inside the osgi bundle jar file to accomplish the bundling, the project's build process relies on a build this sample is built with the following build tool";;
the theme creation process is nearly identical to the portlet creation process that we covered in the last chapter. our theme will be named deep blue, so the project name without spaces is deep-blue, and the display name which can let's create the theme using liferay developer studio first, and then with the terminal go to file new liferay project fill in deep-blue for the project name and deep blue for the display select the build type, plugins sdk, and liferay runtime if you select the maven build type, you'll be prompted to enter an artifact version, group id, and active profile for your project. otherwise, select the ant build type, a plugins sdk for this demonstration, make the following selections for more information, see sections installing the select theme for your plugin type your theme inherits the parent theme's styling as a base from which to build your theme. in addition to the styled theme, you can choose to inherit from the unstyled theme, which contains no styling. there's also the classic theme that has a smooth look and feel and works for now, select styled as the theme parent you can select the freemarker or velocity template frameworks for your theme. or you can select jsp as your theme's figure 5.1 make sure to select the theme plugin type for your theme with developer studio, you can create a new plugin project, or if you already have a project, create a new plugin in an existing project. using the terminal navigate to the themes directory in the plugins sdk and enter the appropriate command for your operating system now there's a blank theme in your themes folder, which the plugins sdk automatically named by appending -theme to your project name. your next step is to set a base theme that serves as the default all themes in liferay are built on top of two base themes, named unstyled and your newly created theme is based on these by default, but they you can take advantage of an existing theme's styling by setting the theme of your choice as the base for your theme base themes are added in layers. first unstyled is added, giving you the core of the theme, then styled, providing the most basic elements. different base theme, it's added on top of styled and overrides the default styling wherever there are differences. after the base themes are added, your own custom styling is added on top to specify a base theme, edit the url file for your theme and change existing theme that's installed or in your plugins sdk. is set, let's deploy the theme to your portal instance if you're already familiar with portlet deployment from reading chapter 3, theme deployment will be a piece of cake! you can deploy your theme in developer deploying in developer studio click and drag your theme project onto your figure 5.2 drag and drop your theme onto the server upon deploying, your server outputs messages indicating your plugin is read, registered, and available for use deploying in the terminal open a terminal window in your themesdeep-blue-theme directory and enter a build successful message indicates your theme is now being deployed. switch to the terminal window running liferay, within a few seconds you will see the message 1 theme for deep-blue-theme is available for use let's apply your theme to a page go to your web browser and log in to the portal hover over manage at the top of the page and click on page directly underneath the words manage pages, select the look and feel click on your theme to activate it now that you've built and deployed a theme, let's study theme anatomy.;;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable blob types are not supported in plugins created with the service builder in liferay portal 6.1.x a possible workaround could be use the documents and media services to store files or upgrade to liferay portal 6.2 ee t his lps cannot be back-ported as it would involve api changes that would cause issues. however, these code changes have been implemented in 6.2.x regarding lps-31186, lps-43193, and lps-50839. these issues relate to this article and have been addressed on portal 6.2 ee;;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable this article addresses memory issues caused by jruby, a java implementation of the ruby programming language. liferay portal currently uses jruby to run sass for the purpose of processing css the following list outlines a number of steps that may be taken to reduce the memory impact of jruby in your liferay environment there is currently an issue lps-34419 which addresses the perm. gen. space memory leak caused by jruby. to get this fix, simply open a ticket and our subscription services team will gladly provide it when css is used in hooks, jruby will likely be triggered to start filling with memory. therefore, to limit memory consumption, limit the overriding of core css files with hooks as much as possible and instead apply css through the theme to reduce the possibility of memory issues caused by url, remove the attribute antiresourcelockingtrue from all of the url files in your already deployed portlets if you haven't modified the url files manually, you can simply delete the whole url file. the url files can be found in url there is an issue lps-29750 in some versions of liferay portal that will cause the overriding of each portlet's url file upon deployment. therefore, it is important to check the contents of each portlet's url file as the contents may have changed and may be causing memory issues when creating a portlet, make sure to run the'build-css' ant task. this takes care of building the.sass-cache files, so the portal won't have to do it runtime. once you built it, redeploy the portlet to all nodes even if the portlet itself does not use sass, it is still recommended to run the build-css task. at the very least, manually create an empty.sass-cache folder in the portlet's css folder sometimes issues may arise because the user running liferay does not have the required privileges to create either the.sass-cache folder, or the files within them. please make sure that this user has write permission to the folders when the portal reaches out for the compiled css files, it first checks to see if the timestamps are the same for the css file and the compiled css. if the timestamps aren't the same, then the portal recompiles the css on the fly. this can also cause memory issues, especially if there are a lot of files that have mismatching timestamps running the attached groovy script resolves some of these issues by updating the timestamps so that they match. in addition, it also prints out the processed files and all of the used properties which might be useful for the support team should you be in touch with them. the script creates an output file at the following location url url please note, that running this script has one side effect if you have included custom css in any hooks, these will be lost as soon as the cache is invalidated if you are in a clustered environment, make sure to run the script for all nodes.;;
liferay portal users can export and import the contents of the web content display portlets as a liferay archive lar. when exporting a lar from the web content display portlet, the past versions of a web content article are not included in the exported lar file prior to liferay portal 6.1ga3, it was not possible to export past versions of a web content article. starting in portal 6.1 ga3, if users want to include past versions of the web content, they must begin the export of the lar process from the web content portlet in the control panel and not from the web content display portlet itself to reproduce this behavior in liferay portal prior to 6.1 ee ga3 as expected, only the latest version was exported if users require the inclusion of past versions of the same article during the export process, the following steps will need to be taken;;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable before lps-34161, there was redundancy in the search portlet which would manifest when multiple asset publishers were present on a site. the more asset publishers that were present, the slower search would be. until this point the performance had an inverse relationship with the number of asset publishers along with the number of search results if you would like to take advantage of a more efficient search algorithm, simply open a request and request a hotfix for lps-34161.;;
"this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable the following comprises a list of issues that administrators have experienced in running an upgrade, along with the underlying cause as well as the resolution to that particular issue url.sqlexception invalid sql statement or jdbc escape, terminating''' not found this issue is a result of characters within the database preventing a query from being executed. typically it can be a result of sql injection attack attempts on the database. delete from resourcecode where name like'!'; delete from resourcecode where name like'script'; delete from resourcecode where name like'cat'; delete from resourcecode where name like'imgsrc'; delete from resourcecode where name like'frame'; delete from resourcecode where name like'meta'; delete from resourcecode where name like'acu'; delete from resourcecode where name like'acu'; delete from resourcecode where name like'printf'; delete from resourcecode where name like''; delete from resourcecode where name like''; url.upgradeexception url.sqlexception cannot insert duplicate key row in object'dbo.resourcecode' with unique index'ix' the resourceactionid is already present during the upgrade from portal 5.2 to a later version of liferay portal. this is a result of bad data during the permissions migration in the upgrade lps-33364 fix was committed to the verifyprocess another possible solution would be to perform a data migration from permissions algorithm 5 to 6 prior to the upgrade.p during the upgrade, new tables and columns for the next version of liferay portal is being created. this exception occurs as a result of having the column name or table already present during the upgrade. no longer able to view image gallery images the image gallery portlet is now a legacy portlet and has been removed from later versions of liferay portal 6.1 ee liferay upgrade halts with alter table exception previous versions of liferay portal, during upgrade processes, would attempt to modify all tables within the database - including tables not used by liferay portal this results from a previously set virtual host setting which is no longer being referenced verify the virtual host settings are correct for the portal a particular section of the portal is not rendering such as a missing dockbar, missing portlet, etc this can be a result of customizations making direct changes to the portal html and themes. this can be from improper unregistering of the customizations. please be sure to also verify the cache is not affecting the portal from rendering clear out the cache of the web browser to manually clear the cache for internet explorer to manually clear data for google chrome to manually clear cache for firefox clear content cached by their vm clear content cached across the cluster unable to find theme messages during startup this is a result of a legacy theme not properly migrated or deployed to the new instance of liferay. these references may also be attached to custom layouts rebuild and re-deploy the layouts and themes for the new instance of liferay.";;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable setting the jndi datasource in weblogic and upgrading from portal 5.2.8. to portal 6.1 causes upgrades to fail with messages like this issue results from an inconsistent datatype error when using a jndi lps-27043 . the following are two available options to work around the issue upgrade to an updated version of liferay portal 6.1 resolved via hotfix or a later version of the portal use the url to manage the database settings rather than datasource.;;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable after configuring the application to sync with another server that has a different groupid, some administrators have found that liferay sync ios crashes sync the application with a server. configure the application to sync with another server that has a different groupid. first, update liferay sync ios to version 1.2.;;
integrating ntlm with liferay products should only be done with internet explorer for these affected versions due to security vulnerabilities. microsoft has not made any updates to ntlm with the advent of microsoft kerberos as lps-15559 points out, there is a security risk for using ntlm in non-internet explorer ie browsers. when ntlm was integrated in 6.0.x, there were various security issues when using chrome and firefox. thus to address this security issue, starting from liferay portal 6.1 ee, ntlm authentication is automatically disabled for non ie browsers to enable ntlm for other browsers, the code must be customized. the portion of code to modify is found in the url ntlm is deprecated as of dxp 7.2. we strongly suggest that customers move to kerberos, which is supported for all dxp versions please note that edge is not technically considered ie, and thus ntml is not supported on ie edge;;
you can use kerberos to authenticate microsoft windows tm accounts with this is done completely through configuration by using a combination of liferay dxp's ldap support and a web server that supports the kerberos note that this configuration is preferred above because security vulnerabilities persist while it's beyond the scope of this article to explain how to set up kerberos and active directory on a windows tm server, we can describe the minimum prerequisites for setting up liferay authentication a windows tm server with active directory and dns set up so the ad server and liferay dxp can resolve each other on the network. they must be able to ping each other by name an administrative user in ad liferay dxp can use to bind to ad a kerberos keytab file exported via the ktpass command containing the cryptographic information the liferay dxp server needs to bind to ad a web server in front of liferay dxp that supports kerberos, such as apache, the web server must also support injecting a header to be used as a token in the liferay dxp configuration see below of course, you need a liferay dxp installation that can also resolve by name it should never run on the active directory server when you have all of these prerequisites in place, you're ready to configure from the prerequisites, you may be able to guess that there are several moving parts to how sso works with kerberos figure 1 kerberos authentication requires a web server in front of your liferay dxp server first, a properly configured web browser sends a negotiate request using to configure this, the browser must recognize the site as a trusted site explained below. the web server's kerberos module uses the keytab file to bind over the kerberos protocol to ad and verify the user if all is okay, the ad server confirms the connection with a valid the web server you choose must support both the kerberos protocol and the injection of a custom header into the request that liferay dxp can later read. when the web server forwards the request to liferay dxp, it reads the header to obtain the user data and authenticate the user next, you'll learn how to get all of this working there are four components to configure a user keytab from active directory, a web server in front of your application server, liferay dxp, and your create a user so liferay dxp can bind to active directory ensure that the ad domain controller and the web server can see each other on the network via dns configuration or hosts file on linux, this involves installing krb5 and configuring it to match your realm that's already configured for active the example domain for the user configured in step two above copy the keytab file you generated on your ad server to your web server configure your web server, making sure you set the correct server name, kerberos service name, kerberos authentication realms, and the path to the for example, if you're using the apache http server, the configuration might look like this the last line is commented out based on user preference. removed from the user name when saved in liferay dxp, uncomment it. leave it commented out to store the domain with the user name finally, configure liferay dxp to access active directory via the ldap change authentication to be by screen name by selecting it in connect liferay dxp to ad over ldap by going to configuration instance provide the information appropriate to your installation base provider url your ad server on the proper port principalcredentials supply the credentials for the user exported to authentication search filter supply the appropriate search filter to uuid supply what uniquely identifies a user, such as samaccountname screen name supply the field that should be mapped to liferay dxp's screen name field, such as samaccountname password supply the field that contains the user's password, such as be sure to test the connection, save, and enable the configuration finally, configure the token for single sign-on at configuration system settings security sso token based sso. the user token name matches exactly the token you configured in your web click the enabled and import from ldap boxes and click save you've configured your servers. all that's left is to configure your you must do two things make your computer log into the domain and configure your liferay dxp server as a trusted internet site join your computer to your domain. in keeping with the example above, you'd make your computer a member of the intdomain.local domain log in as a user in that domain internet explorer, edge, and chrome use the windowstm settings for if you use these browsers, go to internet options security local intranet sites and add your liferay dxp server's url. firefox can be configured by typing aboutconfig in its address bar. for the below two preferences and add the liferay dxp server's url as the value after configuring these things, test your configuration by accessing liferay dxp since you are already logged into your client machine, you should be automatically logged into liferay dxp without congratulations on configuring kerberos with liferay dxp!;;
as a help center user, you can be a member of one or many different organizations. if you're a member of a shared organization, you can see tickets for all members of that organization. you can also receive notifications on the requests pertaining to that organization. this article describes the process of subscribing and unsubscribing from these notifications the link appears only if you're a member of a shared organization in zendesk perform steps 1-3 from the subscribe section then click unfollow.;;
as a customer, you are familiar with using lesa to create tickets and work with liferay customer support engineers cses. on december 1, 2018, liferay officially released our new support site, help center, and lesa was switched over to read-only mode please see our help center faq page to learn more about this change in the meantime, you may still need access to current and past tickets on lesa. there are two ways to view your ticket history;;
"experience; consider that word for a moment. gain with repetition, but the contact or encounter you have with something. example, if you're hiking in the woods and are mauled by a black panther, you would consider this a bad hiking experience. suppose you travel to your local food market and someone gives you a large amount of money for no reason other you would consider this a great grocery shopping experience these two examples may be a bit extreme, so let's tone this down to something a suppose you're a huge sports fan and you're contemplating whether to buy tickets to the big game next week. you might consider that would determine whether you attend the game or not? price of the tickets is usually the most important factor. parking accessibility, distance to the game, quality of your favorite team, to determine whether you attend the game, you weigh the negative factors, like price and the stadium's nightmarish parking setup, with the reason you're attending the game, the experience. experience of seeing your favorite team play to trump the negative factors, you'll if you expect the experience will be bad or worse than the negative factors you expect to encounter, you'll stay home and watch the game on tv liferay dxp takes the experience factor very seriously when it comes to web just like the sports fan that weighs the experience vs. the live game headaches, the useradministrator also weighs the experience of using a web platform with the resulting site created on it. provided with liferay dxp's web experience management suite, the management of sites, pages, and content is seamless managing sites and pages is a fundamental pillar of any web site, and liferay dxp provides easy-to-use features that make sitepage creation quick and easy. content is another building block upon which most sites rely. content apps, you can easily create simple or complex content for your site's once you've created content, liferay dxp also provides several innovative ways to publish that content, so users can find the right information as fast as sometimes your site must adapt on the fly, whether it be for a testing environment where you can plan the look and feel of your pagescontent gives you peace of mind in knowing that you won't have to trial and error site changes on a live page just as the die-hard fan knew he'd have a great experience when buying his tickets to the big game, you can expect a great and seamless web experience with";;
now that you've performed the steps needed to prepare for your installation, you're ready to install liferay dxp! since bundles are the easiest way to complete an installation, all the installation steps below assume a bundle has been if you plan to install liferay dxp manually, please refer to the article for your app server of choice, and then come back here to complete the you've created a blank database for liferay dxp and have gathered the credentials you need for your mail server. liferay dxp bundles contain the same folder structure regardless of application the top-level folder is named for the release of liferay dxp. this folder is usually the parent folder of the this is why liferay dxp bundles place the application server inside the bundle's root folder. on a manual installation, the location of this folder varies by application server. if you're doing a manual installation, please refer to the article covering that app server for its location in the liferay home folder there are folders for various purposes data this folder is used to store an embedded hsql database, liferay dxp's file repository, and liferay dxp's search indexes. liferay dxp is initially configured to use the embedded hsql database but the hsql database is primarily intended for demonstration and trial purposes. sets the hypersonic embedded hsql database location deploy to auto-deploy liferay dxp plugins, copy them to this folder. style.war files, liferay dxp 7.0 style.jar files, and.lpkg files from liferay marketplace are supported. license liferay dxp's copyright and version files are here logs this folder contains liferay dxp's log files. liferay dxp's log files can be quite valuable for system administrators, especially when trying to diagnose a problem. url file sets the location for the log to override the log file location, you must use an url file in an ext plugin osgi all the jar files and a few configuration files for liferay dxp's osgi patching-tool this folder contains patches for liferay dxp and files for installing the patches digital enterprise 7.0 only tools for portal upgrade and target platform indexer application server the name of this folder is different depending on this folder contains the application server in which liferay dxp has been installed if liferay dxp is unable to create the resources it needs in the liferay home folder or if it finds itself running on certain application servers, it creates a folder called liferay in the home folder of the operating system user that in this case, the liferay folder becomes liferay home. for example, if the operating system user's name was jbloggs, the liferay home folder could be homebloggsliferay or cusersjbloggsliferay getting a liferay dxp bundle up and running is as easy as uncompressing the archive, possibly copying a jdbc driver, and then starting the application let's use the liferay dxp tomcat bundle as an example if you're setting up liferay dxp to be an actual server, copy your database's jdbc driver.jar file to tomcatlibext. open source database or if you're setting up liferay dxp for demo purposes, you you've extracted liferay dxp, and it's ready for use. easier than doing a manual installation on an app server. what you need to do, please at this point click the link on the left and go through the installation procedure for your app server of choice. finished with the installation and before you've started liferay dxp for the first time, come back to this spot, because you need to hook it up to your you can connect liferay dxp through either your app server's data source or the one because of its suitability for tuning, it is recommended that you use the data source that ships with liferay dxp. you'll create a configuration file called url, and you'll place that file in your liferay home folder the configuration varies by database, of course, so templates for each one are provided in the reference section. to connect your database, therefore, create a text file called url in your liferay home folder. for your database and paste it into this file now all you have to do is customize it. enter the proper host name and user and password credentials for your database, and then save the file next, start your app server, or start the liferay dxp app in your app server. example, if you're using the liferay dxp-tomcat bundle, start tomcat as if you had tomcat is launched by invoking a script which is found if you open a command prompt or terminal and go to this folder, you can launch tomcat via the following command on windows or the following command on linuxmacunix the liferay dxp tomcat bundle then starts. if you are on windows, another command prompt window appears with tomcat's console in it. see the tomcat console by issuing the following command liferay dxp writes log files to folder liferay homelogs the first time liferay dxp starts, it'll take a while to create all of its database once it has successfully started, it automatically launches a web browser that displays liferay dxp's basic configuration page. if for some reason your browser doesn't load the basic configuration page, launch your web browser and navigate liferay dxp's setup wizard runs when you start liferay dxp for the first time. it easy to configure liferay dxp, the first thing you see when browsing to your newly installed liferay dxp bundle is a setup wizard. this page provides a convenient way to make an there are two sections of the wizard the portal and the administrator. portal, you need to supply the following information portal name the name of the portal you're powering with liferay dxp default language choose the default locale of your portal for the administrator, you need to supply the following information first name the first name of the default administrator user last name the last name of the default administrator user email the email address of the default administrator user note the administrator user's email domain is used as the liferay dxp instance's default domain i.e., the figure 1 supply the information for your portal and your portal's default administrator user on the basic configuration page the basic configuration page also includes a checkbox labeled add sample if you check this box, sample data is added to liferay dxp's database. data includes users, sites, and organizations. liferay dxp features to be showcased. if you're installing liferay dxp on your own machine to explore its features, the sample data will probably be useful. however, you're installing liferay dxp on a real server, you should start with a once you've filled out the form, click finish configuration. creates a url file which stores the settings that when you begin customizing your portal's configuration, however, you should use the url file you created earlier. possible properties that can be placed in this file are documented in our tip the wizard is an extremely helpful tool, especially if you're setting up liferay dxp for the first time. if you're a liferay dxp veteran and you already have your various properties set up, you can disable the setup wizard. the setup wizard, you must configure everything manually from the to disable the setup wizard, enter property values in url the file created in liferay home by the setup wizard override property values in url after you've entered the information requested by the basic configuration page, liferay dxp should bring you to its home page. now that liferay dxp is up and running, log in as the administrative user you click the menu icon and then go to control panel server administration mail, and have your mail credentials ready you're asked for the following information incoming pop server the hostname for a server running the post office liferay dxp checks this mailbox for incoming messages, such as message incoming port the port on which the pop server is listening use a secure network connection use an encrypted connection when connecting user name the user id liferay dxp should use to log into the pop server password the password liferay dxp should use to log into the pop server outgoing smtp server the hostname for a server running the simple mail liferay dxp uses this server to send emails, such as password change emails and other notifications outgoing port the port on which the smtp server is listening user name the user id liferay dxp should use to log into the smtp server password the password liferay dxp should use to log into the smtp server manually specify additional javamail properties to override the above configuration if there are additional properties you need to specify, supply when you're finished setting up your mail configuration, click save your next step for basic liferay dxp configuration is to convert the search implementation from its default demo mode into a production-ready mode.;;
this article is to help those who wish to change the x-frame-options in liferay digital experience platforms. usually, this is required if you are trying embedding widgets in a portlet or an iframe so that http headers are protected against clickjacking these values are found in the url file and not the url file located inside the url to override the default settings, create a url file. like the url file, as best practices, you should never modify the url directly. to do so, each nested widget should be like this url.1 truncated portal page url allow-from web page url place the url file in the ..rootweb-infclasses folder when finished. it is possible that a server restart is necessary to apply the changes see the url reference guide for more general information.;;
this article is regarding a performance issue that may surface when executing an ldap import using the usergroup method for a large amount of users. specifically, the issue is that the import process could take longer than expected the cause of this issue is that the sql query select userid from usersusergroups where usergroupid ? will be executed for each user being imported. this query execution could create large result set if there are a large amount of users in the database. since the oracle jdbc connection defaultrowprefetch size is only at 10 rows, the defaultrowprefetch size creates a bottleneck in terms of fetching the query results to improve the bulk ldap import performance, there are two possible options to consider using tune the oracle jdbc connection pool size to set the defaultrowprefetch value from 10 to a more appropriate number note database related tuning is not supported by liferay support. please refer to oracle resource for more information lps-49427 was raised to address the issue by introducing cacheless table mapper through the optimized query statement. in addition to using the fix from lps-49427, the url table name needs to be added to the url file to configure which table to adopt this option.to use this property, you would put the names of the tables and separate them by commas note this option does not require any change of jdbc connection pool. the table name for the property is case sensitve.;;
"this article documents a known issue in the export process if any asset has a forbidden character in the name. these characters are usually reserved for html and xml and thus should not be used. in the case of exporting a page template as a.lar, there is a console error and the export process fails the following characters have been blacklisted!;?' at this point the system attempts to generate the.lar file. then the status page displays the export process has failed the console error displays below one immediate solution is to add the characters to the property url found in the url. add the forbidden values to this list separated by commas. as a best practice, do not modify the url file directly, but instead, create a url file liferay engineering has implemented a fix where the error will be caught much earlier in time than at the export process. this means the portal will have a validation check when site administrators are naming their site or page templates. however, at this point, this solution has not been implemented in any liferay portal 6.2 ee fix packs to receive this solution, open a ticket and ask for a hotfix that includes lps-74521 to track the status of the fix, see lps-74521.";;
the liferay schema encoding should always match the encoding used in the database. one of the easiest ways to do this is to simply use utf-8 across the board so that no issues arise if you decide use international characters or characters with accents on them, any other encoding may have issues when these characters are being read from the database. it is therefore advisable to use utf-8 for internationalization. if iso encodings are used, ensure that only english western characters are used meaning that no accents are allowed. be very specific when first setting up the database to ensure that the encoding stays at utf-8. if it is not, data conversion may be necessary if internationalization is required in the future.;;
between fix packs portal-96 and portal-109, there is a known issue with license handling. when the maximum connection limit is reached, the license page is displayed and the license itself is marked as invalid see the picture below. you do not have the option to reset the connections to solve the issue, simply install portal-110-6210 or newer fix pack installing fix packs and hotfixes on liferay portal 6.x ee;;
if the window size of the browser is not fully maximized, the ckeditor will not display all the buttons as when the browser is maximized this behavior is a new feature implemented in liferay portal ee 6.2 to support mobile display. since there are so many mobile devices being released, liferay engineers have used screen width as a deciding factor for the way the editor is rendered. the determination of how the editor is displayed occurs upon loading a page as the liferay platform does not keep checking the changes made after a page loads as that could negatively impact performance. that is why if the browser is not maximized and the screen width is at minimized at a certain size, then the ckeditor may seem to be missing some of the editor tools that normally appear with a maximized screen maximize the page and then reloadrefresh the page. the full range of tools and buttons on the ckeditor will now be available for use. then minimize the browser page to the desired size and as long as the page is not refreshed, the full range of buttons available in the editor will be available for use for more information, please refer to lps-38359;;
the liferay portal 6.1 ee ga3 portal-67 fix pack allows dynamiccssfilter and minifierfilter to create temporary files in the wrong directory temporary cache files of dynamiccssfilter and minifierfilter are created in the directory where the java process was launched from e.g. tomcathomebin instead of inside the server's temp directory e.g. tomcathometempliferaycss and tomcathometempliferayminifierportal please request a new hotfix by opening a help center ticket with the following title hotfix request for lpe-16018.;
this article outlines a specific known issue that exists within liferay portal 6.1 ee ga3 sp3 and provides a link to follow its resolution at the time of release, there is one known issue with liferay portal 6.1 ee ga3 sp3. in this version of liferay, a concurrentmodificationexception may be experienced when deploying plugins to the portal this issue is resolved in the liferay-fixpack-development-6-6130 update. this fix is included with the latest set of fixpacks for the portal.;;
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 outlines known issues that may be experienced when using liferay portal 6.2 ee with the jboss application server please note that these two issues apply to the liferay-jboss 7.1.1 bundle that is available for customers the following issue applies to jboss as 7.1.2 per-deployment logging was added to jboss as 7.1.2, resulting in an out of the box split between liferay's logs in liferayhomelogs and jboss' url in jbosshomestandalonelog . messages from liferay will no longer be logged in url due to this split. this jboss as7 ticket describes the feature and the following forum post delves more deeply into the issue as noted in the forum thread above, to disable the feature one can add url to the javaopts variable in url and restart the server. unfortunately, configuring url will make the logs more verbose and record even what liferay portal has set to be ignored. to address this you can add liferay's log levels to jboss' log levels, but this will require all logging levels to be adjusted within url. after this is set they cannot be adjusted within control panel server administration log levels here are the steps to disable per-deployment logging in jboss as 7.1.2 and configure liferay's logs as an example, here is a logging category in url in liferay's url they look like this after formatting and adding liferay portal's logging categories to url please restart the server and verify that liferay portal's logging messages appear in url.;;
"searches done in all scopes everything from a search portlet upgraded from portal 6.1 will lose the scope and filter only to the current site if a facet is selected this only happens if before the upgrade the search portlet's display settings configuration was changed from basic to advanced and the default search configuration was not changed this is a known issue; the advanced configuration of the search portlet is not changed during upgrade in order to avoid the possible loss of customization. the default search configuration for 6.1 does not have a scopes facet, which leads to the described behaviour in order to workaround this issue, a configuration block of the scope facet similar to the one below must be added to the json facet configuration of the search portlet see lps-53703 for more information.";;
there is currently a known issue for some liferay customers using a clustered jboss web 7.0.16 server and previous versions in which a memory leak occurs according to the red hat jboss enterprise application platform 6 matrix, jbossweb-7.0.16.final is part of eap 6.0.0 according to red hat jboss, this particular memory leak issue has been resolved in jbossweb-7.0.17.final. which corresponds to eap 6.0.1 and upwards to resolve this issue, consider upgrading to the latest version of jboss eap 6.;;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable this article documents the solution to a known issue when creating structured web content if the customer is using an older version of the javamelody hook developed for liferay portal during the structured web content creation process, customers will see the following error message in the console logs liferay-javamelody hook version 1.62.0 or earlier is incompatible with lps-57997 contained in the fix pack portal-73-6210 upgrade the hook to a version higher than 1.62.0 javamelody is an open source lightweight product designed to monitor java applications. liferay has forked a branch on github to create this plugin.;;
the antisamy portlet is meant to prevent xss type attacks. one side effect however is that if an html target is used, then the portlet will remove it upon publishing the content the liferay platform uses antisamy's default configuration xml, the url, which by default scrubs the target attribute because it could possibly expose a xss risk however, you may configure the antisamy's configuration file to allow the target attribute to work. an example of configuring the xml file that may work is described here xss filter issue with the target attribute of the a tag as this would be a customization, please keep a backup of the original antisamy portlet, or extend it if possible please refer to owasp's guides on how to configure antisamy;;
this article lists the issues that exist in liferay portal 6.2 ee sp14 description complete local is prepended to the url when setting url to 2 resolution apply the fix pack portal-80-6210 available from help center description the value 3 for the property url doesn't work as stated in the properties file. it does not prepend the locale to the url for guest users as described in the properties description resolution update to sp17 or later see lps-65302 for more details.;
this article is a legacy article. it applies to previous versions of the liferay product. while the article is no longer maintained, the information may still be applicable this article outlines a small set of issues that exist within the core-5 fix pack as well as their resolutions in some environments, the plugin language keys fails to load after installing core-5 fix pack. redeploying the problematic plugin will resolve the issue. this issue is known to exist in the wsrp portlet uninstalling social office through marketplace will render social office sites' pages inaccessible notice current so 2.0.4 ce users planning to upgrade to 2.0.5 ee must first download 2.0.5 ce. upgrading directly from 2.0.4 ce to 2.0.5 ee will break social office.;;
"this article documents changes to the mvcactioncommand type of commands after liferay dxp 7.0 fix pack 11 is deployed. this change most affects developers building portlets in liferay ide tools e.g. liferay developer studio or liferay blade before fix pack 11, developers did not have to declare url; it was not necessary for mvcaction commands but only the liferay dxp 7.0 generated portletid once fix pack 11 was deployed, it was discovered that mvcaction commands no longer worked. the rationale was a change in the portal. liferay dxp 7.0 generated a name for the portlet that did not match the underscored name defined in the portletname constant in the keys class. therefore, mvcactioncommands will not be triggered if url is not defined in the mvcportlet, the result is when actions are invoked from mvcactioncommands for example, addrecordmvcactioncommand, the mvcportlet ends up using the method getportletname from genericportlet and this name is post processed by the portlet container after fix pack 11, the url has been added to each portlet classes in liferay dxp 7.0 by default. see the following template from source developers using liferay blade cli tools will have to manually add this property to all portlets because this property is not included in the project templates. once added to any custom portlet, this will resolve the issue of mvcactioncommands not being bound to the portlet. the next release should resolve this issue by including url in all project templates developers using liferay developer studio will find that this property is already included in the project templates in the latest release.";;
"the following article describes how to detect section 508 compliance issues section 508 is an, amendment to the united states workforce rehabilitation act of 1973, which is a federal law mandating that all electronic and information technology developed, procured, maintained, or used by the federal government be accessible to people with disabilit ies. source techtarget search cio while each issue is different and compliance is based on a case-by-case scenario, the easiest way to measure whether something is 508 compliant is to test if a portlet and its functionality can be accessed via the keyboard to detect section 508 compliance issues, one can use a tool such as web accessibility evaluation tool wave toolbar for firefox. the wave toolbar extension is developed by url and is available for download here wave browser extensions. it can detect what is missing or hindering accessibility on a particular web page. the toolbar does not solve problems; rather it is used best as a detection tool. see the screenshots below for the wave toolbar in action usually, the tool like wave will indicate elements such as missing form label. as mentioned above, the wave toolbar does not solve accessibility problems. rather it highlights specific elements on the page where web designers should improve in order to comply with section 508 requirements. in the second screenshot, the altalt error indicates that alt tags have not been filled out to differentiate between the different images if a 508 compliance issue is encountered, please note that our support team will use due diligence to confirm the issue. if the issue is determined by engineering to be an issue that support needs to provide a fix for, we will release the solution in the form of a fixpack, minor release or major release.";;
this article documents liferay's position on duplicating a database to create a staging environment in order to enable remote live staging, system administrators must have two databases a staged environment and a live environment. one assumption is that it should be possible to copy the staged database and make it the live environment. this is perceived to be a shortcut so that the platform does not have to perform the initial publication when moving staged data to remote live this method was once nonviable because there was a validation check during the staging process that ensured the two sites were different. if this validation check fails, the following error is displayed in the gui liferay engineering has removed the validation check in liferay digital enterprise 7.0 fix pack de-33 available from the fix packs page. validation will be available in specific use cases where needed, but no longer absolutely required. before installing the fix pack, please read the important fix pack changes article see lps-74947 for more information.;;
portletmvc4spring compliments the spring web framework and mvc design pattern by providing annotations that map portlet requests to controller classes and here you'll develop and deploy a portlet application that uses portletmvc4spring, spring, and jspjspx templates figure 1 the archetype's sample portlet prints a greeting e.g., hello, joe bloggs on submitting a first and last name follow these steps to create and deploy your portlet application for the project structure and commands for generating portletmvc4spring here's the maven command for generating the jspjspx project. this article lists sample code from the generated project in your project's gradle build file or maven pom, add your app's here are the portletmvc4spring development dependencies at this point you can develop your model, view, or controller components, in create your model classes in a package for models e.g., create your view using a spring web-supported template type. generate your project using the archetype mentioned above, specify a view resolver for template type in your the sample url template renders a form for submitting a user's first to invoke actions in your controller, associate action urls with your the sample template associates the action url variable mainformactionurl with its form element a element's modelattribute attribute targets an application the sample template targets the application's user model style your portlet by adding css to a stylesheet e.g., url and linking your template to it define your portlet's messages in a properties file e.g., template references some of these properties create a controller class to handle portlet requests. annotation applies the spring controller component stereotype. framework scans controller classes for controller annotations annotation marks the class's public methods as request handler methods for in your controller, apply annotations to methods for url.rendermapping and make sure each handler method returns a string that matches the name of a template to here are the sample's render request handler methods the annotation causes the prepareview method above to be invoked if no other handler methods match the request. prepareview renders the user template i.e., url the params url annotation causes the showgreeting method to be invoked if the render request has the in your controller, apply annotations to your portlet action request handling methods. the sample controller's action handler method below is annotated with, making it the default action handler if no other action since this portlet only has one action handler, the submitapplicant method handles all of the portlet's action requests associates the view's user model comprising a first name and last name to the user object passed to this method note, the submitapplicant method sets the url render parameter to success the previous render handler method showgreeting configure any additional resources and beans in the project's descriptors and spring context files respectively. build the project war using gradle or maven deploy the war by copying it to your liferay-homedeploy folder liferay dxp logs the deployment and the portlet is now available in the liferay dxp find your portlet by selecting the add icon and navigating to widgets and the category you specified to the liferay bundle generator sample is the default category you created and deployed a portletmvc4spring portlet;;
spring framework 5 does not include support for spring portlet mvc. support for spring framework 4, including portlet mvc support, will remain until 2020. what is the future of spring portlet mvc and liferay liferay adopted spring portlet mvc in march of 2019 and the project was renamed to portletmvc4spring. portletmvc4spring is an open source project for developing portlet-based applications using the spring framework and mvc patterns portletmvc4spring is fully backed by liferay. customers can report issues with the portletmvc4spring project in order to receive issue resolution and limited guidance as part of their subscription benefits portletmvc4spring requires jdk 8 and portlet api 3.0. in addition, it has been refactored and tested for use with version 5.1.x of the spring framework portletmvc4spring can be used with liferay dxp 7.1 fix pack 3 and higher developing a portlet using portletmvc4spring for dxp 7.2 migrating from spring portlet mvc to portletmvc4spring portletmvc4spring requires a portlet 3.0 compliant portal. previous versions of spring framework 4.x and 3.x are compatible with liferay dxp 7.0 and below. spring portlet mvc should be used for these versions of liferay creating a spring mvc portlet for dxp 7.0 what does the future hold for spring portlet mvc?;;
the spring mvc portlet provides a way to add various different fields into the database and display them in a table. this project is a spring mvc based portlet war that implements the same functionality as the appsservice-builderbasic-web sample project. display, uses a spring-annotated portlet class, and invokes the appsservice-builderbasic-api module to call services note if you're planning to package this sample using maven, you must complete a few additional steps to avoid build errors. since the basic-api bundle is not available on liferay's cdn repo or maven central, this sample can not reference it, resulting in build failures to satisfy this dependency, you must install the bundle dependency to your local .m2 repo, along with the parent bnd plugin and root maven project. now you can build this sample successfully figure 1 click add and fill out the sample fields to generate a custom entry in the portlet's table unlike the service-builderbasic-web module, spring mvc portlets must be delivered as portlet war projects. this project builds to a war file but leverages all of the liferay workspace tools and gradle to build the war. must build and deploy the service-builderbasic-api and service-builderbasic-service modules for this sample to work properly. more information on using spring mvc portlets in liferay dxp, visit the this sample demonstrates a liferay dxp portlet built using the you can easily modify this sample by customizing its springmvcportletviewcontroller java class or any of its jsps stored in the for more information on customizing this sample, see the javadoc listed in this sample's springmvcportletviewcontroller there are three different versions of this sample, each built with a different;;
liferay is an open platform in an ecosystem of open platforms. liferay has its own mvc framework, therefore, doesn't mean you have to use it. it is perfectly valid to bring the tools and experience you have from other development projects over to liferay. liferay's development platform is standards-based, making it an ideal choice for applications of almost any type if you're already a wizard with spring mvc, you can use it instead of liferay's with no limitations whatsoever. since spring mvc replaces only your application's web application layer, you can still use so what does it take to implement a spring mvc application in liferay? considering how to package a spring mvc application for liferay dxp 7.0 developers creating portlets for liferay dxp 7.0 can usually deploy their portlet as java ee-style web application archive war artifacts or as java archive jar spring mvc portlet developers don't have that spring mvc portlets must be packaged as war artifacts because the spring mvc framework is designed for java ee. therefore, it expects a war layout and requires java ee resources such as the url descriptor because liferay supports the osgi wab web application bundler standard for deployment, you can deploy your war and it runs as expected in the osgi here are the high points on why that works in liferay dxp 7.0 the liferay auto-deploy process runs, adding the portletservlet and plugincontextlistener configurations to the url file automatically creates an osgi-ready meta-infmanifest.mf file. to affect the content of the manifest file, you can place bnd directives and osgi headers directly into the url you'll still need to provide the liferay descriptor files url and url, and you'll need a url descriptor develop a spring mvc portlet war file with the appropriate descriptor files your portlet's descriptor files reference by adding the packages to an import-package header in your url file here's an example import-package header the auto-deploy process and liferay's wab generator convert your project to a the wab generator detects your class's import statements and adds all external packages to the wab's import-package header. generator merges packages from your plugin's url if you depend on a package from java's url other than a java. package, and add it to the property's list. note spring mvc portlets whose embedded jars contain properties files e.g., url, url, url might be affected the last jar that has properties files is the only jar whose properties are added to the resulting wab's classpath. properties in other jars aren't added for example, suppose that a portlet has several jars containing these the properties from the last jar processed are the only ones added to the the properties files must be on the classpath in order for the to add all the properties files to the classpath, you can combine them into one of each type e.g., one url, one url, and one url and add them to web-infsrc here's a shell script that combines these files you can modify and use the shell script to add your jar's properties files to note if you want to use a spring framework version different from the version liferay dxp provides, you must name your spring framework jars if you don't rename your spring framework jars, the wab generator assumes you're using liferay dxp's spring framework jars and excludes yours from explains how to detect liferay dxp's spring framework version now get into the details of configuring a spring mvc portlet for liferay this isn't a comprehensive guide to configuring a spring mvc portlet. the high points, assuming you already have familiarity with spring mvc. don't, you should consider using liferay's mvc framework what does a liferay spring mvc portlet look like? to configure a spring mvc portlet, start with the in it you must declare spring's the spring front controller needs to know where the application context file is, so specify it as an initialization parameter in url update the path provide an application context file url in the example above, specified as you normally would for your spring mvc portlet if you're configuring a wab yourself, the url file in your spring mvc project needs to be fully ready for deployment. configuration for spring mvc, you need to include a listener for and a servlet and servlet-mapping for if you're letting liferay generate the wab for you this is the recommended approach, the above is not necessary, as it is added automatically during your application must be able to convert url.portletrequest s to url.servletrequest s and back again. to configure the spring view resolver, add a bean in your application context now the front controller, url.dispatcherportlet, can get a request from the view layer, but there are no actual controller classes to delegate the request handling to with spring mvc, your controller is conveniently separated into classes that handle the portlet modes view, edit, help you'll use spring's annotations to configure the controller and tell dispatcherportlet which mode the controller supports a simple controller class supporting view mode might look like this the return defaultview statement should be understood in terms of the view resolver bean in the application context file, which gives the string defaultview a prefix of web-infviews, and a suffix of.jsp. the path url, where you would place your default with spring mvc, you can only support one portlet phase in each controller an edit mode controller might contain render methods and action methods you need to define any controller classes in your application context file by develop your controllers and your views as you normally would in a spring mvc you'll also need to provide some necessary descriptors for liferay liferay portlet plugins that are packaged as war files should include some the descriptor url controls the category in which your portlet appears in liferay dxp's add menu. here's a simple example that just specifies the category the application will go under in liferay's menu for adding applications the descriptor url is used for specifying additional information about the portlet like the location of css and javascript files or a complete list of the attributes you can set can be liferay dxp uses the name to create the portlet's id you'll also notice the role-mapper elements included above. defining the liferay roles used in the portlet the liferay plugin, declare its resources, and specify its security related in the url file, you can also add osgi metadata adds to the manifest.mf file when you deploy your war file find all of liferay's dtds here to call osgi-based service builder services from your spring mvc portlet, you need a mechanism that gives you access to the osgi service registry note if you don't already have one, create a service builder project using blade cli design your model entity and write your service layer as normal see the that, add your service's api jar as a dependency in your spring mvc project since you're in the context of a spring mvc portlet, you can't look up a reference to the services published to the osgi runtime using declarative so how do you call service builder services, or other services published in the osgi service registry? one way is by calling the static while very simple, that's not a good way to call osgi services because of the dynamic nature of the osgi runtime. service implementations could be removed and added at any time, and your plugin needs to be able to account for that. additionally, you need a mechanism that lets your portlet plugin react gracefully to the possibility of the service implementation becoming unavailable that's why you should open a service tracker when you want to call a service that's in the osgi service registry since you don't have the luxury of using declarative services to manage your service dependencies, you have a little bit of work to do if you want to gain some of the benefits osgi gives you accounting for multiple service implementations, using the best service implementation available taking into account the service ranking property the static utility classes don't let you do that, and that's sad. because with a little code, you can regain those benefits. implementing a service tracker, read the service trackers tutorial to summarize, you'll need to do these things instantiate a new url.servicetracker to track the service open the service tracker in an method make sure the service tracker has if there is indeed something in the service tracker, now you're ready to call the service. here's what the if block might look close the service tracker in an method that's probably not enough detail, so refer to the tutorial on service as you'll see in the tutorial, there's some boilerplate code involved, but leveraging service trackers lets you look up services in the osgi if you are not required to use a spring mvc portlet, consider using liferay's mvc framework to design your portlets instead. the declarative services and annotations, which let you avoid the boilerplate code associated with service trackers;;
do you want to develop mvc-based portlets using the java ee standard? want to use a portlet development framework with a ui component model that makes it easy to develop sophisticated, rich uis? web apps using jsf that you'd like to use in liferay dxp? to any of these questions, you're in luck! liferay faces provides all these liferay faces is an umbrella project that provides support for the javaservertm faces jsf standard in liferay dxp. for a comprehensive demo for the jsf component suite, visit the if you're new to jsf, you may want to know its strengths, its weaknesses, and how it stacks up to developing portlets with cssjavascript here are some good reasons to use jsf and liferay faces there are some reasons not to use jsf. for example, if you are a front-end developer who makes heavy use of htmlcssjavascript, you might find that jsf ui components render html in a manner that gives you less control over the overall sticking with javascript and leveraging alloyui or some other javascript framework may be better for you. or, perhaps standards aren't a major consideration for you or you may simply prefer developing portlets using your whether you develop your next portlet application with jsf and liferay faces or with htmlcssjavascript is entirely up to you. more about liferay faces and try it out for yourself.;;
are set in the soy portlet's server-side code. that exposes these parameters as properties so you can access them on the client this tutorial covers how to configure your view component's state object and its properties on the client side so you can update the ui this tutorial references the example below this tutorial references the example portlet covered in this section. includes one view with a header that reads hello soy by default figure 1 the example soy portlet has a configurable header the text in the header following hello is provided by the header state property defined in its mvcrendercommand class. to follow along with this tutorial. the example portlet's mvcrendercommand class and soy template appear below for reference soy portlets are registered automatically using the so you can use this api to retrieve your portlet and update its state you can test this in your browser's developer console open the console in your web browser retrieve your portlet's component by passing the soy portlet's id in the for example, you can access the example portlet's component with the code below this returns the soy portlet's component object containing the state properties along with properties inherited from the prototype. alternatively, you can access the state object directly by calling the note the url method only returns the state object information for components currently on the page. properties defined for the current view now that you retrieved your soy portlet's component, you can access its state properties the same way you would access any object's properties the dot notation or the bracket notation. for example, you can use the code below to retrieve the url portlet's header state update the state property's value or you can pass a configuration object with the setstate method for example, you can change the example portlet's header to read figure 2 you can change the example portlet's header state property on the client side now you know how to configure soy portlet state properties on the client side! understanding the state object's architecture;;
the spring portlet mvc framework facilitates injecting dependencies and implementing the model view controller if you use this framework in a portlet for liferay portal 6.x, you can upgrade it to liferay dxp 7.0 this tutorial demonstrates upgrading a spring mvc portlet called my spring mvc it's a bare-bones portlet created from the plugins sdk's springmvc template figure 1 my spring mvc portlet shows its name and liferay dxp's information to follow along, download and refer to the the figure below shows the my-spring-mvc-portlet project figure 2 the my-spring-mvc-portlet project has traditional liferay plugin files, spring portlet mvc application contexts in spring-context, and a controller class myspringmvcportletviewcontroller these files have spring-related content here are the spring mvc portlet upgrade steps adapt the code to liferay 7.0's api facilitates updating the code and resolving compilation issues quickly the upgrade planner detects if the value of the liferay-versions property in your plugin's url file needs updating and it provides an option to fix it automatically. this is the only code adaptation required by my-spring-mvc-portlet in liferay portal 6.2, my-spring-mvc-portlet leveraged portal's jars by specifying them in the url file's since the property is deprecated in liferay dxp 7.0, you should acquire dependencies using a dependency management framework, such as gradle, maven, or apache antivy converting the sample portlet plugin from a traditional plugin to a liferay workspace web application facilitated resolving its dependencies here's the updated my-spring-mvc-portlet's url file some of my-spring-mvc-portlet's dependency artifacts have new names note if the spring framework version you're using differs from the version liferay dxp uses, you must name your spring framework jars differently from liferay dxp's spring framework jars. if you don't rename your jars, liferay dxp assumes you're using its spring framework jars and excludes yours from the lists liferay dxp's spring framework jars. explains how to detect the spring framework version liferay dxp uses note if a dependency is an osgi module jar and liferay dxp already exports your plugin's required packages, exclude the jar from your plugin's war file. this prevents your plugin from exporting the same packages that liferay is this prevents class loader collisions. deployment, add its name to the your project's to import class packages referenced by your portlet's descriptor files, add the packages to an import-package header in the if you depend on a package from java's url other than its java. and add it to the property's list. note spring mvc portlets whose embedded jars contain properties files e.g., url, url, url might be affected the last jar that has properties files is the only jar whose properties are added to the resulting wab's classpath. properties in other jars aren't added explains how to add all the embedded jar properties the portlet is ready to deploy. converts the portlet war to a web application bundle wab and installs the wab to liferay's osgi runtime framework you've upgraded a spring mvc portlet to liferay dxp 7.0. migrating plugins sdk projects to workspace and gradle;;
now that liferay is promoting more modular plugins deployed into an osgi runtime, you have to consider how your own code, living in its own module, can rely on services in other modules for functionality. possibility of service implementations being swapped out or removed entirely if your module is to survive and thrive in an osgi environment. liferay dxp 7.0 developers who need to annotation,, to get a service reference. when the referenced service is available if you're able to use ds and leverage the and ds handles much of the complexity of handling service if you can't use ds to create a component, keep reading to learn how to implement a service tracker to look up services in the service registry figure 1 service implementations that are registered in the osgi service registry can be accessed using service trackers note when using service trackers in your war-style project, you must configure the required url dependency carefully in your build file e.g., url, url, etc. to avoid errors. liferay dxp by default, it must be configured as provided. third party packages portal exports focusing on scenarios where ds can't be used. note the static utility classes e.g., userlocalserviceutil that were useful in liferay portal 6.2 and earlier exist for compatibility but should static utility classes cannot account for the osgi using a static class, for example, you might attempt calling a service that has stopped or hasn't been deployed or startedthis could cause unrecoverable runtime errors. however, helps you make osgi-friendly service calls using a service tracker, your non-osgi application can access any service registered in the osgi runtime, including your own and the services published by liferay's modules like the popular although you don't have the luxury of using ds to manage your service dependencies, you can call services from the service registry with a little bit to implement a service tracker you can do this to simplify your code, you can create a class that extends from the initialization part of your logic that uses the service, call your the object host parameter is used to obtain your own bundle context and in order to give accurate results must be an object from remember to open the service tracker before using it, typically as early as you the most basic usage of a service tracker is to interrogate the service's state. in your program logic, for example, check whether the service is null before service trackers have several other utility functions for introspecting tracked later when your application is being destroyed or undeployed, close the service if there's a strong possibility the service might not be available, or if you need to track multiple services, the service tracker api provides a callback mechanism which operates on service events. servicetracker's addingservice and removedservice methods. servicereference parameter references an active service object here's an example servicetracker implementation from the osgi alliance's osgi core release 7 specification when the is added to the osgi registry, this servicetracker creates a new wrapper class, myservlet, which uses the newly added service. when the service is removed from the registry, the removedservice method as an alternative to directly overloading servicetracker methods, create a register the servicetrackercustomizer by passing it as the servicetracker there's a little boilerplate code you need to produce, but now you can look up services in the service registry, even if your plugins can't take advantage of the declarative services component model.;;
easiest way for liferay developers to create new liferay modules. plugins sdk is also supported, blade cli lets you create projects that can be used with any ide or development environment. blade cli is a command line tool bootstrapped on to a gradle based environment that is used to build liferay 7.0 this tool set provides a host of sub-commands that help liferay developers create and deploy modules to a liferay instance. sub-commands are callable in the blade cli environment in this set of tutorials, you'll learn how to use these commands to create and;;
this section describes the mapping of portlet xml descriptor values to osgi service properties that can be used when publishing osgi portlets osgi services can contain properties in their definitions. properties makes dealing with configuration concerns simple and cohesive. properties are typically represented as key-value pairs or, more generally, as a portlet spec property keys are prefixed by liferay property keys are prefixed by the mappings essentially flatten what is found in the xml descriptor, sticking relatively closely to the original naming in order to have a memorable relationship with those definitions note xpath notation derived from the portlet xsd 4 is used in note xpath notation derived from liferay portlet 5 is used in 1 portlets are registered as concrete objects 2 multiples of these properties may be used. 3 this type is registered as an osgi service 6 liferay dxp creates each portlet's id based on the portlet's name i.e., the portlet-name descriptor in url or the url osgi service property. spaces are allowed in the portlet name, but they and all other javascript unsafe characters are stripped from the name value that's used for the therefore, make your portlet name unique in light of the otherwise, if you try to deploy a portlet whose id is the same as a portlet that's already deployed, your portlet deployment fails and liferay dxp logs a message like this;;
now that you've imported your plugin project to liferay developer studio, you probably see compile errors for some of the liferay classes it uses. as undefined classes or unresolved symbols because they've been moved, renamed, as a part of modularization in liferay dxp, many of these classes you must resolve all of these liferay classes for your plugin. changes are quick and easy to fix. changes involving the new modules require more effort to resolve, but doing so is still straightforward liferay class changes and required adaptations are described here class moved to a package that's in the classpath this change is since the module is already on your classpath, you need only update the class import. you can do this by using the liferay code upgrade tool or by organizing imports in developer studio. reports each moved class for you to address one by one. in developer studio automatically resolves multiple classes at once it's typically faster to resolve moved classes using the mentioned eclipse since liferay developer studio is based on eclipse, you can generate imports of classes in your classpath with the organize imports keyboard sequence comment out or remove any imports marked as errors, then if there's only one match for the import, developer studio automatically generates its import statement. that lets you select the correct import class moved to a module that's not in the classpath you must resolve the new module as a dependency for your project. the module and specifying your project's dependency on it class replaced or removed the class has been replaced by another class the upgrade planner discussed later explains what happened to the class, how to handle the change, and why the resolving a class that's moved within your classpath is straightforward. consider resolving such classes first. the remainder of this tutorial explains how to resolve the last two cases and starts with configuring your plugin project to declare the modules it needs before liferay dxp 7.0, all the platform apis were in url. of these apis are now in independent modules. many benefits, as described in the article benefits of liferay dxp 7.0 for liferay portal 6 developers. one such advantage is that these api modules can evolve separately from the they also simplify future upgrades. having to check all of liferay's apis, each module's indicates whether the module contains any backwards-incompatible changes. need only adapt your code to such modules if any as part of the modularization, url has been renamed appropriately to url, as it continues to hold the portal figure 1 liferay refactored the portal-service jar for liferay dxp 7.0. application apis now exist in their own modules, and the portal-service jar is now portal-kernel each app module consists of a set of classes that are highly cohesive and have a specific purpose, such as providing the app's api, implementation, or ui. app modules are therefore much easier to understand. modules that now hold the classes referenced by your plugin contains a table that maps each class moved from url to its new the table includes each class's new package and symbolic name you'll use this information to configure your plugin's your plugin might reference classes that are in liferay utility modules such as the following table shows each liferay utility module's symbolic name to find versions of modules deployed on your liferay dxp instance note previous versions of the plugins sdk made url the liferay dxp 7.0 plugins sdk similarly makes if you're using a liferay dxp bundle liferay dxp pre-installed on an app server, the liferay utility modules are already on your if you manually installed liferay dxp on your app server, the liferay utility modules might not be on your classpath. if a utility module you need is not on your classpath, note its symbolic name artifact id and version now that you have the module artifact ids and versions, you can make the modules available to your plugin project. the modules your plugin uses must be available to it at compile time and run time. here are two options for resolving module dependencies in your traditional plugin project option 2 manage dependencies manually the next sections explain and demonstrate these options dependency management tools such as antivy, facilitate acquiring java artifacts that provide packages your plugins need. they can download artifacts from public repositories or from internal repositories you configure as a proxies. from internal repositories you can the following links provide proxy details the liferay plugins sdk provides an antivy infrastructure. your dependencies in an url file in your plugin project's root folder. plugins sdk's ant tasks leverage the url file and the plugins sdk's ivy scripts to download the specified modules and their dependencies and make them note you can use gradle or maven in place of ivy for dependency management, but this isn't in this tutorial's scope. tutorials demonstrate using these tools additionally, liferay workspace provides a command for migrating antivy projects to gradle-based liferay workspace projects. migrating traditional plugins to workspace web applications here's an example dependency element for the liferay journal api module, version each dependency includes the module's name name , organization org , and tutorial explains how to determine the module's organization org at compile time, ivy downloads the dependency jar files to a cache folder so you at deployment, liferay dxp's wab generator creates an osgi web application bundle the wab generator detects the java packages your plugin uses and declares dependencies on them. your plugin can use the packages once a registered osgi service provides them if your project doesn't already have an url file, you can get one by creating a new plugin project in liferay developer studio and copying the url file it here's an example of an url file from the liferay portal 6.2 knowledge the plugins sdk works with project ivy files to store artifacts and make them accessible to your plugin projects if you don't want to use ivy or some other dependency management framework, you can store dependency jars within your plugin project manually. plugins rely on their dependencies' availability at compile time and run time. to compile your plugin, you must make sure the dependencies are available in the to run your plugin, the container must be able to find them either 1 the dependency java packages must already be active in liferay dxp's osgi framework or 2 the dependency jars must be included in the wab your plugin can use both the jars it currently has and the packages liferay dxp exports the plugins sdk for liferay portal 6 provided a way to compile against jars it you'd specify these jars in the portal-dependency-jars property in your on seeing a plugin's portal-dependency-jars list, the liferay plugins sdk copied the jars into the plugin's web-inflib. from adding the jars to the plugin war. this kept the wars small for deploying it was especially useful for deploying wars remotely or to cluster in liferay dxp 7.0, the portal-dependency-jars property is deprecated and behaves differently from previous versions. because importing and exporting java packages has replaced wholesale use of jars, modules and wabs can import packages without concerning themselves with jars. liferay dxp exports many third party packages for plugins can use if you're still using the portal-dependency-jars property, you may run into follow the instructions below the scenario to fix i've specified a jar, but in liferay dxp 7.0 none of the classes are some jars that liferay portal 6.2 used were removed in liferay dxp 7.0. specify them in your portal-dependency-jars, liferay dxp can't provide them. if you still need them, remove them from the portal-dependency-jars property and add the jars you need to your plugin's web-inflib folder i've specified jars, and liferay dxp 7.0 also exports all the jar's packages keep the jar in your portal-dependency-jars list. jar to your plugin's web-inflib folder at compile time but refrains from adding the jar to the plugin wab. the wab generated for the plugin imports the packages from a registered provider at run time liferay dxp 7.0 provides the jar but doesn't export a package my plugin imports keep the jar in your portal-dependency-jars property. the jar to your plugin's web-inflib folder at compile time and adds the jar to the plugin wab at deployment declares jars that are stripped from all liferay dxp generated wabs. are excluded from wabs because liferay dxp provides them already. for this property are excluded from the wabs, even if the plugins listed the jar in their portal-dependency-jars property if your plugin requires different versions of the packages liferay dxp exports, you must include them in jars named differently from the ones liferay dxp uses the url portal to use a different spring framework version in your wab, you must name the corresponding spring framework jars differently from the glob-patterned jars for example, to use spring framework version 3.0.7's spring aop jar, include it in your plugin's web-inflib but name it something other than adding the version to the jar name i.e., url differentiates it from the excluded jar and prevents it from being stripped from the wab you must download and install to your plugin's web-inflib folder jars that provide packages liferay dxp doesn't export that your plugin requires search for the module by its artifact id and group id navigate the search results to find the version of the module you want click the jar link to download the module's jar file add the jar to your project's web-inflib folder figure 2 after searching maven central, download an artifact's jar file by clicking the jar link as you manage module jars, make sure not to deploy any osgi framework jars these, they'll conflict with the jars already installed in the osgi framework. identical jars in two different classloaders can cause class cast exceptions. the easiest way to exclude such jars from your plugin's deployment is to list them in a deploy-excludes property in your plugin's you must otherwise remove the jars manually to exclude jars in your plugin's url file, add an entry like the one below, replacing the square-bracketed items with the names of jar files to exclude for example, here's an example property that excludes the osgi framework jar url and the liferay app module jar url how do you know what modules are already installed in liferay dxp? liferay dxp instance has a particular liferay app suite installed, then don't deploy module jars you know are in that app suite. experience management app suite is already installed which is the case for a liferay dxp bundle, then don't deploy web content module jars such as searching for a module in liferay dxp's is a sure-fire way to verify existing module installations before adding tag library definition tld files to your plugin, check liferay dxp the liferay dxp web application folder web-inftld has over twenty you can use liferay dxp's tlds in a traditional plugin by adding them to the portal-dependency-tlds property in the plugin's you've fixed class imports and resolved dependencies on all the modules and tag libraries your plugin uses finding and invoking liferay services;;
your modules will often need to use java classes from packages when a module is set up to import, the osgi framework finds other registered modules that export the needed packages and wires them to the at run time, the importing module gets the class from the wired module that exports the class's package for this to happen, a module must specify the import-package osgi manifest header with a comma-separated list of the java packages it needs. if a module needs classes from the url and url packages, it must specify them like so the character represents all packages that the module refers to explicitly. bnd detects the referenced packages import packages must sometimes be specified manually, but not always. conveniently, liferay dxp project templates and tools automatically detect the packages a module uses and add them to the package imports in the module jar's let's explore how package imports are specified in different gradle and maven module projects on building such a project's module jar, bnd detects the packages the module uses and generates a meta-infmanifest.mf file whose import-package header note liferay's maven module archetypes use the bnd-maven-plugin. for example, suppose you're developing a liferay module using maven or gradle. at build time, the maven or gradle bundle plugin reads your url or url file and bnd adds the required import-package headers to your module jar's meta-infmanifest.mf here's an example dependencies section from a module's url file and here's the import-package header that's generated in the module jar's note that your build file need only specify jar file dependencies. bnd examines your module's class path to determine which packages from those jar files contain classes your application uses and imports the packages. includes all classes found in the class patheven those from embedded regarding classes used by a traditional liferay plugin war, detects their use in the war's jsps, descriptor files, and classes in web-infclasses and embedded jars. the wab generator searches the url, it adds package imports for classes that are neither found in the plugin's web-infclasses folder nor in embedded jars the wab generator and bnd don't add package imports for classes referenced in in such cases, you must manually determine these packages and specify an import-package osgi header that includes these packages and the packages that bnd detects automatically. the import-package header belongs in the location appropriate to your project type here's an example of adding a package called url to the list of referenced packages that bnd detects automatically note the wab generator refrains from adding war project embedded liferay dxp already exports the jar's packages if your war requires a different version of a third-party package that liferay dxp exports, specify that package in your import-package list. if the package provider is an osgi module, publish its exported packages by if the package provider is not an osgi module, follow please see the import-package header documentation for more information now you can import all kinds of packages for your modules and resolving a plugin's dependencies;;
developers creating applications for liferay dxp 7.0 can choose to create them as java ee-style web application archive war artifacts or as java archive jar some plugin developers, however, don't have that portlets like spring mvc and jsf must be packaged as war artifacts because their frameworks are designed for java ee. layout and require java ee resources such as the url descriptor liferay provides a way for these war-styled plugins to be deployed and treated like osgi modules by liferay's osgi runtime. liferay dxp 7.0 supports the osgi web application bundle wab standard for deployment of java ee style wars. simply put, a wab is an archive that has a war layout and contains a meta-infmanifest.mf file with the bundle-symbolicname although the source of the project has a war layout, the artifact filename may end with either the.jar or.war liferay only supports the use of wabs that have been auto-generated by the wab the wab generator transforms a general war-style plugin into a wab so what exactly does the wab generator do to a war file to transform it into a wab the wab generator detects packages referenced in a plugin war's jsps, descriptor files, and classes in web-infclasses and embedded jars. whether the detected packages are in the plugin's web-infclasses folder or in an embedded jar in the web-inflib folder. either location are added to an import-package header in the wab's to import a package that is only referenced in the following types of locations, you must add an import-package osgi header to the plugin's url file and add the package to the is preventing packages referenced in url file listener-class elements from being detected and added to wab meta-infmanifest.mf file to import such packages, add them to an import-package header in the plugin's the wab folder structure and war folder structure differ. folder structure of a war-style portlet when a war-style portlet is deployed to liferay dxp and processed by the wab generator, the portlet's folder structure is transformed to something like this the major difference is the addition of the meta-infmanifest.mf file. generator automatically generates an osgi-ready manifest.mf file. to affect the content of the manifest file, you can place bnd directives and osgi headers directly into the url file. a url andor a build-time plugin e.g., bnd-maven-plugin should not be provided for your war plugin, because the generated wab cannot make use of them do you want to try this out for yourself? follow the steps below to see the wab create a war-style plugin that follows a similar structure to the one you can download an example war-style portlet open your liferay dxp instance in a file explorer and add a url file with the following properties these properties store your generated wab into your liferay dxp instance's you can learn more about these properties in the restart liferay dxp for these changes to be recognized copy your war plugin in your liferay dxp instance's deploy folder navigate to your liferay dxp instance's osgiwabs folder and inspect the you've seen the wab generator in action!;;
"service builder is a model-driven code generation tool built by liferay that allows developers to define custom object models called entities. builder generates a service layer through object-relational mapping orm technology that provides a clean separation between your object model and code this frees you to add the necessary business logic service builder takes an xml file as input and generates the necessary model, persistence, and service layers for your application. layers provide a clean separation of concerns. service builder generates most of the common code needed to implement create, read, update, delete, and find operations on the database, allowing you to focus on the higher level aspects of in this section, you'll learn some of the main benefits of using liferay uses service builder to generate all of its internal database in fact, all of liferay's services, both local and remote, are liferay are generated by service builder. service builder's use in liferay portal demonstrates it to be a robust and reliable tool. to use and can save developers lots of development time. of files service builder generates can seem intimidating at first, developers only need to work with a few files in order to make customizations to their applications and add business logic note you don't have to use service builder for liferay application it's entirely possible to develop liferay plugins by writing custom code for database persistence using your persistence framework of if you so choose, you can work directly with jpa or hibernate one of the main ways service builder saves development time is by completely eliminating the need to write and maintain database access code. basic service layer, you only need to create a url file and run this generates a new service.jar file for your project. generated service.jar file includes a model layer, a persistence layer, a service layer, and related infrastructure. these distinct layers represent a healthy separation of concerns. the model layer is responsible for defining objects to represent your project's entities, the persistence layer is responsible for saving entities to and retrieving entities from the database, and the service layer is responsible for exposing crud and related methods for the code service builder generates is database-agnostic, as is liferay itself each entity generated by service builder contains a model implementation class. each entity also contains a local service implementation class, a remote service implementation class, or both, depending on how you configure service builder in customizations and business logic can be implemented in these three classes; in fact, these are the only classes generated by service builder that are intended to be customized. ensuring that all customizations take place in only a few classes makes service builder projects easy to the local service implementation class is responsible for calling the persistence layer to retrieve and store data entities. the business logic and access the persistence layer. client code running in the same java virtual machine. have additional code for permission checking and are meant to be accessible from anywhere over the internet or your local network. generates the code necessary to allow access to the remote services. services generated by service builder include soap utilities and can be accessed another way service builder saves development time is by providing spring and hibernate configurations for your project. runtime and uses spring aop for database transaction management. also uses the hibernate persistence framework for object-relational mapping. a convenience to developers, service builder hides the complexities of using developers can take advantage of dependency injection di, aspect oriented programming aop, and object-relational mapping orm in their projects without having to manually set up a spring or hibernate environment or another benefit of using service builder is that it provides support for finder methods retrieve entity objects from the database based on specified parameters. you just need to specify the kinds of finder methods to be generated in the url configuration file and the generated finder methods allow you, for example, to retrieve a list of all entities associated with a certain site or a list of all entities associated with a certain site and a certain user. service builder not only provides support for generating these kinds of simple finder methods but also for finder methods that take liferay's permissions into for example, if you are using liferay's permissions system to protect access to your entities, service builder can generate a different kind of finder method that only returns entities that the logged-in user has permission to service builder also provides built-in caching support. at three levels entity, finder, and hibernate. ehcache as an underlying cache provider for each of these cache levels. this is configurable via portal properties. all you have to do to enable entity and finder caching for an entity in your project is to set the cache-enabledtrue attribute of your entity's element in your documentation for more details about liferay caching service builder is a flexible tool. it automates many of the common tasks associated with creating database persistence code but it doesn't prevent you from creating custom sql queries or custom finder methods. allows developers to define custom sql queries in an xml file and to implement custom finder methods to run the queries. this could be useful, for example, for retrieving specific pieces of information from multiple tables via an sql join. service builder also supports retrieving database information via dynamic query. liferay's dynamic query api leverages hibernate's criteria api in summary, we encourage developers to use service builder for portlet and plugin development because it's a proven solution used by many liferay plugins it generates distinct model, persistence, and service layers, local and remote services, spring and hibernate configurations, and related infrastructure without requiring any manual intervention by it also allows basic sql queries and finder methods to be generated and ones that filter results, taking liferay's permissions into account. service builder also provides support for entity and query caching. these features can save lots of development time, both initial development time and time that would have to be spent maintaining, extending, or customizing a finally, service builder is not a restrictive tool it allows custom sql queries and finder methods to be added and it also supports dynamic query service builder supports liferay 7's modular application development style. when you configure service builder in a liferay 7 osgi module, this module functions as a service module and its a convention to append service to the and a build tool-specific plugins such as the the gradle service builder plugins includes liferay's service builder plugin as the basic-api, basic-service, basic-web modules in the project serve as example service builder projects.";;
"web applications are often developed following the model view controller mvc but liferay has developed a groundbreaking new pattern called the okay, that's not true the framework is actually another implementation of model view controller. experienced developer, this will not be the first time you've heard about model in this article you'll need to stay focused, because there will be several attempts to show you why liferay's implementation of model view controller is different, when instead you're hearing about another mvc with that in mind, let's get back to the medial vein constriction if there are so many implementations of mvc frameworks in java, why did liferay stay with us and you'll see that liferay mvc provides the liferay mvc portlet framework is light, it hides part of the complexity of portlets, and it makes the most common operations easier. mvcportlet project uses separate jsps for each portlet mode for example, url is for edit mode and url is for help mode before diving in to the liferay mvc swimming pool with all the other cool kids applications, review how each layer of the moody vase conscription pattern helps you separate the concerns of your application in mvc, there are three layers, and you can probably guess what they are model the model layer holds the application data and logic for manipulating view the view layer contains logic for displaying data controller the middle man in the mvc pattern, the controller contains logic for passing the data back and forth between the view and the model layers the middle verse completer pattern fits well with liferay's application modularity effort liferay's applications are divided into multiple discrete modules. builder, the model layer is generated into a service and an api module. accounts for the model in the mvc pattern. the view and the controller share a generating the skeleton for a multi-module service builder driven mvc application using liferay blade cli saves you lots of time and gets you started on the more important and interesting, if we're being honest in a larger application, your -portlet class can become monstrous and unwieldy if it holds all of the controller logic. liferay provides mvc command classes to there must be some confusing configuration files to keep everything wired together and working properly, right? wrong it's all easily managed in the osgi component in the -portlet class whether or not you plan to split up the controller into mvc command classes, you use a portlet component class with a certain set of properties. simple portlet component as an example when using mvc commands, the url property is important. property is one of two that must be included in each mvc command component; it links a particular portlet urlcommand combination to the correct portlet liferay dxp uses the name to create the portlet's id there can be some confusion over exactly what kind of url implementation you're publishing with this component. expects this to be url.portlet, so make sure that's the class you import, and not, for example, url.portlet note to find a list of all the liferay-specific attributes you can specify as properties in your portlet components, check out the consider the element from the above link as an example. specify that property in your component, use this syntax in your property list the properties namespaced with url.... are elements of the with all for this focus on mvc commands, you might be concerned that you'll be forced into a more complex pattern than is necessary, especially if you're developing only a small liferay mvc application. logic into the -portlet class if you don't want to split up your mvc commands in simpler applications, if you don't have an mvc command to rely on, your portlet render urls specify the path to the jsp in an mvcpath parameter as you've seen, liferay's medical vortex concentrator mvc portlet framework gives you a well-structured controller layer that takes very little time to with all your free time, you could";;
state properties have these configuration options setter normalizes the state key's value. the setter function receives the new value that was set and return the value that should be stored validator validates the state key's value. value the state key's default value. alternatively, you can set the default value with the valuefn property. setting this to an object causes all class instances to use the same reference to the object. instance use a different reference for objects, use the valuefn option instead. note that the portlet template parameter's value if applicable has valuefn a function that returns the state key's default value. alternatively, you can set the default value with the value property. that the portlet template parameter's value if applicable has priority writeonce whether the state key is read-only, meaning the initial value is now you know the state object's architecture and how to configure it! configuring soy portlet template parameters on the client side;;
metaljs's component class, which your extends, extends metaljs's state class. the state class provides a state object that contains state properties, as well as watches these properties for defined in your portlet classes are automatically added as properties to the the component class provides additional rendering logic, such as automatically re-rendering the component when the state class detects a change in a state property. change a state property on the client-side and automatically see that change reflected in the component's ui! this section of tutorials covers how to configure and use your soy portlet's;;
to create a soy portlet, you'll need these key components first, familiarize yourself with a soy portlet's anatomy. since a soy portlet extends an mvc portlet now that you know the basic structure of a soy portlet module, you can configure to build your initial project if you wish. instructions in this section to manually configure the module add the osgi metadata to your module's url file. in addition to the standard metadata, notice the require-capability property. this specifies that this bundle requires modules that provide the capability soy with a type of metal to work. you must include your url file to load the soy specify the javascript module dependencies in your url. you should have the following dependencies and configuration parameters this provides everything you need to create a metal component based on soy. that the version in your url should match the bundle-version in next you can specify your module's build dependencies add the dependencies shown below to your url file note these are current at the time of this writing, but may change. for the proper versions for your liferay dxp instance now that your module build is configured, you can learn how to create the soy create a soy portlet component that extends the soyportlet class. requires an implementation of the url service to run. declare this using an annotation in the portlet class which is an extension itself of url.portlet, so you've provided the the component requires some properties as well. a sample configuration is shown some of these properties may seem familiar to you, as they are the same ones used to develop an mvc portlet. you can find a list of all the liferay-specific attributes that are available for use as properties in your portlet components the url... properties are elements of the url descriptor liferay's dtd files can be found here now that you've set your soy portlet component's foundation, you can write the soy portlets extend mvc portlets, so they use the same model-view-controller your controller receives requests from the front-end, and it receives data from the back-end. it's responsible for sending that data to the right front-end view so it can be displayed to the user, and it's responsible for taking data the user entered in the front-end and passing it to for this reason, it needs a way to process requests from the front-end and respond to them appropriately, and it needs a way to determine the appropriate front-end view to pass data back to the user the render logic is where all the magic happens. note the init-param properties you set in your this directs the default rendering to view url . property tells the framework the location of your soy templates. means that the soy files are located in your project's root resources folder. that's why it's important to follow liferay dxp's standard folder structure, here's the path of a hypothetical web module's resource folder in this case, the url file is found at that's the default view of the application. when the init method is called, the initialization parameters you specify are read and used to direct rendering throughout this framework, you can render a different view soy template by setting the mvcrendercommandname parameter of the the example below uses a portlet url called navigationurl to render the view view each view, excluding the default template view, must have an implementation the mvcrendercommand implementation must declare itself as a component with the mvcrendercommand service, and it must specify the portlet's name and mvc command name using the url and url properties below is an example mvcrendercommand implementation for a the render logic provides the view layer with information to display the data in this case the mvc command name is set to navigation the soy template with namespace navigation . the mvc render command name for the portleturl navigationurl is set to view the soy template with namespace navigation , using the mvcrendercommandname attribute. navigationurl parameter is passed to the navigation soy template as the variable navigationurl, using the url method. mvcrendercommand class returns the mvc render command name as a string note that soy portlet parameters are scoped to the portlet class they're written for instance, you can have a navigationurl parameter in two different classes, each with a different value. below is an example hellosoyportlet class that also defines a navigationurl parameter the navigationurl points to the navigation soy template this time. navigationurl and releaseinfo parameters are passed to the view soy since this logic should be executed before the default render method, the method concludes by calling url now that you understand the render logic, you can learn how the view layer works your portlet also requires a view layer, and for that you'll use soy templates, which is the whole point of developing a soy portlet, isn't it? briefly covers how to get your view layer working, from including other soy templates, to creating a metaljs component for rendering your views soy templates are defined in a file with the extension.soy. the soy template's name is specified at the top of the template using for example, this template has the namespace view it can be accessed in another soy template by calling the render method on the below is an example view soy template that includes header and footer soy each view has a corresponding url file usually with the same name that imports the soy templates the view requires and registers the view as a metaljs this file is also used for any additional javascript logic your view for example, here is a url component for a url now that you understand how to configure a soy template view, you can learn how to use portlet parameters in your soy templates next as mentioned above, the url method exposes portlet parameters to once a parameter is exposed, you can access it in the soy template by defining it at the top with the name type declaration. for instance, the hello-soy-web portlet's view soy template defines the navigationurl parameter with the code below it is then used to navigate between portlet views some java theme object variables are available as well. in a soy template, use the following syntax you can also access the locale object by using locale. url template for the url portlet, which demonstrates the features covered in this section now you know how to create a soy portlet! jsf portlets with liferay faces;;

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.