Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The...

30
Aprimo Marketing Studio 8.7 Configuration Mover Guide

Transcript of Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The...

Page 1: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Aprimo Marketing Studio 8.7 Configuration Mover Guide

Page 2: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Copyright 2011 Aprimo, a Teradata Company. All rights reserved.

All rights to this publication are reserved. No part of this book may be reproduced or transmitted in any form or by any

means, electronic, digital, or mechanical, including photocopying and recording, for any purpose other than the purchaser's personal use without the written permission of Aprimo, a Teradata Company.

Aprimo is a registered trademark of Aprimo, a Teradata Company.

All other names and products used herein are trademarks of their respective owners.

Page 3: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Contents 1. Overview of the Configuration Mover Process .....................................................4

2. Creating a Test Data Source ................................................................................6

Take Aprimo Marketing Studio Offline ....................................................................... 6

Back Up and Restore the Database ............................................................................ 7

Restart the Services .................................................................................................... 7

Configure the Test Data Source .................................................................................. 7

Initialize the Test Data Source .................................................................................... 8

Edit System Settings for the Test Data Source ........................................................... 9

3. Configuring Objects in the Test Data Source ...................................................... 10

Aprimo Tools Package Objects ................................................................................. 10

Workflow Administration Package Objects .............................................................. 13

4. Exporting Data from the Test Data Source ......................................................... 14

Create the Export Configuration Job and Select Objects ......................................... 14

Select Object Records ............................................................................................... 15

Select the Dependencies of Object Records ............................................................ 15

Review the Selected Object Records and Dependencies ......................................... 16

Create and Download the Configuration Mover Job File ......................................... 17

Troubleshoot Export Configuration Job Errors ......................................................... 17

Undoing an Export Configuration Job ...................................................................... 18

5. Importing Data into the Production Data Source................................................ 20

Back up the Production Database ............................................................................ 20

Create and Start the Import Configuration Job ........................................................ 20

Troubleshoot Import Configuration Job Errors ........................................................ 21

Verify that Object Data Imported Correctly ............................................................. 23

6. Using a Verification Data Source ....................................................................... 24

Appendix A: Glossary ............................................................................................... 25

Appendix B: Data Handling Methods Reference ........................................................ 26

Aprimo Tools Package .............................................................................................. 26

Workflow Administration Package ........................................................................... 29

Page 4: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Version 1 – 1-Jul-2011 4

1. Overview of the Configuration Mover Process You use the configuration mover to move object records that you configured and tested in a test

data source to your production data source. This guide provides information about the types of

objects the configuration mover supports and details for each step in the process.

Caution Before attempting to move object records from a test data source to a production data source, read this guide to become familiar with the process. Not following the procedures can cause errors and affect data integrity in your production database.

You complete these steps to set up and use the configuration mover:

Create and initialize a test data source.

The test data source in which you create, edit, and test object records is based on a backup

of your production database. The test data source is automatically initialized the first time

you log on. For more information, see chapter 2.

Create, configure, and test objects in the test data source.

After the test data source is initialized, you can create, configure, and test object records

supported by the configuration mover. For more information, see chapter 3.

Export data from the test data source.

You create an export configuration job in the test data source to select object records and

dependencies, and to create the configuration mover job file containing the exported data.

For more information, see chapter 4.

o Select a package and types of objects to export

A package is a group of objects categorized for use in the configuration mover. For

example, the Aprimo Tools package only contains objects types you configure in

Aprimo Tools modules, such as system types and system parameters. An export

configuration job can export object records from a single package. After you select

the package, you select the object types to export.

o Select object records to export

For each selected object type, you select one or more object records that you created

or edited in the test data source.

o Select dependencies of object records.

A dependency is an object record that is referenced by an object record selected for

export. For example, the groups to which a user belongs are dependencies of the user

record. Dependencies that exist only in the test data source are automatically selected

for import. You manually select non-required dependencies, which are typically

object records that exist in the production data source or were previously exported.

o Review the selected object records and dependencies.

You view onscreen summaries and the Export Catalog report to verify that you

selected the correct object records and dependencies.

o Create the configuration mover job file.

You start the export configuration job to create the configuration mover job file that

contains the object data to move to the production data source.

Page 5: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 1: Overview of the Configuration Mover Process

Version 2 – 1-Jul-2011 5

o Download the configuration mover job file.

You download the configuration mover job file to your computer or a computer you

can access.

Import object records and configuration data into the production data source

You create an import configuration job in the production database to import the

configuration mover job file that contains the object data from the test data source. For

more information, see chapter 5.

o Take the application offline and back up the production database.

Follow your standard practices to perform a full backup of your production database

before you import data from the test data source.

o Select the configuration mover job file and start the import configuration job.

