Publisher

Exporting content

Exporting Content via RSS feeds

It is possible to export content from Publisher and this content can be pre-filtered on metadata. To syndicate the content you will need to create an RSS user (and if you want to filter the content, you would need to select the user's preferences to do this.) If you want to have several different feeds, you need several different RSS users.
Creating a standard RSS feed
To create a standard RSS feed, you need to:
  1. Create an RSS User
     - Create a user in the organisation. A good example of this is RSSALL@clientdomain.com
  2. RSS Feeds
     - Copy the email address of the user you just created and navigate to
    System administration>System Settings
    RSS feeds
     and select
    Add User
    .
3. Adding an RSS user - Whilst adding an RSS user, you must add the following details:
  • Pair name
     - This is the name of the RSS feed. For example: 'Feed for all available modules'
  • Email address
     - This is the email address of the user. For example, RSSALL@clientdomain.com
  • RSS IP
     - This option enables you to restrict feed access to an IP address OR
    Restrict IP
     enables you to block certain IP addresses
  • RSS feed permissions
     - Once the RSS user has been created, navigate to
    More actions
     >
    Module permissions
     and select the modules you want the feed to be able to access
4. Click the ellipsis on the RSS and click either
Copy previous rss link
 or
Copy latest rss link
 as per the above screen.
5. You will receive a link, similar to this: https://clientdomain.highq.com/clientdomain/RSSAuth.action?kydt=v%2FUQWqGWsO9YBaF%2B4cQlElEmiHWjy4Nnd4Q2Z4tUJDD5eOQpPoGT3%2FsxlUR9heIgRK9vpaWizzQ%3D&maxrecords=0&rqf=as.
Changing the variables of an RSS feed
Records in a feed
To specify a maximum number of items in an RSS feed, you need to change the 'maxrecords' parameter with the new value.
The values are as follows:
  1. '-1' means all records (i.e '&mxr=-1' or '&maxrecords =-1')
  2. '0' means first 100 records (i.e '&mxr=0' or '&maxrecords =0')
  3. Any other numeric value defines the specific number of items in the RSS feed (e.g. '&maxrecords =10' equals the first 10 items)
So for example, you could use:
https://clientdomain.highq.com/clientdomain/RSSAuth.action?kydt=v%2FUQWqGWsO9YBaF%2B4cQlElEmiHWjy4Nnd4Q2Z4tUJDD5eOQpPoGT3%2FsxlUR9heIgRK9vpaWizzQ%3D&maxrecords=
10
 &rqf=as
Additional details
Additionally, you can also add a 'ful' parameter, which will add the complete set of available data to the RSS feed. By appending '&ful=1' to the RSS link, you can return a more complete set of details for the feed. This can be very useful if you need to import items from your Publisher instance.
So for example, you could use:
https://clientdomain.highq.com/clientdomain/RSSAuth.action?kydt=v%2FUQWqGWsO9YBaF%2B4cQlElEmiHWjy4Nnd4Q2Z4tUJDD5eOQpPoGT3%2FsxlUR9heIgRK9vpaWizzQ%3D&maxrecords=
10
 &rqf=as
&ful=1
Sorting content by modified date
To sort the content by modified date you need to append '&sortByModifiedDate=true' or '&smd=true' with '&ful=1' or '&fulldetails=1' to the RSS link, i.e append '&smd=true&ful=1'
So for example, you could use:
https://clientdomain.highq.com/clientdomain/RSSAuth.action?kydt=v%2FUQWqGWsO9YBaF%2B4cQlElEmiHWjy4Nnd4Q2Z4tUJDD5eOQpPoGT3%2FsxlUR9heIgRK9vpaWizzQ%3D&maxrecords=10&rqf=as&smd=tru&ful=1
Narrowing a feed by a particular metadata
From the
User system administration
 page, you need to set the system preferences for your RSS 'feed user' for example RSSALL@clientdomain.com via the
More actions
 menu. Select the metadata preferences for the RSS user and select
Save
. These will now be pulled through to the RSS Feed.
Example feed
Below are some examples of feeds:
https://clientdomain/clientdomain/RSSAuth.action?kydt=v%2FUQWqGWsO8uW29998rwZlEmiHWjy4Nnd4Q2Z4tUJDD5eOQpPoGT31x1QHZfc6N6PVhNL%2B4NsnA%3D&maxrecords=0&rqf=as
view-source:https://clientdomain/clientdomain/RSSAuth.action?kydt=v%2FUQWqGWsO8uW29998rwZlEmiHWjy4Nnd4Q2Z4tUJDD5eOQpPoGT31x1QHZfc6N6PVhNL%2B4NsnA%3D&maxrecords=0&rqf=as
The following list of recent improvements to the RSS feed will be available to all users, ensuring the easier consumption of content:
Batches for the RSS feed
We have introduced the ability to access RSS Syndication in batches. If you have over 100,000 articles and try to access them all, it is now scaleable and results are returned as expected.
We have also introduced the ability to call batches of articles. This can be done by appending '&pgno=0' to the RSS link, and by setting up the 'maxrecords=10' parameter, you can return a batch of the content for the feed. This can be very powerful if you need to import many items from your Publisher instance.
For example, you could use:
https://clientdomain.highq.com/clientdomain/RSSAuth.action?kydt=v%2FUQWqGWsO9YBaF%2B4cQlElEmiHWjy4Nnd4Q2Z4tUJDD5eOQpPoGT3%2FsxlUR9heIgRK9vpaWizzQ%3D&maxrecords=
10
 &rqf=as&ful=1
&pgno=2
Permalink URL
We also have the option to show related materials into our RSS feed.
Currently, the permalink URL is a front-end vanity link. Whereas within the RSS feed, this is the back-end URL and this contains extra parameters to help identify where you click the link from (e.g. email/RSS which helps for log in/permission purposes) however, there is no difference in terms of what the content is. Examples of this are below:
Permalink e.g.
https://clientdomain.highq.com/clientdomain/insights/antitrust-vertical-merger-guidelines
RSS feed URL e.g.
https://clientdomain.highq.com/clientdomain/dispatchContent.action?key=BcJlhLtdCv6%2FJTDZxvL23UhmyE6WUXVgzGAckwosUSmlWlttVf7c5dw%2Fc9jGWruxmzF4%2Fk20N54nHczOItrck93OjGmtaEjr&nav=FRbANEucS95NMLRN47z%2BeeOgEFCt8EGQ%2FHLCIrtYuIY%3D&uid=kpypw3ykExQ%3D
We have introduced the option to have the permalink URL included, rather than the back-end URL, this is managed within the super admin setting named 'Enable RSS permalink URL'.
When the super admin setting 'Enable RSS permalink URL' is set to true, the RSS will be the permalink URL:
When the super admin setting "Enable RSS permalink URL" is set to false the RSS is the back-end URL:
Inclusion of related materials and attachments in the Publication permalink URLs
To be included in the RSS feed with their own:
Related materials
  • Articles - These will respect the permissions of the article
  • Uploaded Documents - This is the same as the Attachment content pieces - if you have the RSS Feed -> Edit RSS feed ->
    RSS IP
     check box is selected, then the user can automatically download, however, if the
    RSS IP
     check box is unselected, then it will redirect the user to the login page
  • External URLs - Access to this is dependant on the external source (if it requires an external login).
Attachments
  • Uploaded Documents - This is the same as the Attachment content pieces - if you have the RSS Feed -> Edit RSS feed ->
    RSS IP
     check box is selected, then that user can automatically download, however, if the
    RSS IP
     check box is unselected, then it will redirect the user to the login page
Content based on a specific date
Adding date function
To add a date function, (take the RSS link below for example):
  1. Add the parameters to fulfil your date range
    • modified Since = All content since this date
    • modified Before = All content before this date
  2. Both parameters need the following date format 'YYYYMMDDHHmm'. For example: 22 March 2012 15:00 would be 201203221500
  3. Once you have decided what the additional code should be, you must append it in this way. For example, the additional code could be &modifiedSince=201203221500
The example RSS would then be: https://publisher.highqsolutions.com/publisher/RSSAuth.action?kydt=V0%2BASO82k5JjGLHKAm%2BhbH26Pm6vJtg5rL21MOB7xjlEjnk3tUyvPH8IRqio7Qc5qua2MGD7nrPd%0D %0AzoxprWhI6w%3D%3D&maxrecords=0&rqf=as&modifiedSince=201203221500
Include the last modify date of the content in the RSS feed
To include the last modify date of the content in the RSS feed, you must append '&includeLastmdifiedDate=true' or '&lmd=true' with '&ful=1' or '&fulldetails=1' to the RSS link. For example: append '&lmd=true&ful=1' to the link of the RSS feed
Sort content by modified date
To sort the content by modify date, you must append '&sortByModifiedDate=true' or '&smd=true' with '&ful=1' or '&fulldetails=1' to the RSS link. For example, append '&smd=true&ful=1' to the link of the RSS feed
Include Status of the content
To include the status of the content, you must append '&includeStatus=true' or '&ins=true' in with '&ful=1' or '&fulldetails=1' to the RSS link, which will add one more tag in the RSS feed
For example, append 'includeStatus=true&ful=1' to the link of the RSS feed
Include Archive content in the RSS feed
To include archived content, you must append '&includeArchived=true' or '&ina=true' in with '&ful=1' or '&fulldetails=1' to the RSS link.
For example, append '&includeArchived=true&ful=1' to the link of the RSS feed
Changes to the latest version of the RSS:
Below is a list of the changes implemented with the latest version of the RSS. (June 2023)
1. Remove the < last.ModifiedDate> Thu, 25 Aug 2022 08:28:23 +0200< /LastModifiedDate> as both are no longer needed. < lastBuildDate>will suffice:
2. Type="text/html" contentLength="5" is no longer needed within link tags:
3. Author name is now included within brackets as well as the email address:
4. Replace & to a "&" within any URLs/links (as it gets converted to & in the RSS process):
5. Enclose tag is only required for mp3 or video and therefore is removed for anything other than those types. Additionally the medium="image" OriginalImage="true" are no longer required and have been removed:

Exporting content via an API

As of the September 2023 release you can now retrieve content through APIs instead of relying solely on RSS feeds. This will empower developers with comprehensive access to the necessary content elements for effective integration. This is available via Swagger documentation by adding "/showSwaggerUI.action" to your instance URL: e.g. https://example.com /showSwaggerUI.action

This article applies to:

  • PRODUCT: HighQ,HighQ
  • Sub Product: HighQ Publisher
  • Subject: Clients

Related Content