Promoting Portal Content

Promote a Portal Page Template, Content Object, Portlet Instance, or Portal Page

	About Fine-Grained Promotion of Portal Content
	Promote a Portal Page Template
	Promote a Portal Content Object
	Promote a Portlet Instance
	Promote a Portal Page

About Fine-Grained Promotion of Portal Content

A very incremental alternative to promoting the entire Portal Application Tree or one Permission Tree at a time is to promote a single piece of portal content. For example, you can promote a single portal page template, portal page, portal content object, or portlet instance.

CAUTION:: Certain types of portal content have dependencies.
For successful fine-grained promotion, you must carefully follow a specific sequence of steps.

Fine-grained promotion can be much more difficult than promoting the entire Portal Application Tree or a Permission Tree. This is because the content promotion tool cannot determine the associated child objects (for example, the portlets that are on a page that you are promoting). Instead, you must identify and promote each child object before you promote the parent object. For example, to promote a page, you complete the following tasks:

Identify all portlets that are associated with the page, and all SAS content for each of those portlets.
Promote the SAS Content.
Promote the portlets.
Promote the page.

Because of this complexity, fine-grained promotion is not a first-choice approach in most scenarios.

Step 1: Prepare the Source System

To prepare the source system for fine-grained promotion, follow these steps:

Perform a complete backup of the source system (including the metadata repository, the configuration directories, and the SAS Content Server).

Note: For instructions, see the SAS Intelligence Platform: System Administration Guide. Use either the SAS 9.1.3 or 9.2 version of this document, as appropriate for the version of your source system.
On the source host, create a PortalPromotion subdirectory within your equivalent of SAS-Configuration-Directory\Lev1\Web\Applications\SASPortalversion\. Copy the promotion scripts into that directory. The portal promotion scripts use the directory paths specified for the JAVA_HOME and the SAS_HOME environment variables.
- If you have SAS Information Delivery Portal 4.3, the scripts are in the configuration directory under your equivalent of \Lev1\Web\Applications\SASPortal4.3\PortalPromotion
- If you do not have SAS Information Delivery Portal 4.3, obtain the scripts by contacting SAS Technical Support.
Note: The scripts use relative paths, so it is essential that they are present in the correct location.

Set environment variables for SAS_HOME and JAVA_HOME. For example:

set SAS_HOME=C:\Program Files\SAS\SASFoundation\9.2
set JAVA_HOME=C:\Program Files\Java\jre1.5.0_15\bin

export SAS_HOME=/disk2/SAS9.2/sasinstall/SASFoundation/9.2
export JAVA_HOME=/usr/java/jdk1.5.0_07/bin/java

Step 2: Prepare the Target System

To prepare the target system for fine-grained promotion, follow these steps:

Perform a complete backup of the target system (including the metadata repository, the configuration directories, and the SAS Content Server). For instructions, see "Creating, Registering, Moving, Copying, Renaming, and Deleting SAS Metadata Repositories," in the SAS Intelligence Platform: System Administration Guide.
On the target host, create a PortalPromotion subdirectory within your equivalent of SAS-Configuration-Directory\Lev1\Web\Applications\SASPortalversion\. Copy the promotion scripts into that directory. The portal promotion scripts use the directory paths specified for the JAVA_HOME and the SAS_HOME environment variables.
- If you have SAS Information Delivery Portal 4.3, the scripts are in the configuration directory under your equivalent of \Lev1\Web\Applications\SASPortal4.3\PortalPromotion.
- If you do not have SAS Information Delivery Portal 4.3, obtain the scripts by contacting SAS Technical Support.
  
  Note: The scripts use relative paths, so it is essential that they are present in the correct location.

Set environment variables for SAS_HOME and JAVA_HOME. For example:

set SAS_HOME=C:\Program Files\SAS\SASFoundation\9.2
set JAVA_HOME=C:\Program Files\Java\jre1.5.0_15\bin

export SAS_HOME=/disk2/SAS9.2/sasinstall/SASFoundation/9.2
export JAVA_HOME=/usr/java/jdk1.5.0_07/bin/java

If the target system's version is different from the source system's version (for example, you are promoting content from a SAS 9.1.3 system to a SAS 9.2 system), install the following JAR files in the ANT_HOME/lib directory:
- bsf.jar
- BeanShell JAR files: bsh*.jar
- commons-logging.jar
You can obtain JAR files from the following locations:

On Windows: SAS_Installation_Directory \Program Files\SAS\SASVersionedJarRepository\9.2\eclipse\plugins

On UNIX: SAS_Installation_Directory/SASVersionedJarRepository/9.2/eclipse/plugins

Note: You can also obtain JAR files from http://ant.apache.org/manual/install.html. In the section on Library Dependencies, click the appropriate URL paths to download each set of JAR files.

Promote a Portal Page Template

A portal page template is a page definition that is stored in SAS metadata. Page templates are defined for groups. The process for promoting a portal page template is similar to the promotion process used for a Permissions Tree.

Step 1: Perform the Required Promotion Tasks for a Portal Page Template on the Source System

To perform the required promotion tasks for a portal page template on the source system, follow these steps:

Verify that any non-portal content (for example, SAS Reports or SAS Stored Processes) exist with the same names in the target SAS 9.2 system.
Promote any content upon which the portal page template depends.
On the source system, open the PortalPageTemplate.xml extraction file.
Edit the source copy of the PortalPageTemplate.xml file so that it points to the source metadata repository.
1. Locate the source metadata repository's ID. In SAS Management Console, you can find the ID by navigating to Environment Management Metadata Manager Active Server and selecting Foundation. The repository ID is displayed in the right panel and consists of two 8-digit numbers separated by a period (for example, A0000031.A5BQ25K2).
2. Edit the PortalPageTemplate.xml file to specify the source metadata repository's ID in the ReposId parameter.
Modify the @Name value in the Tree search parameter and save the PortalPageTemplate.xml file:
```
<Tree search="*[@Name=FinanceTemplatePage'']"
TemplateName="PortalPageTemplate"/>
```
Run the extraction command:
```
extractPortalversion.bat PortalPageTemplate.xml  -user AdminID  -password AdminPwd
```
or
```
extractPortalversion.sh  PortalPageTemplate.xml  -user AdminID  -password AdminPwd
```
Note: Choose the version of the script that matches your source. For example: extractPortal913.bat (for a SAS 9.1.3 source on Windows), or extractPortal92.sh (for a 9.2 source on UNIX). For more information, see About the Portal Promotion Tools.

The extraction script generates the following files:
- PortalPageTemplate_deployFile.xml
- PortalPageTemplate_expand.xml
- PortalPageTemplate_extract.xml
- extract.log
Open the extract.log file, and verify that the file does not contain any errors. If the other .xml files are not generated, the extract.log file explains the reason why the extraction procedure did not work.
If the SAS installation of the target host resides on a different machine or platform, copy the generated .xml files to the PortalPromotion subdirectory on the target system.

Step 2: Perform the Required Promotion Tasks for a Portal Page Template on the Target System

To perform the required promotion tasks for a portal page template on the target system, follow these steps:

Verify that any non-portal content (for example, SAS Reports or SAS Stored Processes) exist with the same names in the target SAS 9.2 system.
Promote any content upon which the portal page template depends.
On the target system, open the PortalPageTemplate.xml extraction file.
Edit the target copy of the PortalPageTemplate.xml file so that it points to the target metadata repository.
1. Locate the target metadata repository's ID. In SAS Management Console, you can find the ID by navigating to Environment Management Metadata Manager Active Server and selecting Foundation. The repository ID is displayed in the right panel and consists of two 8-digit numbers separated by a period (for example, A0000031.A5T8FYJJ).
2. Edit the PortalPageTemplate.xml file to specify the target metadata repository's ID in the ReposId parameter.
Modify the @Name value in the Tree search parameter and save the PortalPageTemplate.xml file:
```
<Tree search="*[@Name=FinancePage'']"
TemplateName="PortalPageTemplate"/>
```
If the operating system is UNIX, edit the extracted copy of the PortalPageTemplate_deployFile.xml file. Update the Deploy_Id and Deploy_Name values to reference the target metadata repository.