You select the configuration mover job file to import, and start the job to import

object records into the production data source.

o Verify that the object data imported correctly

After the import completes, you verify that all the object records in the configuration

mover job file were imported and added or updated correctly.

Page 6: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Version 1 – 1-Jul-2011 6

2. Creating a Test Data Source The test data source in which you configure and test new objects is based on your production data

source.

Caution Install any production updates on the production data source before you create the test data source. The production and test data sources must use the same version of Aprimo Marketing Studio for the configuration mover process to work correctly.

Complete these procedures to create the test data source:

Take Aprimo Marketing Studio Offline

Back Up and Restore the Database

Restart the Services

Configure the Test Data Source

Initialize the Test Data Source

Edit System Settings for the Test Data Source

Take Aprimo Marketing Studio Offline To ensure data integrity, take Aprimo Marketing Studio offline before you back up your

production database. Schedule the backup during your organization’s off-peak hours, and notify

your users of the downtime.

You stop several services on your Aprimo Marketing Studio web servers, portal servers, and

services servers to take the application offline.

1. Log on to the server.

2. Open the Services control panel.

3. Stop these services in this order:

Aprimo NT

Aprimo Monitor

Aprimo XML Publishing, if applicable

Aprimo Utility

IIS Admin Service

4. Repeat this procedure on each web server, portal server, and services server.

Page 7: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 2: Creating a Test Data Source

Version 2 – 1-Jul-2011 7

Back Up and Restore the Database Follow your standard practices to perform a full backup of your production database. When the

backup is complete, restore a copy of the database to create the test database.

Caution The test database must be based on the most recent backup of the production database.

Note Record the database name, username, and password. You will need these when you configure the test data source.

Restart the Services Restart the services on your Aprimo Marketing Studio web servers, portal servers, and services

servers.

1. Log on to the server.

2. Open the Services control panel

3. Start these services in this order:

IIS Admin Service

Aprimo Utility

Aprimo Monitor

Aprimo NT

Aprimo XML Publishing, if applicable

4. Repeat this procedure on each web server, portal server, and services server.

Configure the Test Data Source You configure the connection to the test data source in the Data Sources module in the

Configuration Manager.

1. Access the Configuration Manager.

Example http://ServerName/AprimoSysConfig/default.aspx

2. On the navigation column, click Data Sources.

3. Click Add.

4. Type a Name for the data source.

5. In the DB Provider field, click the type of database.

6. In the DB Server field, type the name of the server where the test database is located.

Note If you have an Oracle database, in the DB Server field, type the service name. The service name is the TNS name in the TNSNames.ora file.

7. If you are configuring a SQL Server database, in the Instance field, type the database name

you recorded when you backed up the production data source.

Page 8: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 2: Creating a Test Data Source

Version 2 – 1-Jul-2011 8

8. In the User Name field, type the user name you recorded when you backed up the

production data source.

9. In the Password field, type the password for the user.

10. In the Configuration Mover Type field, click Test.

Note Selecting Test is required to initialize the test data source the first time you log on.

11. In the Servers section, select the servers that can access this data source.

12. Type this information in the Pre Cache User fields:

In the Login ID field, type the Aprimo administrator account name.

In the Password field, type the Aprimo administrator account password.

13. Click the Test button.

Note If the test is unsuccessful, verify that the information you typed in the fields is correct, and test the data source again. If the second test is unsuccessful, contact Aprimo Customer Support.

14. Click OK.

15. Click Save.

Initialize the Test Data Source Log on to the test data source to automatically start the initialization. The configuration mover

functionality is disabled during initialization, which might take several minutes. When the

initialization finishes, the New button in the Export Configuration Jobs module is enabled.

Caution Do not allow users to configure objects in the test data source during initialization.

These processes occur during initialization:

Move existing GUIDs from the import history to the export history

The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records to

identify whether they are new or updated. If object records were previously imported via

the configuration mover into the production data source on which the test data source is

based, existing GUIDs are moved from the import history to the export history so that ID

conflicts do not occur.

Scan existing object records and create GUIDs

The application scans the ID of each object record the configuration mover supports. If the

ID of an object record is currently mapped to a GUID, the GUID is retained. If an ID is not

mapped, a GUID is created.

Delete configuration mover job history

If object records were previously imported via the configuration mover into the production

data source on which the test data source is based, the job history is deleted.

Page 9: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 2: Creating a Test Data Source

Version 2 – 1-Jul-2011 9

Edit System Settings for the Test Data Source Because the test data source is based on your production data source, you might need to edit these

system settings:

System parameters that specify URLs or UNC paths, such as the application URL and the

filestore directory. For more information, see Understanding System Parameters in the

Help.

