Configuration and management

Settings

Sync URL is the URL to mfn.se and should, in most cases, be https://feed.mfn.se/v1. This URL is used by the plugin to retrieve historical news that has been published on MFN or other news wires. It a used when an admin clicks on Sync Latest or Sync All.

Hub URL is the URL to MFN's WebSub Hub and should, in most cases, be https://feed.mfn.se/v1. This URL is used by the plugin to talk to the WebSub Hub in order to setup a HTTP posthook subscription for the plugin. This in order to let MFN push news when published into the Wordpress application.

Plugin URL is the globally accessible URL to the plugin. It is important that /wp-content/plugins/mfn-wp-plugin/posthook.php is accessible from the Internet, since this php-file accepts and stores news being pushed from MFN into the Wordpress database. The plugin should however point to the base path of the plugin, eg. http://your-site.com/wp-content/plugins/mfn-wp-plugin.

Entity Id is a UUID that refers to a specific company news feed in MFN. This ID will be given to you by your contact at Modular Finance on request.

Custom Query is an experimental field used in certain cases, but shouldn't normally be used.

Rewrite settings makes it possible to change the name of the custom post type mfn_news as well as the archive name and singular name. Once saving the changes these settings will apply directly to the URL.

Disable archive if checked, the news archive will no longer be reachable. (Could be useful if you want to prevent users from reaching the archive URL).

Verify Signature is an option that is up to the user. Each press release sent from MFN is cryptographically signed in order for the receiver to be able to verify that it was indeed the sent from MFN. If this setting is turned on, any news items with a bad signature will be dropped.

Use WPML will make the plugin compliant with https://wpml.org locale management.

Use Polylang will make the plugin compliant with https://polylang.pro locale management.

Reset Cache if checked, on every new item insert this will reset the database cache.

Status

In the status section you'll find five different parameters which is a result of:

Subscription Id appears once the plugin has successfully subscribed via https://feed.mfn.se/v1through a posthook. A subscription Id appears once you've clicked the "Subscribe"-button. The Subscription Id is a sensitive credential, and should not be shared. With this id you can alter or end a subscription at MFN.

Posthook Secret is generated when you click "Subscribe". It is random string which is used to verify messages from MFN as described in the Verify Signature section above. It is used as a HMAC key in accordance to the w3 WebSub specification https://www.w3.org/TR/websub/. The Posthook Secret is a sensitive credential which will give you rights to post content to the posthook. It should not be shared. Malicious actors could masquerade as MFN and sign any data with valid signatures before sending it to the WP plugin.

Posthook Name is generated when you click "Subscribe". It's a random string which is used as a token for posting messages to the plugin. Any call to the posthook must have this token included. Otherwise the call will be discarded.

Plugin URL is information about the Plugin URL added in the setting section. It should say Valid.

Hub URL is the information about the Hub URL added in the settings section. It should say Valid.

Actions

There are two Sync actions:

  1. Sync Latest will sync the 10 most recently published items from MFN to the Wordpress site. This syncing function disregards what newswire who sent the item.

  2. Sync All will sync all the news items from MFN for the Entity ID. This syncing function disregards what newswire who sent the item.

You can use this functionality multiple times. The WP posts that are added to the database will not be overwritten, but terms associated with the item will.

The Subscribe function will register the WP plugins posthook with the WebSub hub, https://feed.mfn.se/v1. If it is successful the Subscription Id in the status section will become visible. It is important here that your Plugin URL is valid and that posthook.php is accessible from the Internet in order for it to work.

Last updated