This chapter describes how to configure Tzunami Deployer settings and covers the following topics:

  • Rule Engine
  • Tzunami Deployer Options

 

Rule Engine

Deployer Rule Engine is a powerful Deployer component that enables you to automate large parts of the deployment process by creating flowcharts of If-Then statements in a rules editor.

A Rule consists of a set of conditions (logical IFs) and Actions (logical THENs). If all conditions are fully met, then the Actions are executed. A Rule Set is a set of rules that define deployment options for a specific Enterprise Content Management (ECM) system.

The Deployer Rule Engine is intended for power users, System Integrators, and Tzunami Deployer specialists. It provides you with a high degree of freedom in regard to the business logic you can create.

The order of the Rules in a Rule Set is important. The Rule Engine processes each container item in the deployed item, evaluating the Rules one after the other against each item. If even one Condition is not met, the Rule is ignored, and the Rule Engine proceeds to the next Rule. If all Conditions are met, the Actions are performed, and the Rule Engine continues handling the next item. No other rule is evaluated for that item. As a result, even if two Rules are valid for a certain item, only the first Rule is evaluated and performed.

The Rule Sets Editor contains several built-in default Rule Sets that define some common deployment logic schemas. You can customize these default Rule Sets to suit your specific deployment needs.

Configuring Rule Engine

You can choose whether to involve the Rule Engine in the deployment process. Tzunami recommends that you start working with Tzunami Deployer without the Rule Engine. After you are familiar with Tzunami Deployer’s behavior and features, you can create a new Rule Set and enable the Rule Engine to generate suggestions.

To set the Rule Engine interaction level

  1. Select Tools > Options. The Options window appears.
  2. Select the Rule Engine tab. The Options window displays the Rule Engine tab.
  3. Select one of the following levels of interaction:
  • Don’t use Rule Engine – The Rule Engine does not take part in the deployment process.
  • Rule Engine provides options – The Rule Engine generates suggestions for the deployment process. The deployment wizard is displayed to the user to validate and acknowledge the options.

4. Click OK.

The Rule Engine interaction level is set.

Opening the Rule Sets

To open the Rule Sets Editor:

  • Select Tools > Deployment Rules.

Or

Press F8.

The Rule Sets Editor appears.

 

Figure 67: Rule Sets Editor

Specifying Rule Set Location

Rule Sets are saved on the file system. The location of each Rule Set must be specified in the Rule Engine.

To specify the locations of Rule Sets:

    1. Select Tools > Options > Rule Engine.

      Tzunami Deployer - Options window appears, displaying the locations in center of the screen.


      Figure 68: Options Window

    2. Click Add and browse to the location of the Rule Set.

      Or Enter the location in a new line in the Locations area.

    3. Select Rule Set and click OK.

 

You can use two special variables in the definition of the location:

@DEPLOYER@ – denotes the Tzunami Deployer installation folder.

@PROJECT@ – denotes the currently open Tzunami Deployer project.

You can delete a location by highlighting the relevant text in the Location area, and deleting it.

 

You can specify that the location of a new Rule Set be automatically added to the list of locations, by clicking Add location to list of rules set locations when you define a new Rule Set (Figure 69).

Rule Sets Editor

You can create multiple Rule Sets for each ECM system. However, at any given time, only one Rule Set can be used during the deployment process. For more information about “Rule Set” see Rule Engine on page 5-132.

To set which Rule Set to use during the deployment process:

  1. Select Tools > Options in the menu. The Options window appears, displaying the existing Rule Sets in the bottom half of the screen (Figure 69).
  2. Select the Rule Set for the ECM to use during the deployment.

 

Creating a New Rule Set

To create a Rule Set:

  • In the Rule Sets Editor (Figure 67), click New Rules set. The New Deployment Rules Set Form appears.

 

Figure 69: New Deployment Rules Set Form

 

  • Enter the following information for the new Rule Set and click OK.

Table 15: New Deployment Rule Set Form Fields

Field

Description

Rules Set Name

Specify a name for the Rule Set.

Type

Select the type of source ECM the Rule Set applies to from the drop-down list.

Filename

Specify where to save the Rule set file.

Add location to list of rules set locations

Select this option if you wish to display the file location in the Locations pane in the Options window (Figure 68).

 

 

If the Rule Set you are creating is very similar to an existing Rule Set, you can duplicate the existing Rule Set and edit its rules. For more information, seeCopying a Rule Set on page 5-96.

 

Copying a Rule Set

To copy a Rule Set:

When you duplicate a Rule Set, it appears with the same name as the original Rule Set, followed by - Copy.

  1. Select Tools > Deployment Rules. The Rule Sets Editor appears.
  2. In the Rule Set Editor toolbar, click Copy.

 

