Skip to content

Commit a57abb7

Browse files
authored
Merge pull request #183 from salesforcecli/jshackell-sfdc-patch-1
W-19176724: edit messages for "agent activate|deactivate"
2 parents 400a1e6 + e075da5 commit a57abb7

File tree

4 files changed

+17
-13
lines changed

4 files changed

+17
-13
lines changed

messages/agent.activate.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# summary
22

3-
Activate an agent in the org.
3+
Activate an agent in an org.
44

55
# description
66

7-
An agent can be active or inactive within an org. Active agents are available in the org and can be previewed using the CLI or VS Code while inactive agents cannot.
7+
Activating an agent makes it immediately available to your users. An agent must be active before you can preview it with the "agent preview" CLI command or VS Code.
8+
9+
You must know the agent's API name to activate it; you can either be prompted for it or you can specify it with the --api-name flag. Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup.
810

911
# examples
1012

11-
- Activate an agent in the default target org by being prompted:
13+
- Activate an agent in your default target org by being prompted:
1214

1315
<%= config.bin %> <%= command.id %>
1416

15-
- Activate an agent by specifying the agent API name and target org:
17+
- Activate an agent with API name Resort_Manager in the org with alias "my-org":
1618

1719
<%= config.bin %> <%= command.id %> --api-name Resort_Manager --target-org my-org
1820

messages/agent.activation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# error.noAgentsInOrg
22

3-
No Agents found in org %s.
3+
No agents found in org %s.
44

55
# error.missingAgentInOrg
66

77
Agent %s not found in org %s.
88

99
# error.agentIsDeleted
1010

11-
Agent %s is deleted and cannot be activated.
11+
Agent %s has been deleted and can't be activated.
1212

1313
# error.agentIsDefault
1414

15-
Agent %s is an org default agent and cannot be activated.
15+
Agent %s is the default Agentforce agent in your org and you can't change its activation status.

messages/agent.deactivate.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# summary
22

3-
Deactivate an agent in the org.
3+
Deactivate an agent in an org.
44

55
# description
66

7-
An agent can be active or inactive within an org. Active agents are available in the org and can be previewed using the CLI or VS Code while inactive agents cannot.
7+
Deactivating an agent makes it unavailable to your users. To make changes to an agent, such as adding or removing topics or actions, you must deactivate it. You can't preview an agent with the "agent preview" CLI command or VS Code if it's deactivated.
8+
9+
You must know the agent's API name to deactivate it; you can either be prompted for it or you can specify it with the --api-name flag. Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup.
810

911
# examples
1012

11-
- Deactivate an agent in the default target org by being prompted:
13+
- Deactivate an agent in your default target org by being prompted:
1214

1315
<%= config.bin %> <%= command.id %>
1416

15-
- Deactivate an agent by specifying the agent API name and target org:
17+
- Deactivate the agent Resort_Manager in the org with alias "my_org":
1618

1719
<%= config.bin %> <%= command.id %> --api-name Resort_Manager --target-org my-org
1820

messages/agent.preview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This command is useful to test if the agent responds to your utterances as you e
1010

1111
When the session concludes, the command asks if you want to save the API responses and chat transcripts. By default, the files are saved to the "./temp/agent-preview" directory. Specify a new default directory by setting the environment variable "SF_AGENT_PREVIEW_OUTPUT_DIR" to the directory. Or you can pass the directory to the --output-dir flag.
1212

13-
Find the agent's API name in its main details page in your org's Agent page in Setup.
13+
Find the agent's API name in its Agent Details page of your org's Agentforce Studio UI in Setup. If your agent is currently deactivated, use the "agent activate" CLI command to activate it.
1414

1515
IMPORTANT: Before you use this command, you must complete a number of configuration steps in your org and your DX project. The examples in this help assume you've completed the steps. See "Preview an Agent" in the "Agentforce Developer Guide" for complete documentation: https://developer.salesforce.com/docs/einstein/genai/guide/agent-dx-preview.html.
1616

@@ -32,7 +32,7 @@ Enable Apex debug logging during the agent preview conversation.
3232

3333
# examples
3434

35-
- Interact with an agent with API name "Resort_Manager" in the org with alias "my-org" and the linked "agent-app" connected app:
35+
- Interact with an agent with API name Resort_Manager in the org with alias "my-org" and the linked "agent-app" connected app:
3636

3737
<%= config.bin %> <%= command.id %> --api-name Resort_Manager --target-org my-org --client-app agent-app
3838

0 commit comments

Comments
 (0)