Note You can specify a path to a new file store or to a copy of the production file store.

Paths for server files. For more information, see Understanding Server Files in the Help.

Note You must use a SQL script to edit server file paths.

Datasource Management module configurations if you use them to import data into Aprimo

Marketing Studio. For more information about the datasource management modules, see

Understanding Databases and Understanding Data Sources in the Help.

Page 10: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Version 1 – 1-Jul-2011 10

3. Configuring Objects in the Test Data Source The objects the configuration mover supports are organized in packages. An export configuration

job can contain object records from a single package. This chapter lists the types of objects in each

package:

Aprimo Tools Package Objects

Workflow Administration Package Objects

Each section also provides information for the objects that have design considerations or export

behaviors you should understand. The information is organized in these categories:

Best practices

Follow the practice recommendations for an object to prevent import and export errors.

Guidelines/Notes

Guidelines and notes provide information about object records and dependencies that can or

cannot be exported when you select another record.

Non-supported dependencies

A non-supported dependency is an object record that references a selected object record, but

cannot be moved between test and production data sources via the configuration mover.

When a selected object record is associated with a non-supported dependency that does not

exist in the production data source, you must remove the association to successfully export

the object record.

Aprimo Tools Package Objects The Aprimo Tools package contains these types of objects:

Activity types

Annotation types

Attachment types

Audience member

types

Audience types

Black out Date types

Brand types

Calendar item types

Car rental types

Cell types

Change order

categories

Channel types

Digital asset format

types

Digital asset tag types

Digital asset types

Extended attribute page

layout

Extended attributes

Facility option types

Facility type

Flight class type

General transportation

types

Groups

Household member

role types

Incentive cost types

Incentive types

Invoice types

Journal voucher types

Lead status types

Material types

Miscellaneous expense

types

Offer types

Offering types

Participant types

Plan overview status

types

Portal security

questions

Product categories

Product types

Regions

Review reject reasons

RFP types

Roles

Room types

Supplier types

System parameters

Terminology

Treatment cost types

Treatment types

Users

Wave type

Page 11: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 3: Configuring Objects in the Test Data Source

Version 1 – 1-Jul-2011 11

Activity Types

Guidelines/Notes

If you delete an activity type status or audience member status in the test data source, the

deletions are not reflected in the production data source.

Status changes you make to an activity type status or audience member status in the test

data source are reflected in the production data source.

Extended Attribute Page Layout

Guidelines/Notes

Exporting an extended attribute page layout also exports newly created extended attribute records

that are associated with the layout.

Extended Attributes

Best Practices

Create extended attributes only in the test data source. Because extended attribute IDs from the

test data source are retained on import, creating extended attributes in both the test and production

data sources might result in ID conflicts. If the configuration mover detects an ID conflict during

import, an error occurs.

Guidelines/Notes

If you delete selection options for a Picklist-Encoded or Multiple Selection extended

attribute in the test data source, the deletions are not reflected in the production data source.

Status changes you make in the test data source are reflected in the production data source.

Exporting extended attribute records does not export associated extended attribute page

layout records.

If you do not export an extended attribute page layout with which an extended attribute is

associated, the field associated with the extended attribute is placed in the default location

on the page or tab in the production data source. For more information, see Understanding

Extended Attributes in the Help.

If you configure a workflow administration object, such as a workflow template, with fields

associated with extended attributes, those attributes can be exported as dependencies of the

record in a Workflow Administration package.

Exporting an extended attribute only updates its parent reference. You must select the child

extended attribute records to export.

Groups

Guidelines/Notes

Exporting group records does not export newly created user records that are associated with the

group. To export the associated users, select the Users object and the appropriate user records.

Non-supported Dependencies

Currency codes

Page 12: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 3: Configuring Objects in the Test Data Source

Version 2 – 1-Jul-2011 12

Participant Types

Non-supported Dependencies

Currency codes

Product Categories

Guidelines/Notes

Exporting a product category only updates its parent reference. You must select the child product

categories to export.

Roles

Guidelines/Notes

Exporting role records does not export associated user or group records. To export the associated

records, select the Users and Groups objects and the appropriate user and group object records.

Non-supported Dependencies

Currency codes

System Parameters

Guidelines/Notes

Selecting a system parameter record exports records for all Aprimo Marketing Studio domains.

Terminology

Guidelines/Notes

Selecting a terminology record exports records for all Aprimo Marketing Studio domains.

Users

Guidelines/Notes

Exporting user records also exports newly created group and role records that are associated

with the record.

Only user details are exported. Settings for My Aprimo, annotations, navigation columns,

and user preferences are not exported.

These user record attributes are not updated for existing records in the production data

source: password, password set date, invalid password count, question ID, and security

answer. These attributes are exported for newly created user records.

