Archy Frequently Asked Questions

• Question: On the archy publish, archy update and archy create commands, there is a --recreate option. What is this for?
• Answer: There is help on these commands which describes the recreate option but since this is a pretty common question, the recreate option deletes the flow if it exists prior to performing the publish, update or create command. The point of having this option is that the resulting flow will be starting fresh at version 1.0. To see additional help on the commands above, you can run archy publish --help at the command line.

• Question: I noticed that when using a third party code editor with Archy generated JSON Schemas that when writing flow YAML, no matter what I do there are never any typeahead suggestions for Call Bridge Action objects. Why is that?
• Answer: When Archy generates the JSON Schema objects, it uses the Genesys Cloud Platform SDK and there is no Bridge API available. Since there is no Bridge API support, Archy does not attempt to generate JSON Schema objects for Bridge Actions either. The answer here is to use Data Actions instead. Archy generates JSON Schemas for those.

• Question: When writing flow YAML, specifying a value for the division property on the root flow object is optional. Since a flow has to belong to a division, when I go to publish or create the flow from the YAML, what division will Archy use? The organization's home division?
• Answer: Yes, when the YAML for the root flow object has no division property value specified, Archy will use the organization's home division on for the create or publish call.

• Question: When authoring flow YAML, why are there no typeahead suggestions for users in an organization like there are for queues, groups, wrapup codes, etc.?
• Answer: Archy does not collect and store any user data in JSON schemas due to GDPR restrictions, so there is no user-related data for the typeahead plugin to use.

• Question: When authoring flow YAML, how can I set a variable as secure?
• Answer: To learn more about how to create secure variables, take a look at our page covering variables.

• Question: When authoring flow YAML, how can I configure the output paths for a task?
• Answer: To learn more about how to create output paths, take a look at our pages covering call task actions and end task actions.

• Question: When adding additional properties to my flow YAML, why are they not processed?
• Answer: By design, Archy does not process any additional properties that are found within a flow YAML file that are not expected.

• Question: Why is my flow taking so long to be created/updated/published with debug mode enabled?
• Answer: Debug mode can cause increased processing time when running commands. If you are seeing very long times with it enabled, we recommend disabling it unless it is absolutely needed. Remember, if an error occurs when running Archy, we still write out the debug log file to the debug folder in the archyHome directory.

• Question: Why is Archy unable to find my flow YAML file when I run a command?
• Answer: When this happens, verify that the path is correct. If the flow YAML filename has a space in it, try adding quotes around the file name. For example, "/path/to/my/flow file.yaml" will correctly resolve out the file with the space in the name.

• Question: What features are available in Genesys Cloud Architect that are not available within Archy?
• Answer: The only feature in Genesys Cloud Architect that's not currently available in Archy is Builder support. Examples of Builders are the Audio Sequence Editor and the String Builder.

• Question: Why are some features missing from my generated schemas, such as the ability to create an Inbound Message Flow?
• Answer: Similar to Architect, what you can and can’t do in Archy is organization dependent. For example, if your organization does not have Inbound Message flows available, then Archy would not put metadata for them in schema files either when running the archy refresh command. The same is true for actions, data types and other Architect related functionality. This is by design so consumers of Archy schemas don’t say that something is valid in flow YAML when it is not for a particular organization.

• Question: Is there a way to export a flow from Genesys Cloud Architect to YAML?
• Answer: Yes! You can export a flow from the Architect UI, and as of Archy version 1.4.0 via the export command. To find out more about the export command, run archy export --help.

• Question: Does Archy support proxy configuration?
• Answer: Neither Archy nor Architect Scripting support proxy configuration currently.

• Question: Why can I not reference in shared YAML from within a common file?
• Answer: At this time, embedding an external reference from within a common file using either the ref or refArray property is not allowed. This also includes referencing YAML from within the same common file.
• --
• Question: I upgraded to a new version of Archy, and things aren't working as expected. How can I go to an older version?
• Answer: You can easily do this by using the version command. First off, you can run the command archy version list which will list all available Archy versions. In the output, you can then find the most recent installed version by looking for a - next to the version numbers. To revert to this version, run the command archy version VERSION_NUMBER_NERE. To give an example, you just downloaded version 1.5.1 and find that something is not working right. You then run archy version list to find your most recent installed version and see that it is version 1.5.0. You then run the command archy version 1.5.0 and it will then downgrade you to that version. You can also use archy version previousLocal to achieve the same result. Alternatively, if you want to go to the most recent published version prior to the current one, you can run archy version previousPublished. You can find more information about the version command by running ‘archy version --help’ at the command line.

Archy - Ver. 2.33.1, generated on January 3, 2025