Getting Started

This page provides a guide to Establishing a Connection to Oracle Sales in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Oracle Sales

Establishing a Connection shows how to authenticate to Oracle Sales and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Oracle Sales through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to Oracle Sales by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Oracle Sales uses Basic authentication over SSL; after setting the following connection properties, you are ready to connect:

Username: Set this to the user name that you use to log into your Oracle Cloud service.
Password: Set this to your password.
HostURL: Set this to the Web address (URL) of your Oracle Cloud service.

Custom Fields and Objects

Schemas for standard Oracle Sales tables are internally stored in CData Cloud and used to minimize the amount of sent requests and payload received. By default, CData Cloud will use these tables and not expose any of your instance's custom objects. While custom fields are exposed since IncludeCustomFields defaults to true.

The CData Cloud supports dynamically retrieving schemas for objects and custom fields from within your Oracle Sales specific instance by following the steps described below.

Including Custom Fields

In case your schema needs to include custom fields (columns) added to Oracle Sales standard objects (tables), you can use the IncludeCustomFields connection property. Setting this property to true will result in one or more extra calls being issued and will affect CData Cloud behavior in the following ways:

Custom fields will be retrieved and listed along with the rest of the columns in your schema.
All internally stored columns will be replaced with dynamically generated columns based on the latest API version.

Set IncludeCustomFields to false to improve performance.

Including Custom Objects

In case you need to access custom objects (tables), created to your Oracle Sales instance, you can use the IncludeCustomObjects connection property. By default, this property is set to false, and when queries are attempted on custom objects, they will fail to execute due to the internal schema being used. Similarly to IncludeCustomFields, setting this property to true, will issue one or more extra requests.

Generating Schema Files

If you need to regularly work with custom fields and/or custom objects, you can use the GenerateSchemaFiles connection property to store locally a dynamically generated schema and avoid constantly using IncludeCustomFields and IncludeCustomObjects, which in return will decrease execution time and payload.

Note: Setting GenerateSchemaFiles=OnStart/OnUse alone, will only generate a schema containing custom fields for all standard tables but not any custom tables. Using GenerateSchemaFiles combined with IncludeCustomObjects enables you to generate a schema containing both custom fields and objects.

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The CData Cloud models the Oracle Sales objects as relational tables. Tables support both retrieving and updating data.

You can work with all the tables in your account. The Cloud connects to Oracle Sales and gets the list of tables and the metadata for the tables by calling the appropriate Web services. Any changes you make to your Oracle Sales account, such as adding a new table, adding new columns, or changing the data type of a column, will immediately be reflected when you use the Cloud to connect.

Tables

Oracle Sales objects have relationships to other objects; in the tables, these relationships are expressed through foreign keys. Oracle Sales objects are also part of an application that the account contains. For example, the table Opportunities represents the Opportunity object, which is part of the Sales application.

Tables

The Cloud models the data in Oracle Sales as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Oracle Sales Tables


Name	Description
AccountAddresses	The address resource is used to view, create, and update addresses of an account. An address represents the location information of an account.
AccountAddressPurposes	The address purpose resource is used to view, create, or modify the address purpose. The address purpose describes the use of an address, such as shipping address or billing address.
AccountNotes	The note resource is used to capture comments, information, or instructions for an account.
AccountPrimaryAddresses	The primary address resource is used to view, create, and update primary address of an account. A primary address is the default communication address of an account.
AccountRelationships	The relationship resource is used to view, create, and update account relationships.
AccountResources	The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.
Accounts	The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.
Activities	Table to capture task and appointment information.
ActivityAssignees	Table used to capture the assignees/resources associated to the activity.
ActivityContacts	Table used to capture the contacts associated to the activity.
ActivityNotes	Note data objects that capture comments, information or instructions for an Oracle Fusion Applications business object.
ActivityObjectives	Table used to capture the objectives associated to the activity.
ContactAddresses	Table that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.
ContactAddressPurposes	The address purpose resource is used to view, create, or modify the address purpose. The address purpose describes the use of an address, such as shipping address or billing address.
ContactNotes	The note resource is used to capture comments, information, or instructions for a contact.
ContactPrimaryAddresses	The primary address resource is used to view, create, or modify a primary address of a contact. A primary address is the default communication address of an entity.
ContactRelationships	The relationship resource includes attributes that are used to store values while viewing, creating, or updating a relationship.
Contacts	Table resource items include attributes used to store values while creating or updating a contact.
ContactSalesAccountResources	The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.
EmployeeResourceAttachments	The contact picture attachment resource is used to view, create, and update the resource's picture.Get a resource's picture
EmployeeResources	The resources resoure is used to view, create, and update a resource. A resource is a person within the deploying company who can be assigned work to accomplish business objectives, such as sales persons or partner members.
Opportunities	The opportunity competitor resource is used to view, create, and update the competitors for an opportunity. The opportunity competitors is used to store information about the competitors associated with the opportunity.
OpportunityCompetitors	The opportunity competitor resource is used to view, create, and update the competitors for an opportunity. The opportunity competitors is used to store information about the competitors associated with the opportunity.
OpportunityContacts	The opportunity contact resource is used to view, create, and update the contacts of an opportunity.The contact associated with the opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.
OpportunityDeals	A deal associated with the opportunity.
OpportunityLeads	The opportunity lead resource is used to view, create, and update the lead that resulted in an opportunity.
OpportunityNotes	The note resource is used to capture comments, information, or instructions for an opportunity.
OpportunityPartners	The opportunity partner resource is used to view, create, and update the partners associated with this opportunity.The opportunity partner is used to store information about partners who are contributing to the selling effort of the current opportunity.
OpportunityRevenueItems	The revenue items resource is used to view, create, and update revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing. You add revenue items by selecting a product group or product to associate with an opportunity.
OpportunityRevenueProductGroups	The product group resource is used to view, create, and update the product groups associated with an opportunity. The product group let you categorize products and services that you sell.
OpportunityRevenueProducts	The following table describes the default response for this task.
OpportunityRevenueTerritories	The opportunity revenue territories resource is used to view, create, and update the revenue territories of an opportunity. The territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.
OpportunitySources	The opportunity source resource is used to view, create, and update the source of an opportunity.The opportunity source is used to capture the marketing or sales campaign that resulted in this opportunity.
OpportunityTeamMembers	The opportunity team members resource is used to view, create, and update the team members associated with an opportunity. The opportunity team member of the deploying organization associated with the opportunity.
Territories	The sales territories resource represents the list of sales territories that the logged-in user can view. A sales territory is an organizational domain with boundaries defined by attributes of customers, products, services, resources, and so on. Sales territories can be created based on multiple criteria including postal code, area code, country, vertical market, size of company, product expertise, and geographical location. Sales territories form the fundamental infrastructure of sales management as they define the jurisdiction that salespeople have over sales accounts, or the jurisdiction that channel sales managers have over partners and partner transactions.

AccountAddresses

The address resource is used to view, create, and update addresses of an account. An address represents the location information of an account.

Columns


Name	Type	ReadOnly	References	Description
AddressNumber [KEY]	String	False		This is the primary key of the addresses table.
PartyNumber [KEY]	String	False	Accounts.PartyNumber	The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
AddrElementAttribute1	String	False		An additional address element to support flexible address format.
AddrElementAttribute2	String	False		An additional address element to support flexible address format.
AddrElementAttribute3	String	False		An additional address element to support flexible address format.
AddrElementAttribute4	String	False		An additional address element to support flexible address format.
AddrElementAttribute5	String	False		An additional address element to support flexible address format.
Address1	String	False		The first line for address.
Address2	String	False		The second line for address.
Address3	String	False		The third line for address.
Address4	String	False		The fourth line for address.
AddressId	Long	False		The unique identifier of the address.
AddressLinesPhonetic	String	False		The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
Building	String	False		The building name or number in the address.
City	String	False		The city in the address.
ClliCode	String	False		The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address.
Comments	String	False		The user-provided comments for the address.
CorpCurrencyCode	String	False		The corporate currency code used by the CRM Extensibility framework.
Country	String	False		The country code of the address. Review the list of country codes using the Manage Geographies task.
CreatedBy	String	False		The user who created the account record.
CreatedByModule	String	False		The module that created the account record.
CreationDate	Datetime	False		The date when the record was created.
CurcyConvRateType	String	False		The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
CurrencyCode	String	False		The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
DateValidated	Datetime	False		The date when the address was last validated.
Description	String	False		The description of the location.
DoNotMailFlag	Boolean	False		Indicates whether the address should not be used for mailing.
EffectiveDate	Datetime	False		The date when the address becomes active.
EndDateActive	Datetime	False		The date after which the address becomes inactive.
FloorNumber	String	False		The floor number of the address.
FormattedAddress	String	False		The formatted version of the address.
FormattedMultilineAddress	String	False		The formatted multiline version of the address.
HouseType	String	False		Indicates the building type for the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
Latitude	Long	False		The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
LocationDirections	String	False		The directions to the address location.
LocationId	Long	False		The unique identifier for the location.
Longitude	Long	False		The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
Mailstop	String	False		The user-defined code that indicates a mail drop point within the organization.
ObjectVersionNumber	Integer	False		The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
PartyId	Long	False		The unique identifier of the account associated with the address.
PartySourceSystem	String	False		The name of external source system where the account, associated with the address, party is imported from. The values configured in setup task Trading Community Source System.
PartySourceSystemReferenceValue	String	False		The unique identifier for the account, associated with the address, from the external source system specified in the attribute PartySourceSystem.
PostalCode	String	False		The postal code of the address.
PostalPlus4Code	String	False		The four-digit extension to the United States Postal ZIP code for the address.
PrimaryFlag	Boolean	False		Indicates whether this is the primary address of the account. If the value is Y, this address is the primary address of the account. The default value is N.
Province	String	False		The province of the address.
SourceSystem	String	False		The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
SourceSystemReferenceValue	String	False		The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
StartDateActive	Datetime	False		The date when the address becomes active.
State	String	False		The state of the address.
Status	String	False		The internal flag indicating status of the address. The status codes are defined by the lookup HZ_STATUS.
ValidatedFlag	Boolean	False		Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
ValidationStartDate	Datetime	False		The date when the validation becomes active. The value is internally set by system during address cleansing.
ValidationStatusCode	String	False		A standardized status code describing the results of the validation. The value is internally set by system during address cleansing.

AccountAddressPurposes

The address purpose resource is used to view, create, or modify the address purpose. The address purpose describes the use of an address, such as shipping address or billing address.

Columns


Name	Type	ReadOnly	References	Description
AddressPurposeId [KEY]	Long	False		This is the primary key of the address purpose table.
PartyNumber [KEY]	String	False	Accounts.PartyNumber
AddressNumber [KEY]	String	False	AccountAddresses.AddressNumber
DeleteFlag	Boolean	False		Indicates whether the address purpose is to be deleted. If the value is Y, then the address purpose has to be deleted. The default value is N.
Purpose	String	False		The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.

AccountNotes

The note resource is used to capture comments, information, or instructions for an account.

Columns


Name	Type	ReadOnly	References	Description
NoteId [KEY]	Long	False		This is the primary key of the notes table.
PartyNumber [KEY]	String	False	Accounts.PartyNumber	The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
ContactRelationshipId	Long	False		The relationship ID populated when the note is associated with a contact.
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile.
CreatedBy	String	False		Indicates the user who created the row.
CreationDate	Datetime	False		Indicates the date and time of the creation of the row.
CreatorPartyId	Long	False		This is Party Id for the Note Creator.
CurcyConvRateType	String	False		Holds Currency Conversion Rate Type from profile.
CurrencyCode	String	False		Holds currency code of a record.
LastUpdateDate	Datetime	False		Indicates the date and time of the last update of the row.
NoteTxt	String	False		This is the column which will store the actual note text.
NoteTypeCode	String	False		This is the note type code for categorization of note.
PartyId	Long	False		Party identifier.
PartyName	String	False		Name of this party.
SourceObjectCode	String	False		This is the source_object_code for the source object as defined in OBJECTS Metadata.
SourceObjectId	String	False		This is the source_object_Uid for the source object (such as Activities, Opportunities etc) as defined in OBJECTS Metadata.
VisibilityCode	String	False		This is the attribute to specify the visibility level of the note.

AccountPrimaryAddresses

The primary address resource is used to view, create, and update primary address of an account. A primary address is the default communication address of an account.

Columns


Name	Type	ReadOnly	References	Description
AddressNumber [KEY]	String	False		This is the primary key of the primary addresses table.
PartyNumber [KEY]	String	False	Accounts.PartyNumber
AddressElementAttribute1	String	False		An additional address element to support flexible address format.
AddressElementAttribute2	String	False		An additional address element to support flexible address format.
AddressElementAttribute3	String	False		An additional address element to support flexible address format.
AddressElementAttribute4	String	False		An additional address element to support flexible address format.
AddressElementAttribute5	String	False		An additional address element to support flexible address format.
AddressId	Long	False		The unique identifier of the primary address.
AddressLine1	String	False		The first line of the primary address.
AddressLine2	String	False		The second line of the primary address.
AddressLine3	String	False		The third line of the primary address.
AddressLine4	String	False		The fourth line of the primary address.
AddressLinesPhonetic	String	False		The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan.
Building	String	False		The building name or number in the primary address.
City	String	False		The building name or number in the primary address.
Comments	String	False		The user-provided comments for the primary address.
CorpCurrencyCode	String	False		The corporate currency code used by the CRM Extensibility framework.
Country	String	False		The country code of the primary address. Review the list of country codes using the Manage Geographies task.
County	String	False		The county of the primary address.
CreatedBy	String	False		The user who created the primary address record.
CreationDate	Datetime	False		The date when the record was created.
CurcyConvRateType	String	False		The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
CurrencyCode	String	False		The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
DateValidated	Datetime	False		The date when the primary address was last validated.
DeleteFlag	Boolean	False		Indicates whether the primary address is to be deleted. If the value is Y, then the primary address has to be deleted. The default value is N.
Description	String	False		The description of the location.
FloorNumber	String	False		The floor number of the primary address.
FormattedAddress	String	False		The formatted version of the primary address.
FormattedMultiLineAddress	String	False		The formatted multiline version of the primary address.
HouseType	String	False		Indicates the building type for the building in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
Latitude	Long	False		The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes.
LocationDirections	String	False		The directions to the address location.
LocationId	Long	False		The unique identifier for the location.
Longitude	Long	False		The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes.
Mailstop	String	False		The user-defined code that indicates a mail drop point within the organization.
PartyId	Long	False		The unique identifier of the account associated with the address.
PostalCode	String	False		The postal code of the address.
PostalPlus4Code	String	False		The four-digit extension to the United States Postal ZIP code for the address.
Province	String	False		The province of the address.
SourceSystem	String	False		The name of external source system where the address is imported from. The values configured in setup task Trading Community Source System.
SourceSystemReferenceValue	String	False		The unique identifier for the address from the external source system specified in the attribute PartySourceSystem.
State	String	False		The state of the address.
ValidatedFlag	Boolean	False		Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
ValidationStatusCode	String	False		A standardized status code describing the results of the validation. The value is internally set by system during address cleansing.