Non-supported Dependencies

Currency codes

Offices

Page 13: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 3: Configuring Objects in the Test Data Source

Version 2 – 1-Jul-2011 13

Workflow Administration Package Objects The Workflow Administration package contains these types of objects:

Data collection templates

Notification templates

Step checklists

Teams

Work schedules

Workflow templates

Note If you configure a workflow administration object, such as a workflow template, with fields associated with extended attributes, those attributes can be exported as dependencies of the record in a Workflow Administration package.

Step Checklists

Guidelines/Notes

Newly created extended attribute tabs referenced by activity links are not exported.

Workflow Templates

Guidelines/Notes

At minimum, each workflow template to export must have the Valid state in the test data

source.

If you configure a workflow template with fields associated with extended attributes, those

attributes can be exported as dependencies of the template in a Workflow Administration

package.

If a workflow template is associated with attachments, only the current version of each

attachment is exported. Annotations associated with the attachment version are not

exported.

Newly created activity type statuses and encoded picklist items referenced by Picklist-

Encoded and Multiple Selection extended attributes that are associated with the workflow

template are not exported.

Newly created steps in external workflows referenced by review links are not exported by

default. To export, select the workflows containing these steps as object records or

dependencies, and set the Workflow Template Disposition of the export configuration job to

Promoted.

Newly created extended attribute tabs referenced by activity links are not exported.

Non-supported Dependencies

Brands

Clients

Digital assets

Digital asset folders

Funding accounts

Objectives

Organizational strategies

Plan overviews

Page 14: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Version 1 – 1-Jul-2011 14

4. Exporting Data from the Test Data Source When you finish configuring and testing object records in the test data source, you create an

export configuration job to select the records and dependencies to export. Complete these

procedures:

Create the Export Configuration Job and Select Objects

Select Object Records

Select the Dependencies of Object Records

Review the Selected Object Records and Dependencies

Create and Download the Configuration Mover Job File

Troubleshoot Export Configuration Job Errors

Create the Export Configuration Job and Select Objects

1. Log on to the test data source.

2. On the main navigation column, point to System Administration, and click Aprimo Tools.

3. On the navigation column, point to Configuration Mover, and click Export Configuration

Jobs.

4. Click New.

5. In the Package field, click the package type to create.

6. Type a Title for the export configuration job.

7. If you are configuring a Workflow Administration package that will contain workflow

templates, click the Workflow Template Disposition to assign to each workflow template

in the package:

Invalid

The templates must be validated and promoted before they can be used in a project or

change order.

Valid

The validated templates must be promoted before they can be used in a project or

change order.

Promoted

The templates can be used in a project or change order immediately after they are

imported into the production data source.

Note You can select a different disposition when you import the package into the production data source.

8. In the Objects section, move each object type to export from the Available Objects list to

the Selected Objects list.

9. Continue with the next procedure.

Page 15: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 4: Exporting Data from the Test Data Source

Version 2 – 1-Jul-2011 15

Select Object Records 1. Click the Object Selection tab.

2. Point to an object’s action icon, and click Edit Selections.

3. On the Edit Object Record Selections page, select the object records to export, and click

Save.

Tip To view or edit an object record, point to the record’s action icon, and click View.

4. Close the View Object Record Selections page.

5. Repeat steps 2 – 4 for each object to export.

Notes

You must select an object record for each object type listed. If you do not need to export any records for a particular object type, remove it from the Selected Objects field on the Details tab.

When you select an object record that is a parent in an object relationship, no child records are recognized as dependencies. However, selecting a child record automatically recognizes a newly created parent record as a dependency.

6. Continue with the next procedure.

Select the Dependencies of Object Records A dependency is an object record that is referenced by an object record you selected on the Object

Selection tab. For example, an extended attribute is a dependency of a data collection template

containing a field that is associated with the extended attribute.

There are three types of dependencies:

Required

A required dependency is an object record that does not currently exist in the production

data source or a record you selected on the Object Selection tab. Required dependencies are

automatically included in configuration mover job files. The check box is checked and

disabled.

Note Required dependencies exported by previously completed export configuration jobs are not marked as required because they are understood to be present in the production data source.

Non-required

A non-required dependency is related to an object record, but typically already exists in the

production data source or was exported by a previous export configuration job. You use the

Dependencies tab to select which non-required dependencies to export.

Non-supported

A non-supported dependency is a newly created object record with an essential relationship

to a selected object record, but cannot be exported via an export configuration job. You

must remove the association to successfully export the object record. For more information,

see Resolving an Error Caused by a Non-supported Dependency later in this chapter. The

check box is cleared and disabled.

Page 16: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 4: Exporting Data from the Test Data Source

