Migrating Sales Stages

This chapter describes how to migrate sales stages using the command-line interface of the Oracle Migration Tool On Demand client. It contains the following topics:

Sales Stages

A sales stage is a step in a sales process. The following table describes the Oracle Migration Tool On Demand client commands used with sales stages. These commands are case sensitive.

Table Commands Used with Sales Stages in Oracle Migration Tool On Demand

Command Description

Command	Description
`Read SalesStage BaseName [SalesProcessBaseName]`	This command exports a single sales stage, if the optional SalesProcessBaseName parameter is specified together with the BaseName parameter. If SalesProcessBaseName is not specified, then multiple sales stages might be exported. BaseName is the language-independent name of the sales stage. If the language-independent name contains any spaces or special characters, such as brackets, then it must be enclosed with quotation marks. SalesProcessBaseName is the language-independent name of the sales process that the sales stage is associated with. If the language-independent name contains any spaces or special characters, such as brackets, then it must be enclosed with quotation marks. The SalesProcessBaseName parameter is optional. However, if you do not specify it, and if there is more than one sales stage with the same name (associated with different sales processes), then all of the sales stages with the specified name are exported. You can use the ReadAll SalesProcess command to extract the language-independent names of the sales processes. For more information, see Migrating Sales Processes.
`ReadAll SalesStage`	This command exports all sales stages in the Oracle CRM On Demand tenant.
`Upsert SalesStage SalesStageXML`	This command updates or inserts the sales stage specified in the XML file.

Read SalesStage BaseName [SalesProcessBaseName]

This command exports a single sales stage, if the optional SalesProcessBaseName parameter is specified together with the BaseName parameter. If SalesProcessBaseName is not specified, then multiple sales stages might be exported.

BaseName is the language-independent name of the sales stage. If the language-independent name contains any spaces or special characters, such as brackets, then it must be enclosed with quotation marks.

SalesProcessBaseName is the language-independent name of the sales process that the sales stage is associated with. If the language-independent name contains any spaces or special characters, such as brackets, then it must be enclosed with quotation marks.

The SalesProcessBaseName parameter is optional. However, if you do not specify it, and if there is more than one sales stage with the same name (associated with different sales processes), then all of the sales stages with the specified name are exported. You can use the ReadAll SalesProcess command to extract the language-independent names of the sales processes. For more information, see Migrating Sales Processes.

ReadAll SalesStage

This command exports all sales stages in the Oracle CRM On Demand tenant.

Upsert SalesStage SalesStageXML

This command updates or inserts the sales stage specified in the XML file.

Privileges Required for Migrating Sales Stages

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.
For the Upsert commands: Enable Web Services Access, and Manage Data Rules - Manage Sales Stage Definition.

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

Elements and Sections in the Sales Stage XML Output File

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

Note: Sales stages named Closed/Lost and Closed/Won are automatically associated with each sales process. The Probability field on the Closed/Lost sales stage is set to zero (0), and the Probability field on the Closed/Won sales stage is set to 100. You cannot change these values. Do not set up any other sales stage with the Probability field equal to 0 or 100 percent. Modifying picklists that are used internally by the Oracle CRM On Demand application can have an adverse impact on standard functionality.

Table Elements and Sections in the Sales Stage XML File

