Fonteva

Developer Documentation

Modals

Modals are used throughout the product to provide users with a simple way to modify records, view information, and navigate through a wizard.

Markup

<div class="slds-modal">
  <div class="slds-modal__container">
    <div class="slds-modal__header">
      <button class="slds-button slds-modal__close slds-button--icon-inverse">
        <lightning:icon iconName="utility:close" size="medium" />
      </button>
      <div class="slds-text-heading_medium">Title</div>
    </div>
    <div class="slds-modal__content slds-p-vertical_medium slds-p-horizontal_large">
      ...
    </div>
    <div class="slds-modal__footer">
      <button class="slds-button slds-button_neutral">
        ...
      </button>
      <button class="slds-button slds-button_brand">
        ...
      </button>
    </div>
  </div>
</div>
<div class="slds-backdrop" />
...
<div class="slds-modal__content slds-p-vertical_medium slds-p-horizontal_large">
  <div>...</div>
  <div class="slds-grid slds-gutters_x-small">
    <div class="slds-col">
      ...
    </div>
    <div class="slds-col">
      ...
    </div>
  </div>
  <div class="slds-grid slds-wrap slds-gutters_x-small">
    <div class="slds-col slds-medium-size_*-of-* slds-large-size_*-of-*">
      ...
    </div>
    <div class="slds-col slds-medium-size_*-of-* slds-large-size_*-of-*">
      ...
    </div>
  </div>
</div>
...
...
<div class="slds-modal__header slds-modal__header_empty">
  <button class="slds-button slds-modal__close slds-button--icon-inverse">
    <lightning:icon iconName="utility:close" size="medium" />
  </button>
</div>
...
...
<div class="slds-modal__footer">
  <button class="slds-button slds-button_neutral">
    ...
  </button>
  <button class="slds-button slds-button_brand">
    ...
  </button>
</div>
...

AnalyticsEvent

AnalyticsEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
eventString false pageview
pageNameString true
trackerIdString false UA-35884772-9

BaseComponent

BaseComponent
For more information on configuring Quick Actions, please visit Salesforce Help

Button

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
additionalClassesString false
dataAttributesMap Data attributes false {}
disableBoolean Disable Button false false
enableProgressIndicatorBoolean Progress Indicator false true
groupString false
imageClassesString Image Src false
imageSrcString Image Src false
isSubmitButtonBoolean false false
labelString false
lightningIconString Icon to load from Lightning:Icon component. false
lightningIconSizeString Size of icon to load from Lightning:Icon component. false medium
lightningIconVariantString Variant property for Lightning Icon false inverse
nameString false
onClickActionAura.Action This allows handling onClick events true
progressIndicatorLocationString Progress Indicator Location false expand-right
svgAssistiveTextString Image Src false
svgClassString Image Src false
svgContainerClassString Image Src false
svgPathString Image Src false
typeString false brand
valueString false

Methods

  • startIndicator()
  • stopIndicator(disable)
  • Parameters
    disable
    Type: Boolean
    Description:
    Required?: false
  • updateLabel(label)
  • Parameters
    label
    Type: String
    Description: Label For Button
    Required?: false

ButtonToggleIndicatorEvent

ButtonToggleIndicatorEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
actionString false toggle
groupString false

CurrencyField

For more information on configuring Quick Actions, please visit Salesforce Help

		Example for CurrencyField
	

Component Attributes

Attribute Name Attribute Type Description Required Default
currencyISOCodeString true
formattedValueString false
isMultiCurrencyOrgBoolean false false
showFreeLabelBoolean false true
valueString false 0

FileUploadCropEvent

FileUploadCropEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
actionString true
fieldIdString true

Img

Img
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
altString the img tag alt text false
classString the img tag class false
extraString comma-separated `key=value` to add extra attributes to the img tag false
heightString the img tag height false
idString the img tag id false
onclickAura.Action A callback for onclick events false
srcString the img tag source false
styleString the img tag style false
titleString the img tag title false
widthString the img tag width false

InputFieldClearErrorMessagesEvent

InputFieldClearErrorMessagesEvent
For more information on configuring Quick Actions, please visit Salesforce Help

InputFieldValidationEvent

Event template
For more information on configuring Quick Actions, please visit Salesforce Help

InputFieldValueChangedEvent

Event template
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
fieldIdString true
groupString false
oldValueObject false
optionsList false
secondaryGroupString false
valueObject false

InputFields

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
customFieldTypeBoolean Custom Field Type false false
disableRadioEventBoolean Disable Radio Event false false
disabledBoolean Disable Field false false
errorsList Errors false []
fieldNameString false
fieldTypeString input type field false
fireChangeEventBoolean Fire Change Event false false
formatString Format for field false
globalIdString Global Id false
groupString Group name false
helpTextString Help Text false
idString false
isBooleanBoolean false false
isRequiredBoolean input value false false
labelString input name false
labelStyleClassesString Addition CSS Classes for label false
linkTextString false
linkTextActionAura.Action false
loadingBoolean Loaded false true
maxValueValidationMessageString false Input max value is:
maxlengthInteger input length false
minValueValidationMessageString false Input must be greater than:
otherAttributesMap Other Attributes false {}
sObjectNameString false
secondaryGroupString Group name false
secondaryIdString false
selectOptionsList select options false
styleClassesString Addition CSS Classes false
stylesheetString input stylesheet false
suppressValidationMessagesBoolean false false
useSecondaryIdBoolean false false
validatedBoolean Validated false true
valueMap input value false {}

Methods

  • changeFieldType(fieldType, value, otherAttributes)
  • Change Field Type

    Parameters
    fieldType
    Type: String
    Description:
    Required?: true
    value
    Type: String
    Description: SelectedValue
    Required?: false
    otherAttributes
    Type: Object
    Description: SelectedValue
    Required?: false
  • clearErrorMessages()
  • Error Message For Field

  • clearOptions()
  • Clear Options available for the input

  • clearValue()
  • Clear Value via Method

  • reInitialize()
  • Reinitialize Comp

  • setErrorMessages(errorMessages)
  • Set Error Messages

    Parameters
    errorMessages
    Type: Array
    Description: Error Message
    Required?: false
  • setOtherAttributes(otherAttributes, forceReInitialization)
  • Set Other Attributes

    Parameters
    otherAttributes
    Type: Object
    Description: Other Attributes
    Required?: false
    forceReInitialization
    Type: Boolean
    Description: Force ReInitialization
    Required?: false
  • setSelectOptions(selectOptions, value)
  • Validate Field

    Parameters
    selectOptions
    Type: Array
    Description: Select Options
    Required?: false
    value
    Type: String
    Description: SelectedValue
    Required?: false
  • updateValue(value, refresh)
  • Update Value via Method

    Parameters
    value
    Type: String
    Description: Value To Set
    Required?: false
    refresh
    Type: Boolean
    Description: Fires input change event
    Required?: false
  • validate()
  • Validate Field

MessagePrompt

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
cancelButtonLabelString false Close
closeOnClickActionAura.Action This allows handling onClick events false {!c.hideModal}
enableSubmitButtonProgressIndicatorBoolean false true
idString false
messageString true
preFormatTextBoolean false false
severityString false info
showCancelButtonBoolean false true
showSubmitButtonBoolean false true
submitButtonLabelString false Submit
submitOnClickActionAura.Action This allows handling onClick events false {!c.hideModal}
titleString true

Methods

  • hideModal()
  • Modal Modal

  • showModal()
  • Show Modal

  • stopIndicator()
  • Stop Indicator

  • updateMessage(message)
  • Update Message

    Parameters
    message
    Type: String
    Description:
    Required?: true
  • updateTitle(title)
  • Update Title

    Parameters
    title
    Type: String
    Description:
    Required?: true

RefreshComponentEvent

Event template
For more information on configuring Quick Actions, please visit Salesforce Help

RefreshInputField

Event template
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
dataObject false {}
groupString false
refreshBoolean false
typeString false

RichTextInputFieldModalEvent

RichTextInputFieldModalEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
actionString true
fieldIdString true

SVG

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
assistiveTextString Description name of icon false
classString the class of this SVG tag, can be use for CSS purpose false
containerClassString Container class name for span container of icon false
nameString Symbol name of icon false
namespaceString Namespace false
svgClassString Class for SVG false
svgPathString the path for the icon in the static resource, this will be use in a SVG use tag false

ShowComponentEvent

Event template
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
componentNameString false
componentParamsObject false {}
identifierString false

Spinner

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Toast

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Methods

  • showMessage(title, message, autoHide, severity, position)
  • Parameters
    title
    Type: String
    Description:
    Required?: false
    message
    Type: String
    Description:
    Required?: false
    autoHide
    Type: Boolean
    Description:
    Required?: false
    severity
    Type: String
    Description:
    Required?: false
    position
    Type: String
    Description:
    Required?: false
  • showMessages(messages)
  • Parameters
    messages
    Type: List
    Description:
    Required?: false

Tooltip

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
helpTextString Help Text false

UIApi

UIApi
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
uniqueIdString true

UIApiResponseEvent

UIApiResponseEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
fieldsMap true
uniqueIdString true

UrlUtil

A method-only component containing methods dealing with URLs
For more information on configuring Quick Actions, please visit Salesforce Help

Methods

  • getTimedDirectLink(url, callback)
  • When passed a URL targeting /apex/AwsProxy, will return a signed, timed link direct to AWS. Otherwise returns the caller's URL. URL is the only parameter provided to the callback.

    Parameters
    url
    Type: String
    Description:
    Required?: false
    callback
    Type: Function
    Description:
    Required?: false
  • wrapLinks(cmp, attrNames, callback)
  • Performs `getDirectTimedLink` against all of the `attrNames` stored in `cmp`.

    Parameters
    cmp
    Type: Component
    Description:
    Required?: true
    attrNames
    Type: Object[]
    Description:
    Required?: true
    callback
    Type: Function
    Description:
    Required?: false

ValidationErrorMessages

ValidationErrorMessages
For more information on configuring Quick Actions, please visit Salesforce Help

Methods

  • hideMessages()
  • showMessages(messages)
  • Parameters
    messages
    Type: List
    Description:
    Required?: false

BaseComponent

BaseComponent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
disableThemeValueBoolean false false
isAuthenticatedBoolean false false
isRecordPreviewBoolean false false
organizationIdString false
salesOrderString false
siteIdValueString false
siteObjSiteRecord false
storeObjStore false
themeObjTheme false
usrMap false {}

BaseComponentLoadCompleteEvent

BaseComponentLoadCompleteEvent
For more information on configuring Quick Actions, please visit Salesforce Help

CookieUsagePrompt

CookieUsagePrompt
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
contactString Contact to load to check if cookie prompt is already accepted or not false
isGuestBoolean false false
isThemedBoolean Boolean to toggle the community theme or not false true
siteString Site to load to check if cookie prompt is required true

FontevaBaseInterface

FontevaBaseInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
identifierString false
isPreviewBoolean false
paramsMap false

FontevaController

Fonteva Controller
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
disableRoutingBoolean false false
disableThemeBoolean false false
isPreviewBoolean false false
recordIdString false
siteIdString false
urlVarsObject false

MediaAssetUploadQuickAction

MediaAssetUploadQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

ThemeBuilderQuickAction

ThemeBuilderQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

AccessPermission

AccessPermission
For more information on configuring Quick Actions, please visit Salesforce Help

AccessPermissionQuickAction

AccessPermissionQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

AdminAppConfig

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
appConfigObjObject false
newAppConfigObjObject false
settingObjsList false []

AmendSubscription

AmendSubscription
For more information on configuring Quick Actions, please visit Salesforce Help

CheckoutWrapper

CheckoutAddress
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
customerIdString false
environmentKeyString false
gatewayTokenString false
iFrameStylesString false
isThemedBoolean false true
offsiteRedirectUrlString false
paymentPageLoadedBoolean false false
paymentSuccessReturnObjMap false
postbackRedirectUrlString false
redirectUrlString false
retURLString false
returnObjMap false
salesOrderIdString false
salesOrderObjMap false {}
showOfflinePaymentBoolean false false
showProformaPaymentBoolean false false
storeIdId false
successfulPaymentReturnUrlString false

ContactCreatedEvent

ContactCreatedEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
accountIdString false
contactIdString false
uniqueIdentifierString true

ContactPopover

ContactPopover
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
accountIdString false
customerObjMap false {}
positionString false left
uniqueIdentifierString true customerLookup

Methods

  • closePopover()
  • setNameValues(firstName, lastName, accountId)
  • Parameters
    firstName
    Type: String
    Description:
    Required?: false
    lastName
    Type: String
    Description:
    Required?: false
    accountId
    Type: String
    Description:
    Required?: false
  • showPopover()

CustomPaymentTypeActionEvent

CustomPaymentTypeActionEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
paramsMap false {}
typeString true

CustomPaymentTypeInterface

CustomPaymentTypeInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
customPaymentTypeObjMap true
epaymentString false
iFrameStylesString false
pathPrefixString false
salesOrderString false

CustomerLookup

For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
autoHideContactBoolean false true
contactIdString false contactId
contactLabelString false Contact
contactNubbinLocationString false right
customerObjMap false {}
fireChangeEventBoolean input value false false
globalConIdString Global Value false
groupString Group name false
isRequiredBoolean input value false false
labelString false {!$Label.c.CustomerLookupLabel}
sldsIconResourceString false OrderApi__SLDS_Icons
validatedBoolean false false
valueMap false {}

Methods

  • showContactField()
  • updateValue(value, contact, fireChangeEvent)
  • Parameters
    value
    Type: String
    Description: Value To Set
    Required?: false
    contact
    Type: String
    Description: Value To Set
    Required?: false
    fireChangeEvent
    Type: Boolean
    Description: input value
    Required?: false
  • validate()

CustomerLookupFilterUpdatedEvent

CustomerLookupFilterUpdatedEvent
For more information on configuring Quick Actions, please visit Salesforce Help

InvoicePayment

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

Component Attributes

Attribute Name Attribute Type Description Required Default
storeIdId false

KnownAddressChangeEvent

KnownAddressChangeEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
uniqueIdString true
valueObject false

KnownAddressModalEvent

KnownAddressModalEvent indicates that the modal has been displayed.
For more information on configuring Quick Actions, please visit Salesforce Help

KnownAddresses

KnownAddresses
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
contactIdString true
createModalAddressHeaderString false {!$Label.c.Known_Address_New_Address_Modal_Header}
editModalAddressHeaderString false {!$Label.c.Known_Address_Edit_Address_Modal_Header}
knownAddressObjMap false
knownAddressesKnownAddress[] false
loadKnownAddressesBoolean false true
showNoAddressTextBoolean false false
showSummaryBoolean false false
uniqueIdString false
useBackdropBoolean false true
validatedBoolean false false
valueMap false {}

Methods

  • resetToDefaultAddress()
  • validate()
  • validateSummaryAddress()

KnownAddressesModal

CheckoutAddressModal
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
contactIdString true
createModalAddressHeaderString false New Address
editModalAddressHeaderString false Edit Address
uniqueIdString false
useBackdropBoolean false true
valueMap false {}

Methods

  • closeModal()
  • Close Modal

  • showModal(isNew, isFirst)
  • Show Modal

    Parameters
    isNew
    Type: Boolean
    Description:
    Required?: false
    isFirst
    Type: Boolean
    Description:
    Required?: false

ManageAddress

ManageAddress
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
hideHeaderBoolean false false
isThemedBoolean false false
recordIdId false

ManageKnownAddressesQuickAction

ManageKnownAddressesQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

ManageRenewalPathsQuickAction

ManageRenewalPathsQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

ManageSubscriptionPlansQuickAction

ManageSubscriptionPlansQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

PackageItemsListing

PackageItemsListing
For more information on configuring Quick Actions, please visit Salesforce Help

PayNow

PayNow
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
eCheckRedirectUrlString false
enableSavePaymentBoolean false true
environmentKeyString true
iFrameStylesString false
isFrontEndBoolean false true
isSalesOrderBoolean false true
offsiteRedirectUrlString false
overridePaymentMethodString false
pathPrefixString false
paymentObjMap false {}
paymentSuccessReturnObjMap false
postbackRedirectUrlString false
recordIdString false
renderAsTabsBoolean false false
requireSavePaymentMethodBoolean false false
showOfflinePaymentBoolean false false
storeIdString false
successRedirectUrlString false
suppressOffsiteButtonsBoolean false false

Methods

  • processTokenPayment()
  • validateTokenPayment()

PayNowTabChangeEvent

PayNowTabChangeEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
currentTabString true
customTabBoolean false false
showCustomButtonBoolean false false

PayPalPaymentType

PayPalPaymentType
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentGatewayListing

PackageItemsListing
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentGatewaysQuickAction

PaymentGatewaysQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentMethodChangeEvent

PaymentMethodChangeEvent
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentMethodTabsLT

PaymentMethodTabsLT
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentMethodTabsVF

PaymentMethodTabsVF
For more information on configuring Quick Actions, please visit Salesforce Help

PaymentMethods

PaymentMethods
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
hideHeaderBoolean false false
paymentGatewayPaymentGateway false
recordIdId false
singleGatewayToUseString false

PaymentMethodsInterface

PaymentMethodsInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
componentToCreateString true
contactIdString true
contactNameString false
paymentGatewayMap false
paymentMethodsObject[] false []

PaymentMethodsPaypal

PaymentMethodsPaypal
For more information on configuring Quick Actions, please visit Salesforce Help

PriceRules

For more information on configuring Quick Actions, please visit Salesforce Help

		Example Description
	

PriceRulesQuickAction

PriceRulesQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

ProcessingChangesEvent

ProcessingChangesEvent
For more information on configuring Quick Actions, please visit Salesforce Help

RefreshItems

RefreshItems
For more information on configuring Quick Actions, please visit Salesforce Help

Refunds

Refunds
For more information on configuring Quick Actions, please visit Salesforce Help

RenewSubscription

RenewSubscription
For more information on configuring Quick Actions, please visit Salesforce Help

SalesOrderInvoice

For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
dateFormatString true
retURLString false
returnObjMap false
salesOrderIdString false

SalesOrderProformaInvoice

For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
retURLString false
returnObjMap false
salesOrderIdString false

SalesOrderShipping

SalesOrderShipping
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
addressNotFoundTextString false {!$Label.c.Known_Address_None_Found}
isPortalBoolean false false
noAddressesFoundBoolean false false
salesOrderObject false {}
shippingObjMap false {}
validatedBoolean false false

SalesOrderUpdateEvent

SalesOrderUpdateEvent
For more information on configuring Quick Actions, please visit Salesforce Help

SalesOrders

For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
customerObjMap false {}
dateFormatString false
eCheckRedirectUrlString false
enableSavePaymentBoolean false true
environmentKeyString false
gatewayTokenString false
isCommunityViewBoolean false false
paymentPageLoadedBoolean false false
paymentSuccessReturnObjMap false
retURLString false
returnObjMap false
salesOrderIdString false
showHeaderButtonsBoolean false true
showOfflinePaymentBoolean false true
storeIdId false
successfulPaymentReturnUrlString false

SaveKnownAddressEvent

SaveKnownAddressEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
idString false
typeString false new
uniqueIdString false

SubmitOffsitePaymentEvent

SubmitOffsitePaymentEvent
For more information on configuring Quick Actions, please visit Salesforce Help

ToggleKnownAddressSummaryEvent

ToggleKnownAddressSummaryEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
showSummaryBoolean false false
uniqueIdString true

DeleteFilterRow

For more information on configuring Quick Actions, please visit Salesforce Help

EditLightingCompInterface

EditLightingCompInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
indexInteger false
pageComponentMap true
validatedBoolean false true

EventAgendaCriteria

EventAgendaCriteria
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeesLabelString attendees input field name false {!$Label.c.Event_Builder_Agenda_Attendees}
customListList[] false []
dateFormatString true
dayLabelBoolean days input field name false {!$Label.c.Event_Builder_Agenda_Day}
fieldOptionsObjMap false {}
headingLabelString label is used for main header false {!$Label.c.Event_Builder_Agenda_Search_and_Filter_Schedule_Items}
isCustomListBoolean false false
isPortalBoolean false false
sessionSearchLabelString session input field name false {!$Label.c.Event_Builder_Agenda_Schedule_Item_Search}
sortByLabelBoolean sort by input field name false {!$Label.c.Event_Builder_Agenda_Sort_By}
speakerLabelString speakers input field name false {!$Label.c.Event_Builder_Agenda_Speaker}
styleClassesString Addition CSS Classes false
trackLabelBoolean tracks input field name false {!$Label.c.Event_Builder_Agenda_Track}

Methods

  • filterScheduleItems(eventAgendaCriteriaObj)
  • This method filters and returns back the filtered schedule items.

    Parameters
    eventAgendaCriteriaObj
    Type: Map
    Description: Filter Parameter
    Required?: false

EventAgendaFilterEvent

EventAgendaFilterEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
eventAgendaCriteriaObjMap false {}
fieldIdString false

EventBuilderEditor

EventBuilderEditor
For more information on configuring Quick Actions, please visit Salesforce Help

EventBuilderQuickAction

EventBuilderQuickAction
For more information on configuring Quick Actions, please visit Salesforce Help

EventBuilderTabInterface

EventBuilderTabInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
eventObjMap false
sitesList false

EventBuilderWrapper

EventBuilderWrapper
For more information on configuring Quick Actions, please visit Salesforce Help

EventCategories

EventCategories
For more information on configuring Quick Actions, please visit Salesforce Help

AccountSearchComponent

AccountSearchComponent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
queryFilterString additional query filter to narrow down the accounts returned in the result false
storeObjStore false
valueMap input value false {}

BaseComponent

BaseComponent
For more information on configuring Quick Actions, please visit Salesforce Help

BuildEventPageEvent

BuildEventPageEvent
For more information on configuring Quick Actions, please visit Salesforce Help

ConferenceEvent

ConferenceEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventActionButtons

EventActionButtons
For more information on configuring Quick Actions, please visit Salesforce Help

Methods

  • stopIndicator(id)
  • Modal Modal

    Parameters
    id
    Type: String
    Description:
    Required?: true

EventAgenda

EventAgenda
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjAttendeeRecord false
previousComponentString false
readOnlyBoolean false true
showPurchaseBoolean false false

EventAgendaModal

EventAgendaModal
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjAttendeeRecord false
initialPurchaseBoolean false true
readOnlyBoolean false true
showPurchaseBoolean false false

EventAgendaSection

EventAgendaSection
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
initialPurchaseBoolean false true
readOnlyBoolean true
sessionMap true
showPurchaseBoolean false false

EventAgendaSectionItem

EventAgendaSectionItem
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
initialPurchaseBoolean false true
itemMap true
readOnlyBoolean false
showPurchaseBoolean false false

EventCancelRegistrationEvent

EventCancelRegistrationEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventChangePageEvent

EventChangePageEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomHTML

EventCustomHTML
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomHTMLEdit

EventCustomHTMLEdit
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomImage

EventCustomImage
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomImageEdit

EventCustomImageEdit
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomVideo

EventCustomVideo
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventCustomVideoEdit

EventCustomVideoEdit
For more information on configuring Quick Actions, please visit Salesforce Help

EventInterface

EventInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjMap false
componentObjMap false
directionString false next
eventObjMap false
identifierBoolean false
initialPurchaseBoolean false
isPreviewBoolean false false
readOnlyBoolean false false
salesOrderString false
salesOrderObjMap false
siteObjMap false
storeObjMap false
usrMap false

EventMainView

ConfEventMainView
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventOverview

EventOverview
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventPaymentReceipt

EventPaymentReceipt
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventPrimaryVenue

EventPrimaryVenue
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegAttendeeChangeEvent

EventRegAttendeeChangeEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegSeatingSeat

EventRegSeatingSeat
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegSeatingSection

EventRegSeatingSection
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegisterButtonToggleEvent

EventRegisterButtonToggleEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationAttendee

EventRegistrationAttendee
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
disableRemoveBoolean false false
eventObjMap false
fireChangeEventBoolean false true
indexInteger false -1
isAuthenticatedBoolean false true
isGuestBoolean false false
isSalesOrderLineBoolean false true
isWaitlistBoolean false false
labelString false {!$Label.c.Search_Attendee_Field_Label}
labelStyleClassesString false hidden
lineMap true
primaryRegistrationInvitationBoolean false false
salesOrderIdString false
salesOrderObjMap salesOrderObj false {}
showAttendeeLabelBoolean false false
showHorizontalPaddingBoolean false true
storeObjMap true

EventRegistrationAttendeeSelection

EventRegistrationAttendeeSelection
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
initialPurchaseBoolean false true
previousComponentString false

EventRegistrationAttendeeUpdateEvent

EventRegistrationAttendeeUpdateEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
assignmentAssignment false
linesSalesOrderLine[] false
salesOrderLineSalesOrderLine false
salesOrderObjMap false
waitlistWaitlistEntry false

EventRegistrationCheckoutSummary

EventRegistrationCheckoutSummary
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
previousComponentString false

EventRegistrationFlowDetails

EventRegistrationFlowDetails
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjMap false

EventRegistrationForm

EventRegistrationForm
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationForms

EventRegistrationForms
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
disableNavigationButtonsBoolean false false
isTicketFormsBoolean false true
previousComponentString false
subjectLookupFieldString false OrderApi__Assignment__c

EventRegistrationInvitationOnly

EventRegistrationInvitationOnly
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
showRegisterButtonBoolean false true

EventRegistrationSeatingAssignment

EventRegistrationSeatingAssignment
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationSeatingTicket

EventRegistrationSeatingTicket
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationSeatingTickets

EventRegistrationSeatingTickets
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationSeatingWrapper

EventRegistrationSeatingWrapper
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventRegistrationTicketSelection

EventRegistrationTicketSelection
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
linesByTicketList false
showRegisterButtonBoolean false false
ticketPurchaseObjObject false

EventRegistrationWrapper

EventRegistrationWrapper
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
agendaOnlyBoolean false false
initialPurchaseBoolean false true
readOnlyBoolean false true
secondaryCompNameString false

EventSecondaryVenues

EventSecondaryVenues
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

EventSpeakers

EventSpeakers
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventSponsorPackages

EventSponsorPackages
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventSponsors

EventSponsors
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

EventToggleSideNavEvent

EventToggleSideNavEvent
For more information on configuring Quick Actions, please visit Salesforce Help

EventVenueMap

EventVenueMap
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

EventWrapper

EventWrapper
For more information on configuring Quick Actions, please visit Salesforce Help

FeaturedEventSpeakers

FeaturedEventSpeakers
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

FeaturedEventSponsors

FeaturedEventSponsors
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

FontevaBaseInterface

FontevaBaseInterface
Interface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
identifierString false
paramsMap false

FontevaController

Fonteva Controller (DO NOT USE)
For more information on configuring Quick Actions, please visit Salesforce Help

Login

Login
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
eventIdString false
loginDataMap false {}
returnUrlString false
showOverviewBoolean false false
siteObjMap false
storeObjMap false

LoginComponentEvent

LoginComponentEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
cancelLoginProcessBoolean false
enabledBoolean false
guestContactMap false
showOverviewBoolean false false

ManageMyRegistration

ManageMyRegistration
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

MyAttendeeForm

MyAttendeeForm
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjMap true
attendeesObject[] false

MyAttendeeSessionForms

MyAttendeeSessionForms
Implements: LTE:EventInterface
Extends: LTE:EventBase
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjMap true

MyAttendees

MyAttendees
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeesAttendeeRecord[] false

MyAttendeesForms

MyAttendeesForms
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Receipt

Receipt
For more information on configuring Quick Actions, please visit Salesforce Help

RegistrationProcessChangeEvent

RegistrationProcessChangeEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
actionString true
componentString false
salesOrderObjMap false

RegistrationProcessCompleteEvent

RegistrationProcessCompleteEvent
For more information on configuring Quick Actions, please visit Salesforce Help

RegistrationProcessSetGlobalObjectsEvent

RegistrationProcessSetGlobalObjectsEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeObjMap false
salesOrderObjMap false

RegistrationToolbarUpdateEvent

RegistrationToolbarUpdateEvent
For more information on configuring Quick Actions, please visit Salesforce Help

ReloadAttendeesEvent

