Product versions: Business Objects Enteprise XI 3.1

This article is provided by the IPNW RIG team, with the main contributors : Patrice Le Bihan, David Gonzalez. Don't hesitate to provide feedback in the comments section.

Table of Contents

This article is part of a series on Federation XI 3.1 :

Federation in BOE XI 3.1
How does Federation XI 3.1 work ?
Error diagnosis and troubleshooting with Federation XI 3.1
Federation typical workflows
- About adding, renaming, moving or deleting objects on Origin
- Adding, Renaming, Moving or Deleting objects on destination
- About Replication Filters in Federation
Tuning Federation XI 3.1 for performance and heavy load
Known issues and common problems with Federation XI 3.1

Introduction

In this article, you will find illustrated examples of typical workflows of Federation. It aims at complement the admin guide with screenshots and also clarify the expected behaviour and limitations of certain options. This will help you design or advise on a Federation implementation. These tests have been done on XI 3.1.

Workflows by functionality

Example 1 : Adding /Renaming /Moving objects on destination (1way - "Normal" - or "Refresh from origin")

You should not modify the destination with this option.

In this case you are going to replicate some objetcs (these objects can be documents, folder ....) and modify the destination only.

	Origin	Destination (Added) Option : "Normal" or "Refresh from origin"	Destination (Renamed) Option : "Normal" or "Refresh from origin"	Destination (Moved) Option : "Normal" or "Refresh from origin"
Step1	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2
Step2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	We added the FolderD and the DocC3 \|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2 \|__DocC3 \|__FolderD	We renamed the FolderB and the DocC1 \|__ FolderA \|__RenameFolderB \|__FolderC \|__RenamedDocC1 \|__DocC2	We moved the FolderC under the FolderB and the DocC1 under the FolderB. \|__ FolderA \|_FolderB \|__DocC1 \|__FolderC \|__DocC2
Step3		We ran the federation	We ran the federation	We ran the federation
Step4	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2 \|__DocC3 \|__FolderD Origin and destination are not synchronized. If you add some folders or documents in destination, the federation won't considere them. This is the normal behavior. You should not modify the destination with this option.	\|__ FolderA \|__RenameFolderB \|__FolderC \|__RenamedDocC1 \|__DocC2 Origin and destination are not synchronized. You should not rename folders or documents. The federation won't restore the folder or document with its orignal name. This is the normal behavior. You should not modify the destination with this option.	\|__ FolderA \|_FolderB \|__DocC1 \|__FolderC \|__DocC2 Origin and destination are not synchronized. You should not move folders or documents.The federation won't restore the folder or document wiht its original path. This is the normal behavior. You should not modify the destination with this option.

Example 2 : Deleting objects on destination (1way)

In this case you are going to replicate some objetcs (these objects can be documents, folder ....) and modify the destination only.

	Origin	Destination option "Normal replication"	Destination option "Refresh from origin"
Step1	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1
Step2	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1	We deleted the FolderC and the DocB1. \|__ FolderA \|__FolderB	We deleted the FolderC and the DocB1. \|__ FolderA \|__FolderB
Step3		We ran the federation	We ran the federation
Step4	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1	Origin and destination are not synchronized. You should not modify the destination with this option.	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1 Origin and destination are synchronized. The deleted folder and document will be imported by the next federation job.

Example 3 : Adding/Renaming /Moving objects on destination (2 ways replication - "normal" or "refresh from origin")

Normal : (Added / Renamed) on destination

	Origin	Destination Option : "normal" (Added / renamed)
Step1	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2
Step2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	We added the FolderD and DocD3 We renamed the FolderB and DocC1 \|__ FolderA \|__RenamedFolderB \|__FolderC \|__RenamedDocC1 \|__DocD3 \|__DocC2 \|__FolderD
Step3		We ran the federation
Step4	\|__ FolderA \|__RenamedFolderB \|__FolderC \|__RenamedDocC1 \|__DocD3 \|__DocC2 \|__FolderD Origin and destination are synchronized. The added / renamed / moved folders and documents are imported by the federation job.	\|__ FolderA \|__RenamedFolderB \|__FolderC \|__RenamedDocC1 \|__DocD3 \|__DocC2 \|__FolderD Origin and destination are synchronized.

