Follow the instructions below to create the SEO plugin extension and configure your application module to use it and the parent SEO plugin.
Copy the SEO-related repository definition file and database SQL scripts to your application module:
Copy the
SEORepository.xmlfile located inCommerceAccelerator/Applications/B2CStore/src/main/config/atg/seoto this location:CommerceAccelerator/Applications/application-name/src/main/config/atg/seoCopy the
csa_seo_ddl.sqlfile for your database type. This file is located inCommerceAccelerator/Applications/B2CStore/src/main/sql/db_components/database-type, wheredatabase-typeis eitherdb2,mssql,mysqlororacledepending on which database you are using.Paste the
csa_seo_ddl.sqlfile in this location:CommerceAccelerator/Applications/application-name/src/main/sql/db_components/database-typeCopy the
drop_csa_seo_ddl.sqlfile for your database type. This file is located inCommerceAccelerator/Applications/B2CStore/src/main/sql/uninstall/database-type, wheredatabase-typeis eitherdb2,mssql,mysqlororacledepending on which database you are using.Paste the
csa_seo_ddl.sqlfile in this location:CommerceAccelerator/Applications/application-name/src/main/sql/uninstall/database-type
Create a directory for the SEO plugin extension called
CommerceAccelerator/Applications/application-name/Plugins/SEO/META-INFand populate it with aMANIFEST.MFfile that has the following content:Manifest-Version: 1.0
ATG-Class-Path: lib/SEO.jar
ATG-Config-Path: src/main/config
ATG-Required: CommerceAccelerator.Applications.NewStore.Base
CommerceAccelerator.Plugins.SEOTo make the SEO plugin extension module start up with the rest of the application module, update the
CommerceAccelerator/Applications/application-name/META-INF/MANIFEST.mffile to addCommerceAccelerator.Applications.application-name.Pluginsto theATG-Requiredproperty. If, when adding this module name to theATG-Requiredproperty, the line exceeds a length of 72 characters ensure that all text after the 72nd character is wrapped onto the next line and the next line starts with a space.
Note: This step may already have been done for other plugins that were included in the application module.
Create a
build.gradlefile inCommerceAccelerator/Applications/application-name/Plugins/SEOwith the following content:project(":Applications:application-name:Plugins:SEO") {
defaultTasks "all";
description = "Contains cartridges, configuration and code
for the new feature."
dependencies {
compile project(":Plugins:SEO"),
project(":Base")
}
}Create a
StoreConfigurationcomponent, using an identifying name such asStoreUSConfiguration.properties, inCommerceAccelerator/Applications/application-name/Plugins/SEO/src/main/config/atg/endeca/sitemapwith the following content:$description=Store configuration for generating site links.
$basedOn=StoreConfiguration
siteId=site-idEach
StoreConfigurationcomponent provides the site ID for a store that should be included in the generated sitemap.Create a
SiteLinksGenerator.propertiesfile inCommerceAccelerator/Applications/application-name/Plugins/SEO/src/main/config/atg/endeca/sitemapwith the following content:$description=Extending the SiteLinksGenerator to add the storeSites
property.
# Sites for whick links has to be generated.
storeSites=/atg/endeca/sitemap/store-configuration-component-nameThis configuration maps the component you created in the previous step to the
storeSitesproperty in theSiteLinkGeneratorcomponent.Create a
PhantomjsRenderer.propertiesfile inCommerceAccelerator/Applications/application-name/Plugins/SEO/src/main/config/atg/repository/seowith the following content:# Phantomjs executable path.
phantomExecutablePath=path-to-phantomjsReplace the
path-to-phantomjsvariable with the path to your PhantomJS executable, for example,C:/phantomjs-2.0.0-windows/bin/phantomjs.exe.Edit the
CommerceAccelerator/Applications/application-name/gradle.propertiesfile to add the SEO plugin extension to theincludedPluginsproperty.includedPlugins=\
CommerceAccelerator.Applications.application-name.Plugins.SEOAdd the SEO plugin extension to the build by updating the
CommerceAccelerator/settings.gradlefile to add the following reference at the end of the array:"Applications:application-name:Plugins:SEO"Be sure that all entries in the array end with a comma except for the last one.
If necessary, stop the production server instance.
In a UNIX shell or command prompt, change directories to the
CommerceAcceleratordirectory.Run the following command to execute the build:
gradleRe-assemble and re-deploy the EAR file. You can do this using CIM by repeating the process for step [4] Application Assembly & Deployment in the CIM main menu.