ReloadAttendeesEvent
For more information on configuring Quick Actions, please visit Salesforce Help

RequiredPackageItemClassEvent

RequiredPackageItemClassEvent
For more information on configuring Quick Actions, please visit Salesforce Help

SalesOrderLineDeletedEvent

SalesOrderLineDeletedEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
soMap updated salesorder obj false
solIdString sol to be deleted false

SeatSelectedEvent

SeatSelectedEvent
For more information on configuring Quick Actions, please visit Salesforce Help

SessionSelectEvent

SessionSelectEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
allowConflictsboolean Shows if selected session allow conflicts false false
fireServerCallboolean fire apex method to create session items false false
sessionstring Session Selected true
sessionItemstring Session Selected true
sessionSelectedboolean Session Selected or removed true
ticketTypesList ticketType sols selected for the session false []
waitlistedboolean Session Selected as waitlist false false

ShowSeatingTicketsEvent

ShowSeatingTicketsEvent
For more information on configuring Quick Actions, please visit Salesforce Help

ToggleOrderSummaryCloseButtonEvent

ToggleOrderSummaryCloseButtonEvent
For more information on configuring Quick Actions, please visit Salesforce Help

TransferAttendeeRegistration

TransferAttendeeRegistration
Implements: LTE:EventInterface
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
attendeeMap attendee is an object to transfer contact to false {}
attendeeObjMap attendeeObj is a current user attendee false {}

TransitionAttendeeModal

TransitionAttendeeModal
For more information on configuring Quick Actions, please visit Salesforce Help

Component Attributes

Attribute Name Attribute Type Description Required Default
actionString false
classString false

ViewSectionEvent

ViewSectionEvent
For more information on configuring Quick Actions, please visit Salesforce Help

Api

Api Service, Resource, and Mapping objects

Methods

This component supports the following methods.

getAPIGroupings:
global static List<Grouping> getAPIGroupings(String apiService)
Method Arguments
Name Type Description
apiService String
Returns: List<Api.Grouping> -
getDispatchObjs:
global static List<Dispatch> getDispatchObjs()
getDispatchObjs:
global static List<Dispatch> getDispatchObjs(String apiService)
Method Arguments
Name Type Description
apiService String
Returns: List<Api.Dispatch> -
getService:
global static Service getService(String apiService)
Method Arguments
Name Type Description
apiService String {String} Api.Service.name
Returns: Api.Service - Service
getServices:
global static Service[] getServices(String namespace)
Method Arguments
Name Type Description
namespace String
Returns: List<Api.Service> - Service[] list of all Api.Service objects configured
getServices:
global static Service[] getServices()
getResources: Returns Api.Resource objects related to the given apiService {Api.Service.name}, and apiObject {Api.Resource.apiObject}
global static Resource[] getResources(String apiService)
Method Arguments
Name Type Description
apiService String {String} value for Api.Service.name
Returns: List<Api.Resource> - Api.Resource[]
getResourcesByGrouping: Returns Api.Resource objects related to the given apiGrouping {Api.Grouping.name}
global static Resource[] getResourcesByGrouping(String apiGrouping)
Method Arguments
Name Type Description
apiGrouping String {String} value for Api.Grouping.name
Returns: List<Api.Resource> - Api.Resource[]
getAllResources: Returns all Api.Resource objects
global static Resource[] getAllResources()
getServiceConnections: Returns Api.ServiceConnection objects related to the given apiService {Api.Service.name}
global static ServiceConnection[] getServiceConnections(String apiService)
Method Arguments
Name Type Description
apiService String {String} value for Api.Service.name
Returns: List<Api.ServiceConnection> - Api.ServiceConnection[]
getServiceConnectionConfig: Return Api.ServiceConnectionConfig object based on name and connection
global static ServiceConnectionConfig getServiceConnectionConfig(String serviceConnection,String name)
Method Arguments
Name Type Description
serviceConnection String String name
name String String name of config value
Returns: Api.ServiceConnectionConfig - ServiceConnectionConfig obj
setDailyCalloutLimitConfig: Set the Daily Limit of HTTP callouts for each service connection
global static Api.ServiceConnectionConfig setDailyCalloutLimitConfig(String apiServiceConnection,Integer dailyLimit)
Method Arguments
Name Type Description
apiServiceConnection String String
dailyLimit Integer Integer
Returns: Api.ServiceConnectionConfig - Api.ServiceConnectionConfig
getResource: Returns Api.Resource object related to the given apiService {Api.Service.name}, and apiObject {Api.Resource.apiObject}
global static Resource getResource(String apiService, String targetSObject)
Method Arguments
Name Type Description
apiService String {String} value for Api.Service.name
targetSObject String
Returns: Api.Resource - Api.Resource
getVariables: Returns custom setting Variable objects for making outgoing calls
global static Variable[] getVariables(String apiResource)
Method Arguments
Name Type Description
apiResource String {String} value for Api.Resource object
Returns: List<Api.Variable> - List<Api.Variable> objects
getMappings: Returns all Api.Mapping objects related to a given Api.Service found by {String} apiService, and {String} apiObject
global static Mapping[] getMappings(String apiResource, String apiObject)
Method Arguments
Name Type Description
apiResource String
apiObject String {String} value for the Api.Resource.apiObject
Returns: List<Api.Mapping> - Api.Mapping[]
getMapping: Returns Api.Mapping object related to the given apiService {Api.Service.name}, apiObject {Api.Resource.apiObject}, and apiField {Api.Mapping.apiField}
global static Mapping getMapping(String apiResource, String apiObject, String apiField)
Method Arguments
Name Type Description
apiResource String
apiObject String {String} value for the Api.Resource.apiObject
apiField String {String} value for the Api.Mapping.apiField
Returns: Api.Mapping - Api.Mapping
deserialize: Returns a new SObject for the given apiService {Api.Service.name} and Dom.XmlNode (must have a root element matching a Api.Resource related to the Api.Service returned by the apiName {String})
global static SObject[] deserialize(String apiService, Dom.XmlNode node)
Method Arguments
Name Type Description
apiService String {String} Name of the Api.Service object to find
node Dom.XmlNode {Dom.XmlNode} XML node where the root element matches
Returns: List<SObject> - SObject[]
getPreviousJSONResponse: Get Previous JSON response based on Api.Resource and the HTTP Verb that was used. This method allows dev to get old responses to pull out data needed.
global static Map<String,Object> getPreviousJSONResponse(Api.Resource resource, String httpVerb, Integer position)
Method Arguments
Name Type Description
resource Api.Resource Api.Resource
httpVerb String String
position Integer Integer Position the JSON to pull out if the same resource has been called mulitple times
Returns: Map<String, Object> - Map<String,Object> serialize JSON response
getLastJSONResponse: Get Last JSON response based on Api.Resource and the HTTP Verb that was used. This method allows dev to get old responses to pull out data needed.
global static Map<String,Object> getLastJSONResponse(Api.Resource resource, String httpVerb)
Method Arguments
Name Type Description
resource Api.Resource Api.Resource
httpVerb String String
Returns: Map<String, Object> - Map<String,Object> serialize JSON response
getLastRawResponse: Get Last Raw response based on Api.Resource and the HTTP Verb that was used. This method allows dev to get old responses to pull out data needed.
global static String getLastRawResponse(Api.Resource resource, String httpVerb)
Method Arguments
Name Type Description
resource Api.Resource Api.Resource
httpVerb String String
Returns: String - String raw response from vendor
get: Method to get a list of SObjects based on Resource Name
global static List<SObject> get(String resourceName)
Method Arguments
Name Type Description
resourceName String String resource name
Returns: List<SObject> - List<SObject> List of Sobjects that are mapped from JSON
get: Method to get a list of SObjects based on Resource Name with custom config object
global static List<SObject> get(String resourceName,Api.ResourceConfig config)
Method Arguments
Name Type Description
resourceName String String resource name
config Api.ResourceConfig Api.ResourceConfig that stores such things as uri, url and header parameters
Returns: List<SObject> - List<SObject> List of Sobjects that are mapped from JSON
post: Method to POST SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> post(String resourceName,SObject sObj)
Method Arguments
Name Type Description
resourceName String String resource name
sObj SObject SObject that will be converted to JSON
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from POST response
post: Method to POST SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> post(String resourceName,SObject sObj,Api.ResourceConfig config)
Method Arguments
Name Type Description
resourceName String String resource name
sObj SObject SObject that will be converted to JSON
config Api.ResourceConfig Api.ResourceConfig that stores such things as uri, url and header parameters
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from POST response
post: Method to POST SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> post(String resourceName,List<SObject> SObjects)
Method Arguments
Name Type Description
resourceName String String resource name
SObjects List<SObject> List<SObject> that will be converted to JSON
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from POST response
post: Method to POST SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> post(String resourceName,List<SObject> SObjects,Api.ResourceConfig config)
Method Arguments
Name Type Description
resourceName String String resource name
SObjects List<SObject> List<SObject> that will be converted to JSON
config Api.ResourceConfig Api.ResourceConfig that stores such things as uri, url and header parameters
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from POST response
put: Method to PUT SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> put(String resourceName,SObject sObj)
Method Arguments
Name Type Description
resourceName String String resource name
sObj SObject SObject that will be converted to JSON
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from PUT response
put: Method to PUT SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> put(String resourceName,SObject sObj,Api.ResourceConfig config)
Method Arguments
Name Type Description
resourceName String String resource name
sObj SObject SObject that will be converted to JSON
config Api.ResourceConfig Api.ResourceConfig that stores such things as uri, url and header parameters
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from PUT response
put: Method to PUT SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> put(String resourceName,List<SObject> SObjects)
Method Arguments
Name Type Description
resourceName String String resource name
SObjects List<SObject> List<SObject> that will be converted to JSON
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from PUT response
put: Method to PUT SObjects from Saleforce to remote server. Converts SObject to JSON
global static List<SObject> put(String resourceName,List<SObject> SObjects,Api.ResourceConfig config)
Method Arguments
Name Type Description
resourceName String String resource name
SObjects List<SObject> List<SObject> that will be converted to JSON
config Api.ResourceConfig Api.ResourceConfig that stores such things as uri, url and header parameters
Returns: List<SObject> - List<SObject> List of SObjects that are mapped from PUT response
:
global static String makeRequest(String endpoint,        String uri,        List<String> uriParameters,        Map<String,String> urlParameters,        VendorAuthenticationService vendorAuthService,        String body,        String method,        Map<String,String> headers,        Boolean debugMode,        Boolean retryAuth)

Api.ResourceConfig

Api.ResourceConfig top-level object for configuration of new Api resource network calls

Methods

This component supports the following methods.

ResourceConfig: Constructor that will setup some base information such as parameters, uri parameters, headers
global ResourceConfig()
ResourceConfig: Constructor that will setup some base information such as parameters, uri parameters, headers
global ResourceConfig(Map<String,String> parameters,List<String> uriParameters,Map<String,String> headers)
Method Arguments
Name Type Description
parameters Map<String, String>
uriParameters List<String>
headers Map<String, String>
Returns: Void
setParameters: Set Parameters map for URL calls
global void setParameters(Map<String,String> parameters)
Method Arguments
Name Type Description
parameters Map<String, String> Map<String,String> of GET/POST parameters
Returns: Void
setUriParameters: Set list of URI parameters that will be filled into the URL
global void setUriParameters(List<String> uriParameters)
Method Arguments
Name Type Description
uriParameters List<String> List<String>
Returns: Void
setHeaders: Set Headers Map that will be used for network calls
global void setHeaders(Map<String,String> headers)
Method Arguments
Name Type Description
headers Map<String, String> Map<String,String> key/value pairs of parameters
Returns: Void
setServiceConnection: Set the Service Connection the user would like to use for the outgoing calls
global void setServiceConnection(String serviceConnection)
Method Arguments
Name Type Description
serviceConnection String String name of service connection
Returns: Void
setCheckForExistingRecords: Set the check for existing records or bypass that
global void setCheckForExistingRecords(Boolean checkForExistingRecords)
Method Arguments
Name Type Description
checkForExistingRecords Boolean Boolean
Returns: Void
setRawResponseOnly: Set so that the raw response is saved and no mapping is done
global void setRawResponseOnly(Boolean rawResponseOnly)
Method Arguments
Name Type Description
rawResponseOnly Boolean Boolean
Returns: Void

Api.ServiceConnectionConfig

Multiple configuration values such as scope etc for OAuth calls.
Properties
configId: String
name: String
value: String
isMasked: Boolean
apiServiceConnection: String

Api.ServiceConnection

Service connection class that stores multiple connections tied to a single Service
Properties
configId: String
accessToken: String
refreshToken: String
clientId: String
clientSecret: String
username: String
password: String
apiService: String
isDefault: Boolean
scope: String
configs: List<Api.ServiceConnectionConfig>

Api.Service

Api.Service top-level object for configuration of new Api integrations
Properties
name: String
namespace: String
endpoint: String
isEnabled: Boolean
debugMode: Boolean
apexClass: String
imagePath: String
authType: VendorAuthenticationService.AuthType
displayName: String
description: String
isReadOnly: Boolean
resources: List<Api.Resource>
connections: List<Api.ServiceConnection>

Api.Resource

Api.Resource contains all Api.Mappings related to a given response object

Methods

This component supports the following methods.

setParentGrouping:
global void setParentGrouping(String parentGrouping)
Method Arguments
Name Type Description
parentGrouping String
Returns: Void
getParentGrouping:
global String getParentGrouping()
Properties
configId: String
apiService: String
apiObject: String
targetSObject: String
apiObjectKeyField: String
targetObjectKeyField: String
createURI: String
readURI: String
updateURI: String
deleteURI: String
createVerb: String
readVerb: String
updateVerb: String
deleteVerb: String
disablePostPutParse: Boolean
mappings: List<Api.Mapping>
variables: List<Api.Variable>

Api.Grouping

Api.Grouping individual api Groups under the API.Resource

Methods

This component supports the following methods.

setGroupingId:
global void setGroupingId(String groupingId)
Method Arguments
Name Type Description
groupingId String
Returns: Void
setApiResource:
global void setApiResource(String apiResource)
Method Arguments
Name Type Description
apiResource String
Returns: Void
setApiService:
global void setApiService(String apiService)
Method Arguments
Name Type Description
apiService String
Returns: Void
getApiService:
global String getApiService()
setApiObject:
global void setApiObject(String apiObject)
Method Arguments
Name Type Description
apiObject String
Returns: Void
setTargetrelatedLookupField:
global void setTargetrelatedLookupField(String targetrelatedLookupField)
Method Arguments
Name Type Description
targetrelatedLookupField String
Returns: Void
getGroupingId:
global String getGroupingId()
getApiResource:
global String getApiResource()
getApiObject:
global String getApiObject()
getTargetrelatedLookupField:
global String getTargetrelatedLookupField()

Api.Mapping

Api.Mapping individual api fields mapped to SObjectFields for a given Api.Service and Api.Resource
Properties
configId: String
apiService: String
apiResource: String
apiObject: String
apiField: String
targetField: String
targetFieldType: String
relatedObjectField: String

Api.Variable

Api.Variable that maps to outgoing request variable such as GET variables. Ability to set if field has default value and if it is required
Properties
configId: String
apiResource: String
defaultValue: String
fieldApiName: String
fieldApiValue: String
required: Boolean
deserializeMapping: Map<String, String>
serializeMapping: Map<String, String>

Api.Dispatch

Properties
configId: String
apiResource: String
sObjectName: String
isEnabled: Boolean
afterInsert: Boolean
afterUpdate: Boolean
disableRun: Boolean
executionOrder: Integer
httpVerb: String
apiService: String
dispatchVariables: List<Api.DispatchHeaderVariables>

Api.DispatchHeaderVariables

Properties
configId: String
apiDispatch: String
key: String
value: String
isHeader: Boolean
isVariable: Boolean
isTokenVariable: Boolean
tokenOrder: Integer

ApiOauthController

OAuth controller class that will do the login flow using the interface

Methods

This component supports the following methods.

ApiOauthController:
global ApiOauthController()
getToken: Call Vendor to get the Token based on the OAuth login flow
global PageReference getToken()
login: Login and start OAuth flow to send to vendor site
global PageReference login(String apiConnectionName)
Method Arguments
Name Type Description
apiConnectionName String String of the connection name to use to login
Returns: PageReference - PageReference Send user to vendors login page
login: Login and start OAuth flow to send to vendor site
global PageReference login()

ApiRouteBase

Api Route base for all routes

Methods

This component supports the following methods.

getRoute:
global virtual Blob getRoute()
postRoute:
global virtual Blob postRoute()
putRoute:
global virtual Blob putRoute()
deleteRoute:
global virtual Blob deleteRoute()

ApiRouter

Rest Api Router For Framework

Methods

This component supports the following methods.

get:
global static void get()
post:
global static void post()
put:
global static void put()

ApiRouter.Route

ApiRouter.Route top-level object for configuration of new Api integrations

Methods

This component supports the following methods.

setName:
global void setName(String name)
Method Arguments
Name Type Description
name String
Returns: Void
setApexClass:
global void setApexClass(String apexClass)
Method Arguments
Name Type Description
apexClass String
Returns: Void
getName:
global String getName()
getApexClass:
global String getApexClass()

AppUpdate

Wrapper class for Update Custom Setting

Methods

This component supports the following methods.

get:
global static AppUpdate get(String updateName)
Method Arguments
Name Type Description
updateName String
Returns: AppUpdate -
isActivated:
global static Boolean isActivated(String updateName)
Method Arguments
Name Type Description
updateName String
Returns: Boolean -
isActivated:
global static Boolean isActivated(String updateName, Datetime createdDate)
Method Arguments
Name Type Description
updateName String
createdDate Datetime
Returns: Boolean -
Properties
configId: String
displayName: String
description: String
isActivated: Boolean
apexClass: String
forcedActivationDate: Date
namespace: String

AppUpdateInterface

Interface class for App Updates
Interface

Methods

This component supports the following methods.

activateUpdate:
void activateUpdate()

AwsUtil

AwsUtil provides helper methods to deal with files stored securely in AWS. For internal users, this class is the controller for AwsProxy.page & UrlUtil.cmp

Methods

This component supports the following methods.

getTimedDirectLink: Transforms links targeting our internal AwsProxy into timed, direct links to AWS. Otherwise return the URL.
global static String getTimedDirectLink(String url)
Method Arguments
Name Type Description
url String the url to transform
Returns: String - the transformed link
getPostSignature:
global static S3Data getPostSignature(String key,Boolean usePublicBucket)
Method Arguments
Name Type Description
key String
usePublicBucket Boolean
Returns: AwsUtil.S3Data -

AwsUtil.S3Data

Properties
signature: String
isoDate: String
credential: String
policyJson: String
expires: String
bucketName: String
region: String
ttl: Integer

Config

Platform configuration objects for JSON serialization/deserialization. Used to register apps and provide an easy way to export and import JSON based configurations.

Methods

This component supports the following methods.

export: Exports Fonteva configurations
global static String export()
export: Exports Fonteva configurations
global static String export(Boolean prettify)
Method Arguments
Name Type Description
prettify Boolean Return JSON String in "Pretty Print" format
Returns: String - String JSON string
push: Commit configuration objects to the database
global static void push(Object configObject)
Method Arguments
Name Type Description
configObject Object {Object} Instance of any supported
Returns: Void
push: Commit configuration objects to the database
global static void push(Object[] configObjects)
Method Arguments
Name Type Description
configObjects List<Object> {Object[]} Instance of any supported
Returns: Void
clear: Removes the given configuration object from Framework custom settings
global static void clear(Object configObject)
Method Arguments
Name Type Description
configObject Object {Object} Instance of configuration object
Returns: Void
clear: Removes the given configuration object from Framework custom settings
global static void clear(Object[] configObjects)
Method Arguments
Name Type Description
configObjects List<Object> {Object[]} Instance of configuration object
Returns: Void
clear:
global static void clear(String namespace)
Method Arguments
Name Type Description
namespace String
Returns: Void
clearAll: Remove all configurations from Framework custom settings
global static void clearAll()
Properties
registeredApps: List<RegisteredApp>

CurrencyUtils

Util class to convert currencies from record currencyisocode to system currencyisococde.

Methods

This component supports the following methods.

getCurrencyIsoCode: retrieves the currencyisocode of the organisation.
global static String getCurrencyIsoCode(SObject record)
Method Arguments
Name Type Description
record SObject
Returns: String - string

CustomScript

Custom Script configuration class provides low-level interaction static methods and serves as an instance of a Framework Custom Script object
Properties
apexClass: String
name: String
namespace: String
description: String

DecimalUtils

Static methods for working with Decimals

Methods

This component supports the following methods.

round: Returns the rounded (System.RoundingMode.Half_Up) value for the given decimal
global static Decimal round(Decimal decimalToRound)
Method Arguments
Name Type Description
decimalToRound Decimal {Decimal}
Returns: Decimal - {Decimal}

Dispatcher

Dispatcher routes SObjects sent by triggered events to the appropriate Domain Apex Class for logic processing. Dispatcher also logs any non-final exception thrown as a new System Log record to assist trouble shooting and defect replication.

Methods

This component supports the following methods.

dispatchTrigger: Primary method for routiung SObjects sent by Apex Triggers. <p> The syntax for calling this method from a trigger is simple <example> trigger AccountTrigger on Account (before insert...) { Fonteva.Dispatcher.dispatchTrigger(); } <p> No arguments are required because all trigger variables persist as context variables throughout the execution context of any given trigger event. Registered App, and Registered Objects are dynamically detected using various Apex Describe methods.
global static void dispatchTrigger()
Properties
dispatchLog: List<Dispatcher.Route>
disableTriggerInContext: Map<String, Boolean>

Dispatcher.Route

Class to route dispatched action such as Trigger execution
Properties
dispatchedClass: Type
order: Integer
sobjectToken: SobjectType

Domain

Domain model software pattern for manaing SObject logic and validation through a series of stubbed out overrideable methods

Methods

This component supports the following methods.

Domain: Constructor for Domain with list of SObjects that are going to be acted up
global Domain(List<SObject> sObjectList)
Method Arguments
Name Type Description
sObjectList List<SObject> List<SObject>
Returns: Void
applyDefaults:
global virtual void applyDefaults()
validate:
global virtual void validate()
validate:
global virtual void validate(Map<Id,SObject> existingRecords)
Method Arguments
Name Type Description
existingRecords Map<Id, SObject>
Returns: Void
beforeInsert:
global virtual void beforeInsert()
beforeUpdate:
global virtual void beforeUpdate(Map<Id,SObject> existingRecords)
Method Arguments
Name Type Description
existingRecords Map<Id, SObject>
Returns: Void
beforeDelete:
global virtual void beforeDelete()
afterInsert:
global virtual void afterInsert()
afterUpdate:
global virtual void afterUpdate(Map<Id,SObject> existingRecords)
Method Arguments
Name Type Description
existingRecords Map<Id, SObject>
Returns: Void
afterDelete:
global virtual void afterDelete()
error: Returns the same message that was passed in as an argument after adding the error to the errorList @see ErrorFactory
global String error(String message, SObject record)
Method Arguments
Name Type Description
message String Message to show to the end user that explains the nature of the error
record SObject SObject that caused the error
Returns: String - String The value of the message string passed in as an argument
error: Returns the same message that was passed in as an argument after adding the error to the errorList @see ErrorFactor
global String error(String message, SObject record, SObjectField field)
Method Arguments
Name Type Description
message String Message to show to the end user that explains the nature of the error
record SObject SObject that caused the error
field SObjectField SObject field that caused the error
Returns: String - String The value of the message string passed in as an argument
Properties
records: List<SObject>
errors: Domain.ErrorFactory

Domain.DomainConstructor

Interface

Methods

This component supports the following methods.

construct:
Domain construct(List<SObject> sObjectList)
Method Arguments
Name Type Description
sObjectList List<SObject>
Returns: Domain -

FormatUtils

Methods

This component supports the following methods.

getDatePlaceholderText: Generate a Date Format string per the User's Locale setting
global static String getDatePlaceholderText()
formatStrToDate:
global static Date formatStrToDate(String dateStr)
Method Arguments
Name Type Description
dateStr String
Returns: Date -
formatDateToStr:
global static String formatDateToStr(Date dateObj)
Method Arguments
Name Type Description
dateObj Date
Returns: String -

Guid

GUID (Global Unique Identifier) generator class

Methods

This component supports the following methods.

generate: Returns a random and unique GUID a.k.a. Global Unique Identifier in the form of a string
global static String generate()

Installer

Installer for populating settings and defaults for the Fonteva Framework @implements Scriptable

Methods

This component supports the following methods.

onInstall: Method to be called on installation of Framework
global static void onInstall(InstallContext context)
Method Arguments
Name Type Description
context InstallContext InstallContext
Returns: Void
onUninstall: Method to be called on installation of Framework
global static void onUninstall(UninstallContext context)
Method Arguments
Name Type Description
context UninstallContext InstallContext
Returns: Void
install: Static method to install the base objects from Framework
global static void install()

Log

Implementation of Fonteva Framework system logs with several static methods useful for interacting with the log including creating logs, and stack trace leveling

Methods

This component supports the following methods.

setAppInContext: Set the app in context so logs can blame the appropriate app when an exception is caught by dispatcher or otherwise debugged via the Log service Framework @throws InvalidAppNamespaceException if no Registered_App__c sobject is found for the given namespace.
global static void setAppInContext(String sparkNamespace)
Method Arguments
Name Type Description
sparkNamespace String The registered namespace for the Spark app to set in context.
Returns: Void
setObjectInContext: Sets the object in context for the Log by sobjectType (objectToken)
global static void setObjectInContext(SobjectType objectToken)
Method Arguments
Name Type Description
objectToken SobjectType SobjectType of the object in context.
Returns: Void
push: Pushes a function 'push' event into the stack trace
global static void push(String eventDescription)
Method Arguments
Name Type Description
eventDescription String
Returns: Void
push: Creates new diagnostic entry for the current log
global static void push(String apexClass, String method)
Method Arguments
Name Type Description
apexClass String String value for Apex Class name
method String String value for Apex Class method name
Returns: Void
pop: Pops the current level and adds a INFO level debug in the Salesforce debug log
global static void pop()
debug: Log ad-hoc debug statement into the diagnosticLog which can be helpful when an exception is later thrown in the script statement to trace the core problem back to the root cause
global static void debug(String debugString)
Method Arguments
Name Type Description
debugString String Content to push to the current log.
Returns: Void
debugException: Creates a new System Log record containing useful debug related date including the current stack trace and all diagnostic log entries that occured before the exception was caught in an execution context
global static void debugException(Exception ex)
Method Arguments
Name Type Description
ex Exception Exception object to create the System Log for
Returns: Void
popAll: Resets the currentLevel to 0 and calls pop()
global static void popAll()
CurrentLog: Returns the string value of the current diagnostic log
global static String CurrentLog()

LookupController

Controller for the Lookup.component

Methods

This component supports the following methods.

:
global static List<SObject> searchRecords(String queryString, String objectName,        List<String> fieldNames, String fieldsToSearch,        String filterClause, String orderBy, Integer recordLimit)

Message

Methods

This component supports the following methods.

getMessage:
global String getMessage()
getSeverity:
global Severity getSeverity()
serialize:
global static String serialize()
addMessage: Static block to initialize cache in execution context.
global static void addMessage(String message)
Method Arguments
Name Type Description
message String
Returns: Void
addMessage:
global static void addMessage(String message,Severity severityType)
Method Arguments
Name Type Description
message String
severityType Message.Severity
Returns: Void
addMessage:
global static void addMessage(Exception ex,Severity severityType)
Method Arguments
Name Type Description
ex Exception
severityType Message.Severity
Returns: Void
addMessage:
global static void addMessage(String messageStr,Severity severityType, Boolean logMessage)
Method Arguments
Name Type Description
messageStr String
severityType Message.Severity
logMessage Boolean
Returns: Void
clear:
global static void clear()
getMessages:
global static List<Message> getMessages(Severity severityType)
Method Arguments
Name Type Description
severityType Message.Severity
Returns: List<Message> -
getMessages:
global static Map<Severity,List<Message>> getMessages()
Properties
Success: Message.Severity

Message.Severity

