Quick Reference FAQs
|
ON THIS PAGE Show |
|
|
|
|
What are the system requirements for the AP Media Agent and Configuration Dashboard?
See System Requirements.
What credentials should I use to access the configuration dashboard in AP Newsroom?
Use your AP Newsroom credentials
to log in to the AP Newsroom, click 
at top left
and choose AP Media API to access the configuration
dashboard. All users within your
organization will have the same exact view - they will see all profiles
and agents for your organization.
How do I get up and running with the AP Media Agent?
Watch an intro tutorial and follow the quick steps to configure and set up your agent in Getting Started.
What version of Java should I install to run the agent?
Running the agent requires a compatible Java Runtime Environment (JRE) installation on the computer where you will run the agent. There are many compatible Java versions on many operating systems, and you should choose the one that is the most appropriate for your needs. It is always recommended that you use the newest available release version of the JRE you chose and keep it up to date with the latest security patches and bug fixes. If you are unsure of which JRE to choose for your installation, you can use Oracle’s Open JDK (https://jdk.java.net/), which is free for all commercial use under the GNU General Public License. Oracle also now offers a paid licensed version with support and more frequent updates (https://www.java.com/en/). Mac OS X users can install the latest Java version via Software Update.
Can I change the name of the agent Java file?
It is strongly recommended not to rename the agent jar file. If you are planning to run multiple agents on the same machine, each agent jar file must be in its own folder.
How do I install the Agent service?
See Running the Agent as a Service.
Can I specify the port that the local Agent Management page uses?
Yes. See Can I change the local port that the Agent Management page uses?
Can I disable the local Agent Management page server?
Yes. See Can I disable the local Agent Management page server?
Can I run more than one agent on a single machine?
Yes, you can run multiple agents on the same machine. If you are planning to run multiple agents on the same machine, each agent jar file must be in its own folder. See the tips in Download and Register Agent in Getting Started.
How do I find agent logs for troubleshooting?
The agent logs are in the logs folder below the agent directory where your agent jar file is located.
How can I check if my agent is connected to AP Media API?
You can run the agent connectivity scan by specifying the statusCheckOnly:true parameter when you start the agent from the command line; for example:
java -jar agent.jar statusCheckOnly:true
You will get the Agent Connectivity Scan Report that you can send to AP Customer Support for troubleshooting if necessary.
Can I start and stop the agent ingestion remotely, without having to log into the local machine the agent is running on?
Yes, you can stop and restart content ingestion from the configuration dashboard as long as the agent process is running. See How do I stop ingesting? and Restarting Ingestion.
When I first start my agent, I see a bunch of stories/photos/videos/audio downloaded immediately. Why does this happen?
When first started, the agent pulls the most recent 10 items from the feed.
When should I choose the JSON: Associated Item Files option?
See JSON: Associated Item Files.
Why can't I delete my agent?
You can delete an agent from the configuration dashboard only after it has been off for a certain period of time (currently after two hours).
How do I run the agent from a terminal/command line?
See Can I launch the agent from a command prompt?
How do I run the agent if I'm running a proxy server?
See How can I run the agent using a proxy server?
How can I manage duplicate content being downloaded by the agent?
By default, the agent does not ingest duplicate content. If you are interested in saving duplicate content, see How can I save duplicates?
What naming conventions are available for content downloaded by the agent?
See Content File Naming Format.
Where can I find the agent ID of a particular agent?
You can find it in the agent details on the Manage Ingest Agent page. See Where can I view agent details?
Where can I find the agent version I am running?
You can find it in the agent details on the Manage Ingest Agent page. See Where can I view agent details?
Where can I find the hostname of the machine that the agent is running on?
You can find it in the agent details on the Manage Ingest Agent page. See Where can I view agent details?
I am having issues with an older version of the agent.
We strongly urge you to upgrade to the latest version of the agent to avoid potential issues and take full advantage of improved performance.
Can I save JSON or NewsML-G2 item metadata files with the original video file name?
Yes, you can save item metadata files for video using the original file name of the associated video rendition if available.
In your agent's profile on the configuration dashboard, select the JSON: Item Files and/or XML: Item Files (NewsML-G2) options on the Content Options tab:
Select the desired video renditions; for example:
On the Content Save Options tab, select the <OriginalFileName>-<PartialContentID>.ext option:
If there is an original file name associated with the selected video renditions, the original video file name is applied to the saved JSON and/or 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 JSON item metadata file name would be 4329116_Portugal Virus UK Travel_0-item.json, and the NewsML-G2 item metadata file name would be 4329116_Portugal Virus UK Travel_0-item.xml.
How can I determine what kind of content I will receive over a particular product or package ID?
Go to AP Newsroom, log in with your AP Newsroom credentials, enter productid:{productID} in the Search box, and you will see what content moved on this product ID in the last 30 days.
What are the "class" tags I'm seeing in NITF?
Some NITF content may contain HTML "class" attributes to help you with formatting this content using CSS if you wish.
What is an abstract/summary? How can I get it?
|
|
Abstract (story summary) is an optional add-on to existing text services to which your organization may or may not be entitled. If you are interested in receiving this story element, please contact your AP sales representative. |
|
|
|
NoteThe Abstract provides a summary of text stories written by AP journalists, which encapsulates the story in about 100 words. These summaries are great for digital and mobile use, social media properties, text-to-audio applications, and more.
If included in your service, the story summary is delivered in the "description_summary" field in the JSON search or feed response and in the <abstract> field in NITF stories.
{// Example:
"description_summary": "U.S. industrial production jumped a solid 0.9 percent in October. Factory activity recovered from the previous months' shuttering of assembly lines by Hurricanes Harvey and Irma. The Federal Reserve says that manufacturing activity surged 1.3 percent last month. Many of the gains came from a sharp increase in the production of chemical and petroleum and coal products. Motor vehicles and metals also posted decent gains."}
- <nitf version="-//IPTC//DTD NITF 3.4//EN" change.date="October 18, 2006" change.time="19:30">
+ <head>
- <body>
- <body.head>...
+ <dateline>
<abstract>U.S. industrial
production jumped a solid 0.9 percent in October. Factory activity recovered
from the previous months' shuttering of assembly lines by Hurricanes Harvey
and Irma. The Federal Reserve says that manufacturing activity surged
1.3 percent last month. Many of the gains came from a sharp increase
in the production of chemical and petroleum and coal products. Motor vehicles
and metals also posted decent gains.</abstract>
</body.head>...
AP Media API and Media Agent always deliver all the story elements (story body, summary and headline) to which you are entitled in the same NITF file.
For example, you are using the Media Agent or making a Media API feed request for one or both or these product IDs:
Product ID 100135 Broadcast – APTV – Michigan (you are entitled to headline, extended headline, body)
Product ID 47066 Broadcast – Summaries – Michigan (you are entitled to headline and summary)
You will receive ALL the story elements to which you are entitled in the same NITF file: the summary in the <abstract>, the body in <body.content> and the headline in body.head/hedline/hl1.
|
|
The extended headline is not part of NITF; it is available only in the "headline_extended" property in the Media API response. |
|
|
|