Description	Element or Section
The <SalesStage> section contains all of the information for a single sales stage: <SalesCategoryName> contains the name of the sales category that the sales stage is associated with. <SalesCategoryBaseName> contains the language-independent name of the sales category that the sales stage is associated with. <Probability> contains the default probability for the sales stage. <SalesProcessBaseName> contains the language-independent name of the sales process that the sales stage is associated with. <BaseName> contains the language-independent name of the sales stage. <Name> contains the name of the sales stage. <Description> contains the description of the sales stage. <Order> indicates the sequence of the sales stage as it appears in the picklist. <Status> contains the status of the sales stage. <BaseDescription> contains the language-independent description of the sales stage. <Language> contains the three-letter code for the language. <SalesProcessName> contains the name of the sales process that the sales stage is associated with.	<data:SalesStage> <data:SalesCategoryName>Leads Category</data:SalesCategoryName> <data:SalesCategoryBaseName>Leads Category</data:SalesCategoryBaseName> <data:Probability>30</data:Probability> <data:SalesProcessBaseName>High Potential</data:SalesProcessBaseName> <data:BaseName>Short List</data:BaseName> <data:Name>Short List</data:Name> <data:Description>Looking for the Right Characteristics</data:Description> <data:Order>1</data:Order> <data:Status>Open</data:Status> <data:BaseDescription>Looking for the Right Characteristics </data:BaseDescription> <data:Language>ENU</data:Language> <data:SalesProcessName>High Potential</data:SalesProcessName> . . . </data:SalesStage>
The <ListOfProcessCoach> section contains the details of the process coach steps.	<data:SalesStage> . . . <data:ListOfProcessCoach> . . . </data:ListOfProcessCoach> . . . </data:SalesStage>
The <ProcessCoach> section contains the details of a single process coach step: <BaseTitle> contains the language-independent title of the process coach step. <Order> contains the sequence of the process coach step as it appears in the picklist. <BaseDescription> contains the language-independent description of the process coach step. <Language> contains the three-letter code for the language. <Title> contains the title of the process coach step. <Description> contains the description of the process coach step. <StepName> contains the name of the process coach step.	<data:SalesStage> <data:ListOfProcessCoach> <data:ProcessCoach> <data:BaseTitle></data:BaseTitle> <data:Order>1</data:Order> <data:BaseDescription>Send first letter to the opportunity</data:BaseDescription> <data:Language>ENU</data:Language> <data:Title></data:Title> <data:Description>Send first letter to the opportunity</data:Description> <data:StepName>Step 1</data:StepName> </data:ProcessCoach> . . . </data:ListOfProcessCoach> . . . </data:SalesStage>
The <ListOfAutomatedTask> section contains the details of the automated tasks associated with sales stage.	<data:SalesStage> . . . <data:ListOfAutomatedTask> . . . </data:ListOfAutomatedTask> . . . </data:SalesStage>
The <AutomatedTask> element contains the details of a single automated task. There is a child element for each field that is available to be added to a task Detail page, including custom fields. For information about the task fields, see Oracle Web Services On Demand Guide.	<data:SalesStage> . . . <data:ListOfAutomatedTask> <data:AutomatedTask> . . . </data:AutomatedTask> . . . </data:ListOfAutomatedTask> . . . </data:SalesStage>
The <ListOfTranslation> section contains the translation values for the sales stage for each language activated for your company.	<data:SalesStage> . . . <data:ListOfTranslation> . . . </data:ListOfTranslation> </data:SalesStage>
The <Translation> section contains the translation of the sales stage for one language: <Description> contains the translated description of the sales stage in the language identified by the language code. <Language> contains the three-letter code for the translation language. <Name> contains the translation of the name of the sales stage in the language identified by the language code.	<data:SalesStage> . . . <data:ListOfTranslation> <data:Translation> <data:Description></data:Description> <data:Language></data:Language> <data:Name></data:Name> </data:Translation> . . . </data:ListOfTranslation> </data:SalesStage>
The <ListOfProcessCoachTranslation> section contains the translation values for the process coach step for each language activated for your company.	<data:SalesStage> . . . <data:ListOfProcessCoachTranslation> . . . </data:ListOfProcessCoachTranslation> . . . </data:SalesStage>
The <ProcessCoachTranslation> section contains the translation of the process coach step for one language: <Language> contains the three-letter code for the translation language. <Title> contains the title of the process coach step in the language identified by the language code. <Instruction> contains the description of the process coach step in the language identified by the language code. <ProcessCoachName> contains the translation of the name of the process coach step in the language identified by the language code.	<data:SalesStage> . . . <data:ListOfProcessCoachTranslation> <data:ProcessCoachTranslation> <data:Language>ENU</data:Language> <data:Title>Short List</data:Title> <data:Instruction>Send first letter to the opportunity</data:Instruction> <data:ProcessCoachName>Step 1</data:ProcessCoachName> . . . </data:ProcessCoachTranslation> . . . </data:ListOfProcessCoachTranslation> . . . </data:SalesStage>
The <ListOfAttachment> section contains the details of the attachments associated with sales stage.	<data:SalesStage> . . . <data:ListOfAttachment> . . . </data:ListOfAttachment> . . . </data:SalesStage>
The <Attachment> section contains the details of a single attachment: <AttachmentTag> indicates whether the attachment is a file or a URL. <FileExtension> contains the file extension of the attachment, if the attachment is a file. <DisplayFileName> contains the display name for the attachment. <FileDate> contains the date the file was uploaded, if the attachment is a file. <Description> contains the description of the attachment. <FileSize> contains the size of the file in KB, if the attachment is a file. <FileNameOrURL> contains the name of the file or the URL string. <Attachment> contains the content of the file, if the attachment is a file. Note: When you extract sales stage information, the content of any attached files is included in the sales stage XML file, encoded as inline Base64 encoded data. For more information about file attachments, see Oracle Web Services On Demand Guide.	<data:SalesStage> <data:ListOfAttachment> <data:Attachment> <data:AttachmentTag>URL</data:AttachmentTag> <data:FileExtension></data:FileExtension> <data:DisplayFileName>Click here</data:DisplayFileName> <data:FileDate></data:FileDate> <data:Description></data:Description> <data:FileSize></data:StepName> <data:FileNameOrURL>www.example.com</data:FileNameOrURL> <data:Attachment></data:Attachment> </data:Attachment> . . . </data:ListOfAttachment> . . . </data:SalesStage>
The <ListOfAutomatedTaskTranslation> section contains the translation values for the automated tasks for each language activated for your company.	<data:SalesStage> . . . <data:ListOfAutomatedTaskTranslation> . . . </data:ListOfAutomatedTaskTranslation> . . . </data:SalesStage>
The <AutomatedTaskTranslation> section contains the translation of the process coach step for one language: <Subject> contains the translation of the subject of the task in the language identified by the language code. <Language> contains the three-letter code for the translation language. <TaskExternalSystemId> contains the unique external ID of the task. <TaskIntegrationId> contains the integration ID of the task. <Comments> contains the translation of the description of the task in the language identified by the language code.	<data:SalesStage> . . . <data:ListOfAutomatedTaskTranslation> <data:AutomatedTaskTranslation> <data:Subject></data:Subject> <data:Language></data:Language> <data:TaskExternalSystemId></data:TaskExternalSystemId> <data:TaskIntegrationId></data:TaskIntegrationId> <data:Comments></data:Comments> </data:AutomatedTaskTranslation> . . . </data:ListOfAutomatedTaskTranslation> . . . </data:SalesStage>
The <ListOfRequiredField> section contains the details of the required fiels for the sales stage.	<data:SalesStage> . . . <data:ListOfRequiredField> . . . </data:ListOfRequiredField> . . . </data:SalesStage>
The <RequiredField> section contains the details of a single required field: <DefaultValue> contains the default value for the field. <FieldName> contains the name of the field. <TagName> contains the integration tag for the field.	<data:SalesStage> . . . <data:ListOfRequiredField> <data:RequiredField> <data:DefaultValue>Not specified</data:DefaultValue> <data:FieldName>Approver Alias</data:FieldName> <data:TagName>Approver</data:TagName> </data:RequiredField> . . . </data:ListOfRequiredField> </data:SalesStage>

