Documentation
¶
Index ¶
- Constants
- type Report
- type ReportBlock
- type ReportBlockInfo
- type ReportBucket
- type ReportBucketSourceValue
- type ReportBucketValue
- type ReportColumn
- type ReportCrossFilter
- type ReportFilter
- type ReportFilterCriteriaItem
- type ReportGroupingAcross
- type ReportGroupingDown
- type ReportParam
- type ReportTimeFrameFilter
Constants ¶
const NAME = "Report"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Report ¶
type Report struct {
metadata.MetadataInfo
XMLName xml.Name `xml:"Report"`
Xmlns string `xml:"xmlns,attr"`
Xsi string `xml:"xmlns:xsi,attr,omitempty"`
Aggregates []struct {
AcrossGroupingContext *struct {
Text string `xml:",chardata"`
} `xml:"acrossGroupingContext"`
CalculatedFormula *TextLiteral `xml:"calculatedFormula"`
Datatype struct {
Text string `xml:",chardata"`
} `xml:"datatype"`
Description *TextLiteral `xml:"description"`
DeveloperName struct {
Text string `xml:",chardata"`
} `xml:"developerName"`
DownGroupingContext *struct {
Text string `xml:",chardata"`
} `xml:"downGroupingContext"`
IsActive struct {
Text string `xml:",chardata"`
} `xml:"isActive"`
IsCrossBlock struct {
Text string `xml:",chardata"`
} `xml:"isCrossBlock"`
MasterLabel struct {
Text string `xml:",chardata"`
} `xml:"masterLabel"`
Scale struct {
Text string `xml:",chardata"`
} `xml:"scale"`
} `xml:"aggregates"`
Block []ReportBlock `xml:"block"`
BlockInfo *ReportBlockInfo `xml:"blockInfo"`
Buckets []ReportBucket `xml:"buckets"`
Chart *struct {
BackgroundColor1 struct {
Text string `xml:",chardata"`
} `xml:"backgroundColor1"`
BackgroundColor2 struct {
Text string `xml:",chardata"`
} `xml:"backgroundColor2"`
BackgroundFadeDir struct {
Text string `xml:",chardata"`
} `xml:"backgroundFadeDir"`
ChartSummaries []struct {
Aggregate *struct {
Text string `xml:",chardata"`
} `xml:"aggregate"`
AxisBinding struct {
Text string `xml:",chardata"`
} `xml:"axisBinding"`
Column struct {
Text string `xml:",chardata"`
} `xml:"column"`
} `xml:"chartSummaries"`
ChartType struct {
Text string `xml:",chardata"`
} `xml:"chartType"`
EnableHoverLabels struct {
Text string `xml:",chardata"`
} `xml:"enableHoverLabels"`
ExpandOthers struct {
Text string `xml:",chardata"`
} `xml:"expandOthers"`
GroupingColumn struct {
Text string `xml:",chardata"`
} `xml:"groupingColumn"`
LegendPosition *struct {
Text string `xml:",chardata"`
} `xml:"legendPosition"`
Location struct {
Text string `xml:",chardata"`
} `xml:"location"`
SecondaryGroupingColumn *struct {
Text string `xml:",chardata"`
} `xml:"secondaryGroupingColumn"`
ShowAxisLabels struct {
Text string `xml:",chardata"`
} `xml:"showAxisLabels"`
ShowPercentage struct {
Text string `xml:",chardata"`
} `xml:"showPercentage"`
ShowTotal struct {
Text string `xml:",chardata"`
} `xml:"showTotal"`
ShowValues *struct {
Text string `xml:",chardata"`
} `xml:"showValues"`
Size struct {
Text string `xml:",chardata"`
} `xml:"size"`
SummaryAxisRange struct {
Text string `xml:",chardata"`
} `xml:"summaryAxisRange"`
TextColor struct {
Text string `xml:",chardata"`
} `xml:"textColor"`
TextSize struct {
Text string `xml:",chardata"`
} `xml:"textSize"`
Title *struct {
Text string `xml:",chardata"`
} `xml:"title"`
TitleColor struct {
Text string `xml:",chardata"`
} `xml:"titleColor"`
TitleSize struct {
Text string `xml:",chardata"`
} `xml:"titleSize"`
} `xml:"chart"`
ColorRanges []struct {
Aggregate *TextLiteral `xml:"aggregate"`
ColumnName struct {
Text string `xml:",chardata"`
} `xml:"columnName"`
HighBreakpoint *struct {
Text string `xml:",chardata"`
} `xml:"highBreakpoint"`
HighColor struct {
Text string `xml:",chardata"`
} `xml:"highColor"`
LowBreakpoint struct {
Text string `xml:",chardata"`
} `xml:"lowBreakpoint"`
LowColor struct {
Text string `xml:",chardata"`
} `xml:"lowColor"`
MidColor struct {
Text string `xml:",chardata"`
} `xml:"midColor"`
} `xml:"colorRanges"`
Columns []ReportColumn `xml:"columns"`
CrossFilters []ReportCrossFilter `xml:"crossFilters"`
CustomDetailFormulas []struct {
CalculatedFormula struct {
Text string `xml:",chardata"`
} `xml:"calculatedFormula"`
DataType struct {
Text string `xml:",chardata"`
} `xml:"dataType"`
Description *struct {
Text string `xml:",chardata"`
} `xml:"description"`
DeveloperName struct {
Text string `xml:",chardata"`
} `xml:"developerName"`
Label struct {
Text string `xml:",chardata"`
} `xml:"label"`
Scale struct {
Text string `xml:",chardata"`
} `xml:"scale"`
} `xml:"customDetailFormulas"`
Description *TextLiteral `xml:"description"`
Filter *ReportFilter `xml:"filter"`
Format TextLiteral `xml:"format"`
FormattingRules []struct {
Aggregate *TextLiteral `xml:"aggregate"`
ColumnName struct {
Text string `xml:",chardata"`
} `xml:"columnName"`
Values []struct {
BackgroundColor *struct {
Text string `xml:",chardata"`
} `xml:"backgroundColor"`
RangeUpperBound *struct {
Text string `xml:",chardata"`
} `xml:"rangeUpperBound"`
} `xml:"values"`
} `xml:"formattingRules"`
GroupingsAcross []ReportGroupingAcross `xml:"groupingsAcross"`
GroupingsDown []ReportGroupingDown `xml:"groupingsDown"`
Name TextLiteral `xml:"name"`
Params []ReportParam `xml:"params"`
ReportType TextLiteral `xml:"reportType"`
RoleHierarchyFilter []struct {
Text string `xml:",chardata"`
} `xml:"roleHierarchyFilter"`
Scope *struct {
Text string `xml:",chardata"`
} `xml:"scope"`
ShowDetails *struct {
Text string `xml:",chardata"`
} `xml:"showDetails"`
ShowGrandTotal *struct {
Text string `xml:",chardata"`
} `xml:"showGrandTotal"`
ShowSubTotals *struct {
Text string `xml:",chardata"`
} `xml:"showSubTotals"`
SortColumn *struct {
Text string `xml:",chardata"`
} `xml:"sortColumn"`
SortOrder *struct {
Text string `xml:",chardata"`
} `xml:"sortOrder"`
TimeFrameFilter *ReportTimeFrameFilter `xml:"timeFrameFilter"`
}
func (*Report) DeleteField ¶
func (*Report) KeepEmptyElements ¶ added in v0.69.0
func (c *Report) KeepEmptyElements()
KeepEmptyElements marks reports as written with empty elements open, as Salesforce writes <value></value> in filter criteria.
func (*Report) SetMetadata ¶
func (c *Report) SetMetadata(m metadata.MetadataInfo)
func (*Report) Type ¶
func (c *Report) Type() metadata.MetadataType
type ReportBlock ¶ added in v0.69.0
type ReportBlock struct {
BlockInfo ReportBlockInfo `xml:"blockInfo"`
Columns []ReportColumn `xml:"columns"`
Filter *ReportFilter `xml:"filter"`
Format TextLiteral `xml:"format"`
Name TextLiteral `xml:"name"`
Params []ReportParam `xml:"params"`
ReportType TextLiteral `xml:"reportType"`
Scope *TextLiteral `xml:"scope"`
ShowGrandTotal *TextLiteral `xml:"showGrandTotal"`
ShowSubTotals *TextLiteral `xml:"showSubTotals"`
SortColumn *TextLiteral `xml:"sortColumn"`
SortOrder *TextLiteral `xml:"sortOrder"`
TimeFrameFilter *ReportTimeFrameFilter `xml:"timeFrameFilter"`
}
ReportBlock represents one block of a joined report
type ReportBlockInfo ¶ added in v0.69.0
type ReportBlockInfo struct {
AggregateReferences []struct {
Aggregate TextLiteral `xml:"aggregate"`
} `xml:"aggregateReferences"`
BlockId NillableText `xml:"blockId"`
JoinTable TextLiteral `xml:"joinTable"`
}
ReportBlockInfo identifies a block of a joined report, or, at the top level of a joined report, the report itself
type ReportBucket ¶
type ReportBucket struct {
BucketType TextLiteral `xml:"bucketType"`
DeveloperName TextLiteral `xml:"developerName"`
MasterLabel TextLiteral `xml:"masterLabel"`
NullTreatment TextLiteral `xml:"nullTreatment"`
OtherBucketLabel *TextLiteral `xml:"otherBucketLabel"`
SourceColumnName TextLiteral `xml:"sourceColumnName"`
UseOther TextLiteral `xml:"useOther"`
Values []ReportBucketValue `xml:"values"`
}
ReportBucket represents a bucket in a report
type ReportBucketSourceValue ¶ added in v0.69.0
type ReportBucketSourceValue struct {
From *TextLiteral `xml:"from"`
SourceValue *TextLiteral `xml:"sourceValue"`
To *TextLiteral `xml:"to"`
}
ReportBucketSourceValue is one source of a bucket value: a picklist or text value, or a numeric range bounded by from and to
type ReportBucketValue ¶
type ReportBucketValue struct {
SourceValues []ReportBucketSourceValue `xml:"sourceValues"`
Value TextLiteral `xml:"value"`
}
ReportBucketValue represents a bucket value
type ReportColumn ¶
type ReportColumn struct {
AggregateTypes []TextLiteral `xml:"aggregateTypes"`
Field TextLiteral `xml:"field"`
}
ReportColumn represents a column in a report
type ReportCrossFilter ¶ added in v0.69.0
type ReportCrossFilter struct {
CriteriaItems []ReportFilterCriteriaItem `xml:"criteriaItems"`
Operation TextLiteral `xml:"operation"`
PrimaryTableColumn TextLiteral `xml:"primaryTableColumn"`
RelatedTable TextLiteral `xml:"relatedTable"`
RelatedTableJoinColumn TextLiteral `xml:"relatedTableJoinColumn"`
}
ReportCrossFilter represents a cross filter, which filters a report by its related records
type ReportFilter ¶
type ReportFilter struct {
BooleanFilter *TextLiteral `xml:"booleanFilter"`
CriteriaItems []ReportFilterCriteriaItem `xml:"criteriaItems"`
}
ReportFilter represents a filter in a report
type ReportFilterCriteriaItem ¶
type ReportFilterCriteriaItem struct {
Column TextLiteral `xml:"column"`
ColumnToColumn *TextLiteral `xml:"columnToColumn"`
IsUnlocked *TextLiteral `xml:"isUnlocked"`
Operator TextLiteral `xml:"operator"`
Value TextLiteral `xml:"value"`
}
ReportFilterCriteriaItem represents a filter criteria item in a report
type ReportGroupingAcross ¶
type ReportGroupingAcross struct {
DateGranularity *TextLiteral `xml:"dateGranularity"`
Field TextLiteral `xml:"field"`
SortOrder TextLiteral `xml:"sortOrder"`
}
ReportGroupingAcross represents a grouping across in a report
type ReportGroupingDown ¶
type ReportGroupingDown struct {
AggregateType *TextLiteral `xml:"aggregateType"`
DateGranularity *TextLiteral `xml:"dateGranularity"`
Field TextLiteral `xml:"field"`
SortByName *TextLiteral `xml:"sortByName"`
SortOrder TextLiteral `xml:"sortOrder"`
SortType *TextLiteral `xml:"sortType"`
}
ReportGroupingDown represents a grouping down in a report
type ReportParam ¶ added in v0.69.0
type ReportParam struct {
Name TextLiteral `xml:"name"`
Value TextLiteral `xml:"value"`
}
ReportParam represents a report parameter
type ReportTimeFrameFilter ¶ added in v0.69.0
type ReportTimeFrameFilter struct {
DateColumn TextLiteral `xml:"dateColumn"`
EndDate *TextLiteral `xml:"endDate"`
Interval TextLiteral `xml:"interval"`
StartDate *TextLiteral `xml:"startDate"`
}
ReportTimeFrameFilter represents the date range a report covers