Enum Values

  • Error
  • Danger
  • Warning
  • Info
  • Success

PageUtils

Static utility methods for working with Apex Pages

Methods

This component supports the following methods.

getParam: Returns String value of a page parameter
global static String getParam(String paramName)
Method Arguments
Name Type Description
paramName String Name of the page parameter to return
Returns: String - String
getIdParam: Returns Id value of a page parameter
global static Id getIdParam(String paramName)
Method Arguments
Name Type Description
paramName String Name of the page parameter to return
Returns: Id - Id
getBooleanParam: Returns Id value of a page parameter
global static Boolean getBooleanParam(String paramName)
Method Arguments
Name Type Description
paramName String Name of the page parameter to return
Returns: Boolean - Boolean

RegisteredApp

Registered App configuration class instance and static methods

Methods

This component supports the following methods.

export: Exports the configuration JSON data for a given Registered App
global static String export(String namespace)
Method Arguments
Name Type Description
namespace String The Namespace of the registered app to export configurations
Returns: String - String JSON configurations for the given registered app in the installed org
export: Exports the configuration JSON data for a given Registered App
global static String export(String namespace, Boolean prettify)
Method Arguments
Name Type Description
namespace String The Namespace of the registered app to export configurations
prettify Boolean Return JSON string in "Pretty Print" format
Returns: String - String JSON configurations for the given registered app in the installed org
Properties
name: String
namespace: String
apexNamespace: String
homepage: String
description: String
installClass: String
iconImageUrl: String
bannerImageUrl: String
owner: String
developerEmail: String
shortDescription: String
isEnabled: Boolean
isManaged: Boolean
isPaid: Boolean
registeredObjects: List<RegisteredObject>
routingRules: List<RoutingRule>
customScripts: List<CustomScript>
rollupSummaryFields: List<RollupSummaryField>
apiServices: List<Api.Service>
settingsPages: List<SettingsPage>

RegisteredObject

Registered Object configuration class
Properties
sObjectName: String
namespace: String
apexClass: String
soqlLimit: String
soqlOrderBy: String
salesforceId: String
triggersEnabled: Boolean
isEnabled: Boolean
isStandard: Boolean
validationDisabled: Boolean
orderBy: String

Registry

Helper class for Registry__mdt, the generic key/value store

Methods

This component supports the following methods.

runOnce: Run a script once. Uses the registry to prevent re-run of jobs.
global static Boolean runOnce(Scriptable s, String jobName)
Method Arguments
Name Type Description
s Scriptable the scriptable to run once
jobName String a key name that the job will be stored as
Returns: Boolean - true if the job ran; false if it was skipped
getEntries: Get active registry entries. Fields are Id, MasterLabel, Category__c, Key__c, Value__c, & Is_Enabled
global static List<Registry__mdt> getEntries()
getEntry: Get a registry enty. Fields are Id, MasterLabel, Category__c, Key__c, Value__c, & Is_Enabled
global static Registry__mdt getEntry(String category, String key)
Method Arguments
Name Type Description
category String
key String
Returns: Registry__mdt - the entry specified by category+key or null if not found
getEntries: Get registry entries. Fields are Id, MasterLabel, Category__c, Key__c, Value__c, & Is_Enabled
global static List<Registry__mdt> getEntries(Boolean includeDisabled)
Method Arguments
Name Type Description
includeDisabled Boolean pass true to include entries with `Is_Enabled=false`
Returns: List<Registry__mdt> - all of the registry entries
getEntriesByCat: Get active registry entries matching the category. Fields are Id, MasterLabel, Category__c, Key__c, Value__c, & Is_Enabled
global static List<Registry__mdt> getEntriesByCat(String category)
Method Arguments
Name Type Description
category String the category to filter on
Returns: List<Registry__mdt> - matching registry entries
getEntryMapByCat: Get active registry entries matching the category. Returns a map of keys => values
global static Map<String, String> getEntryMapByCat(String category)
Method Arguments
Name Type Description
category String the category to filter on
Returns: Map<String, String> - matching map of keys => values
getEntryMapByCat: Get active registry entries matching the category. Returns a map of keys => values
global static Map<String, String> getEntryMapByCat(String category, Boolean includeDisabled)
Method Arguments
Name Type Description
category String the category to filter on
includeDisabled Boolean pass true to include entries with `Is_Enabled=false`
Returns: Map<String, String> - matching map of keys => values
getEntriesByCat: Get registry entries matching the category. Fields are Id, MasterLabel, Category__c, Key__c, Value__c, & Is_Enabled
global static List<Registry__mdt> getEntriesByCat(String category, Boolean incudeDisabled)
Method Arguments
Name Type Description
category String the category to filter on
incudeDisabled Boolean pass true to include entries with `Is_Enabled=false`
Returns: List<Registry__mdt> - matching registry entries
upsertEntry: Upsert a registry entry, identified by category+key
global static void upsertEntry(String category, String key, String value)
Method Arguments
Name Type Description
category String the category
key String the key
value String the value
Returns: Void
upsertEntries: Upsert a batch of registry entries, each identified by category+key
global static void upsertEntries(List<Entry> entries)
Method Arguments
Name Type Description
entries List<Registry.Entry> a list of registry entries to upsert
Returns: Void
upsertGenericEntries:
global static void upsertGenericEntries(List<GenericEntry> entries)
Method Arguments
Name Type Description
entries List<Registry.GenericEntry>
Returns: Void

Registry.Entry

Data transfer object used when calling `upsertEntries`

Methods

This component supports the following methods.

Entry: Convenience constructor
global Entry(String category, String key, String value)
Method Arguments
Name Type Description
category String the entry category
key String the entry key
value String the entry value
Returns: Void
Properties
category: String
key: String
value: String

Registry.GenericEntry

Generic data transfer object used when calling `upsertGenericEntries`. Does not upsert "Registry" entries, inserts _any_ type of custom metadata

Methods

This component supports the following methods.

GenericEntry: Convenience constructor
global GenericEntry(String fullName, String label, Map<String, String> fqKeysValues)
Method Arguments
Name Type Description
fullName String the full name of the metadata record
label String the friendly name of the metadata record
fqKeysValues Map<String, String> a map of fully-qualified keys => string values to be set in the metadata record
Returns: Void
GenericEntry: Convenience constructor
global GenericEntry(String fullName, String label, Map<String, Object> fqKeysObjValues)
Method Arguments
Name Type Description
fullName String the full name of the metadata record
label String the friendly name of the metadata record
fqKeysObjValues Map<String, Object>
Returns: Void
Properties
fullName: String
label: String
fqKeysValues: Map<String, String>

RollupSummaryField

Registered Object configuration class
Properties
configId: String
namespace: String
childField: String
childSObject: String
parentField: String
parentSObject: String
relationshipField: String
filter: String
operation: String
isEnabled: Boolean
enableTrigger: Boolean
Concatenate_Distinct: RollupSummaryField.Operation

RollupSummaryField.Operation

Enum Values

  • Sum
  • Max
  • Min
  • Avg
  • Count
  • Concatenate
  • Concatenate_Distinct

RollupSummaryService

Static methods for declaritive rollup calculations @see RollupSummary

Methods

This component supports the following methods.

rollup: Method wraps the Rollup.rollup method, provides context via the lookups described in Rollup_Summary_Field__c
global static void rollup(List<SObject> childRecords)
Method Arguments
Name Type Description
childRecords List<SObject> Child records being modified
Returns: Void

RoutingRule

Routing Rule configuration class
Properties
configId: String
apexClass: String
namespace: String
sObjectName: String
isEnabled: Boolean
executionOrder: Integer

SObjectService

Service for Sobjects(Insert, update, Delete, Upsert)

Methods

This component supports the following methods.

insertRecord:
global static void insertRecord(SObject obj)
Method Arguments
Name Type Description
obj SObject
Returns: Void
insertRecords:
global static void insertRecords(SObject[] objects)
Method Arguments
Name Type Description
objects List<SObject>
Returns: Void
updateRecord:
global static void updateRecord(SObject obj)
Method Arguments
Name Type Description
obj SObject
Returns: Void
updateRecords:
global static void updateRecords(SObject[] objects)
Method Arguments
Name Type Description
objects List<SObject>
Returns: Void
deleteRecord:
global static void deleteRecord(SObject obj)
Method Arguments
Name Type Description
obj SObject
Returns: Void
deleteRecords:
global static void deleteRecords(SObject[] objects)
Method Arguments
Name Type Description
objects List<SObject>
Returns: Void
upsertRecord:
global static void upsertRecord(SObject obj)
Method Arguments
Name Type Description
obj SObject
Returns: Void
upsertRecords:
global static void upsertRecords(SObject[] objects)
Method Arguments
Name Type Description
objects List<SObject>
Returns: Void

SObjectUtils

Static utility methods for working with SObjects

Methods

This component supports the following methods.

getPicklistValues: Returns List<SelectOption> for a given SObjectField
global static SelectOption[] getPicklistValues(SObjectField field)
Method Arguments
Name Type Description
field SObjectField
Returns: List<SelectOption> - List<SelectOption>
getDependentPicklistOptions:
global static Map<String,List<Map<String,String>>> getDependentPicklistOptions(SObjectType baseObject, SObjectField controllingField,SObjectField dependentField)
Method Arguments
Name Type Description
baseObject SObjectType
controllingField SObjectField
dependentField SObjectField
Returns: Map<String, List<Map<String, String>>> -
mapObject: Returns the target SObject with the values of any custom fields found on the source SObject that share the same local name (api name without a namespace prefix - if applicable)
global static SObject mapObject(SObject source, SObject destination)
Method Arguments
Name Type Description
source SObject Source SObject to map values
destination SObject
Returns: SObject - SObject Source SObject with updated valuesap
mapObject: Returns the target SObject with the values of any custom fields found on the source SObject that share the same local name (api name without a namespace prefix - if applicable)
global static SObject mapObject(SObject source, SObject destination, Boolean updateEmptyFieldsOnly)
Method Arguments
Name Type Description
source SObject Source SObject to map values
destination SObject Target SObject to update values
updateEmptyFieldsOnly Boolean
Returns: SObject - SObject Source SObject with updated valuesap
mapObject: @see mapObject
global static SObject mapObject(SObject source, SObject destination, Boolean updateEmptyFieldsOnly, Boolean updateBooleanFields)
Method Arguments
Name Type Description
source SObject
destination SObject
updateEmptyFieldsOnly Boolean
updateBooleanFields Boolean
Returns: SObject -
mapObject:
global static SObject mapObject(SObject source, SObject destination, Boolean updateEmptyFieldsOnly, Boolean updateBooleanFields, Boolean updateAcrossNamespaces)
Method Arguments
Name Type Description
source SObject
destination SObject
updateEmptyFieldsOnly Boolean
updateBooleanFields Boolean
updateAcrossNamespaces Boolean
Returns: SObject -
mapChildFieldsFromRelated: Returns the target SObject with the values of any custom fields found on the source SObject that share the same local name (api name without a namespace prefix - if applicable)
global static void mapChildFieldsFromRelated(SObject[] records, String referenceToParentId, Map<String, String[]> fieldMap)
Method Arguments
Name Type Description
records List<SObject> Record SObject to map values
referenceToParentId String Parent SObject Id reference field name in child
fieldMap Map<String, List<String>> Map of Parent field names to be mapped to child field names
Returns: Void
getIdValue: Returns Id value for a given SObject and fieldName (API Name)
global static Id getIdValue(SObject sObj, String fieldName)
Method Arguments
Name Type Description
sObj SObject SObject
fieldName String SObjectField Api Name
Returns: Id - Id
validatefieldsCSV: validates the csv fields.
global static Boolean validatefieldsCSV(String objectName, String fieldCSV)
Method Arguments
Name Type Description
objectName String name of the object to be validated against.
fieldCSV String list of comma seperated fields.
Returns: Boolean - Boolean
validatefieldsCSV: validates the csv fields that can be used in a where clause of a soql.
global static Boolean validatefieldsCSV(String objectName, String fieldCSV, Boolean isFilterable, Boolean isSortable)
Method Arguments
Name Type Description
objectName String name of the object to be validated against.
fieldCSV String list of comma seperated fields.
isFilterable Boolean
isSortable Boolean
Returns: Boolean - Boolean
validatefieldSetsCSV: validates the csv fieldsets.
global static Boolean validatefieldSetsCSV(String objectName, String fieldSetCSV)
Method Arguments
Name Type Description
objectName String name of the object to be validated against.
fieldSetCSV String list of comma seperated fieldsets.
Returns: Boolean - Boolean
validatefieldSetsNoNSPCSV: validates the csv fieldsets without nsp.
global static Boolean validatefieldSetsNoNSPCSV(String objectName, String fieldSetCSV)
Method Arguments
Name Type Description
objectName String name of the object to be validated against.
fieldSetCSV String list of comma seperated fieldsets.
Returns: Boolean - Boolean

SchemaService

The SchemaService class provides built in caching for collecting various Apex Describe information on both SObjects and SObject fields.

Methods

This component supports the following methods.

getSObjectType: Returns a token for the SObjectType found by the string value of the SObject's api name.
global static SObjectType getSObjectType(String objectName)
Method Arguments
Name Type Description
objectName String String value of the SObject API name
Returns: SObjectType - SObjectType
getDescribe: Returns a DescribeSObjectResult object for a given SObjectType token.
global static DescribeSObjectResult getDescribe(SObjectType objectToken)
Method Arguments
Name Type Description
objectToken SObjectType The SObjectType to return the
Returns: DescribeSObjectResult - DescribeSObjectResult
getFieldSetMap: Returns a map with key of the field api name (without namespace if same as pkg) and value of the Schema.Fieldset.
global static Map<String, Schema.Fieldset> getFieldSetMap(SObjectType token)
Method Arguments
Name Type Description
token SObjectType SObjectType token to return the field map for.
Returns: Map<String, Schema.Fieldset> - Map<String, Schema.Fieldset>
getFieldMap: Returns a map with key of the fieldset api name (without namespace if same as pkg) and value of the fildset.
global static Map<String,SObjectField> getFieldMap(SObjectType token)
Method Arguments
Name Type Description
token SObjectType SObjectType token to return the field map for.
Returns: Map<String, SObjectField> - Map<String,SObjectField>
getSObjectField: Returns the token for a SObject field from the SObjectType 'token' and a String 'fieldName'.
global static SObjectField getSObjectField(SObjectType token, String fieldName)
Method Arguments
Name Type Description
token SObjectType
fieldName String
Returns: SObjectField - SObjectField
getDescribe: Returns the DescribeFieldResult object for a given SObjectField
global static DescribeFieldResult getDescribe(SObjectField field)
Method Arguments
Name Type Description
field SObjectField SObjectField to describe
Returns: DescribeFieldResult - DescribeFieldResult
getDescribe: Return a field describe for a given object and field by string value for each argument (objectName and fieldName)
global static DescribeFieldResult getDescribe(String objectName, String fieldName)
Method Arguments
Name Type Description
objectName String The api name for the SObject type that contains the field to describe
fieldName String The api name for the field to describe
Returns: DescribeFieldResult - DescribeFieldResult
getDescribe: Returns a DescribeFieldResult object for a given SObjectType and field name (String value)
global static DescribeFieldResult getDescribe(SObjectType objectToken, String fieldName)
Method Arguments
Name Type Description
objectToken SObjectType SObjectType for the SObject that holds the
fieldName String String value of the api name for the field to return
Returns: DescribeFieldResult - DescribeFieldResult
checkObjectAccess: Returns the name of a relationship in string form - used to create dynamic queries in the Selector class
global static Boolean checkObjectAccess(SObjectType objectType, Boolean isInsert, Boolean isUpdate, Boolean isDelete)
Method Arguments
Name Type Description
objectType SObjectType
isInsert Boolean
isUpdate Boolean
isDelete Boolean
Returns: Boolean -

Scriptable

Interface used by CustomScripts for ad-hoc script integration of Registered Apps - displayed on the Registered Apps detail page in Mission Control
Interface

Methods

This component supports the following methods.

run:
void run()

Selector

Selector class for enabling common SOQL queries across registered objects with built in feature detection for Person Account, and Multi-Currency orgs, adding fields for those features when called in orgs enabled for them.

Methods

This component supports the following methods.

getSObjectType: Override to allow a no-argument constructor for an extension to this class
global virtual SObjectType getSObjectType()
getFieldSets: Returns a list of Field Sets to use as the query fields if applicable
global virtual List<FieldSet> getFieldSets()
getOrderBy:
global virtual String getOrderBy()
Selector: Global no-argument constructor, only valid if the class is being constructed in an extension class
global Selector()
Selector:
global Selector(SObjectType type,Boolean enableForUpdate)
Method Arguments
Name Type Description
type SObjectType
enableForUpdate Boolean
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,Boolean enableForUpdate)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
enableForUpdate Boolean
Returns: Void
Selector:
global Selector(SObjectType type,Integer soqlLimit)
Method Arguments
Name Type Description
type SObjectType
soqlLimit Integer
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,String soqlSort)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
soqlSort String
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,Integer soqlLimit)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
soqlLimit Integer
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause, SObjectField lookupField)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
lookupField SObjectField
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,Integer soqlLimit,Boolean enableForUpdate)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
soqlLimit Integer
enableForUpdate Boolean
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause, SObjectField lookupField,Boolean enableForUpdate)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
lookupField SObjectField
enableForUpdate Boolean
Returns: Void
Selector:
global Selector(SObjectType type, SObjectField lookupField, String soqlWhereClause,Integer soqlLimit)
Method Arguments
Name Type Description
type SObjectType
lookupField SObjectField
soqlWhereClause String
soqlLimit Integer
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,String soqlSort,Integer soqlLimit,SObjectField lookupField)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
soqlSort String
soqlLimit Integer
lookupField SObjectField
Returns: Void
Selector:
global Selector(SObjectType type,String soqlWhereClause,String soqlSort,Integer soqlLimit,SObjectField lookupField,Boolean enableForUpdate)
Method Arguments
Name Type Description
type SObjectType
soqlWhereClause String
soqlSort String
soqlLimit Integer
lookupField SObjectField
enableForUpdate Boolean
Returns: Void
Selector: Construct from SObjectType
global Selector(SObjectType type)
Method Arguments
Name Type Description
type SObjectType SObjectType
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a token for a child object lookup field to include a relationship query to the target child sobject type in the query result
global Selector(SObjectType type, SObjectField lookupField)
Method Arguments
Name Type Description
type SObjectType SObjectType
lookupField SObjectField SObjectField
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a token for a child object lookup field to include a relationship query to the target child sobject type in the query result
global Selector(SObjectType type, SObjectField lookupField, String soqlFilter)
Method Arguments
Name Type Description
type SObjectType SObjectType
lookupField SObjectField SObjectField
soqlFilter String String
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a list of field sets to use for the fields to query as opposed to the default query all fields behavior of this class
global Selector(SObjectType type, FieldSet fieldSet)
Method Arguments
Name Type Description
type SObjectType SObjectType
fieldSet FieldSet FieldSet
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a list of field sets to use for the fields to query as opposed to the default query all fields behavior of this class
global Selector(SObjectType type, List<FieldSet> fieldSets)
Method Arguments
Name Type Description
type SObjectType SObjectType
fieldSets List<FieldSet> List<FieldSet>
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a list of field sets to use for the fields to query as opposed to the default query all fields behavior of this class
global Selector(SObjectType type, List<FieldSet> fieldSets, String soqlFilter)
Method Arguments
Name Type Description
type SObjectType SObjectType
fieldSets List<FieldSet> List<FieldSet>
soqlFilter String String
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a list of field sets to use for the fields to query as opposed to the default query all fields behavior of this class - as well as a SObjectField token for a related child object field that lookups to the primary query object to include a relationship query to that object (WARNING! all child fields are returned in the query result)
global Selector(SObjectType type, List<FieldSet> fieldSets, SObjectField lookupField)
Method Arguments
Name Type Description
type SObjectType SObjectType
fieldSets List<FieldSet> List<FieldSet>
lookupField SObjectField
Returns: Void
Selector: Construct with a SObjectType for the primary query result object and a list of field sets to use for the fields to query as opposed to the default query all fields behavior of this class - as well as a SObjectField token for a related child object field that lookups to the primary query object to include a relationship query to that object (WARNING! all child fields are returned in the query result)
global Selector(SObjectType type, List<FieldSet> fieldSets, SObjectField lookupField, String soqlFilter)
Method Arguments
Name Type Description
type SObjectType SObjectType
fieldSets List<FieldSet> List<FieldSet>
lookupField SObjectField SObjectField
soqlFilter String String
Returns: Void
getAll: Returns all rows for the SObjectType without filter
global virtual List<SObject> getAll()
selectById: Returns single SObject by record Id
global virtual SObject selectById(Id value)
Method Arguments
Name Type Description
value Id Id of record to return
Returns: SObject - SObject
selectById: Returns single SObject by Id in a custom reference field (String name)
global virtual SObject selectById(Id value, String referenceFieldName)
Method Arguments
Name Type Description
value Id Id of record to return
referenceFieldName String Full API name of the field to search for the Id (value)
Returns: SObject - SObject
selectById: Returns a list of SObjects for a given set of record ids
global virtual List<SObject> selectById(Set<Id> idSet)
Method Arguments
Name Type Description
idSet Set<Id> Set<Id> of record Ids
Returns: List<SObject> - List<SObject>
selectById: Returns a list of SObjects for a given set of custom reference ids - field to filter by specified by referenceFieldName
global virtual List<SObject> selectById(Set<Id> idSet, String referenceFieldName)
Method Arguments
Name Type Description
idSet Set<Id> Set<Id> custom reference Ids
referenceFieldName String Field to filter Ids
Returns: List<SObject> - List<SObject>
selectOptions: Returns list of SelectOptions using the getAll SObject list query
global SelectOption[] selectOptions()
selectOptions: Returns list of SelectOption objects using the record ids as a filter for the options returned
global SelectOption[] selectOptions(Set<Id> idSet)
Method Arguments
Name Type Description
idSet Set<Id> Set<Id> of record Ids
Returns: List<SelectOption> - SelectOption[]
selectOptions: Returns list of SelectOption objects using the record ids as a filter for the options returned
global SelectOption[] selectOptions(Set<Id> idSet, String referenceFieldName)
Method Arguments
Name Type Description
idSet Set<Id> Set<Id> of record Ids
referenceFieldName String Full API name of field to use for id filter
Returns: List<SelectOption> - SelectOption[]
getQueryLocator:
global Database.QueryLocator getQueryLocator()
getQueryLocator:
global Database.QueryLocator getQueryLocator(Set<Id> idSet)
Method Arguments
Name Type Description
idSet Set<Id>
Returns: Database.QueryLocator - Database.QueryLocator
getQueryLocator:
global Database.QueryLocator getQueryLocator(Set<Id> idSet, String referenceField)
Method Arguments
Name Type Description
idSet Set<Id> Id set for soql where clause
referenceField String
Returns: Database.QueryLocator - Database.QueryLocator
buildQueryStatement: @see buildQuery(String)
global String buildQueryStatement()
buildQueryStatement: Returns SOQL template in string form
global String buildQueryStatement(String referenceFieldName)
Method Arguments
Name Type Description
referenceFieldName String
Returns: String - String
Properties
fieldsToString: String

SetUtils

Useful static methods for working with the Set primitive data type

Methods

This component supports the following methods.

getIds: Returns a set of ids containing the record ids for each SObject contained in the list of sobjects passed in as an argument
global static Set<Id> getIds(List<SObject> records)
Method Arguments
Name Type Description
records List<SObject> List of records to return a set of ids for
Returns: Set<Id> - Set<Id> Ids for each record in the list of sobjects passed in as an argument
getIds: Returns a set of ids containing the record ids for each SObject contained in the list of sobjects passed in as an argument
global static Set<Id> getIds(List<SObject> records, String fieldName)
Method Arguments
Name Type Description
records List<SObject> List of records to return a set of ids for
fieldName String String fieldName to extract Id from
Returns: Set<Id> - Set<Id> Ids for each record in the list of sobjects passed in as an argument

SettingsPage

Settings_Page__c mirrored configuration class
Properties
apexComponent: String
apexClass: String
label: String
namespace: String
description: String

SettingsPage.DynamicComponent

Interface for providing the ApexPages.Component to draw for Framework's dynamic Settings Pages @since 2.1.0
Interface

Methods

This component supports the following methods.

getComponent:
ApexPages.Component getComponent()

StringUtils

Useful static methods for working with the String primitive data type

Methods

This component supports the following methods.

clean: Returns the string passed in as an argument without whitespace characters at the start or end - if the string passed into the method is null an empty string will be returned
global static String clean(String inputString)
Method Arguments
Name Type Description
inputString String
Returns: String - String Empty string if null string passed in as argument, or

TemplateController

Controller for all template vf pages used for staff facing interfaces.

Methods

This component supports the following methods.

TemplateController:
global TemplateController()
getCDNPath:
global String getCDNPath()

VendorAuthenticationService

Base virtual class that all vendor classes will extend for Auth functionality Such as OAuth

Methods

This component supports the following methods.

VendorAuthenticationService: Consturcutor that takes in the Api.ServiceConnection object on creation
global VendorAuthenticationService(Api.ServiceConnection serviceConnection)
Method Arguments
Name Type Description
serviceConnection Api.ServiceConnection
Returns: Void
VendorAuthenticationService: Default constructor with no parameters
global VendorAuthenticationService()
getAuthConfig: Get Auth Config objects for a particular Auth Type. Will return list of instantiated config objects that implement the same interface
global static List<AuthConfig> getAuthConfig(VendorAuthenticationService.AuthType authType)
Method Arguments
Name Type Description
authType VendorAuthenticationService.AuthType VendorAuthenticationService.AuthType
Returns: List<VendorAuthenticationService.AuthConfig> - List<AuthConfig> List of configs
getAuthTypes: Get list of all auth types that are available in the system.
global static List<VendorAuthenticationService.AuthType> getAuthTypes()
setTokenUrl: Set the base Oauth get token URL as that differs from Vendor to Vendor
global void setTokenUrl(String url)
Method Arguments
Name Type Description
url String Templated url that will be called to start Oauth login flow
Returns: Void
setAuthCodeUrl: Set the base Oauth get authorization URL as that differs from Vendor to Vendor
global void setAuthCodeUrl(String url)
Method Arguments
Name Type Description
url String Templated url that will be called to get token
Returns: Void
setRefreshTokenUrl: Set the base Oauth get refresh token URL as that differs from Vendor to Vendor
global void setRefreshTokenUrl(String url)
Method Arguments
Name Type Description
url String Templated url that will be called to get refresh token
Returns: Void
setHttpMethodGetToken: Set HTTP method to get Token, this differs from Vendor to Vendor.
global void setHttpMethodGetToken(String httpMethod)
Method Arguments
Name Type Description
httpMethod String String method GET or POST
Returns: Void
setApiServiceConnection: Set the Api.ServiceConnection object that is needed for methods to figure out what endpoint to call
global void setApiServiceConnection(Api.ServiceConnection apiServiceConnectionObj)
Method Arguments
Name Type Description
apiServiceConnectionObj Api.ServiceConnection Api.ServiceConnection
Returns: Void
setSuccessfulLoginRedirect: Set the PageReference object that is needed for redirect
global void setSuccessfulLoginRedirect(PageReference successPage)
Method Arguments
Name Type Description
successPage PageReference PageReference
Returns: Void
setFailureLoginRedirect: Set the PageReference object that is needed for redirect
global void setFailureLoginRedirect(PageReference failurePage)
Method Arguments
Name Type Description
failurePage PageReference PageReference
Returns: Void
setApiAuthType: Set the Auth Type for the vendor
global void setApiAuthType(VendorAuthenticationService.AuthType apiAuthType)
Method Arguments
Name Type Description
apiAuthType VendorAuthenticationService.AuthType
Returns: Void
getTokenUrl: Get Base Oauth token url set by Vendor
global String getTokenUrl()
getAuthCodeUrl: Get Base Oauth Authorization code url set by Vendor
global String getAuthCodeUrl()
getRefreshTokenUrl: Get Base Oauth refresh token url set by Vendor
global String getRefreshTokenUrl()
getHttpMethodGetToken: Get Base Oauth token HTTP method to get token which is set by Vendor
global String getHttpMethodGetToken()
getRedirectUrl:
global String getRedirectUrl()
getRedirectUrl: Get Redirect URL that will be used by vendor to call back
global virtual String getRedirectUrl(String connectionId)
Method Arguments
Name Type Description
connectionId String
Returns: String -
getApiServiceConnection: Get the associated Api.ServiceConnection object that contains the connection info
global virtual Api.ServiceConnection getApiServiceConnection()
buildTokenUrl: Build PageReference object that will redirect you to vendor. Each vendor does this differently so the token URL needs to build by vendor class.
global virtual PageReference buildTokenUrl()
buildAuthorizationCodeUrl: Build the Authorization code url which is the final step in the Oauth flow to get the token.
global virtual String buildAuthorizationCodeUrl(Map<String,String> parameters)
Method Arguments
Name Type Description
parameters Map<String, String>
Returns: String - String HTTP URL that will be called to get token
extractAccessToken: Extract Token from Vendor response. Needs to be overriden as every Vendor sends a different response
global virtual String extractAccessToken(String messageBody)
Method Arguments
Name Type Description
messageBody String String containing response from Vendor
Returns: String - String Extracted Access Token
: Build Auth Header that depends on Vendor for OAuth. Some vendors do not require this
global virtual String buildAuthHeader(        String url,        String method,        Map<String,String> signatureParams,        String secret)
Method Arguments
Name Type Description
url String
otherHeaderParams Map<String,String>
Returns: - String auth header
getApiAuthType: Get the currently set AuthType for the particular vendor
global AuthType getApiAuthType()
Properties
None: VendorAuthenticationService.AuthType