Creating a Rule in a Rule Set

To create a rule in a Rule Set:

1. Click New in the Rules toolbar. The Rule Editor window appears.

 

Figure 70: Rule Editor Window – General Tab

2. In the General tab enter the following information:

Table 16: Rule Editor, General tab – Description of Fields

Field

Description

Title

Enter a name for the rule.

Description

Enter a description for the rule.

Enabled

Select if you want this rule to be processed as part of the Rule Set.

 3. Click the Conditions tab and define the condition(s):

a. Click New. The Conditions Selector window appears, listing all available conditions.

 

These conditions may differ depending on the type of ECM system you specified in the Type field of the Rule Set.

Figure 71: Conditions Selector Window

b. Select the Condition(s) you wish to add and click OK. Each Condition is displayed both in the top pane and the bottom pane. The Condition’s variables are marked in blue and underlined.

Figure 72: Rule Editor Window – Conditions Tab

c. In the bottom pane, select a value for each variable by clicking the variable, and entering or selecting a value. For information about the values to enter or select, see Defining Conditions on page 5-100.

 

If you do not select a value, the rule is considered incomplete, and will not be processed.

 4. Click the Actions tab and define the action(s):

a. Click New. The Actions Selector window appears, listing all available actions. Note that these conditions may differ depending on the type of ECM system you specified in the Type field of the Rule Set.

Figure 73: Actions Selector Window

 

b. Select the Actions you wish to add and click OK. Each Action is displayed both in the top pane and the bottom pane. The Action’s variables are marked in blue and underlined.

Figure 74: Rule Editor Window – Actions Tab

c. In the bottom pane, select a value for each variable by clicking the variable, and entering or selecting a value. For information about the values to enter or select, see Defining Actions on page 5-109.

 

If you do not select a value, the rule is considered incomplete, and will not be processed.

Copying and modifying a Rule in a Rule Set

This option is useful if you wish to create a rule that is similar to an existing one. Instead of creating a new rule from scratch, you can first copy the existing rule, and then edit it.

 

To copy a rule in a Rule Set:

  1. Select the rule you wish to duplicate.
  2. Click Copy in the Rule toolbar. The Rule Editor window appears, displaying the new rule.

You can now edit the information in the General, Conditions, and Actions tabs of the rule, as described in Creating a Rule in a Rule Set on page 5-97.

 

To edit a rule in a Rule Set:

  1. Select the rule you wish to edit.
  2. Click Edit in the Rule toolbar.

Or Double-click the rule.

The Rule Editor window appears, displaying the selected rule.

You can now edit the information in the General, Conditions, and Actions tabs of the rule, as described in Creating a Rule in a Rule Set on page 5-97.

 

Defining Conditions

This section provides descriptions of the various Conditions you can define. Each description includes the relevant variables, as well as general remarks, if applicable.

 

If you specify multiple Conditions in a rule, Tzunami Deployer arranges them in the order in which they will be evaluated. You cannot change this order.

If you define contradicting Conditions in a Rule, the Rule will never be executed, because there will never be a case when all Conditions are met.

You can define a Rule with no conditions. This rule will apply to all items. However, note that only this rule will be executed. This rule is useful with theExecute the following Rules <Rules> action. For more information, see Execute the following Rules <Rules> on page 5-120.

 

Parent is of type <Parent Type>

Check if the designated (new) parent of the item is of a certain type.

Variables

Variable

Description

<Parent Type>

The type of the designated parent. The type can be one of the following values:

  • Web Application
  • Site Collection
  • Sub Site
  • Area – The Portal Area used in a SharePoint 2003 Server
  • Site – Automatically adjust between Root site, WSS, or Area
  • Document Library
  • Image Library
  • List – A list of any type, including Document Library and Image Library
  • Folder/List. Note that lists are also recognized as folders
  • Area Listing – The List used in a SharePoint 2003 Server

 

Items is at level <Level> of parent <Parent Type>

Check if the Items hierarchy is at same level of designated parent type items.

Variables

Variable                       

Description

<Level>

The value (or values) to search for in the item.

<Parent Type>

The type of the designated parent. The type can be one of the following values:

  • Web Application.
  • Site Collection.
  • Sub Site.
  • Area – The Portal Area used in a SharePoint 2003 Server.
  • Site – Automatically adjust between Root site, WSS, or Area.
  • Document Library.
  • Image Library.
  • List – A list of any type, including Document Library and Image Library
  • Folder/List. Note that lists are also recognized as folders
  • Area Listing – The List used in a SharePoint 2003 Server

 

Source Parent is of type <Source Type>

Checks the source type of the parent of current item

 

Variables

Variable

Description