Normal : (Moved) on destination

You should not modify the destination with this option.

	Origin	Destination Option : "normal" (Moved)
Step1	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2
Step2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	We moved the DocC2 under the FolderB \|__ FolderA \|__FolderB \|__DocC2 \|__FolderC \|__DocC1
Step3		We ran the federation
Step4	\|__ FolderA \|__FolderB \|__DocC2 \|__FolderC \|__DocC1 Origin and destination are not synchronized. The replication is done as it was defined in the step2 of the destination.	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2 Origin and destination are not synchronized. The federation modified also the destination. The Federation cancelled all changes done in Step2, so the Step1 tree is re-build. You should not modify the destination with this option.

Refresh from origin : (Added / renamed / moved) on destination

You should not modify the destination with this option.

	Origin	Destination Option : "refresh from origin" (Added / renamed / moved)
Step1	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2
Step2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	We added the FolderD and DocD3 We renamed the FolderB and DocC1 \|__ FolderA \|__RenamedFolderB \|__FolderC \|__RenamedDocC1 \|__DocD3 \|__DocC2 \|__FolderD
Step3		We ran the federation
Step4	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2 Origin and destination are not synchronized. The added / renamed / moved Folders / Documents are NOT imported by the federation job. This is the normal behavior. You should not modify the destination with this option.	\|__ FolderA \|__RenamedFolderB \|__FolderC \|__RenamedDocC1 \|__DocD3 \|__DocC2 \|__FolderD Origin and destination are not synchronized. This is the normal behavior. You should not modify the destination with this option.

Example 4 : Deleting objects on destination (2 ways replication - normal or refresh from origin)

In this case you are going to replicate some objetcs (these objects can be documents, folder ....) and modify the destination only.

	Origin	Destination option "normal"	Destination option "Refresh from origin"
Step1	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1
Step2	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1	We deleted the folder C and the DocB1. \|__ FolderA \|__FolderB	We deleted the folder C and the DocB1. \|__ FolderA \|__FolderB
Step3		We ran the federation	We ran the federation
Step4	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1	\|__ FolderA \|__FolderB Origin and destination are not synchronized. This is the normal behavior. The deleted Folders and Documents won't be imported by the federation job . You should not modify the destination with this option.	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1 Origin and destination are synchronized. The deleted Folders and Documents will be imported by the next federation job.

Example 5 : Adding /Renaming /Moving objects on destination (2 Ways - refresh from destination)

Refresh from destination : (Added / renamed)

In this case you are going to replicate some objetcs (these objects can be documents, folder ....) and modify the destination only.

	Origin	Destination Option : "Refresh from destination" (Added or renamed)
Step1	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2
Step2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	We added the FolderD and the DocC3 and renamed the folderB and DocC2 \|__ FolderA \|__RenamedFolderB \|__FolderC \|__DocC1 \|__RenamedDocC2 \|__DocC3 \|__FolderD
Step3		We ran the federation
Step4	\|__ FolderA \|__RenamedFolderB \|__FolderC \|__DocC1 \|__RenamedDocC2 \|__DocC3 \|__FolderD Origin and destination are synchronized. The federation replicated all folders and documents. But in this case the folders and documents replicated in the origin don't have the "replicated" icon.	\|__ FolderA \|__RenamedFolderB \|__FolderC \|__DocC1 \|__RenamedDocC2 \|__DocC3 \|__FolderD Origin and destination are synchronized. Once the federation is done, the folders and documents added have the "replicated" icon.

Refresh from destination : (Moved) on destination

You should not modify the destination with this option.

In this case you are going to replicate some objetcs (these objects can be documents, folder ....) and modify the destination only.

	Origin	Destination Option : "Refresh from destination" (Moved)