Version 2 – 1-Jul-2011 16

You use the Dependencies tab to view the dependencies of each object record and to select the

non-required dependencies to export. Selecting non-required dependencies is not mandatory.

However, if you do not select a non-required dependency that has changed in the test data source,

the changes will not be reflected in the production database.

1. Click the Dependencies tab.

2. Expand an object.

The object records appear.

3. Expand an object record.

The objects that have dependencies appear.

4. Expand the object, and select which dependencies to export.

Tips

Point to the name of an object record or dependency to display a ScreenTip with the last modified and last export dates.

Click the name of an object record or dependency to view and edit the record.

5. Repeat steps 2 – 4 for the remaining objects and records.

6. Click Save.

7. Continue with the next procedure.

Review the Selected Object Records and Dependencies View the summaries on the Object Summary tab and the Export Catalog report to verify that you

selected all of the necessary object records and dependencies for the export configuration job.

1. Click the Object Summary tab.

2. Point to the Selected Objects Pending Export button, and click the summary to view:

Selected Objects Pending Export

This summary displays the object records you selected on the Object Selection tab,

sorted by the objects selected on the Details tab.

Object Dependency Summary

This summary displays counts of these items:

o Object records you selected

o Required dependencies selected automatically

o Non-required dependencies you selected

o Non-required dependencies still available to select

Tips

If you select additional object records or dependencies, click the Refresh button to update the summaries.

Click the orange Report button to view or print a PDF version of the summary.

3. Click the blue Report button to view the Export Catalog report.

4. In the Export Catalog report, verify that all of the object records and dependencies are

selected.

5. Continue with the next procedure.

Page 17: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 4: Exporting Data from the Test Data Source

Version 2 – 1-Jul-2011 17

Create and Download the Configuration Mover Job File After you finish selecting and reviewing object records and dependencies, you create the

configuration mover job file that contains the data to move to the production data source.

1. Click the Details tab.

2. If the Start button is disabled, click Save.

3. Click Start.

4. Wait several minutes, and click the Refresh ( ) toolbar button.

5. If the Status is Processing, repeat step 4 until the status is Complete or Error.

6. If the Status is Complete, click the File Name, and download the configuration mover

export file to your computer or a computer you can access.

-or-

If the Status is Error, continue with the Troubleshoot Export Configuration Job Errors

procedure.

Tips

Click the blue Report button or the status of the export configuration job to view the Export Catalog report. This report lists the object records and dependencies included in the configuration mover job file.

You can also view the Export Catalog in the Import Configuration Job module.

7. Close the export configuration job, and continue with chapter 5, Importing Data into the

Production Data Source.

Troubleshoot Export Configuration Job Errors To troubleshoot an export configuration job that has the Error status, view its log to determine

what caused the error and if you can resolve it.

1. Open the export configuration job if necessary.

2. On the navigation column, click Export Configuration Job Logs.

3. Find the log message that describes the error.

Example This log message indicates the error was caused by a non-supported dependency:

A record in the job requires an association to the non-supported object Digital Assets with ID 201. This ID is not in the Production data source. Remove the association and start the export again.

4. If the log message indicates the error was caused by a non-supported dependency, as in the

example, continue with the next procedure.

-or-

If the log message indicates a different cause for the error, contact Aprimo Customer

Support.

Page 18: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 4: Exporting Data from the Test Data Source

Version 2 – 1-Jul-2011 18

Resolving an Error Caused by a Non-supported Dependency

If the format of an error message matches the example in the Troubleshoot Export Configuration

Job Errors procedure, follow these steps to resolve the error.

1. Note the non-supported dependency that caused the error.

2. Click Copy.

The copy of the export configuration job appears.

3. Click the Dependencies tab.

4. Click the name of the object record with which the non-supported dependency is associated.

5. Edit the object record to remove the association with the non-supported dependency.

6. Close the object record.

7. On the Dependencies tab of the export configuration job, click the Refresh ( ) toolbar

button.

8. Verify that the non-supported dependency is no longer associated with the object record.

9. Click Save.

10. Complete the Create and Download the Configuration Mover Job File procedure.

11. In the production data source, add the dependency, and reassociate it with the object record.

Undoing an Export Configuration Job If you do not import a particular configuration mover job file into the configuration mover, you

should undo the export configuration job that created the file.

Caution Do not undo an export configuration job that was imported into the production data source. Because the object records are removed from the configuration mover job history, it is possible to select them in future export configuration jobs, which will add duplicate records to the production data source.

These events occur when you undo an export configuration job:

A rollback is performed:

o The GUIDs assigned to newly exported object records in the export configuration job

removed.

o The Last Exported dates for new and edited object records are reset to their previous

values.

Note GUIDs and dates are not rolled back for any object records that were exported in a later job.

