Migrating Sales Assessment Templates

This chapter describes how to migrate sales assessment templates by using the Oracle Migration Tool On Demand client. It contains the following topics:

Sales Assessment Templates

A sales assessment template (or assessment script) is a series of questions that helps Oracle CRM On Demand users to collect customer data. A sales assessment template can be used to qualify leads, assess opportunities, guide customer service interactions, survey customer satisfaction, capture activity information, and so on. For more information, see the topics describing assessment scripts in the Oracle CRM On Demand Online Help.

The following table describes the Oracle Migration Tool On Demand client commands used with sales assessment templates. For more information about running these commands, see Migrating Sales Assessment Templates.

Table Commands Used with Sales Assessment Templates in Oracle Migration Tool On Demand

Command	Description
`Read SalesAssessmentTemplate AssessmentType`	This command exports sales assessment template configuration data of the type specified by AssessmentType, for example, activity assessment templates, from Oracle CRM On Demand.
`ReadAll SalesAssessmentTemplate`	This command exports all sales assessment template configuration data in the Oracle CRM On Demand tenant.
`Upsert SalesAssessmentTemplate MySalesAssessmentScriptXML`	This command updates or inserts sales assessment template configuration data in the Oracle CRM On Demand tenant.

Note: Nonadministrative Oracle CRM On Demand users can run the Read and ReadAll commands.

Privileges Required for Migrating Sales Assessment Templates

The following privileges are required for the user account running the Oracle Migration Tool On Demand client commands:

For the Read and ReadAll commands: Enable Web Services Access, Manage Assessments Access, and Manage Content.
For the Upsert command: Enable Web Services Access, Manage Assessments Access, and Manage Content.

For information about setting and checking privileges, see Oracle CRM On Demand Online Help.

Elements and Sections in the Sales Assessment Template XML Output File

The following table describes the elements and sections in the sales assessment template XML output file.

Table Elements and Sections in the Sales Assessment Template XML File

