Oracle Eloqua Developer Glossary
A
AppCallback
CallbackURL is the Eloqua URL an app calls into when configuration is
complete during installation.
Example:
Where {1} is the installId and {2} is a guid generated by Eloqua.
Note: this parameter is separate and distinct from the OAuth Callback URL.
AppId
AppId is a templated parameter used in AppCloud service apps. Its value is the GUID-based ID of the app making the service call. Each AppCloud app has a single unique AppId.
AssetId
AssetId is a templated parameter used in AppCloud service apps. Its value is the referencing asset's ID. Each instance of an asset will have a unique AssetId.
AssetName
AssetName is a templated parameter used in AppCloud service apps. Its value is the referencing asset's filename.
AssetPath
AssetPath is a templated parameter used in AppCloud service apps. Its value is the referencing asset's directory path.
AssetType
AssetType is a templated parameter used in AppCloud service apps. Its value is the referencing asset's type. Possible asset types include campaign, form, landing page, program, etc.
C
CampaignId
CampaignId is a templated parameter used in Landing Page Content services. Its value is the ID of the campaign retrieved using the elqCampaignId query parameter. It must be an integer. Learn more.
CustomObjectId
CustomObjectId is a templated parameter used in AppCloud action, decision, and feeder service apps for programs. Its value is the ID of the custom object associated with the program when CustomObjectRecords is specified for EntityType. It must be an integer.
D
Dictionary of Strings
Duration
E
EntityType
EntityType is a templated parameter used in AppCloud service apps. The value specifies the entity type the campaign or program is set to. Possible values are Contacts or CustomObjectRecords.
For instance, if a user drags a decision step onto a custom object program, the EntityType would be CustomObjectRecords because the program's entity type is set to custom objects. Alternatively, if that decision step was dragged onto a contact program, the EntityType would be Contacts.
Note that campaigns only support the contact entity type, but programs can support contacts or custom objects. Use the AssetType parameter to determine if the asset is a campaign or a program.
EventType
EventType is a templated parameter used in AppCloud service apps. Its value is the status change that triggered the call (Created, Activated, Draft, etc.)
List of EventType values:
Created,
Updated,
Deleted,
Activated,
ActivatedBySchedule,
Scheduled,
Draft,
DraftWaitingApproval,
DraftApproved,
CampaignAssetAdded,
CampaignAssetRemoved,
CampaignLandingPageAdded,
CampaignLandingPageRemoved,
CampaignFormAdded,
CampaignFormRemoved,
CampaignEmailAdded,
CampaignEmailRemoved,
CampaignSegmentAdded,
CampaignSegmentRemoved,
MembersAdded,
ContentRequired,
Completed.
ExecutionId
ExecutionId is a templated parameter used in AppCloud content service apps. Its value is an integer and identifies a unique email send execution.
F
Feeder
Feeders allow external systems to determine and control which contacts or custom objects enter into a campaign or program canvas, and when. Developers can now build apps that utilize data in third-party systems to drive campaign or program membership.
I
InstallId
InstallId is a templated parameter used in AppCloud service apps. Its value is the GUID for the user's installation of the AppCloud App. Whenever a user installs an app, a new InstallId is created.
InstanceId
InstanceId is a templated parameter used in AppCloud service apps. Its value is the GUID for the specific instance of the AppCloud service being used. For instance, when a user drags and drops an action or decision service onto a campaign canvas this is considered a distinct instance and a new InstanceId is created.
IsPreview
IsPreview is a templated parameter used in AppCloud content service apps. Its value specifies whether the referencing email is in preview mode. Possible values are:
O
oauth-expiration
Note:
- Authorization Codes expire in 60 seconds (intended for immediate use)
- Access Tokens expire in 8 hours
- Refresh Tokens expire in 1 year
- Refresh Tokens will expire immediately after being used to obtain new tokens, or after 1 year if they are not used to obtain new tokens
O
OriginalAssetId
OriginalAssetId is a templated parameter used in AppCloud service apps. It is specific to a service's Copy URL and its value is the original service's AssetId (as opposed to the copied service's AssetId).
OriginalAssetName
OriginalAssetName is a templated parameter used in AppCloud service apps. It is specific to a service's Copy URL and its value is the original service's AssetName (as opposed to the copied service's AssetName).
OriginalInstallId
OriginalInstallId is a templated parameter used in AppCloud service apps. It is specific to a service's Copy URL and its value is the original service's installId (as opposed to the copied service's InstallId).
OriginalInstanceId
OriginalInstanceId is a templated parameter used in AppCloud service apps. It is specific to a service's Copy URL and its value is the original service's InstanceId (as opposed to the copied service's InstanceId).
R
RenderType
RenderType is a templated parameter used in AppCloud content service apps. Its value specifies the different types of email renderings. Possible values are:
0: No render -- no content is being assembled.1: EmailSend -- content is being assembled for sending an email.2: LiveWeb -- content is being assembled to render a live landing page.3: EmailPreview -- content is being assembled to render an email preview.4: WebPreview -- content is being assembled to render a preview of a landing page.5: EmailSaved -- content is being assembled to render the web version of a sent email.
S
SiteId
SiteId is a templated parameter used in AppCloud service apps. Its value is the GUID-based ID for the user's Eloqua instance.
SiteName
SiteName is a templated parameter used in AppCloud service apps. Its value is the name of the user's Eloqua instance.
U
Unix Time
UserCulture
UserCulture is a templated parameter used in AppCloud service apps. Its value is the linguistic profile of the user of the user that triggered the call. Eloqua uses Microsoft's CultureInfo class to define culture. For example, for English (United States), the code is "en-US", for French (Canada) it is "fr-CA".
UserId
UserId is a templated parameter used in AppCloud service apps. Its value is the ID of the user who triggered the call.
UserName
UserName is a templated parameter used in AppCloud service apps. Its value is the name of the user who triggered the call.
UTC Timestamp
V
VisitorId
VisitorId is a templated parameter used in AppCloud content service apps. Its value is an integer and represents the ID of the visitor for whom you wish to construct a landing page.