Actions Developer Guide
jDeploy Data Kit Components Action
Deploy data kit components sequentially in a subscriber org. The
deployDataKitComponents invocable action is
used in the Deploy Data Kit Component flow to invoke the deployment
of each data kit component. This action is available for flows in API version 61.0 and
later.
Inputs
| Input | Type | Description |
|---|---|---|
| dataKitComponentDeployInput | Apex-defined sfdatakit__DeployComponentInput | Required. An Apex sfdatakit__DeployComponentInput payload that contains details about the components to deploy and their metadata. |
| dataKitName | text | Required. The data kit name that contains the components to get the status for. |
| dataSpaceName | text | The name of the data space to deploy the data kit to. If a data space isn't defined, the system deploys the components in the default data space. |
Outputs
None.
Example
The following examples show sample input payloads for the different data kit components.
sfdatakit__DeployComponentInput.bundleConfig (Apex-defined):
1{
2 "inputs": [
3 {
4 "dataKitComponentsInput": [
5 {
6 "componentType": "DataStreamBundle",
7 "bundleConfig": {
8 "connectorType": "CRM",
9 "bundleName": "hello", #full Qualified Bundle Name with namespace in datakit
10 "forceNoRefresh": true,
11 "bundleCRMConfig": {
12 "orgId": "org123" #Data Org Id
13 }
14 }
15 }
16 ],
17 "dataKitNameInput": "datakit1",
18 "dataKitDataSpaceInput" : "default"
19 }
20 ]
21}sfdatakit__DeployComponentBundleConfig.bundleConnectorFrameworkConfig (Apex-defined):
1{
2 "inputs": [
3 {
4 "dataKitComponentsInput": [
5 {
6 "componentType": "DataStreamBundle",
7 "bundleConfig": {
8 "connectorType": "MORECONNECTORS",
9 "bundleName": "hello", #full Qualified Bundle Name with namespace in datakit
10 "forceNoRefresh": true,
11 "bundleConnectorFrameworkConfig": {
12 "connectionName": "name"
13 }
14 }
15 }
16 ],
17 "dataKitNameInput": "datakit1",
18 "dataKitDataSpaceInput" : "default"
19 }
20 ]
21}sfdatakit__DeployComponentBundleConfig.bundleIngestApiConfig (Apex-defined):
1{
2 "inputs": [
3 {
4 "dataKitComponentsInput": [
5 {
6 "componentType": "DataStreamBundle",
7 "bundleConfig": {
8 "connectorType": "INGESTAPI",
9 "bundleName": "hello", #full Qualified Bundle Name with namespace in datakit
10 "forceNoRefresh": true,
11 "bundleIngestApiConfig": {
12 "connectorName": "name" #ingestion API connector name
13 }
14 }
15 }
16 ],
17 "dataKitNameInput": "datakit1",
18 "dataKitDataSpaceInput" : "default"
19 }
20 ]
21}
22sfdatakit__DeployComponentBundleConfig.bundleStreamingAppConfig (Apex-defined):
1{
2 "inputs": [
3 {
4 "dataKitComponentsInput": [
5 {
6 "componentType": "DataStreamBundle",
7 "bundleConfig": {
8 "connectorType": "STREAMINGAPP",
9 "bundleName": "hello", #full Qualified Bundle Name with namespace in datakit
10 "forceNoRefresh": true,
11 "bundleStreamingAppConfig": {
12 "connectorName": "name", #Streaming app connector name
13 "streamingAppDataConnectorType": "MobileApp" #MobileApp,WebApp
14 }
15 }
16 }
17 ],
18 "dataKitNameInput": "datakit1",
19 "dataKitDataSpaceInput" : "default"
20 }
21 ]
22}sfdatakit__DeployComponentInput.calculatedInsightsConfig (Apex-defined):
1{
2 "inputs": [
3 {
4 "dataKitComponentsInput": [
5 {
6 "componentType": "CalculatedInsight",
7 "calculatedInsightsConfig": {
8 "apiName": "crm",#full Qualified CI Name with namespace in datakit
9 "apiNameOverride": "hello", #api name of CI to be created on org
10 "label": "lab", #label of CI to be created on org
11 "publishInterval":"NotScheduled" #NotScheduled,One,Six,Twelve,TwentyFour
12 }
13 }
14 ],
15 "dataKitNameInput": "datakit1",
16 "dataKitDataSpaceInput" : "default"
17 }
18 ]
19}sfdatakit__DeployComponentInput.dloConfig (Apex-defined):
1{
2 "inputs": [
3 {
4 "dataKitComponentsInput": [
5 {
6 "componentType": "DataLakeObject",
7 "dloConfig": {
8 "dataSourceObjectDevName": "crm",#full Qualified DLO Name with namespace in datakit
9 "apiName": "hello",#api name of DLO to be created on org
10 "label": "lab"#label of DLO to be created on org
11 }
12 }
13 ],
14 "dataKitNameInput": "datakit1",
15 "dataKitDataSpaceInput" : "default"
16 }
17 ]
18}
19sfdatakit__DeployComponentInput.dataTransformConfig (Apex-defined):
1{
2 "inputs": [
3 {
4 "dataKitComponentsInput": [
5 {
6 "componentType": "DataTransform",
7 "dataTransformConfig": {
8 "dataTransformType": "BATCH", #STREAMING,BATCH
9 "dataTransformDevName": "BatchTransformAccount",#full Qualified Transform Name with namespace in datakit
10 "apiName":"BatchTransformAccount",#api name of Transform to be created on org
11 "label" : "BatchTransformAccount"#label of Transform to be created on org
12 }
13 }
14 ],
15 "dataKitNameInput": "datakit1",
16 "dataKitDataSpaceInput" : "default"
17 }
18 ]
19}