Here is an example:
```
<RepositoryBase Id="A0000001.A5HQ15K2"
Name="Foundation" 
Deploy_Id="A0000031.A5T8FYJJ"
Deploy_Name="Foundation"/>
```
Save the PortalPageTemplate_deployFile.xml file.
On the target system, remove any old portal content or existing portal page template object with the same name.
```
removePortal92version.bat PortalPageTemplate.xml  -user AdminID  -password AdminPwd -portalpagetemplatename NameofPortalPageTemplate
```
or
```
removePortal92version.sh PortalPageTemplate.xml  -user userID  -password AdminPwd -portalpagetemplatename NameofPortalPageTemplate
```
CAUTION:
This action is irreversible.

Note: Choose the version of the script that matches your source. For example: importPortal913.bat (for a SAS 9.1.3 source on Windows), or importPortal92.sh (for a 9.2 source on UNIX). For more information, see About the Portal Promotion Tools.

Run the appropriate import command:

importPortalversion.bat PortalContentObject.xml  -user AdminID  -password AdminPwd

importPortalversion.sh  PortalContentObject.xml  -user AdminID  -password AdminPwd

Verify that the ANT_HOME environment variable has been specified. If this environment variable has not been set, the upgrade scripts will fail.
Run the appropriate upgrade script for this content type, if the source system is not at the same version level as the target system:
```
upgradeMetadata.bat  fixDav -user AdminID  -password AdminPwd
```
or
```
upgradeMetadata.sh fixDav -user AdminID  -password AdminPwd
```

Run the following upgrade scripts if the target system has SAS Information Delivery Portal 4.3:

upgradeMetadata.bat convertIMVtoReportPortlet -user  AdminID  -password AdminPwd
upgradeMetadata.bat adjustUrls -user  AdminID  -password AdminPwd

upgradeMetadata.sh convertIMVtoReportPortlet -user  AdminID  -password AdminPwd
upgradeMetadata.sh adjustUrls -user  AdminID  -password AdminPwd

Note: Sharing content as page templates is not a best practice because each user gets a copy of the template. This causes the size of the metadata to increase over time, and it is difficult to remove or replace content that is created from templates. [cautionend]

Promote a Portal Content Object

A portal content object can be a Web application, an RSS feed, or a link that users have added to their portal pages. Portal content objects are simple forms of content that are easy to identify and promote.

When you promote a new set of portal content objects, you can inform users about the availability of these objects. These objects can be searched by name and added to user desktops. Promoting content objects that are not associated with portlets (for example, a Collection Portlet) is recommended for a user community that meets these criteria:

comfortable with the search feature
has the ability to build custom content collections with a Collection Portlet

Step 1: Perform the Required Promotion Tasks for a Portal Content Object on the Source System

To promote a portal content object (for example, a Web application, an RSS feed, or a link) from a source system, follow these steps:

Verify that the User or Group Permissions Tree associated with the portal content object already exists.
Promote any content upon which the content object depends.
On the source system, open the PortalContentObject.xml file.
Edit the source copy of the PortalContentObject.xml file so that it points to the source metadata repository.
1. Locate the source metadata repository's ID. In SAS Management Console, you can find the ID by navigating to Metadata Manager Active Server and selecting Foundation. The repository ID is displayed in the right panel and consists of two 8-digit numbers separated by a period (for example, A0000031.A5BQ25K2).
2. Edit the PortalContentObject.xml file to specify the source metadata repository's ID in the ReposId parameter. For example: <ReposId>A0000031.A5BQ25K2</ReposId>
In the PortalContentObject.xml file, modify the @Name value in the Document search parameter. Here is an example:
```
<Document search="*[@Name='CNN News']" TemplateName="PortalLink"/>
```
Run the appropriate extraction command:
```
extractPortalversion.bat PortalContentObject.xml  -user AdminID  -password AdminPwd
```
or
```
extractPortalversion.sh  PortalContentObject.xml  -user AdminID  -password AdminPwd
```
The extraction script generates the following files:
- PortalContentObject_deployFile.xml
- PortalContentObject_expand.xml
- PortalContentObject_extract.xml
- extract.log
Open the extract.log file, and verify that the file does not contain any errors. If the other .xml files are not generated, the extract.log file explains the reason why the extraction procedure did not work.
If the SAS installation of the target host resides on a different machine or platform, copy the generated .xml files to the PortalPromotion subdirectory on the target system.

Step 2: Perform the Required Promotion Tasks for a Portal Content Object on the Target System