AccountRelationships

The relationship resource is used to view, create, and update account relationships.

Columns


Name	Type	ReadOnly	References	Description
RelationshipRecId [KEY]	Long	False		This is the primary key of the relationships table.
PartyNumber [KEY]	String	False	Accounts.PartyNumber
Comments	String	False		The user-provided comments for the relationship.
CreatedBy	String	False		The user who created the record.
CreatedByModule	String	False		The module that created the account record.
CreationDate	Datetime	False		The date when the record was created.
EndDate	Datetime	False		The date when the relationship ends.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
ObjectPartyId	Long	False		The unique identifier of the object party in this relationship.
ObjectPartyNumber	String	False		The alternate key identifier for the object party of the relationship.
ObjectSourceSystem	String	False		The name of the external source system for the object party in the relationship.
ObjectSourceSystemReferenceValue	String	False		The identifier for the object party in the relationship from the external source system.
RelationshipCode	String	False		The code of the relationship that specifies if this is a forward or a backward relationship code. A list of valid relationship codes is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.
RelationshipSourceSystem	String	False		The name of external source system where the relationship is imported from. The values configured in setup task Trading Community Source System.
RelationshipSourceSystemReferenceValue	String	False		The unique identifier for the relationship from the external source system specified in the attribute RelationshipSourceSystem.
RelationshipType	String	False		The relationship type such as CUSTOMER_SUPPLIER. A list of valid relationship types is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the codes using the Setup and Maintenance task, Manage Relationship Lookups.
StartDate	Datetime	False		The date when the relationship was created.
Status	String	False		Indicates if the relationship is active or inactive, such as A for active and I for inactive. A list of valid values is defined in the lookup HZ_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
SubjectPartyId	Long	False		The unique identifier of the subject party in this relationship.
SubjectPartyNumber	String	False		The alternate key identifier for the subject party of the relationship.
SubjectSourceSystem	String	False		The name of the external source system for the subject party in the relationship.
SubjectSourceSystemReferenceValue	String	False		The identifier for the subject party in the relationship from the external source system.

AccountResources

The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Columns


Name	Type	ReadOnly	References	Description
TeamMemberId [KEY]	Long	False		The surrogate primary key for the member of the sales account resource team.
PartyNumber [KEY]	String	False	Accounts.PartyNumber
AccessLevelCode	String	False		The access level determines the type of access granted to the resource as well as managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup.
AssignmentTypeCode	String	False		The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup.
CreatedBy	String	False		The user who created the record.
CreationDate	Datetime	False		The date and time the record was created.
EndDateActive	Datetime	False		Indicates the date on which the association of resource is ended to the sales account.
LastUpdatedBy	String	False		The date on which the record is last updated.
LastUpdateLogin	String	False		The user who last updated the record.
LockAssignmentFlag	Boolean	False		The user login for the user who last updated the record.
MemberFunctionCode	String	False		The flag indicates automatic territory assignment cannot remove the sales account team resource when this flag is Y'. When a sales account team member is added manually, this flag is defaulted toY'. Otherwise,
ResourceEmailAddress	String	False		The lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS.
ResourceId	Long	False		Unique identifier for the resource
ResourceName	String	False		The name of the sales team member.
ResourceOrgName	String	False		The name of the organization that the sales team member belongs to.
ResourcePartyNumber	String	False		Unique identifier for the resource
ResourcePhoneNumber	String	False		The primary phone number of the sales team member.
ResourceRoleName	String	False		The roles assigned to the sales team member.
SalesProfileId	Long	False		The identifier for the sales account.
StartDateActive	Datetime	False		Indicates the date on which the association of resource is created to the sales account.
UserLastUpdateDate	Datetime	False		The date and time of the last update from mobile.

Accounts

The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Columns


Name	Type	ReadOnly	References	Description
PartyNumber [KEY]	String	False		The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
AnalysisFiscalYear	String	False		The fiscal year used as the source for financial information.
AssignmentExceptionFlag	Boolean	False		Indicates whether the sales account had the required dimensions to allow assignment manager to assign territories to the sales account. If the value is True, then the sales account has the dimensions. The default value is False.
BusinessReport	String	False		The Dun & Bradstreet business information report.
BusinessScope	String	False		The class of business to which the account belongs, such as local, national, or international.
CEOName	String	False		The name of the organization's chief executive officer.
CEOTitle	String	False		The formal title of the chief executive officer.
CertificationLevel	String	False		The certification level the organization. A list of valid certification level codes is defined using the lookup HZ_PARTY_CERT_LEVEL. Review the Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CertificationReasonCode	String	False		The reason for the contact's current certification level assignment. A list of valid certification reason codes are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
Comments	String	False		The corporate charter of the organization.
CongressionalDistrictCode	String	False		The U.S. Congressional district code for the account.
ControlYear	Long	False		The year when current ownership gained control of the organization.
CorpCurrencyCode	String	False		The corporate currency code associated with the account. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CorporationClass	String	False		The taxation classification for corporation entities such as Chapter S in the US.
CreatedBy	String	False		The user who created the account record.
CreatedByModule	String	False		The module that created the account record.
CreationDate	Datetime	False		The date when the record was created.
CurrencyCode	String	False		The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
CurrentFiscalYearPotentialRevenueAmount	Decimal	False		The estimated revenues that can be earned by the organization during its current fiscal year.
DeleteFlag	Boolean	False		Indicates if the account can be deleted.
DisadvantageIndicator	String	False		Indicates whether the organization is considered disadvantaged by the US government under Title 8A. If the value is Yes, the organization is considered disadvantaged under Title 8A. The default value is No.
DomesticUltimateDUNSNumber	String	False		The DUNS Number for the Domestic Ultimate. A Domestic Ultimate is the highest member of the same country in the organization's hierarchy. An organization can be its own Domestic Ultimate.
DoNotConfuseWith	String	False		Indicates that there is an organization that is similarly named.
DUNSCreditRating	String	False		The Dun & Bradstreet credit rating.
DUNSNumber	String	False		The DUNS Number in freeform text format. The value not restricted to nine digit number.
EmailAddress	String	False		The e-mail address of the contact point for the organization.
EmailFormat	String	False		The preferred format for e-mail addressed to this organization, such as HTML or ASCII.
EmployeesAtPrimaryAddress	String	False		The qualifier to calculate the estimated number of employees at the primary address. A list of valid qualifier codes are defined using the lookup EMP_AT_PRIMARY_ADR_EST_IND. Review and update the codes using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
EmployeesAtPrimaryAddressEstimation	String	False		The estimated minimum number of employees at the primary address. A list of accepted values are defined in the lookup type EMP_AT_PRIMARY_ADR_MIN_IND. Review and update the values using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
EmployeesAtPrimaryAddressMinimum	String	False		The qualifier to qualify calculation of employees at the primary address as minimum.
EmployeesAtPrimaryAddressText	String	False		The number of employees at the referenced address in text format.
EmployeesTotal	Lonjg	False		The total number of employees in the organization.
ExistingCustomerFlag	Boolean	False		Indicates if there is an existing selling or billing relationship with the sales account. If the value is true, then there is an existing relationship with the sales account. The default value is False.
ExistingCustomerFlagLastUpdateDate	Datetime	False		The date when the existing customer flag was last updated.
ExportIndicator	String	False		Indicates whether the organization is an exporter. If the value is Y, then the organization is an exporter. The default value is N.
FavoriteAccountFlag	Boolean	False		Indicates if the account is a favorite.
FaxAreaCode	String	False		The area code for the fax number.
FaxCountryCode	String	False		The international country code for a fax number, such as 33 for France.
FaxExtension	String	False		The extension to the fax number of the organization.
FaxNumber	String	False		The fax number of the organization in the local format. The number should not include area code, country code, or extension.
FiscalYearendMonth	String	False		The last month of a fiscal year for the organization. The list of accepted values is defined in the lookup type MONTH.
FormattedFaxNumber	String	False		The formatted phone number of the organization.
FormattedPhoneNumber	String	False		The formatted phone number of the organization.
GeneralServicesAdministrationFlag	Boolean	False		Indicates whether organization is a US federal agency supported by the General Services Administration (GSA). If the value is Y, then the organization is supported by GSA. The default value is N.
GlobalUltimateDUNSNumber	String	False		The DUNS Number for the Global Ultimate. A Global Ultimate is the highest member in the organization's hierarchy. An organization can be its own Global Ultimate.
GrowthStrategyDescription	String	False		The user-defined description of growth strategy.
HomeCountry	String	False		The home country of the organization.
HQBranchIndicator	String	False		The status of this site, such as HQ, a branch, or a single location. A list of accepted values are defined in the lookup type HQ_BRANCH_IND.
ImportIndicator	String	False		Indicates whether the organization is an importer. If the value is Y, then the organization is an importer. The default value is N.
IndustryCode	String	False		The Industry classification code. The classification codes are defined for every classification category as specified in IndustryCodeType attribute. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task.
IndustryCodeType	String	False		The industry classification category code type. It is defaulted to the value of profile option MOT_INDUSTRY_CLASS_CATEGORY. Review and update the codes using the Setup and Maintenance work area, Manage Classification Categories task.
LaborSurplusIndicator	String	False		Indicates whether the organization operates in an area with a labor surplus. If the value is Y, then the organization operates in an area with a labor surplus. The default value is N.
LastAssignmentDateTime	Datetime	False		The date when the Sales Account Territory Assignment was last run by Assignment Manager.
LastEnrichmentDate	Datetime	False		The date when the record was last enriched.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
LegalStatus	String	False		The legal structure of the organization such as partnership, corporation, and so on.
LineOfBusiness	String	False		The type of business activities performed at this site.
LocalActivityCode	String	False		The local activity classification code.
LocalActivityCodeType	String	False		The local activity classification code type identifier.
LocalBusinessIdentifier	String	False		The primary identifier assigned to a businesses by a government agency such as Chamber of Commerce, or other authority. It is often used by countries other than USA.
LocalBusinessIdentifierType	String	False		The lookup that represents most common business identifier in a country such as Chamber of Commerce Number in Italy, Government Registration Number in Taiwan. A list of accepted values are defined in the lookup type LOCAL_BUS_IDEN_TYPE.
MinorityOwnedIndicator	String	False		Indicates whether the organization is primarily owned by ethnic or racial minorities. If the value is Y, then the organization is owned by ethnic or racial minorities. company is primarily owned by ethnic or racial minorities. The default value is N.
MinorityOwnedType	String	False		The type of minority-owned firm.
MissionStatement	String	False		The corporate charter of organization in user-defined text format.
NamedFlag	Boolean	False		Indicates if the sales account is a named sales account. If the value is True, then the account is a named account. The default value is False.
NextFiscalYearPotentialRevenueAmount	Decimal	False		The estimated revenue of the organization to be earned during its next fiscal year.
OrganizationName	String	False		The name of the account.
OrganizationSize	String	False		The size of the organization based on its revenue, number of employees, and so on.
OrganizationType	String	False		The type of the organization.
OutOfBusinessIndicator	String	False		Indicates whether the organization is out of business. If the value is Y, then the organization is out of business. The default value is N.
OwnerEmailAddress	String	False		The e-mail address of the employee resource that owns and manages the sales account. The owner is a valid employee resource defined within Sales Cloud.
OwnerName	String	False		The name of the employee resource that owns and manages the sales account.
OwnerPartyId	Long	False		The unique identifier of a valid employee resource who owns and manages the sales account.
OwnerPartyNumber	String	False		The party number of a valid employee resource who owns and manages the sales account.
ParentAccountName	String	False		The name of the parent account in the hierarchy.
ParentAccountPartyId	Long	False		The party Id of the parent account within the hierarchy. To assign a parent account to a sales account, you must provide the parent account's party ID, party number, or source system reference.
ParentAccountPartyNumber	String	False		The party number of the parent account within the hierarchy.
ParentAccountSourceSystem	String	False		The source system of the parent account within the hierarchy.
ParentAccountSourceSystemReferenceValue	String	False		The source system reference of the parent account within the hierarchy.
ParentDUNSNumber	String	False		The DUNS Number of the organization or the parent entity that owns a majority stake of the organization's capital stock. The parent entity can be a subsidiary of another corporation. If the parent also has branches, then it is regarded as headquarters as well as a parent company.A headquarters is a business establishment that has branches or divisions reporting to it, and is financially responsible for those branches or divisions. If the headquarters has more than 50% of capital stock owned by another corporation, it also will be a subsidiary. If it owns more than 50% of capital stock of another corporation, then it is also a parent.
ParentOrSubsidiaryIndicator	String	False		Title:
PartyId	Long	False		Title:
PartyStatus	String	False		Title:
PartyUniqueName	String	False		Title:
PhoneAreaCode	String	False		Title:
PhoneCountryCode	String	False		Title:
PhoneExtension	String	False		Title:
PhoneNumber	String	False		Title:
PreferredContactMethod	String	False		Title:
PreferredFunctionalCurrency	String	False		Title:
PrimaryContactEmail	String	False		Title:
PrimaryContactName	String	False		Title:
PrimaryContactPartyId	Long	False		Title:
PrimaryContactPartyNumber	String	False		Title:
PrimaryContactPhone	String	False		Title:
PrimaryContactSourceSystem	String	False		Title:
PrimaryContactSourceSystemReferenceValue	String	False		Title:
PrincipalName	String	False		Title:
PrincipalTitle	String	False		Title:
PublicPrivateOwnershipFlag	Boolean	False		Title:
RecordSet	String	False		Title:
RegistrationType	String	False		Title:
RentOrOwnIndicator	String	False		Title:
SalesProfileStatus	String	False		Title:
SmallBusinessIndicator	String	False		Indicates whether the organization is considered as a small business. If the value is Y, then the organization is considered as a small business. The default value is N.
SourceSystem	String	False		The name of external source system where the account party is imported from. The values configured in setup task Trading Community Source System.
SourceSystemReferenceValue	String	False		The unique identifier for the account party from the external source system specified in the attribute SourceSystem.
StockSymbol	String	False		The corporate stock symbol of the organization as listed in stock exchanges.
TaxpayerIdentificationNumber	String	False		The taxpayer identification number that is often a unique identifier of the organization, such as income taxpayer Id in USA and fiscal code or NIF in Europe.
TotalEmployeesEstimatedIndicator	String	False		Indicates if the employee total is estimated. The accepted values are defined in the lookup type TOTAL_EMP_EST_IND.
TotalEmployeesIndicator	String	False		Indicates if subsidiaries are included in the calculation of total employees. The accepted values are defined in the lookup type TOTAL_EMPLOYEES_INDICATOR.
TotalEmployeesMinimumIndicator	String	False		Indicates if the number is a minimum, maximum, or average number of total employees. The accepted values are defined in the lookup type TOTAL_EMP_MIN_IND.
TotalEmployeesText	String	False		The total number of employees in text format.
Type	String	False		The account type that defines if the account is a sales account or a prospect or any other party type. The accepted values are defined in the lookup type ZCA_ACCOUNT_TYPE. It is defaulted to ZCA_CUSTOMER if no value is provided.
UniqueNameSuffix	String	False		The suffix used to generate the attribute PartyUniqueName. The suffix is concatenated to the OrganizationName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix.
UpdateFlag	Boolean	False		Indicates if the record can be updated.
URL	String	False
WomanOwnedIndicator	String	False		Indicates whether the organization is primarily owned by women. If the value is Y, then the organization is primarily owned by women. The default value is N.
YearEstablished	Int	False		The year that the organization started it business operations.
YearIncorporated	Int	False		The year that the business was formally incorporated.