<Source Type>

The type of the designated parent. The type can be one of the following values:

  • Web Application
  • Site Collection
  • Sub Site
  • Area – The Portal Area used in a SharePoint 2003 Server
  • Site – Automatically adjust between Root site, WSS, or Area
  • Document Library
  • Image Library
  • List – A list of any type, including Document Library and Image Library
  • Folder/List. Note that lists are also recognized as folders
  • Area Listing – The List used in a SharePoint 2003 Server

 

Remarks

This condition is only available if you specified SharePoint 2003, SharePoint 2007, SharePoint 2010 and SharePoint 2013 in the Type field of the Rule Set.

 

 

Source is of type <Source Type>

Checks the source type of the current item

Variables

Variable

Description

<Source Type>

The type of source. The type can be one of the following values:

  • Web Application
  • Site Collection
  • Sub Site
  • Area – The Portal Area used in a SharePoint 2003 Server
  • Site – Automatically adjust between Root site, WSS, or Area
  • Document Library
  • Image Library
  • List – A list of any type, including Document Library and Image Library
  • Folder/List. Note that lists are also recognized as folders
  • Area Listing – The List used in a SharePoint 2003 Server

Remarks             

This condition is only available if you specified SharePoint 2003, SharePoint 2007, SharePoint 2010 or SharePoint 2013 in the Type field of the Rule Set.

 

Source Server Template is <Server Template>

Check if the source list is based on a specific list definition type (server template).

Variables

Variable                

Description

<Server Template>

Server template ID of the source list. In MOSS/WSS3.0 it is also referred to as Base Template. This can be one or several of the values in Table 16, or any custom Server Template ID.

Table 17: Standard Template IDs

ID

Template Name

ID

Template Name

0

No List Template

202

Meeting Attendees List

100

Generic List

204

Decision

101

Document Library

204

Meeting Decisions List

102

Survey

207

Meeting Objective

103

Links

207

Meeting Objectives List

104

Announcements

210

Text Box

105

Contacts

210

Meeting Text Box

106

Events

211

Things To Bring

107

Tasks

211

Meeting Things To Bring List

108

Discussion Board

212

Home Page Library

109

Picture Library

212

Meeting Workspace Pages List

110

Data Sources

300

Portal Sites List

111

Web Template Catalog

301

Posts

112

User Information

302

Comments

113

Web Part Catalog

303

Categories

114

List Template Catalog

402

Facility

115

XML Form

403

Whereabouts

116

Master Page Catalog

404

Call Track

117

No Code Workflows

405

Circulation

118

Workflow Process

420

Timecard

119

Web Page Library

421

Holidays

120

Custom Grid

499

IMEDic

121

Solution Catalog

600

External List

122

No Code Public

850

Publishing Page Library

130

Data Connection Library

1100

Issue Tracking

140

Workflow History

1200

Admin Tasks

150

Gantt Tasks

1220

Health Rule

200

Meetings

1221

Health Reports

200

Meeting Series List

1301

Translation Lists

200

Area Document Library

2002

Personal Document Library

201

Agenda

2003

Private Document Library

201

Meeting Agenda List

-1

Invalid Type

202

Meeting User

 

 

 

 Remarks

  • You can enter any custom Server Template ID in order to support customized lists.
  • This condition is only available if you specified SharePoint 2003, SharePoint 2007, SharePoint 2010 or SharePoint 2013 in the Type field of the Rule Set.

 

Source Item is a Document Workspace

Check if the source item is a document workspace

 

Expected target parent is a Meeting Workspace

Check if the expected target parent is a Meeting Workspace.

 

Source item is a Meeting Workspace

Check if the source item is a meeting workspace

 

Source parent item's <'Property Name'> property equals <Values>

Checks if the value of the current item’s source parent item property equal certain value.

Variables

Variable

Description

<Property Name>

The display name of the property (case sensitive).

<Value>

The value (or values) to search for in the item.

 

Remarks

If property name is entered in <Property Name>, then the Condition is true only if the value matches the current items source parent property name.

 

 

Number of subitems <Great/Equals/Less than> <Number> <not including items under sub-containers> and <count sub-containers as items>

Check if the number of sub items of item is greater than/equals to/ less than the total number of sub-containers as items excluding item under sub-container.

 

Variables

Variable

Description

<Great/Equals/Less than >

The type of the Operators. The type can be one of the following values:

  • Greater Than
  • Equal
  • Less Than

< Number>

The value (or values) to search for in the item.

<not including items under sub-containers>

  • Including items under sub-containers (recursively) – Select number of sub-items under sub-containers (recursively)
  • Not including items under sub-containers – Do not select the number of sub-items under sub-containers 