To promote a portal content object (for example, a Web application, an RSS feed, or a link) on a target system, follow these steps:

On the target system, open the PortalContentObject.xml file.
Edit the target copy of the PortalContentObject.xml file so that it points to the target metadata repository.
1. Locate the target metadata repository's ID. In SAS Management Console, you can find the ID by navigating to Metadata Manager Active Server and selecting Foundation. The repository ID is displayed in the right panel and consists of two 8-digit numbers separated by a period (for example, A0000031.A5T8FYJJ).
2. Edit the PortalContentObject.xml file to specify the target metadata repository's ID in the ReposId parameter. For example: <ReposId>A0000001.A5T8FYJJ</ReposId>
In the PortalContentObject.xml file, modify the @Name value in the Document search parameter and save the file. Here is an example:
```
<Document search="*[@Name='CNN News']" TemplateName="PortalLink"/>
```
Edit the extracted copy of the PortalContentObject_deployFile.xml file. Update the Deploy_Id and Deploy_Name values to reference the target metadata repository.

Here is an example:
```
<RepositoryBase Id="A0000001.A5BQ25K"
Name="Foundation" 
Deploy_Id="A0000031.A5T8FYJJ"
Deploy_Name="Foundation"/>
```
Save the PortalContentObject_deployFile.xml file.

On the target system, remove any old portal content or existing portal page template object with the same name.

removePortal92.bat PortalContentObject.xml  -user AdminID  -password AdminPwd -portalcontentname NameofContenttobeDeleted

removePortal92.sh PortalContentObject.xml  -user AdminID  -password AdminPwd -portalcontentnameNameofContenttobeDeleted

CAUTION:: This action is irreversible.

Run the appropriate import command:
```
importPortalversion.bat PortalContentObject.xml  -user AdminID  -password AdminPwd
```
or
```
importPortalversion.sh  PortalContentObject.xml  -user AdminID  -password AdminPwd
```
Note: Choose the version of the script that matches your source. For example: importPortal913.bat (for a SAS 9.1.3 source on Windows), or importPortal92.sh (for a 9.2 source on UNIX). For more information, see About the Portal Promotion Tools.
Run the appropriate upgrade script for this content type, if the source system is not at the same version level as the target system:
```
upgradeMetadataversion.bat fixDav -user AdminID -password AdminPwd
```
or
```
upgradeMetadataversion.sh fixDav -user AdminID -password AdminPwd 
```
Note: In SAS 9.1.3, the DAV repository name is WebDAVDemo. In SAS 9.2, the repository name is WebDAV. When the upgrade script upgrades the metadata by using the fixDav parameter, the script applies the appropriate repository name and completes the upgrade process.

Promote a Portlet Instance

A portlet instance is a user or group's instance of a supplied portlet (for example, Linda Collection Portlet).

The same rules that apply to the promotion of portal content objects also apply to portlet instances. First, promote the portlets that belong to a page. Next, promote the page that contains these portlets. A different strategy is to promote the portlet instances individually. Then, inform the users about the availability of these items that can be searched and added to new or existing pages.

Step 1: Perform the Required Tasks to Promote a Portlet Instance on the Source System

To promote a portlet instance on the source system, follow these steps:

First, promote any content upon which the portlet instance depends.
Edit the source copy of the PortletInstance.xml file so that it points to the source metadata repository.
1. Locate the source metadata repository's ID. In SAS Management Console, you can find the ID by navigating to Metadata Manager Active Server and selecting Foundation. The repository ID is displayed in the right panel and consists of two 8-digit numbers separated by a period (for example, A0000031.A5BQ25K2).
2. Edit the PortletInstance.xml file to specify the source metadata repository's ID in the ReposId parameter. For example: <ReposId>A0000031.A5BQ25K2</ReposId>
In the source copy of the extraction template, modify the @Name value (for example, Linda Collection Portlet) in the PSPortlet search parameter.

Here is an example:
```
<PSPortlet search="*[@Name='Linda  Collection Portlet'][Trees/Tree
[@Name='SASAdministrators Permissions Tree']]"TemplateName="PortletInstance"/>
```
Run the appropriate extraction command:
```
extractPortalversion.bat PortletInstance.xml  -user AdminID  -password AdminPwd
```
or
```
extractPortalversion.sh  PortletInstance.xml  -user AdminID  -password AdminPwd
```
Note: Choose the version of the script that matches your source. For example: extractPortal913.bat (for a SAS 9.1.3 source on Windows), or extractPortal92.sh (for a 9.2 source on UNIX). For more information, see About the Portal Promotion Tools.