Activities

Table to capture task and appointment information.

Columns


Name	Type	ReadOnly	References	Description
ActivityNumber [KEY]	String	False		System generated or can come from external system (user key).
ActivityId	Long	True		System generated non-nullable primary key of the table.
StartDtRFAttr	Datetime	False		null
AccountAddress	String	False		null
AccountId	Long	False		Party Id of the activity account (Customer - org/person, or Partner etc.).
AccountIdAttr	Long	False		null
AccountName	String	False		Name of account associated to activity.
AccountNameOsn	String	False		null
AccountPhoneNumber	String	False		null
AccountStatus	String	False		null
AccountType	String	False		null
ActivityCreatedBy	String	False		Original Activity Created By
ActivityCreationDate	Datetime	False		Original Activity Creation Date
ActivityDescription	String	False		A text field for capturing some descriptive information about the activity.
ActivityDirection	String	False		null
ActivityEndDate	Datetime	False		The end date and time of an appointment, or the completion time of a task.
ActivityFilter	String	False		null
ActivityFunctionCode	String	False		Task vs Appointment. System use only.
ActivityFunctionCodeTrans	String	False		null
ActivityLastUpdateLogin	String	False		Original Activity Last Update Login
ActivityMtgMinutes	String	False		Activity meeting minutes
ActivityOutcome	String	False		null
ActivityPartialDescription	String	False		null
ActivityPriority	String	False		null
ActivityStartDate	Datetime	False		The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation datetime for a task.
ActivityStatus	String	False		null
ActivityTimezone	String	False		Represents the time zone that the activity needs to be created in, other than the default logged in user's timezone preference.
ActivityType	String	False		null
ActivityTypeCode	String	False		The type or category of the activity.
ActivityUpdateDate	Datetime	False		Original Activity Update Date
ActivityUpdatedBy	String	False		Original Activity Updated By
ActivityUserLastUpdateDate	Datetime	False		Original Activity User Last Update Date
AllDayFlag	Bool	False		Designates that an appointment is the entire day.
ApptEndTime	Datetime	False		null
ApptStartTime	Datetime	False		null
AssessmentId	Long	False		Identifier of the Assessment to which the activity or the activity template is associated to.
AssetId	Long	False		Id of the Asset associated with the activity.
AssetName	String	False		Name of the Asset associated with the activity
AssetNumber	String	False		Asset Number.
AssetSerialNumber	String	False		Asset Serial Number.
AttachmentEntityName	String	False		null
AutoLogSource	String	False		For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity.
BpId	Long	False		Related Business plan.
BuOrgId	Long	False		null
CalendarAccess	Bool	False		null
CalendarRecurType	String	False		null
CalendarSubject	String	False		null
CalendarSubjectDay	String	False		null
CalendarTimeType	String	False		null
CallReportCount	Long	False		null
CallReportUpcomingYN	String	False		Flag to indicate Y,N,M for upcoming appointments
CallReportYN	String	False		Flag to Check if this activity has a Call Report
CampaignId	Long	False		Related Campaign.
CampaignName	String	False		Name of campaign associated to the activity.
CheckedInBy	String	False		Specifies the name of the person who checks-in to a location.
CheckedOutBy	String	False		Specifies the name of the person who checks-out to a location.
CheckinDate	Datetime	False		Stores the date and time when a user checks in to an Appointment.
CheckinLatitude	Long	False		Stores the latitude of a location where a user checks in to an Appointment.
CheckinLongitude	Long	False		Stores the longitude of a location where a user checks in to an Appointment.
CheckoutDate	Datetime	False		Stores the date and time when a user checks out of an Appointment.
CheckoutLatitude	Long	False		Stores the latitude of a location where a user checks out of an Appointment.
CheckoutLongitude	Long	False		Stores the longitude of a location where a user checks out of an Appointment.
ClaimId	Long	False		Related Claim.
ClaimName	String	False		Claim Name associated to the activity.
ConflictId	Long	False		null
ContactIDAttr	Long	False		null
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile
CreatedBy	String	False		System attribute to capture the user Id of the activity creator. This is defaulted by the system.
CreationDate	Datetime	False		System attribute to capture the Date and time the activity was created. This is defaulted by the system.
CurcyConvRateType	String	False		Holds currency code of a record
CurrencyCode	String	False		Holds Currency Conversion Rate Type from profile
CurrentDateForCallReport	Datetime	False		null
CurrentDateForCallReportAttr	Datetime	False		null
CurrentSystemDtTransient	Date	False		null
CustomerAccountId	Long	False		Id of Customer Account that the activity relates to.
DealId	Long	False		Related Deal.
DealNumber	String	False		Deal Number associated to the activity.
DelegatorId	Long	False		Activity resource that delegated activity ownership to another resource.
DelegatorName	String	False		Name of activity resource that delegated activity ownership to another resource.
DeleteFlag	Bool	False		This flag controls if the user has access to delete the record
DerivedAccountId	Long	False		null
DirectionCode	String	False		Inbound/Outbound. Optional. Default null.
DismissFlag	Bool	False		This Flag indicates if this activity is Dismissed
DoNotCallFlag	Bool	False		Flag to indicate if primary Contact can be called.
DueDate	Date	False		The date the task activity is due to be completed.
Duration	Long	False		Duration of an appt or task.
DynamicClaimLOVSwitcher	String	False		null
EmailSentDate	Datetime	False		This field is used to capture the Activity Email Notification shared date for Outlook integration
EndDateForCallReport	Datetime	False		null
EndDateForCallReportAttr	Datetime	False		null
EndDtRFAttr	Datetime	False		null
ExternalContactEmail	String	False		Indicates the Email address of an external contact.
ExternalContactName	String	False		Indicates the name of an external contact.
ExternallyOwnedFlag	Bool	False		Indicates that the activity is not created by an internal resource.
FundRequestId	Long	False		Related Fund request.
FundRequestName	String	False		Fund Request Name associated to the activity.
InstNumDerivedFrom	String	False		null
IsClientService	String	False		null
LastUpdateDate	Datetime	False		System attribute to capture the Date and Time the activity was last updated. This is defaulted by the system.
LastUpdateLogin	String	False		System attribute to capture the Id of the user who last updated the activity. This is defaulted by the system.
LastUpdatedBy	String	False		System attribute to capture the Id of the user who last updated the activity. This is defaulted by the system.
LeadId	Long	False		Related Lead.
LeadIdAttr	Long	False		null
LeadName	String	False		Lead Name
LeadNameOsn	String	False		null
Location	String	False		Appointment location.
LocationId	Long	False		Location or Address ID of the activity account or primary contact.
LoginUserRFAttr	Long	False		null
MdfRequestId	Long	False		null
MobileActivityCode	String	False		Unique identifier of external mobile device.
NotesLinkSourceCodeTransient	String	False		null
ObjectiveId	Long	False		Related Objective.
OpportunityId	Long	False		Related Opportunity.
OpportunityIdAttr	Long	False		null
OpportunityName	String	False		Name of opportunity associated to the activity.
OpportunityNameOsn	String	False		null
OrigEntityCode	String	False		null
OrigEntityNumber	String	False		null
OsnActivityId	Long	False		null
OtherPartyPhoneNumber	String	False		For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called.
OutcomeCode	String	False		The outcome of the activity.
OutlookFlag	Bool	False		If created from Outlook and synced,
OutlookIdentifier	String	False		Unique identifier from Outlook Activity.
OwnerAddress	String	False		Activity Owner's Address.
OwnerEmailAddress	String	False		Activity Owner's Email Address.
OwnerId	Long	False		Primary resource on the activity. Supports resources only.
OwnerName	String	False		Name of primary resource of activity.
OwnerNameOsn	String	False		null
OwnerPhoneNumber	String	False		Activity Owner's Phone Number.
ParentActivityId	Long	False		Related activity Id, only applicable if the record is a follow up activity.
ParentActivityIdAttr	String	False		null
PartialMtgMinutes	String	False		null
PartnerEnrollmentId	Long	False		Related Partner Enrollment
PartnerEnrollmentNumber	String	False		null
PartnerPartyId	Long	False		Party identifier of the partner organization.
PartnerPartyName	String	False		Party name of the partner organization.
PartnerProgramId	Long	False		Related Partner Program.
PartnerProgramName	String	False		Name of partner program associated to the activity.
PartnerUsageFlag	Bool	False		Flag to indicate that the Activity has been created for an Organization Account with usage as Partner.
PercentageComplete	Long	False		Numeric Value 0-100 to reflect the percent complete status of the activity. Free form numeric. % value at end.
PrimaryContactEmailAddress	String	False		Holds Email Id of the primary contact
PrimaryContactId	Long	False		Primary contact of the activity.
PrimaryContactName	String	False		Name of primary contact.
PrimaryContactNameOsn	String	False		null
PrimaryFormattedAddress	String	False		Holds Address of the primary contact
PrimaryFormattedPhoneNumber	String	False		Holds Phone Number of the primary contact
PriorityCode	String	False		The priority of the activity. Default to 2. Possible values: 1, 2, 3.
PrivateFlag	Bool	False		This Flag indicates if this activity is private
RecordSet	String	False		null
RecurDay	Long	False		Repeat on specified day of month (for monthly appointments).
RecurEndDate	Datetime	False		Ends on a specified date.
RecurEveryOptionFlag	Bool	False		It is set to indicate if the recurrence occurs for every day, month, year, etc. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it is everyday of the week, it is set to Y if it is weekdays only, it is set to N.
RecurExceptionFlag	Bool	False		Indicates if Appointment instance has been updated outside of recurring appointment series.
RecurFrequency	Long	False		Frequency that the recurring appointment series repeats.
RecurFriFlag	Bool	False		Repeat on Friday.
RecurMonFlag	Bool	False		Repeat on Monday.
RecurMonth	String	False		Repeat on specified month (for yearly appointments).
RecurNumberOfInstances	Long	False		Designates specific number of occurrences for the series to end after.
RecurOrigInstDate	Datetime	False		Original date of a recurring appointment instance.
RecurPattern	String	False		Designates which week for appointment to recur (for monthly and yearly appointments). Possible values: First, Second, Third, Fourth, Last.
RecurRecType	String	False		For Internal Use Only. Either
RecurSatFlag	Bool	False		Repeat on Saturday.
RecurSeriesId	Long	False		Series Id that links instances of a series together.
RecurSunFlag	Bool	False		Repeat on Sunday.
RecurThuFlag	Bool	False		Repeat on Thursday.
RecurTueFlag	Bool	False		Repeat on Tuesday.
RecurTypeCode	String	False		Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, Yearly.
RecurUpdatedAttributes	String	False		null
RecurWedFlag	Bool	False		Repeat on Wednesday.
RecurWeekday	String	False		It works in conjunction with RecurPattern attribute. Possbile values: Monday to Sunday, Weekday, Weekend, Day
ReferenceCustomerActTypeCode	String	False		Activity Type for a reference customer activity. To be used as an extension only
ReferenceCustomerId	Long	False		Id of the reference customer (party) associated with the activity.
ReminderPeriod	String	False		Reminder Period
ResponseCode	String	False		Response Code
SalesObjectiveName	String	False		Sales Objective Name associated to the activity.
SearchDate	Datetime	False		null
SelectedFlag	Bool	False		null
ShowStatus	String	False		null
ShowTimeAs	String	False		Show Time
SortDate	Datetime	False		This is an internal column which is used to sort the activity based on the due date for task and start date for activity.
SourceObjectCode	String	False		Code of the Object to which Activity will get related to
SourceObjectId	Long	False		Identifier of the Object to which Activity will get related to
SrId	Long	False		Service Request Id
SrNumber	String	False		Service Request Number
StartDateForCallReport	Datetime	False		null
StartDateForCallReportAttr	Datetime	False		null
StatusCode	String	False		Status of the activity. Defaulted to NOT_STARTED.
Subject	String	False		Subject/Name/Title of the activity.
SubmittedBy	Long	False		Call Report submitter.
SubmittedByName	String	False		Call Report submitter
SubmittedDate	Datetime	False		Call Report submission date
SwitchCallId	String	False		Unique Ientifier of the call on the external phone system.
TemplateDuration	String	False		The duration (in days) of the template activity. This attribute is used with the start date when generating an activity from a template in order to calculate the due date.
TemplateFlag	String	False		null
TemplateId	Long	False		null
TemplateLeadTime	String	False		The lead time (in days) of the template activity. This attribute is used with the date input parameter when generating an activity from a template in order to calculate the activity start date. Activity start date = date provided as input parameter + lead time.
UpdateFlag	Bool	False		This flag controls if the user has access to update the record
UpgSourceObjectId	String	False		null
UpgSourceObjectType	String	False		null