The status of the job is changed to Canceled.

Page 19: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 4: Exporting Data from the Test Data Source

Version 2 – 1-Jul-2011 19

The configuration mover export file is deleted from the server.

Notes

The undo export functionality is not enabled by default. The setting of the Allow Undo of Configuration Mover Export Jobs system parameter determines if you can undo export configuration jobs.

You do not need to undo export configuration jobs that result in an error. No export file is created for an export configuration job that errors.

Undo multiple export configuration jobs in reverse order from which they were started. Use the End Time field on the Export Configuration Job List page to determine the order in which jobs were started.

To undo an export configuration job:

1. Point to the export configuration job’s action icon, and click View Details.

2. Click Undo Export.

3. If you downloaded the configuration mover job file, delete it from the computer.

Page 20: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Version 1 – 1-Jul-2011 20

5. Importing Data into the Production Data Source After you download a configuration mover job from the test data source, you create an import

configuration job in the production data source to import the object records. Complete these

procedures:

Back up the Production Database

Create and Start the Import Configuration Job

Troubleshoot Import Configuration Job Errors

Verify that object Data Imported Correctly

Back up the Production Database Follow your standard practices to perform a full backup of your production database before you

import data from the test data source.

Create and Start the Import Configuration Job

1. Log on to the production data source.

2. On the main navigation column, point to System Administration, and click Aprimo Tools.

3. On the navigation column, point to Configuration Mover, and click Import

Configuration Jobs.

4. Click New.

5. Next to the Upload File field, click Browse, and select the export configuration job to

import.

Tip If importing a Workflow Administration package, you can select a different workflow template disposition.

6. Click Save.

7. Click Start.

8. Wait several minutes, and click the Refresh ( ) toolbar button.

9. If the Status is Processing, repeat step 8 until the status is Complete or Error.

10. If the Status is Complete, continue with the Verify that Object Data Imported Correctly

procedure.

-or-

If the Status is Error, continue with the Troubleshoot Import Configuration Job Errors

procedure.

Page 21: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 5: Importing Data into the Production Data Source

Version 2 – 1-Jul-2011 21

Troubleshoot Import Configuration Job Errors If an import configuration job has the Error status after you start it, no data is imported into the

production database. You can view the import configuration job log to determine the cause of the

error and whether you can resolve it.

1. Open the import configuration job if necessary.

2. On the navigation column, click Import Configuration Job Logs.

3. Find the log message that describes the error.

Example 1: GUID not Found Error ImportIDReplace :: Could not find GUID 0033257d-27ef-451c-8ecd-fee1277c7f20 for (Table Name: USER_ROLE -- Column Name: ROLE_ID -- Value: 342). The associated object record might have been exported, but not imported. To troubleshoot, see the Configuration Mover Guide.

Example 2: ID not Found Error ImportIDReplace :: Could not find ID 342 for (Table Name: USER_ROLE -- Column Name: ROLE_ID). The associated object record might have been deleted from the production data source. To troubleshoot, see the Configuration Mover Guide.

4. If the log message format matches example 1, continue with the Resolving a GUID not

Found Error procedure.

-or-

If the log message format matches example 2, continue with the Resolving an ID not Found

Error procedure.

-or-

If the log message format does not match either example, contact Aprimo Customer

Support.

Resolving a GUID not Found Error

A GUID not found error occurs when a required dependency of an object record is not selected in

the current export configuration job or present in the production data source. Typically, this occurs

because the dependency was exported in a previous job, but not imported into the production data

source.

Because the dependency is logged as exported and assumed to exist in the production data source,

it is considered a non-required dependency in all subsequent export configuration jobs. If you do

not manually select the dependency in a subsequent job, a GUID not found error will occur on

import.

Follow these steps to resolve the error:

1. Record the table name, column name, and the ID or value in the error message.

2. Log off the production data source.

3. Log on to the test data source, and access the Export Configuration Jobs module.

4. If the undo export functionality is enabled:

Open the export configuration job that corresponds to the import configuration job

that caused the error.

Click Undo Export.

Page 22: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 5: Importing Data into the Production Data Source

Version 2 – 1-Jul-2011 22

5. Wait several minutes, and click the Refresh ( ) toolbar button.

6. If the Status is Processing, repeat step 5 until the status is Canceled.

7. If the Status is Canceled, click Copy.

The copy of the export configuration job appears.

8. Click the Dependencies tab.

9. Expand the list of dependencies until you find the record with the ID listed in the error

message.

10. Select the dependency.

11. Click Save.

12. Complete the Create and Download the Configuration Mover Job File procedure.

13. Import the new configuration mover job file into the production data source.

Resolving an ID not Found Error