Migrating Sales Stages

The following topics describe how to use the Oracle Migration Tool On Demand client to migrate sales stages:

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

Extracting a Single Sales Stage

This topic describes how to extract a single sales stage from your Oracle CRM On Demand environment.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract a sales stage:

migrationtool -u UserID -s ServerURL Read SalesStage BaseName SalesProcessBaseName

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.
BaseName is the language-independent name of the sales stage.

If the language-independent name of the sales stage contains any spaces or special characters, such as brackets, then it must be enclosed with quotation marks.
SalesProcessBaseName is the language-independent name of the sales process that the sales stage is associated with.

If the language-independent name of the sales process contains any spaces or special characters, such as brackets, then it must be enclosed with quotation marks.

The output XML file is named with the language-independent name of the sales stage, and it is saved in the following directory:

...\repository\SalesStage\SalesProcessBaseName

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 a Single Sales Stage

The following is an example of extracting a sales stage named Short List:

migrationtool -u UserID -s ServerURL Read SalesStage "Short List" "[High Potential]"

Extracting All Sales Stages

This topic describes how to extract all of the sales stages from your Oracle CRM On Demand environment.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to extract all of the sales stages:

migrationtool -u UserID -s ServerURL ReadAll SalesStage

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 (using the pipe command) to the client program from standard input; that is, from a file, from the command line, or from another program.

Updating or Inserting a Sales Stage

This topic describes how to update a sales stage (if it exists) or insert a sales stage (if it does not exist) on your Oracle CRM On Demand environment (customer test environment or production).

About the Upsert Operation

The Upsert command inserts or updates sales stages based on the user key: BaseName (the language-independent name of the sales stage) and SalesProcessBaseName (the language-independent name of the sales process).

Oracle CRM On Demand attempts to locate the sales stage specified in the input file based on the user key. If a match is located, then the sales stage is updated. If Oracle CRM On Demand cannot locate a sales stage based on the user key, then a new sales stage is created.

Syntax

The following is the syntax for using the Oracle Migration Tool On Demand client to insert or update a sales stage:

migrationtool -u UserID -s ServerURL Upsert SalesStage SalesStageXML

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.
SalesStageXML is the fully qualified path name of the sales stage XML file, for example:
```
C:\My Files\Short List.xml
```
If the fully qualified path name contains any spaces or special characters, such as brackets, then it must be enclosed with quotation marks, for example:
```
migrationtool -u UserID -s ServerURL Upsert SalesStage "C:\My Files\[High Potential]\Short List.xml"
```

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 Updating or Inserting a Sales Stage

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

migrationtool -u UserID -s ServerURL Upsert SalesStage "C:\Oracle Migration Tool On Demand\windows\repository\SalesStage\[High Potential]\Short List.xml"