ActivityAssignees

Table used to capture the assignees/resources associated to the activity.

Columns


Name	Type	ReadOnly	References	Description
ActivityAssigneeId [KEY]	Long	False		Activity Assignee Id.This is the surrogate primary key added for BI and Outlook.
ActivityFunctionCode	String	False		null
ActivityId	Long	False		System generated non-nullable primary key of the Parent Activity.
ActivityNumber	String	False
AssigneeId	Long	False		ID of assignee associated with the activity.
AssigneeName	String	False		Assignee Name
AssigneePartyNumber	String	False		Holds Party Number of the contact
AtkMessageId	Long	False		null
AttendeeFlag	Bool	False		Flag to Check If the Contact Attended the Activity
ConflictId	Long	False		null
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile
CreatedBy	String	False		System attribute to capture the user Id of the activity assignee creator. This is defaulted by the system.
CreationDate	Datetime	False		System attribute to capture the date and time the activity assignee was created. This is defaulted by the system.
CurcyConvRateType	String	False		Holds Currency Conversion Rate Type from profile
CurrencyCode	String	False		Holds currency code of a record
DismissFlag	Bool	False		This Flag indicates if this activity is Dismissed
JobName	String	False		Job Name
LastUpdateDate	Datetime	False		System attribute to capture the date and time the activity assignee was last updated. This is defaulted by the system.
LastUpdateLogin	String	False		System attribute to capture the Id of the user who last updated the activity assignee. This is defaulted by the system.
LastUpdatedBy	String	False		System attribute to capture the Id of the user who last updated the activity assignee. This is defaulted by the system.
Phone	String	False		Holds Phone Number of the contact
PrimaryAssigneeFlag	String	False		null
PrimaryEmail	String	False		Holds Email Id of the contact
PrimaryFormattedAddress	String	False		Holds Primary Address of the resource
RecurSeriesId	Long	False		null
ReminderDatetime	Datetime	False		The date/time to send the appointment reminder.
ReminderPeriod	Int	False		Designates how soon before the appointment to send a reminder.
ResourceName	String	False		null
ResponseCode	String	False		Flag to indicate whether a reminder if needed.
SenderJobId	Long	False		null
ShowTimeAsCode	String	False		Designates how to show your appointment time on the calendar (free, busy, tentative).
SortDate	Datetime	False		null
StatusCode	String	False		null
UpgSourceObjectId	Long	False		null
UpgSourceObjectType	String	False		null
UserGuid	String	False		null
UserGuid1	String	False		null
UserLastUpdateDate	Datetime	False		Attribute to capture when the record was last updated by a user in disconnect mode.
UserName	String	False		null

ActivityContacts

Table used to capture the contacts associated to the activity.

Columns


Name	Type	ReadOnly	References	Description
AccountId	Long	False		null
ActivityContactId [KEY]	Long	False		This is the surrogate primary key added for BI and Outlook.
ActivityId	Long	False		System generated non-nullable primary key of the Parent Activity.
ActivityNumber	String	False
Affinity	String	False		Contact Affinity
AttendeeFlag	Bool	False		Flag to Check If the Contact Attended the Activity
BuyingRole	String	False		Contact Buying Role
ConflictId	Long	False		null
ContactAccount	String	False		Holds the Account Name that the Contact is associated to
ContactAccountId	Long	False		Holds the Id of the Account that the Contact is associated to
ContactAccountType	String	False		null
ContactCustomer	String	False		null
ContactEmail	String	False		Holds Email Id of the contact
ContactId	Long	False		Id of contact associated with the activity.
ContactJobTitle	String	False		Holds the Job Title of the Contact
ContactLovSwitcher	String	False		null
ContactName	String	False		Contact Name
ContactPartyNumber	String	False		Holds Party Number of the contact
ContactPhone	String	False		Holds Phone Number of the contact
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile
CreatedBy	String	False		System attribute to capture the user Id of the activity contact creator. This is defaulted by the system.
CreationDate	Datetime	False		System attribute to capture the date and time the activity contact was created. This is defaulted by the system.
CurcyConvRateType	String	False		Holds Currency Conversion Rate Type from profile
CurrencyCode	String	False		Holds currency code of a record
DoNotCallFlag	Bool	False		Flag to check if this contact can be contacted through Call
DoNotContactFlag	Bool	False		Flag to check if this contact can be contacted
DoNotEmailFlag	Bool	False		Flag to check if this contact can be contacted through Email
EmailContactPreferenceFlag	String	False		null
ExternalContactEmail	String	False		Indicates the Email address of an external contact.
ExternalContactFlag	Bool	False		Indicates that the contact does not exist in Oracle Sales.
ExternalContactName	String	False		Indicates the name of an external contact.
LastUpdateDate	Datetime	False		System attribute to capture the date and time the activity contact was last updated. This is defaulted by the system.
LastUpdateLogin	String	False		System attribute to capture the Id of the user who last updated the activity contact. This is defaulted by the system.
LastUpdatedBy	String	False		System attribute to capture the ID of the user who last updated the activity contact. This is defaulted by the system.
Name	String	False		null
PhoneContactPreferenceFlag	String	False		null
PrimaryContactFlag	Bool	False		This used of enable/disable PrimaryContactFlag for a contact.
PrimaryFormattedAddress	String	False		Holds Primary Address of the contact
RecurSeriesId	Long	False		null
RelationshipId	Long	False		Id of the relationship of the contact.
UpgSourceObjectId	Long	False		null
UpgSourceObjectType	String	False		null
UserLastUpdateDate	Datetime	False		Attribute to capture when the record was last updated by a user in disconnect mode.

ActivityNotes

Note data objects that capture comments, information or instructions for an Oracle Fusion Applications business object.

Columns


Name	Type	ReadOnly	References	Description
NoteId [KEY]	Long	False		Unique Note Identifier. This is the primary key of the notes table.
ActivityNumber [KEY]	String	False	Activities.ActivityNumber
ContactRelationshipId	Long	False		The relationship ID populated when the note is associated with a contact.
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile
CreatedBy	String	False		Who column: indicates the user who created the row.
CreationDate	Datetime	False		Who column: indicates the date and time of the creation of the row.
CreatorPartyId	Long	False		This is Party Id for the Note Creator
CurcyConvRateType	String	False		Holds Currency Conversion Rate Type from profile
CurrencyCode	String	False		Holds currency code of a record
DeleteFlag	Bool	False		This flag controls if the user has access to delete the record
EmailAddress	String	False		Email Address of the user who created the Note
FormattedAddress	String	False		Address of the user who created the Note
FormattedPhoneNumber	String	False		Phone Number of the user who created the Note
LastUpdateDate	Datetime	False		Who column: indicates the date and time of the last update of the row.
LastUpdateLogin	String	False		System attribute to capture the Id of the user who last updated the Note. This is defaulted by the system.
LastUpdatedBy	String	False		System attribute to capture the Id of the user who last updated the Note. This is defaulted by the system.
NoteTxt	String	False		This is the column which will store the actual note text.
NoteTypeCode	String	False		This is the note type code for categorization of note.
ParentNoteId	Long	False		null
PartyId	Long	False		Party identifier
PartyName	String	False		Name of this party
SourceObjectCode	String	False		This is the source_object_code for the source object as defined in OBJECTS Metadata.
SourceObjectId	String	False		This is the source_object_Uid for the source object (such as Activities, Opportunities etc) as defined in OBJECTS Metadata.
UpdateFlag	Bool	False		This flag controls if the user has access to update the record
VisibilityCode	String	False		This is the attribute to specify the visibility level of the note.

ActivityObjectives

Table used to capture the objectives associated to the activity.

Columns


Name	Type	ReadOnly	References	Description
ObjectiveId [KEY]	Long	False		Objective Id
ActivityNumber [KEY]	String	False	Activities.ActivityNumber
ActivityId	Long	False	Activities.ActivityId	System generated non-nullable primary key of the Parent Activity.
AttributeCategory	String	False		null
CompletedFlag	Bool	False		Completed Flag
ConflictId	Long	False		Conflict id
CorpCurrencyCode	String	False		Holds Corporate Currency Code from profile
CreatedBy	String	False		System attribute to capture the user Id of the activity assignee creator. This is defaulted by the system.
CreationDate	Datetime	False		System attribute to capture the date and time the activity assignee was created. This is defaulted by the system.
CurcyConvRateType	String	False		Holds Currency Conversion Rate Type from profile
CurrencyCode	String	False		Holds currency code of a record
LastUpdateDate	Datetime	False		System attribute to capture the date and time the activity assignee was last updated. This is defaulted by the system.
LastUpdateLogin	String	False		System attribute to capture the Id of the user who last updated the activity assignee. This is defaulted by the system.
LastUpdatedBy	String	False		System attribute to capture the Id of the user who last updated the activity assignee. This is defaulted by the system.
ObjectiveCode	String	False		Objective Code
ObjectiveFreefmtText	String	False		Objective Free Format Text
RecurSeriesId	Long	False		null

ContactAddresses

Table that includes attributes used to store values while creating or updating an address. An address represents the location information of an account, contact or household.

Columns


Name	Type	ReadOnly	References	Description
AddressNumber [KEY]	String	False		The unique alternate identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. A list of accepted values is defined in the profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
PartyNumber [KEY]	String	False	Contacts.PartyNumber	The alternate unique identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. The default value for PartyNumber is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. You can update the PartyNymber depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of accepted values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task.
AddrElementAttribute1	String	False		The additional address element to support flexible address format.
AddrElementAttribute2	String	False		The additional address element to support flexible address format.
AddrElementAttribute3	String	False		The additional address element to support flexible address format.
AddrElementAttribute4	String	False		The additional address element to support flexible address format.
AddrElementAttribute5	String	False		The additional address element to support flexible address format.
Address1	String	False		The first line for address.
Address2	String	False		The second line for address.
Address3	String	False		The third line for address.
Address4	String	False		The fourth line for address.
AddressId	Long	False		The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
AddressLinesPhonetic	String	False		The phonetic or kana representation of the Kanji address lines (used in Japan).
City	String	False		The city element of Address.
ClliCode	String	False		The Common Language Location Identifier (CLLI) code.
Comments	String	False		User comments for the address.
CorpCurrencyCode	String	False		The corporate currency code associated with the addresses. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
Country	String	False		The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.
County	String	False		The county element of Address.
CreatedBy	String	False		The user who created the address record.
CreatedByModule	String	False		The application module that created this organization record. The default value for CreatedByModule is HZ_WS for all Web service based creation.
CreationDate	Datetime	False		The date and time when the address record was created.
CurcyConvRateType	String	False		The currency conversion rate type associated with the address. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CurrencyCode	String	False		The currency code associated with the address. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
DateValidated	Date	False		The date when the address was last validated.
Description	String	False		An extensive description of the location of the address.
DoNotMailFlag	Boolean	False		Indicates if this address should be used for mailing. If the value is True, then the address should not be used for mailing. The default value is False.
EffectiveDate	Date	False		The date when the address becomes effective.
EndDateActive	Date	False		Date on which this address is no longer active.
FloorNumber	String	False		The specific floor number at a given address or in a particular building when building number is provided.
FormattedAddress	String	False		The formatted address information.
FormattedMultilineAddress	String	False		The formatted multiple line address information.
HouseType	String	False		The type of building. A list of accepted values for this attribute is defined in the lookup HZ_HOUSE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
LastUpdateDate	Datetime	False		The date when the address data was last updated.
LastUpdatedBy	String	False		The user who last updated the address record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the address record.
Latitude	Long	False		Used to store latitude information for the location for spatial proximity and containment purposes.
LocationDirections	String	False		The directions to the location.
LocationId	Long	False		The unique identifier for this location.
Longitude	Long	False		Used to store longitude information for the location for spatial proximity and containment purposes.
Mailstop	String	False		A user-defined code to indicate a mail drop point within their organization.
ObjectVersionNumber	Int	False		Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
PartyId	Long	False		The unique Identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
PartySourceSystem	String	False		The name of external source system of the contact with which the address is associated. Part of Alternate Key for the contact record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. A list of accepted values should be pre-defined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task.
PartySourceSystemReferenceValue	String	False		The identifier from external source system for the contact with which the address is associated. Part of Alternate Key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated.
PostalCode	String	False		The postal code as defined by the formal countrywide postal system.
PostalPlus4Code	String	False		The four digit extension to the United States Postal ZIP code.
PrimaryFlag	Boolean	False		Indicates if this is the primary address of the contact irrespective of the context. If the value is True, then the address is the primary address of the contact. The default value is False.
Province	String	False		The province element of Address.
SourceSystem	String	False		The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
SourceSystemReferenceValue	String	False		The identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
StartDateActive	Date	False		Date on which this address becomes active.
State	String	False		The state element of Address.
Status	String	False		The status of the address. A list of accepted values is defined in the lookup HZ_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
ValidatedFlag	Boolean	False		Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing.
ValidationStartDate	Date	False		The date when the address validation started. The value is internally set by system during address cleansing.
ValidationStatusCode	String	False		The standardized status code describing the results of the address validation. The value is internally set by system during address cleansing.

