Skip to content

Latest commit

 

History

History
394 lines (202 loc) · 8.02 KB

opportunity-details.schema.md

File metadata and controls

394 lines (202 loc) · 8.02 KB
Raw

XDM Business Opportunity Details Schema

https://ns.adobe.com/xdm/mixins/opportunity-details

Captures and maintains additional opportunity attributes that are used by industry crm systems.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted fieldgroups/opportunity/opportunity-details.schema.json

Schema Hierarchy

  • XDM Business Opportunity Details https://ns.adobe.com/xdm/mixins/opportunity-details
    • B2B Source https://ns.adobe.com/xdm/datatypes/b2b-source
    • Currency https://ns.adobe.com/xdm/datatypes/currency

XDM Business Opportunity Details Example

{}

XDM Business Opportunity Details Properties

Property Type Required Default Defined by
xdm:actualCloseDate string Optional XDM Business Opportunity Details (this schema)
xdm:campaignID string Optional XDM Business Opportunity Details (this schema)
xdm:campaignKey B2B Source Optional XDM Business Opportunity Details (this schema)
xdm:expectedCloseDate string Optional XDM Business Opportunity Details (this schema)
xdm:expectedRevenue Currency Optional XDM Business Opportunity Details (this schema)
xdm:fiscalQuarter string Optional XDM Business Opportunity Details (this schema)
xdm:fiscalYear integer Optional XDM Business Opportunity Details (this schema)
xdm:forecastCategory string Optional XDM Business Opportunity Details (this schema)
xdm:forecastCategoryName string Optional XDM Business Opportunity Details (this schema)
xdm:isClosed boolean Optional XDM Business Opportunity Details (this schema)
xdm:isWon boolean Optional XDM Business Opportunity Details (this schema)
xdm:lastActivityDate string Optional XDM Business Opportunity Details (this schema)
xdm:leadSource string Optional XDM Business Opportunity Details (this schema)
xdm:nextStep string Optional XDM Business Opportunity Details (this schema)
xdm:opportunityAmount Currency Optional XDM Business Opportunity Details (this schema)
xdm:opportunityQuantity integer Optional 0 XDM Business Opportunity Details (this schema)
xdm:probabilityPercentage number Optional XDM Business Opportunity Details (this schema)
* any Additional this schema allows additional properties

xdm:actualCloseDate

Actual Close Date

Actual date of closure for this opportunity.

xdm:actualCloseDate

  • is optional
  • type: string
  • defined in this schema

xdm:actualCloseDate Type

string

xdm:campaignID

Campaign ID

Campaign unique identifer reference.

xdm:campaignID

  • is optional
  • type: string
  • defined in this schema

xdm:campaignID Type

string

xdm:campaignKey

Campaign Key

Unique composite identifier of the Campaign.

xdm:campaignKey

  • is optional
  • type: B2B Source
  • defined in this schema

xdm:campaignKey Type

  • B2B Source – https://ns.adobe.com/xdm/datatypes/b2b-source

xdm:expectedCloseDate

Expected Close Date

Expected date of closure for this opportunity.

xdm:expectedCloseDate

  • is optional
  • type: string
  • defined in this schema

xdm:expectedCloseDate Type

string

xdm:expectedRevenue

Expected Revenue

Calculated revenue based on the Amount and Probability.

xdm:expectedRevenue

  • is optional
  • type: Currency
  • defined in this schema

xdm:expectedRevenue Type

  • Currency – https://ns.adobe.com/xdm/datatypes/currency

xdm:fiscalQuarter

Fiscal Quarter

The fiscal quarter this opportunity is targeted.

xdm:fiscalQuarter

  • is optional
  • type: string
  • defined in this schema

xdm:fiscalQuarter Type

string

All instances must conform to this regular expression (test examples here):

^([1-4]{1})$|^([Qq][1-4]{1})$

xdm:fiscalYear

Fiscal Year

The fiscal year this opportunity is targeted.

xdm:fiscalYear

  • is optional
  • type: integer
  • defined in this schema

xdm:fiscalYear Type

integer

xdm:forecastCategory

Forecast Category

Forecast Category determined by the opportunity Stage value eg: omitted,pipeline,bestcase,commit,closed.

xdm:forecastCategory

  • is optional
  • type: string
  • defined in this schema

xdm:forecastCategory Type

string

xdm:forecastCategoryName

Forecast Category Name

Forecast category name that is displayed in reports for a perticular forecast category.

xdm:forecastCategoryName

  • is optional
  • type: string
  • defined in this schema

xdm:forecastCategoryName Type

string

xdm:isClosed

Closed Flag

Flag indicating if this opportunity is closed.

xdm:isClosed

  • is optional
  • type: boolean
  • defined in this schema

xdm:isClosed Type

boolean

xdm:isWon

Won Flag

Flag indicating if this opportunity is Won.

xdm:isWon

  • is optional
  • type: boolean
  • defined in this schema

xdm:isWon Type

boolean

xdm:lastActivityDate

Last Activity Date

Last activity date for this opportunity.

xdm:lastActivityDate

  • is optional
  • type: string
  • defined in this schema

xdm:lastActivityDate Type

string

xdm:leadSource

Lead Source

Source of the opportunity such as Advertisement, Partner, or Web.

xdm:leadSource

  • is optional
  • type: string
  • defined in this schema

xdm:leadSource Type

string

xdm:nextStep

Next Step

Description of next task in closing opportunity.

xdm:nextStep

  • is optional
  • type: string
  • defined in this schema

xdm:nextStep Type

string

xdm:opportunityAmount

Opportunity Amount

Estimated total sale amount.

xdm:opportunityAmount

  • is optional
  • type: Currency
  • defined in this schema

xdm:opportunityAmount Type

  • Currency – https://ns.adobe.com/xdm/datatypes/currency

xdm:opportunityQuantity

Opportunity Quantity

Total of all quantity field values for all products in the Products related list for this opportunity.

xdm:opportunityQuantity

  • is optional
  • type: integer
  • default: 0
  • defined in this schema

xdm:opportunityQuantity Type

integer

  • minimum value: 0

xdm:probabilityPercentage

Probability Percentage

Likelihood that opportunity will close, stated as a percentage.

xdm:probabilityPercentage

  • is optional
  • type: number
  • defined in this schema

xdm:probabilityPercentage Type

number

  • minimum value: 0
  • maximum value: 100