Skip to content

Commit dc38b22

Browse files
committed
chore: W-23501725 update user guide
1 parent 012f488 commit dc38b22

1 file changed

Lines changed: 39 additions & 7 deletions

File tree

‎doc/data-transfer-user-guide.md‎

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -553,15 +553,13 @@ When a foreign key field references more than one object type (polymorphic), you
553553

554554
**Best Practices**:
555555

556-
- Include all fields necessary for business logic
557-
- Include fields used in relationships (e.g., ParentProductId)
558-
- Use dot-notation for parent field references (e.g., BasedOn.Code)
559-
- Avoid including unnecessary fields to reduce data transfer size
556+
- Do NOT specify fields unless there is a special reason.
557+
- This tool will include all not-null fields that the authenticated user running the tool can access.
560558

561559
**Example**:
562560

563561
```
564-
"fields": "Name, Code, ParentProductId, BasedOn.Code, Description"
562+
"fields": ""
565563
```
566564

567565
**9. Empty Filter Criteria**
@@ -1087,12 +1085,46 @@ sf data setup transfer \
10871085
## Frequently Asked Questions
10881086

10891087
**Q:** The global key has an empty value. What should I do?
1090-
**A:** If a global key (for example, the `Code` field of `ProductComponentGroup`) is empty, update the value in the source org and rerun the CLI command. If the issue persists, investigate whether the problem exists in the source org or the target org. Open the `tmp/setup-transfer-payload.json` file in the directory from which you ran the CLI command. This file contains the exported data merged with the data set definition to identify the missing or incorrect values.
1088+
**A:** If a global key (for example, the `Code` field of `ProductComponentGroup`) is empty, update the value in the source org and rerun the CLI command.
1089+
10911090
**Q:** How to identify the issue is in source org or target org?
1092-
**A:** In the folder from which the CLI command is run, look for the tmp`/setup-transfer-payload.json` file. This file has the exported data combined with the data set definition.
1091+
**A:** In the folder from which the CLI command is run, look for the tmp`/setup-transfer-payload.json` file. This file has the exported data.
1092+
10931093
**Q:** Does the tool delete a record in the target org?
10941094
**A:** No
10951095

1096+
**Q:** Objects in a managed package.
1097+
**A:** The namespace prefix must be added to custom objects/fields in the dataset definition. Ex: "devopsimpkg15__" is the namespace prefix.
1098+
```
1099+
{
1100+
"dataSetName": "custom-object-managed-package",
1101+
"version": "1.0.0",
1102+
"exportSequence": {
1103+
"list": [
1104+
"devopsimpkg15__AdminTabLayout__c"
1105+
]
1106+
},
1107+
"importSequence": {
1108+
"list": [
1109+
"devopsimpkg15__AdminTabLayout__c"
1110+
]
1111+
},
1112+
"objects": {
1113+
"list": [
1114+
{
1115+
"objectName": "devopsimpkg15__AdminTabLayout__c",
1116+
"globalKeyField": "Name",
1117+
"fields": "Name",
1118+
"filterCriteria": "",
1119+
"foreignKeys": {
1120+
"list": []
1121+
}
1122+
}
1123+
]
1124+
}
1125+
}
1126+
```
1127+
10961128
## **Additional Resources**
10971129

10981130
- **GitHub Repository**: [plugin-data-setup-transfer](https://github.com/salesforcecli/plugin-data-setup-transfer/tree/main)

0 commit comments

Comments
 (0)