Create and Manage Profile

What is a profile?

A content ingest profile specifies the settings for downloading content. When you create a profile, you select entitlements for which you wish to download content and choose content file types and formats; for example, stories in NITF format or specific video renditions. You can also edit other settings; for example, the directory and folder structure for saving content.

How do I create a profile?

How do I select content?

1. On the Select Content tab, select the check box next to each entitlement that you want to download.

   • To view and select entitlements by type, switch between the All, Followed Topics, On-Demand, Products and Packages tabs.

   • Search by keyword, entitlement name or ID to narrow down the list of displayed entitlements. The search is not case-sensitive.

   • To view only selected entitlements, click Selected Items.

   • To filter by media type(s), click one or more check boxes next to Product Media Types.

   • To view all products included in a package, click See Products in Package to the right of the package ID. To select individual products in a package, select the check box next to each product that you want to download.

2. Click Save Profile at the bottom of the page to save your selections.

Can I select individual products included in a package?

Yes. On the Select Content tab, click the Packages tab, and then click See Products in Package next to the package name to view all products included in a package.

To select individual products in a package, select the check box next to each product that you want to download.

How do I select content file types and formats?

Click the Content Options tab and select the options under Files to choose the file types and formats for downloading content; for example, specific video renditions or NITF-formatted stories. In addition to saving content files, you can also choose to download metadata for individual content items or the entire feed.

Metadata

Downloading Metadata Files

Content metadata is returned in the JSON format and/or as XML in the NewsML-G2 format. For more information, see Content Metadata Fields.

Downloading metadata files is optional. Typically, you will need to write a custom script to post-process the downloaded metadata files.

• If you post-process JSON metadata files, you would typically choose to download either multiple content items in the same JSON file (JSON: Feed Files) or one content item per file (JSON: Item Files).  

• XML files in the NewsML-G2 format contain one content item per file. For more information, see XML: Item Files (NewsML-G2).

• If you are interested in processing metadata for associated items (linked media and/or AP Top Headline stories), select Associated Item Files in addition to one of the other JSON and/or NewsML-G2 XML file options.

JSON: Feed Files

Select this option to save feed files in JSON format (multiple content items are included in each feed file).

By default, feed files are saved in the <Agent Directory>/feeds folder. The file name format is feed_<yyyyMMdd_HHmmss>_seq_<sequenceNumber>.json where <yyyyMMdd_HHmmss> is the date and time when the file was downloaded, and <sequenceNumber> is a unique sequential number that identifies each feed item.

JSON: Item Files

Select this option to save item metadata files in JSON format (one content item per file).

By default, the item metadata files are saved below the <Agent Directory>/content directory. The default file name format is <ItemID>--<Version>--<ContentID>-item.json.

If you are downloading video files and select the <OriginalFileName>--<PartialContentID>.<ext> option on the Content Save Options tab in conjunction with the JSON: Item Files option, the original file name (if available for the video rendition) will be applied to the JSON item metadata files. For example, if the originalfilename value for the video rendition is 4329116_Portugal Virus UK Travel_0_Preview.mp4, the JSON item metadata file name would be 4329116_Portugal Virus UK Travel_0-item.json.

JSON: Embed NITF Text

If you are running the latest version of the agent and have selected to download JSON item files, you can select the JSON:Embed NITF Text option to embed the following in the NITF format at the end of the JSON item files:

• Story body (for text) in "nitf_story"
• Captions for pictures, graphics and video in "nitf_caption"
• Video scripts and/or shotlists in "nitf_script" and/or "nitf_shotlist"

XML: Item Files (NewsML-G2)

If you are running the latest version of the agent, you can select this option to save item metadata files as XML in the NewsML-G2 format (one content item per file).

By default, the item metadata files are saved below the <Agent Directory>/content directory. The default file name format is <ItemID>--<Version>--<ContentID>-item.xml.

If you are downloading video files and select the <OriginalFileName>--<PartialContentID>.<ext> option on the Content Save Options tab in conjunction with the XML: Item Files (NewsML-G2) option, the original file name (if available for the video rendition) will be applied to the NewsML-G2 item metadata files. For example, if the originalfilename value for the video rendition is 4329116_Portugal Virus UK Travel_0_Preview.mp4, the NewsML-G2 item metadata file name would be 4329116_Portugal Virus UK Travel_0-item.xml.

XML: Embed NITF Text

If you are running the latest version of the agent and have selected to download NewsML-G2 XML item files, you can also select the XML: Embed NITF Text option to embed the following NITF-formatted renditions in the <inlineXML> elements in the NewsML-G2 item files: story body (for text), captions (for pictures, graphics and video) and scripts and/or shotlists (for video). The <inlineXML> elements are embedded in addition to the <remoteContent> elements that contain links to these renditions.

NewsML-G2 Example: Embedded NITF Caption

<inlineXML contenttype="application/nitf+xml" wordcount="202">

Associated Item Files

Select this option if you are interested in downloading metadata for any of the following associated items:

• Linked media (for example, pictures and video linked to text stories).

• AP Top Headline stories (individual Top Headline stories are delivered as associated items of the Top Headline parent item; for example, "AP Top News at 8:50 p.m. EDT", that identifies all of these stories)

• Media linked to Top Headline stories.

The format of the associated item files (JSON and/or NewsML-G2 XML) will match the selected format of the metadata files. For example, if you select JSON: Item Files and Associated Item Files, the associated item files will be downloaded in the JSON format, and if you select XML: Item Files (NewsML-G2) and Associated Item Files, the associated item files will be downloaded in the NewsML-G2 XML format.

By default, the associated item metadata files are saved below the <Agent Directory>/content directory. The file name format of the JSON associated item files is <ItemID>--<Version>--<ContentID>-associated_item.json. The file name format of the NewsML-G2 XML associated item files <ItemID>--<Version>--<ContentID>-associated_item.xml.

Text

Text renditions (renditions of textual content) are the NITF version of a story and textual descriptions of the media (for example, an image caption or a video script). Learn more >>

NITF: Story Body

Select this option to save NITF-formatted stories.

If available, inline links are always included in NITF-formatted stories; for example:

<block id="Main">
  <p>BARCELONA, Spain (AP) - The rallying cry erupted, almost precisely, after 17 minutes and 14 seconds of soccer in the match between Barcelona and Malaga.</p>
  <p>
    <a href="https://www.youtube.com/watch?v=vMCg84QWNhs">"In! In-de! In-de-pen-den-ci-a!"</a> 
  </p>
  <p>It rolled around and around the Camp Nou stadium like a tide, from behind one of the goals into a frothing chorus of thousands of voices.</p>
    ... 
</block>

NITF: Caption

Select this option to save captions for pictures, graphics and video, including linked media captions.

The default file name format is <ItemID>--<Version>--<ContentID>_Caption.xml for captions of the pictures, graphics and video included in the feed and <ItemID>--<Version>--<ContentID>_Caption-associated_item.xml for linked media captions.

NITF: Script

Select this option to save video scripts, including the scripts of linked video.

The default file name format is <ItemID>--<Version>--<ContentID>_Script.xml for scripts of the video included in the feed and <ItemID>--<Version>--<ContentID>_Script-associated_item.xml for linked video scripts.

NITF: Shotlist

Select this option to save video shotlists, including the shotlists of linked video.

When a separate shotlist is available, the default file name format is <ItemID>--<Version>--<ContentID>_Shotlist.xml for shotlists of the video included in the feed and <ItemID>--<Version>--<ContentID>_Shotlist-associated_item.xml for linked video shotlists.

Media Renditions

Media renditions (renditions of non-textual content) are alternative versions of the same content item based on the format, size and/or other content characteristics, such as video frame rate and aspect ratio. For example, media renditions of a picture or graphic are the high-resolution, preview and thumbnail sizes of an image. Learn More >>

Select the check boxes for the media renditions (pictures, graphics, audio and video) that you want to download.

Are all media renditions available for all entitlements?

No, all renditions may not be available for certain entitlements. Although the AP offers a wide variety of potential media renditions, their availability for any given entitlement or content item is not guaranteed. Therefore, selecting certain renditions does not guarantee that you receive all of them; it only ensures that if the rendition is available, it is not filtered out. For example, you can select all video renditions, but the available video for a given entitlement or feed may include only MP4 files.

What are Content Save Options?

Video Tutorial

Agent Content Save Options (01:49)

Agent Directory

By default, the agent saves content in the <Agent Directory>/content folder (<Agent Directory> is the folder where the agent jar file is saved); for example: C:\Agent\content.

To save files in a different folder:

1. On the Manage Content Profile page, click the Content Save Options tab.

2. Click Custom directory and specify the path to the folder where you want to save content.

Content File Naming Format

• <ItemID>--<Version>--<ContentID>.<ext> can be used to correlate downloaded content item components with their specific metadata in an item metadata file.

  • <ItemID> is a unique ID that remains the same throughout all revisions of the content item; for example, all stories that have the same item ID are part of the same 'story chain'. <ItemID> corresponds to the "altids.itemid" property in the JSON feed.

  • <Version> is the content item version number: typically 0 for the initial version, 1 for the first revision, 2 for the second revision and so on. The higher the number, the more recent the content item's version. <Version> corresponds to the "version" property in the JSON feed. Together with <ItemID>, <Version> may be useful for placing a story in the specific location in the 'story chain' if you are tracking all versions of the story for news management.

  • <ContentID> is a code that identifies a media rendition and corresponds to the "contentid" property in the JSON feed.

  • <ext> is a file name ending that designates the file format and typically consists of three alphanumeric characters (for example, .xml, .jpg, .pdf and .mpg).

• <OriginalFileName>--<PartialContentID>.<ext> can be used to save files with original file names plus the last five digits of the <ContentID>; for example, EXAMPLE.JPEG--e68c0.jpg. This option helps prevent overwriting files saved with original file name. Files that have no original file name are saved with the file name in the format <ContentID>.<ext>.