VendorAuthenticationService.AuthConfig

AuthConfig Inteface that allows us to list configs needed for OAuth or other authentication mechanisms
Interface

Methods

This component supports the following methods.

getName: Get the name of the config that will be stored as the name of Api.ServiceConnectionConfig
String getName()
isRequired: Check to see if the configuration is required to make the authentication be successful
Boolean isRequired()
getType: Get the type of the config such as STRING,URL etc
String getType()
getDefaultValue: Get the default value if it exists, if not a null value is returned
String getDefaultValue()

VendorAuthenticationService.AuthType

Enum Values

  • OAuth
  • OAuth2
  • OAuth1A
  • Basic
  • None

Base

Base class containing common client-side properties. Values are pulled in at runtime, validated and/or transformed, and, finally, serialized to the client. TO-DO might need to add more properties.

Methods

This component supports the following methods.

setDebug:
global void setDebug(Boolean value)
Method Arguments
Name Type Description
value Boolean
Returns: Void
setElementId:
global void setElementId(String value)
Method Arguments
Name Type Description
value String
Returns: Void
setJsController:
global void setJsController(String value)
Method Arguments
Name Type Description
value String
Returns: Void
setApexController:
global void setApexController(String value)
Method Arguments
Name Type Description
value String
Returns: Void
setComponentTitle:
global void setComponentTitle(String value)
Method Arguments
Name Type Description
value String
Returns: Void
setStyleClass:
global void setStyleClass(String value)
Method Arguments
Name Type Description
value String
Returns: Void

Base.BaseComponentException

BaseController

Base controller for configuration based components

Methods

This component supports the following methods.

BaseController:
global BaseController()
BaseController:
global BaseController(Base config)
Method Arguments
Name Type Description
config Base
Returns: Void
getConfigJson:
global virtual String getConfigJson()
getComponentId: Generate a random String for a given component. This provides uniqueness for JS variables using same component multiple times
global virtual String getComponentId()

CalendarController

Apex controller class for Calendar Component. Global because of the Remote Action method in the component.

Methods

This component supports the following methods.

getCalendarEvents: Remote action method that will return a list of Calendar Events
global static List<CalendarEvent> getCalendarEvents(List<CalendarInputWrapper> calendarData)
Method Arguments
Name Type Description
calendarData List<CalendarInputWrapper>
Returns: List<CalendarController.CalendarEvent> -

CalendarController.CalendarEvent

Build the query based on the Calendard Input Wrapper Record.

CalendarInputWrapper

Global class to load Calendar data. Used in calendar Apex Component, populate a list of CalendarInputWrapper and pass it as attribute on calendar component

Methods

This component supports the following methods.

getObjectName:
global String getObjectName()
setObjectName:
global void setObjectName(String value)
Method Arguments
Name Type Description
value String
Returns: Void
getTitleField:
global String getTitleField()
setTitleField:
global void setTitleField(String value)
Method Arguments
Name Type Description
value String
Returns: Void
getStartDateField:
global String getStartDateField()
setStartDateField:
global void setStartDateField(String value)
Method Arguments
Name Type Description
value String
Returns: Void
getEndDateField:
global String getEndDateField()
setEndDateField:
global void setEndDateField(String value)
Method Arguments
Name Type Description
value String
Returns: Void
getFieldsToDisplay:
global List<String> getFieldsToDisplay()
setFieldsToDisplay:
global void setFieldsToDisplay(List<String> values)
Method Arguments
Name Type Description
values List<String>
Returns: Void
getBeginningDateTime:
global Datetime getBeginningDateTime()
setBeginningDateTime:
global void setBeginningDateTime(Datetime value)
Method Arguments
Name Type Description
value Datetime
Returns: Void
getEndDateTime:
global Datetime getEndDateTime()
setEndDateTime:
global void setEndDateTime(Datetime value)
Method Arguments
Name Type Description
value Datetime
Returns: Void
getColor:
global String getColor()
setColor:
global void setColor(String value)
Method Arguments
Name Type Description
value String
Returns: Void

ComponentConfig

Apex object used to render configurations for PagesApi components.

Methods

This component supports the following methods.

ComponentConfig: ComponentConfig Constructor uses a page element and a list of page element attributes to create a Map of a String => Object to populate for implementations of the IComponent interface.
global ComponentConfig(Page_Element__c element, Page_Element_Attribute__c[] elementAttributes)
Method Arguments
Name Type Description
elementPagesApi__Page_Element__c
elementAttributes List<Page_Element_Attribute__c>
Returns: Void
getCustomHtml:
global String getCustomHtml()
getAttributes:
global Map<String,Object> getAttributes()

ComponentConfigOption

Configuration object for PagesApi Component attributes.

Methods

This component supports the following methods.

setLabel:
global void setLabel (String value)
Method Arguments
Name Type Description
value String
Returns: Void
setName:
global void setName (String value)
Method Arguments
Name Type Description
value String
Returns: Void
setOptions:
global void setOptions (SelectOption[] value)
Method Arguments
Name Type Description
value List<SelectOption>
Returns: Void
setConfigType:
global void setConfigType (Type value)
Method Arguments
Name Type Description
value Type
Returns: Void
setIsRequired:
global void setIsRequired (Boolean value)
Method Arguments
Name Type Description
value Boolean
Returns: Void
setDescription:
global void setDescription (String value)
Method Arguments
Name Type Description
value String
Returns: Void
setDefaultValue:
global void setDefaultValue (String value)
Method Arguments
Name Type Description
value String
Returns: Void

ComponentService

Apex services for working with dynamic components in PagesApi

Methods

This component supports the following methods.

build: Returns a list of ApexPages.Component objects to use when rendering components on pages.
global static ApexPages.Component[] build(Set<Id> pageElementIds)
Method Arguments
Name Type Description
pageElementIds Set<Id>
Returns: List<ApexPages.Component> - ApexPages.Component[] Array of ApexPages.Component objects

DefaultTemplateController

default_template page controller

Methods

This component supports the following methods.

DefaultTemplateController:
global DefaultTemplateController()
getSite:
global virtual Site__c getSite()
getSiteNav:
global Menu__c getSiteNav()
getPageNav:
global Menu__c getPageNav()
getTheme:
global Theme__c getTheme()
getPage:
global Page__c getPage()
getCurrentContact:
global Contact getCurrentContact()
getCurrentUser:
global User getCurrentUser()
getIsAuthenticated:
global Boolean getIsAuthenticated()
getLanguageISOCode:
global virtual String getLanguageISOCode()
getIsAuthenticatedUser:
global Boolean getIsAuthenticatedUser()
getShowMainNav:
global Boolean getShowMainNav()
getCDN:
global String getCDN()

FeedController

Controller class for Feed component.

Methods

This component supports the following methods.

getUsers:
global static List<User> getUsers(String searchString)
Method Arguments
Name Type Description
searchString String
Returns: List<User> -
getFeedData:
global static ConnectApi.FeedElementPage getFeedData(String groupId, String pageToken)
Method Arguments
Name Type Description
groupId String
pageToken String
Returns: ConnectApi.FeedElementPage -
postFeedData:
global static ConnectApi.FeedElement postFeedData(String groupId, String textInput)
Method Arguments
Name Type Description
groupId String
textInput String
Returns: ConnectApi.FeedElement -
postFeedDataWithFile:
global static ConnectApi.FeedElement postFeedDataWithFile(String groupId, String textInput, Blob fileInput, String fileType,String fileName)
Method Arguments
Name Type Description
groupId String
textInput String
fileInput Blob
fileType String
fileName String
Returns: ConnectApi.FeedElement -
postCommentData:
global static ConnectApi.Comment postCommentData(String groupId, String feedElementId, String textInput)
Method Arguments
Name Type Description
groupId String
feedElementId String
textInput String
Returns: ConnectApi.Comment -
getCommentsForFeedElement:
global static ConnectApi.CommentPage getCommentsForFeedElement(String feedElementId, String pageToken)
Method Arguments
Name Type Description
feedElementId String
pageToken String
Returns: ConnectApi.CommentPage -
likeElement:
global static ConnectApi.ChatterLike likeElement(String subjectId, String subjectType)
Method Arguments
Name Type Description
subjectId String
subjectType String
Returns: ConnectApi.ChatterLike -
unlikeFeedItem:
global static void unlikeFeedItem(String likeId)
Method Arguments
Name Type Description
likeId String
Returns: Void

FeedController.FeedConfig

FontevaControllerService

Fonteva Controller

Methods

This component supports the following methods.

getRecord:
global virtual Object getRecord(String recordId)
Method Arguments
Name Type Description
recordId String
Returns: Object -
getRecordMap:
global virtual Map<String,Object> getRecordMap(String urlVars)
Method Arguments
Name Type Description
urlVars String
Returns: Map<String, Object> -
getRecordMap:
global virtual Map<String,Object> getRecordMap(String urlVars,Boolean isPreview)
Method Arguments
Name Type Description
urlVars String
isPreview Boolean
Returns: Map<String, Object> -

FormBuilderController

Methods

This component supports the following methods.

getSkipLogicData: Gets the field in context and assigns the field to the newField object.
global static SkipLogicWrapper getSkipLogicData(String fieldId)
Method Arguments
Name Type Description
fieldId String
Returns: FormBuilderController.SkipLogicWrapper -
saveSkipLogic:
global static void saveSkipLogic(String data)
Method Arguments
Name Type Description
data String
Returns: Void

FormBuilderController.SkipLogicWrapper

Methods

This component supports the following methods.

SkipLogicWrapper:
global SkipLogicWrapper(String fieldId)
Method Arguments
Name Type Description
fieldId String
Returns: Void

FormDetailController

Controller for the form_detail.page

Methods

This component supports the following methods.

FormDetailController:
global FormDetailController(ApexPages.StandardController stdCon)
Method Arguments
Name Type Description
stdCon ApexPages.StandardController
Returns: Void
getFieldDisplayTypeOptions: Clears any values found for the current field and field group in context
global static String getFieldDisplayTypeOptions()

FormResponseService

Default Logic for Form_response__c SObject

Methods

This component supports the following methods.

upsertSobjects: Returns a map where the key is the form response record id and the value is a collection of Sobjects the system created as a result of the form response submission.
global static Map<Id,List<Id>> upsertSobjects(Set<Id> formResponseIds)
Method Arguments
Name Type Description
formResponseIds Set<Id>
Returns: Map<Id, List<Id>> - Map<Id,Sobject[]> Map form response id to a collection of sobjects

GoogleAuthRegHandler

Methods

This component supports the following methods.