An ID not found error occurs when an existing version of an object record or dependency selected

in an export configuration job was deleted from the production data source. The error occurs

because the configuration mover cannot replace deleted objects in the production data source.

Follow these steps to resolve the error:

1. Record the table name, column name, and the ID or value in the error message.

2. Log off the production data source.

3. Log on to the test data source, and open the Export Configuration Jobs module.

4. Create a copy of the export configuration job that corresponds to the import configuration

job that caused the error.

5. Review the records selected on the Object Selection and Dependencies tabs until you find

the record with the ID listed in the error message.

6. Clear the selection for the object record or dependency.

-or-

Click the object record or dependency to edit the record and remove the reference.

Tip You can create a copy of the object record or dependency that caused the error, and select it in the export configuration job. Because this copy has a different ID than the original, it will not cause an ID not found to occur.

7. Click Save.

8. Complete the Create and Download the Configuration Mover Job File procedure.

9. Import the new configuration mover job file into the production data source.

Page 23: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Chapter 5: Importing Data into the Production Data Source

Version 2 – 1-Jul-2011 23

Verify that Object Data Imported Correctly The Complete status indicates that an import configuration job imported successfully. When the

import finishes, you should verify that the object records and data imported correctly. Verification

provides this information:

All selected object records and dependencies were imported into the production data source.

Each object record and dependency was added or updated appropriately.

The IDs assigned to object records and dependencies in the production data source.

You compare the Export Catalog and Import Configuration Job Summary reports to verify that

data imported correctly.

1. Point to Linked Reports, and click Export Catalog.

2. Save or print the report.

3. Close the View Report page.

4. Point to Linked Reports, and click Import Configuration Job Summary.

Tip You can also click the status to open the Import Configuration Job Summary report.

5. Save or print the report.

6. Close the View Reports page.

7. Verify that all object records and dependencies in the Export Catalog report are present in

the Import Configuration Job Summary report.

8. In the Import Configuration Job Summary report, verify that the add or update indicator is

correct for each record.

9. Access the appropriate modules in the production data source to verify that the object

records and dependencies in the Import Configuration Job Summary report exist in the data

source.

Page 24: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Version 1 – 1-Jul-2011 24

6. Using a Verification Data Source Follow these steps if your organization requires testing new and edited object records from the test

data source in a verification data source before importing them into the production data source.

1. Restore a copy of the same production database backup that you used to create the test

database.

2. In the Configuration Manager, create the verification data source, and set the Configuration

Mover Type field to Production.

For more information, see chapter 2.

3. Create the export configuration job in the test data source.

For more information, see chapter 4.

4. Import the configuration mover job file into the verification data source, and verify that the

data imported correctly.

For more information, see chapter 5.

5. If your testing in the verification data source is successful, import the same configuration

mover job file into the production data source.

-or-

If your testing determines that changes are required before importing the object records into

the production data source:

Open the export configuration job in the test data source, and undo the export.

Note The undo export functionality must be enabled. For more information, see chapter 4.

Edit the appropriate object records in the test data source.

Repeat steps 3 – 5.

Page 25: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Version 1 – 1-Jul-2011 25

Appendix A: Glossary configuration mover job file

The file exported when you start an export configuration job in the test data source. It contains the

object records and dependencies to move to the production data source. These files have the .dpp

file name extension.

dependency

An object record referenced by an object record selected to export from the test data source.

export configuration job

A configuration mover job you create in the test data source to select and export the object records

and dependencies to move to the production data source.

import configuration job

A configuration mover job you create in the production data source to select and import a

configuration mover job file.

object

A type of object, such as workflow templates, the configuration mover supports. You can move

individual object records of a supported object between data sources.

object record

An individual instance of an object that you can select to move from the test data source to the

production data source.

package

A group of objects categorized for use in the configuration mover. Each export configuration job

can contain objects from a single package.

production data source

The data source where users perform actions and complete tasks in Aprimo Marketing Studio.

test data source

The data source where you create, configure, and test object records before exporting them for use

in the production data source.

Page 26: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Version 1 – 1-Jul-2011 26

Appendix B: Data Handling Methods Reference Data handling methods determine how IDs are assigned to object records that are imported into

the production database. They also determine if object records you delete in the test data source

are also deleted in the production data source.

These data handling methods are used:

Add or update

This is the default data handling method. On import, new object records from the test data

source are assigned new IDs. Object records that already exist in the production database

are updated, but might have different IDs than in the test data source.

You cannot select object records deleted in the test data source for export. You must

manually delete the record in the production data source.

Add or update by ID only

This data handling method is used only for extended attributes. On import, new object

records from the test data source are assigned new IDs. Object records that already exist in

the production data source are updated, but retain the same ID.

Add only

