Skip to content

Commit 12a7c03

Browse files
fix: edit message for new data seeding commands
1 parent 1a9f45c commit 12a7c03

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

messages/data-seeding.generate.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,47 @@
11
# summary
22

3-
Generate org data using AI
3+
Generate synthetic org data that mimics existing data in a source org, and then load it into a separate target org.
44

55
# description
66

7-
Generates data using AI that is similar to selected data from a source org, based on a configuration file, and loads it into a target org
7+
This command uses AI to generate synthentic (or "fake") data that has a similar format to selected data in a source org. The command uses a JSON configuration file to define the characteristics of the synthetic data. For example, the configuration file might specify the number of records to generate for one or more Salesforce objects, along with the subset of fields to include. Once generated, the data is automatically loaded into the specified target org. You must be authenticated to both the source and target orgs before running this command.
8+
9+
By default, this command runs synchronously and outputs the job ID, along with a running status of each execution phase, such as querying the source org or generating the data. If you prefer, you can run the command asynchronously by specifying the --async flag so that the control of the terminal is immediately returned to you. Then use the job ID to run the "data-seeding generate report" command to view the status.
810

911
# examples
1012

11-
- Generate data using org aliases
12-
13-
$ <%= config.bin %> <%= command.id %> -s mySourceOrg -o myTargetOrg -f "./config/seed-config.json"
13+
- Generate synthentic data similar to existing data in the org with alias "mySourceOrg" then load it into the org with alias "myTargetOrg"; use the specified config file to determine the format of the generated data:
14+
15+
<%= config.bin %> <%= command.id %> --source-org mySourceOrg --target-org myTargetOrg --config-file ./config/seed-config.json
16+
17+
- Generate synthentic data using org usernames and run the command asynchronously:
18+
19+
<%= config.bin %> <%= command.id %> --source-org source@org.com" --target-org target@org.com" --config-file ./config/seed-config.json --async
1420

15-
- Generate data using usernames for each org
21+
- Generate synthentic data using org aliases; if after 5 minutes the command hasn't finished, it completes asynchronously:
1622

17-
$ <%= config.bin %> <%= command.id %> --source-org="source@org.com" --target-org="target@org.com" --config-file "./config/seed-config.json"
23+
<%= config.bin %> <%= command.id %> --source-org source@org.com" --target-org target@org.com" --config-file ./config/seed-config.json --wait 5
1824

1925
# flags.target-org.summary
2026

21-
Username or alias of the Target org where generated data will be loaded to.
27+
Username or alias of the target org into which the generated data will be loaded.
2228

2329
# flags.source-org.summary
2430

25-
Username or alias of the Source org containing data to be used as input for AI to generate similar data.
31+
Username or alias of the source org that contains the data that AI will mimic.
2632

2733
# flags.config-file.summary
2834

29-
Path to data seeding JSON configuration file.
35+
Path to the data seeding JSON configuration file.
3036

3137
# flags.wait.summary
3238

33-
Number of minutes to wait for command to complete.
39+
Number of minutes to wait for the command to complete; when reached, the command completes asynchronously if necessary.
3440

3541
# flags.async.summary
3642

37-
Run the command asynchronously.
43+
Run the command asynchronously and immediately return control of the terminal.
3844

3945
# report.suggestion
4046

41-
- Check the status with: sf data-seeding generate report -i %s
47+
- Run this command to check the status of the data generation: "sf data-seeding generate report --job-id %s"

0 commit comments

Comments
 (0)