Skip to content

Migrating to AP Media Agent

If you are using the AP WebFeeds Agent configured on the AP WebFeeds Manager Portal, follow the quick steps below to migrate to the AP Media Agent. Learn about migration benefits >>

Quick Steps

STEP 1: Export Your WebFeeds Profile from the WebFeeds Manager Portal

  1. Go to the AP WebFeeds Manager Portal and log in using your organization's AP WebFeeds user name and password.
  2. On the Manage Profiles page, under Actions, click the Export link associated with the profile that you want to export and save the profile configuration XML file to your machine.

STEP 2: Import Your WebFeeds Profile to the Media Agent Dashboard

  1. Go to AP Newsroom and enter your organization's AP Newsroom user name and password.
  2. Click Menu Icon at top left and choose AP Media API from the menu to display the Agent Configuration Dashboard.
  3. On the Agent Configuration Dashboard, click Create Content Profile, and then click Import from File.
  4. Type the name of the profile in the New Profile Name box, and then click Choose File to browse to the previously exported XML file.
  5. Click Submit to import the profile. Once the profile is successfully imported, review the settings and make any necessary changes.

Tips

  • Keep in mind that some of the options that you might have selected in AP WebFeeds Manager are no longer supported. Learn more >>
  • If you are using Serial Port Integration to download ANPA from the agent, the functionality on the new dashboard has not changed.

STEP 3: Get API Key

Your can use your user name and password to log in to AP Newsroom and access the Agent Configuration Dashboard; however, you will need an API key to run the agent.

To get your API key:

On the dashboard, click See My API Keys (you may need to confirm your password to display your API key).

STEP 4: Download and Register Agent

  1. On the dashboard, click Download Agent and save the agent jar file to a folder on your machine.

    Tips

    • When choosing the folder for saving the jar file, consider that this folder will be your <Agent Directory> below which the agent will be saving files by default when you start ingesting content.
    • It is strongly recommended not to save content in any system folders.
    • It is not recommended to run the agent from your Desktop.
    • Renaming the agent jar file is not recommended.
    • If you are planning to run multiple agents on the same machine, each agent jar file must be in its own folder.
  2. Do one of the following to run the agent:

    • From your desktop environment, browse to the folder where you saved the agent jar file and double-click the file name. The Agent Registration page opens in your browser.
    • From a command prompt on Windows or with sudo on Mac or Linux:

      1. Change to the directory where the agent jar file is located; for example, on Windows:
        cd LOCATION_OF_AGENT
      2. Run the following command:
        java -jar agent.jar

    The Register Agent page opens in your browser prompting you for an API key.

    Tip

    Alternatively, you can provide the API key as an argument from the command prompt:

    java -jar agent.jar key:API_KEY

  3. To register your agent with the configuration dashboard, enter your API key in the API Key box and click Register. If registration is successful, you will receive this message: "Success you've verified your API Key".

    Tip

    Check your browser's Address box to determine where the Agent Management page is located on your local machine. For example, if your agent registration address is localhost:8087/register, you can manage your agent from your local machine at localhost:8087/agent.

  4. Click Go to Admin Portal to assign a content profile to your agent.

STEP 5: Assign the Profile to the Agent and Start Ingesting Content

  1. On the Manage Ingest Agent page, enter the agent name of your choice in the Agent Name box. The agent name allows you to identify this agent on the dashboard and must be unique.
  2. Select your content profile from the Content Profile list.
  3. Make sure that the default access mode and version are selected from the Access Mode lists.
  4. Click Save Agent.
  5. Click Start Ingestion to start ingesting content.

Changes to Agent Configuration Options

The improved agent configuration on the AP Media Agent Configuration Dashboard provides fewer and more streamlined options, compared to the agent configuration settings on the WebFeeds Manager portal:

  • Metadata format. Metadata files are delivered in the JSON format. Feed XML is no longer supported. Learn more about JSON metadata options >>
  • Text story formats. Text stories are available in the NITF or ANPA formats. The IPTC 7901 and hNews formats are no longer supported. Learn more about text formats >>
  • Media filters. Fewer video filters are now available for easier selection of video renditions. Newly added graphics renditions include JPEG, PNG and JPEG Matte full-resolution images. Freehand 8 and 9 graphics are no longer available. For audio, supported formats now include only MP3 and MPEG. Learn more about media renditions >>
  • Naming formats. Content file naming formats now include the two most popular options: <ItemID>-<Version>-<ContentID>.<ext> and <OriginalFileName>-<PartialContentID>.<ext>. When you import a WebFeeds configuration profile, options containing <OriginalFileName> are converted to <OriginalFileName>-<PartialContentID>.<ext>, and the other WebFeeds file naming options are converted to <ItemID>-<Version>-<ContentID>.<ext>. Learn more about Content Save options >>
  • Folder structure. WebFeeds options 'One folder per Entry' and 'One folder per entry and entitlement' are converted to the AP Media API option 'One folder per entitlement and one subfolder per version'. The other two folder structure options ('One folder per entitlement' and 'One folder for all content') are mapped to their direct counterparts. Learn more about folder structure >>
  • Duplicate settings. Options for filtering out duplicate content in the AP Media API have been simplified and are set to the default option of "Discard duplicates" when you import a WebFeeds profile. If you are interested in saving duplicates, make sure to change this setting in your AP Media API profile. Learn more about duplicate settings >>
  • Content post-processing. The option to specify a script for post-processing content is no longer available. If you are interested in tighter integration of your system with AP Media API, you can write your own custom program for processing a feed or searching and downloading content. To learn more, see AP Media API Developer documentation.