Campaign — entity reference

A service campaign: rules select its members (accounts, or assets with their owning account), campaign items say what is offered or required, and processing buttons create the follow-up work. Process Members rebuilds the member list from the rules; Leads, Opportunities and Asset Maintainance create one lead, one opportunity with a line per campaign item, or one asset maintenance entry per campaign item for each member, adding a new set on every run; Contract Schedule and Maintenance Schedule create reminder leads for assets whose contract due date or next service date is exactly today plus a reminder offset. Every processing button requires the campaign to be active and inside its start and end dates. Transfer Members moves members to another campaign and works on any campaign.

Fields

Field	Label	Type	Required	What it does
`AccountId`	Account	Lookup
`AdjustedAmount`	Adjusted Amount	Currency
`AdjustmentId`	Adjustment	Lookup → Adjustment
`Amount`	Amount	Decimal
`ApexJobId`	Apex Job	Text
`BranchId`	Branch	Lookup → Branch		The location the campaign belongs to, limited to the partner account's branches. Copied onto every member Process Members builds, and from the members onto generated records.
`CreatedById`	Created By	Lookup → UserAccount	Yes
`CreatedDateTime`	Created Date	DateAndTime	Yes
`Currency`	Currency	PickList		Values: USD.
`DocumentDate`	Document Date	Date	Yes
`DynamicMemberObject`	Dynamic Member Object	PickList		What a member is: Account, or Asset (the member then also carries the asset's owning account). Blank means Account. The campaign rules are tested against fields of this object. Values: Asset, Account.
`DynamicMemberType`	Dynamic Member Type	PickList		Where members come from. Field Filter builds them from the campaign rules. Report Data has no member engine: Process Members skips such a campaign and leaves its member list untouched. Values: Field Filter, Report Data.
`EndDate`	End Date	Date		Last day the campaign can be processed. After this date every processing button, Execute Campaign and the pull of campaign work onto documents are refused. Blank means no end limit.
`ExternalId`	External	Text
`FromEngineSeries`	From Engine Series	Number		Start of the engine-series range the campaign is meant for. Reference only; member selection uses the campaign rules.
`GeneralLedgerId`	General Ledger	Lookup
`GLAccountId`	GL Account	Lookup
`GLAmount`	GL Amount	Decimal
`Id`	Id	Guid	Yes
`IsActive`	Is Active	Boolean	Yes	Whether the campaign can be processed. Every processing button and Execute Campaign refuse an inactive campaign, and open asset maintenance from an inactive campaign is not pulled onto opportunities or service orders. Transfer Members ignores it.
`IsGLPosted`	Is GL Posted	Boolean	Yes
`IsGLPostingApproved`	Is GL Posting Approved	Boolean	Yes
`ItemMaintenanceScheduleId`	Item Maintenance Schedule	Lookup → ItemMaintenanceSchedule		The item maintenance schedule that Maintenance Schedule reads. Assets whose next service date on the schedule is exactly today plus a reminder offset get a reminder lead. Without it the button does nothing.
`ItemServiceContractId`	Service Contract	Lookup → ItemServiceContract		The item service contract that Contract Schedule watches. Asset service contracts under it that are not utilised and still valid get a reminder lead when their due date is exactly today plus a reminder offset. Copied onto those leads.
`LeadId`	Lead	Lookup → Lead
`ManualAssetAction`	ManualAssetAction	Boolean		Whether the campaign's open asset maintenance is offered on new opportunities. Cleared (the default): open entries are added as lines to a new opportunity for the asset, and from there a new service order for the asset that has no lines, or Populate Asset Maintenance on an existing order, picks them up. Ticked: new opportunities skip the entries, and because service orders take campaign work only from the asset's opportunity lines, the entries do not reach any document by themselves.
`ModifiedById`	Modified By	Lookup → UserAccount	Yes
`Name`	Document Number	Text	Yes	The campaign's name. Required. The shipped document name setting has no destination field, so campaigns are not numbered automatically unless an administrator configures it.
`Notes`	Notes	MultiLineText
`OpenAmount`	Open Amount	Decimal
`OwnerId`	Owner	Lookup → UserAccount	Yes
`ParentCampaignId`	Campaign	Lookup → Campaign		A parent campaign this one belongs under. Reference only; no processing reads it.
`PartnerAccountId`	Partner Account	Lookup → Account		The dealer the campaign belongs to. Copied onto every member Process Members builds, and from the members onto the leads, opportunities and asset maintenance the campaign creates.
`PerformGLPosting`	Perform GL Posting	Boolean	Yes
`RecordTypeId`	Record Type	Guid, hidden
`ReminderDaysOffset1`	Reminder Days Offset 1	Number		Days before a due date at which the first reminder lead is created: a contract due date or next service date exactly today plus this number creates a lead with reminder offset number 1. The largest of the three offsets sets how far ahead the reminder buttons look.
`ReminderDaysOffset2`	Reminder Days Offset 2	Number		Days before a due date at which the second reminder lead is created; a match creates a lead with reminder offset number 2.
`ReminderDaysOffset3`	Reminder Days Offset 3	Number		Days before a due date at which the third reminder lead is created; a match creates a lead with reminder offset number 3.
`ReportId`	Report	Text
`RuleSuccessCriteria`	Rule Success Criteria	PickList		How the campaign rules combine when Process Members runs: All Rules Are Met, Any Rule Is Met, Custom Logic Is Met (uses Rule Success Custom Logic) or Always (No Criteria). Blank, Always, or a campaign with no rules makes every account or asset a member. Values: All Rules Are Met, Any Rules Are Met, Always (No Criteria), Custom Logic Is Met.
`RuleSuccessCustomLogic`	Rule Success Custom Logic	Text		Expression used when Rule Success Criteria is Custom Logic Is Met, for example 1 AND (2 OR 3). Numbers are the rules' positions in sequence-number order, starting at 1; AND, OR and brackets are supported.
`ServiceContractId`	Service Contract	Lookup
`ServiceLeadId`	ServiceLead	Guid
`StartDate`	Start Date	Date		First day the campaign can be processed. Before this date every processing button, Execute Campaign and the pull of campaign work onto documents are refused. Blank means no start limit.
`Status`	Status	PickList		Where the campaign stands: Draft, Start, In Progress or On Hold, shown as the progress strip on the record. It changes only when a user edits it and no processing button reads it. Values: Draft, Start, In Progress, On Hold.
`ToEngineSeries`	To Engine Series	Number		End of the engine-series range the campaign is meant for. Reference only; member selection uses the campaign rules.
`Type`	Type	PickList		Classifies the campaign. Shipped values are Recall - Asset Actions and Marketing;Service; the list can be extended. It does not change how any processing button behaves. Values: Recall - Asset Actions, Marketing;Service.
`UIProps`	UI Props	Text
`UpdatedDateTime`	Modified Date	DateAndTime	Yes

Actions

Action	Label	Type	What it does
`BulkDelete`	Delete	Delete	Delete the selected records.
`Clone`	Clone	ServerAction (`Clone`)	Create a copy of this record
`Delete`	Delete	Delete	Delete
`DeleteInList`	Delete	Delete	Delete in a list page
`Edit`	Edit	EditInline	Edit
`Edit2`	Edit	EditInline	Edit
`EditInLine`	Edit	Edit	Edit in page.
`EditRow`	Edit	Edit	Edit
`New`	New	New	New
`ProcessAssets`	Process Assets	ServerAction (`ProcessAssets`)	Creates one asset maintenance entry per campaign item for every member that is not marked utilised and has no service order, carrying the member's asset and the item's quantity, contract and mandatory flag. Requires the campaign active and inside its dates. Entries from earlier runs of this button are kept, but entries created by Execute Campaign are removed.
`ProcessContractSchedule`	Process Contract Schedule	ServerAction (`ProcessContractSchedule`)	Generates contract-renewal reminder Leads: scans un-utilized AssetServiceContract rows for the campaign's itemServiceContractId whose dueDate lands exactly on today plus one of the campaign's reminderDaysOffset1/2/3, and creates one lead per hit stamped with the matching ReminderOffsetNumber. Requires the campaign active and inside its date window. Intended to run daily (each day matches the contracts whose due date crosses an offset boundary).
`ProcessLeads`	Process Leads	ServerAction (`ProcessLeads`)	Creates one Draft Lead per CampaignMember, carrying the member's account/asset/partner/branch links and a back-reference to the campaign and member. Requires the campaign active and inside its start/end window. Each run tags its leads with a batch id and hard-deletes the campaign's leads from earlier runs - so rerunning replaces previously generated (unconverted) leads rather than adding to them.
`ProcessMaintenanceSchedule`	Process Maintenance Schedule	ServerAction (`ProcessMaintenanceSchedule`)	Requires the campaign active and inside its date window.
`ProcessMembers`	Process Members	ServerAction (`ProcessMembers`)	Rebuilds the campaign's member list: resolves the Accounts or Assets (per dynamicMemberObject) matching the CampaignRule rows under ruleSuccessCriteria, inserts one CampaignMember per match tagged with a fresh batch id, then soft-deletes members from earlier runs - build and sweep commit in one unit of work so the campaign is never left member-less in between. Run this before any of the generation actions - they all fan out from the current member rows.
`ProcessOpportunities`	Process Opportunities	ServerAction (`ProcessOpportunities`)	Creates one opportunity per member, with one line per campaign item copying the item, item service contract, quantity and mandatory flag. Requires the campaign active and inside its dates. Each run adds a new set; opportunities from earlier runs are kept. A campaign with no campaign items still gets one opportunity per member, with no lines.

Lookup filters

Filter	Lookup field	Notes
Branch For Partner Account	`BranchId`
Customer Account Filter	`AccountId`
Partner Account Filter	`PartnerAccountId`

Campaign — looks up via ParentCampaignId
Budget — looks up via BudgetId
Lead — looks up via LeadId
ItemServiceContract — looks up via ItemServiceContractId
Branch — looks up via BranchId
ItemMaintenanceSchedule — looks up via ItemMaintenanceScheduleId
UserAccount — looks up via CreatedById
UserAccount — looks up via OwnerId
Account — looks up via PartnerAccountId
UserAccount — looks up via ModifiedById
Adjustment — looks up via AdjustmentId
Lead — referenced by via CampaignId
CampaignMember — referenced by via CampaignId
Campaign — referenced by via ParentCampaignId
Opportunity — referenced by via CampaignId
CampaignRule — referenced by via CampaignId
CampaignItem — referenced by via CampaignId
AssetMaintenance — referenced by via CampaignId
OpportunityLine — referenced by via CampaignId
ServiceOrderLine — referenced by via CampaignId

Campaign — entity reference

Fields

Actions

Lookup filters

Related entities

Related topics