ContactAddressPurposes

The address purpose resource is used to view, create, or modify the address purpose. The address purpose describes the use of an address, such as shipping address or billing address.

Columns


Name	Type	ReadOnly	References	Description
AddressPurposeId [KEY]	Long	False		This is the primary key of the contact address purposes table.
PartyNumber [KEY]	String	False	Contacts.PartyNumber
AddressNumber [KEY]	String	False	ContactAddresses.AddressNumber
DeleteFlag	Boolean	False		Indicates if the address purpose for an address was deleted. If the value is True, then the address purpose is deleted. The default value is False.
Purpose	String	False		The use or purpose of the address.

ContactNotes

The note resource is used to capture comments, information, or instructions for a contact.

Columns


Name	Type	ReadOnly	References	Description
NoteId [KEY]	Long	False		This is the primary key of the notes table.
PartyNumber [KEY]	String	False	Contacts.PartyNumber
ContactRelationshipId	Long	False		The identifier of the relationship populated when the note is associated with a contact.
CorpCurrencyCode	String	False		The corporate currency code of the note associated with the contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CreatedBy	String	False		The user who created the note record.
CreationDate	Datetime	False		The date and time when the note record was created.
CreatorPartyId	Long	False		The unique party identifier for the note creator.
CurcyConvRateType	String	False		The currency conversion rate type associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CurrencyCode	String	False		The currency code associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
LastUpdateDate	Datetime	False		The date when the note data was last updated.
NoteTxt	String	False		The actual note text.
NoteTypeCode	String	False		This code for categorization of the note type.
PartyId	Long	False		The unique Identifier of the contact to which the note is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
PartyName	String	False		The name of a contact party.
SourceObjectCode	String	False		The code of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata.
SourceObjectId	String	False		The primary key identifier of the source object such as Activities, Opportunities, as defined in OBJECTS Metadata.
VisibilityCode	String	False		The visibility level of the note.

ContactPrimaryAddresses

The primary address resource is used to view, create, or modify a primary address of a contact. A primary address is the default communication address of an entity.

Columns


Name	Type	ReadOnly	References	Description
AddressNumber [KEY]	String	False		This is the primary key of the contact primary addresses table.
PartyNumber [KEY]	String	False	Contacts.PartyNumber
AddressElementAttribute1	String	False		The additional address element to support flexible address format.
AddressElementAttribute2	String	False		The additional address element to support flexible address format.
AddressElementAttribute3	String	False		The additional address element to support flexible address format.
AddressElementAttribute4	String	False		The additional address element to support flexible address format.
AddressElementAttribute5	String	False		The additional address element to support flexible address format.
AddressId	Long	False		The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update.
AddressLine1	String	False		The first line for address.
AddressLine2	String	False		The second line for address.
AddressLine3	String	False		The third line for address.
AddressLine4	String	False		The fourth line for address.
AddressLinesPhonetic	String	False		The phonetic or kana representation of the Kanji address lines (used in Japan).
Building	String	False		The specific building name or number at a given address.
City	String	False		The city element of Address.
Comments	String	False		User comments for the address.
CorpCurrencyCode	String	False		The corporate currency code associated with the addresses. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
Country	String	False		The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.
County	String	False		The county element of Address.
CreatedBy	String	False		The user who created the address record.
CreationDate	Datetime	False		The date and time when the address record was created.
CurcyConvRateType	String	False		The currency conversion rate type associated with the address. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CurrencyCode	String	False		The currency code associated with the address. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
DateValidated	Datetime	False		The date when the address was last validated.
DeleteFlag	Boolean	False		Indicates if the primary address was deleted. If the value is True, then the primary address is deleted. The default value is False.
Description	String	False		An extensive description of the location of the address.
FloorNumber	String	False		The specific floor number at a given address or in a particular building when building number is provided.
FormattedAddress	String	False		The formatted address information.
FormattedMultiLineAddress	String	False		The formatted multiple line address information.
HouseType	String	False		The type of building. A list of accepted values is defined in the lookup HZ_HOUSE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
LastUpdateDate	Datetime	False		The date when the address data was last updated.
LastUpdatedBy	String	False		The user who last updated the address record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the address record.
Latitude	Long	False		Used to store latitude information for the location for spatial proximity and containment purposes.
LocationDirections	String	False		The directions to the location.
LocationId	Long	False		The unique identifier for this location.
Longitude	Long	False		Used to store longitude information for the location for spatial proximity and containment purposes.
Mailstop	String	False		A user-defined code to indicate a mail drop point within their organization.
PartyId	Long	False		The unique Identifier of the contact to which the primary address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
PostalCode	String	False		The postal code as defined by the formal countrywide postal system.
PostalPlus4Code	String	False		The four digit extension to the United States Postal ZIP code.
Province	String	False		The province element of Address.
SourceSystem	String	False		The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
SourceSystemReferenceValue	String	False		The identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
State	String	False		The state element of Address.
ValidatedFlag	Boolean	False		Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing.
ValidationStatusCode	String	False		The date when the address validation started. The value is internally set by system during address cleansing.

ContactRelationships

The relationship resource includes attributes that are used to store values while viewing, creating, or updating a relationship.

Columns


Name	Type	ReadOnly	References	Description
RelationshipRecId [KEY]	Long	False		This is the primary key of the relationships table.
PartyNumber [KEY]	String	False	Contacts.PartyNumber
Comments	String	False		User comments for the relationship.
CreatedBy	String	False		The user who created the relationship record.
CreatedByModule	String	False		The application module that created this organization record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.
CreationDate	Datetime	False		The date and time when the relationship record was created.
EndDate	Datetime	False		The date when the relationship ends.
LastUpdateDate	Datetime	False		The date and time when the relationship data was last updated.
LastUpdatedBy	String	False		The user who last updated the relationship record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the relationship record.
ObjectPartyId	Long	False		The primary key identifier of the contact, in this relationship. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the contact party of the relationship.
ObjectPartyNumber	String	False		The unique alternate identifier for the relationship of the contact party. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the object party of the relationship.
ObjectSourceSystem	String	False		The name of external source system for the contact party in the relationship, which are defined by an admin as part of system setup. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the object party of the relationship. A list of accepted values should be pre-defined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task.
ObjectSourceSystemReferenceValue	String	False		The identifier from external source system for the relationship of the contact party. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the contact party of the relationship.
RelationshipCode	String	False		The code for a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups.
RelationshipSourceSystem	String	False		The name of external source system for the relationship, which are defined by an Admin as part of system setup.
RelationshipSourceSystemReferenceValue	String	False		The identifier from external source system for the relationship.
RelationshipType	String	False		The type of relationship of a contact party, such as CUSTOMER_SUPPLIER. A list of accepted relationship type values is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups task.
StartDate	Datetime	False		Date on which this relationship becomes active.
Status	String	False		The status of the relationship. Indicates if this is an active or inactive relationship. The values A indicate an active relationship and I an inactive relationship. This is an internal column and user is not expected to pass in a value. A list of accepted values is defined in the lookup HZ_STATUS. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
SubjectPartyId	Long	False		The primary key identifier of the subject in this relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship.
SubjectPartyNumber	String	False		The alternate unique identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship.
SubjectSourceSystem	String	False		The name of external source system for the subject party in the relationship, which are defined by an Admin as part of system setup. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship. A list of accepted values should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task.
SubjectSourceSystemReferenceValue	String	False		The identifier from external source system for the subject party in the relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship.

Contacts

Table resource items include attributes used to store values while creating or updating a contact.

Columns


Name	Type	ReadOnly	References	Description
PartyNumber [KEY]	String	False		The unique alternate identifier for the contact party. The default value for PartyNumber is the value specified in the profile option HZ_GENERATE_PARTY_NUMBER. You can update the PartyNumber depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of accepted values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task.
AcademicTitle	String	False		The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith.
AccountName	String	False		The name of the sales account that this contact belongs to.
AccountPartyId	Long	False		The unique identifier of sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference.
AccountPartyNumber	String	False		The party number of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference.
AccountSourceSystem	String	False		The Source System code of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference.
AccountSourceSystemReferenceValue	String	False		The Source System Reference value of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference.
AddressElementAttribute1	String	False		Additional address element to support flexible address format
AddressElementAttribute2	String	False		Additional address element to support flexible address format
AddressElementAttribute3	String	False		Additional address element to support flexible address format
AddressElementAttribute4	String	False		Additional address element to support flexible address format
AddressElementAttribute5	String	False		Additional address element to support flexible address format
AddressLine1	String	False		First line of address.
AddressLine2	String	False		Second line of address.
AddressLine3	String	False		Third line of address.
AddressLine4	String	False		Fourth line of address.
AddressLinesPhonetic	String	False		The phonetic or Kana representation of the Kanji address lines (used in Japan).
AddressNumber	String	False		Alternate unique identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. Prefix defined as in profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number.
AddressType	String	False		Additional information as type of address like BillTo, ShipTo.
AssignmentExceptionFlag	Bool	False		Indicates whether the sales account has the required dimensions to allow assignment manager to assign territories to the sales account. If the value is True, then the sales account has the required dimensions. The default is false.
Building	String	False		Specific building name or number at a given address.
CertificationLevel	String	False		The certification level of a contact. A list of accepted values are defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CertificationReasonCode	String	False		The reason for the contact's current certification level assignment. A list of accepted values are defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
City	String	False		The city element of address.
ClassificationCategory	String	False		A valid classification category code for the contact. This is defined by an admin and is marked as primary.
ClassificationCode	String	False		A valid classification code corresponding to the classification category, which is marked as primary.
Comments	String	False		The textual comments about a contact.
ContactIsPrimaryForAccount	String	False		The preferred contact for the account.
ContactName	String	False		The derived name of the contact.
ContactRole	String	False		Specifies the role of the contact
ContactUniqueName	String	False		The unique contact name displayed on contact related screens. The default value for ContactUniqueName is the concatenation of attributes ContactName and UniqueNameSuffix. If the attribute UniqueNameSuffix is nil, then the ContactName is concatenated with a system generated number.
Country	String	False		Country code of the address.
County	String	False		County element of address.
CreatedBy	String	False		The user who created the contact record.
CreatedByModule	String	False		The application module that created this contact record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task.
CreationDate	Datetime	False		The date and time when the contact record was created.
CurrencyCode	String	False		The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
DataCloudStatus	String	False		The enrichment status of the contact record from Data cloud. A list of accepted values are defined in the lookup DATA_CLOUD_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
DateOfBirth	Date	False		The date when the person was born.
DateOfDeath	Date	False		Date the person died.
DeceasedFlag	Bool	False		Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default is False.
DeclaredEthnicity	String	False		The declared ethnicity of the person.
DeleteFlag	Bool	False		This flag controls if the user has access to delete the record
Department	String	False		The free form text used to name the department for the contact.
DepartmentCode	String	False		The department code for the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
DoNotCallFlag	Bool	False		Indicates if the user can call the person or not. If the value is True, then the user must not call the person. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
DoNotContactFlag	Bool	False		Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
DoNotEmailFlag	Bool	False		Indicates if the user can e-mail the person or not. If the value is True, then the user must not contact the person by e-mail. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
DoNotMailFlag	Bool	False		Indicates if the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
EmailAddress	String	False		The e-mail address of the contact point.
EmailContactPointType	String	False
EmailFormat	String	False		The preferred format for e-mail addressed to this address such as HTML or ASCII. A list of accepted values is defined using the lookup EMAIL_FORMAT. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
ExistingCustomerFlag	Bool	False		Indicates whether there is an existing selling or billing relationship with the sales account. If the value is true, then there is an existing relationship with the sales account. The default value is False. Such relationships are defined by the existence of a Sell_To or Bill_To address.
ExistingCustomerFlagLastUpdateDate	Date	False		The date when the ExistingCustomerFlag was last modified. It is internally populated by the application.
FavoriteContactFlag	Bool	False		Indicates whether the person is a key contact. If the value is true, then person is a key contact. The default value is False.
FaxAreaCode	String	False		The area code.
FaxContactPointType	String	False
FaxCountryCode	String	False		The international country code for a telephone number, such as 33 for France.
FaxExtension	String	False		The additional number addressed after initial connection to an internal telephone system.
FaxNumber	String	False		A telephone number formatted in the local format without the area code, country code, or extension.
FirstName	String	False		First name of the person.
FloorNumber	String	False		Specific floor number at a given address or in a particular building when building number is provided
FormattedFaxNumber	String	False		The formatted fax number information.
FormattedHomePhoneNumber	String	False		Formatted mobile phone number information.
FormattedMobileNumber	String	False		The formatted mobile phone number information.
FormattedWorkPhoneNumber	String	False		The formatted work phone number information.
Gender	String	False		The gender of the person, such as male, female, and unknown. A list of accepted values are defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
HeadOfHouseholdFlag	Bool	False		Indicates if the person is the head of the household. If the value is True, then the person is the head of the household. The default value is False.
HomePhoneAreaCode	String	False		The area code within a country code.
HomePhoneContactPointType	String	False
HomePhoneCountryCode	String	False		The international country code for a telephone number, such as 33 for France.
HomePhoneNumber	String	False		The home phone number formatted in the local format without the area code, country code, or extension.
HouseholdIncomeAmount	Decimal	False		The income of the household that this person is a part of.
HouseholdSize	Long	False		The size of the household this person is a part of.
Initials	String	False		The initials in the contact's name.
JobTitle	String	False		The free form text for job title.
JobTitleCode	String	False		Code given to the job title.
LastAssignmentDate	Date	False		The date when the Sales Account Territory Assignment was last run by Assignment Manager.
LastContactDate	Datetime	False		The date when the contact was last contacted.
LastEnrichmentDate	Date	False		The date when the contact record was last enriched with data from external sources by using Data-as-a-Service.
LastName	String	False		The last name of the person.
LastNamePrefix	String	False		The prefix for the last name of a person, such as fon, van. For example, if a person's name is Hans Van, the last name of the person is captured using this attribute.
LastUpdateDate	Datetime	False		The date and time when the contact was last updated.
LastUpdateLogin	String	False		Indicates the session login associated to the user who last updated the record.
LastUpdatedBy	String	False		The user who last updated the contact record.
Mailstop	String	False		A user-defined code to indicate a mail drop point within their organization
MaritalStatus	String	False		The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
MaritalStatusEffectiveDate	Date	False		The date when the person's marital status was changed.
MiddleName	String	False		The middle name of the person.
MobileAreaCode	String	False		The area code for the contact's mobile phone.
MobileContactPointType	String	False
MobileCountryCode	String	False		The international country code for a contact's mobile phone number, such as 33 for France.
MobileExtension	String	False		The additional number addressed after initial connection to an internal telephone system.
MobileNumber	String	False		The mobile phone number formatted in the local format. The number should not include area code, country code, or extension.
NameSuffix	String	False		The place in a family structure. For example, in
NamedFlag	Bool	False		Indicates whether a sales account is a named sales account. If the value is true, then the sales account is a named sales account. The default value is False.
OverallPrimaryFormattedPhoneNumber	String	False
OwnerEmailAddress	String	False		The e-mail address of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber or E-mail Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and OwnerEmailAddress are honored in this order to determine the owner for the contact.
OwnerName	String	False		The name of the sales account owner.
OwnerPartyId	Long	False		The unique identifier of a valid employee resource who owns and manages the sales account. The owner is a valid employee resource defined within Sales Cloud. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber, or E-mail Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and OwnerEmailAddress are honored in this order to determine the owner for the contact. During create, if none of the OwnerPartyID, OwnerPartyNumber, or OwnerEmailAddress is provided, then the contact is assigned by default to the login user. The login user's partyID is used to populate OwnerPartyID.
OwnerPartyNumber	String	False		The party number of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber, or E-mail Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and OwnerEmailAddress are honored in this order to determine the owner for the contact.
PartyId	Long	False		The unique internal identifier of a contact party. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact party.
PartyNumberKey	String	False
PartyStatus	String	False		The status of the contact. A list of valid values are defined in the lookup HZ_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
PartyType	String	False
PersonProfileId	Long	False
PersonalIncomeAmount	Decimal	False		The estimated gross annual income of the person.
PlaceOfBirth	String	False		The place where the person was born, such as city or country.
PostalCode	String	False		Postal code as defined by the formal countrywide postal system
PostalPlus4Code	String	False		Four digit extension to the United States Postal ZIP code.
PreferredContactMethod	String	False		The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.
PreferredFunctionalCurrency	String	False		The default currency code for this contact. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task.
PreviousLastName	String	False		The previous last name or surname of the person.
PrimaryAddressId	Long	False
Province	String	False		Province element of address.
RawFaxNumber	String	False		The unformatted fax number information.
RawHomePhoneNumber	String	False		Unformatted home phone number information.
RawMobileNumber	String	False		The unformatted mobile phone number information.
RawWorkPhoneNumber	String	False		The unformatted work phone number information.
RecordSet	String	False		The search results displayed under the selected record set.
RegistrationStatus	String	False		Specifies the registration status of the contact
RentOrOwnIndicator	String	False		Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
SalesAffinityCode	String	False		The affinity of a contact to the deploying organization. A list of accepted values are defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
SalesBuyingRoleCode	String	False		The roles played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
SalesProfileNumber	String	False
SalesProfileStatus	String	False		A valid user defined status of the sales account.
Salutation	String	False		The phrase used to address a contact party in any correspondence.
SalutoryIntroduction	String	False		The title or a salutary introduction for a contact, such as Mr., Herr, and so on. A list of accepted values is defined in the lookup CONTACT_TITLE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
SecondLastName	String	False		The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
SellToPartySiteId	Long	False
SourceObjectType	String	False
SourceSystem	String	False		The name of external source system where the contact party is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task.
SourceSystemReferenceValue	String	False		The alternate unique identifier for the contact party from the external source system specified in the attribute SourceSystem.
State	String	False		State element of address.
TaxpayerIdentificationNumber	String	False		The taxpayer identification number, which is often a unique identifier of the contact. The typical values are taxpayer Id in USA or fiscal code or NIF in Europe.
Title	String	False		A professional or family title, such as Don or The Right Honorable.
Type	String	False		The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
UniqueNameSuffix	String	False		The system generated or manually overridden suffix. The suffix is used to generate the PartyUniqueName attribute and is concatenated to the ContactName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix.
UpdateFlag	Bool	False		This flag controls if the user has access to update the record
WorkPhoneAreaCode	String	False		The area code for the contact's work phone.
WorkPhoneContactPointType	String	False
WorkPhoneCountryCode	String	False		The international country code for a contact's work phone number, such as 33 for France.
WorkPhoneExtension	String	False		The additional number addressed after initial connection to an internal telephone system.
WorkPhoneNumber	String	False		The work phone number formatted in the local format without the area code, country code, or extension.

