Release Guide

This document provides instructions for how to use the new features in the 2024.5 release, grouped by module. Remember to install & test in your test system before Production.

  • There is an important API change which will affect anyone using the Swagger page and also using Basic Authentication (Authentication with a username and a secret).

  • For those using the InDesign extension, there is a new version available. 2.2.6 is available now which includes two small fixes. Please request the version by putting in a support ticket.

  • In Classified order entry, we use a component called TinyMCE for the text editing window. That component has been upgraded to a new version, so it may look a little different to users. We went from v4 to v7, so it was a big jump.

  • We have a new optional add-on to Naviga Plan that will automatically update the Tearsheet URL in Naviga Ad. Previously we were only able to offer this to InDesign or NCS Content users.

  • We are working on a new version of the Nylas integration to work with the new API version that Nylas recently released. It isn't going to be ready in time for the 2024.5 initial release, but it will be patched to 2024.5. Once ready, we will add documentation here and we expect to work individually with sites already using Nylas today to transition them to the new version.

Advertising Module

New Version of Text Editor image-text

With the 2024.5 upgrade users will notice a slight difference in the UI of the text editor. Earlier versions look like this:

And in 2024.5 and later, it will look like this:

Some notable differences that may or may not be obvious:

OLD Editor
NEW Editor
Comment

What used to be "Formats" in the first row is now "Paragraph" in the second.

Admins can create HTML Code Blocks in the system to allow users to shortcut certain frequently used formats. The old icon in the top row has been replaced with one that looks like a rubber stamp in the 2nd row. The template screen itself is also a little different, with a nice filter/search bar at the top to easily find a template if you have a large library:

The line spacing work has been replaced with an icon. When setting up your templates, the line-height settings can now be more specific. For example, in previous versions you could go from line-height .95 (or 95%) and then 1.0 (or 100%), but nothing in between. Now you can use .96, .97, .98 or .99 to really fine tune the spacing between lines. Same with sizes > 100% you can increase/decrease in smaller increments.

The bullets and numbered lists dropdowns have been replaced with a more visual depiction of what the list will look like.

General, Advanced and Upload choices are at the left now rather than the top, and on the advanced tab, the "Style" box where someone could manually manipulate the style by adding code is gone. (Not sure if that was ever used anyway.)

Clicking on the image in the text editor gives options for rotating, flipping, editing, etc. Same functions are still there, but the icons look a little different.

And finally, my favorite of the new text editor - while the zoom looks exactly the same as it always has, it is now sticky. So if you have old eyes like me and always find yourself zooming in to better view the text - it will remember your last setting next time you come in. (yay!)

Complete documentation on all the buttons and what they do is available here.

Buy X Get One Free image-text

There is a new rate option which will allow you to offer a free (or reduced) ad when qualifying rules are met.

Couple of important caveats to understand:

  • This is a rate - not a discount, so it doesn't trigger any approvals for adjustments

  • This only considers ads within a single order line and not across the entire campaign (Use incentives for looking at the entire campaign). This means if you are splitting lines, the rule will be considered only when the order is first created - once the line has been split, they are then separate lines, and no longer a single order line. You'll be able to open qualifier lines for editing, but if you open the free one, you will lose your BOGO and will need to add a manual adjustment to set it back to free.

  • On the issue date of the free/reduced ad - there will be no (or less) revenue for this ad for that issue date. The more accurate approach accounting-wise is to use an incentive, which distributes an adjustment across all the issues.

  • This is only for Print! (meaning Liners and Display ads only) - it is not applicable for Inserts, Digital or Newsletter type ads.

  • The qualifiers much be satisfied before the reduced day can be given. For example, if I must buy a Monday and Wednesday and get Tuesday for free, then Monday and Wednesday must both come first and then the following Tuesday can be free.

Setup on the Ratecard

There is a new tab on Ratecard setup - Buy-One-Get-One Setup

Enable BOGO Rules - Set this to Yes to use the BOGO

