+

Search Tips   |   Advanced Search

Create a syndication relationship from the command line


To set up a syndication relationship from the command line, use xmlaccess.sh and ConfigEngine.sh to configure the subscriber.

To syndicate a library containing more than 10000 items, update the maximum Java heap size used by the portal application server on the subscriber server:

  1. In the WAS admin console, navigate to the Java virtual machine settings.

      Standalone server:

      Servers > Server Types > WebSphere appservers > WebSphere_Portal > Java and Process Management > Process definition > Java Virtual Machine

      Clustered server:

      System administration > dmgr > Java and Process Management > Process Definition > Java Virtual Machine

  2. Update the value in the Maximum Heap Size field. A value of at least 1024 MB is recommended.

  3. Click OK, and then save the changes.

We can syndicate only between servers running the same version. We cannot syndicate between versions.

For example:

Ensure that you have at least as much swap space allocated on the subscriber server as you have physical memory.

First-time syndication to an existing library is not supported. If you attempt to syndicate a library to a subscriber that already has a library with the same name, an error results.

Information about a Library is only syndicated the first time syndication occurs and not on subsequent updates and rebuilds. If a library is renamed or library user access is changed, this information is not syndicated to the Subscriber.

If you change the name of a library or change user access to a library, these changes are not syndicated. The same settings on all the syndicated libraries, manually make the same changes to any subscriber libraries.

If content from one library (Library A) uses an item from another library (Library B), include both libraries in the syndicator. Including both libraries ensures that all items are syndicated successfully.

If you include only Library A in the syndicator, any items in Library that reference items in Library B are not syndicated. Syndication errors are also generated.

If we add a library to a syndicator after the initial syndication, click Update to force the new library to be syndicated immediately.

If we are creating a two-way syndication relationship, use a consistent syndication strategy.

For example, if syndicating "All items", then both syndication relationships must be syndicating "All items".


Set up a syndication relationship from the command line

  1. Ensure both the subscriber and syndicator are running and that they can access each other over a network.

  2. On the subscriber server, create a shared credential vault slot with xmlaccess.sh.

    1. Create the CreateVaultSlot.xml file using a text editor.

      This sample file uses the following values that we can change to reflect the environment:

        syndication-slot Name of the shared credential vault slot.
        wpsadmin User ID for the portal administrator.
        passw0rd Password for the portal administrator. 

      <?xml version="1.0" encoding="UTF-8"?>

<request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:noNamespaceSchemaLocation="PortalConfig_8.0.0.xsd"
            type="update" 
            create-oids="true">

    <!-- Sample for creating a new credential vault slot. This script creates a    -->
    <!-- credential vault resource and a shared slot in the Default Admin Segment   -->

    <portal action="locate">

        <credential-segment action="locate" 
                            adapter-type="default" 
                            name="DefaultAdminSegment" 
                            user-mapped="false">

            <description>Default Admin Segment</description>

            <credential-slot action="update" 
                             active="false" 
                             name="syndication-slot"
                             resource="syndication-resource" 
                             secrettype="userid-password" 
                             system="true">

                <localedata locale="en">
                    <description>used for syndicator and subscriber pair</description>
                </localedata>

                <password-secret action="create" 
                                 external-id="wpsadmin" 
                                 user="uid=wpsadmin,o=defaultWIMFileBasedRealm">passw0rd
                </password-secret>

            </credential-slot>

        </credential-segment>
    </portal>
</request>

    2. Run the xmlaccess command with the CreateVaultSlot.xml file.

        ./xmlaccess.sh -in CreateVaultSlot.xml -out slot-out.xml -url http://localhost:10039/wps/config -user wpsadmin -password passw0rd

  3. On the subscriber server, create a virtual portal on the subscriber with the create-virtual-portal task.

    This example creates a virtual portal called sample, although we can change this value to reflect the environment.

      ./ConfigEngine.sh create-virtual-portal -DPortalAdminPwd=passw0rd -DWasPassword=passw0rd -DVirtualPortalTitle=sample -DVirtualPortalContext=sample

  4. On the subscriber server, set up the syndication relationship with the run-wcm-admin-task-subscribe-now task.

    This sample command uses the following additional values that we can change to reflect the environment:

      syndicator-hostname

      The host name of the syndicator server.

      syndicator1

      This name is used for the syndicator item created on the syndicator server. Enter a name that helps identify the syndication relationship we are creating. This name must be unique and cannot be the same as an existing syndicator name.

      To reuse syndicator names of previously deleted syndication relationships on a subscriber, also delete the same relationship on the syndicator.

      subscriber1

      This name is used for the subscriber item created on the subscriber server. Enter a name that helps identify the syndication relationship we are creating. This name must be unique and cannot be the same as an existing subscriber name.

    In addition, use the following properties to identify the libraries to which we are subscribing and the type of syndication to perform. For each syndication relationship, we can specify only one type of syndication. Separate multiple libraries with commas.

      liveItems="library_name_1,library_name_2"

      Live item syndication is mostly used when syndicating to a staging or delivery server. The following items are syndicated:

      • Published
      • Expired

      Draft items, projects, and items in a project are not syndicated.

      liveProjectsItems="library_name_1,library_name_2"

      Use "Live and projects" syndication to gradually syndicate projects to a staging or delivery server, rather than waiting until all items in a project achieve a published state. The following items are syndicated:

      Draft items outside of projects are not syndicated.

      allItems="library_name_1,library_name_2"

      All item syndication is mostly used when syndicating between servers within an authoring environment. The following items are syndicated:

    Example commands: 

      ./ConfigEngine.sh run-wcm-admin-task-subscribe-now 
                  -Dsyndicator=http://syndicator-hostname:10039/wps/wcm 
                  -DvaultSlotName=syndication-slot 
                  -DsyndicatorName=syndicator1 
                  -DsubscriberName=subscriber1 
                  -DVirtualPortalContext=sample 
                  -DliveItems="Web Content,Portal Site" 
                  -DPortalAdminPwd=passw0rd 
                  -DWasPassword=passw0rd


Parent: Administer syndication
Related reference:
XML configuration reference