Description	Element or Section
<Name> specifies the name of the sales assessment template.	<data:Name>MyAssessment</data:Name>
<Active> specifies whether the sales assessment template is active (true) or inactive (false).	<data:Active>true</data:Active>
The <Filtern> elements specify the filters that are used to identify which assessment script is the appropriate one to present to a user for a task.	<data:Filter1></data:Filter1> <data:Filter2></data:Filter2> <data:Filter3></data:Filter3> <data:Filter4></data:Filter4>
<AttributeValueNumber> shows the maximum number of answers specified for a question in the assessment script. This element is read-only and is ignored for upsert requests.	<data:AttributeValueNumber></data:AttributeValueNumber>
<ChildScore> shows the maximum score for the first question, which is calculated by multiplying the weight of the first question by the highest score specified for an answer for the first question. This element is read-only and is ignored for upsert requests.	<data:ChildScore></data:ChildScore>
<Description> contains the description of the sales assessment template.	<data:Description>Sales Assessment</data:Description>
<FieldtoMapScoreTo> specifies the field that displays the score in the parent record.	<data:FieldtoMapScoreTo> </data:FieldtoMapScoreTo>
<MaxAttrValue> shows the total number of answers for the questions in the assessment script. This element is read-only and is ignored for upsert requests.	<data:MaxAttrValue>4</data:MaxAttrValue>
<MaxPossibleScore> is a calculated value. For each question, the weight for the question is multiplied by the highest score for an answer for the question. The sum of the results for all questions is shown in this element. This element is read-only and is ignored for upsert requests.	<data:MaxPossibleScore></data:MaxPossibleScore>
This element is not used.	<data:MaxScore></data:MaxScore>
<ResponseControl> specifies the control used for adding responses to assessment questions. Valid values are: Drop Down, and Radio Button.	<data:ResponseControl>Drop-Down</data:ResponseControl>
This element is not used.	<data:SalesMethod></data:SalesMethod>
This element is not used.	<data:SalesStages></data:SalesStages>
<FieldtoMapOutcomeValueTo> specifies the field that displays the outcome value in the parent record.	<data:FieldtoMapOutcomeValueTo> </data:FieldtoMapOutcomeValueTo>
<RemoveCommentBox> determines whether the comment box is removed when the user is completing the assessment (true) or the comment box is visible (false).	<data:RemoveCommentBox>false</data:RemoveCommentBox>
<OutcomeValueIfThresholdMet> specifies the outcome value to display if the threshold score is met.	<data:OutcomeValueIfThresholdMet> </data:OutcomeValueIfThresholdMet>
<OutcomeValueIfThresholdNotMet> specifies the outcome value to display if the threshold score is not met.	<data:OutcomeValueIfThresholdNotMet> </data:OutcomeValueIfThresholdNotMet>
<ThresholdScore> specifies the threshold that is used to calculate the outcome of the script. If the score is equal to or higher than the threshold, then the outcome is met.	<data:ThresholdScore>40</data:ThresholdScore>
<Type> specifies the type of the assessment script. The valid values are: Account Survey Activity Assessment BusinessPlan Assessment Contact Script Lead Qualification Objective Assessment Opportunity Assessment Service Request - Script Service Request - Survey	<data:Type>Account Survey</data:Type>
<TemplateType> specifies the record type of the assessment script. This element is always set to Assessment, is read-only, and is ignored for upsert requests.	<data:TemplateType>Assessment</data:TemplateType>
The <ListOfSalesAssessmentTemplateAttribute> section contains the details of the criteria specified for the sales assessment template.	<data:ListOfSalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
The <SalesAssessmentTemplateAttribute> section contains the details of one criterion for the assessment.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<Question> specifies a question to be answered by the user.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> <data:Question></data:Question> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<CriteriaName> contains a descriptive name for the question.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:CriteriaName></data:CriteriaName> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<ChildNumber> shows the number of answers that are specified for the question. This element is read-only and is ignored for upsert requests.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:ChildNumber>2</data:ChildNumber> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<ChildOrder> shows the sequence number of the first answer to the first question. This element is read-only and is ignored for upsert requests.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:ChildOrder>1</data:ChildOrder> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<ChildScore> shows the score assigned to the first answer for the question. This element is read-only and is ignored for upsert requests.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:ChildScore>100</data:ChildScore> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<AnswerMapToField> specifies the field on the parent record for displaying the answer to the question.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:AnswerMapToField></data:AnswerMapToField> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<MaxChild> shows the highest score assigned to an answer for the question. This element is read-only and is ignored for upsert requests.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:MaxChild>100</data:MaxChild> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<Order> specifies the position of this question in the sequence of questions presented to the user.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:Order>1</data:Order> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<ParentType> shows the type of the sales assessment to which the question belongs. This element is read-only and is ignored for upsert requests.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:ParentType>Account Survey </data:ParentType> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<Weight> specifies a percentage value that indicates the importance of the question. The sum of the weights for all questions must equal 100.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:Weight>50</data:Weight> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
<WeightxScore> is the maximum score for the question. It is calculated by multiplying the weight of the question by the highest score assigned to an answer for the question. This element is read-only and is ignored for upsert requests.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:WeightxScore>5000</data:WeightxScore> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
The <ListOfSalesAssessmentAttributeValue> section contains the elements for the Answer section of the Assessment Script template.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:ListOfSalesAssessmentAttributeValue> . . . </data:ListOfSalesAssessmentAttributeValue> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>
The <SalesAssessmentAttributeValue> section contains the details of one answer, in the following elements: <Order> indicates the position of this answer in the sequence of the answers presented to the user when completing the assessment. <Answer> contains the answer for the question. <Score> contains the score for the answer. Note: The Description element in this section is not used.	<data:ListOfSalesAssessmentTemplateAttribute> <data:SalesAssessmentTemplateAttribute> . . . <data:ListOfSalesAssessmentAttributeValue> <data:SalesAssessmentAttributeValue> <data:Description></data:Description> <data:Order>1</data:Order> <data:Answer></data:Answer> <data:Score>100</data:Score> </data:SalesAssessmentAttributeValue> . . . </data:ListOfSalesAssessmentAttributeValue> . . . </data:SalesAssessmentTemplateAttribute> . . . </data:ListOfSalesAssessmentTemplateAttribute>

Migrating Sales Assessment Templates