<count sub-containers as items>

  • Count sub-containers as items – Count number of sub-items in sub-containers as items
  • Do not count sub-containers as items– Do not Count number of sub-items in sub-containers.

 

Source Item’s <Property Name> property equals <Value>

Checks the value of the source item’s property

Variables

Variable

Description

<Property Name>

The display name of the property (case sensitive).

<Value>

The value (or values) to search for in the item.

 

Remarks

If property name is entered in <Property Name>, then the Condition is true only if the value matches the current items property name.

 

Container <is/is not empty>

Check if the container is empty or not.

Variables

Variable

Description

is

A keyword indicating that the container does not have items

Is not empty

A keyword indicating that the container has items

 

Source item's <'Property Name'> property contain <'Value'>

Check if the source item’s property name contains a value.

Variables

Variable

Description

<Property Name>

The display name of the property (case sensitive).

<Value>

The value (or values) to search for in the item.

 

Source item's children have <all> of the properties <Values>

Check if the children of the current item have certain property value.

Variables

Variable

Description

<all>

The display all or any value of the property

<Values>

The value (or values) to search for in the item.

 

Parent Deployment option <Property Name> equals <Value>

Check if the deployment option of the current item’s parent property has a certain value.

Variables

Variable

Description

<Property Name>

The deployment option property to check. This can be one of the following values, described in Defining the Deployment Structureon page 4-65 :

  • Invalid
  • Description
  • Language Id
  • Language Name
  • List Template Name
  • List Template Server template
  • List Template Base type
  • URL
  • Owner login name
  • Owner display name
  • Site Template name
  • Title
  • Deploy Files
  • Deploy Hierarchy
  • Flat Deploy

<Value>

The value to search for in the deployment options of the item.

Deployment option <Property Name> equals <Value>

Check if the deployment option of the current item property has a certain value.

Variables

Variable

Description

<Property Name>

The deployment option property to check. This can be one of the following values, described in Defining the Deployment Structure on page 4-65:

  • Invalid
  • Description
  • Language Id
  • Language Name
  • List Template Name
  • List Template Server template
  • List Template Base type
  • URL
  • Owner login name
  • Owner display name
  • Site Template name
  • Title
  • Deploy Files
  • Deploy Hierarchy
  • Flat Deploy

Value

The value to search for in the deployment options of the item.

 

Source Item {Does | Does not have} unique permissions

Checks if a source item has unique permissions or it inherited/has the same permissions as the parent.

Parameters

Parameter

Description

Does

A keyword indicating that the source item has unique permissions.

Does not have

A keyword indicating that the source item does not have unique permissions.

 

Any of the subitems' <'Property Name'> property equal <Values> (Do not look recursively in sub-containers)

Check if property of sub-item of item has certain property values but don’t look recursively in sub-containers of item

 

Parameter

Parameter

Description

All

The display any or all properties

Value

The value to search for in the deployment options of the item.

(Do not look recursively in sub-containers)

  • Look recursively in sub-containers
  • Do not look recursively in sub-containers

 

All sub-items’ <Property Name> property equals <Value> (using <flags>)

Check if the property of all sub-items of item has certain value using the provided flag.

Variables

Variable

Description

<Property Name>

The display name of the property (case sensitive).

<Value>

The value (or values) to search for in the item.

<flags>

  • Consider folders – Selecting this flag will consider subfolder of folder containing subfolders and items.
  • Look recursive – Selecting this flag will recursively look for items or folders in containers.
  • Accept empty containers– Selecting this flag will accept empty containers
  • Ignore already deployed items– Selecting this flag will help to ignore which is already deployed.

 

Remarks

  • If a property name of each sub-items of item is entered in <Property Name>, then the Condition is true only if the values of all sub-items of item include value defined in the Condition using the flag.
  • This Condition will also check the items and files of the currently checked container.

 

 

Defining Actions

This section provides descriptions of the various Actions you can define. Each description includes the relevant variables, as well as general remarks if applicable.

 

If you specify multiple Actions in a rule, Tzunami Deployer arranges them in the order in which they will be evaluated. You cannot change this order.

If you define illogical combinations of Actions; the Actions are performed in the order determined by Tzunami Deployer, and invalid Actions are ignored.

 

Deploy as <Type>

Sets the deployment options to deploy as a certain type

Variables

Variable

Description

<Type>

The type to deploy as. This can be one of the following values:

  • Web Application
  • Site Collection
  • Sub Site
  • Area – The Portal Area used in a SharePoint 2003 Server
  • Site  – Automatically adjust between Root site, WSS, or Area
  • Document Library
  • Image Library
  • List – A list of any type, including Document Library and Image Library
  • Folder/List. Note that lists are also recognized as folders
  • Do not Deploy – Using during the deployment process
  • Area Listing - The List used in a SharePoint 2003 Server

 

