Description Usage Arguments Value Additional Information Examples
The migration endpoints require access to the Gallery admin API. Users cannot authorize using non-admin keys.
Migrating workflows is a four-step process:
Find all Gallery resources marked as "Ready to Migrate"
Download the resources from the source environment
Publish the resources to the target environment
Toggle "Ready to Migrate" flag
The functions get_migratable
, publish
, and
toggle_migratable
perform the above tasks individually:
get_migratable
: Returns a list
of resources marked as
ready for migration in Gallery
publish
: Downloads and publishes resources
toggle_migratable
: Toggles "Ready to Migrate" flag
The function migrate
is provided as a wrapper to automate migration
from end-to-end.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | migrate(migration_directory = NULL, subscription = list(),
form = NULL, gallery = get_gallery(),
target_alteryx_api_key = getOption("target_alteryx_api_key"),
target_alteryx_secret_key = getOption("target_alteryx_secret_key"),
target_gallery = getOption("target_alteryx_gallery"), verbose = TRUE)
get_migratable(subscription = list(), gallery = get_gallery(),
verbose = TRUE)
publish(app, migration_directory = NULL, form = NULL,
target_alteryx_api_key = getOption("target_alteryx_api_key"),
target_alteryx_secret_key = getOption("target_alteryx_secret_key"),
target_gallery = getOption("target_alteryx_gallery"), verbose = TRUE)
toggle_migratable(app, gallery = get_gallery())
|
migration_directory |
A directory for storing downloaded resources. Defaults to a random temporary directory. |
subscription |
A |
form |
A
|
gallery |
URL for your Alteryx Gallery |
target_alteryx_api_key |
Admin API key for target environment |
target_alteryx_secret_key |
Admin API secret key for target environment |
target_gallery |
URL for your target Alteryx Gallery |
verbose |
Print information related to migration status |
app |
A single |
NULL value. Use verbose = TRUE
to see migration status.
Remember to set your API key, secret, and Gallery location for the target environment.
It is possible for deleted resources to show as marked for migration. In this situation, you will see a message that the resource was "(Skipped due to a problem)."
It is possible to migrate from and to the same environment.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | ## Not run:
# to run manually
app <- get_migratable()[[1]]
form <- list(
name = "app_name.yxwz",
owner = "new_owner_email@domain.com",
validate = "false",
isPublic = "false",
sourceId = "ABC123",
workerTag = "",
canDownload = "false"
)
publish(
app,
migration_directory = "c:/aspot/tostage/files"
form = form
)
toggle_migratable(app)
# automated
migrate(
form = form,
migration_directory = "c:/aspot/tostage/files"
)
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.