BOGO Qualifiers - items on this side set the qualifying rules

  • Issue Count - how many paid issues are required to then get a free one. In the above example, two days must be paid before a free one can be earned.

  • Issue Days that Count - This is a dropdown of days of the week. Select which (if any) purchased days are required. In the above example, Day of week isn't relevant to the BOGO - I must purchase 2 days and then will get one day free - any day is fine.

  • Repeat Max Times - how many times can this be repeated? In the example above there are 2 - so I will buy 2 get one, buy another two get another one, but if I buy two more, I don't get a third free one.

  • Days Threshold - this shows how many day's I have to complete a BOGO cycle. In the example above, I have three days. So if I buy Sunday and Monday, I can get Tuesday or Wednesday for Free, but not Thursday. In this case Sunday would be the first qualifying date and then I have three days to complete the cycle.

BOGO Application - items in this side displays what you get for the free ad.

  • Issue Days that can be reduced - this is a day of week dropdown where you can select which day of the week is allowed to be free (or reduced)

  • Rate reduction percent - for a free ad, this will be 100, for a reduced ad this will be something less than 100. This number must be a whole number between 0 and 100.

Here is an example of the above BOGO:

Note - all the other tabs on the rate setup are applicable first, and then the BOGO gets evaluated - so you will notice above that Sunday got the Sunday rate, and Monday got the Monday rate - so other rating rules still applied.

Quick Line Entry

When using a BOGO rate in Quick Line Entry, the BOGO will be evaluated when the line is saved. So when you are in the QLE window, it may not look like it is getting the free one:

but once it is saved, it will be there:

The reason for that is because there are a lot of changes that a user could be making to those lines within the QLE window - for example, I could change the size, the section/position, could move an issue date to something out of sequential order - it isn't until the order is saved that the system evaluates all the lines together and determines which lines belong on one saved line and which are actually separate order lines - so that is when the BOGO can be evaluated.

Import Change to QLE in this version even if you don't use the BOGO!

When the QLE window is saved onto individual order lines, the system looks at all the QLE lines and evaluates them to determine which ones to consolidate. It looks at the Product, the Ratecard/RateLine IDs, the Line Description, the Section/Position, the Ad Type, the Layout ID, and the size.

In 2024.4 and earlier, it evaluated the price as well (Ratecard Rate and Adjusted rate). So if you had an ad running for several days and Sunday was one price and Monday/Tuesday was a different price, then that would end up as different lines on the campaign.

Price will no longer be a factor when creating Print lines from QLE, so the example above where Sunday was $1440, Monday was 480 and then Tuesday was 0 - even created in QLE that would all be the same line.

Option to place rep info on Campaign Setup tab

On the Advertising Setup screen (Setup -> Admin -> System Parameters) there are a couple of new options related to display of the rep assignment. Previously Brand Rep was an option, and now the Original and the Order Sales Rep have also been added.

You can select all or any of the above to display them on the Campaign setup tab rather than the Other Information tab.

Alternate Product Name

This has actually been in the system since 2024.1 - but I missed it! I think it is a great new field that others might want to take advantage of, so I thought it was worth calling out, even though it is a little late!

The alternate Product Name gives you the ability to have the Product Name be more of an internally friendly name, while having the Invoices, Statements, etc use a more client-friendly alternate name.

The tag #ALT_PRODUCT_NAME# has been added to the following templates in the system:

  • Campaign Confirmations (including those sent from the actual campaign, AND the template for the Print Order Portal Display Templates)

  • Advertising Affidavits

  • Campaign Invoices

  • Classified Self-Service Templates

For Statements, in keeping with the other naming conventions with in the Invoice Details section, the tag will be #IN_ALT_PRODUCT_NAME#

In the Material Approval Templates, it is #FIRSTALTPRODUCTNAME# which is also in keeping with other naming conventions for the approval email, since the same material could be for orders in multiple products.

Merge/Purge Brands recorded in History of Changes

When there are duplicate brands or brands that are no longer needed the function Merge/Purge Brands can be used to consolidate them:

That merging process, previously, was not stored on the History of changes in Name Maintenance window. That is now recorded:

Option to limit Client Types on initial Account Creation image-text

When first creating a client account (in Advertising Module or in CRM), the client type selected will set certain defaults according to setup in Client Type Defaults.

As such, it might be desirable to limit the Client Type Defaults which can be chosen when the account is created. This is set as a new Group Security Option under Advertising (Other Settings)

If it is desirable to limit to certain client types, select them from the left column and use the arrows to move them to right. If none are selected, then all client types will be available.

This is only for new account creation. If a user has access to full name maintenance, they would later be able to select a different client type. This also does not affect the clients that a user can see and use for order creation or CRM (use Access Codes for that function) - this mod is really about limiting the selection list only during account creation to prevent user error in setting the proper defaults.

Sort Order now available on Classified packages image-text

The list of classified packages will now default to an Alpha sort according to the name of the package.

If it is desired to put that in a specific order other than Alpha order, then a numeric sort code can be added in Package Setup:

Support for Tax Overrides by Product image-text

In the Tax Setup there is a section for override by Publication. This was originally for the Classic version of Naviga Ad. We have now allowed for use with Digital First as well. Please see tax setup for full details on the function. Please note that this is supported for Performance Campaigns, but since invoicing of Flexible campaigns is decoupled from the individual products on the campaign, it isn't supported for Flexible Campaigns. Flexible Campaigns will utilize the overrides for Product Group.

GAM Campaign Line Name Format

There is a new format available in Setup -> Admin -> Ad Server Integration Setup,

Navigate to the Connection Setup node and select your ad server from the dropdown.

Item # 14 - Campaign Line Name Format - has a new option which now includes the following - [Advertiser Name] - [Product Group] - [Ratecard ID] - [Line ID]

When an ad comes into GAM, the naming concatenates these 4 fields. Below Underwater World is the Advertiser, Customer Demo is the Product Group, 18 is the Ratecard ID, and 7213 is the Line ID on the Campaign.

New Dimension option in Size setup

There is a new "Custom Creative Template" option in Size setup

Users will also see Custom Creative Template available on the material. Having it also on the size allows for instances where the material itself is not being entered in Naviga at all. This allows for the size to alert GAM that this is a custom creative template type of ad, even when there is no material linked to the Naviga Line.

Suppress Brand option on the New/Lost Advertiser Report

There is a new option on the New/Lost Advertisers report. Navigate to Analysis -> Advertiser Reports -> New/Lost Advertisers

By default, the Suppress Brand will be deselected and there will be a brand column displayed. Then for each individual brand, the system will consider if they ran/did not run between the dates selected in the report settings.

If suppress brand is selected to yes, then the brand column will disappear from the screen and the report will look across all brands for that advertiser to determine if the advertiser ran / did not run between the dates selected in the report settings.

Other Production Reports to display preview

By popular demand, the "Preview of final" option that has been available on the Print Production report for a long time has now been added to the other Production Reports - Production by Product Group, Production by Product (non-print), Production by Controller, and Production by Sales Rep

With digital ads, there is often more than one material per order line. This preview will only show the first material found. To see other materials, the user is advised to click the line ID to see all materials for this order. Alternatively, user can click on each material ID if the material id column is selected for view.

To show the preview, navigate to the "Configure Output" tab and move it from the left column to the right column using the arrows between the columns. This column is only relevant for onscreen viewing and isn't included on the export.

Update Page Numbers in an Issue Report image-text

On this report a user can update the Page Number, the Tearsheet URL and the Ad Headline. If you are using Naviga Plan, Plan will auto-update the Page Number. Also, if you are using the new Tearsheet URL add on to Plan, then the Tearsheet URL will also be auto-updated at the same time the Page number is updated.

The new feature on this report relates to Spaceholder, or Parent-Child type ads (also called Ganged ads). With Spaceholder ads, the parent ad is what goes to pagination, and the child ads get the invoices. Since Naviga Plan does not know about the Child Ads, Plan can't auto-update those.

