mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-10 17:41:49 +08:00
3.3 KiB
3.3 KiB
Configuration Catalog
The fixed catalog of supported ConfigurationName values for the post-copy
automation config. Never invent a new value — if an SOP step does not
fit a row below, raise it to the user.
The catalog currently covers two types only:
OutboundMessagesRemoteSiteSettings
Anything else (Custom Labels, Connected Apps, Named Credentials, SSO, etc.) is out of scope for this skill at present — surface them to the user and recommend a follow-up to extend the catalog.
How to use this catalog
For each post-copy action extracted from the SOP:
- Find the row whose SOP signal phrases match the action.
- Use the
ConfigurationNamefrom that row. - Use one of the listed Field keys in your entry's
Fieldsobject. - Put the concrete value from the SOP (literal URL, name, etc.) as the value. If the SOP does not state a concrete value, skip the entry entirely and list it in the response.
Catalog
OutboundMessages
- SOP signal phrases: "outbound message", "OBM", "endpoint URL", "Workflow Actions > Outbound Messages".
- Field keys (both required for non-delete entries):
EndpointUrl— value is the literal post-refresh URL the SOP gives for that outbound message.Object— the SObject the outbound message targets (e.g.,Account,Contact,Asset,Lead). This is mandatory because the sameLabelmay apply to multiple OBMs that differ only by entity, and the post-copy tool needs the Object to disambiguate. Infer from the OBM name (e.g.,IR_Account_OBM_PROD→Account,IR_Contact_OBM_PROD→Contact) or from explicit text in the SOP. If the entity is genuinely ambiguous and the SOP gives no signal, skip the entry and surface it.
- Skip when: the SOP only names the outbound message but does not give a new endpoint URL, OR the target Object cannot be determined.
- Special action: deletion. When the SOP says "delete all endpoints",
use
Fields: { "Action": "Delete", "Object": "<entity>" }. ("Delete"is a literal instruction the tool understands, not a placeholder.)
RemoteSiteSettings
- SOP signal phrases: "remote site setting", "remote site", "trusted URL", "Setup > Security > Remote Site Settings".
- Field keys:
RemoteSiteUrl— value is the literal post-refresh URL. The key must be spelled exactlyRemoteSiteUrl. Do not useUrl,RemoteSiteURL,SiteUrl, orEndpointUrl(that last one is the OBM key, not the remote-site key). The post-copy tool matches the field by exact API name, so any other spelling silently no-ops at runtime.
- Do NOT add:
RemoteSiteName— the name lives in the top-levelLabelfield.IsActive— the active flag lives at the top level of the entry. Putting either insideFieldsduplicates information the tool already has and creates ambiguity.
- Skip when: the SOP names the remote site but does not give a new URL.
Adding a new ConfigurationName
If a customer SOP introduces a configuration type not in the list above, stop and ask the user. Adding a new value requires:
- Update the
enuminassets/json_schema.json. - Add a new section to this file.
- Update
examples/sample_sop_to_config.jsonif relevant. - Update the description in
SKILL.mdto include the new type.