alterryx (version 0.5.0)

migrate: Migrate Workflows

Description

The migration endpoints require access to the Gallery admin API. Users cannot authorize using non-admin keys.

Migrating workflows is a four-step process:

1. Find all Gallery resources marked as "Ready to Migrate"

2. Download the resources from the source environment

3. Publish the resources to the target environment

4. 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.

Usage

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())

Arguments

migration_directory

A directory for storing downloaded resources. Defaults to a random temporary directory.

subscription

A list of subscriptions ids to filter migratable results by private studio

form

A list that contains metadata for the published resource in the target environment. If NULL, the defaults will be assumed from the source environment. A list that contains

• name

• owner

• validate

• isPublic

• sourceId

• workerTag

• canDownload

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 alteryx_app returned from get_app

Value

NULL value. Use verbose = TRUE to see migration status.

Additional Information

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.

Examples

# NOT RUN {
# to run manually
app <- get_migratable()[[1]]
form <- list(
  name = "app_name.yxwz",
  owner = "[e-mail]",
  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"
)

# }
# NOT RUN {
# }