Orbitera placeholders

Orbitera placeholders are tokens defined in a string that are swapped out for real values prior to being shown to a user. Placeholders make the system more dynamic, by pulling values already stored by Orbitera. The placeholder concept is used in:

  • Account and product callbacks
  • API deployments
  • Script deployments
  • Test Drives

Availabilty differs by component.

Availability codes

  • ACE: Account callback events
  • API: Product API deployment
  • S: Product script deployment (for example: AWS/Cloudformation)
  • T: Test Drives (used in emails generated from Test Drives)

Placeholder reference

Placeholder Current Availability
CloudAccountNumber API, S
CloudAccountProviderCode API, S
CompanyName1 T
CustomerId API
CustomerName ACE, API, T
CustomerEmail ACE, API
CustomerFirstName ACE, API
CustomerLastName ACE, API
CustomerTitle ACE, API
CustomerPhone ACE, API
CustomerOrganization ACE, API
CustomerAddressStreet ACE, API
CustomerAddressSuite ACE, API
CustomerAddressCity ACE, API
CustomerAddressStateCode ACE, API
CustomerAddressStateName ACE, API
CustomerAddressZip ACE, API
CustomerAddressCountryCode ACE, API
CustomerAddressCountryName ACE, API
ProductBinaryUrl2 ACE
ProductBinaryFilename ACE, API, S
ProductId API, S
ProductName ACE, API, S
ProductSku ACE, API, S
SubscriptionDescription API, S
SubscriptionId API, S
SubscriptionPlanId API, S
SubscriptionPlanName API, S
SubscriptionProductId API, S
SubscriptionProductName API, S
SubscriptionPlanFeaturesBase64Encoded3 API, S

Notes

  1. Account profile company name or account profile.
  2. The ProductBinaryUrl variable returns a signed timed URL to a file that was uploaded to the product. The URL is accessible for one hour. The duration is not customizable.
  3. Base64-encoded JSON array. Example Subscription Plan features JSON:

    [{"name":"This is the Plan Name","qty":0},{"name":"2 Copies","qty":2}]
    

Pass custom fields

If you defined custom fields for your customers, you can pass those custom fields using {CustomerField:NameOfField}.

Examples

https://myserver.com?userName={CustomerName}
https://myserver.com?product={ProductSku}
https://myserver.com?file={ProductBinaryFilename}
https://myserver.com?account={CloudAccountNumber}