The extraction script generates the following files:
- PortletInstance_deployFile.xml
- PortletInstance_expand.xml
- PortletInstance_extract.xml
- extract.log
Open the extract.log file, and verify that the file does not contain any errors. If the other .xml files are not generated, the extract.log file explains the reason why the extraction procedure did not work.
If the SAS installation of the target host resides on a different machine or platform, copy the generated .xml files to the PortalPromotion subdirectory on the target SAS 9.2 system.

Step 2: Perform the Required Tasks to Promote a Portlet Instance on the Target System

To promote a portlet instance, follow these steps:

Edit the target copy of the PortletInstance.xml file so that it points to the target metadata repository.
1. Locate the target metadata repository's ID. In SAS Management Console, you can find the ID by navigating to Metadata Manager Active Server and selecting Foundation. The repository ID is displayed in the right panel and consists of two 8-digit numbers separated by a period (for example, A0000031.A5T8FYJJ).
2. Edit the PortletInstance.xml file to specify the target metadata repository's ID in the ReposId parameter. For example: <ReposId>A0000001.A5T8FYJJ</ReposId>

In the target copy of the extraction template, modify the @Name value in the PSPortlet search parameter.

Here is an example:

<PSPortlet search="*[@Name='SAS Collection Portlet'][Trees/Tree
[@Name='SASAdministrators Permissions Tree']]"TemplateName="PortletInstance"/>

Modify the extracted copy of the PortletInstance_deployFile.xml file. Update the Deploy_Id and Deploy_Name values to reference the target metadata repository. Here is an example:
```
<RepositoryBase Id="A0000031.A5BQ25K2"
Name="Foundation" 
Deploy_Id="A0000001.A5T8FYJJ"
Deploy_Name="Foundation"/>
```

On the target system, remove any old portal content or existing portlet instances with the same names.

removePortal92.bat PortletInstance.xml  -user AdminID  -password AdminPwd -portalcontentname NameofPortletInstancetobeDeleted

removePortal92.sh PortletInstance.xml  -user AdminID  -password AdminPwd -portalcontentname NameofPortletInstancetobeDeleted

CAUTION:: This action is irreversible.

Run the appropriate import command:
```
importPortalversion.bat PortletInstance.xml  -user AdminID  -password AdminPwd
```
or
```
importPortalversion.sh  PortletInstance.xml  -user AdminID  -password AdminPwd
```
Note: Choose the version of the script that matches your source. For example: importPortal913.bat (for a SAS 9.1.3 source on Windows), or importPortal92.sh (for a 9.2 source on UNIX). For more information, see About the Portal Promotion Tools.

Run the following upgrade script for this content type if the source is not at the same version level as the target system:

upgradeMetadata.bat fixDav -user AdminID  -password AdminPwd

upgradeMetadata.sh fixDav -user AdminID  -password AdminPwd

Run the following upgrade scripts if the target system has SAS Information Delivery Portal 4.3:

upgradeMetadata.bat convertIMVtoReportPortlet -user  AdminID  -password AdminPwd
upgradeMetadata.bat adjustUrls -user  AdminID  -password AdminPwd

upgradeMetadata.sh convertIMVtoReportPortlet -user  AdminID  -password AdminPwd
upgradeMetadata.sh adjustUrls -user  AdminID  -password AdminPwd

Promote a Portal Page

A portal page is an individual Web page in the portal that contains portlets. These portlets can contain portal content objects. In the default view, a user might have a single home page, and each new page added by the user displays in a new tab.

Before promoting a portal page, all dependent objects and portlets must be promoted first. To promote a page and its contents, you are required to perform an inventory of all content in the page and promote that content. Then, you can promote the portal page.

CAUTION:: This task can be arduous and prone to errors.
It is easier to promote a portal page as part of a Group Permissions Tree because the content promotion tool can identify the page contents that are shared with the Group Permissions Tree.