Content Folder Structure

One folder for all content

All content is saved to the folder used for saving downloaded content (for example, to C:), and no subfolders are created:

One folder per entitlement

One folder is created per product, package or Followed Topic, but no subfolders are created for individual content item versions; for example:

One folder per entitlement and one subfolder per version

The agent creates one folder per entitlement below the folder used for saving downloaded content (for example, under C:) and subfolders for individual versions in each entitlement folder; for example:

For AP Top Headlines, the agent creates one folder per entitlement (for example, AP Online Top General Headlines) below the folder used for saving downloaded content (for example, under C:) and subfolders for individual versions of each Top Headline story in each entitlement folder:

Duplicate Settings

What are duplicates?

Duplicate content is content that has been ingested more than once within a 24-hour period (the standard news cycle).

Duplicate content may be delivered for a variety of reasons; for example:

• AP Top Headlines are filed multiple times throughout the day, often with the same stories.

• AP editors may file the same story for print and online use.

• The same story or media may appear in multiple entitlements (products, packages or Followed Topics).

• Stories may share linked media; for example, the same picture may be linked to two different stories about the same news event.

How do I filter out duplicates?

By default, the agent does not ingest duplicate content.

How can I save duplicates?

On the Content Save Options tab, scroll down to the Duplicate Settings section and select one of these options:

• To save all duplicates, click Save all duplicates.
  

Tip
This option is useful if you are saving each story version with its linked media in a separate subfolder using the One folder per entitlement and one subfolder per version option on the Content Save Options tab.

• To save one duplicate per entitlement, click Save one duplicate per entitlement.
  

  Tip
  This option is useful if you are saving content for each entitlement in a different folder using the One folder per entitlement option on the Content Save Options tab.

Content Deletion

Deleting downloaded content files automatically after a certain time from the directory where they are saved cleans up older files, preventing them from exhausting disk space. When content file deletion is enabled, the agent deletes content, log, item metadata and JSON feed files according to the specified settings.

Does the agent automatically delete older files?

No. The agent does not delete older files by default.

How can I enable content file deletion?

On the Content Save Options tab, select one of these options under Content Deletion :

• Delete after 24 hours

• Delete after 48 hours

• Delete after 7 days

Customize Entitlement Settings

How do I edit entitlement settings?

You can edit settings for one or more individual entitlements that you selected on the Select Content tab.

1. Click the Edit Settings link to the right of the entitlement ID to customize its settings, including Content File Options and Content Save Options.

2. Click Save Profile at the bottom of the page to save your changes.

How do I restore default settings?

To restore the default values for all settings in this entitlement, click Restore Default Settings at the bottom of the Entitlement Settings page.

Will editing default content settings affect customized entitlements?

No. If you later edit the default content settings, the customized entitlements will not be affected. The changes will apply only to entitlements that you have not customized.

How do I know which entitlements I have customized?

On the Select Content tab, the entitlements for which the settings have been modified are marked by a red warning icon next to the Edit Settings link:

Manage Profiles

How do I edit a profile?

 

1. On the dashboard, scroll down to the Content Profiles section.

2. Under Options, click the Edit link associated with the profile that you want to edit.

3. Make the changes on the Manage Content Profile page (the options are the same as those for creating a profile).

4. Click Save at the bottom of the page to save your profile.

How do I delete a profile?

1. On the dashboard, scroll down to the Content Profiles section.

2. Under Options, click the Delete link associated with the profile that you want to delete.

3. Click OK to confirm.

Export and Import Profiles

Can I export a profile?

Yes. If you would like to save a copy of your configuration profile to your machine (for example, as a backup copy), you can export the profile configuration settings as a JSON file.

To export a profile:

1. On the dashboard, scroll down to the Content Profiles section.

2. Under Options, click the Export link associated with the profile that you want to export.

3. Save the profile JSON file to your machine. The default file name is in the format {Profilename}_{Datetime}.json.

How do I import a profile?

If you have previously exported a configuration profile from the dashboard to a JSON file and saved it to your machine, you can import it to the dashboard.

To import a profile:

1. On the dashboard, click Create Content Profile, and then click Import from File.

2. Type the name of the profile in the New Profile Name box, and then click Choose File to browse to the previously exported profile JSON file.

3. Click Submit to import the profile. Once the profile is successfully imported, review the settings and make any necessary changes.

Default Profile

How do I set a default profile?

You can set a default profile to have all newly installed agents start ingesting content automatically with the same settings, which are specified in that default profile.

To set a default profile:

1. On the dashboard, scroll down to the Content Profiles section.

2. Under Options, click the Assign Default link associated with the profile that you want to set as a default. The default profile is now marked as (default) in the Content Ingest Profiles section of the dashboard and in the Content Profile drop-down list.

How can I unassign a default profile?

To unassign a default profile:

1. On the dashboard, scroll down to the Content Profiles section.

2. Under Options, click the Unassign Default link associated with the profile marked as (default).