createUser:
global User createUser(Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
portalId Id
data Auth.UserData
Returns: User -
updateUser:
global void updateUser(Id userId, Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
userId Id
portalId Id
data Auth.UserData
Returns: Void

GroupMembersController

Controller class for the VF Component groupmembers

Methods

This component supports the following methods.

doSearch:
global static List<Community_Group_Member__c> doSearch(GroupMembersConfig configs, List<SearchFilters> filters, String searchString)
Method Arguments
Name Type Description
configs GroupMembersController.GroupMembersConfig
filters List<GroupMembersController.SearchFilters>
searchString String
Returns: List<Community_Group_Member__c> -

GroupMembersController.GroupMembersConfig

GroupMembersController.SearchFilters

GroupsController

Controller class for the VF Component Groups

Methods

This component supports the following methods.

doSearch:
global static List<CommunityGroupWrapper> doSearch(GroupsConfig configs, List<SearchFilters> filters, String searchString)
Method Arguments
Name Type Description
configs GroupsController.GroupsConfig
filters List<GroupsController.SearchFilters>
searchString String
Returns: List<GroupsController.CommunityGroupWrapper> -

GroupsController.GroupsConfig

GroupsController.SearchFilters

GroupsController.CommunityGroupWrapper

Method that returns the FieldNames and FieldLabels Map @return Map<String,String>
Properties
cgroup: Community_Group__c
groupCount: Integer
isMyGroup: Boolean
isPrivate: Boolean
type: String

IComponent

Enables extension packages to register and build new PagesApi components by providing stubs to build new components with config objects and to retrieve config options.
Interface

Methods

This component supports the following methods.

getComponent:
ApexPages.Component getComponent(ComponentConfig config)
Method Arguments
Name Type Description
config ComponentConfig
Returns: ApexPages.Component -
getOptions:
ComponentConfigOption[] getOptions()

ISiteCreator

Enables extension packages to provide a mechanism to create new communities from template and related configurations.
Interface

Methods

This component supports the following methods.

create:
Site__c create(Site__c siteObj)
Method Arguments
Name Type Description
siteObjPagesApi__Site__c
Returns: Site__c -

LinkedInAuthRegHandler

Methods

This component supports the following methods.

createUser:
global User createUser(Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
portalId Id
data Auth.UserData
Returns: User -
updateUser:
global void updateUser(Id userId, Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
userId Id
portalId Id
data Auth.UserData
Returns: Void

MenuController

Controller class for navbar and navlist Visualforce Components (together part of Menu).

Methods

This component supports the following methods.

getMenuItemsTree: RemoteAction method that returns the Hierarchy for all the Menu Items
global static List<MenuHierarchy> getMenuItemsTree(String menuName)
Method Arguments
Name Type Description
menuName String
Returns: List<MenuHierarchy> - LIst<MenuHierarachy>

MenuHierarchy

Wrapper class for the Menu Items Hierarchy.

Methods

This component supports the following methods.

MenuHierarchy:
global MenuHierarchy(Menu_Item__c item, String parentId)
Method Arguments
Name Type Description
itemPagesApi__Menu_Item__c
parentId String
Returns: Void
getItem:
global Menu_Item__c getItem()
getMenuName:
global String getMenuName()
getTarget:
global String getTarget()
getNavURL:
global String getNavURL()
getParentId:
global String getParentId()
compareTo:
global Integer compareTo(Object compareTo)
Method Arguments
Name Type Description
compareTo Object
Returns: Integer -

PackageScripts

Framework configuration scripts as well as the default install and uninstall handler class for the PagesApi Managed Package.

Methods

This component supports the following methods.

onInstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onInstall(InstallContext context)
Method Arguments
Name Type Description
context InstallContext
Returns: Void
onUninstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onUninstall(UninstallContext context)
Method Arguments
Name Type Description
context UninstallContext
Returns: Void
install:
global static void install()

PackageScripts.Install

Used for the custom script config to invoke install scripts of PagesApi app from Framework mission control/setup pages @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Permissioner

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Metadata

Always set the Org Defaults on install/upgrade

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.SampleSite

Methods

This component supports the following methods.

run: Used for the custom script config to load data for sample site to work @implements Framework.Scriptable
global void run()

Site

Global Site Service for Site__c configs

Methods

This component supports the following methods.

getSite:
global static Site__c getSite()
getPathPrefix:
global static String getPathPrefix()
setSite:
global static void setSite(Site__c siteObj)
Method Arguments
Name Type Description
siteObjPagesApi__Site__c
Returns: Void

TableComponentController

Controller class for the VF Component TableComponent

Methods

This component supports the following methods.

invoke: Remoting method to get the SObject Records for any object called from Datatable's AJAX Request
global static DataTableResponse invoke(List<Map<String, Object>> request, String sobjectName)
Method Arguments
Name Type Description
request List<Map<String, Object>> - Input Request provided by the DataTable
sobjectName String - Salesforce SObjectName
Returns: TableComponentController.DataTableResponse - DatatableResponse that can be used by API for table processing
invokeSearch:
global static DataTableResponse invokeSearch(DataTable request, String sobjectName)
Method Arguments
Name Type Description
request TableComponentController.DataTable
sobjectName String
Returns: TableComponentController.DataTableResponse -
getFieldLabelMap: Remoting method to get the fieldLabMap for any SObject, basically would return labels to show on a Table
global static Map<String,String> getFieldLabelMap(String sobjectName)
Method Arguments
Name Type Description
sobjectName String - Salesforce SObjectName
Returns: Map<String, String> - Map<String,String>
getFieldTypeMap: Remoting method to get the fieldLabMap for any SObject, basically would return labels to show on a Table
global static Map<String,String> getFieldTypeMap(String sobjectName)
Method Arguments
Name Type Description
sobjectName String - Salesforce SObjectName
Returns: Map<String, String> - Map<String,String>

TableComponentController.DataTableResponse

TableComponentController.DataTable

Properties
iDisplayStart: Integer
iDisplayLength: Integer
columns: List<String>
sortColumns: List<Integer>
sortDirections: List<String>
searchString: String

TwitterAuthRegHandler

Methods

This component supports the following methods.

createUser:
global User createUser(Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
portalId Id
data Auth.UserData
Returns: User -
updateUser:
global void updateUser(Id userId, Id portalId, Auth.UserData data)
Method Arguments
Name Type Description
userId Id
portalId Id
data Auth.UserData
Returns: Void

AccessPermission

Access Permission check class

Methods

This component supports the following methods.

AccessPermission:
global AccessPermission(Id customerId)
Method Arguments
Name Type Description
customerId Id
Returns: Void
setCustomerIds:
global void setCustomerIds (Set<Id> customerIds)
Method Arguments
Name Type Description
customerIds Set<Id>
Returns: Void
haveAccess:
global Boolean haveAccess(SObject sObj)
Method Arguments
Name Type Description
sObj SObject
Returns: Boolean -
haveAccess:
global List<SObject> haveAccess(List<SObject> sObjs)
Method Arguments
Name Type Description
sObjs List<SObject>
Returns: List<SObject> -
haveAccessByContacts:
global Map<Id,Set<Id>> haveAccessByContacts(List<SObject> sObjs)
Method Arguments
Name Type Description
sObjs List<SObject>
Returns: Map<Id, Set<Id>> -

AccessibleSitesController

Get Accessible Sites

Methods

This component supports the following methods.

AccessibleSitesController:
global AccessibleSitesController()

CampaignController

Custom Controller for Campaign Display

Methods

This component supports the following methods.

getSalesOrderLines:
global static List<Sales_Order_Line__c> getSalesOrderLines(String salesorderid)
Method Arguments
Name Type Description
salesorderid String
Returns: List<Sales_Order_Line__c> -
closeSalesOrder:
global static String closeSalesOrder(String salesorderid)
Method Arguments
Name Type Description
salesorderid String
Returns: String -

CampaignPageBuilderController

Controller for pagebuilder.page which allows user to manage the page elements for any parent.

Methods

This component supports the following methods.

updateOrder: Dynamically find the parent for the pageElement, based on the page parameter, get the SObjectName, fieldname @Assumption: the fieldname for the parent is same as SObject Name (Does not support custonm field names)
global static String updateOrder(List<PageElementOrder> items)
Method Arguments
Name Type Description
items List<CampaignPageBuilderController.PageElementOrder>
Returns: String -

CampaignPageBuilderController.PageElementOrder

CampaignPageComponentControllerBase

Catalog Base Controller

Methods

This component supports the following methods.

CampaignPageComponentControllerBase:
global CampaignPageComponentControllerBase()
getCatalogItems:
global List<Item__c> getCatalogItems(String catalog)
Method Arguments
Name Type Description
catalog String
Returns: List<Item__c> -
buildSalesOrder:
global static void buildSalesOrder(String dataJson)
Method Arguments
Name Type Description
dataJson String
Returns: Void
buildSalesOrderFromComponent:
global PageReference buildSalesOrderFromComponent(String salesorderid,Id selectedItem,Integer selectedQuantity)
Method Arguments
Name Type Description
salesorderid String
selectedItem Id
selectedQuantity Integer
Returns: PageReference -
getQuantityPrice:
global static Decimal getQuantityPrice(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Decimal -
getQuantityPrice:
global static Decimal getQuantityPrice(String itemId,Integer quantity)
Method Arguments
Name Type Description
itemId String
quantity Integer
Returns: Decimal -
getQuantityOptions:
global List<SelectOption> getQuantityOptions()

Catalog

Methods

This component supports the following methods.

Catalog:
global Catalog (Id catalogId)
Method Arguments
Name Type Description
catalogId Id
Returns: Void
Catalog:
global Catalog (Id catalogId, Id customerId)
Method Arguments
Name Type Description
catalogId Id
customerId Id
Returns: Void
getItems:
global Map<Id,Item> getItems()
getItemsPriceRules:
global Map<Id,Price_Rule__c> getItemsPriceRules(Set<Id> itemIDs)
Method Arguments
Name Type Description
itemIDs Set<Id>
Returns: Map<Id, Price_Rule__c> -

Catalog.Item

Methods

This component supports the following methods.

getPriceRule:
global Price_Rule__c getPriceRule ()
getPriceRule:
global Price_Rule__c getPriceRule(Double quantity)
Method Arguments
Name Type Description
quantity Double
Returns: Price_Rule__c -

CatalogCheckboxDisplayController

Catalog Radio Display Component Controller

Methods

This component supports the following methods.

getUpdatedPriceByQuantity:
global static Decimal getUpdatedPriceByQuantity(String itemId,Integer quantity)
Method Arguments
Name Type Description
itemId String
quantity Integer
Returns: Decimal -

CatalogRadioDisplayController

Catalog Radio Display Component Controller

Methods

This component supports the following methods.

getUpdatedPriceByQuantity:
global static Decimal getUpdatedPriceByQuantity(String itemId,Integer quantity)
Method Arguments
Name Type Description
itemId String
quantity Integer
Returns: Decimal -

CatalogSelectDisplayController

Catalog Select Display Component Controller

Methods

This component supports the following methods.

getUpdatedPriceByQuantity:
global static Decimal getUpdatedPriceByQuantity(String itemId,Integer quantity)
Method Arguments
Name Type Description
itemId String
quantity Integer
Returns: Decimal -

CatalogTileDisplayController

Catalog Tile Display Component

Methods

This component supports the following methods.

getUpdatedPriceByQuantity:
global static Decimal getUpdatedPriceByQuantity(String itemId,Integer quantity)
Method Arguments
Name Type Description
itemId String
quantity Integer
Returns: Decimal -

CheckoutShippingController

Custom Controller for shipping during checkout

Methods

This component supports the following methods.

addShippingRate: Always converts to Kilogram for calculation
global static void addShippingRate(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Void

CheckoutSummaryController

Custom Controller for checkout summary (Total of Tax, Shipping and Items)

Methods

This component supports the following methods.

updateTotals:
global static Map<String,Object> updateTotals(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Map<String, Object> -
getTotals:
global static String getTotals(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: String -
closeAndPostSalesOrder:
global static PageReference closeAndPostSalesOrder(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: PageReference -
applyDiscount:
global static Boolean applyDiscount(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Boolean -

Contacts

Domain class for the Contact SObjectType

Methods

This component supports the following methods.

getUpdatedBadgeTypes:
global static Badge_Type__c[] getUpdatedBadgeTypes(Id contactId)
Method Arguments
Name Type Description
contactId Id
Returns: List<Badge_Type__c> -
updateContactBadges:
global static Contact updateContactBadges(Id contactId)
Method Arguments
Name Type Description
contactId Id
Returns: Contact -

Contacts.Constructor

Methods

This component supports the following methods.

construct:
global Framework.Domain construct(List<SObject> sObjectList)
Method Arguments
Name Type Description
sObjectList List<SObject>
Returns: Framework.Domain -

CustomPaymentTypeContext

Class for Custom Payment Type Config

Methods

This component supports the following methods.

setSalesOrder:
global void setSalesOrder(Sales_Order__c salesOrder)
Method Arguments
Name Type Description
salesOrderOrderApi__Sales_Order__c
Returns: Void
setItem:
global void setItem(Item__c item)
Method Arguments
Name Type Description
itemOrderApi__Item__c
Returns: Void
getSalesOrder:
global Sales_Order__c getSalesOrder()
getItem:
global Item__c getItem()
setContext:
global void setContext(String context)
Method Arguments
Name Type Description
context String
Returns: Void
getContext:
global String getContext()

CustomPaymentTypeTemplate

Base Class for Custom Payment Type Template

Methods

This component supports the following methods.

getPaymentOptions:
global virtual List<Map<String,String>> getPaymentOptions(List<Payment_Method__c> paymentMethods,CustomPaymentTypeContext customPaymentTypeContext)
Method Arguments
Name Type Description
paymentMethods List<Payment_Method__c>
customPaymentTypeContext CustomPaymentTypeContext
Returns: List<Map<String, String>> -
customizeName:
global virtual String customizeName(Payment_Method__c paymentMethod,CustomPaymentTypeContext customPaymentTypeContext)
Method Arguments
Name Type Description
paymentMethodOrderApi__Payment_Method__c
customPaymentTypeContext CustomPaymentTypeContext
Returns: String -
customizeValue:
global virtual String customizeValue(Payment_Method__c paymentMethod,CustomPaymentTypeContext customPaymentTypeContext)
Method Arguments
Name Type Description
paymentMethodOrderApi__Payment_Method__c
customPaymentTypeContext CustomPaymentTypeContext
Returns: String -
calcuatePaymentMethods:
global static List<Map<String,String>> calcuatePaymentMethods(String customerId,CustomPaymentTypeContext customPaymentTypeContextObj)
Method Arguments
Name Type Description
customerId String
customPaymentTypeContextObj CustomPaymentTypeContext
Returns: List<Map<String, String>> -
calculatePaymentMethods:
global static List<Map<String,String>> calculatePaymentMethods(String customerId,CustomPaymentTypeContext customPaymentTypeContextObj)
Method Arguments
Name Type Description
customerId String
customPaymentTypeContextObj CustomPaymentTypeContext
Returns: List<Map<String, String>> -

EPayment

Class to get epayments

Methods

This component supports the following methods.

createEpayments:
global static EPayment__c[] createEpayments(Scheduled_Payment__c[] scheduledPayments)
Method Arguments
Name Type Description
scheduledPayments List<Scheduled_Payment__c>
Returns: List<EPayment__c> -

EpaymentWebServices

Methods

This component supports the following methods.

doPost:
global static void doPost()

Invoice

Wrapper for Invoice. @implements Comparable. Ability to sort Invoices based on their due date.

Methods

This component supports the following methods.

compareTo:
global Integer compareTo(Object compareTo)
Method Arguments
Name Type Description
compareTo Object An instance of Invoice
Returns: Integer - -1 if the due date of this invoice is before.

InvoiceLine

Wrapper for Invoice Line Object. @implements Comparable. Ability to sort Invoice Lines based on their payment priority

Methods

This component supports the following methods.

compareTo:
global Integer compareTo(Object compareTo)
Method Arguments
Name Type Description
compareTo Object An instance of InvoiceLine to be compared Against
Returns: Integer - -1 if this has lower priority.

Invoices

Domain class for the Invoice__c SObjectType

Methods

This component supports the following methods.

Invoices:
global Invoices(List<Invoice__c> sObjectList)
Method Arguments
Name Type Description
sObjectList List<Invoice__c>
Returns: Void

Invoices.Constructor

Methods

This component supports the following methods.

construct:
global Framework.Domain construct(List<SObject> sObjectList)
Method Arguments
Name Type Description
sObjectList List<SObject>
Returns: Framework.Domain -

Item

Class to get items under item class

Methods

This component supports the following methods.

Item:
global Item(Id itemId)
Method Arguments
Name Type Description
itemId Id
Returns: Void
getListPrice:
global PriceRule getListPrice()
getPrice:
global PriceRule getPrice(Double quantity,Id customerId, Map<String, Integer> customerPRUsed)
Method Arguments
Name Type Description
quantity Double
customerId Id
customerPRUsed Map<String, Integer>
Returns: PriceRule -
getPrice:
global PriceRule getPrice(Double quantity,Id customerId)
Method Arguments
Name Type Description
quantity Double
customerId Id
Returns: PriceRule -
getItemSubPlans:
global ItemSubscriptionPlan[] getItemSubPlans(Id customerId, Double quantity, Id[] subPlans)
Method Arguments
Name Type Description
customerId Id
quantity Double
subPlans List<Id>
Returns: List<ItemSubscriptionPlan> -

ItemClass

Class to get items under item class and their prices

Methods

This component supports the following methods.

ItemClass:
global ItemClass(Id itemClassId)
Method Arguments
Name Type Description
itemClassId Id
Returns: Void
ItemClass:
global ItemClass(Id itemClassId,Id customerId)
Method Arguments
Name Type Description
itemClassId Id
customerId Id
Returns: Void
ItemClass:
global ItemClass(Id itemClassId,Id customerId,Id sourceCodeId)
Method Arguments
Name Type Description
itemClassId Id
customerId Id
sourceCodeId Id
Returns: Void
getItems:
global Map<Id,Item> getItems()
getItems:
global Map<Id,Item> getItems(Boolean forceAccessPermissions)
Method Arguments
Name Type Description
forceAccessPermissions Boolean
Returns: Map<Id, Item> -

ItemSubscriptionPlan

Methods

This component supports the following methods.

ItemSubscriptionPlan:
global ItemSubscriptionPlan(Id subId, PriceRule listPrice)
Method Arguments
Name Type Description
subId Id
listPrice PriceRule
Returns: Void
getSubscription:
global Id getSubscription()
getPrice:
global PriceRule getPrice()

NavListController

Controller class for navbar and navlist Visualforce Components (together part of Menu).

Methods

This component supports the following methods.

getMenuItemsTree: RemoteAction method that returns the Hierarchy for all the Menu Items
global static List<PagesApi.MenuHierarchy> getMenuItemsTree(String jsonDataStr)
Method Arguments
Name Type Description
jsonDataStr String
Returns: List<PagesApi.MenuHierarchy> - LIst<MenuHierarachy>

OrderSummaryController

Controller class for order_summary Visualforce Component

Methods

This component supports the following methods.

updateOrder: Method to update the order line items based on Line Item Id Sales Order Line Quantity - based on quantityField.
global static void updateOrder(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Void
deleteOrderLine: Method to delete the order line item
global static void deleteOrderLine(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Void

PackageItem

wrapper class for Package_Item__c

Methods

This component supports the following methods.

PackageItem: Construct a PackageItem wrapper from a Package_Item__c
global PackageItem(Package_Item__c pi)
Method Arguments
Name Type Description
piOrderApi__Package_Item__c the package item SObject
Returns: Void
PackageItem: Construct a PackageItem wrapper from a parentId and a packageId
global PackageItem(String parentItemId, String packageId)
Method Arguments
Name Type Description
parentItemId String the parent item id
packageId String the bundled item id
Returns: Void
save: Persist the PackageItem wrapper to the corresponding SObject
global void save()
Properties
name: String
parentItemName: String
packagedItemName: String
type: String
item: String
itemClass: String
isRequired: Boolean
hasNoAdditionalCharge: Boolean
hasAdditionalCharge: Boolean
minQuantity: Integer
maxQuantity: Integer
maxQuantityPerItem: Integer
displayName: String
buttonDisplayName: String
displayInstructions: String
packageItemId: String
parentItemId: String
minQuantityFieldLabel: String
maxQuantityFieldLabel: String
displayNameFieldLabel: String
buttonDisplayNameFieldLabel: String
displayInstructionsFieldLabel: String
maxQuantityPerItemFieldLabel: String
ticketTypeId: String
scheduleItemId: String
sponsorPackageId: String

PackageScripts

Ad-hoc scripts to support master data manipulation for the OTC Managed Package

Methods

This component supports the following methods.

onInstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onInstall(InstallContext context)
Method Arguments
Name Type Description
context InstallContext
Returns: Void
onUninstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onUninstall(UninstallContext context)
Method Arguments
Name Type Description
context UninstallContext
Returns: Void
install: Execute the installation scripts for the OrderApi managed package
global static void install()

PackageScripts.Install

Runs all default installation scripts for the OTC Managed Package @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Exceptions

Creates and links an account and contact record to NationSuite's settings for Exception Account and Exception Contact respectively. @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.AppConfig

Creates basic accounting master data and other preference releated configurations. @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Register

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Rollups

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.DeleteConfig

Invoice__c.Credits_Applied__c (Sum)

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.CustomScripts

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Jobs

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.CustomPaymentScripts

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.SubBchJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.SPCBchJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.BBchableJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.TermBchJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.FlowBJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.KABchJob

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Wipe

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Metadata

Methods

This component supports the following methods.

run:
global void run()

PaymentConfigPreferences

Methods

This component supports the following methods.

PaymentConfigPreferences:
global PaymentConfigPreferences()
getKey:
global String getKey()
getSecret:
global String getSecret()
getSignedSecret:
global String getSignedSecret()
isDebugModeEnabled:
global Boolean isDebugModeEnabled()
setKey: Sets the Spreedly Key
global void setKey(String key)
Method Arguments
Name Type Description
key String
Returns: Void
setSecret: Sets the Spreedly Secret
global void setSecret(String secret)
Method Arguments
Name Type Description
secret String
Returns: Void
setSignedSecret: Sets the Spreedly Signed Secret
global void setSignedSecret(String signedSecret)
Method Arguments
Name Type Description
signedSecret String
Returns: Void
setDebugMode: Sets the enable individual accounts field for the preference in context.
global void setDebugMode(Boolean debugMode)
Method Arguments
Name Type Description
debugMode Boolean
Returns: Void
push: List of all eBusiness Preferences
global void push()

PortalShoppingCartController

Controller for portal_shopping_cart.component

Methods

This component supports the following methods.

updateOrder: Called from apex:actionFunction invoked from onclick event of item delete action link
global static void updateOrder(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Void

Preferences

Methods

This component supports the following methods.

Preferences:
global Preferences()
Preferences:
global Preferences(Id setupOwnerId)
Method Arguments
Name Type Description
setupOwnerId Id
Returns: Void
getBusinessGroupId: Id of the preferred Business Group sobject Id.
global Id getBusinessGroupId()
getIncomeAccountId: Id of the preferred default Income GL Account sobject Id.
global Id getIncomeAccountId()
getRefundAccountId: Id of the preferred default Refund GL Account sobject Id.
global Id getRefundAccountId()
getDepositAccountId: Id of the preferred default Deposit GL Account sobject Id.
global Id getDepositAccountId()
getAdjustmentAccountId: Id of the preferred default Adjustment GL Account sobject Id.
global Id getAdjustmentAccountId()
getARAccountId: Id of the preferred default A/R GL Account sobject Id.
global Id getARAccountId()
getPaymentGatewayId: Id of the preferred default Payment Gateway sobject Id.
global Id getPaymentGatewayId()
getExceptionAccountId: Returns the ID of the Account sobject configured as the Exception Account
global Id getExceptionAccountId()
getExceptionContactId: Returns the ID of the Contact sobject configured as the Exception Contact
global Id getExceptionContactId()
getPaymentTermsId: Returns the ID of the preferred Payment Terms sobject
global Id getPaymentTermsId()
getTaxAccountId: Returns the preferred Tax GL Account sobject Id
global Id getTaxAccountId()
getTaxLocaleId: Returns the preferred Tax Locale sobject Id
global Id getTaxLocaleId()
getEnableIndividualAccounts:
global Boolean getEnableIndividualAccounts()
getEnableBillingSyncBypass:
global Boolean getEnableBillingSyncBypass()
getDisableSavePymntMethodOptn:
global Boolean getDisableSavePymntMethodOptn()
getDBCommitted: If the custom setting (app_config__c) in context has been inserted in the database this will return true, otherwise false
global Boolean getDBCommitted()
getSetupOwnerId: The Id of the user, profile, or organization that owns the hierarchy setting (configObj) in context
global Id getSetupOwnerId()
setSetupOwnerId: Sets the setup owner id for the preference in context.
global void setSetupOwnerId(Id setupOwnerId)
Method Arguments
Name Type Description
setupOwnerId Id
Returns: Void
setPaymentTerms: Sets the Pyament Terms for the preference in context.
global void setPaymentTerms(Id PTId)
Method Arguments
Name Type Description
PTId Id
Returns: Void
setRefundAccount: Sets the Refund Account for the preference in context.
global void setRefundAccount(Id RAId)
Method Arguments
Name Type Description
RAId Id
Returns: Void
setTaxAccount: Sets the tax account for the preference in context.
global void setTaxAccount(Id TAId)
Method Arguments
Name Type Description
TAId Id
Returns: Void
setTaxLocale: Sets the tax locale for the preference in context.
global void setTaxLocale(Id TLId)
Method Arguments
Name Type Description
TLId Id
Returns: Void
setExceptionAccount: Sets the exception account for the preference in context.
global void setExceptionAccount(Id EAId)
Method Arguments
Name Type Description
EAId Id
Returns: Void
setExceptionContact: Sets the exception contact for the preference in context.
global void setExceptionContact(Id ECId)
Method Arguments
Name Type Description
ECId Id
Returns: Void
setIncomeAccount: Sets the income account for the preference in context.
global void setIncomeAccount(Id IAId)
Method Arguments
Name Type Description
IAId Id
Returns: Void
setDepositAccount: Sets the deposit account for the preference in context.
global void setDepositAccount(Id DAId)
Method Arguments
Name Type Description
DAId Id
Returns: Void
setDiscountAccount: Sets the discount account for the preference in context.
global void setDiscountAccount(Id DAId)
Method Arguments
Name Type Description
DAId Id
Returns: Void
setARAccount: Sets the AR account for the preference in context.
global void setARAccount(Id ARAId)
Method Arguments
Name Type Description
ARAId Id
Returns: Void
setAdjustmentAccount: Sets the adjustment account for the preference in context.
global void setAdjustmentAccount(Id AAId)
Method Arguments
Name Type Description
AAId Id
Returns: Void
setBusinessGroup: Sets the business group for the preference in context.
global void setBusinessGroup(Id BGId)
Method Arguments
Name Type Description
BGId Id
Returns: Void
setUpdateContactStandardEmailField: Sets the update contact standard email field for the preference in context.
global void setUpdateContactStandardEmailField(Boolean UCSEF)
Method Arguments
Name Type Description
UCSEF Boolean
Returns: Void
setUpdateContactStandardPhoneField: Sets the update contact standard phone field for the preference in context.
global void setUpdateContactStandardPhoneField(Boolean UCSPF)
Method Arguments
Name Type Description
UCSPF Boolean
Returns: Void
setNamespacePrefix: Sets the namespacePrefix for the preference in context.
global void setNamespacePrefix(String nsp)
Method Arguments
Name Type Description
nsp String
Returns: Void
setIndividualAccountNameExtension: Sets the individual account name extension for the preference in context.
global void setIndividualAccountNameExtension(String IANE)
Method Arguments
Name Type Description
IANE String
Returns: Void
setitemWeightUOM: Sets the item weight UOM for the preference in context.
global void setitemWeightUOM(String IWUOM)
Method Arguments
Name Type Description
IWUOM String
Returns: Void
setEnableIndividualAccounts: Sets the enable individual accounts field for the preference in context.
global void setEnableIndividualAccounts(Boolean EIA)
Method Arguments
Name Type Description
EIA Boolean
Returns: Void
setDisableSavePymntMethodOptn: Sets the disable save payment method option in Payment Processing Page for the preference in context.
global void setDisableSavePymntMethodOptn(Boolean disableSPMO)
Method Arguments
Name Type Description
disableSPMO Boolean
Returns: Void
setCalculateSalesTax: Sets the calculate sales tax for the preference in context.
global void setCalculateSalesTax(Boolean CST)
Method Arguments
Name Type Description
CST Boolean
Returns: Void
push: List of all eBusiness Preferences
global void push()
exportAll: List of all eBusiness Preferences
global static Preferences[] exportAll()

PriceRule

Class to get active price for item

Methods

This component supports the following methods.

PriceRule:
global PriceRule(Price_Rule__c priceRuleObj)
Method Arguments
Name Type Description
priceRuleObjOrderApi__Price_Rule__c
Returns: Void
getPriceRule:
global Price_Rule__c getPriceRule()
setPriceRule:
global static void setPriceRule(Sales_Order_Line__c[] sols, String contactId, String sourceCodeId)
Method Arguments
Name Type Description
sols List<Sales_Order_Line__c>
contactId String
sourceCodeId String
Returns: Void

RenewalPath

Methods

This component supports the following methods.

RenewalPath:
global RenewalPath()
setAccountId:
global void setAccountId(String accountId)
Method Arguments
Name Type Description
accountId String
Returns: Void
setContactId:
global void setContactId(String contactId)
Method Arguments
Name Type Description
contactId String
Returns: Void
setItemId:
global void setItemId(String itemId)
Method Arguments
Name Type Description
itemId String
Returns: Void
setsubscriptionId:
global void setsubscriptionId(String subscriptionId)
Method Arguments
Name Type Description
subscriptionId String
Returns: Void
getItem:
global Item__c getItem()
getIsDefault:
global Boolean getIsDefault()
serializeRenewalPath:
global static String serializeRenewalPath(RenewalPath rJSON)
Method Arguments
Name Type Description
rJSON RenewalPath
Returns: String -
isRenewalPathDefined: Global method returns true if Subscription Item has any RenewalPath related
global static Boolean isRenewalPathDefined(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: Boolean -
getRenewalPathItems: Global method returns List of RenewalPath records which are applicable for that user
global static RenewalPath[] getRenewalPathItems(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: List<RenewalPath> -

SalesReceipt

Api object for processing customer orders

Methods

This component supports the following methods.

SalesReceipt:
global SalesReceipt(Id customer_id)
Method Arguments
Name Type Description
customer_id Id
Returns: Void
Properties
customer_id: Id
line_items: List<SalesReceipt.LineItem>

SalesReceipt.LineItem

Methods

This component supports the following methods.

LineItem:
global LineItem(Id item_id, Integer quantity)
Method Arguments
Name Type Description
item_id Id
quantity Integer
Returns: Void
LineItem:
global LineItem(Id item_id, Integer quantity, Boolean price_override, Decimal sale_price)
Method Arguments
Name Type Description
item_id Id
quantity Integer
price_override Boolean
sale_price Decimal
Returns: Void
LineItem:
global LineItem(Id invoice_id, Decimal invoice_payment_amount)
Method Arguments
Name Type Description
invoice_id Id
invoice_payment_amount Decimal
Returns: Void
Properties
invoice_id: Id
item_id: Id
price_override: Boolean
amount: Decimal
quantity: Integer

ScheduledPayments

Domain class for the Scheduled_Payment__c SObjectType

Methods

This component supports the following methods.

processScheduledPayment:
global static void processScheduledPayment(Id scheduledPaymentId)
Method Arguments
Name Type Description
scheduledPaymentId Id
Returns: Void

ScheduledPayments.Constructor

Methods

This component supports the following methods.

construct:
global Framework.Domain construct(List<SObject> sObjectList)
Method Arguments
Name Type Description
sObjectList List<SObject>
Returns: Framework.Domain -

ShoppingCart

Object for working with shopping carts and related data for customers accessing the app in a salesforce community

Methods

This component supports the following methods.

ShoppingCart:
global ShoppingCart()
ShoppingCart:
global ShoppingCart(Boolean autoInsert)
Method Arguments
Name Type Description
autoInsert Boolean
Returns: Void
getSalesOrder:
global Sales_Order__c getSalesOrder()
getSalesOrder:
global Sales_Order__c getSalesOrder(Boolean forceCreateSO)
Method Arguments
Name Type Description
forceCreateSO Boolean
Returns: Sales_Order__c -
updateCookie:
global static void updateCookie(Id cookieSalesOrderId, Id cookieUserId)
Method Arguments
Name Type Description
cookieSalesOrderId Id
cookieUserId Id
Returns: Void
createSalesOrderLineCookie:
global static void createSalesOrderLineCookie(Id cookieSalesOrderLineId)
Method Arguments
Name Type Description
cookieSalesOrderLineId Id
Returns: Void
createSalesOrderLineCookies:
global static void createSalesOrderLineCookies(Set<Id> cookieSalesOrderLineIds)
Method Arguments
Name Type Description
cookieSalesOrderLineIds Set<Id>
Returns: Void
clearSalesOrderLineCookie:
global static void clearSalesOrderLineCookie()
deleteUnwantedSalesOrderLines:
global static void deleteUnwantedSalesOrderLines()

StoreService

Service class for the Store__c SObjectType

Methods

This component supports the following methods.

buildStoreAccount:
global static Account buildStoreAccount(Store__c store,Contact contactObj)
Method Arguments
Name Type Description
storeOrderApi__Store__c
contactObj Contact
Returns: Account -
getGuestContact:
global static Contact getGuestContact(Store__c store,String email,String firstName, String lastName,String matchingField)
Method Arguments
Name Type Description
storeOrderApi__Store__c
email String
firstName String
lastName String
matchingField String
Returns: Contact -

EventRegistrationController

Methods

This component supports the following methods.

EventRegistrationController:
global EventRegistrationController()
setSelectedTicketType:
global static String setSelectedTicketType(String selectedTicketType,String item,String soId,String ticketTypeSOLId)
Method Arguments
Name Type Description
selectedTicketType String
item String
soId String
ticketTypeSOLId String
Returns: String -

GenerateEventMobilePass

Generate mobile pass for events

Methods

This component supports the following methods.

GenerateEventMobilePass:
global GenerateEventMobilePass(Event__c eventObj,Attendee__c attendeeObj)
Method Arguments
Name Type Description
eventObjEventApi__Event__c
attendeeObjEventApi__Attendee__c
Returns: Void
setRegUrl:
global void setRegUrl(String url)
Method Arguments
Name Type Description
url String
Returns: Void
isPassbookAvailable:
global Boolean isPassbookAvailable()
getPassUrl:
global String getPassUrl()

MobilePassController

Generate mobile pass for events controller

Methods

This component supports the following methods.

generatePass:
global static String generatePass(String jsonData)
Method Arguments
Name Type Description
jsonData String
Returns: String -

PackageScripts

Methods

This component supports the following methods.

onInstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onInstall(InstallContext context)
Method Arguments
Name Type Description
context InstallContext
Returns: Void
onUninstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onUninstall(UninstallContext context)
Method Arguments
Name Type Description
context UninstallContext
Returns: Void
install: Execute the installation scripts for the EventApi managed package
global static void install()

PackageScripts.Install

Runs all default installation scripts for the EventApi Managed Package @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.AppConfig

Creates basic accounting master data and other preference releated configurations. @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Register

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Rollups

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.CustomScripts

Event__c.Waitlist_Entry__c (# of Waiting people for an Event) (Count)

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Jobs

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.Metadata

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.SetQRCodesDefaults

Methods

This component supports the following methods.

run:
global void run()

PackageScripts.swapDescriptiononVenue

Methods

This component supports the following methods.

run:
global void run()

SponsorPackageWrapper

SponsorPackage Wrapper Class

Methods

This component supports the following methods.

compareTo:
global Integer compareTo(Object compareTo)
Method Arguments
Name Type Description
compareTo Object
Returns: Integer -

TemplateController

Methods

This component supports the following methods.

TemplateController:
global TemplateController()
cleanSalesOrderLines:
global void cleanSalesOrderLines()

PackageScripts

Package Scripts

Methods

This component supports the following methods.

onInstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onInstall(InstallContext context)
Method Arguments
Name Type Description
context InstallContext
Returns: Void
onUninstall: Required for UninstallHandler interface implementation ID organizationId(); ID uninstallerId();
global void onUninstall(UninstallContext context)
Method Arguments
Name Type Description
context UninstallContext
Returns: Void
install: Execute the installation scripts for the OrderApi managed package
global static void install()

PackageScripts.Install

Runs all default installation scripts for the OrderApi Managed Package @implements Framework.Scriptable

Methods

This component supports the following methods.

run:
global void run ()

PackageScripts.MigrateIsFeaturedData

SponsorPackageWrapper

SponsorPackage Wrapper Class

Methods

This component supports the following methods.

compareTo:
global Integer compareTo(Object compareTo)
Method Arguments
Name Type Description
compareTo Object
Returns: Integer -

currencyField

Attributes

record: SObject
** Conditionally Required ** The SObject Record .
field: String
** Conditionally Required when record is filled in ** The Salesforce Field .
value: String
** Conditionally Required ** Use this when you dont want to use outputField but still get the formatting .
currencySymbol: String
** Conditionally Required ** The Currency Symbol .
currencyISOCode: String
** Conditionally Required ** The Currency ISO Code you want to use for this component .
useOutputField: Boolean
** Conditionally Required ** The Currency ISO Code you want to use for this component .

img

Attributes

src: String
the img tag source
clazz: String
the img tag class
id: String
the img tag id
style: String
the img tag style
alt: String
the img tag alt text
width: String
the img tag width
height: String
the img tag height
title: String
the img tag title
extra: String
comma-separated `key=value` to add extra attributes to the img tag

lookup

Attributes

value: String
Set the value of the lookup input field
styleClass: String
CSS class attribute to apply on the search input box.
style: String
CSS style attribute to apply on the search input box.
placeholder: String
Text to display as a placeholder in the search input box.
object: String
The type of record we are searching.
objectIdField: String
The field that provides the object Id.
primaryField: String
The field that provides the primary display value.
secondaryField: String
A field to differentiate the display value. Appears in parens.
minSearchLength: Integer
How many characters you must type before searching. Must be 2 or more.
searchScope: String
Indicates which types of fields on the object to search. One of ALL, NAME, EMAIL, PHONE, SIDEBAR.
filterClause: String
WHERE clause to filter records. Do not include WHERE.
orderBy: String
Name of field to sort records by.
recordLimit: String
Maximum number of records to return to the list.
destinationForSelectedId: String
Id of a field, such as an apex:inputHidden, that should get Salesforce Id of the selected item.
destinationForSelectedValue: String
Id of a field, such as an apex:inputHidden, that should get the displayed name/value of the selected item.
stealFocus: Boolean
Whether to automatically move the focus to the search box when the component is displayed.
multipleSelect: Boolean
If select box is multiple select or single select. Default is mutltiple

mdapi_unzip

Attributes

oncomplete: String
Javascript executed on unzip of file entry
name: String
Name of the Javascript function generated to unzip files

mdapi_zip

Attributes

oncomplete: String
Javascript executed once all files have been zipped
name: String
Name of the Javascript function generated to zip files

mdapi_zip_entry

Attributes

path: String
Path to entry in the zip file
data: String
File data

messages

Attributes

severity: String
Severity Of Messages To Display

slds_accordion

calendar

Attributes

calendarType: String
** Required ** The Type of Calendar .
calendarInput: CalendarInputWrapper[]
** Required ** List of CalendarInput Type data to render on Calendar
clickable: Boolean
** Optional ** If the list is clickable
width: String
** Optional ** The Width of the Calendar in pixels
height: String
** Optional ** The Height of the Calendar in pixels
contentHeight: String
** Optional ** Content Height of the cell
pageTitle: String
** Optional ** The page title
styleClass: String
** Optional ** The Styleclass for the top level div
calendarStyleClass: String
** Optional ** The Styleclass for the Calendar div

customhtml

Attributes

html: String
** Required ** The Custom HTML that need to be rendered in the Component.
layout: String
** Required ** The Custom HTML that need to be rendered in the Component.
styleClass: String
** Optional ** Style Class for the Custom HTML

dataTable

Attributes

sobjectName: String
fieldSetName: String
** Optional / Required ** The name of the fieldset for column display. Name field is displayed by default
fieldCsv: String
searchable: boolean
sortable: boolean
** Optional ** if the table is sortable
tableHeading: String
** Optional ** The Table heading to be displayed
defaultSortOrder: String
** Optional ** the default sort order
defaultPageSize: Integer
** Optional ** The page size of a table
styleClass: String
tableStyleClass: String
defaultSortColumns: String
** Optional ** CSV String of default Sort columns
editable: Boolean
** Optional ** If the Table is editable
panelStyle: String
Valid styles include default, primary, warning, info, success, inverse and danger.

detail

Attributes

fieldSetNames: String[]
** Conditionally Required ** List of (or one) fieldset(s) to show up on detail page .
fieldSetNamesCSV: String
** Conditionally Required ** List of (or one) fieldset(s) to show up on detail page in the CSV Format.
subjectId: Id
** Required ** Record Id of the Sobject
styleClass: String
** Optional ** The Adhoc Styleclass for the outer div
editable: Boolean
** Optional ** If the detail page is editable
onSubmit: String
** Optional ** Javascript to execute on Form Submit
onSaveComplete: String
** Optional ** Javascript to execute onSaveComplete
successRedirectPageKey: String
** Optional ** External Id of a Page Record.
columnsPerRow: Integer
** Required ** Number of columns per row

feed

Attributes

subjectid: Id
** Required ** The group to which the feed is posted.

form

Attributes

formId: Id
** Required ** The record Id of the form to render.
formResponseId: Id
** Optional ** The record Id of the response to update is optional.
subjectId: Id
** Optional ** The subject Id is used to link the form response to a parent sobject.
subjectLookupField: sobjectField
SobjectField token to use when linking the subject (found by subjectId) as the parent to a Form Response. The field must be a field found on the Form Response custom object and match the subjectId sobject type.
wizard: Boolean
Render the form in wizard format, defaults false
width: String
Valid value for CSS width default is 100%.
reRender: String
Value of the component Id to rerender when the form is saved
onSubmit: String
Javascript to execute when the form is submitted.
responderId: Id
Provide any valid Contact, Account, or User Id to link to the form response generated by the component.
wizardHeight: String
The wizard functionality has been deprecated - it will be replaced in a future release.
wizardNavPosition: String
Control the position of the wizard navigation, does not affect the component when wizard is not set to true. Valid values are right, left, top, and bottom. Default is left.
componentNamespace: String
Namespace component for javascript
submitButtonLabel: String
The label for the submit button on the form.
displaySubmitButton: Boolean
Display Submit Button Label
formIdentifier: String
The label for the submit button on the form.

formexternal

Attributes

formId: Id
** Required ** The record Id of the form to render.
componentNamespace: String
Namespace component for javascript
formResponseId: Id
** Optional ** The record Id of the response to update is optional.
subjectId: Id
** Optional ** The subject Id is used to link the form response to a parent sobject.
subjectLookupField: sobjectField
SobjectField token to use when linking the subject (found by subjectId) as the parent to a Form Response. The field must be a field found on the Form Response custom object and match the subjectId sobject type.
width: String
Valid value for CSS width default is 100%.
reRender: String
Value of the component Id to rerender when the form is saved
onSubmit: String
Javascript to execute when the form is submitted.
responderId: Id
Provide any valid Contact, Account, or User Id to link to the form response generated by the component.
renderSubmit: Boolean
Whether or not to render the submit button
renderTitleInstructions: Boolean
Whether or not to render the title/instructions

groupmembers

Attributes

subjectid: String
The Id of the record. If provided will search related records within that id
searchable: boolean
If the component is searchable
titlefield: String
** Optional ** The Table heading to be displayed
imagefield: String
** Optional ** The Table heading to be displayed
descriptionfieldCSV: String
** Optional ** The Table heading to be displayed
defaultpagesize: Integer
** Optional ** The page size of a table
defaultsortorder: String
** Optional ** The Sort Order for members
defaultsortfield: String
** Optional ** The Sort field for members
modaltitlefield: String
** Optional ** The title field on modal
modaldescriptionfieldsetCSV: String
** Optional ** The title field on modal
filterFieldcsv: String
** Optional ** The title field on modal
showmodalonclick: Boolean
** Optional ** Show the Modal when card is clicked
showfilters: Boolean
** Optional ** Show the Modal when card is clicked
no_results_found_message: String
** Optional ** Message displayed when no results are returned

groups

Attributes

subjectid: String
The Id of the Site. If provided will search related records within that id
showmygroups: Boolean
Boolean flag to show only logged in user groups
searchable: boolean
If the component is searchable
titlefield: String
** Optional ** The Table heading to be displayed
imagefield: String
** Optional ** The Table heading to be displayed
descriptionfieldCSV: String
** Optional ** The Table heading to be displayed
defaultpagesize: Integer
** Optional ** The page size of a table
defaultsortorder: String
** Optional ** The Sort Order for members
defaultsortfield: String
** Optional ** The Sort field for members
filterfieldCSV: String
** Optional ** The filter fields for the page.
showfilters: Boolean
** Optional ** Show the Modal when card is clicked
no_results_found_message: String
** Optional ** Message displayed when no results are returned
navigateurl: String
** Optional ** Url to navigate to when clicked on a card

list

Attributes

records: SObject[]
** Required ** The list of records .
sobjectName: String
** Required ** The SObject name on which a list is created .
filter: String
** Required ** The Sobject filter .
recordLimit: Integer
** Required ** The Sobject Record Limit .
ordered: boolean
** Optional ** Whether the list is ordered or unordered list
orderByFields: String
** Optional ** The fields on which the records must be ordered (can have multiple fields, comma separated)
sortOrder: String
** Optional ** The sort order for the records, valid values ASC and DESC
titleField: String
** Optional ** the field that is highlighted
descriptionFieldsCSV: String
** Optional ** the fields to show under the list item
searchable: Boolean
** Optional ** If the list is searchable
pageSize: Integer
** Optional ** The List Page Size
styleClass: String
** Optional ** Styleclass for top level div container
listStyleClass: String
** Optional ** Styleclass for the UL List group
itemStyleClass: String
** Optional ** StyleClass for the List Item
headerStyleClass: String
** Optional ** StyleClass for the Headers
detailStyleClass: String
** Optional ** StyleClass for the Details
refStyleClass: String
** Optional ** StyleClass for the header field.

navbar

Attributes

name: String
** Required ** Name of Menu .
styleClass: String
** Optional ** The StyleClass for the Menu Component
brandRedirect: String
** Optional ** The Redirect URL when Brand Logo is clicked
brandLogo: String
** Optional ** The Logo URL for the brand image
brandTitle: String
** Optional ** The brand title
navStyleClass: String
** Optional ** The StyleClass for the Nav Component
ulStyleClass: String
** Optional ** The StyleClass for the Ul Component
logoImgClass: String
** Optional ** The StyleClass Logo Image

navlist

Attributes

title: String
** Optional ** The title of Menu .
name: String
** Required ** Name of Menu .
styleClass: String
** Optional ** The StyleClass for the Menu Component
elementStyleClass: String
** Optional ** The StyleClass for the a element
ulStyleClass: String
** Optional ** The StyleClass for the a element
panelType: String
The type of panel includes default, primary, warning, or danger.
displayInPanel: Boolean
Displays the menu inside of a panel.

profiletabs

Attributes

userId: String
** Required ** User Id of the User .
fieldSetNamesCSV: String
** Required ** Fieldsets to show on the Details tab .

userprofile

Attributes

userId: String
** Required ** User Id of the User .
fieldSetNamesCSV: String
** Required ** Fieldsets to show on the Details tab .

userprofilephoto

Attributes

userId: String
** Required ** User Id of the User .
width: String
** Optional ** The Width of the Image .
height: String
** Optional ** The height of the Image .
inputFileStyleClass: String
** Optional ** Input File Style Class .
styleClass: String
** Optional ** StyleClass for the div .
inputFileStyleClass: String
** Optional ** Input File Style Class .

accessible_sites

Attributes

customerId: String
Contact Id of current User

admin_app_config

campaign_page_preview_error

customer360

Attributes

customerId: Id
** REQUIRED ** The ID of an account or contact record to use as the display subject for the component.

epayment_credit_card

Attributes

redirectUrl: String
The url to redirect users after a payment transaction.
postbackUrl: String
The url to redirect users after a payment transaction.
gatewayToken: String
Payment gateway token.
salesOrder: Sales_Order__c
Sales Order object.
epayment: EPayment__c
Epayment sobject.
disable: Boolean
disables the component if there is an error
payment_method_retain: Boolean
Checks the save payment method checkbox by default
hide_save_payment: Boolean
Ability to save payment method
has_payment_error: Boolean
Boolean value to hide AVS values after payment error
credit_card_namespace: String
Namespace for credit card
batch: String
Batch Id

epayment_echeck

Attributes

redirectUrl: String
The url to redirect users after a payment transaction.
gatewayToken: String
Payment gateway token.
salesOrder: Sales_Order__c
Sales Order object.
epayment: EPayment__c
Epayment object.
payment_method_retain: Boolean
Checks the save payment method checkbox by default
hide_save_payment: Boolean
Ability to save payment method
namespace: String
Namespace for e-check component
batch: String
Batch Id

epayment_invoice

Attributes

salesOrder: Sales_Order__c
Sales Order object.
ePayment: EPayment__c
Epayment object.
redirectUrl: String
The url to redirect users after a payment transaction.

epayment_offline

Attributes

salesOrder: Sales_Order__c
Sales Order object.
ePayment: EPayment__c
Epayment object.
redirectUrl: String
The url to redirect users after a payment transaction.
batch: String
Batch Id

epayment_payment_methods

Attributes

customerId: Id
Account/Contact for which the payment methods are managed
salesOrder: Sales_Order__c
Sales Order object.
redirectUrl: String
The url to redirect users after a payment transaction.
gatewayToken: String
Payment gateway token.
epayment: EPayment__c
Epayment sobject.
disable: Boolean
disables the component if there is an error
saved_methods_namespace: String
Namespace for saved payment methods
batch: String
Batch Id

epayment_proforma_invoice

Attributes

salesOrder: Sales_Order__c
Sales Order object.

epayment_result

invoice

Attributes

invoiceId: Id
The id of the invoice to display in the component.

loader

navlist

Attributes

title: String
** Optional ** The title of Menu .
name: String
** Required ** Name of Menu .
ulStyleClass: String
** Optional ** The StyleClass for the a element
panelType: String
The type of panel includes default, primary, warning, or danger.
displayInPanel: Boolean
Displays the menu inside of a panel.
contactId: Id
Contact Id for user

new_receipt_invoice

Attributes

recInvId: Id
The salesforce unique record id of the receipt to display.

order_summary

Attributes

pgController: PageControllerBase
The controller for the page using the component.
componentId: String
The unique component Id for the Component. Will be useful when using multiple components in a single Visualforce page
subjectId: Id
** Required ** Record Id of the parent SObject
styleClass: String
** Optional ** The Adhoc Styleclass for the outer div
header: String
** Optional ** The text for header
cartHeader: String
** Optional ** The header for Cart Section
totalLabel: String
** Optional ** The Cart Total Label
tableClass: String
** Optional ** The Adhoc Styleclass for the table div
itemStyleClass: String
** Optional ** The Adhoc Styleclass for the Item div
removeBtnStyleClass: String
** Optional ** The Adhoc Styleclass for the remove button div
imageWidth: String
** Optional ** The Width of the Image
imageHeight: String
** Optional ** The Height of the Image
pageRerenderPanels: String
** Optional ** The rerender panels - CSV separated, on the parent page that need to be rerendered when order summary changes

payment_methods

Attributes

customerId: Id
Account/Contact for which the payment methods are managed
gatewayToken: String
Token of the gateway with which the new payment methods can be verified
redirecturl: String
redirect url to where you want to redirect the page to after successful verfification

portal_shopping_cart

proforma_invoice_email_pdf

Attributes

soId: String
Sales order record to which the email is sent to

proforma_invoice_template

Attributes

soId: String
Sales order record to which the email is sent to

receipt

Attributes

receiptId: Id
The salesforce unique record id of the receipt to display.

add_to_calendar

Attributes

event: Event__c
The Sobject for the event used as the subject for the component must query the event EventApi__Start_Date_Time__c, EventApi__End_Date_Time__c, EventApi__Calendar_Reminder_Text__c, and EventApi__Display_Name__c fields.
venue: Venue__c
Primary Venue
startDateTime: String
Start Date Time Converted based on timezone
endDateTIme: String
End Date Time Converted based on timezone
calendars: String
Comma-separated list of calendars to support for the component. Valid calendar values are 'iCalendar','Google Calendar','Outlook','Outlook Online', and 'Yahoo! Calendar.'

group_confirmation_email

Attributes

attendeeId: String
Attendee record to which the email is sent to

group_registration_email

Attributes

attendeeId: String
Attendee record to which the email is sent to

mobile_pass

Attributes

event: Event__c
The Sobject for the event used as the subject for the component must query the event EventApi__Start_Date_Time__c, EventApi__End_Date_Time__c, EventApi__Organizer_Name__c, EventApi__Location_Information__c, and EventApi__Display_Name__c fields.
attendee: Attendee__c
The Sobject for the attendee used as the subject for the component.
eventId: Id
The Id for the event used as the subject for the component must query the event EventApi__Start_Date_Time__c, EventApi__End_Date_Time__c, EventApi__Organizer_Name__c, EventApi__Location_Information__c, and EventApi__Display_Name__c fields.
attendeeId: Id
The Id for the attendee used as the subject for the component.
logoImageUrl: String
The logo Image Url.
barcodeUrl: String
Barcode URL for QR code on pass
passIconWidth: String
Pass Icon Width
passIconHeight: String
Pass Icon Height
labelColor: String
Label Color
foregroundColor: String
Color for value font
imageStyleClasses: String
Style Classes for image tag

venue_map

Attributes

venue: Venue__c
Venue sobject to use as the subject for the rendered map.
documentElementId: String
Enter a unique string to use as the div id for the map container.
height: String
Enter the height of the map.

Framework__API_Dispatch_Header_Variables__c

API Dispatch Header Variable
API Dispatch header variables

Custom Fields

API Name Label Type Length Required
Description
Framework__Api_Dispatch__c Api Dispatch Text 255 true
**Required** The name of the API Field to pull the value from
Framework__Key__c Key Text 255 true
**Required** Headers Or Variable Key
Framework__Value__c Value Text 255 true
**Required** Headers Or Variable Value
Framework__SObject_Field_Value__c Value Text 255 false
Value for Header or Variable pulled from SObject so that the value can be dynamic
Framework__Is_Header__c Is Header Checkbox false
**Optional** Is Key/Value Pair a header value
Framework__Is_Variable__c Is Variable Checkbox false
**Optional** Is Key/Value Pair a variable value
Framework__Is_Token_Variable__c Is Token Variable Checkbox false
**Optional** Is Key/Value Pair a token variable value
Framework__Token_Order__c Token Order Number false
**Conditionally** Order for token replacement only if Is Token Variable is set to true

Framework__API_Dispatch__c

API Dispatch
API Dispatch to fire API Calls

Custom Fields

API Name Label Type Length Required
Description
Framework__Api_Resource__c Api Resource Text 255 true
**Required** The name of the API Field to pull the value from
Framework__API_Service__c API Service Text 255 true
**Required** The name of the related API Service
Framework__HTTP_Verb__c HTTP Verb Text 255 true
**Required** Which HTTP verb to call in the Api Resource
Framework__SObject_Name__c SObject Name Text 255 false
Framework__Is_Enabled__c Is Enabled Checkbox false
When enabled, the trigger that fires on the object represented by this rule will route to the defined Apex Class. Default checked.
Framework__Disable_Run__c Disable Run Checkbox false
Disable the next run if the current run is done for after update or after insert
Framework__After_Insert__c After Insert Checkbox false
Fire HTTP calls after insert happens on triggered object
Framework__After_Update__c After Update Checkbox false
Fire HTTP calls after update happens on triggered object
Framework__Execution_Order__c Execution Order Number false
**Conditionally** Order for API Calls to be executed

Framework__API_Grouping__c

API Grouping
List of API Groupings to SObjects related to one API Service and one API Object

Custom Fields

API Name Label Type Length Required
Description
Framework__Api_Object__c Api Object Text 255 true
Name of the JSON API object.
Framework__API_Service__c API Service Text 255 true
The name of the related API Service
Framework__Target_Related_Lookup_Field__c Target Related Lookup Field Text 255 true
Relationship Field between the related object and the primary object selected in the API_Resource__c
Framework__Primary_Api_Resource__c Primary API Resource Text 255 true
Primary API Resource under which this grouping exists.

Framework__API_Mapping__c

API Mapping
List of API mappings to SObjectFields related to one API Service and one API Object

Custom Fields

API Name Label Type Length Required
Description
Framework__Api_Field__c Api Field Text 255 true
**Required** The name of the API Field to pull the value from
Framework__Api_Object__c Api Object Text 255 true
**Required** Name of the parent Api Object for the specified Api Field.
Framework__Api_Resource__c Api Resource Text 255 true
**Required** Name of the parent Api Resource
Framework__Related_Object_Field__c Related Object Field Text 255 false
Framework__Target_Field_Type__c Target Field Type Text 255 true
**Required** The name of the Schema.DisplayType (found in SObjectField.getDescribe().getType())
Framework__Target_Field__c Target Field Text 255 true
**Required** The API name of the target SObjectField to populate with the value of the API Field (Source)

Framework__API_Resource__c

API Resource
API Resource linked to a API Service

Custom Fields

API Name Label Type Length Required
Description
Framework__API_Service__c API Service Text 255 true
**Required** The name of the related API Service configuration.
Framework__Api_Grouping__c Api Grouping Text 255 false
ID of the API Grouping the resource belongs to.
Framework__Api_Object_Key_Field__c Api Object Key Field Text 255 true
Framework__Api_Object__c Api Object Text 255 true
**Required** The name of the API Object related to the API Resource, typically the name of a json object or xml root element.
Framework__Create_URI__c Create URI Text 255 false
Framework__Create_Verb__c Create Verb Text 255 false
Framework__Delete_URI__c Delete URI Text 255 false
Framework__Delete_Verb__c Delete Verb Text 255 false
Framework__Disable_Post_Put_JSON_Parse__c Disable POST/PUT JSON Parse Checkbox false
Denotes if the response from the POST/PUT should be parsed or not.
Framework__Is_List__c Is List Checkbox false
Denotes if the api resource is a list of records or a single record.
Framework__Read_URI__c Read URI Text 255 false
Framework__Read_Verb__c Read Verb Text 255 false
Framework__Target_Object_Key_Field__c Target Object Key Field Text 255 true
Framework__Target_SObject__c Target SObject Text 255 true
**Required** The full api name of the target SObjectType to bind the API Object too.
Framework__Update_URI__c Update URI Text 255 false
Framework__Update_Verb__c Update Verb Text 255 false

Framework__API_Route__c

API Route
API Router route

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 true
**Required** The name of the apex class that implements the ApiInterface class

Framework__API_Service_Connection_Config__c

API Service Connection Config
Multiple connection name/value pairs that may be needed for calls and login.

Custom Fields

API Name Label Type Length Required
Description
Framework__API_Service_Connection__c API Service Connection Text 255 true
Framework__Name__c Name Text 60 true
Framework__Value__c Value Text 255 true
Framework__Is_Masked__c Is Masked Checkbox false

Framework__API_Service_Connection__c

API Service Connection
Service connection object that stores connection info and is related to API Service so you can have multiple connections to single vendor

Custom Fields

API Name Label Type Length Required
Description
Framework__API_Service__c API Service Text 255 true
Framework__Access_Token__c Access Token Text 255 false
Framework__Access_Token_Ext1__c Access Token Ext 1 Text 255 false
Framework__Refresh_Token__c Refresh Token Text 255 false
Framework__Refresh_Token_Ext1__c Refresh Token Ext 1 Text 255 false
Framework__Client_Id__c Client Id Text 255 false
Framework__Client_Secret__c Client Secret Text 255 false
Framework__Is_Default__c Is Default Checkbox false
Framework__Password__c Password Text 255 false
Framework__Scope__c Scope Text 255 false
Framework__Username__c Username Text 255 false

Framework__API_Service__c

API Service
List of API Services registered with the Framework

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 true
Framework__Auth_Type__c Auth Type Text 255 true
Framework__Description__c Description Text 255 false
Framework__Display_Name__c Display Name Text 255 false
Framework__Is_Read_Only__c Is Read Only Checkbox false
When checked, changes can only be made by System.
Framework__Debug_Mode__c Debug Mode Checkbox false
When checked, the responses received from the API Service will be written to System Logs for debugging and troubleshooting.
Framework__Endpoint__c Endpoint Text 255 true
**Required** The base url to send api requests related to the API service
Framework__Is_Enabled__c Is Enabled Checkbox false
Checked when the API Service is live, Unchecked when the API Service is disabled.
Framework__Namespace__c Namespace Text 255 false
Framework__Image_Path__c Image Path Text 255 false

Framework__API_Variable__c

API Variable
Variables that will be used to make network call

Custom Fields

API Name Label Type Length Required
Description
Framework__API_Resource__c API Resource Text 255 true
Framework__Default_Value__c Default Value Text 255 false
Framework__Field_Api_Name__c Field Api Name Text 255 true
Framework__Field_Api_Value__c Field Api Value Text 255 false
Framework__Required__c Required Checkbox false

Framework__App_Update__c

App Update
Custom Setting that controls which features are enabled or disabled.

Custom Fields

API Name Label Type Length Required
Description
Framework__Display_Name__c Display Name Text 255 true
**Required** The name of the critical update to be applied
Framework__Namespace__c Namespace Text 255 true
**Required** The namespace for the app update
Framework__Description__c Description Text 255 false
The description of the critical update to be applied
Framework__Is_Activated__c Is Activated Checkbox false
When activated the apex class will be executed and enable the feature.
Framework__Is_Dismissed__c Is Dismissed Checkbox false
When the app update notification is dismissed.
Framework__Apex_Class__c Apex Class Text 255 false
Apex class to execute when the update is activated
Framework__Forced_Activation_Date__c Forced Activation Date Date false
Date that the update will be force activated and Apex class will be executed.
Framework__Activated_Date__c Activated Date DateTime false
the date when this app update was activated.

Framework__Core__c

Core
**Protected** Fonteva Core hierarchy setting controls Fonteva platform enablement

Custom Fields

API Name Label Type Length Required
Description
Framework__Custom_Domain__c Custom Domain Text 255 false
Custom Domain for org's with special "my.salesforce.com" domains.
Framework__Is_Enabled__c Is Enabled Checkbox false
Enable or disable Fonteva and all Registered Apps
Framework__Triggers_Enabled__c Triggers Enabled Checkbox false
Enable or disable Registered Object Triggers and Trigger Extensions
Framework__Enable_Async_Rollups__c Enable Async Rollups Checkbox false
Enable or disable Async Rollups

Framework__Currency_Conversion_Table__c

Currency Conversion Table
**Protected** Custom settings used for Currency Conversion Table since Portal User does not have access to Standard "CurrencyType" object to get rates.

Custom Fields

API Name Label Type Length Required
Description
Framework__Conversion_JSON__c Conversion JSON TextArea false
Stores the daily rates in JSON format. Scheduled class updates this JSON only if Multi Currency is enabled for related environment.

Framework__Custom_Script__c

Custom Script
**Protected** Configurations for managing ad hoc custom apex scripts related to Registered Apps.

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 false
Name of the apex class (no namespace - or dot namespace conventions) that executes the script and implements the ScriptableInterface.
Framework__Description__c Description TextArea false
Short description for the script when viewed in a list.
Framework__Name__c Name Text 255 false
The display name of the script to end users.
Framework__Namespace__c Namespace Text 255 false
The namespace assigned to the Registered App that owns the configuration.

Framework__Developer_Settings__c

Developer Settings
**Public** Developer settings for working with Framework and extending packages.

Custom Fields

API Name Label Type Length Required
Description
Framework__CDN_Base_Url__c CDN Base Url Text 255 false
** Warning! Do Not Modify ** The base url for the cdn server used to surface assets for framework (lux) ui.

Framework__FontevaPulse_Component__mdt

Fonteva Pulse Component

Custom Fields

API Name Label Type Length Required
Description
Framework__Is_Enabled__c Is Enabled Checkbox false
When checked, this record will become enabled as a template.
Framework__Lightning_Component_Name__c Lightning Component Name Text 255 false
**REQUIRED** Name of the Lightning component that needs to be added. Only provide the name of the component without namespace.

Framework__Registered_App__c

Registered App
**PROTECTED** Enables managed packages to register with NationSuite's Base managed package services.

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 false
The Apex Class assigned to the Registered App.
Framework__Banner_Image_Path__c Banner Image Path Text 255 false
Relative path to the location of the png, gif, or jpeg image file containing a 960 x 300 image used as the banner art for the Registered App's detail page in Mission Control.
Framework__Description__c Description TextArea false
Framework__Developer_Email__c Developer Email Email false
Developer email address used for exception notifications and other workflows related to the Registered App.
Framework__Homepage__c Homepage Url false
Website URL that points to the app's homepage where user's can find additional information.
Framework__Icon_Image_Path__c Icon Image Path Text 255 false
Relative path to the location of the png or gif file containing a 120x120 pixel icon image for the Registered App.
Framework__Install_Class__c Install Class Text 255 false
Framework__Is_Enabled__c Is Enabled Checkbox false
When checked, the app is enabled and dispatch will allow all triggers controlled by the app to fire in the environment. Default checked.
Framework__Is_Managed__c Is Managed Checkbox false
Checked when the registered app is a managed package installed from the AppExchange. Default checked.
Framework__Is_Paid__c Is Paid Checkbox false
Checked when the Registered App is a paid license model.
Framework__Name__c Name Text 255 false
The name of the application as it should appear to end users.
Framework__Owner__c Owner Text 255 false
The name of the individual or business entity that holds the rights for the Registered App.
Framework__Short_Description__c Short Description TextArea false
Short description (less than 255 characters) to use in pages that contain a list of Registered Apps.

Framework__Registered_Object__c

Registered Object
Maps SObjects to a Registered App, Domain Apex Class, and Selector Apex Class with additional controls and configurations.

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 false
The Apex Class assigned as the domain for the Registered Object.
Framework__Validation_Disabled__c Validation Disabled Checkbox false
Disable validation that is run when triggers are dispatched
Framework__Is_Enabled__c Is Enabled Checkbox false
When unchecked, exceptions will be thrown for all triggerable events related to the associated SObjectType. Default checked.
Framework__Is_Standard__c Is Standard Checkbox false
True when the object registered is a standard Salesforce object (Account, Contact, Opportunity, etc...)
Framework__Namespace__c Namespace Text 255 false
Framework__SOQL_Limit__c SOQL Limit Text 255 false
Framework__SOQL_Order_By__c SOQL Order By Text 255 false
Framework__Salesforce_ID__c Salesforce ID Text 20 false
Salesforce.com Id for the related SObject.
Framework__Triggers_Enabled__c Triggers Enabled Checkbox false
When checked Triggers will be routed through Dispatcher for the associated SObjectType assuming all other route trigger evaluated conditions return true. Default checked.

Framework__Registry__mdt

Fonteva Registry Entry

Custom Fields

API Name Label Type Length Required
Description
Framework__Is_Enabled__c Is Enabled Checkbox false
todo
Framework__Category__c Entry Category Text 255 false
todo
Framework__Key__c Entry Key Text 255 true
todo
Framework__Value__c Entry Value LongTextArea 32768 false
todo

Framework__Rollup_Summary_Field__c

Rollup Summary Field
**PROTECTED** "Rollup Summary Field" (RollupSummaryField.class) configurations.

Custom Fields

API Name Label Type Length Required
Description
Framework__Child_Field__c Child Field Text 255 false
Framework__Child_SObject__c Child SObject Text 255 false
Framework__Filter__c Filter Text 255 false
Framework__Is_Enabled__c Is Enabled Checkbox false
Framework__Namespace__c Namespace Text 255 false
Framework__Operation__c Operation Text 255 false
Framework__Parent_Field__c Parent Field Text 255 false
Framework__Parent_SObject__c Parent SObject Text 255 false
Framework__Relationship_Field__c Relationship Field Text 255 false
Framework__Parent_Batch_Scope__c Parent Batch Scope Number false
Number of parent records going into the batch during the resync of the rollup
Framework__Child_Batch_Scope__c Child Batch Scope Number false
Number of child records going into the batch during the batch rollup
Framework__Enable_Batching__c Enable Batching Checkbox false
Rollup enabled for batch processing.
Framework__Enable_Trigger__c Enable Trigger Checkbox false
Enable trigger for parent SObject that will be updated in result of the rollup running.

Framework__Routing_Rule__c

Routing Rule
**PROTECTED** Configurations to control trigger and trigger extension behaviors.

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 false
The class that contains all logic for the object identified by the rule.
Framework__Execution_Order__c Execution Order Number false
The order in which the extension will fire 0 (first) thru 999 (last) positions supported.
Framework__Is_Enabled__c Is Enabled Checkbox false
When enabled, the trigger that fires on the object represented by this rule will route to the defined Apex Class. Default checked.
Framework__Namespace__c Namespace Text 255 false
Framework__SObject_Name__c SObject Name Text 255 false

Framework__Settings_Page__c

Settings Page
** PROTECTED ** List of settings pages configured for a registered app.

Custom Fields

API Name Label Type Length Required
Description
Framework__Apex_Class__c Apex Class Text 255 false
The apex class that implements the DyanamicComponent.Handler interface.
Framework__Apex_Component__c Apex Component Text 255 false
The full api name of the apex (visualforce) component to use when rendering the contents of the page.
Framework__Description__c Description Text 255 false
The description to display to end users.
Framework__Label__c Label Text 255 false
The label for the settings page.
Framework__Namespace__c Namespace Text 255 false
The namespace that corresponds with the registered app that owns the settings page.

Framework__System_Log__c

System Log
Fonteva System Logs captures diagnostic and debugging data for all exceptions handled by Registered Apps using the Fonteva Framework.

Custom Fields

API Name Label Type Length Required
Description
Framework__Data__c Data LongTextArea 32768 false
Data contains the current log at the time the System Log was generated either by an exception, Registered App event, Fonteva Framework event, or user triggered event.
Framework__Exception_Data__c Exception Data LongTextArea 32768 false
Exception data contains information specifically related to exceptions handled by the Fonteva Platform including code line number, exception message, exception type, as well as blamed Registered App and/or Registered Object when applicable.
Framework__Path__c Path Text 255 false
The path of the requested URL from the user who created the System Log.
Framework__Registered_App__c Registered App Text 255 false
The display name of the Registered App that generated the log.
Framework__Registered_Object__c Registered Object Text 255 false
The full api name of the Registered Object that generated the System Log.
Framework__Type__c Type Text 255 false
**System Calculated** Populates with a general description of the event that triggered the System Log.
Framework__User_Profile__c User Profile Text false
The user profile.
Framework__User_Type__c User Type Text false
The user type.
Framework__Is_Shipped__c Is Shipped Checkbox false
Whether or not the log has shipped to our remote logging server.

PagesApi__Community_Group_Member__c

Community Group Member
Junction object which would connect groups or contacts or accounts to different groups.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Account__c Account LookupPagesApi__Account false
Defines the group member to an Account record.
PagesApi__Activated_Date__c Activated Date Date false
Defaults to today's date when no value is populated on record insert.
PagesApi__Bio__c Bio LongTextArea 131072 false
Description of the group member.
PagesApi__Chatter_Group_Member_Id__c Chatter Group Member Id Text 18 false
DO NOT UPDATE. The ID in this field links the group member to a chatter group member. For groups with the contact member entity type only.
PagesApi__Community_Group__c Community Group MasterDetail false
The group under which all the members are linked.
PagesApi__Contact__c Contact LookupPagesApi__Contact false
Defines the group member to a Contact record.
PagesApi__Deactivated_Date__c Deactivated Date Date false
The group member deactivation date.
PagesApi__Display_In_Directory__c Display In Directory Checkbox false
Allows group member to appear in search results when displaying group list views in the portal. Defaults checked if Is Active is checked.
PagesApi__Display_Name__c Display Name Text 255 false
The name of the Group Member as you would like it to display when published to customers.
PagesApi__Email__c Email Email false
The group member's email.
PagesApi__Facebook_Profile_URL__c Facebook Profile URL Text 255 false
URL where the user should be redirected when they click the Facebook icon in the group dashboard.
PagesApi__Google_Profile_URL__c Google+ Profile URL Text 255 false
URL where the user should be redirected when they click the Google+ icon in the group dashboard.
PagesApi__Image_URL__c Image URL Url false
URL for the group member's image or photo.
PagesApi__Is_Active_User__c Is Active User Checkbox false
Identifies an active user related to the group member.
PagesApi__Is_Active__c Is Active Checkbox false
Select whether the group member is active. Defaults checked.
PagesApi__Is_Manager__c Is Manager Checkbox false
Select whether the group member is allowed to manage the group. Defaults unchecked.
PagesApi__Join_Request_Date__c Join Request Date Date false
The date that the group member requested to join a private group.
PagesApi__LinkedIn_Profile_URL__c LinkedIn Profile URL Text 255 false
URL where the user should be redirected when they click the LinkedIn icon in the group dashboard.
PagesApi__Linked_Community_Group__c Linked Community Group LookupPagesApi__Community_Group__c false
Defines the group member that is a part of a collection of groups.
PagesApi__Role__c Role Picklist false
Role of the group member in the group.
PagesApi__Status__c Status Picklist false
Status of the group member record: 1. Request Submitted - group member has requested to join a private group. 2. Active - group member has been added to a group. 3. Request Declined - group member has been rejected upon request to join a private group. 4. Deactivated - group member has been deactivated.
PagesApi__Twitter_Profile_URL__c Twitter Profile URL Text 255 false
URL where the user should be redirected when they click the Twitter icon in the group dashboard.
PagesApi__User__c User LookupPagesApi__User false
Defines a relationship to a contact's related community user record. CANNOT BE UPDATED.

PagesApi__Community_Group__c

Community Group
A group of members which could contain either groups or contacts or accounts.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Banner__c Banner Url false
Banner displayed in the group
PagesApi__Chatter_Group_Id__c Chatter Group ID Text 18 false
**System Calculated** Collaboration group ID that the community group is linked with.
PagesApi__Community_Network_ID__c Community Network ID Text false
** System Calculated ** This field shows the ID for the related community.
PagesApi__Description__c Description LongTextArea 131072 false
Description of the group that should appear in the dashboard of the group.
PagesApi__Email__c Email Email false
The Group's email address.
PagesApi__Enable_Access_Permissions__c DEPRECATED Checkbox false
When checked, the Group will only be made visible when the Contact meets the criteria set in the "Access Permissions" related list. Unchecked by default.
PagesApi__Enable_Community_Feed__c Enable Community Feed Checkbox false
Enables chatter features in the community. Requires members to be enabled.
PagesApi__Enable_Events__c Enable Events Checkbox false
Enables event only features in the community.
PagesApi__Enable_Members__c Enable Members Checkbox false
Enables Member features in the community.
PagesApi__Disable_Join__c Disable Join Checkbox false
Disable joining the community group.
PagesApi__Facebook_Profile_URL__c Facebook Profile URL Text 255 false
URL where the user should be redirected when they click the Facebook icon in the group dashboard.
PagesApi__Google_Profile_URL__c Google+ Profile URL Text 255 false
URL where the user should be redirected when they click the Google+ icon in the group dashboard.
PagesApi__Group_Image_URL__c Group Image URL Url false
URL for the group image that should appear in the dashboard of the group.
PagesApi__Group_Member_Edit_Field_Sets_CSV__c Group Member Edit Field Sets(CSV) Text 255 false
This field references field sets that define the attributes to be updated by the group member when editing their group member profile.
PagesApi__Group_Member_View_Field_Sets_CSV__c Group Member View Field Sets(CSV) Text 255 false
This field references field sets that define the attributes to be seen on the group member modal.
PagesApi__Group_Owner__c Group Owner LookupPagesApi__User false
Owner of the group. Defaults to the user creating the group, if not populated.
PagesApi__Group_Roster_Label__c Group Roster Label Text 255 false
Button label displayed on the group detail page.
PagesApi__Group_Roster_Link__c Group Roster Link Url false
Page where the user should be redirected when they click the roster link. Defaults to the group roster page.
PagesApi__Is_Account_Member_Entity__c SYSTEM Checkbox false
**System Calculated** Selected if Member Entity Type is "Account."
PagesApi__Is_Contact_Member_Entity__c SYSTEM Checkbox false
**System Calculated** Selected if Member Entity Type is "Contact."
PagesApi__Is_Group_Member_Entity__c SYSTEM Checkbox false
**System Calculated** Selected if Member Entity Type is "Group."
PagesApi__Is_Private__c Is Private Checkbox false
Checked if the group is Private.
PagesApi__Is_Public__c SYSTEM Checkbox false
Checked if group is Public.
PagesApi__Is_Published__c Is Published Checkbox false
By checking this field, the group will be displayed in the Community Portal.
PagesApi__Is_Unlisted__c SYSTEM Checkbox false
Checked if group is Unlisted.
PagesApi__LinkedIn_Profile_URL__c LinkedIn Profile URL Text 255 false
URL where the user should be redirected when they click the LinkedIn icon in the group dashboard.
PagesApi__Member_Entity_Type__c Member Entity Type Picklist false
Defines the member type. Only the type selected can be a member of the group.
PagesApi__Member_Search_Display_Fields_CSV__c Member Search Display Fields (CSV) Text 255 false
Defines the fields to be displayed on the group member tiles in the Group Members page using comma separated values of field API names. Limited to Group Member fields only.
PagesApi__Member_Search_Filter_Fields_CSV__c Member Search Filter Fields (CSV) Text 255 false
Enter additional fields, comma separated, to narrow group member searches on the group listing page. Be sure to use the field's API name.
PagesApi__Member_Search_Display_Field_s_CSV__c Member Search Display Fields (CSV) LongTextArea 31768 false
Defines the fields to be displayed on the group member tiles in the Group Members page using comma separated values of field API names. Limited to Group Member fields only.
PagesApi__Member_Search_Filter_Field_s_CSV__c Member Search Filter Fields (CSV) LongTextArea 31768 false
Enter additional fields, comma separated, to narrow group member searches on the group listing page. Be sure to use the field's API name.
PagesApi__Members__c Members Summary false
Number of members in the group.
PagesApi__Privacy_Setting__c Privacy Setting Picklist false
Choose the privacy settings of the group: 1. Public - Open visibility; Open join process 2. Private - Restricted visibility; Approval based join process 3. Unlisted - Visible only to members, not searchable; Backend join process
PagesApi__Private_Community_Feed__c Private Community Feed Checkbox false
Enables Chatter only for members of the community group.
PagesApi__Private_Events__c Private Events Checkbox false
Enables Events only for members of the community group.
PagesApi__Private_Members__c Private Members Checkbox false
Enables member features for members only in the community.
PagesApi__Search_Results_Sort_Field__c Search Results Sort Field Text 255 false
** Defaults Group Name ** Combined with the Search Results Sort Order, this field defines the field to sort group member search results in ascending or descending order. Limited to Community Group Member Fields Only.
PagesApi__Search_Results_Sort_Order__c Search Results Sort Order Text 255 false
** Defaults Ascending ** Combined with the Search Results Sort Field, this field defines the order in which the search results will be displayed.
PagesApi__Search_Results__c Search Results Number false
** Default 10 ** The value in this field defines the maximum number of results that will be returned for search results on the Group Members tab.
PagesApi__Show_Group_Roster__c Show Group Roster Checkbox false
Displays the link of the group roster in the community group dashboard.
PagesApi__Show_Search_Filters__c Show Search Filters Checkbox false
** Default Unchecked ** This field enables or disables the filters in the Group Search page.
PagesApi__Site__c Site LookupPagesApi__Site__c false
** Required ** Link to the Site which owns the Community Group.
PagesApi__Twitter_Profile_URL__c Twitter Profile URL Text 255 false
URL where the user should be redirected when they click the Twitter icon in the group dashboard.
PagesApi__Type__c Type Picklist false
This field allows you to define a type of group to be available in the group search. This field's values can be updated to better suite your organization's needs.

PagesApi__Component__c

Component
List of dynamic components that can be used to create new page elements.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Apex_Class__c Apex Class Text 255 true
The name of the Apex Class that implements the dynamic component interface.
PagesApi__Description__c Description Text 255 false
Short description for the Dynamic Component.
PagesApi__Has_Body__c Has Body Checkbox false
If true, users can define custom html that will be inserted into the apex:componentBody. Default false.
PagesApi__Icon_Path__c Icon Path Url false
The path to the component Icon that can be used in various pages
PagesApi__Image_Path__c Image Path Text 255 false
Link to an image file showing an example implementation of the dynamic component.
PagesApi__Preview_Width__c Preview Width Number false
PagesApi__Do_Not_Display_In_Page_Builder_UI__c Do Not Display In Page Builder UI Checkbox false
When checked, the Component will not be made available for selection in the page builder ui.

PagesApi__Contact

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Site__c Site LookupPagesApi__Site__c false
Select the Site you wish to use as the default Site for the Contact.
PagesApi__Cookie_Usage_Accepted__c Cookie Usage Accepted Checkbox false
When checked, the Contact has accepted the Cookie Usage Prompt and will not be prompted again.

PagesApi__Field_Group__c

Field Group
Field Groups store data about the behavior of a set of fields published on a web form.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__DML_Operation__c Database Operation Picklist false
The value specified in this field either creates new records ("Insert") or updates existing records ("Upsert").
PagesApi__Form__c Form LookupPagesApi__Form__c false
**Required** Identifies the field group's related form.
PagesApi__Allow_Users_to_Delete_Mapped_Records__c Allow Users to Delete Mapped Records Checkbox false
** WARNING ** when checked, users will be able to delete records mapped to the field group even if they were not created by the form submitter.
PagesApi__Instructions__c Instructions LongTextArea 32768 false
The content entered in this field is displayed to end users to assist in entering data into the fields contained in the field group.
PagesApi__Is_Multiple__c Allow Multiple Entries Checkbox false
Enables multiple record entries for an object on the form (like a related list).
PagesApi__Mapped_Object__c Mapped Object Text 255 false
Specifies the target object to which records are created or updated for this field group.
PagesApi__Mapped_Relationship_Field__c Mapped Relationship Field Text 255 false
When linked to a parent field group, this field stores the api name of the lookup or master-detail field that links the two objects together.
PagesApi__Order__c Order Number false
Identifies the order the Field Group is displayed on the form (Sorted Ascending).
PagesApi__Parent_Field_Group__c Parent Field Group LookupPagesApi__Field_Group__c false
Specifies the Parent Object for this Field Group's records.
PagesApi__SOQL_Filter__c SOQL Filter Text 255 false
Defines the filter criteria used to retrieve existing records for this Field Group.

PagesApi__Field_Response__c

Field Response
Object used to identify the responses from form submissions.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Field_Group__c Field Group LookupPagesApi__Field_Group__c false
** System Calculated ** Link to related Field Group.
PagesApi__Field_Help_Text__c Field Help Text Text false
** System Calculated ** Displays the field's help text.
PagesApi__Field_Label__c Field Label Text false
** System Calculated ** Displays the parent field's label.
PagesApi__Field_Order__c Field Order Number false
** System Calculated ** Displays the order specified on the form.
PagesApi__Field_Type__c Field Type Text false
** System Calculated ** Displays the field type.
PagesApi__Field__c Field LookupPagesApi__Field__c false
** System Calculated Required ** Identifies the value's related field.
PagesApi__Form_Response__c Form Response LookupPagesApi__Form_Response__c false
Identifies the related Form Response for form submissions.
PagesApi__Mapped_Field__c Mapped Field Text false
** System Calculated ** Displays the mapped field from the parent field.
PagesApi__Report_Response__c Report Response Text 255 false
** Use for Reporting on Responses ** The report response field trims the length of the entered response to restrict size to less than 255 chars. Currently salesforce will not allow a report to perform groupings on long text area fields.
PagesApi__Response_Group__c Response Group Text 255 false
** SYSTEM FIELD DO NOT EDIT **
PagesApi__System_Reference__c System Reference Text 18 false
** SYSTEM FIELD DO NOT EDIT ** Maps created object id for upsert updates.
PagesApi__Response__c Response LongTextArea 100000 false
** Required ** Identifies the submitted field's value.
EventApi__Attendee__c Attendee LookupEventApi__Attendee__c false
** System Calculated ** Link between the Field Response and the Attendee. Used to display registration question answers.
EventApi__Speaker__c Speaker LookupEventApi__Speaker__c false
** System Calculated ** Link between the Field Response and the Speaker. Used to display Speaker Contract & Agreement information on the Speaker record.
EventApi__Sponsor__c Sponsor LookupEventApi__Sponsor__c false
** System Calculated ** Link between the Field Response and the Sponsor. Used to display Sponsor Contract & Agreement information on the Sponsor record.

PagesApi__Field__c

Field
Fields store data that drives the look and field and behavior of web forms published in the Web Publisher application.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Field_Group__c Field Group LookupPagesApi__Field_Group__c false
**Required** All fields must be associated with a Field Group. Field Groups can be used to update and create new records in the database.
PagesApi__Form__c Form LookupPagesApi__Form__c false
Associates this field to a form.
PagesApi__Help_Text__c Help Text TextArea false
A value in this field displays a help icon next to the field on the form. Hovering the cursor over the help icon displays a text box with the help text field's content to assist the user in understanding the nature of the question.
PagesApi__Hidden_Field_Value__c Hidden Field Value Text 255 false
Populates a hidden field with the value entered in this field (only required when field is hidden on the form by default).
PagesApi__Is_Hidden__c Hidden Field Checkbox false
Does not display the field to end users when checked. This is typically used when you wish to pass default or constant values as the value for the field.
PagesApi__Is_Required__c Is Required Checkbox false
Requires the field for all users submitting the form. Defaults unchecked.
PagesApi__Mapped_Field__c Mapped Field Text 255 false
**Optional** Specifies the field the response will be mapped to.
PagesApi__Options__c Options LongTextArea 32768 false
Specifies the list of values for a Picklist or Multi-Picklist field below. Each value should be separated by a new line.
PagesApi__Order__c Order Number false
Specifies the order this field is presented to the end user.
PagesApi__Type__c Type Picklist false
Identifies the field type to be created. Section Header and Instructional Text fields build out read-only content in the form to enhance the user experience.

PagesApi__Fonteva_Controller_Route__mdt

Fonteva Controller Route
Lightning community routes by record id's.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Apex_Class__c Apex Class Text 255 false
Apex class to get record information based on route
PagesApi__SObject_Name__c SObject Name Text 255 false
SObject name to base the route on
PagesApi__Component__c Component Text 255 false
Lightning Component name without the namespace to show based on SObject route.
PagesApi__Is_Enabled__c Is Enabled Checkbox false
When checked, this record will become enabled as a route.

PagesApi__Form_Response__c

Form Response
Object used to capture form submission attributes that parents Field Responses.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Account__c Account LookupPagesApi__Account false
Identifies the account or the contact's related account.
PagesApi__Contact__c Contact LookupPagesApi__Contact false
Identifies the related contact to the form submission.
PagesApi__Date__c Date Date false
** System Calculated ** Identifies the date the form was submitted.
PagesApi__Entity__c Entity Picklist false
Identifies the "Customer" of the record.
PagesApi__Form__c Form LookupPagesApi__Form__c false
** Required ** Identifies the response's related form.
PagesApi__Responder_Link__c Responder Text false
** System Calculated ** Link to the responder record (Account, Contact, or User).
PagesApi__User__c User LookupPagesApi__User false
** System Calculated ** Link to the User that responded to the Form.
OrderApi__Assignment__c Assignment LookupOrderApi__Assignment__c false
Link to related Assignment.
OrderApi__Item__c Item LookupOrderApi__Item__c false
Link to related Item.
OrderApi__Sales_Order_Line__c Sales Order Line LookupOrderApi__Sales_Order_Line__c false
Link to related Sales Order Line.
OrderApi__Sales_Order__c Sales Order LookupOrderApi__Sales_Order__c false
Link to related Sales Order.
EventApi__Attendee__c Attendee LookupEventApi__Attendee__c false
** System Calculated ** Link between the Form Response and the Attendee.
EventApi__Registration_Item__c Registration Item LookupEventApi__Registration_Item__c false
** System Calculated ** Link between the Form Response and the Registration Item.
EventApi__Speaker__c Speaker LookupEventApi__Speaker__c false
** System Calculated ** Link between the Form Response and the Speaker.
EventApi__Sponsor__c Sponsor LookupEventApi__Sponsor__c false
** System Calculated ** Link between the Form Response and the Sponsor.

PagesApi__Form__c

Form
Build and publish responsive HTML5 web forms to portal communities or your public facing website.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Description__c Description LongTextArea 32768 false
Optional description for the Form.
PagesApi__Display_Style__c Display Style Picklist false
Defines the display style for the Form. Can be Standard, Accordion or Wizard
PagesApi__Submit_Style__c Submit Style Picklist false
Defines the submit style for the Form. Can be Url Location or Javascript
PagesApi__Submit_Value__c Submit Value LongTextArea 32768 false
URL Location or Javascript to execute on form submission
PagesApi__User_Instructions__c User Instructions LongTextArea 32768 false
Enter the instructions you wish to show users while filling out the form.
PagesApi__Wizard_Review_Instructions__c Wizard Review Instructions LongTextArea 32768 false
For Wizard-style forms only. This text appears on the final review screen.

PagesApi__Media_Asset_Collection__c

Media Collection
Collection of Media Assets.

PagesApi__Media_Asset__c

Media Asset
Upload documents, photographs, animations, videos, music, stylesheets, and javascript files for use in any Fonteva Community.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Download_Link__c Download Link Text false
Download the asset (opens new tab based on browser settings and behavior).
PagesApi__Extension__c Extension Text 255 false
** System Calculated Required ** The extension of the file.
PagesApi__Filename__c Filename Text 255 true
** Required ** The name of the file.
PagesApi__MIME_Type__c MIME Type Text 255 true
** System Calculated ** MIME types form a standard way of classifying file types on the Internet. The MIME Type of the related asset is required.
PagesApi__Media_Asset_Collection__c Media Asset Collection LookupPagesApi__Media_Asset_Collection__c false
Lookup to the Media Asset Collection Object, acts as a grouping parent
PagesApi__Path__c Path Text 255 true
The location of the media asset.
PagesApi__Short_Description__c Short Description TextArea false
Short description about the image that has been uploaded
PagesApi__Title__c Title Text 80 false
The title for the media asset

PagesApi__Menu_Item__c

Menu Item
Menu Items create a hierarchy of links to both Pages and Custom Weblinks.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Custom_URL__c Custom URL LongTextArea 32768 false
** Conditionally Required ** URL for the Web Link. Required for "Custom URL" Menu Items.
PagesApi__Display_Order__c Display Order Number false
** Required ** The order in which this Menu Item should display.
PagesApi__Display_Text__c Display Text LongTextArea 32768 false
** Conditionally Required ** The text to display for "Text" Menu Items.
PagesApi__Icon__c Icon Text 255 false
Optional icon to use in context with the Menu Item. Note! Icon fonts are available only if you define links to the Stylesheets containing their definitions in either the Theme or in a Site's Global CSS.
PagesApi__Link_Target__c Link Target Text 255 false
Specifies how target link is opened in the browser. Valid values include "_self" to open in the same tab, and "_blank" to open in a new window or tab.
PagesApi__Menu_Item__c Parent LookupPagesApi__Menu_Item__c false
Link to the parent Menu Item.
PagesApi__Menu__c Menu MasterDetail false
** Required ** Master-detail link to the parent Menu.
PagesApi__On_Click_Javascript__c On Click Javascript LongTextArea 32768 false
Javascript to run for the "on click" event (when the Menu Item is clicked).
PagesApi__Page__c Page LookupPagesApi__Page__c false
** Conditionally Required ** When the Type of Menu Item is "Page Link".
PagesApi__Style_Class__c Style Class Text 255 false
Custom CSS Style Class to use for the Menu Item.
PagesApi__Value__c Value Text 255 false
** SYSTEM **
PagesApi__Is_Standard__c Is Standard Checkbox false
** SYSTEM **
PagesApi__Type__c Type Picklist false
** Required ** The Type of Menu Item defaults to "Page Link".

PagesApi__Menu__c

Menu
Menus group a collection of Pages and are used to create Navigation elements for Sites published using Fonteva's Publisher.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Site__c Site LookupPagesApi__Site__c false
** Required ** The Site controls the Pages made available when creating Menu Items for the Menu.

PagesApi__Page_Element_Attribute__c

Page Element Attribute
Page Element Attributes store the configuration required for various Page Elements.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Key__c Key Text 255 true
** Required ** Attribute key as defined by the page element dynamic component.
PagesApi__Page_Element__c Page Element MasterDetail false
** Required ** Link to related Page Element.
PagesApi__Value__c Value LongTextArea 32768 false
The value set for the page element configuration.
PagesApi__Type__c Type Text 255 false
** System Field ** The expected and required data type of the page element attribute.

PagesApi__Page_Element__c

Page Element
Page Elements define the content for pages in Fonteva Communities.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Component__c Component Text 255 false
The name of the PagesApi component.
PagesApi__HTML__c HTML LongTextArea 131072 false
HTML content for the page element.
PagesApi__Order__c Order Number false
** Required ** The order in which the element renders inside of a given page section.
PagesApi__Page__c Page LookupPagesApi__Page__c false
** Required ** Link to the page that renders the page element.
OrderApi__Campaign_Page__c Campaign Page LookupOrderApi__Campaign_Page__c false
Link to related Campaign Page.

PagesApi__Page__c

Page
Stores the configurations for custom pages created in Fonteva's Publisher (PagesApi).

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Auth_Required__c Auth Required Checkbox false
When checked the Page will require a User to be authenticated either through the Customer Portal, Partner Portal, or Community. Defaults unchecked.
PagesApi__Enable_SEF_URLs__c Enable SEF URLs Checkbox false
When checked URLs will be re-written into a user friendly format based on the configurations of the Site and Page "Slug" fields. Defaults unchecked.
PagesApi__Is_Published__c Is Published Checkbox false
When checked, the Page is made available either online or in the backend staff interface.
PagesApi__No_Archive__c No Archive Checkbox false
When checked, Google, Yahoo, and Bing will be instructed to not archive the page/cache the Page. Defaults unchecked.
PagesApi__No_Follow__c No Follow Checkbox false
When checked, Google, Yahoo, and Bing will be instructed to not follow and index any links on the Page. Defaults unchecked.
PagesApi__No_Index__c No Index Checkbox false
When checked, Google, Yahoo, and Bing will be instructed to not include the Page in Search Engine Results. Defaults checked.
PagesApi__Page_ID__c Page ID AutoNumber false
Auto incrementing number used as an External ID for the Page.
PagesApi__SEF_Slug__c SEF Slug Text 255 false
Search Engine Friendly (SEF) "Slug" to use when re-writing URLs to improve usability and SEO.
PagesApi__Site__c Site LookupPagesApi__Site__c false
** Required ** Link to the Site where the Page will be published.
PagesApi__Is_Standard__c Is Standard Checkbox false
** SYSTEM **
PagesApi__Menu__c Menu LookupPagesApi__Menu__c false
Link to the related page menu configuration.
PagesApi__Page_URL__c Page URL Url false
** System Calculated ** The URL for the page.
PagesApi__Form__c Form LookupPagesApi__Form__c false
Link to the related form.
PagesApi__Site_Template_Key__c SYSTEM Text false
** System Calculated ** The template key used for the parent site.
PagesApi__Visualforce_Page__c Visualforce Page Text 255 false
The API name (with namespace) of the visualforce page referenced by this page configuration.
PagesApi__Title_Tag__c Title Tag Text 80 false
** Required ** HTML Title tag.
OrderApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked access to the Page is controlled by the related user-defined Access Permissions. Defaults unchecked - essentially enabling all public and authenticated Users access to the Page and related content.

PagesApi__S3__c

S3
** PROTECTED ** Amazon Web Services S3 integration configuration.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__ACL__c ACL Text 255 true
** Required ** Default ACL to use for all media assets. Defaults to "public-read".
PagesApi__Access_Key__c Access Key Text 255 true
** Required ** AWS Access Key
PagesApi__Bucket__c Bucket Text 255 true
** Required ** AWS S3 Bucket used to store all media assets.
PagesApi__Folder__c Folder Text 255 true
** Required ** The customer folder (root) where all media assets will be stored.
PagesApi__Secret__c Secret Text 255 true
** Required ** AWS Secret

PagesApi__Site_Template__c

Site Template
Custom site templates built for Fonteva Communities.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Apex_Class__c Apex Class Text 255 false
PagesApi__Description__c Description Text 255 false
PagesApi__Display_Name__c Display Name Text 255 false
PagesApi__Namespace__c Namespace Text 255 false
PagesApi__Image_Path__c Image Path Text 255 false
PagesApi__Configuration_Fieldset__c Configuration Field Set Text 255 false
PagesApi__Form_VF_Page__c Form VF Page Text 255 false
PagesApi__Custom_Page_VF_Page__c Custom Page VF Page Text 255 false

PagesApi__Site__c

Site
Sites are a collection of Pages published and hosted natively on the Force.com platform.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Site_URL__c Site URL Url false
The base URL for the Site.
PagesApi__Auth_Provider_Default_Account__c Auth Provider Default Account LookupPagesApi__Account false
The default account to use for Auth Provider
PagesApi__Base_Title_Tag__c Base Title Tag Text 255 false
** System Calculated Required Override ** The Base Title Tag is used as a prefix or suffix to all child Page "Title Tags". For example : "My Custom Page < My Base Title Tag". Defaults to the name of the Site.
PagesApi__Community_Network_ID__c Community Network ID Text 255 false
PagesApi__Community_Network_Name__c Community Network Name Text 255 false
PagesApi__Default_Community_New_User_Profile__c Default Community New User Profile Text 255 false
PagesApi__Description__c Description LongTextArea 32768 false
Optional description of the Site.
PagesApi__Enable_SEF_URLs__c Reserved for Future Use Checkbox false
Reserved for Future Use
PagesApi__Google_Login_URL__c Google Login URL Url false
Login URL from Auth Provider in Setup
PagesApi__Is_Default__c Is Default Checkbox false
The default site for a given community. Only one site can be default for a community.
PagesApi__User_Self_Registration_URL__c User Self Registration URL Url false
The URL for the self registration page.
PagesApi__User_Login_URL__c User Login URL Url false
The URL for the login page.
PagesApi__User_Reset_Password_URL__c User Reset Password URL Url false
The URL for the reset password page.
PagesApi__Group_Search_Default_Sort_Field__c Group Search Default Sort Field Text 255 false
** Defaults Group Name ** Combined with the Search Results Sort Order, this field defines the field to sort group search results in ascending or descending order. Limited to Group Fields Only.
PagesApi__Group_Search_Filters_CSV__c Group Search Filters (CSV) Text 255 false
This field references the field set that defines the attributes that a user can use to filter search results.
PagesApi__Group_Search_Page_Results__c Group Search Page Results Number false
** Default 10 ** The value in this field defines the maximum number of results that will be returned for search results on the Groups page.
PagesApi__Group_Search_Result_Display_Fields_CSV__c Group Search Result Display Fields (CSV) Text 255 false
Defines the fields to be displayed on the group tiles in the Groups page using comma separated values of field API names. Limited to Community Group fields only.
PagesApi__Group_Search_Results_Sort_Order__c Group Search Results Sort Order Picklist false
** Defaults Ascending ** Combined with the Search Results Sort Field, this field defines the order in which the search results will be displayed.
PagesApi__Is_Published__c Is Published Checkbox false
When checked, the Site will be published and made available to the appropriate audience. Defaults unchecked.
PagesApi__Enable_Cookie_Prompt__c Enable Cookie Prompt Checkbox false
When checked, the Site will display a prompt asking the user to accept the use of cookies. If not accepted, the user will be redirected to an external site.
PagesApi__Cookie_Decline_Redirect_URL__c Cookie Decline Redirect URL Url false
Required if Enable Cookie Prompt is checked. Field contains the URL to redirect to if the prompt is not accepted. This is conditionally required.
PagesApi__LinkedIn_Login_URL__c LinkedIn Login URL Url false
Login URL from Auth Provider in Setup
PagesApi__Login_Redirect_URL__c Login Redirect URL Text 255 false
PagesApi__Login_Override_URL__c Login Override URL LongTextArea 32768 false
Portal users will be redirected to the provided URL when the "Login" button is clicked on the authentication page.
PagesApi__Create_Account_Override_URL__c Create Account Override URL LongTextArea 32768 false
Providing a URL will hide the "Create a user account" checkbox on the authentication page and display the provided URL link in its place.
PagesApi__Profile_Page_URL__c Profile Page URL Text 255 false
PagesApi__Menu__c Nav Menu LookupPagesApi__Menu__c false
Link to the Menu to use for the Site's "Primary" Navigation.
PagesApi__No_Archive__c No Archive Checkbox false
PagesApi__No_Follow__c No Follow Checkbox false
PagesApi__No_Index__c No Index Checkbox false
PagesApi__SEF_Slug__c Reserved for Future Use Text 255 false
Reserved for Future Use
PagesApi__Site_Template_Key__c Site Template Key Text 255 false
The name of the template to use for creating standard pages and menus related to the site.
PagesApi__Show_Group_Search_Filters__c Show Group Search Filters Checkbox false
** Default Unchecked ** This field enables or disables the filters in the Groups page.
PagesApi__Theme__c Theme LookupPagesApi__Theme__c false
** Required ** The Theme to use for the branding and style of pages contained in the Site.
PagesApi__Title_Tag_Separator__c Title Tag Separator Text 1 false
Optional character to use to separate the Base Title Tag from the Page Title Tag. In the example below the "<" character is used as the Title Tag Separator. Defaults to "|" "My Custom Page Title Tag < My Base Title Tag"
PagesApi__Twitter_Login_URL__c Twitter Login URL Url false
Login URL from Auth Provider in Setup
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
OrderApi__Enable_Access_Permissions__c Enable Access Permissions Checkbox false
When checked access to the Site is controlled by the related user-defined Access Permissions. Defaults unchecked - essentially enabling all public and authenticated Users access to the Site and related content.
OrderApi__Enable_eStore__c SYSTEM Checkbox false
** System Calculated ** Checked when the Site is linked to a Store.
OrderApi__Store__c Store LookupOrderApi__Store__c false
Link to the Related Store.

PagesApi__Skip_Logic_Rule__c

Skip Logic Rule

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Answer__c Answer Text 255 true
Value on which the rule is activated.
PagesApi__Destination__c Destination LongTextArea 131072 false
List of fields that should appear on selecting the value matching the answer field value(CSV).
PagesApi__Field__c Field MasterDetail false
CSV field with list of fields the rule defined against.

PagesApi__Theme__c

Theme
Themes store configurations for page style and branding.

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Body_Background_Color__c Body Background Text 10 false
Valid hexadecimal, rgb, or rgba notation required.
PagesApi__Brand_Primary__c Brand Primary Text 10 false
Valid hexadecimal, rgb, or rgba notation required.
PagesApi__Brand_Secondary__c Brand Secondary Text 10 false
Valid hexadecimal, rgb, or rgba notation required.
PagesApi__Custom_CSS__c Custom CSS LongTextArea 32768 false
Custom CSS is inserted before the closing html head ("</head>") tag into pages using this Theme.
PagesApi__Custom_Print_Stylesheet_URL__c Custom Print Stylesheet URL Text 255 false
Secure ("https://") url to the location of a custom stylesheet to use for rendering pages for print media.
PagesApi__Custom_Stylesheet_URL__c Custom Stylesheet URL Text 255 false
The secure ("https://") url where the stylesheet is hosted.
PagesApi__Description__c Description LongTextArea 32768 false
Optional description for the Theme.
PagesApi__Footer__c Footer LongTextArea 55000 false
Custom HTML to display in the footer of all pages that use the theme.
PagesApi__HTML_Head__c HTML Head LongTextArea 55000 false
Insert custom scripts and styles before the closing </head> tag into pages that use this Theme.
PagesApi__Header__c Header LongTextArea 55000 false
Custom HTML to display in the header of all pages that use the theme.
PagesApi__Link_Color__c Link Text 10 false
Valid hexadecimal, rgb, or rgba notation required.
PagesApi__Logo_Image__c Logo Image Text 255 false
The secure ("https://") url where the logo image file is located. We recommend uploading a logo that is of equal height and width and less than 20kb with a 72dpi resolution. The minimum height and width is 150px the maximum is 1000px.
PagesApi__Logo_Text__c Logo Text Text 255 false
If a logo image is not defined for the Theme the logo text will be used by default. Applies only for themes using "Fonteva Drive" as a stylesheet template.
PagesApi__Logo_URL__c Logo URL Text 255 false
The url of the web page to direct users when they click the logo text or logo image on any web page using this Theme. Valid only for Themes using "Fonteva Drive" as a stylesheet template.
PagesApi__Navbar_Background_Color__c Navbar Background Text 255 false
The background color to use for the primary navigation bar affixed to the top of community related pages.
PagesApi__Supernav_Background_Color__c Supernav Background Text 255 false
The background color to use for the supernav.
PagesApi__Supernav_Link_Color__c Supernav Link Text 255 false
The color to use for links contained inside the supernav.
PagesApi__Supernav_Text_Color__c Supernav Text Text 255 false
The color to use for text contained inside the supernav.
PagesApi__Favicon_Image__c Favicon Image Text 255 false
The image to use for a favicon used for visual site identification in various browser interfaces (bookmarks,tabs,etc...).
PagesApi__Navbar_Link_Color__c Navbar Link Text 255 false
The color to use for links contained inside the primary navigation bar affixed to the top of community related pages.
PagesApi__Text_Color__c Text Text 10 false
Valid hexadecimal, rgb, or rgba notation required.
PagesApi__Supernav_HTML_Position_1__c Supernav HTML Position 1 LongTextArea 30000 false
The Text/HTML for the Supernav Position #1.
PagesApi__Supernav_HTML_Position_2__c Supernav HTML Position 2 LongTextArea 30000 false
The Text/HTML for the Supernav Position #2.
PagesApi__Supernav_HTML_Position_3__c Supernav HTML Position 3 LongTextArea 30000 false
The Text/HTML for the Supernav Position #3.
PagesApi__Community_Styles__c SYSTEM LongTextArea 30000 false
Generated Styles for Community.
PagesApi__Lightning_Community_Styles__c SYSTEM LongTextArea 30000 false
Generated Styles for Lightning Community.

PagesApi__User

Custom Fields

API Name Label Type Length Required
Description
PagesApi__Is_Federated_User__c Is Federated User Checkbox false
PagesApi__Profile_Cover_Image__c Profile Cover Image Text 255 false
The secure ("https://") url where the profile cover image file is located. We recommend uploaded a logo that has a width of 1100px and height of 300px.

OrderApi__AVS_Response_Code__c

AVS Response Codes

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Description__c Description Text 255 false

OrderApi__Access_Permission__c

Access Permission
Access Permissions control the accessibility of content accessed via the API.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Badge_Type__c Badge Type LookupOrderApi__Badge_Type__c false
** Conditionally Required ** If "User Restricted Access Rule" is unchecked, a link to the Badge Type required to access the content is required.
OrderApi__Catalog__c Catalog LookupOrderApi__Catalog__c false
Link to the related Catalog that the Display Permission is controlling.
OrderApi__Icon__c Enabled Badge Type Text false
** System Calculated ** Icon for the related Badge Type with Badge Name.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
Link to the controlled Item Class -- when linked to an Item Class the Access Permission will clone itself by default to all Items created as a child to the Item Class.
OrderApi__Item__c Item LookupOrderApi__Item__c false
When linked to an Item - the Access Permission serves as validation for wether the purchasing Account or Contact is allowed to be assigned and/or sold the Item.
OrderApi__Page__c Page LookupPagesApi__Page__c false
Link to the related Page that the Display Permission is controlling.
OrderApi__Site__c Site LookupPagesApi__Site__c false
Link to the related Site that the Display Permission is controlling.
OrderApi__Store__c Store LookupOrderApi__Store__c false
Link to the related Store that the Display Permission is controlling.
EventApi__Event__c Event LookupEventApi__Event__c false
Link to the Event related to the configured Access Permission.
EventApi__Registration_Group__c Registration Group LookupEventApi__Registration_Group__c false
** System Calculated ** Link to the Registration Group configured with the Access Permission.
EventApi__Schedule_Item__c Schedule Item LookupEventApi__Schedule_Item__c false
** System Calculated ** Link to the Schedule Item configured with the Access Permission.
EventApi__Sponsor_Package__c Sponsor Package LookupEventApi__Sponsor_Package__c false
** System Calculated ** The link to the Sponsor Package configured with the Access Permission.
EventApi__Ticket_Type__c Ticket Type LookupEventApi__Ticket_Type__c false
** System Calculated ** The link to the Ticket Type configured with the Access Permission.
EventApi__Event_Status_Page__c Event Status Page LookupEventApi__Event_Status_Page__c false
** System Calculated ** The link to the Event Status Page configured with the Access Permission.

OrderApi__Account

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account_Email__c Account Email Email false
The default/primary email for the account.
OrderApi__Annual_Engagement_Score__c Annual Engagement Score Number false
Aggregates the Account's active engagement scores from it's badge records for the current year.
OrderApi__Outstanding_Credits__c Outstanding Credits Currency false
** System Calculated ** The sum of the Credit Memo Balance Due field for all Credit Memos linked to this customer.
OrderApi__Disable_Badge_Flow_down__c Disable Badge Flow-down Checkbox false
When checked, this field disables any inheritance of flow-down badges from the parent account.
OrderApi__Lifetime_Engagement_Score__c Lifetime Engagement Score Number false
Aggregates the Account's active engagement scores from it's badge records.
OrderApi__Primary_Contact__c Primary Contact LookupOrderApi__Contact false
The Primary Contact for the Account will auto-populate on all Account Transactions, Payments, etc... by default.
OrderApi__Price_Rules_Usages__c SYSTEM LongTextArea 131072 false
** SYSTEM ** JSON of price rules
OrderApi__Privacy_Settings__c Privacy Settings Picklist false
**Defaults to private** This field sets the visibility settings when account search is enabled. Public: Any user in the system can search. Private: Searchable by authenticated users only. Unlisted: Can not be searched at all.

OrderApi__AccountDomain__c

Account Domain
Stores the accepted domain names for the related account, which will be used for account matching.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Company__c Company LookupOrderApi__Account false
**Required** Linked the to related account.
OrderApi__Value__c Value Text 255 true
**Required** The value for the domain.

OrderApi__App_Config__c

App Config
Order to Cash Preferences for Fonteva Order Management

Custom Fields

API Name Label Type Length Required
Description
OrderApi__AR_Account__c A/R Account Text 20 false
Default AR (Accounts Receivable) Account.
OrderApi__Adjustment_Account__c Adjustment Account Text 20 false
Default Adjustment Account.
OrderApi__Business_Group__c Business Group Text 20 false
User/Profile default Business Group.
OrderApi__Calculate_Sales_Tax__c Calculate Sales Tax Checkbox false
When checked, enables the tax related valdiations and calculations.
OrderApi__Deposit_Account__c Deposit Account Text 20 false
Default Deposit Account.
OrderApi__Disable_Save_Payment_Method_Option__c Disable Save Payment Method Option Checkbox false
When checked, it disables the save payment method option on process payment.
OrderApi__Discount_Account__c Discount Account Text 20 false
Default Discount Account.
OrderApi__Enable_Individual_Accounts__c Enable Individual Accounts Checkbox false
When checked, Users will create individual/person/household accounts when contacts are created without a relationship to an existing account.
OrderApi__Exception_Account__c Exception Account Text 20 false
**System Calculated/Override** NationSuite creates an exception account record to use when a contact with no parent account is linked to a financial transaction without a specified account.
OrderApi__Exception_Contact__c Exception Contact Text 20 false
**System Calculated/Override** NationSuite creates an exception contact record to use when an account with no primary contact is linked to a financial transaction without a specified contact.
OrderApi__Income_Account__c Income Account Text 20 false
Default Income Account (used when creating new Business Groups and Items)
OrderApi__Individual_Account_Name_Extension__c Individual Account Name Extension Text 255 false
The individual account name extension is used when naming new individual/person accounts created in the system. The default value is "Household" which produces "John Doe Household".
OrderApi__Item_Weight_UOM__c Item Weight UOM Text 255 false
This field defines the default unit of measurement for shipping calculations.
OrderApi__Namespace_Prefix__c Namespace Prefix Text 20 false
**System Calculated/Do Not Modify** Namespace Prefix for the NationSuite Platform package.
OrderApi__Payment_Gateway__c Payment Gateway Text 100 false
Default Payment Gateway.
OrderApi__Payment_Terms__c Payment Terms Text 20 false
Default Payment Terms.
OrderApi__Refund_Account__c Refund Account Text 20 false
Default Refund Account.
OrderApi__Tax_Account__c Tax Account Text 20 false
Default Tax GL Account.
OrderApi__Tax_Locale__c Tax Locale Text 20 false
Default Tax Locale.
OrderApi__Bypass_Account_Billing_Address_Sync__c Bypass Account Billing Address Sync Checkbox false
Warning! Existing integrations may be broken when enabling this feature. When checked, the Account Billing Address field will no longer be updated with the value of the Account Shipping Address field.
OrderApi__Update_Contact_Standard_Email_Field__c Update Contact Standard Email Field Checkbox false
Warning! Existing integrations may be broken when enabling this feature. When checked, the contact email field will be updated with the value of the contact preferred email field.
OrderApi__Update_Contact_Standard_Phone_Field__c Update Contact Standard Phone Field Checkbox false
Warning! Existing integrations may be broken when enabling this feature. When checked, the contact phone field will be updated with the value of the contact preferred phone field.

OrderApi__Assignment_Role__c

Assignment Role
Configure custom roles for Contacts to be assigned to against "Assignable" Items.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Description__c Description LongTextArea 32768 false
Optional description for the Assignment Role.
OrderApi__Is_Active__c Is Active Checkbox false
When checked, the Roles is considered "Active".
OrderApi__Is_Default__c Is Default Checkbox false
When checked, the Roles is considered as"Default Assignment Role".
OrderApi__Is_Primary__c Is Primary Checkbox false
When checked, any Contact "Assignment" linked to the Assignment Role will be considered a "Primary Contact" for the "Assigned To Record". Defaults unchecked.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
OrderApi__Receives_Email_Notifications__c Receives Email Notifications Checkbox false
When checked, any Contact "Assignment" linked to the Assignment Role will receive notifications related to the "Assigned To Record" by default. Defaults unchecked.

OrderApi__Assignment__c

Assignment
Assignments track Contacts assigned to purchases of Items (Only available when Items are available for Assignment - determined by the parent Item Class)

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Assigned_Date__c Assigned Date Date false
** System Calculated Required Override ** Defaults to the parent Sales Order Line.
OrderApi__Assignment_Role__c Assignment Role LookupOrderApi__Assignment_Role__c false
** System Calculated Required Override ** Link to the Role for the assigned Contact on record.
OrderApi__Company_Name__c Company Name Text 255 false
Contact company name.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
** Required ** Link to assigned Contact record
OrderApi__Description__c Description LongTextArea 32768 false
Optional description for the Assignment.
OrderApi__Email__c Email Email false
** Conditionally Required ** The email address to send notifications to regarding the "Assigned To" record -- required if "Receives Email Notifications" is checked. Defaults to the related Contact's "Preferred Email".
OrderApi__First_Name__c First Name Text 255 false
Contact first name.
OrderApi__Full_Name__c Full Name Text 255 false
Contact full name.
OrderApi__Is_Active__c Is Active Checkbox false
When checked, the Contact is considered "Active". Defaults checked.
OrderApi__Is_Primary__c Is Primary Checkbox false
When checked, the Assignment is considered "Primary".
OrderApi__Is_Unassigned__c Is Unassigned Checkbox false
** System Calculated ** This checkbox will auto check to true when a Subscriber (Assignment) is marked as "Is Active" unchecked AND is related to a "Is Active" checked Subscription.
OrderApi__Item_Class__c Item Class LookupOrderApi__Item_Class__c false
** System Calculated ** Link to related Item Class.
OrderApi__Item__c Item LookupOrderApi__Item__c false
** System Calculated ** Link to related Item.
OrderApi__Last_Name__c Last Name Text 255 false
Contact last name.
OrderApi__Mailing_City__c Mailing City Text 255 false
Contact mailing city.
OrderApi__Mailing_Country__c Mailing Country Text 255 false
Contact mailing country.
OrderApi__Mailing_Postal_Code__c Mailing Postal Code Text 255 false
Contact mailing postal code.
OrderApi__Mailing_State__c Mailing State Text 255 false
Contact mailing postal code.
OrderApi__Mailing_Street__c Mailing Street Text 255 false
Contact mailing street.
OrderApi__Phone__c Phone Phone false
Contact phone.
OrderApi__Receives_Email_Notifications__c Receives Email Notifications Checkbox false
When checked the linked Contact will be copied on all emails sent regarding the "Assigned To" record. Defaults to the value of the same field on the related "Role" configuration.
OrderApi__Sales_Order_Line__c Sales Order Line (Source) LookupOrderApi__Sales_Order_Line__c false
** Required ** Assignments must be linked to a source Sales Order Line
OrderApi__Subscription_Line__c Subscription Line LookupOrderApi__Subscription_Line__c false
** System Calculated ** Link to related Subscription Line.
OrderApi__Subscription__c Subscription LookupOrderApi__Subscription__c false
Link to related Subscription for the subscribing customer.
OrderApi__Term__c Term LookupOrderApi__Renewal__c false
Link to related Term for the subscribing customer.
OrderApi__Title__c Title Text 255 false
Contact title.
OrderApi__Unassigned_Date__c Unassigned Date Date false
The date the Contact was unassigned.
EventApi__Other_Information__c Other Information LongTextArea 32768 false
Other information needed to configure the assignment.
EventApi__Seat__c Seat LookupEventApi__Seat__c false
Linked to the related seat.
EventApi__Contact_Created_By_System__c Contact Created By System Checkbox false
This field will be automatically checked when the contact is created while registering for an event.

OrderApi__Badge_Type__c

Badge Type
Configure Badge Types to assign to Contacts to allow greater control and flexibility around pricing and content accessibility.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Description__c Description LongTextArea 32768 false
Optional description of the Badge Type
OrderApi__Enable_Badge_Flow_down__c Enable Badge Flow-down Checkbox false
When checked and when the badge is assigned to an account, all contacts of that account, child accounts, and child account's contacts will inherit the benefits. Limited to only one level of child accounts.
OrderApi__Engagement_Score__c Engagement Score Number false
The engagement score that is to be assigned to the entity's badge record.
OrderApi__Icon_Location__c Icon Location Text 255 false
** System Calculated Override ** Override the default Badge Type icon with a custom image to distinguish the Badge Type from other Badge Types.
OrderApi__Icon__c Icon Text false
** System Calculated ** Badge Image Icon -- displayed in most Contact Badge list views.
OrderApi__Image_Location__c Image Location Text 255 false
Distinguish the Badge Type from other Badge Types by providing the URL to a securely hosted image to use as the Badge Type Image.
OrderApi__Image__c Image Text false
** System Calculated ** Preview the Badge Image configured for the Badge Type.
OrderApi__Is_Active__c Is Active Checkbox false
When checked the Badge Type is active and available for assignment to a Contact
OrderApi__Is_Published__c Is Published Checkbox false
When checked, Contacts assigned Badge related to the Badge Type will have the option to display the Badge on their Community Profile (valid only if Fonteva Communities is enabled for your environment - contact your administrator if you have any questions)
OrderApi__Public_Description__c Public Description Html 32768 false
The contents of this field will publish to the community portal.
OrderApi__Short_Description__c Short Description Text 255 false
Optional (but highly recommended) short description used on reports and to provide context to end users looking at a list of Contacts assigned to various badges.

OrderApi__Badge_Workflow__c

Badge Workflow
Trigger the assignment and unassignment of Badges to Contacts using Badge Workflow

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Auto_Expire__c Auto Expire Checkbox false
When checked, the Badge will automatically unassign itself from the Contact record when the Assignment record becomes in active. "Is Active" is unchecked. Defaults unchecked.
OrderApi__Badge_Type__c Badge Type LookupOrderApi__Badge_Type__c false
** Required ** Link to the related Badge Type
OrderApi__Item__c Item LookupOrderApi__Item__c false
Link to the related Item
OrderApi__Line_Contact__c Line Contact Checkbox false
** System Calculated/Override ** Checked when the Type field set to "Line Contact".
OrderApi__Line_Account__c Line Account Checkbox false
** System Calculated/Override ** Checked when the Type field set to "Line Account".
OrderApi__Assigned_Contacts__c Assigned Contacts Checkbox false
** System Calculated/Override ** Checked when the Type field set to "Assigned Contacts".
OrderApi__Type__c Type Picklist false
** Required ** Select "Line Contact" to assign the Badge to the purchasing Customer as defined in the "Contact" lookup field on the Sales Order Line. Select "Assigned Contacts" to give the Badge to all "Active" assigned Contacts.

OrderApi__Badge__c

Badge
Badges are assigned to Contacts either automatically (Badge Workflow) or manually. Badges can enable Contacts for special Price Rules - as well as permission to read, update, or delete certain content types.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Account__c Account LookupOrderApi__Account false
Link to the assigned Account.
OrderApi__Assignment__c Assignment LookupOrderApi__Assignment__c false
** System Calculated ** Badges can be auto-assigned to Contacts based on "Assignment" the link to the "Assignment" record is used to auto-unassign the badge when the Contact has been "Unassigned".
OrderApi__Awarded_Date__c Awarded Date Date false
** System Calculated Required Override ** The date the Badge Type was assigned to the Contact. Defaults to today's date if no other value provided on record creation.
OrderApi__Badge_Description__c Badge Description Text false
** System Calculated ** Value of the "Short Description" field for the linked Badge Type.
OrderApi__Badge_Type_Icon__c Badge Text false
** System Calculated ** Icon with link anchored by the Badge Type Name to the Badge Type assigned to the Contact.
OrderApi__Badge_Type__c Badge Type LookupOrderApi__Badge_Type__c false
OrderApi__Badge_Workflow__c Badge Workflow LookupOrderApi__Badge_Workflow__c false
** System Calculated ** Link to related Badge Workflow that auto-assigned the Badge Type to the Contact.
OrderApi__Contact__c Contact LookupOrderApi__Contact false
Link to the assigned Contact.
OrderApi__Expired_Date__c Expired Date Date false
** System Calculated ** The date the Badge Type was un-assigned from the Contact.
OrderApi__Is_Active__c Is Active Checkbox false
When checked, the Badge is considered "Awarded" and "Active" and will be considered when calculating any permission or pricing configurations related to the linked Badge Type. Defaults checked.
OrderApi__Engagement_Score__c Engagement Score Number false
The numerical engagement score assigned for receiving the badge.
OrderApi__Item__c Item LookupOrderApi__Item__c false
** System Calculated ** Link to related Item that was related to the Assignment or the Sales Order Line that invoked the workflow that auto-assigned the Badge Type to the Contact.
OrderApi__Sales_Order_Line__c Sales Order Line LookupOrderApi__Sales_Order_Line__c false
** System Calculated ** Link to related Sales Order Line that invoked the workflow that auto-assigned the Badge Type to the Contact.

OrderApi__Batch__c

Batch
Batch receipts to improve and faciliate bank reconcilation.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__Actual_Amount__c Actual Amount Currency false
**System Calculated** The sum (amount) of entries entered for the batch.
OrderApi__Actual_Count__c Actual Count Number false
**System Calculated** The current number of entries entered for the batch.
OrderApi__Batch_Number__c Batch Number AutoNumber false
**Auto Calculated** Auto incrementing number. (External Id)
OrderApi__Business_Group__c Business Group LookupOrderApi__Business_Group__c false
**System Calculated/Override/Required** Link to the related Business Group from the Batch inherited from the current user's assigned Business Group if not defined on record creation.
OrderApi__Closed_Date__c Closed Date Date false
The date the Batch was closed and assessed as Ready to Post.
OrderApi__Date__c Default Date Date false
The date to use as the default Date for related Receipts.
OrderApi__Deposit_Account__c Deposit Account LookupOrderApi__GL_Account__c false
**System Calculated/Override/Required** The GL account related to the deposit account (bank) for the batch.
OrderApi__Entity__c Default Entity Picklist false
Select a default Entity for related Receipts to the Batch.
OrderApi__Expected_Amount__c Expected Amount Currency false
**Required** The expected sum (amount) of entries for the batch.
OrderApi__Expected_Count__c Expected Count Number false
**Required** The expected number of entries for the batch.
OrderApi__Is_Closed__c Is Closed Checkbox false
When checked the batch is considered closed and the system will restrict users (without special permissions assigned to their profile) from editing the batch or entries associated with the batch.
OrderApi__Is_Posted__c Is Posted Checkbox false
When checked, related receipts are posted to Transactions.
OrderApi__Item__c Default Item LookupOrderApi__Item__c false
Link to related Item to use as "Default" for related Batch Receipts. (Available in Batch UI only)
OrderApi__Opened_Date__c Opened Date Date false
The date the Batch was opened.
OrderApi__Payment_Gateway__c Payment Gateway LookupOrderApi__Payment_Gateway__c false
Link to the Payment Gateway assigned to the Batch (for online transactions and offline entry of transactions)
OrderApi__Payment_Type__c Payment Type Picklist false
Select the Payment Type for the Batch.
OrderApi__Posted_Date__c Posted Date Date false
The date the Batch was posted.
OrderApi__Source_Code__c Source Code LookupOrderApi__Source_Code__c false
Source Code to set by default on cash entries created from the Batch.

OrderApi__Business_Group__c

Business Group
Separate groups or business entities to facilitate clear reporting on business lines and/or entities.

Custom Fields

API Name Label Type Length Required
Description
OrderApi__AR_Account__c A/R Account LookupOrderApi__GL_Account__c false
**Required** Business groups require a relationship to a default A/R account.
OrderApi__Business_Entity_Type__c Business Entity Type Picklist false
**Optional/When Applicable** Specify the Legal Entity Type for the Business Group.
OrderApi__Calculate_Sales_Tax__c Calculate Sales Tax Checkbox false
When checked, enables the tax related validations and calculations.
OrderApi__Customer_Support_URL__c Customer Support URL Text 255 false
Fully qualified URL is required. A fully qualified URL contains the http:// (or https://www). If the URL is just your domain, the trailing / should also be provided.
OrderApi__Credit_Memo_Account__c Credit Memo Account LookupOrderApi__GL_Account__c false
Link to the GL Account used to create new credit memo receipts linked to this business group.
OrderApi__Default_Payment_Gateway__c Default Payment Gateway LookupOrderApi__Payment_Gateway__c false
Defines the Default Payment Gateway to the related Business Group.
OrderApi__Deposit_Account__c Deposit Account LookupOrderApi__GL_Account__c false
**System Calculated/Override** The default deposit account to use for posting cash entry transactions.
OrderApi__Description__c Description Text 255 false
Briefly describe the ledger as you would like to see it on a report. (72 Chars. or less)
OrderApi__Display_Name__c Display Name Text 255 false
** System Calculated Override ** The name that should be displayed when the Business Group is referenced on Invoices and other external pages and documents. Defaults to the "Name" defined for the Business Group.
OrderApi__Transfers_Payable_Account__c Transfers Payable Account LookupOrderApi__GL_Account__c false
The GL Account to use for intracompany transfer payable transactions.
OrderApi__Transfers_Receivable_Account__c Transfers Receivable Account LookupOrderApi__GL_Account__c false
The GL Account to use for intracompany transfer receivable transactions.
OrderApi__Email__c Email Email false