The following figure illustrates the individual portal promotion tasks that should be completed to promote a portal page from a source to a target system.

[untitled graphic]

Step 1: Perform the Required Tasks to Promote a Portal Page on the Source System

To promote a portal page on the source system, follow these steps:

First, promote any content upon which the page depends.
On the source system, open the PortalPage.xml extraction template.
Edit the source copy of the PortalPage.xml file so that it points to the source metadata repository.
1. Locate the source metadata repository's ID. To find the metadata repository ID, go to SAS Management Console and navigate to Metadata Manager Active Server and selecting Foundation. The repository ID is displayed in the right panel and consists of two 8-digit numbers separated by a period (for example, A0000031.A5BQ25K2).
2. Edit the PortalPage.xml file to specify the source metadata repository's ID in the ReposId parameter. For example: <ReposId>A0000031.A5BQ25K2</ReposId>
In the source copy of the PortalPage.xml extraction template, modify the @Name value in the PSPortalPage search parameter. Here is an example:
```
<PSPortalPage search="*[@Name='Finance Page']"
TemplateName="PortalPage"/>
```
Save the PortalPage.xml file.
Run the extraction command:
```
extractPortalversion.bat PortalPage.xml  -user AdminID  -password AdminPwd
```
or
```
extractPortalversion.sh  PortalPage.xml  -user AdminID  -password AdminPwd
```
Note: Choose the version of the script that matches your source. For example: extractPortal913.bat (for a SAS 9.1.3 source on Windows), or extractPortal92.sh (for a 9.2 source on UNIX). For more information, see About the Portal Promotion Tools.
The extraction script generates the following files:
- PortalPage_deployFile.xml
- PortalPage_expand.xml
- PortalPage_extract.xml
- extract.log
Open the extract.log file, and verify that the file does not contain any errors. If the other .xml files are not generated, the extract.log file explains the reason why the extraction procedure did not work.
If the SAS installation of the target host resides on a different machine or platform, copy the generated .xml files to the PortalPromotion subdirectory on the target system.

Step 2: Perform the Required Tasks to Promote a Portal Page on the Target System

To promote a portal page on the target system, follow these steps:

Edit the target copy of the PortalPage.xml file so that it points to the target metadata repository.
1. Locate the target metadata repository's ID. To find the metadata repository ID, go to SAS Management Console and navigate to Metadata Manager Active Server and selecting Foundation. The repository ID is displayed in the right panel and consists of two 8-digit numbers separated by a period (for example, A0000001.A5T8FYJJ).
2. Edit the PortalPage.xml file to specify the target metadata repository's ID in the ReposId parameter. For example: <ReposId>A0000001.A5T8FYJJ</ReposId>
In the target copy of the PortalPage.xml extraction template, modify the @Name value for the PSPortalPage search parameter.

Here is an example:
```
<PSPortalPage search="*[@Name='Finance Page']"
TemplateName="PortalPage"/>
```
Open the extracted copy of PortalPage_deployFile.xml file.
In the PortalPage_deployFile.xml file, update the values for the Deploy_Id and Deploy_Name parameters to reference the target metadata repository. Here is an example:
```
<RepositoryBase Id="A0000031.A5BQ25K2"
Name="Foundation" 
Deploy_Id="A0000001.A5T8FYJJ"
Deploy_Name="Foundation"/>
```

On the target system, remove any old portal content or existing portlet instances with the same names.

removePortal92.bat PortalPage.xml  -user AdminID  -password AdminPwd -portalcontentname NameofPortalPagetobeDeleted

removePortal92.sh PortalPage.xml  -user AdminID  -password AdminPwd -portalcontentname NameofPortalPagetobeDeleted

CAUTION:: This action is irreversible.

Run the appropriate import command:

importPortalversion.bat PortalPage.xml  -user AdminID  -password AdminPwd

importPortalversion.sh  PortalPage.xml  -user AdminID  -password AdminPwd

Run the appropriate upgrade script for this content type if the source is not at the same version level as the target system:

upgradeMetadataversion.bat fixDav -user AdminID -password AdminPwd

upgradeMetadataversion.sh fixDav -user AdminID -password AdminPwd

To verify that the page content was recreated, log on to the portal, select Add New Page, and search for the new page that was promoted. Share the promoted page with the group.

Top of Page