ContactSalesAccountResources

The sales team member resource represents a resource party and is assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Columns


Name	Type	ReadOnly	References	Description
TeamMemberId [KEY]	Long	False		This is the primary key of the sales account resources table.
PartyNumber [KEY]	String	False	Contacts.PartyNumber
AccessLevelCode	String	False		The type of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
AssignmentTypeCode	String	False		The code indicating how the resource is assigned to the sales account team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
CreatedBy	String	False		The user who created the sales team member record.
CreationDate	Datetime	False		The date and time when the sale team member record was created.
EndDateActive	Datetime	False		Date on which this sales team member is no longer active.
LastUpdateDate	Datetime	False		The date when the sales team member record was last updated.
LastUpdatedBy	String	False		The user who last updated the sales team member record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the sales team member record.
LockAssignmentFlag	Boolean	False		Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'.
MemberFunctionCode	String	False		The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
ResourceEmailAddress	String	False		The e-mail address of the resource.
ResourceId	Long	False		The unique party ID for the existing resource record in Oracle Sales.
ResourceName	String	False		The name of the sales team member.
ResourceOrgName	String	False		The name of the organization that the sales team member belongs to.
ResourcePartyNumber	String	False		The unique public identifier of the resource record.
ResourcePhoneNumber	String	False		The primary phone number of the sales team member.
ResourceRoleName	String	False		The roles assigned to the sales team member.
SalesProfileId	Long	False		The unique identifier of the sales profile of the resource.
StartDateActive	Datetime	False		Date on which this sales team member becomes active.
UserLastUpdateDate	Datetime	False		The date and time when the sales team member was last updated from mobile.

EmployeeResourceAttachments

The contact picture attachment resource is used to view, create, and update the resource's picture.Get a resource's picture

Columns


Name	Type	ReadOnly	References	Description
AttachedDocumentId [KEY]	Long	False		This is the hash key of the attributes which make up the composite key--- AttachedDocumentId and DocumentId1 ---for the Attachments resource and used to uniquely identify an instance of Attachments. The client should not generate the hash key value. Instead, the client should query on the Attachments collection resource with a filter on the primary key values in order to navigate to a specific instance of Attachments.
PartyNumber	String	False		The unique identifier for the resource party.
ContentRepositoryFileShared	Boolean	False		Indicates if the attachment is shared.
CreatedBy	String	False		The user who uploaded the picture attachment.
CreationDate	Datetime	False		The date when the picture attachment was uploaded.
DatatypeCode	String	False		The data type for the picture attachment.
Description	String	False		The description of the picture attachment.
DmFolderPath	String	False		The folder path where the picture attachment exists.
ErrorStatusCode	String	False		The error code, if any, for the attachment.
ErrorStatusMessage	String	False		The error message, if any, for the attachment.
ExpirationDate	Datetime	False		The expiration date of the contents in the attachment.
FileContents	String	False		The contents of the attachment.
FileName	String	False		The name of the attachment file.
FileUrl	String	False		The URL of the attachment file.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
Title	String	False		The title of the attachment.
UploadedFileContentType	String	False		The content type of the attachment.
UploadedFileLength	Long	False		The length of the attachment file.
UploadedFileName	String	False		The name of the attachment file.
UploadedText	String	False		The text uploaded in the attachment.
Uri	String	False		The URI of the attachment.
Url	String	False		The URL of the attachment.
UserName	String	False		The login associated with the attachment.

EmployeeResources

The resources resoure is used to view, create, and update a resource. A resource is a person within the deploying company who can be assigned work to accomplish business objectives, such as sales persons or partner members.

Columns


Name	Type	ReadOnly	References	Description
PartyNumber [KEY]	String	False		Unique identification number for this party
EmailAddress	String	False		E-mail address
EndDateActive	Datetime	False		Indicates the date at which the resource becomes inactive
FormattedAddress	String	False		Primary Formatted address for the resource
FormattedPhoneNumber	String	False		Primary Formatted phone number for the resource
PartyId	Long	False		Identifier for the party. Foreign key to the HZ_PARTIES PARTY_ID.
PartyName	String	False		Name of the Party
PersonFirstName	String	False		Peron First Name
PersonLastName	String	False		Peron LastName
PersonLastNamePrefix	String	False		Resource Peron Last name
PersonMiddleName	String	False		Peron Middle Name.
PersonNameSuffix	String	False		Peron Name suffix
PersonPreNameAdjunct	String	False		Person Preferred Name adjacency
PersonPreviousLastName	String	False		perin Previous flag mage
PersonSecondLastName	String	False		peron secind last name
ResourceProfileId	Long	False		Unique identifier for the Resource Profile. Primary Key.
ResourceType	String	False		Type of Resource ex employee
StartDateActive	Datetime	False		Indicates the date at which the resource becomes active
Url	String	False		Primary URL for the resource
Usage	String	False		Read only party usage for resource party

Opportunities

The opportunity competitor resource is used to view, create, and update the competitors for an opportunity. The opportunity competitors is used to store information about the competitors associated with the opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptyNumber [KEY]	String	False		The unique alternate identifier for the opportunity.
AverageDaysAtStage	Int	False		The average duration, in number of days, the opportunity remains in the current sales stage.
BudgetAvailableDate	Date	False		The date when the budget will be available.
BudgetedFlag	Boolean	False		Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.
ChampionFlag	Boolean	False		Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.
CreatedBy	String	False		The user who created the opportunity record.
CreationDate	Datetime	False		The date and time when the record was created.
CurrencyCode	String	False		The currency used by the opportunity.
CustomerAccountId	Long	False		The customer account associated with the opportunity.
DealHorizonCode	String	False		The estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
DecisionLevelCode	String	False		The job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
DeleteFlag	Boolean	False		Indicates whether the opportunity can be deleted.
Description	String	False		The description of the opportunity including the sales objective. The description is added by the Sales Representative.
DescriptionText	String	False		The description of the sales objective of the opportunity.
DownsideAmount	Decimal	False		The minimum amount of revenue for the opportunity.
EffectiveDate	Date	False		The date when the opportunity may to close.
EmailAddress	String	False		The e-mail address of the employee resource that owns the opportunity.
ExpectAmount	Decimal	False		The expected revenue from the opportunity.
KeyContactId	Long	False		The unique identifier of the primary contact of the opportunity.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the opportunity record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
LineOfBusinessCode	String	False		The line of business that owns the opportunity.
MaximumDaysInStage	Int	False		The maximum duration, in number of days, that an opportunity can be in sales stage before it is considered stalled.
Name	String	False		The name of the opportunity.
OptyId	Long	False		The unique identifier of the opportunity.
OwnerResourcePartyId	Long	False		The unique identifier of a valid employee resource who owns and manages the opportunity.
PartyName1	String	False		The name of the opportunity owner.
PartyUniqueName1	String	False		The unique name of the primary competitor for the opportunity.
PhaseCd	String	False		The current phase of the opportunity sales stage.
PrimaryCompetitorId	Long	False		The unique identifier of the primary competitor for this opportunity.
PrimaryContactEmailAddress	String	False		The e-mail address of the primary contact for the opportunity.
PrimaryContactFormattedPhoneNumber	String	False		The formatted phone number of the primary contact for the opportunity.
PrimaryContactPartyName	String	False		The name of the opportunity's primary contact.
PrimaryOrganizationId	Long	False		The unique identifier of the business unit to which this opportunity belongs.
PrimaryPartnerId	Long	False		The unique identifier of the primary partner associated with the opportunity.
PrimaryPartnerOrgPartyName	String	False		The name of the primary partner associated with the opportunity.
PrimaryRevenueId	Long	False		The unique identifier of the summary revenue line for the opportunity. The summary revenue line stores the total revenue amount of the opportunity.
PrSrcNumber	String	False		The unique identifier number of the primary marketing source or campaign that generated this opportunity.
QuotaFactor	Decimal	False		The quota factor of the opportunity sales stage.
RcmndWinProb	Decimal	False		The recommended probability of winning the opportunity in the sales stage.
ReasonWonLostCode	String	False		The reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
Registered	String	False		Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No.
RegistrationStatus	String	False		The registration status of the opportunity or deal created by a partner.
RegistrationType	String	False		The registration type used by the partner to create the opportunity or deal.
Revenue	Long	False		The estimated revenue amount from the opportunity.
RiskLevelCode	String	False		The risk level code of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
SalesAccountUniqueName	String	False		The unique name of the sales account that owns the opportunity.
SalesChannelCd	String	False		The sales channel for the opportunity.
SalesMethod	String	False		The sales method associated with the opportunity.
SalesMethodId	Long	False		The sales method identifier for this opportunity, and indicates the sales process used.
SalesStage	String	False		The current sales stage of the opportunity.
SalesStageId	Long	False		The unique identifier for the sales stage of the opportunity.
StageStatusCd	String	False		The default status for the opportunity's sales stage.
StatusCode	String	False		The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
StgOrder	Decimal	False		The order of the opportunity's sales stage in the sales method.
StrategicLevelCode	String	False		The strategic value that the opportunity has for the sales account. A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
TargetPartyId	Long	False		The unique identifier of the sales account that owns the opportunity.
TargetPartyName	String	False		The name of the sales account that owns the opportunity.
UpdateFlag	Boolean	False		Indicates whether the opportunity can be updated.
UpsideAmount	Decimal	False		The maximum amount of revenue for the opportunity.
WinProb	Int	False		The estimated probability of winning the opportunity.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityCompetitors

The opportunity competitor resource is used to view, create, and update the competitors for an opportunity. The opportunity competitors is used to store information about the competitors associated with the opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptyCompetitorId [KEY]	Long	False		This is the primary key of the opportunity competitors table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
CmptPartyId	Long	False		The unique identifier for the competitor party.
Comments	String	False		The user-provided comments about the opportunity's competitor.
CreatedBy	String	False		The user who created the record.
CreationDate	Datetime	False		The date and time when the contact record was created.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
Name	String	False		The name of the opportunity.
OptyId	Long	False		The unique identifier for the opportunity.
PartyName	String	False		The name of the party.
PrimaryFlg	String	False		Indicates if the competitor is the primary competitor for the opportunity. If True, then the competitor is the primary competitor. The default value is False.
ThreatLevelCode	String	False		The level of threat or risk from the competitor. The list of valid values are Low, Medium and High. A list of accepted values are defined in the lookup Competitor Threat Level. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityContacts

The opportunity contact resource is used to view, create, and update the contacts of an opportunity.The contact associated with the opportunity. You can specify a contact's role, affinity, and influence level on an opportunity. A single contact can be marked as primary.

Columns


Name	Type	ReadOnly	References	Description
OptyConId [KEY]	Long	False		This is the primary key of the opportunity contacts table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
AffinityLvlCd	String	False		The affinity of the opportunity contact to the deploying organization. A list of accepted values are defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
Comments	String	False		The textual comments about the contact on the current opportunity.
ContactedFlg	String	False		Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.
ContactPointId	Long	False		The unique identifier of the contact's contact point.
CreatedBy	String	False		The user who created the opportunity contact record.
CreationDate	Datetime	False		The date and time when the contact record was created.
DoNotContactFlag	Boolean	False		Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default is False.
EmailAddress	String	False		The e-mail address of the contact.
FormattedAddress	String	False		The formatted address of the contact.
FormattedPhoneNumber	String	False		The formatted phone number of the contact.
InfluenceLvlCd	String	False		The influence of the opportunity contact has on the deploying organization. A list of accepted values are defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
JobTitle	String	False		The free form text for job title of the opportunity contact.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
OptyId	Long	False		The unique identifier of the opportunity.
OrganizationPartyId	Long	False		The unique identifier of the contact's organization.
OrganizationPartyName	String	False		The name of the contact's organization.
OrgContactId	Long	False		The unique identifier of the organization contact for the opportunity.
PartyName	String	False		The name of the contact for the opportunity.
PartyUniqueName	String	False		The unique contact name displayed on party related screens. The default value for Contacts is the concatenation of attributes ContactName and UniqueNameSuffix. The default value for Organizations is the concatenation of the unique name alias and UniqueNameSuffix.
PERPartyId	Long	False		The unique identifier of a valid employee resource who owns and manages the opportunity.
PreferredContactMethod	String	False		The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.
PrimaryFlg	String	False		Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact fo the opportunity. The default value is False.
RelationshipCode	String	False		The code for a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups.
RelationshipId	Long	False		The identifier of the relationship for the opportunity contact.
RoleCd	String	False		The roles played by a contact in the opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
SalesAffinityCode	String	False		The affinity of a contact to the deploying organization. A list of accepted values are defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
SalesBuyingRoleCode	String	False		The roles played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
SalesInfluenceLevelCode	String	False		The contact's level of influence in the buying process for the current opportunity.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityDeals

A deal associated with the opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptyDealId [KEY]	Long	False		This is the primary key of the opportunity deals table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
CreatedBy	String	False		The user who created the opportunity deal record.
CreationDate	Datetime	False		The date and time when the opportunity deal record was created.
DealId	Long	False		The unique identifier of the deal.
LastUpdateDate	Datetime	False		The date and time when the opportunity deal record was last updated.
LastUpdatedBy	String	False		The user who last updated the opportunity deal record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the opportunity deal record.
OptyId	Long	False		The unique identifier of the opportunity.
PartyName	String	False		The name of the partner.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityLeads

The opportunity lead resource is used to view, create, and update the lead that resulted in an opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptyLeadId [KEY]	Long	False		This is the primary key of the opportunity leads table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
CreatedBy	String	False		The user who created the record.
CreationDate	Datetime	False		The date and time when the record was created.
DealEstimatedCloseDate	Datetime	False		The date when the deal registration for the opportunity is estimated to be closed.
DealExpirationDate	Datetime	False		The date when the lead registration will expire.
DealPartProgramId	Long	False		The unique identifier of the partner program associated with the lead registration.
DealType	String	False		The deal or lead registration type for the opportunity.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
LeadNumber	String	False		The unique identification number for the lead.
OptyId	Long	False		The unique identifier of the opportunity.
PartnerTypeCd	String	False		The type of the partner for the lead registration.
PrDealPartOrgPartyId	Long	False		The unique identifier for the partner on the lead registration.
PrDealPartResourcePartyId	Long	False		The unique identifier for the primary partner resource on the lead registration.
RegistrationNumber	String	False		The unique registration number of the lead for the opportunity.
UserLastUpdateDate	Datetime	False		The date and time when the opportunity lead was last updated from mobile.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityNotes

The note resource is used to capture comments, information, or instructions for an opportunity.

Columns


Name	Type	ReadOnly	References	Description
NoteId [KEY]	Long	False		This is the primary key of the notes table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
ContactRelationshipId	Long	False		The identifier of the relationship populated when the note is associated with a contact.
CorpCurrencyCode	String	False		The corporate currency code of the note associated with the contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CreatedBy	String	False		The user who created the note record.
CreationDate	Datetime	False		The date and time when the note record was created.
CreatorPartyId	Long	False		The unique party identifier for the note creator.
CurcyConvRateType	String	False		The currency conversion rate type associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
CurrencyCode	String	False		The currency code associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
LastUpdateDate	Datetime	False		The date when the note data was last updated.
NoteTxt	String	False		The actual note text.
NoteTypeCode	String	False		This code for categorization of the note type.
PartyId	Long	False		The unique Identifier of the party to which the note is associated.
PartyName	String	False		The name of party associated with the opportunity.
SourceObjectCode	String	False		The code of the source object Opportunities, as defined in OBJECTS Metadata.
SourceObjectId	String	False		The primary key identifier of the source object Opportunities, as defined in OBJECTS Metadata.
VisibilityCode	String	False		The visibility level of the note.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityPartners

The opportunity partner resource is used to view, create, and update the partners associated with this opportunity.The opportunity partner is used to store information about partners who are contributing to the selling effort of the current opportunity.

Columns


Name	Type	ReadOnly	References	Description
RevnPartOrgPartyId [KEY]	Long	False		This is the primary key of the opportunity partners table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
CreatedBy	String	False		The user who created the record.
CreationDate	Datetime	False		The date and time when the contact record was created.
DealEstCloseDate	Datetime	False		The date when the deal registration is estimated to close.
DealExpirationDate	Datetime	False		The date when the deal registration will expire.
DealType	String	False		The type of deal registration.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
OptyId	Long	False		The unique identifier of the opportunity.
PartOrgEmailAddress	String	False		The email address of the primary partner organization for this revenue.
PartOrgFormattedPhoneNumber	String	False		The phone number of the primary partner organization for this revenue.
PartOrgPartyId	Long	False		The unique identifier of the partner organization associated with the revenue.
PartProgramId	Long	False		The unique identifier of the partner program associated with the revenue.
PartTypeCd	String	False		The type of the party associated with the summary or primary revenue of the opportunity.
PartyId	Long	False		The unique identifier of the partner party is associated with the opportunity.
PartyName	String	False		The name of the partner associated with the opportunity.
PartyName1	String	False		The name of the primary partner resource associated with the opportunity.
PreferredContactEmail	String	False		The e-mail address of the partner's primary contact.
PreferredContactName	String	False		The name of the partner's primary contact.
PreferredContactPhone	String	False		The phone number of the partner's primary contact.
PrPartResourcePartyId	Long	False		The unique identifier of the primary partner resource.
RegistrationNumber	String	False		The registration number of the deal registration.
RegistrationStatus	String	False		The registration status of the partner who create the opportunity or deal.
RevnId	Long	False		The unique identifier of the summary or primary revenue for the opportunity.
RevnPartnerNumber	String	False		The unique number of the associated between the opportunity partner and a revenue line.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityRevenueItems

The revenue items resource is used to view, create, and update revenue items of an opportunity. The revenue items associated with opportunities are products, services, or other items a customer might be interested in purchasing. You add revenue items by selecting a product group or product to associate with an opportunity.

Columns


Name	Type	ReadOnly	References	Description
RevnId [KEY]	Long	False		This is the primary key of the revenue items table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
ActualCloseDate	Datetime	False		The date when the revenue line was closed.
BUOrgId	Long	False		The unique identifier of the Business Unit that owns the opportunity.
CloseReasonCode	String	False		The reason for winning or losing the revenue.
Comments	String	False		The user-provided comments for the revenue line.
CommitFlag	Boolean	False		Indicates if the revenue line should be used for forecasting. If the value is true, then the revenue line should be used for forecasting. The default value is False.
ConversionRate	Long	False		The currency conversion rate for converting the revenue amount to opportunity summary currency. The rate is used if the revenue line is different from that of the opportunity.
ConversionRateType	String	False		The currency conversion rate type for converting the revenue amount to opportunity summary currency. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
CostAmount	Decimal	False		The cost amount for the opportunity.
CreatedBy	String	False		The user who created the child revenue record.
CreationDate	Datetime	False		The date when the record was created.
CreditRcptPartOrgPartyId	Long	False		Credit Recipient Partner Organization Party.
CrmConversionRate	Long	False		The currency conversion rate for converting the revenue amount to CRM common currency for the Revenue Forecast Metrics. The rate is used if the revenue line is different from that of the opportunity.
CrmConversionRateType	String	False		The currency conversion rate type for converting the revenue amount to CRM common currency for Revenue Forecast Metrics. The rate type is used if the revenue line is different from that of the opportunity. For example, the rate type can be spot, user-defined, or corporate.
CrmCurcyCode	String	False		The common CRM currency code.
CustomerAccountId	Long	False		The unique identifier of the customer account that owns the opportunity.
Description	String	False		The user-provided description of the product associated with the revenue.
Discount	Decimal	False		The discount percent.
DownsideAmount	Decimal	False		The minimum amount of revenue for the opportunity.
EffectiveDate	Datetime	False		The date when the child revenue closes. The default value is the opportunity's close date.
ExpectAmount	Decimal	False		The maximum amount of revenue for the opportunity.
ExpectDlvryDate	Datetime	False		The expected delivery date for the product in the opportunity. This used only for opportunities that include products.
ForecastOverrideCode	String	False		The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
InventoryItemId	Long	False		The unique identifier of the product in the inventory.
InventoryOrgId	Long	False		The unique identifier of the organization in the inventory.
ItemNumber	String	False		The unique number of the product that is associated with the revenue.
ItemNumberInternal	String	False		The unique internal number of the product that is associated with the revenue.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
MarginAmount	Decimal	False		The margin amount for the opportunity.
Name1	String	False		The name of the territory.
NqSplitAllocTypeCode	String	False		The code indicating the non-quota allocation split type. The valid values are Adhoc amount and Proportional to Revenue.
OptyId	Long	False		The unique identified of the opportunity.
OptyLeadId	Long	False		Identifier for lead associated with opportunity.
OrganizationId	Long	False		The unique identifier of the organization to which the product belongs.
OwnerDealExpirationDate	Datetime	False		The date when the owner deal expires.
OwnerDealProtectedDate	Datetime	False		The date when the owner deal starts.
OwnerLockAsgnFlag	Boolean	False		Indicates if the revenue owner assignment should be locked. If the value is Y, then the owner assignment for the child revenue should be locked.
ParentRevnId	Long	False		The Parent revenue line id. Used for Lineset functionality.
PartEngagementTypeCd	String	False		Partner Engagement Type.
PartOrgPartyId	Long	False		The unique identifier of the primary revenue partner party.
PartOrgPartyName	String	False		The name of the primary partner associated with the child revenue.
PrCmptPartyId	Long	False		The unique identifier of the primary competitor of this child revenue.
PrimaryFlag	Boolean	False		Indicates if the revenue is the primary revenue. If the value is true, then the revenue is the primary revenue among all the child revenues. The default value is False.
ProdGroupId	Long	False		The unique identifier of the product group.
ProdGroupName	String	False		The name of the product group associated with the revenue.
ProductType	String	False		The type of product on the revenue line, such as item or product group.
PrPartOrgPartyId	Long	False		Primary Revenue Partner Organization Party.
PrTerritoryVersionId	Long	False		The unique identifier of the primary territory for this revenue item.
Quantity	Long	False		The quantity of product for this opportunity.
RecurDownsideAmount	Decimal	False		The minimum revenue amount from the recurrence.
RecurEndDate	Datetime	False		The date when the child revenue recurrence ends.
RecurFrequencyCode	String	False		The code that indicates the frequency of recurrence for the child revenue.
RecurNumberPeriods	Long	False		The number of time the child revenue should recur.
RecurParentRevnId	Long	False		The unique identifier for the parent revenue of the recurring revenue lines.
RecurPeriodOrEndDateCode	String	False		Indicates if a date or the number of recurrences are specified to end the recurrences.
RecurQuantity	Long	False		The quantity of the child revenue recurrence.
RecurRevnAmount	Decimal	False		The amount of revenue from the child revenue recurrence.
RecurStartDate	Datetime	False		The date when the recurrence starts.
RecurTypeCode	String	False		Indicates if the line is a standard revenue line or recurring revenue line.
RecurUnitPrice	Decimal	False		The price of each child revenue recurrence.
RecurUpsideAmount	Decimal	False		The maximum revenue amount from the recurrence.
ResourcePartyId	Long	False		The unique identifier of the revenue owner.
RevnAmount	Decimal	False		The amount of revenue that is earned from this opportunity.
RevnAmountCurcyCode	String	False		The currency code used to calculate the revenue for this opportunity.
RevnCategoryCode	String	False		The revenue category used in Revenue Line Set functionality.
RevnLineTypeCode	String	False		This denotes the type of revenue line like Opportunity Summary Revenue, Standard Revenue and so on.
RevnNumber	String	False		The user-editable unique identifier for the child revenue. The default value is the revenue identifier.
RevnSequenceNumber	Integer	False		The Revenue Sequence Number
SalesAccountId	Long	False		Identifier of the opportunity sales account.
SalesChannelCd	String	False		Sales Channel Code.
SalesCreditTypeCode	String	False		The type of the sales credit, such as quota or non-quota.
SplitParentRevnId	Long	False		The unique identifier of the split parent revenue.
SplitPercent	Long	False		The percentage of split revenue.
SplitTypeCode	String	False		The code that indicates if the split is revenue or non-revenue.
StatusCode	String	False		The unique code of the status for the child revenue.
TargetPartyId	Long	False		The unique identifier of the sales account that owns the opportunity.
TypeCode	String	False		The revenue type for the revenue earned from this opportunity.
UnitPrice	Decimal	False		The estimated unit price for the product.
UOMCode	String	False		The unit of measure code for the product.
UpsideAmount	Decimal	False		The maximum amount of revenue for the opportunity.
WinProb	Integer	False		The estimated probability of winning the opportunity.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityRevenueProductGroups

The product group resource is used to view, create, and update the product groups associated with an opportunity. The product group let you categorize products and services that you sell.

Columns


Name	Type	ReadOnly	References	Description
ProdGroupId	String	False		This is the primary key of the revenue territories table.
RevnId	Long	False
OptyNumber	String	False
Description	String	False		The user-provided description of the product group.
DisplayName	String	False		The name of the product group.
LastUpdateDate	String	False		The date the product group was last updated.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityRevenueProducts

The following table describes the default response for this task.

Columns


Name	Type	ReadOnly	References	Description
ProductNum [KEY]	String	False		The number of the product.
RevnId	String	False
OptyNumber	String	False
ActiveFlag	Boolean	False		Indicates if the product is Active.
Description	String	False		The description of the product associated with the opportunity.
EndDate	Datetime	False		The effective end date of the product.
InventoryItemId	Long	False		The unique identifier of the product inventory item associated with the opportunity.
InvOrgId	Long	False		The unique identifier of the inventory organization.
LastUpdateDate	Datetime	False		The date the product was last updated.
LongDescription	String	False		Text to describe the product.
ProdGroupId	Long	False		The unique identifier of the Product Group.
ProductType	String	False		The type of the product.
StartDate	Datetime	False		The effective start date of the product.
Text	String	False		The text or keywords associated with the product.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityRevenueTerritories

The opportunity revenue territories resource is used to view, create, and update the revenue territories of an opportunity. The territories assigned to an opportunity revenue line. The territories provide the rules for automatically assigning salespeople and other resources to customers, partners, leads, and opportunity line items.

Columns


Name	Type	ReadOnly	References	Description
RevnTerrId [KEY]	String	False		This is the primary key of the revenue territories table.
RevnId	Long	False
OptyNumber	String	False
AssignmentType	String	False		The type of assignment used to assign the territory to the opportunity.
CreatedBy	String	False		The user who created the revenue territory record.
CreationDate	Datetime	False		The date when the record was created.
EffectiveEndDate	Datetime	False		The date when the resource organization assignment to the territory ends.
EffectiveStartDate	Datetime	False		The date when the resource organization for the territory was assigned to the revenue line.
ForecastParticipationCode	String	False		The code to identify the forecast type that the territory participates in. For example, Revenue, Nonrevenue, Revenue and Nonrevenue, or Nonforecasting.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The login of the user who last updated the record.
Name	String	False		The name of the territory that the opportunity belongs to.
Name1	String	False		The name of the organization that the territory resource belongs to.
PartyId	Long	False		The unique identifier of the resource who owns the territory.
PartyName	String	False		The name of the territory owner for the opportunity.
RoleId	Long	False		The unique identifier of the resource's role.
RoleName	String	False		The name of the resource's role.
TerritoryId	Long	False		Territory identifier.
TerritoryVersionId	Long	False		Territory version identifier.
TypeCode	String	False		The type of territory assigned to the opportunity.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunitySources

The opportunity source resource is used to view, create, and update the source of an opportunity.The opportunity source is used to capture the marketing or sales campaign that resulted in this opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptySrcId [KEY]	Long	False		This is the primary key of the opportunity sources table.
OptyNumber	String	False
CreatedBy	String	False		The user who created the record.
CreationDate	Datetime	False		The date and time when the record was created.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
OptyId	Long	False		The unique Identifier of the opportunity.
SrcNumber	String	False		A unique number indicating the source of the marketing event for the opportunity, such as campaign, new product line, a marketing seminar, and so on.
UserLastUpdateDate	Datetime	False		The date and time when the opportunity was last updated from mobile.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

OpportunityTeamMembers

The opportunity team members resource is used to view, create, and update the team members associated with an opportunity. The opportunity team member of the deploying organization associated with the opportunity.

Columns


Name	Type	ReadOnly	References	Description
OptyResourceId [KEY]	Long	False		This is the primary key of the opportunity team members table.
OptyNumber [KEY]	String	False	Opportunities.OptyNumber
AccessLevelCode	String	False		The type of access granted to the resource as well as managers of the organizations. A list of accepted values are defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
AsgnTerritoryVersionId	Long	False		The unique identifier of the territory version for the resource that got assigned to the opportunity through territory-based assignment.
AssignmentType	String	False		The code indicating how the resource is assigned to the sales account team. A list of accepted values are defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
CreatedBy	String	False		The user who created the opportunity resource record.
CreationDate	Datetime	False		The date and time when the resource record was created.
DealExpirationDate	Datetime	False		The date on which the deal protection period of an opportunity team member ends. The date is updated for territory members when they are unassigned from a opportunity because of a territory realingment.
DealProtected	String	False		Indicates if the resource is under deal protection. If the value is True, then the resource is under deal protection. The default value is False.
DealProtectedDate	Datetime	False		The date on which the deal protection period of an opportunity team member starts. The date is updated for territory members when they are unassigned from a opportunity because of a territory realingment.
EmailAddress	String	False		The e-mail address of the opportunity team member.
FormattedPhoneNumber	String	False		The formatted phone number of the opportunity team member.
LastUpdateDate	Datetime	False		The date when the record was last updated.
LastUpdatedBy	String	False		The user who last updated the record.
LastUpdateLogin	String	False		The session login associated to the user who last updated the record.
LockAssignmentFlag	Boolean	False		Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.
MemberFunctionCode	String	False		The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
MgrResourceId	Long	False		The unique identifier of the resource team member's manager.
OptyId	Long	False		The unique Identifier of the opportunity.
OptyResourceNumber	String	False		The label that represents the association between the opportunity and resource.
OwnerFlag	Boolean	False		Indicates if the opportunity team member is the owner of the opportunity. If the value is True, then the opportunity team member is also the owner fo the opportunity. The default value is False.
PartnerOrgId	Long	False		The unique identifier of the partner organization.
PartnerPartyName	String	False		The name of the partner associated with the partner resource.
PartyName	String	False		The name of the opportunity team member.
PersonFirstName	String	False		The first name of the opportunity team member.
PersonLastName	String	False		The last name of the opportunity team member.
ResourceId	Long	False		The unique party identifier for the existing resource record in Oracle Sales.
RoleName	String	False		The role of the opportunity team member in the resource organization.
TerritoryName	String	False		The name of the opportunity team member's territory.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
RecordSet	String	Input specifying the resource type.
Finder	String	Input specifying the Finder type.

Territories

The sales territories resource represents the list of sales territories that the logged-in user can view. A sales territory is an organizational domain with boundaries defined by attributes of customers, products, services, resources, and so on. Sales territories can be created based on multiple criteria including postal code, area code, country, vertical market, size of company, product expertise, and geographical location. Sales territories form the fundamental infrastructure of sales management as they define the jurisdiction that salespeople have over sales accounts, or the jurisdiction that channel sales managers have over partners and partner transactions.

Columns


Name	Type	ReadOnly	References	Description
TerritoryVersionId [KEY]	Long	False		The unique identifier of the territory version.
CoverageModel	String	False		Indicates if the dimensions of the territory are based on account attributes or partner attributes.
DeleteFlag	Boolean	False		Indicates if the logged-in user can delete the territory.
Description	String	False		The description of the territory.
EffectiveEndDate	Datetime	False		The date and time when the territory version becomes active.
EffectiveStartDate	Datetime	False		The date and time when the territory version becomes active.
EligibleForQuotaFlag	Boolean	False		Indicates whether the territory is going to change during a territory realignment. If the value is True, then the territory is unlikely to change during a major realignment and therefore a quota can be entered against the proposed definition.
ForecastedByParentTerritoryFlag	Boolean	False		Indicates if the forecast for the territory is made by its parent territory.
ForecastParticipationCode	String	False		The code for the forecast participation. The accepted values are: REVENUE, NONREVENUE, REVENUE_AND_NONREVENUE, and NON_FORECASTING.
LatestVersionFlag	Boolean	False		Indicates the latest active version of the territory. If the value is True, then the territory version is the latest active version of the territory.
Name	String	False		The name of the territory.
OrganizationName	String	False		The name of the organization to which the owner belongs.
OwnerResourceId	Long	False		The unique identifier of the owner resource.
ParentTerritoryId	Long	False		The unique identifier of the parent territory.
PartnerId	Long	False		The unique identifier of the partner associated with the territory.
PartnerProgramId	Long	False		The unique identifier of the partner program to which the partner is enrolled.
ProgramName	String	False		The name of the partner program to which the partner is enrolled.
ReviseQuotaFlag	Boolean	False		Indicates whether a submitted quota needs to be revised.
RevisionDescription	String	False		The description of the reason for revising the quota.
RevisionReason	String	False		The user-defined reason for revising the quota.
SourceTerrId	Long	False		The identifier of the territory from which the dimensions are inherited.
SourceTerrLastUpdateDate	Datetime	False		The date and time when the source territory was last updated. This attribute is related to the inheritance of dimensions by recipient territories from source territories.
SourceTerrName	String	False		The name of the territory from which the selected dimensions are inherited.
SourceTerrVersionId	Long	False		The unique identifier of the source territory version.
StatusCode	String	False		The code for the territory status.
TerritoryId	Long	False		The unique identifier of the territory.
TerritoryLevel	Long	False		The level of the territory in the territory hierarchy.
TerritoryNumber	String	False		The unique alternate identification number for the territory.
TerrProposalId	Long	False		The unique identifier of the territory proposal.
TypeCode	String	False		The code for the territory type.
UpdateFlag	Boolean	False		Indicates if the logged-in user can update the territory.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Oracle Sales.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Oracle Sales, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Oracle Sales Stored Procedures


Name	Description

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Oracle Sales:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Opportunities table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Opportunities'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Opportunities table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Opportunities'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:oraclesalescloud:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
HostURL	The URL to the Oracle Sales server used for logging in.
Username	The username of the Oracle Sales account used to authenticate to the server.
Password	The password used to authenticate the user.

Connection

Property	Description
IncludeCustomFields	Specifies whether custom fields must be dynamically retrieved for existing tables. With this property set to false only standard columns will be displayed for a given table.
IncludeCustomObjects	Specifies whether custom objects must be dynamically retrieved or not. Custom tables will not be displayed unless this property is set to true.

SSL

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Logging

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Miscellaneous

Property	Description
ExpandFields	Determines whether the driver will leave the fields URL parameter blank when doing SELECT * queries.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from Oracle Sales.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
HostURL	The URL to the Oracle Sales server used for logging in.
Username	The username of the Oracle Sales account used to authenticate to the server.
Password	The password used to authenticate the user.

Connection

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

Property	Description
IncludeCustomFields	Specifies whether custom fields must be dynamically retrieved for existing tables. With this property set to false only standard columns will be displayed for a given table.
IncludeCustomObjects	Specifies whether custom objects must be dynamically retrieved or not. Custom tables will not be displayed unless this property is set to true.

IncludeCustomFields

Specifies whether custom fields must be dynamically retrieved for existing tables. With this property set to false only standard columns will be displayed for a given table.

Data Type

bool

Default Value

true

Remarks

See Custom Fields and Objects for detailed information.

IncludeCustomObjects

Specifies whether custom objects must be dynamically retrieved or not. Custom tables will not be displayed unless this property is set to true.

Data Type

bool

Default Value

false

Remarks

See Custom Fields and Objects for detailed information.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Verbosity

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
ExpandFields	Determines whether the driver will leave the fields URL parameter blank when doing SELECT * queries.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from Oracle Sales.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

If Timeout expires and the operation is not yet complete, the Cloud throws an exception.

Cloud

Oracle Sales - CData Cloud

Overview

Key Features

Getting Started

Connecting to Oracle Sales

Accessing Data from CData Cloud Services

Establishing a Connection

Custom Fields and Objects

Including Custom Fields

Including Custom Objects

Generating Schema Files

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Tables

CData Cloud - Oracle Sales Tables

AccountAddresses

Columns

AccountAddressPurposes

Columns

AccountNotes

Columns

AccountPrimaryAddresses

Columns

AccountRelationships

Columns

AccountResources

Columns

Accounts

Columns

Activities

Columns

ActivityAssignees

Columns

ActivityContacts

Columns

ActivityNotes

Columns

ActivityObjectives

Columns

ContactAddresses

Columns

ContactAddressPurposes

Columns

ContactNotes

Columns

ContactPrimaryAddresses

Columns

ContactRelationships

Columns

Contacts

Columns

ContactSalesAccountResources

Columns

EmployeeResourceAttachments

Columns

EmployeeResources

Columns

Opportunities

Columns

Pseudo-Columns

OpportunityCompetitors

Columns

Pseudo-Columns

OpportunityContacts

Columns

Pseudo-Columns

OpportunityDeals

Columns

Pseudo-Columns

OpportunityLeads

Columns

Pseudo-Columns

OpportunityNotes