LightningBolt

Represents the definition of a Lightning Bolt Solution, which can include custom apps, flow categories, and Experience Builder templates.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

LightningBolt components have the suffix .lightningBolt and are stored in the lightningBolts folder.

Version 

Introduced in API version 43.0.

Special Access Rules 

To add Experience Builder templates to a Lightning Bolt Solution, enable digital experiences in your org.

Fields 

category 

  • Type: LightningBoltCategory (enumeration of type string)
  • Required: Yes
  • Description: Required. The primary industry that the Lightning Bolt Solution is aimed at.
  • Possible values:
    • Communications
    • Education
    • FinancialServices
    • GeneralBusiness
    • Government
    • HealthcareLifeSciences
    • HighTech
    • Manufacturing
    • Media
    • Nonprofits
    • ProfessionalServices
    • RealEstate
    • Retail
    • TravelTransportationHospitality

lightningBoltFeatures 

  • Type: LightningBoltFeatures[]
  • Required: No
  • Description: The list of feature descriptions of this Lightning Bolt Solution.

lightningBoltImages 

  • Type: LightningBoltImages[]
  • Required: No
  • Description: The list of images of this Lightning Bolt Solution.

lightningBoltItems 

  • Type: LightningBoltItems[]
  • Required: No
  • Description: The list of items (custom apps, flow categories, and Experience Builder templates) that comprise this Lightning Bolt Solution.

masterLabel 

  • Type: string
  • Required: Yes
  • Description: Required. The label of the Lightning Bolt Solution, which appears on the solution detail page.

publisher 

  • Type: string
  • Required: Yes
  • Description: Required. The name of the partner org associated with this Lightning Bolt Solution.

summary 

  • Type: string
  • Required: Yes
  • Description: Required. The summary description of the Lightning Bolt Solution.

LightningBoltFeatures Type 

Represents the list of feature descriptions of a Lightning Bolt Solution.

Fields 

description 

  • Type: string
  • Required: No
  • Description: A description of the feature of the Lightning Bolt Solution.

order 

  • Type: int
  • Required: Yes
  • Description: Required. An integer specifying the position of this feature relative to others in the list. 1 is the first position, and 4 is the max position.

title 

  • Type: string
  • Required: Yes
  • Description: Required. The title of the feature, which appears on the solution detail page.

LightningBoltImages Type 

Represents the list of images of a Lightning Bolt Solution.

Fields 

image 

  • Type: string
  • Required: Yes
  • Description: Required. The developer name of the [ContentAsset](./metadata-contentasset.md) type, which is used as a preview image for this Lightning Bolt Solution.

order 

  • Type: int
  • Required: Yes
  • Description: Required. An integer specifying the position of this image relative to others in the list. 1 is the first position, and 3 is the max position.

LightningBoltItems Type 

Represents the list of items (custom apps, flow categories, and Experience Builder templates) that comprise a Lightning Bolt Solution.

Fields 

name 

  • Type: string
  • Required: Yes
  • Description: Required. The name of the item, which appears on the solution detail page.

type 

  • Type: string (enumeration of type string)
  • Required: Yes
  • Description: Required. The type of the item included in the Lightning Bolt Solution.
  • Possible values:
    • CommunityTemplateDefinition
    • CustomApplication
    • FlowCategory

Declarative Metadata Sample Definition 

The following is an example of a LightningBolt component.

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningBolt xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3    <category>Sales</category>
4    <lightningBoltFeatures>
5        <description>bb</description>
6        <order>1</order>
7        <title>aa</title>
8    </lightningBoltFeatures>
9    <lightningBoltImages>
10        <image>prm1</image>
11        <order>1</order>
12    </lightningBoltImages>
13    <lightningBoltItems>
14        <name>PolaConsole</name>
15        <type>CustomApplication</type>
16    </lightningBoltItems>
17    <lightningBoltItems>
18        <name>Banking_Service_Console</name>
19        <type>CustomApplication</type>
20    </lightningBoltItems>
21    <lightningBoltItems>
22        <name>Banking_Service_Portal</name>
23        <type>CommunityTemplateDefinition</type>
24    </lightningBoltItems>
25    <lightningBoltItems>
26        <name>Banking_Sales_Portal</name>
27        <type>CommunityTemplateDefinition</type>
28    </lightningBoltItems>
29    <lightningBoltItems>
30        <name>myorgdev__updatebenefits</name>
31        <type>FlowCategory</type>
32    </lightningBoltItems>
33    <masterLabel>BoltTe</masterLabel>
34    <publisher>aaaa</publisher>
35    <summary>This is a summary.</summary>
36
37</LightningBolt>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>BoltTe</members>
5        <name>LightningBolt</name>
6    </types>
7    <version>43.0</version>
8</Package>

Wildcard Support in the Manifest File 

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.