Configure and Use the Image Migrator App

Follow

Use the Image Migrator app to easily move blog images from an external hosting service or CMS to Uberflip image hosting.


 

Before You Begin

  • Before you can use the Image Migrator app, you need to install it from the Uberflip Marketplace (click on Marketplace in the top navigation in Uberflip).
  • To use the app, you will need your Uberflip account's API Key and API Secret as well as its Account ID. To learn where to get these details, see this article.
  • To work with the Image Migrator app, images you want to migrate must meet the following requirements:
    • All images must be available on the web through publicly accessible URLs (can't be behind a login).
    • Every image must have its own URL that points directly to the image file (i.e. URLs can't point to non-image files or compressed/zip files of image files).
    • All image URLs must be active (i.e. successfully loads the image, not a 404 error) at the time of migration. 

 

About the Image Migrator App

The Image Migrator app allows you to move blog images in bulk from an external host (e.g. a CMS) into Uberflip.

When you import an external blog into Uberflip, the Uberflip platform creates an exact copy of the blog using its RSS feed. The problem: images in the blog are represented by the URLs where the images are hosted, and these external image URLs are also copied directly into Uberflip. As a result, all images in the Uberflip copy of the blog will still be loaded from their external URLs, so if those URLs become inaccessible (e.g. because the original blog goes offline), the images will break.

If you're planning to decommission an external blog that you've imported into Uberflip, the Image Migrator app helps you to avoid broken images by moving them from the original hosting platform to Uberflip image hosting. The app automates the entire migration process, including:

  • Downloading blog images of your choice from their original URLs
  • Uploading the images to the Uberflip Image Manager in a specified Hub
  • Identifying all the Items in that Hub where the images appear
  • Replacing the external image URLs in these Items with the equivalent Uberflip-hosted URL

Once you have successfully migrated the images to Uberflip, you can safely shut down the external blog without breaking the images in the Uberflip Blog Stream.

 

Configure App Settings

Info

You configure this app at the Hub level, which means that your settings will apply only to the Hub you are currently working in. If you have multiple Hubs, you must configure (and use) this app separately in each Hub.

After your Customer Success Manager has installed the Image Migrator app on your Uberflip account, you'll need to start by configuring it with your Uberflip API credentials. The Image Migrator app will use these credentials to access your Uberflip account via the API to upload and replace images.

  1. Log in to Uberflip and click on Hubs in the menu at the top, then click on the Hub you want to work with.
  2. In the sidebar menu on the left, click on Image Migrator:

    Hubs___Image_Migrator_-_Uberflip.png

  3. The Image Migrations interface will appear on the right. Here, click on the Settings button near the top:
    Hubs___Image_Migrator_-_Uberflip.png
  4. This will open the App Settings menu. Here, type in your your Account ID, your API Key, and your API Secret into the fields provided:
    Hubs___Image_Migrator_-_Uberflip.png
    • See this article for instructions on how to get these details for your Uberflip account.
    • Your Hub ID will be pre-filled based on the Hub you're currently in.
  5. Click on Submit to save your settings, then click on the x button to close the App Settings menu.

Note

If your account's API Key and API Secret change (for example if you rotate them periodically for security, as we recommend doing), you will see an error while using the Image Migator. To avoid (or resolve) this, update the API credentials in the app's settings: simply follow the instructions above, and enter the new API Key and API Secret into the same fields.

 

Migrate Images from an External Host to Uberflip

After you have successfully configured the app, you're ready to start using it to migrate images. You'll need the URLs for all of the images you want to migrate to complete this process, so we recommend creating a list of these URLs before proceeding.

  1. To begin a new migration, click on Image Migrator in the sidebar menu on the left to open the app:

    Hubs___Image_Migrator_-_Uberflip.png

  2. In the Image Migrations main menu, click on the the +New Migration button near the top:
    Hubs___Image_Migrator_-_Uberflip.png
  3. In the New Image Migration menu, enter the URLs for the images you want to migrate into the text field:
    Hubs___Image_Migrator_-_Uberflip.png
    • Enter one URL per line
    • Do not use commas (or any other delimiter) between URLs
    • We recommend entering a maximum of 100 URLs at one time to avoid excessive processing times
  4. Click on Next. The app will now parse the list of URLs you entered and display each individual image URL on a separate line:
    Hubs___Image_Migrator_-_Uberflip.png
  5. Review the list, and remove any URL you don't want (e.g. duplicates, incomplete URLs, etc.) by clicking on the delete (trash) icon beside it. Once you're ready to proceed, click Next.
  6. The app will now begin processing the images, and will attempt to download them from the URLs provided. Once it has finished processing, click on Next:
    Hubs___Image_Migrator_-_Uberflip.png
  7. The app will now show results for the image URLs it has processed, listing each image individually:
    • Success: If the app was able to download the image and upload it to Uberflip, it will display the new URL where the image is now hosted on Uberflip:
      Hubs___Image_Migrator_-_Uberflip.png
    • Failure: If the app was unable to process an image for any reason (see below), this will also be indicated:
      Hubs___Image_Migrator_-_Uberflip.png
  8. If you see any errors, you can try clicking on Retry Failed Images to try them again. If this does not resolve the errors, refer to the Troubleshooting section below.
  9. Click on Next to start searching Items in the current Hub for the old image URLs that you entered (in Step 3). Once the process has finished, click on Next again to view the results.
  10. The Items using URLs screen will appear, which lists all Items that currently use the old image URLs:
    Hubs___Image_Migrator_-_Uberflip.png
  11. To complete the migration, click on Next. The app will now edit all of the Items it identified in the last step to replace the old (external) image URLs with the new (Uberflip-hosted) URLs. When it has finished this process, click on Next again.
  12. Finally, the app will show you a list of the Items that it was able to update. To finish, click on Done:
    Hubs___Image_Migrator_-_Uberflip.png
  13. You will be returned to the main Image Migrations menu, where the migration task that you just performed will appear in the migration history table:
    Hubs___Image_Migrator_-_Uberflip.png
    • You can view details about any previously performed migration task by hovering your mouse over its entry in the table, then clicking on the Edit (pencil) button that appears on the right.
  14. If your migration task was successful, you're done! If you encountered any errors, try fixing them using the Troubleshooting steps outlined below, then run the migration again.

 

Troubleshooting

There are a number of reasons why you might encounter errors while migrating images. Below are some common errors you might encounter, along with steps to resolve them:

Error Cause How to Fix

View Uploaded URLs menu > Error: An error prevented your request from being completed

The image URL is invalid (e.g. because of a typo or copy-paste error).

Check and fix any typos, missing characters, etc. in the image URL. Make sure that you enter only one URL per line, and that only a single URL per bullet point appears on the Verify Images screen.

View Uploaded URLs menu > Error: An error prevented your request from being completed The image is unavailable at the provided URL (404 error) or requires a login to be accessed (401 error). Manually load the URL in your browser: if an error message or login prompt appears, Image Migrator will not be able to process that image URL. To fix, ensure all image URLs meet the requirements.
View Uploaded URLs menu > Error: An error prevented your request from being completed The image URL does not point to an image (an image file in a commonly used format, such as JPG, PNG, etc.). Manually load the URL in your browser: if the image is not displayed in your browser, Image Migrator will not be able to process that image URL. To fix, ensure all image URLs you enter point to image files.

Image Migrations or App Settings menu > Request failed with status code 401

View Uploaded URLs menu > Access Denied. You do not have access to the specified user

Image Migrator was unable to access your account because the API credentials you provided were rejected by the Uberflip platform.

This can happen when your API credentials are rotated (deleted and re-generated), or if they were simply entered incorrectly. Try copying and pasting your API Key and API Secret into the App Settings window again.

Items using URLs menu > No items

Image Migrator was unable to find any of the image URLs you specified in any Uberflip Items, so there were no images to replace.

No fix: the image you are trying to migrate does not exist in Uberflip. If you want to add it to an Item in Uberflip later, you can manually upload it to the Image Manager.
Other errors or none of the suggested solutions resolves the problem

If you have tried to migrate a large number of images in  short period of time, Image Migrator may have reached the maximum number of allowed requests to the Uberflip API.

Try waiting a few hours, then try again.
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.