Step1	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2
Step2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	We moved the FolderC and the DocC1 \|__ FolderA \|___DocC1 \|_FolderB \|__FolderC \|__DocC2
Step3		We ran the federation
Step4	\|__ FolderA \|___DocC1 \|_FolderB \|__FolderC \|__DocC2 Origin and destination are not synchronized. The replication is done as it was defined in the step2 of the destination. You should not modify the destination with this option.	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2 Origin and destination are not synchronized. The federation modified also the destination. The Federation cancelled all changes done in Step2, so the Step1 tree is re-build. You should not modify the destination with this option.

Only the Folders / Documents have this issue when you moved them . If you moved Users , Origin and destination are synchronized.

Example 6 : Deleting objects on destination (2 Ways - refresh from destination)

You should not modify the destination with this option.

In this case you are going to replicate some objetcs (these objects can be documents, folder ....) and modify the destination only.

	Origin	Destination Option : "Refresh from destination" (Deleted)
Step1	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1
Step2	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1	We deleted the FolderC and the DocB1 \|__ FolderA \|__FolderB
Step3		We ran the federation
Step4	\|__ FolderA \|__FolderB \|__DocB1 \|__FolderC \|__DocC1 Origin and destination are not synchronized. You should not modify the destination with this option.	\|__ FolderA \|__FolderB Origin and destination are not synchronized. You should not modify the destination with this option.

<=== Previous Article

About adding, renaming, moving or deleting objects on Origin

Next Article ===>

Tuning Federation XI 3.1 for performance and heavy load

	Origin	Destination (Added) Option : "Normal" or "Refresh from origin"	Destination (Renamed) Option : "Normal" or "Refresh from origin"	Destination (Moved) Option : "Normal" or "Refresh from origin"
Step1	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2
Step2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	We added the FolderD and the DocC3 \|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2 \|__DocC3 \|__FolderD	We renamed the FolderB and the DocC1 \|__ FolderA \|__RenameFolderB \|__FolderC \|__RenamedDocC1 \|__DocC2	We moved the FolderC under the FolderB and the DocC1 under the FolderB. \|__ FolderA \|_FolderB \|__DocC1 \|__FolderC \|__DocC2
Step3		We ran the federation	We ran the federation	We ran the federation
Step4	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2	\|__ FolderA \|__FolderB \|__FolderC \|__DocC1 \|__DocC2 \|__DocC3 \|__FolderD Origin and destination are not synchronized. If you add some folders or documents in destination, the federation won't considere them. This is the normal behavior. You should not modify the destination with this option.	\|__ FolderA \|__RenameFolderB \|__FolderC \|__RenamedDocC1 \|__DocC2 Origin and destination are not synchronized. You should not rename folders or documents. The federation won't restore the folder or document with its orignal name. This is the normal behavior. You should not modify the destination with this option.	\|__ FolderA \|_FolderB \|__DocC1 \|__FolderC \|__DocC2 Origin and destination are not synchronized. You should not move folders or documents.The federation won't restore the folder or document wiht its original path. This is the normal behavior. You should not modify the destination with this option.

Page tree

Adding, renaming, moving or deleting objects on Destination

Introduction

Workflows by functionality

Example 1 : Adding /Renaming /Moving objects on destination (1way - "Normal" - or "Refresh from origin")

Example 2 : Deleting objects on destination (1way)

Example 3 : Adding/Renaming /Moving objects on destination (2 ways replication - "normal" or "refresh from origin")

Normal : (Added / Renamed) on destination

Normal : (Moved) on destination

Refresh from origin : (Added / renamed / moved) on destination

Example 4 : Deleting objects on destination (2 ways replication - normal or refresh from origin)

Example 5 : Adding /Renaming /Moving objects on destination (2 Ways - refresh from destination)

Refresh from destination : (Added / renamed)

Refresh from destination : (Moved) on destination

Example 6 : Deleting objects on destination (2 Ways - refresh from destination)