The following topics provide examples of how to use the Oracle Migration Tool On Demand client to migrate sales assessment templates:

Note: Back up your configuration data and all other relevant data before running the Oracle Migration Tool On Demand client.

Extracting a Sales Assessment Template Configuration

This topic describes how to extract a set of sales assessment template configuration data from the Oracle CRM On Demand server for your environment; that is, a customer test environment or production environment.

Note: Users require the Enable Web Services Access privilege to run the Read command.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract a set of sales assessment templates:

migrationtool -u UserID -s ServerURL Read SalesAssessmentTemplate AssessmentType

where:

UserID is the user sign-in ID that has the appropriate privileges to run the Oracle Migration Tool On Demand client commands.
ServerURL is the URL for the Oracle CRM On Demand server where your company resides.
AssessmentType is the assessment type for which you want to read a set of sales assessment templates. It can be one of the following types:
- ActivityAssessment. Activity assessment template configuration data.
- AccountSurvey. Account survey assessment template configuration data.
- BusinessPlan Assessment. Business plan assessment template configuration data.
- Contact Script. Contact script assessment template configuration data.
- Lead Qualification. Lead qualification assessment template configuration data.
- Objective Assessment. Objective assessment template configuration data.
- Opportunity Assessment. Opportunity assessment template configuration data.
- Service Request - Script. Service request script assessment template configuration data.
- Service Request - Survey. Service request survey assessment template configuration data.

Note: The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

Example of Extracting Activity Assessment Template

The following is an example of extracting activity assessment template configuration data.

migrationtool -u UserID -s ServerURL Read SalesAssessmentTemplate ActivityAssessment

Extracting All Sales Assessment Templates

This topic describes how to extract all sales assessment template configuration data from your Oracle CRM On Demand environment; that is, a customer test environment or production environment.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract all sales assessment template data:

migrationtool -u UserID -s ServerURL ReadAll SalesAssessmentTemplate

where:

UserID is the user sign-in ID that has the appropriate privileges to run the Oracle Migration Tool On Demand client commands.
ServerURL is the URL for the Oracle CRM On Demand server where your company resides.

Note: The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (by using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

The output from the Oracle Migration Tool On Demand client is located at:

migration tool install/repository/SalesAssessmentTemplate/object/assessmentname.xml

For example, when you extract assessments for account survey objects, the output is located at the following location:

.../repository/SalesAssessmentTemplate/Account Survey/Account Assessment01.xml

Example of Extracting All Sales Assessment Template Configuration Data

The following is an example of extracting all sales assessment templates from your Oracle CRM On Demand server:

migrationtool -u UserID -s ServerURL ReadAll SalesAssessmentTemplate

Updating or Inserting a Specific Sales Assessment Template (Upsert)

This topic describes how to update a specific sales assessment template configuration (if it exists) or insert the sales assessment template configuration (if it does not exist) in your Oracle CRM On Demand environment; that is, a customer test environment or production environment.

Note: The Manage Assessments Access and Manage Content privileges are required to run the Upsert operation.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to update a specific sales assessment template configuration (if it exists) or insert the sales assessment template configuration (if it does not exist):

migrationtool -u UserID -s ServerURL Upsert SalesAssessmentTemplate MySalesAssessmentScriptXML

where:

UserID is the user sign-in ID that has the appropriate privileges to run the Oracle Migration Tool On Demand client commands.
ServerURL is the URL for the Oracle CRM On Demand server where your company resides.
MySalesAssessmentScriptXML is the fully qualified path name of the sales assessment template XML file, for example:
```
C:\My Files\MySalesAssessmentScipt.xml
```

Note: The Oracle Migration Tool On Demand client requests your Oracle CRM On Demand password, which can be redirected (by using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

Example of Updating or Inserting Sales Assessment Template Configuration Data

The following is an example of updating sales assessment template configuration (if it exists) or inserting the sales assessment template configuration (if it does not exist) in your Oracle CRM On Demand server:

migrationtool -u UserID -s ServerURL Upsert SalesAssessmentTemplate "C:\My Files\MySalesAssessmentTemplate.xml"

Note: Quotation marks are required if the file name or path contains spaces.