On import, new object records from the test data source are assigned new IDs. Object

records that already exist in the production database are updated by creating a new versions.

Flush and fill

On import, IDs of all imported object records are deleted and replaced in the production

database. Records are never appended in the production database.

Flush and fill is applied only to object records referenced by a primary object record. Object

records imported into the production data source are exact copies of the records in the test

data source.

Example You edit an activity type to associate it with domain B instead of domain A. When you import the activity type into the production data source, it is associated with domain B instead of domain A.

Object records you delete in the test data source are also deleted from the production data

source.

These tables list objects with IDs assigned by the add only or flush and fill data handling methods.

Objects that are not listed have IDs assigned by the add or update data handling method.

Use the tables to verify the delete behavior or the ID assigned to an object record.

Aprimo Tools Package

Activity Types

Table Table Name Data Handling Method

Domains activity_type_domains Flush and fill

Page 27: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Appendix B: Data Handling Methods Reference

Version 2 – 1-Jul-2011 27

Audiences

Table Table Name Data Handling Method

Domains audience_domains Flush and fill

Extended Attribute Page Layout

Table Table Name Data Handling Method

Tabs ext_attr_page_tabs Flush and fill

Sections ext_attr_tab_sections Flush and fill

Fields ext_attr_section_fields Flush and fill

Disallowed values ext_attr_section_disalloweds Flush and fill

Extended Attributes

Table Table Name Data Handling Method

Relationships ext_attr_relationships Flush and fill

Domains ext_attr_domains Flush and fill

Group access ea_access_list Flush and fill

Types extended_attribute_types Flush and fill

Groups

Table Table Name Data Handling Method

Domain rights user_group_functions Flush and fill

Domains user_group_domains Flush and fill

Incentive Types

Table Table Name Data Handling Method

Offer types incentive_type_offer_types Flush and fill

Offers

Table Table Name Data Handling Method

Activity types offer_type_activity_types Flush and fill

Page 28: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Appendix B: Data Handling Methods Reference

Version 2 – 1-Jul-2011 28

Product Category Types

Table Table Name Data Handling Method

Parent category product_category_parent_list Flush and fill

Program Types

Table Table Name Data Handling Method

Domains campaign_type_domains Flush and fill

Regions

Table Table Name Data Handling Method

Domains region_domains Flush and fill

Review Reject Reason Types

Table Table Name Data Handling Method

Review reject types review_reject_type_list Flush and fill

Roles

Table Table Name Data Handling Method

Members user_role_member Flush and fill

Users

Table Table Name Data Handling Method

Domain rights user_group_functions Flush and fill

Domains user_group_domains Flush and fill

Extended attributes user_group_ext_attributes Add or update

Multiple selection extended attributes

user_group_ext_attr_multi Flush and fill

User groups group_membership Flush and fill

Page 29: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Appendix B: Data Handling Methods Reference

Version 2 – 1-Jul-2011 29

Workflow Administration Package

Data Collection Templates

Table Table Name Data Handling Method

Version data_collection_versions Add only

Sections data_collection_sections Add only

Fields data_section_fields Add only

Notification Templates

Table Table Name Data Handling Method

Fields notification_template_fields Flush and fill

Step Checklists

Table Table Name Data Handling Method

Version workflow_checklist_versions Add only

Checklist items workflow_checklist_item Add only

Teams

Table Table Name Data Handling Method

Workflow team members workflow_team_members Flush and fill

Work Schedules

Table Table Name Data Handling Method

Version work_schedule_versions Add only

Daily hours work_schedule_daily_hours Add only

Blackout dates work_schedule_blackout_dates Add only

Workflow Templates

Table Table Name Data Handling Method

Variables workflow_variables Add only

Comment box workflow_comments Add only

Steps workflow_steps Add only

Page 30: Aprimo Marketing Studio 8 · Move existing GUIDs from the import history to the export history The configuration mover assigns GUIDs (Globally Unique Identifiers) to object records

Appendix B: Data Handling Methods Reference

Version 2 – 1-Jul-2011 30

Table Table Name Data Handling Method

Status actions workflow_step_actions Add only

Required documents workflow_step_req_docs Add only

Supporting documents workflow_step_sup_docs Add only

Activity links workflow_step_links Add only

Review links workflow_step_review_links Add only

Step checklists workflow_step_cklist Add only

Step checklist roles workflow_step_cklist_roles Add only

Step data collection templates

workflow_step_dct Add only

Step data collection template roles

workflow_step_dct_roles Add only

Assignees workflow_step_roles Add only

Review rejection notifications

workflow_step_reject_notif Add only

Review approval notifications

workflow_step_approve_notif Add only

Ports workflow_ports Add only

Paths workflow_paths Add only