Going forward, when Plan adds the page number (and possibly also the tearsheet), then Naviga Ad will copy them to the children linked to that parent ad.

If you are manually updating page number, there is a new option at the top of the screen where the user can choose if they want their manual updates to affect the children or just the parent.

Selecting "Assign Parent and Children Data Separately" will result in children being displayed as their own lines in the grid. User will be able to independently assign page numbers to parents and children.

Selecting "Apply Parent data to Children" will result in only the parent ads being displayed (and non-spaceholder type ads). Whatever page number is applied to the parent will also be copied to the children, thus saving the user time.

New Fields on Orders by Product

The orders by product report now displays the Billing contact and their email address. These new fields are available for both onscreen viewing and for download.

Millimeters field added to Material Record

There is a new display field on the material record:

Millimeters has always been supported on the order record and, functionally, worked fine thru to the material creation and layout in Plan, but when viewing the material record, the number of millimeters was displayed in the Centimeters or inches field. This could be confusing to users, so we have added a separate millimeters field.

Edition report to allow multi-select editions

The Editions dropdown on the Editions Report will now allow for a select all and/or selecting multiple individual editions:

Navigate to Analysis -> Campaign Reports -> Editions Report to access this report.

Classified Self-Service

PDF On-Screen preview image-text

In the Classified Self Service approval process the user has always been able to see a preview of the ad (jpg) on-screen as well as a link to download the pdf. There is a new option now to see the pdf in an on-screen preview rather than downloading and then opening if it was desired to see the pdf.

Clicking on the blue "View Press-Ready PDF" link and a popup will display the pdf of the ad:

In addition, there is a pdf icon on the list view of ads to be approved which will give this same pop-up preview.

Disable Login and Account Creation image-text

In Classified Portal Profile setup (Campaigns -> Classified Self-Serve -> Self-Serve Setup) there is a new option to not allow clients to create an account or login.

If this is set to yes, all the campaigns booked through the classified portal will come into Naviga Ad under the Private Party dummy account selected for the Portal Profile. (Selected under "Advertiser" in Order Defaults Section)

The Login link on the start page will be hidden, and the popup at the end of the booking process that allows them to create an account will be suppressed as well.

Accounts Receivable

Importing Currency Rates image-text

Support has been added for importing updates to foreign currency rates. If you plan to use this feature, please put in a support ticket so that Naviga personnel can enable the Windows Service for Currency Rates in your environment. It will not be enabled by default.

Navigate to the A/R Module -> Setup -> Admin -> A/R System Setup. there is a new section on that screen called "Import Currency Rates FTP"

Important information is displayed at the top of the section.

  • The service is looking for a very specific filename: CurrencyRates.csv

  • This is a very simple file structure - 2 columns

    • First Column is the ID for the currency (This does not create new currencies and therefore must match what you set up already in your Currency Setup)

    • Second Column is the Exchange Rate

here is an example: Whether or not there is a heading line is up to you. If the B column does not contain a numeric value, the row will be ignored.

Once successfully imported, the .csv file will be removed from the FTP.

Enter the following information into the setup:

  1. FTP Host/Server name: Yours may be different from what is displayed in the example. Don't forget to include the ftps:// at he beginning and the :port number at the end. (or ftp: or sftp: depending on your protocol)

  2. FTP Username: Enter your username here

  3. FTP Password: Enter your password here

  4. Test FTP Connection Credentials: Press the button to ensure the system can successfully connect to the ftp ***

  5. Folder Path: Enter desired path where you plan to upload the file.

*** See A/R Setup for additional info and screenshots of potential errors you might see if you enter invalid information here

Couple of new statement merge tags available image-text

#IN_AD_STOP_DATE_1#

The #IN_AD_STOP_DATE# tag always shows a date range for the run dates, even if it is a single date. The _1 version will show a range when there are multiple dates, but a single date if the start and stop are the same. Here is an example using #IN_AD_STOP_DATE_1#:

Here is the same statement with the first column using the #IN_AD_STOP_DATE# merge tag:

#BILLING_STAGES#

This formatting might be really client specific, but on Flex Campaigns this will display (Inv x of y) so you can alert that it is invoice 1 of 1 or 2 of 4, etc. If the invoice is performance, this will just be blank.

New Parameter on Statements

There is a new parameter on statements called "Include Detail for Credits Applied in Current Period"

This parameter is useful when sending Balance Forward statements so that older invoices, which typically wouldn't display in the invoice details section, WILL show details if there is a credit applied in the current period.

If this option is NOT selected, the balance forward statement may look like this:

The above statement has an unpaid invoice from a past month, so I just see the balance as a balance forward amount.

Here is that same statement WITH the option selected:

This statement is for November activity, but since there was a credit of $40.00 applied to the October invoice, the details of that invoice are displayed here.

Audit History of Payments

Scroll to the bottom of the payment details screen and user will see the audit history of who did what to the payment.

In this example, the payment was received, then applied to an invoice, then unapplies, then transferred to a different account, and then applied to invoices on that account.

Advertiser Portal

This mod affects pay links throughout the system, so in both A/R and in Advertising, but only relevant if you use the advertiser portal, so documenting it here. There will now be a filter applied to the selection dropdown for profile on a pay link based on the product group the order / invoice is for.

In the above example, the selected invoices are for the "Demo Group" and for the "ABC" Product Groups. Therefore in the dropdown only lists profiles that include both groups (or have no group filter)

If you select invoices for too many product groups and the system cannot find an appropriate profile which includes all these groups, then the error will appear as follows:

The user will then need to deselect some invoices and possibly send separate pay links for the different profiles (or an admin needs to edit the profile to include more product groups, if appropriate)

In Previous releases we displayed when a pay link was sent in the Credit Control Notes. We now also include who sent it.

General/System Settings

When using our API, and specifically the Swagger page, there are a couple of different ways you could potentially authenticate, depending on how you are set up.

The default, simplest way, is an API Key. If you have this enabled, logging into the swagger page will look like this:

Your naviga implementation specialist will set your unique API Key for you, and you can read and write from the API with this key. For these users, there is no change when upgrading to 2024.5.

Most live customers who are actively using the API will use Basic Authentication, where you (or Naviga on your behalf) can set up various API users with Read or Write access, and will have a secret generated which is unique to each API user. This allows for more control and security so you can give different rights to different systems and can easily disable one API user's access without affecting other API users. With Basic Authentication turned on, you have traditionally seen this (in versions prior to 2024.5), where you enter the API username and the API secret at the top of the Swagger page:

Beginning with 2024.5, we have added support to OAuth 2.0 Authentication for one of our clients who requires it. With OAuth 2.0, the system will request authentication from some other authority and then return here. This has been tested with our client's authentication provider, but should be considered to be in BETA for all other customers. If you think you would like to turn it on, discuss with support/implementation and they can turn it on in test for you, but for most customers it should not yet be turned on in PROD.

Turning on OAuth 2.0 will affect everything that uses the API - so 3rd parties, Interface Link, and the Swagger page - so it is a big, disruptive change if you turn on OAuth 2.0.

Enabling the potential for OAuth 2.0 has necessitated a small change to the Swagger page for any sites with Basic Authentication enabled. So, even if you don't have OAuth 2.0 turned on, you will notice the username and secret are missing from the top of the page and instead the authentication is down with each API Endpoint. This only affects the Swagger page and does not affect accessing the API from other places (unless OAuth 2.0 is turned on). There is a red exclamation point with each API Endpoint. Click that to see the username and secret - enter the same user and secret here that you used to enter at the top of the page (in versions prior to 2024.5).

When OAuth 2.0 is enabled, this login popup will also include authentication button to go to your OAuth 2.0 provider like this (NOTE: This is an either/or option, Basic Auth can still be used):