Set <Deploy Option> to <Value>

Sets a deploy option to a certain value.

Variables

Variable

Description

<Deploy Option>

The name of the deployment option. This can be one of the following values, described in Defining the Deployment Structureon page 4-65.

  • Invalid
  • Description
  • Language Id
  • Language Name
  • Title
  • Deploy Files
  • Deploy Hierarchy
  • Flat Deploy
  • Enable Quick Launch
  • Inherit Navigation
  • On Top Navigation bar

Value

The value to set for the deployment option.

 

Set the best-matching workspace template

When an item is deployed as a site, this action matches the template of the deployed site to best matching available site templates.

 

Set Template to <Site Template>

When an item is deployed as a site, this action sets the site template to a certain template.

Variables

Variable

Description

<Site Template>

The name of the site template. For example: Team Site, Blank Site, and so on.

 

Remarks

This Action is valid only when an item is deployed as a site.

 

Set Template using the following <mapping>

When an item is deployed as a site, this action sets the site template according to the specified site mapping.

Variables

Variable

Description

<Mapping>

A mapping of source templates to target templates. See Table 18and Table 19 for a list of standard source template IDs and standard target template Name#IDs.

 

Table 18: Standard source values (Template base type IDs)

ID

Template Name

Description

1

STS

Template for Team Site, Blank site and Document workspace

2

MPS

Meeting Workspaces Template

3

CENTRALADMIN

Central Admin Site

4

WIKI

Wiki Site

9

BLOG

Blog

20

SPS

SharePoint Portal Server Site (Obsolete)

21

SPSPERS

SharePoint Portal Server Personal Space

22

SPSMSITE

Personalization Site

30

SPSTOC

Contents area Template (Obsolete)

31

SPSTOPIC

Topic area template (Obsolete)

32

SPSNEWS

News Site Template (Obsolete)

33

SPSNHOME

News Site Template

34

SPSSITES

Site Directory

36

SPSCOMMU

Community area template

38

SPSREPORTCENTER

Report Center

39

CMSPUBLISHING

Publishing Site

47

SPSPORTAL

Collaboration Portal

50

SRCHCEN

Search Center with Tabs

51

PROFILES

Profiles

52

BLANKINTERNETCONTAINER

Publishing Portal

53

BLANKINTERNET

Publishing site Template

54

SPSMSITEHOST

My Site Host

 

