Use below script to update portal-ext property. Change property name which you want to update
import com.liferay.portal.util.PropsUtil;
String google = PropsUtil.get("metatag.google.site.verification");
out.println("google: - "+google);
PropsUtil.set("metatag.google.site.verification","abcdpqrsxyz");
google = PropsUtil.get("metatag.google.site.verification");
out.println("google: - "+google);
Remove specific publication process from Staging:
· Fetch backgroundtaskId from database from backgroundtask table specific to publication process.
Select * from backgroundtask where status =1;
· Run groovy Script provided by Liferay Support team which will remove the background task entry( Stuck In progress) from database .
import com.liferay.portal.background.task.service.BackgroundTaskLocalServiceUtil;
BackgroundTaskLocalServiceUtil.deleteBackgroundTask(<backgroundTaskId>);
Groovy Script:
import java.util.List;
import com.liferay.portal.background.task.model.BackgroundTask;
import com.liferay.portal.background.task.service.BackgroundTaskLocalServiceUtil;
List<BackgroundTask> btasks=BackgroundTaskLocalServiceUtil.getBackgroundTasks(328022L,1);
for(BackgroundTask btask : btasks){
if(btask != null) {
out.println(btask.getBackgroundTaskId());
out.println(btask.getName());
//BackgroundTaskLocalServiceUtil.deleteBackgroundTask(btask.getBackgroundTaskId());
}
}
Create UserGroup:
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.service.UserGroupLocalServiceUtil;
import com.liferay.portal.kernel.service.UserLocalServiceUtil;
import com.liferay.portal.kernel.util.PortalUtil;
long companyId = PortalUtil.getDefaultCompanyId();
User user = UserLocalServiceUtil.getUserByEmailAddress(companyId, "test@liferay.com");
//User user = UserLocalServiceUtil.getUser(20105);
String[] userGroupNames = new String[3];
userGroupNames[0] = "test_content_editor";
userGroupNames[1] = "test_content_reviewer";
userGroupNames[2] = "test_documentUploader";
for(String userGroupName : userGroupNames){
try {
UserGroupLocalServiceUtil.addUserGroup(user.getUserId(),user.getCompanyId(),userGroupName,"Description for :" + userGroupName,null);
out.println(userGroupName + " UserGroup created successfully.");
} catch (Exception e) {
out.println("Error:" + e.getMessage());
}
}
Create Role:
import java.util.Locale;
import java.util.Map;
import com.liferay.portal.kernel.model.Role;
import com.liferay.portal.kernel.model.RoleConstants;
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.service.RoleLocalServiceUtil;
import com.liferay.portal.kernel.service.UserGroupLocalServiceUtil;
import com.liferay.portal.kernel.service.UserLocalServiceUtil;
import com.liferay.portal.kernel.util.PortalUtil;
import com.liferay.portal.kernel.model.UserGroup;
try {
long companyId = PortalUtil.getDefaultCompanyId();
User user = UserLocalServiceUtil.getUserByEmailAddress(companyId, "test@liferay.com");
List< UserGroup> userGroups = UserGroupLocalServiceUtil.getUserGroups(companyId);
for (UserGroup userGroup : userGroups) {
String userGroupName = userGroup.getName();
Map<Locale, String> titleMap = null;
Map<Locale, String> descMap = null;
titleMap = new HashMap<Locale, String>();
titleMap.put(Locale.getDefault(),userGroupName );
descMap = new HashMap<Locale, String>();
descMap.put(Locale.getDefault(),"Description for: " + userGroupName );
// adding the role
Role role = RoleLocalServiceUtil.addRole(user.getUserId(),null,0,userGroupName ,titleMap, descMap,RoleConstants.TYPE_REGULAR,null,null); out.println(role + "... role created successfully.");
// assigning the UserGroup to the role
GroupLocalServiceUtil.addRoleGroups(role.getRoleId(), [userGroup.getGroupId()] as long[]);
}
} catch (Exception e) {
out.println("Error:" + e.getMessage());
}
Create User:
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.model.UserGroup;
import com.liferay.portal.kernel.service.UserGroupLocalServiceUtil;
import com.liferay.portal.kernel.service.UserLocalServiceUtil;
import com.liferay.portal.kernel.util.PortalUtil;
import java.util.List;
try {
long companyId = PortalUtil.getDefaultCompanyId();
User user = UserLocalServiceUtil.getUserByEmailAddress(companyId, "test@liferay.com");
List<UserGroup> userGroups = UserGroupLocalServiceUtil.getUserGroups(companyId);
for (UserGroup userGroup : userGroups) {
String userGroupName = userGroup.getName();
UserLocalServiceUtil.addUser(Long.valueOf(user.getUserId()), Long.valueOf(companyId), Boolean.valueOf(false),
"password", "password", Boolean.valueOf(true), userGroupName+"_user",
userGroupName+"_user@liferay.com", 0, null, Locale.UK,
userGroupName+"_user", "", userGroupName, 123, 345, true, 00, 01, 1970,
"developer", null, null, null, [userGroup.getUserGroupId()] as long[], false, null);
out.println("user created");
}
} catch (Exception e) {
out.println(e.getMessage());
out.println(e.printStackTrace());
}
Use below script to delete site specific documents.
import com.liferay.document.library.kernel.service.DLAppServiceUtil;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.repository.model.FileEntry;
import com.liferay.document.library.kernel.service.DLFileEntryLocalServiceUtil;
import java.util.List;
import java.util.Calendar;
import java.util.Date;
List<FileEntry> fileEntries = DLAppServiceUtil.getGroupFileEntries(106502, 20130, 0, 2);
for(FileEntry fileEntry : fileEntries) {
out.println("UserId:"+fileEntry.getUserId()+ " GroupId:"+fileEntry.getGroupId()+" FileEntryId:"+fileEntry.getFileEntryId()+" FileName:"+fileEntry.getFileName() + " FolderId:" + fileEntry.getFolderId()+ " CreateDate:" +fileEntry.getCreateDate());
Date date = fileEntry.getCreateDate();
Calendar today = Calendar.getInstance();
Calendar specifiedDate = Calendar.getInstance();
specifiedDate.setTime(date);
if(today.get(Calendar.DAY_OF_MONTH) == specifiedDate.get(Calendar.DAY_OF_MONTH)
&& today.get(Calendar.MONTH) == specifiedDate.get(Calendar.MONTH)
&& today.get(Calendar.YEAR) == specifiedDate.get(Calendar.YEAR)) {
DLFileEntryLocalServiceUtil.deleteDLFileEntry(fileEntry.getFileEntryId());
out.println("Date specified [" + specifiedDate + "] is today [" + today + "]");
}
out.println("---------------------------");
}
Use below groovy script to find the master node.
import com.liferay.portal.kernel.cluster.*;
out.println("** Master: "+ ClusterMasterExecutorUtil.isMaster());
Create project in Liferay Developer Studio:
Right click on project workspace -> New -> Liferay Module Project -> Select Project Template Name as "template-context-contributor"
package com.test.context.contributor;
import com.liferay.portal.kernel.template.TemplateContextContributor;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
@Component(
immediate = true,
property = {"type=" + TemplateContextContributor.TYPE_THEME},
service = TestTemplateContextContributor.class
)
public class TestTemplateContextContributor
implements TemplateContextContributor {
@Override
public void prepare(
Map<String, Object> contextObjects, HttpServletRequest request) {
contextObjects.put("testVar", "Liferay");
contextObjects.put("navItemHelper", navItemHelper);
}
@Reference(unbind="-")
NavItemHelper navItemHelper;
}
Note: Use public methods of NavItemHelper class by annotate with @Reference and NavItemHelper class must be a component. We can access public methods through navItemHelper variable from context in theme ftl.
/**
*
*/
package com.test.context.contributor;
import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.theme.NavItem;
import com.liferay.portal.kernel.theme.ThemeDisplay;
import com.liferay.portal.kernel.util.WebKeys;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.osgi.service.component.annotations.Component;
@Component(
immediate = true,
service = NavItemHelper.class
)
public class NavItemHelper {
public List<NavItem> fromLayouts(
HttpServletRequest request, List<Layout> layouts,
Map<String, Object> contextObjects) {
if ((layouts == null) || layouts.isEmpty()) {
return Collections.emptyList();
}
ThemeDisplay themeDisplay = (ThemeDisplay)request.getAttribute(
WebKeys.THEME_DISPLAY);
List<NavItem> navItems = new ArrayList<>(layouts.size());
for (Layout layout : layouts) {
navItems.add(
new NavItem(request, themeDisplay, layout, contextObjects));
}
return navItems;
}
}
Usage: In theme navigation.ftl use below code to retrieve public pages through context contributor variable i.e., navItemHelper.fromLayouts(request,publicPages, null)
<#assign
layoutlocalService = serviceLocator.findService("com.liferay.portal.kernel.service.LayoutLocalService")
publicPages = layoutlocalService.getLayouts(themeDisplay.getScopeGroupId(),false,0)
navItemClass = staticUtil["com.liferay.portal.kernel.theme.NavItem"]
public_nav_items = navItemHelper.fromLayouts(request,publicPages, null)
/>
<#list public_nav_items as nav_item>
<#assign
nav_item_attr_has_popup = ""
nav_item_attr_selected = ""
nav_item_css_class = ""
nav_item_layout = nav_item.getLayout()
/>
</#list>
Step 1. Prepare
for migration
Before migrating
the existing portal to 7.3 it’s recommended to remove unnecessary files and
objects
· Remove unused
objects
It’s good
practice to find not required objects that can be deleted by examining the
tables that were large or contained lots of records. Below listed down some of
the common entities to find unneeded objects.
o Sites: Remove unused sites
and its content
o Instances: Remove instance
which is no longer needed. Since they consume highest object in the hierarchy,
removing it can optimize upgradation process.
o Web Content: Liferay generates
a new version whenever we are updating any web content. You can delete all
older versions of web content.
o Users: Remove all
inactive users and its related data to optimize the process.
o Layouts: Remove
unnecessary layouts.
·
Remove duplicated
structure names
For LR 6.2 you
can have different web content structures in your portal, they are likely to
have fields with the same names. But DXP requires unique field names of fields
for structures. Therefore, we need to rename structure to have a unique field
name.After removing unused objects from your portal, make sure to test those in
your older environment. In that case, you can more easily find out any issues,
knowing that they’re not related to upgrade processes.
Step 2: Liferay
Database migration
· In this step, we
will migrate our database from LR 7.0 to LR 7.3. After removing unused objects
now our portal is ready to migrate DB from 7.0 to 7.3/DXP.
· Liferay provides
a database upgrade tool that will migrate our database.
· Before migrating
existing DB to LR DXP make sure that you have a backup of it.
Follow below
steps :-
1. Create a new
database for Liferay 7.3/DXP in Oracle server
e.g. create
database Liferay_dxp_db character set utf8
2. Take backup and
restore
Take dump from
liferay 7.0 database and restore that dump into a new liferay 7.3/DXP database
Connect to
database
3. Copy data
Copy
document_library (You can find from [Liferay Home]/data/) folder from Liferay 7.0
to Liferay 7.3/DXP, copy images folders into data folder also. This data will
be stored in the default store and you can also choose your location, it's up
to your choice.
4. Configure Your
Documents and Media File Store
If the document_library_path
is configured in different location then
a) Create a file with the name
com.liferay.portal.store.file.system.configuration.FileSystemStoreConfiguration.config under [Liferay_HOME]/osgi/configs
folder
b) configure the
same path to “rootDir” property in Simple File Store:
rootDir="C:/dev/project/Liferay_7_3_dev/data/document_library"
5. Disable indexer
and autoUpgrade
Now, we need to
disable indexing since we are going to start the database upgrade process for
our new environment. Using this we can disable reindexing content and
performance issues to be arised. For this, we have to follow below steps:-
· Need to create
file in liferay 7.3 DXP :
"com.liferay.portal.search.configuration.IndexStatusManagerConfiguration.config"
on this location [Liferay Home]/osgi/configs and add below content
indexReadOnly="true"
· Then create
another file in the same folder :
"com.liferay.portal.upgrade.internal.configuration.ReleaseManagerConfiguration.config"
and add below content
autoUpgrade="false"
6. Configure the
upgrade tool
Liferay 7.x
provides a dedicated tool for database upgrade 'portal-tools-db-upgrade-client'
in [Liferay Home]/tools folder
·
Tuning Database upgrade process:
Make sure to provide adequate memory for the database upgrade
tool’s Java process. Also make sure to set the file encoding to UTF-8 and the
time zone to GMT. Here are the Java process settings:
Open db_upgrade.bat file
and edit this line:
java -jar
com.liferay.portal.tools.db.upgrade.client.jar
-j “ -Dfile.encoding=UTF-8
-Duser.timezone=GMT -Xmx8000m”
Now, we need to
configure below files before running the upgrade in [Liferay Home]/tools
folder:
·
app-server.properties
dir=../../tomcat-9.0.40
extra.lib.dirs=/bin
global.lib.dir=/lib
portal.dir=/webapps/ROOT
server.detector.server.id=tomcat
· portal-upgrade-database.properties(mention
database name of them dump taken )
jdbc.default.driverClassName=oracle.jdbc.OracleDriver
jdbc.default.url=jdbc:oracle:thin:@host:1521:db
jdbc.default.username=XXXXXX
jdbc.default.password=xxxxxx
· portal-upgrade-ext.properties
liferay.home=../../
module.framework.base.dir=../../osgi
hibernate.jdbc.batch_size=0
json.deserialization.whitelist.class.names=\
com.liferay.portal.kernel.service.permission.ModelPermissions,\
com.liferay.portal.kernel.internal.service.permission.ModelPermissionsImpl,\
com.liferay.portal.kernel.service.ServiceContext,\
sun.util.calendar.ZoneInfo
dl.store.impl=com.liferay.portal.store.file.system.FileSystemStore(optional)
7. Verify
buildNumber
We have to check a release buildNumber from DB
before running the upgrade tool, it will be incremented after each deployment
in Service Builder which is used for generating internal database persistence
code.
Using this query you can
find current buildNumber as 7010:
select buildnumber from Release_ where servletcontextname = 'portal';
Make sure below
steps before running the db_upgrade.bat file,
·
Place ojdbc6.jar in /lib/ext folder and stop the any
running liferay server
·
Since we are using an Oracle database, it is highly
recommend putting this property hibernate.jdbc.batch_size=0 in portal-upgrade-ext.properties. This prevents
issues when copying or writing CLOBs or other large data during the upgrade.
·
Verify if the database user has full read and write
permissions to the Liferay 7.0 database
·
Verify if gogo shell is already running or not? If
running kill the task with process id.
C:\Users\VKOTESW>netstat -ano | findstr :9201
C:\Users\VKOTESW>taskkill /PID 10180 /F
·
Whenever an upgrade fails, it is best practice to
restore the database back to it's pre-upgraded state. This is because if an
upgrade fails, there is a very high chance of corrupted data; and re-running
the upgrade without restoring it may not fix that.
·
Run upgrade tool
using below command (Path [Liferay Home]/tools/portal-tools-db-upgrade-client
folder) :
For window
Double click on “db_upgrade.bat”
file
The upgrade
failed due to a missing database index
com.liferay.dynamic.data.mapping.internal.upgrade.v3_1_0.UpgradeDDMStructureLayout:
This would
indicate that the upgrade is trying to drop IX_B7158C0A, but it does not exist.
Creating the IX_B7158C0A index will likely resolve this error and allow the
com.liferay.dynamic.data.mapping.service to succeed.
Execute below
script on Liferay 7.0 database fresh dump and run the db_upgrade.bat again
create unique
index IX_B7158C0A on DDMStructureLayout (structureVersionId);
One possible way
to have the portal create it in the database would be to set database.indexes.update.on.startup=true
in the portal-ext.properties file of your Liferay 7.0, start up the bundle and shut
it down again once fully started. Then use a copy of this 7.0 database once it
is confirmed that IX_B7158C0A exists for another upgrade attempt to 7.3.
· NOTE: Whenever an
upgrade fails, it is best practice to restore the database back to it's
pre-upgraded state. This is because if an upgrade fails, there is a very high
chance of corrupted data; and re-running the upgrade without restoring it may
not fix that.
·
Even if the
schema version states 7310, if an error like this occurred, then the upgrade
will not be considered successful and the upgrade will need to be done again.
Your upgrade if failed it
will open gogo shell execute below command to complete upgrade all remaining upgrade:
>upgrade:executeAll
After upgrade
again check build number it should be 7310
8. Enabling indexer
Now, The last and
most important step is remaining which can only be taken post-upgrade and to
enable indexer. For this, you have to modify the file "com.liferay.portal.search.configuration.IndexStatusManagerConfiguration.config"
in the folder [Liferay Home]/osgi/configs with the following content
indexReadOnly="false"
Liferay Core is
been upgraded now you can start your
portal and check !!
COMMON ERRORS:
Though the
property database.indexes.update.on.startup=true exist in the
portal-ext.properties file some times indexs will not create. So we created the
index manually with the name IX_B7158C0A on DDMStructureLayout in database and
ran the upgrade on failed database only. Still we see some issue in the upgrade
log for the below module,
2021-07-15
08:06:57.472 INFO [main][UpgradeProcess:115] Failed upgrade process
com.liferay.journal.internal.upgrade.v1_1_0.UpgradeJournalArticleLocalizedValues
in 7 ms
(1213)[com.liferay.portal.upgrade.internal.release.ReleaseManagerImpl(3102)]
: The activate method has thrown an exception
com.liferay.portal.kernel.upgrade.UpgradeException:
java.lang.IllegalStateException: JournalArticle must have title and description
columns
it is being
thrown from this code https://github.com/liferay/liferay-portal/blob/7.3.x/modules/apps/journal/journal-service/src/main/java/com/liferay/journal/internal/upgrade/v1_1_0/UpgradeJournalArticleLocalizedValues.java#L67 . This would
suggest that the Upgrade Tool is unable to access the title and description
columns from the JournalArticleLocalization table. JournalArticleLocalization
is created in Liferay 7.1, and should have been created during the upgrade
process since you're coming from 7.0.
Solution: Restored the database back to it's pre-upgraded state and start the upgrade with
fresh setup.
Note: Whenever an upgrade
fails, it is best practice to restore the database back to it's pre-upgraded
state. This is because if an upgrade fails, there is a very high chance of
corrupted data; and re-running the upgrade without restoring it may not fix
that. Before you run the next upgrade attempt, please restore it back to 7.0.
Make sure to create IX_B7158C0A as noted in the Github link.
2021-07-29 06:46:08.798
WARN
[main][LiferayJSONDeserializationWhitelist:50] Unable to deserialize
sun.util.calendar.ZoneInfo due to security restrictions
2021-07-29 06:01:52.628
WARN
[main][LiferayJSONDeserializationWhitelist:50] Unable to deserialize
com.liferay.portal.kernel.service.permission.ModelPermissions due to security
restrictions
Solution: If we get above
WARN messages then add the below property in portal-upgrade-ext.properties and
start upgrade again
json.deserialization.whitelist.class.names=\
com.liferay.portal.kernel.service.permission.ModelPermissions,\
com.liferay.portal.kernel.internal.service.permission.ModelPermissionsImpl,\
com.liferay.portal.kernel.service.ServiceContext,\
sun.util.calendar.ZoneInfo