Once Authenticated, the red exclamation point will become blue so the user can visualize that they are authenticated. Successful authentication either via OAuth or Basic Auth will apply the blue dot to ALL of the methods which match the user's rights to access/work the API. It only needs to be done once unless you need to auth for additional, lesser or expanded rights to the API method(s).:

Click on the blue exclamation and they can log out

Note to Naviga Personnel - There are settings you must set on behalf of the customer in System Settings, under the Platform Authentication section. Please see internal docs for setup info. Changes to the Platform Authentication will not take effect immediately. It will take effect after the regular nightly processes run.

New InDesign extension available

Two minor bugs were fixed in the latest InDesign Extension available. The latest is v2.2.6. Verstion number can be found in small print under the "My Queue" heading:

This version fixes the following

  • Small bug where login fails if the artist enters their login (email address) in all caps

  • Small bug where the label "pts" was next to the number of columns, but this is a count of columns and not meant to be a size, so the label was removed

It is ok to take this version even if you are not yet on 2024.5. Any 2024 version should be fine to use this extension version, though has only been internally tested on 2024.4 and 2024.5.

Please put in a support ticket if you are on an older extension and need this latest version.

Tearsheet URL add-on option image-text

As this is an add-on option, please log a support ticket or check in with your Naviga sales rep to get a quote to add it to your contract.

Naviga Plan (version 202136 and newer) can now be configured to auto-update the URL inside Naviga Ad with the location where the tearsheet will be output from the Content System.

Since Plan is saved before the final page is actually output from Editorial, the URL in Naviga ad will be a bit premature, but on the Client Portal, the Tearsheet won't be accessible until after the issue date has passed, so it shouldn't be obvious to any clients that the tearsheet URL is delivered to Naviga ad slightly sooner than necessary - but this then saves an extra manual step later for someone to have to remember to go back and update the URL.

Important parts of the configuration are as follows:

The above fields are in Plan Setup on the General -> Miscellaneous tab. Your plan implementation specialist will supply the data for the Access Key and Tearsheet URL Base. (Naviga Personnel - see internal documentation for details)

The exact Tearsheet URL Path will be unique to your site. If we are hosting the pages, this URL will be provided by Naviga Hosting. If you are hosting your own pages (or your content provider is hosting them) then you will need to know that URL. There are some fields available to provide additional subfolders beyond the base URL. In the above example [product] was added to the base URL and so plan will add the product ID to the URL updated into naviga ad. Additional supported fields can be found HERE in the "Folder Containing Ads" configuration.

The other important bit of configuration in Naviga Plan is on your template setup.

On the Page Set Setup, select the "Naming Pattern" appropriate for the name of the final pdf. If you aren't using Naming Patterns already, the patterns available in the dropdown are configured in Plan Setup, on the Naming Pattern tab.

This will need to be coordinated with the editorial folks who are outputting the pages and will be concatenated onto the end of the above tearsheet URL Path

The naming pattern will define what is displayed here on the page info:

What gets uploaded into Naviga ad will be the tearsheet URL Path + Output Name + .pdf

So using my example above, my tearsheet would be located at https://dem-pdftest.newscyclecloud.com/pdftest/NAV13/NAV13_10-18-24_A1.pdf (Note NAV13 is the product ID)


A couple years ago, we introduced the idea of a Customer Enhancement Portal, where you all get to add feature requests, look at feature requests submitted by others, add comments, and vote on things you would like to see us implement in the system. Items that were voted up in the Enhancement Portal will have this check mark next to the feature in the release guide. To date, over 80 items from the Enhancement Portal were implemented in Naviga Ad. Keep those ideas coming and be sure to vote up good ideas from others!

image-text Click on the Video Icon in the heading to be directed to the release video page. Topics that were included in the release video will display this icon. Use Ctrl-click (Cmd-click on mac) to open in a new tab and not lose your place in the release guide.

In 2023 we introduced a new learning subscription program called NavigaYou. Part of that program are some custom development hours. Any new features that were part of someone's NavigaYou will be highlighted as such with this icon. See WEBINAR for more info on NavigaYou

Last updated

Was this helpful?