Table 19: Standard target values (Template name#Configuration ID)

Template Name#ConfigurationID

Title

STS#0

Team Site

STS#1

Blank Site

STS#2

Document Workspace

MPS#0

Basic Meeting Workspace

MPS#1

Blank Meeting Workspace

MPS#2

Decision Meeting Workspace

MPS#3

Social Meeting Workspace

MPS#4

Multipage Meeting Workspace

CENTRALADMIN#0

Central Admin Site

WIKI#0

Wiki Site

BLOG#0

Blog

SPS#0

SharePoint Portal Server Site (this template is obsolete)

SPSPERS#0

SharePoint Portal Server Personal Space

SPSMSITE#0

Personalization Site

SPSTOC#0

Contents area Template (this template is obsolete)

SPSTOPIC#0

Topic area template (this template is obsolete)

SPSNEWS#0

News Site (this template is obsolete)

SPSNHOME#0

News Site

SPSSITES#0

Site Directory

SPSCOMMU#0

Community area template (this template is obsolete)

SPSREPORTCENTER#0

Report Center

CMSPUBLISHING#0

Publishing Site

SPSPORTAL#0

Collaboration Portal

SRCHCEN#0

Search Center with Tabs

PROFILES#0

Profiles

BLANKINTERNETCONTAINER#0

Publishing Portal

BLANKINTERNET#0

Publishing Site

BLANKINTERNET#1

Press Releases Site

BLANKINTERNET#2

Publishing Site with Workflow

SPSMSITEHOST#0

My Site Host

 

Remarks

  • This Action is valid only when an item is deployed as a site.
  • This Action is available only if you specified SharePoint 2003, SharePoint 2007, SharePoint 2010 or SharePoint 2013 in the Type field of the Rule Set.

 

 

 

 

  • In the Rule Sets Editor, the following window appears for defining the mapping:

 

Figure 75: Site Template Mapping Editor Window

  •  Enter a source template ID in the left hand field under Add mapping entries, and enter a target template Name#ID in the right hand field under Add mapping entries. Click Add to add this entry to the list of source and target values.
  • The source value “%OTHER%” can be used as a placeholder, signifying “any other template”. This can be used as a default mapping, instead of defining mappings for all source options.
 
 
 
Use List Template having server template <Server Template>ID

When an item is deployed as a list, this action sets the List Template based on a Server Template ID.

Variables

Variable

Description

<Server Template>

The server template ID. You can enter a standard template ID (seeTable 17 for a list of standard template IDs), or any custom Server Template ID.

 

Remarks

  • You can enter any supported Server Template ID, in order to support lists and libraries.
  • This Action is valid only when item is deployed as a list.
  • This Action is based on the SharePoint recommendation, in which each list template has a unique Server Template ID.

 

Use List Template <Server Template Name>

When an item is deployed as a list, this action sets the List Template based on the list template’s Name.


 

Variables

Variable

Description

<Server Template Name>

The server template Name. You can enter a standard template name (such as Document Library, Contacts, and so on, see Table 17 for a list of standard template IDs) or any custom Server Template name.

 

Remarks

You can enter any supported Server Template Name, in order to support lists or libraries.

 

Set List Template using the following <mapping>

While an item is deployed as a list, this action maps template ID number from source to target according to the specified list template mapping.

Variables

Variable

Description

<mapping>

A mapping of source template IDs to target template IDs. You can enter standard source and target template IDs (see Table 17 for a list of standard source and target template IDs), or any custom Server Template ID.

 

Remarks

  • This Action is available only if you specified SharePoint 2003, SharePoint 2007, SharePoint 2010 or SharePoint 2013 in the Type field of the Rule Set.
  • In the Rule Sets Editor, the following window appears for defining a mapping:

 

Figure 76: List Template Mapping Editor Window

  • Enter a source list template ID in the left hand field under Add mapping entries, and a target list template ID in the right hand field under Add mapping entries.
  • Click Use Existing to specify that if the site template includes this list type, it will be used and set true to existing column.
  • Click Add to add this entry to the list of source and target values.

 

Set List Template using the following <mapping> (automatic)

While an item is deployed as a list, this action automatically maps template ID number from source to target according to the specified list template mapping.

Variables

Variable

Description

<mapping>

A mapping of source template IDs to target template IDs. You can enter standard source and target template IDs (see Table 17 for a list of standard source and target template IDs), or any custom Server Template ID.

 

Remarks

  • This Action is available only if you specified SharePoint 2003, SharePoint 2007 SharePoint 2010 or SharePoint 2013 in the Type field of the Rule Set.
  • In the Rule Sets Editor, the following window appears for defining a mapping:

 

Figure 77: List Template Mapping Editor Window

  • Enter a source list template ID in the left hand field under Add mapping entries, and a target list template ID in the right hand field under Add mapping entries.
  • Click Add to add this entry to the list of source and target values.
 
 
 
Use <property mapping file> and <add required target properties>

Sets an XML document as the property mapping to be used for the item, and specifies whether to add required target properties.

Variables

Variable

Description

<mapping>

The path to on XML file that defines the property mapping. SeeSample Property Mapping XML Fileon page 5-116.

Add required target properties|
Don’t add required target properties

Required target properties are the properties that are required in the target item but are not present in property mapping XML file.

Use these keywords to specify whether to add missing properties to the target.

 

Sample Property Mapping XML File

<PropertyMapping SourceSet=“Tasks Column Set” TargetSet=“Tasks Column Set 2”>

  <Pair>

    <Source DisplayName=“Created” Name=“Created”

            PropertyType=“DateTime” />

    <Target DisplayName=“Created” Name=“Created Date”

            PropertyType=“DateTime” />

  </Pair>

  <Pair>

    <Source DisplayName=“Approval Status” Name=“_ModerationStatus”

            PropertyType=“ModStat” />

    <Target DisplayName=“Approval Status” Name=“_ModerationStatus”

            PropertyType=“ModStat” />

  </Pair>

  <Pair>

    <Source DisplayName=“Name” Name=“D996E646-5C05-45b7-B24A-9AFAF5B21503”

            PropertyType=“Text” />

    <Target DisplayName=“Name” Name=“D996E646-5C05-45b7-B24A-9AFAF5B21503”

            PropertyType=“Text” />

  </Pair>

  <Pair>

    <Source DisplayName=“Modified By” Name=“Editor” PropertyType=“User” />

    <Target DisplayName=“Modified By” Name=“Editor” PropertyType=“User” />

  </Pair>

  <Pair>

    <Source DisplayName=“Created By” Name=“Author” PropertyType=“User” />

    <Target DisplayName=“Created By” Name=“Author” PropertyType=“User” />

  </Pair>

  <Pair>

    <Source DisplayName=“Start Date” Name=“StartDate”

            PropertyType=“DateTime” />

    <Target DisplayName=“Start Date” Name=“StartDate”

            PropertyType=“DateTime” />

  </Pair>

  <Pair>

    <Source DisplayName=“Due Date” Name=“DueDate” PropertyType=“DateTime” />

    <Target DisplayName=“Due Date” Name=“DueDate” PropertyType=“DateTime” />

  </Pair>

  <Pair ValueMapping=“@DEPLOYER@\Rules\Mappings\Value Mapping - Tasks - Priority.xml”>

    <Source DisplayName=“Priority” Name=“Priority” PropertyType=“Choice” />

    <Target DisplayName=“Priority” Name=“Priority” PropertyType=“Choice” />

  </Pair>

  <Pair>

    <Source DisplayName=“% Complete” Name=“PercentComplete”

            PropertyType=“Number” />

    <Target DisplayName=“% Complete” Name=“PercentComplete”

            PropertyType=“Number” />

  </Pair>

  <Pair>

    <Source DisplayName=“Modified” Name=“Modified” PropertyType=“DateTime” />

    <Target DisplayName=“Modified” Name=“Modified” PropertyType=“DateTime” />

  </Pair>

  <Pair>

    <Source DisplayName=“Created” Name=“Created” PropertyType=“DateTime” />

    <Target DisplayName=“Created” Name=“Created” PropertyType=“DateTime” />

  </Pair>

  <Pair>

    <Source DisplayName=“Assigned To” Name=“AssignedTo” PropertyType=“User” />

    <Target DisplayName=“Assigned To” Name=“AssignedTo” PropertyType=“User” />

  </Pair>

  <Pair>

    <Source DisplayName=“Description” Name=“Body” PropertyType=“Note” />

    <Target DisplayName=“Description” Name=“Body” PropertyType=“Note” />

  </Pair>

  <Pair>

    <Source DisplayName=“Title” Name=“Title” PropertyType=“Text” />

    <Target DisplayName=“Title” Name=“Title” PropertyType=“Text” />

  </Pair>

  <Pair ValueMapping=“@DEPLOYER@\Rules\Mappings\Value Mapping - Tasks - Status.xml”>

    <Source DisplayName=“Status” Name=“Status” PropertyType=“Choice” />

    <Target DisplayName=“Status” Name=“Status” PropertyType=“Choice” />

  </Pair>

  <Pair>

    <Source DisplayName=“Modified” Name=“Modified”

            PropertyType=“DateTime” />

    <Target DisplayName=“Modified” Name=“Last Modified”

            PropertyType=“DateTime” />

  </Pair>

</PropertyMapping>

 

Where;

DisplayName is the Properties Display name.

Name is the SharePoint internal name.

PropertyType can be one of the following: DateTime, ModStat, User, Choice, and Text.

 

Sample Value Mapping XML File

Note that the sample mapping file includes references to two external XML files that contain value mappings (highlighted in the sample): Status and Priority. The Status value mapping file for this example is:

<ValueMapping>

  <Pair Source=“Issue” Target=“Waiting on someone else” />

  <Pair Source=“Completed” Target=“Completed” />

  <Pair Source=“{D3A98B62-323C-4130-AA18-2CA791C9E57D}” Target=“Not Started” />

  <Pair Source=“{D3A98B62-323C-4130-AA18-2CA791C9E57C}” Target=“{D3A98B62-323C-4130-AA18-2CA791C9E57A}” />

</ValueMapping>

 

Where value mapping provides a few “placeholder” values:

{D3A98B62-323C-4130-AA18-2CA791C9E57C} – Empty Source.

{D3A98B62-323C-4130-AA18-2CA791C9E57D} – Default Source.

{D3A98B62-323C-4130-AA18-2CA791C9E57A} – Target Map to Empty.

{D3A98B62-323C-4130-AA18-2CA791C9E57B} – Target Map to Keep Original.

These values match the values available to users in the Value Mapping step of the deployment wizard.

 

Remarks

You can create the mapping file manually, but it is recommended to export a property mapping during a regular deployment, and use the exported mapping. For more information, see Importing and Exporting Userson page 4-55.

 

Set Title to <Title>

Sets the title of the new item to the selected value

Variables

Variable

Description

<Title>

The title of the item.

 

Use unique permissions

When an item is deployed as a site, this action sets the site to use unique permissions.

Remarks

This Action is valid only when an item is deployed as a site.

 

Set owner to <user>

When an item is deployed as a site, this action sets the owner to a certain value.

Variables

Variable

Description

<User>

The username of the user who is being assigned as owner.

The username is case sensitive. It should be the full user logon name (pre-Windows 2000: DOMAIN\user).

 

Remarks

This Action is valid only when an item is deployed as a root site (site collection).

 

Set Description to <Description>

Sets the description of the new item to the selected value

Variables

Variable

Description

<Description>

The description of the item.

 

Add the missing properties [except]

Adds the missing properties of the item except selected property

Variables

Variable

Description

<except>

The description of the item value.

 

Add the missing properties [except of type]

Adds the missing properties of the item except selected property type

Variables

Variable

Description

<Description>

The description of the item type value.

 

Execute the following Rules <Rules>

Executes selected rules of the current Rule Set

Variables

Variable                          

Description

<rules>

The rules to execute.

 

Remarks

  • It is considered good practice to disable Rules that are meant to be executed as part of this Action.

Usually, Rules that are executed by this Action are small, zero, or one condition Rules. These are often created as Rules only to prevent duplication of their logic in multiple Rules.

 

 

Tzunami Deployer Options

Tzunami Deployer allows you to configure its behavior via the Options window

To define the Tzunami Deployer options:

  1. Select Tools > Options…. The Options window appears.

General

 

Figure 78: Options Window – General

Table 20: Deployer Options - General

Option

Description

Select what version Deployer will migrate

Enables you to specify which document versions are deployed into the target SharePoint:

All versions – All document versions are deployed.

Only last <#> versions – Only the specified number of previous versions is deployed.

Deploy only approved versions – Deploy only those versions marked as approved in the source are deployed.

Deploy Security

Enables you to specify whether to deploy security (users, groups and roles).

Enable metadata warning of empty and required field

Select this option to enable metadata warning of empty and required fields.

InfoPath Form Template Deployment Level

Specify the location for deployment of InfoPath form template in the target SharePoint.

 

SharePoint Connectivity

 

Figure 79: Options Window – SharePoint Connectivity

Table 21: Deployer Options - SharePoint Connectivity

Option

Description

Enable self-hosting of the Remote Service

 

Self-host Deployer Remote Service and force connecting to the Remote Service using TCP or HTTP.

Use authentication cookie from Internet Explorer

Enables you to use the authentication cookie from Internet Exporter cookie cache.

Cache the Remote Service for improved performance

Enable the proxy object to the Tzunami Deployer Remote Service is cached and not created from scratch for each request. It improves performance while working with MOSS 2007, SharePoint 2010 and SharePoint 2013 server.

Use WCF Service Endpoint Identity when connecting to Remote Service.

Specify the endpoint identity mode to use when connecting to the remote service using WCF.

Language filter for reading site templates. Separate multiple entries with commas

Specify filtering the reading of site template based language. For Example the value: '1033: English’. Multiple entries are allowed, separated with commas (,) such as '1033:English, 1049:Russian'.

Specify the port used to connect to the SharePoint 2003 DB Server

Controls the ports used to connect to the SharePoint 2003 DB Server.

 

SharePoint Timeouts

 

Figure 80: Options Window – SharePoint Timeouts

 

Table 22: Deployer Options – SharePoint Timeouts

Option

Description

Reading root site timeout

Specify the amount of time, in milliseconds, that Tzunami Deployer tries to connect to the specified Active Directory domains before it times out the connection.

Root sites creating timeout

Specify the root site creation timeout value in milliseconds

Timeouts for the XML HTTP Web Requests

 

Connection timeout

Specify the connect timeout value in milliseconds

Send timeout

Specify the send timeout value in milliseconds

Receive timeout

Specify the receive timeout value in milliseconds

Resolve timeout

Specify the resolve timeout value in milliseconds

 

SharePoint Read Settings

 

Figure 81: Options Window – SharePoint Read Settings

Table 23: Deployer Options– SharePoint Read Settings

Option

Description

Specify the path to the Custom Global Templates mapping file

Enables you to specify the path to the Custom Global Template mapping file.

Specify advanced site read settings

 

Read folder metadata

Set this flag to ‘True’ to load metadata of folders while loading the target.

Allow Deployer to load the same site collection in source and target

Enables you to connect to the same SharePoint Site Collection in both as a source and target.

Read SPS2003 Portal Area as Windows SharePoint Service Sites

Allows Tzunami Deployer to read Areas as regular sites in order to get also non Area sub-sites under a parent Area.

Specify advanced list read settings

 

List Item Collection Position  Next

The index of an item in each list from which to read onwards.

List Item Order by Filename

The field name used to sort items while reading from SharePoint lists or folders.

Max Item Count in Lists

The maximum number of items to be read from each list or folder.

Number of List Items to Read

The number of list items to reach in each request to SharePoint.

Throughput while reading SharePoint

Enables you to specify how intensely Tzunami Deployer will interact with the SharePoint server during connection and reading from the server. When using a higher level of usage, SharePoint performances might be influenced.

 

SharePoint Commit Settings