NATS4 Configuration Admin
From TMM Wiki
Jump to navigationJump to searchThe NATS4 configuration admin works in conjunction with the NATS configuration file, allowing clients a great deal of flexibility in customizing their NATS. The configuration file is stored in the NATS directory on your server as includes/config.php.
Several tabs let you find configuration options:
- The Home options are the primary NATS settings. Some options can't be edited; if you need these options changed, please submit a ticket.
- The Security options configure who can access secure areas of your NATS program. Be careful editing these settings, as you can easily lock yourself out.
- The Fraud options allow you to set a point-based system that records suspicious activity by affiliates.
- The Billers options set security options relating to billers, as well as biller-specific configurations.
- The Third Party options contain polling options related to your third party providers.
- The Email options tell NATS when to send emails. NATS only sends email if you enter a subject in any of the fields.
- The Affiliates options set affiliate defaults, requirements, postbacks, and other various affiliate settings.
- The Currency options change the exchange rate or how currency is displayed.
- The Cronjobs options change how NATS does scheduled tasks.
- The Logging options change what NATS logs.
- The Display options set default displays for various areas in NATS.
- The Surfer options set tracking options, as well as signup form settings.
- The Notifications options contain settings for ignoring admin notifications.
- The Postback options allow you to further configure postback actions.
- The Misc options contain additional settings that do not fit into the other categories.
Configuration Options
The following is a breakdown of categories and sub-categories that you can find your configuration admin settings in.
You'll find the following settings in the NATS Configuration Admin.
Home
The Configuration Admin's "Home" section contains settings that base settings that apply to your NATS install. The important settings in this section include:
- Project - Allows you to configure the name of your NATS install, as well as domain and time zone.
- PROJECT_NAME / NICE_NAME - Used on various NATS templates to print the name of your NATS. For example: NICE_NAME is used to name the news section on members.php. You can change these to anything.
- TMM_PRODUCT_CODE - Identifies your system for the automatic license update. Do not change this unless TMM tells you to.
- PROJECT_HOSTNAME - Your program's domain. If you change this, you should setup an Apache virtual host for the hold value so that your old links continue to work. Warning: setting this to a bad value will break NATS.
- Period Configuration - Change how long pay periods are, as well as payout delays and if you automatically store payments.
- PAYOUT_PERIOD - Sets which days start a Period. At the end of a period, NATS makes a payment dump. The value can be days of the month (e.x 1, 16, or 30) or days of the week (w1 is Monday, w2 is Tuesday, etc...). The default pay periods are 1-15, and 16-end of month. This means that your pay periods will begin on the 1st and the 16th of each month. If you want this value changed, please contact support.
- PAYOUT_DELAYED - Tells the system the number of pay periods to wait for before generating a payment dump. The default value is 0. If you want this value changed, please contact support.
- PAYOUT_AUTOSTORE - Stores payments immediately after they are formed. This prevents you from needing to manually store payments, so you can always see what needs to be paid to your affiliates.
- Database settings - Configure essential information for your MySQL database, such as server, username, password, etc.
Security
- Admin IPs - A comma separated list of IPs that are allowed to access the admin area. This is separate from/in addition to the restrictions based on affiliate account type.
- Host Settings - Input the URL of your secure host.
- SECURE_RETURN_HOST - The domain that will be used by billers when they redirect surfers back to nats. Not all billers support this feature.
- Data Encryption - Choose whether you want to protect certain data by using encryption.
- Document Upload - sets restrictions on uploading certain extension types, as well as what IPs can upload documents.
Fraud
- Detection Settings - Choose if you want to enable fraud detection and set point values for certain activity.
Billers
- General Settings - Set security options and enable member expiration padding.
- MEMBER_EXPIRE_PAD - The default member expiration padding is half (1/2) of a period length, to a maximum of 7 days.
- Biller-specific Settings - These settings may vary based on what billers are configured in your NATS install. Generic settings include using posts, automatic upgrades, expiration dates, allowed IPs, etc.
- ALLOW_CREATE_NEW_MEMBER_XXX - Allows nats to attempt to create a new member if the information sent by the biller does not match any current never joined member in NATS.
- XXX_AUTOMATIC_UPGRADES - Tells nats to remove the trial flag without notifying the biller when a member submits upgradeplus.php.
- XXX_POLL_BACKDAYS - When NATS polls for transactions, re-check this many extra days
- SET_EXPIRE_XXX_DATE - Determines the NATS expiration date of the member. This setting has four different options:
- NATS Set - based on the period length of the option in NATS.
- Biller Set - based only on the expiration date sent with the tranaction.
- Earliest - the earliest value of NATS set vs Biller Set
- Latest - the latest value of NATS set vs Biller Set
- NOTE: Regardless of this setting, If the biller sends an explicit 'cancel' or 'expire' post, that will be used.
- MEMBER_EXPIRE_PAD_XXX - Use the default member expiration padding for the selected biller (XXX).
- MEMBER_EXPIRE_PAD_XXX_DAYS - Pad all member expiration dates with this number of days for the selected biller (XXX).
- XXX_ALLOWED_IPS - Lists the ips that are allowed to submit transactions for the biller (XXX). This setting is not modifiable.
- XXX_ACTIVATE_MEMBER_ON_DEDUCTION_REVERSAL - If this biller supports deduction reversals (undoing a chargeback), choose if you want to reactivate members upon deduction reversal.
Additionally, there may be biller specific configuration options.
Third Party
- Third Party-specific settings - These settings may vary based on what third parties you have configured in NATS. Generic settings include allowing new members to be created by polling, and the number of days to poll in the past.
Emails
- General settings - Sets preferences for automatically sent emails.
- For more information, please see our NATS4 Email Configuration article.
Affiliates
- Signup - Configure settings that take place when affiliates sign up for your program.
- Account Changes - Set whether verification is required when affiliates change their account settings.
- Payment Settings - Sets requirements and limitations on affiliate payouts.
- FORCE_PV_MIN - If the affiliate's desired payout is less than your PayVia minimum, NATS will automatically use the PayVia minimum when storing payments.
- UPDATE_PV_MIN - If the affiliate's desired payout is less than your PayVia minimum, NATS will automatically change the affiliate's payout to the PayVia minimum.
- For the following four settings, your changes will only apply to the settings for new signups on the main display page, adtools page, stats page, and account page. In NATS version 4.0.74 or greater, there is an option to force this value to overwrite the current value for all affiliates.
- REQUIRE_PAYOUT_APPROVAL
- RESELLER_US_W9
- DEFAULT_PAYVIA
- AFFILIATE_JOIN_PAYMENT
- Tiers - Include or exclude certain statistics when counting tiered sales.
- Adtools - Enable or disable adtool date limitations.
- Link Codes - Choose if you want to use a default Program ID when none is selected.
- Postbacks - Allow affiliates to receive postbacks regarding member activity.
- Custom Flags - Add additional flags or fields for affiliates
- ADMIN_RESELLER_FLAG* adds a custom checkbox field for the affiliate. Once a value (value would be the name you want this field/flag to represent) is saved for this setting, you can find a new checkbox field in the Admin Affiliate Settings section in the Affiliates Admin.
- ADMIN_RESELLER SELECT* adds a custom textbox field for the affiliate. Once a value (value would be the name you want this field/flag to represent) is saved for this setting, you can find this setting in the Admin Affiliate Settings section in the Affiliates Admin.
- ADMIN_RESELLER_CONTACT* adds a custom textbox field for the affiliate. Once a value (value would be the name you want this field/flag to represent) is saved for this setting, it will be displayed on the affiliate signup and affiliate account details edit sections.
- Site Partner - Choose which transactions pay out to site partners.
- MAIN_DISPLAY - Sets display defaults for new affiliates.
- STATS_PAGE - Sets default views for affiliate stat pages.
- ADTOOLS_PAGE - Sets default Adtool views for affiliates.
- ACCOUNT_PAGE - Sets default views for the affiliate account page.
Currency Rates
Sets the currency exchange rates for common currencies. You may enter as many numbers after the decimal places as you want.
Warning: these rates do not auto update. If currency rates change, you must update them yourself.
- RATE_CAD_TO_USD is the Exchange Rate for Canadian dollars to USD (1 USD = X CAD)
- RATE_EUR_TO_USD is the Exchange Rate for Euros to USD (1 USD = X EUR)
- RATE_GBP_TO_USD is the Exchange Rate for British Pounds to USD (1 USD = X GBP)
- RATE_NOK_TO_USD is the Exchange Rate for Norwegian Kroner to USD (1 USD = X NOK)
- RATE_SEK_TO_USD is the Exchange Rate for Swedish Kronor to USD (1 USD = X SEK)
- RATE_DKK_TO_USD is the Exchange Rate for Danish Kroner to USD (1 USD = X DKK)
- RATE_CHF_TO_USD is the Exchange Rate for Swiss Francs to USD (1 USD = X CHF)
- RATE_JPY_TO_USD is the Exchange Rate for Japanese Yen to USD (1 USD = X JPY)
This is a subset of all the currencies available. You can set your basecurrency settings and settings for any currencies that you have already had transactions in under Currency-Used.
Cronjobs
- General Settings - Set how long you want to store certain actions, as well as how many times to retry failed postbacks.
- Standard Cron Runtimes - Set how often you want your crons to run.
- Biller Poll Runtimes - Set how often your biller polls run.
- Third Party Poll Runtimes - Set how often your third party polls run.
Logging
- Global Log Settings - Choose error logs are created, as well as their size.
- Global Logging - Decide what actions you want to be logged.
- Tracking Logging - Decide what tracking actions will be logged.
- Signup Logging - Decide what aspects of member signups will be logged.
- E-mail Logging - Decide what aspects of e-mails will be logged.
- Cronjob Logging - Decide what cronjob actions, as well as what biller actions, will be logged.
Display
- Template Settings - Choose what messages will be displayed on your pages.
- Admin Display - Choose what will be displayed in your admin reports.
- REPORTS_DELETED_PROGRAMS - Displays all deleted programs in NATS.
- REPORTS_DELETED_BILLERS - Displays all deleted billers in NATS.
- REPORTS_DELETED_SITES - Displays all deleted sites in NATS. All reports will not show the deleted sites data when this config setting is disabled. When you enable or disable this config, you must rebuild report summary under the "Cleanup Database -> Filter -> Report Summary Tables Only -> transaction_summary -> Rebuild Summary Data
- (In development) REPORTS_DELETED_TOURS - Displays all deleted tours in NATS. This config setting will not override REPORTS_DELETED_SITES setting. All reports will not show the deleted tours data when this config is disabled, when you enable or disable this config, you must rebuild report summary under the "Cleanup Database -> Filter -> Report Summary Tables Only -> transaction_summary -> Rebuild Summary Data
- REPORTS_DELETED_OPTIONS - Displays all deleted join options in NATS.
- Stats Settings - Change how manual sales are displayed, as well as global stats for adtools.
- Adtool Settings - Choose if or how you want to limit certain adtools.
- Error Display - Choose if you want to forgo your custom error page, or who you don't want to display it for.
- NATS Help Display - Choose if you want to disable any help boxes or tool tips on the Admin pages.
Surfer
- Cookie Settings - Set a cookie hostname, when it expires, and how long to keep cookies.
- Tracking - Choose a method of tracking surfer countries; each country tracking method requires supporting software to make it work.
- Signup Form - Set options for use on the NATS signup form, include member-related, gateway-related, and cascade-related settings.
- This section contains the options "MEMBER_GET_NEW_USERNAME" and "UNIQUE_MEMBER_NAMES". For more information on these configuration settings, please see the sections below:
MEMBER_GET_NEW_USERNAME
NATS can recommend new usernames to surfers if the name they select is already in use. Display these recommendations by adding the following code to your join template.
{if $vars.recommended}
The username you entered was taken, please try one of these.<br />
{foreach from=$vars.recommended item="usernameR"}
{$usernameR}
{/foreach}
{/if}
By default NATS generates four usernames. To disable these recommendations, set the MEMBER_GET_NEW_USERNAME configuration variable to 0 in your NATS configuration file, nats/config.php. If you change MEMBER_GET_NEW_USERNAME to any other number between one and 25, NATS generates that number of username recommendations.
UNIQUE_MEMBER_NAMES
This feature is available in versions >= NATS 4.0.69.1 and replaces UNIQUE_USERNAMES and XSELL_UNIQUE_USERNAMES Determines whether or not members on separate sites can have the same username (members on the same site can never have the same username) There are 9 options
- 0 Only unique within site -- this is the default setting in NATS.
- 1 Unique across all sites -- NATS checks all sites for this username, instead of just the current site.
- 2 Xsells -- Only Xsell members must be unique across all sites. Members joining through the nats join form need only be unique within their site
- 3 Join Form -- Only members using the NATS join form must be unique across all sites. Members joining through an xsell need only be unique within their site
- 4 Join Form (allow matching emails), Xsells -- A member using the join form can join a second site if both the usernames and emails match. If just the username matches, it is not allowed. Members joining as an xsell MUST have a unique username.
- 5 Xsells (allow matching emails), Join Form -- A member joining as an xsell can join a second site if both the usernames and emails match. If just the username matches, it is not allowed. Members joining on the join form MUST have a unique username.
- 6 Join Form (allow matching emails) -- A member using the join form can join a second site if both the usernames and emails match. If just the username matches, it is not allowed. Members joining as an xsell need only be unique within their site.
- 7 Xsells (allow matching emails) -- A member joining as an xsell can join a second site if both the usernames and emails match. If just the username matches, it is not allowed. Members joining on the join form need only be unique within their site
- 8 Join form and Xsells (both allow matching emails) -- A member using the join form can join a second site if both the usernames and emails match. A member joining as an xsell can join a second site if both the usernames and emails match. If just the username matches, it is not allowed.
ATVOD Verification
ATVOD Verification allows you to set up the Authority for Television On Demand feature within NATS. For more information about these settings, please read the ATVOD Verification Process article.
Notification
This sections allows you to ignore admin notifications for specific error categories. You can also choose what admin username(s) these notifications are sent to:
- SUPPORT_RECIPIENTS_QUESTION - The comma separated list of admin usernames that will receive Question support messages from affiliates.
- SUPPORT_RECIPIENTS_PROBLEM - The comma separated list of admin usernames that will receive Problem support messages from affiliates.
- SUPPORT_RECIPIENTS_SUGGESTION - The comma separated list of admin usernames that will receive Suggestion support messages from affiliates.
Postback
- Global Postback Settings - Set an alternate response for failed or successful postbacks.
- Admin Postback - Set a URL and a time delay to post all admin actions.
- Affiliate Account Postback - Set URLs to post affiliate signups and account changes to. You can also set time delays for these postbacks.
- Member Account Postback - Set a time delay for postback URLs that were set in the Sites Admin.
Misc
- General Settings - Set options that do not fit neatly into the other configuration categories, such as creating popups for severe notifications, automatic logins, limiting the recording of surfer stats, etc.
