AssetNow NX System Setting Parameters
AssetNow system settings are stored in XML format in the assetnow-xml.cfm
file located in the /sys/config/
directory.
Values from in the configuration file are loaded in the application scope when the site starts or is reset.
Use the System > Tools > Setup tool to change setup configuration parameters. At a minimum you should change the site e-mail addresses and site name parameter. After making changes click the Save button for changes to be applied and saved in the configuration file.
The parameters are grouped under 6 tabs:
1. General
| Parameter | Description |
|---|---|
| SITE_URL | Primary site URL/IP address including protocol. Can be changed at any time without affecting AssetNow NX generated links. Examples: http://www.mysite.com
or https://mysite.com
or http://206.67.60.194 |
| SITE_NAME | Site name used in page metadata. This text is appended to page titles and appears in the web browser title bar. Typically it will be the name of the site or company. |
| SITE_COPYRIGHT | Text used by the site copyright widget, typically the name of site content owner/company. |
| DEFAULT_COUNTRY_ID | Default country set in forms. Available for developers using the AssetNow NX countries table. |
| ALLOW_FILE_TYPES | Comma delimited list of asset file types that publishers may upload. |
| MAX_ASSET_FILE_SIZE | Maximum asset file size publishers are allowed to upload. |
| ALLOW_IMAGE_TYPES | Comma delimited list of image file types that publishers may upload. |
| MAX_IMAGE_FILE_SIZE | Maximum image file size publishers are allowed to upload. |
| CONTENT_REVIEW_DAYS | Number of days ahead of content creation date when item must be reviewed |
2. Email
AssetNow NX caters for a number of mail password options including the mail server and individual e-mail accounts. you should set passwords as required by your server setup or host provider. Increasingly host providers require that you specify a password for the mail account your are sending from.
| Parameter | Description |
|---|---|
| MAIL_SERVER | URL/IP address of the mail server used by ColdFusion MX. |
| MAIL_SERVER_USERNAME | Username if required by mail server when sending mail from AssetNow NX via ColdFusion MX. |
| MAIL_SERVER_PASSWORD | Password if required by mail server when sending mail from AssetNow NX via ColdFusion MX. |
| MAIL_POP_SERVER | URL/IP address of the pop mail server where the EMAIL_NO_REPLY mailbox is located. |
| EMAIL_ADMIN | Site Administrator e-mail address. E-mails for certain actions such as licenses will be sent to this address. |
| EMAIL_ADMIN_PASSWORD | Password for above account if required. |
| EMAIL_APPROVAL | Reply ("From") E-mail address used in approval request e-mails. |
| EMAIL_APPROVAL_PASSWORD | Password for above account if required. |
| EMAIL_CONTACT | Reply ("From") E-mail address available for developers as a general web site contact e-mail address. The default contact form uses this address as the Reply ("From") address when sending confirmation messages. |
| EMAIL_CONTACT_PASSWORD | Password for above account if required. |
| EMAIL_INFO | E-mail address available for developers for web site information related messages. |
| EMAIL_INFO_PASSWORD | Password for above account if required. |
| EMAIL_SUPPORT | E-mail address available for developers for web site support related messages. |
| EMAIL_SUPPORT_PASSWORD | Password for above account if required. |
| EMAIL_USER | Reply ("From") E-mail address available for developers for web site user account related messages. |
| EMAIL_USER_PASSWORD | Password for above account if required. |
| EMAIL_ERROR | Reply ("From") E-mail address used in error notification e-mails. AssetNow NX limits the number of error e-mails to a maximum of 10 (all errors are logged), the site must be reset to re-enable error e-mails. If the EMAIL_ERROR address is the same as the EMAIL_NO_REPLY address no error notifications are sent. |
| EMAIL_ERROR_PASSWORD | Password for above account if required. |
| EMAIL_NO_REPLY | Reply ("From") E-mail address available for developers for web site messages that should not be replied to. The Lists/Newsletters module uses this account to send mail-outs and check for bounced/returned email. The Lists tool deletes all messages in this mail box after checking it. |
| EMAIL_NO_REPLY_PASSWORD | Password for above account if required. Typically this password is required since Lists module access the mailbox via the POP mail server. |
3. Settings
| Parameter | Description |
|---|---|
| CACHE_CONTENT | Enable caching of content (categories, pages and download files). Categories and pages can be excluded from caching. Cached content is significantly faster and places much less loading on the server. Generally most content can be cached. Developers can use no-cache widgets to exclude dynamic content elements contained in a page template from caching and have them processed when the page is rendered. |
| REMOVE_WHITESPACE | Removes white space left by ColdFusion MX after processing templates. Generally you should enable the white space management option available in the ColdFusion MX administrator in which case you do not need to enable this setting. Some service providers do not enable the ColdFusion server white space management in which case you can use this setting to remove white space. Removing white space will result in smaller page file size and hence faster loading and reduced bandwidth. Leading white space can also cause problems with XML files. |
| EXECUTE_CFML | Global enable/disable of in-page ColdFusion script processing. |
| SYSTEM_NOTIFICATIONS | Enable/Disable sending of automated error notifications |
4. Advanced
| Parameter | Description |
|---|---|
| ALLOW_DISPLAY_TYPES | Comma delimited list of custom output formats. Remove any formats that you do not wish to provide. Developers can add custom types with custom output handlers. Each display type must be associated with template handler. Add xhtml to serve xhtml content to browsers that support the application/xhtml+xml media type. Add rss to support RSS feeds. |
| DISALLOW_CFML_TAGS | Comma delimited list of ColdFusion tags that can not be used in in-page scripting. |
| SUPPORTED_LOCALES | Comma delimited list of locales supported in the site. Locales must correspond with valid ISO 639 locales (see table above and Section 5). The first locale in the list is the default locale. |
| SUPPORTED_VERITY_LANGUAGES | Comma delimited list of Verity languages available on the ColdFusion MX server (see table opposite). Each language must correspond with a language in the SUPPORTED_LOCALES parameter. |
| SERVER_TIME_OFFSET_MINUTES | Positive or negative offset of the server time with respect to your preferred “local” time. For example if your main offices are located in New Zealand and your site is hosted on a server in the United States you can offset the server time so that the site operates on New Zealand time. This primarily affects scheduled content where you want content changes to occur with respect to local time. The local, server, and schedule (offset server time) time is displayed in the left panel of the Start screen in tools mode |
| FEED_DELAY_MINUTES | Delay before new content items and feedback comment postings are added to content feeds. |
| DOWNLOAD_TIME_MINUTES | Time to retain temporary file downloads directories and files after last download request. |
| SITE_RESET_CODE | Custom code that can be used to reset the site via the url. Example: http://www.mysite.com/index.cfm?reset=XXX where XXX = SITE_RESET_CODE. |
| ENCRYPT_KEY | Random alphanumeric string used to encrypt data such as the cookie used to store login details. Simply change the string periodically to invalidate any cookies. |
| DATE_FORMAT | |
| TIME_FORMAT | Format of time stamps applied using ColdFusion mask format. Default is HH:mm:ss. |
| PASSWORD_FORMAT | Mask for AssetNow generated passwords used when creating user accounts where n = number (excludes 1), a = alphabetic character (excludes a,e,i,o,u,l), and x = any character. Default mask is xxxxxx. |
| INDEXING_TIMEOUT_SECONDS | Request timeout for Verity search indexing. If indexing persistently times out then try extending this interval. |
| DSN | ColdFusion Data Source Name (DSN) used to connect to the AssetNow NX database. |
| DSN_USERNAME | Optional username for DSN. |
| DSN_PASSWORD | Optional password for DSN. |
5. Applets
| Parameter | Description |
|---|---|
| XS_WEB_SERVICES_URL | The licensed url for the web services used by the AssetNow NX XHTML editor. Normally the url will be the same as the primary domain licensed for AssetNow NX. You can confirm the url by opening the XStandard XHTML editor license.txt
file located in the /sys/config/xs/
directory with a text editor. |
| XS_WEB_SERVICES_SPELLCHECKER | The URL of the XStandard spellchecker web service. If you install the spellchecker web service on your own server use the appropriate URL, otherwise you can use the XStandard web service located at http://soap.xstandard.com/spellchecker.aspx |
| XS_VERSION | Version of the XStandard XHTML editor. If you receive an update for the editor you will be advised if this parameter must be changed accordingly. |
| XS_OPTIONS | Numeric value used to as a bit mask to set specific XStandard XHTML editor options. The value is the sum of the value associated with each option. Consult the XStandard developer documentation for details. |
| XS_CUSTOM_INLINE_ELEMENTS | Specify custom inline elements for XStandard editor. See XStandard API documentation. |
| XS_CUSTOM_BLOCK_ELEMENTS | Specify custom block elements for XStandard editor. See XStandard API documentation. |
| XS_CUSTOM_EMPTY_ELEMENTS | Specify custom empty elements for XStandard editor. See XStandard API documentation. |
| XS_CUSTOM_NAMESPACES | Specify custom namespaces elements for XStandard editor. See XStandard API documentation. |
| XS_RELATIONSHIP | Specify relationships (Rel) to make available for hyperlinks XStandard editor. See XStandard API documentation. |
| XS_REVERSE_RELATIONSHIP | Specify reverse relationships (Rev) to make available for hyperlinks XStandard editor. See XStandard API documentation. |
| JUPLOAD_USERNAME | Optional www-authentication
username sent by upload applet to server. Usually this is not required and left empty. Consult the javaZOOM jClientUpload applet documentation
for details. |
| JUPLOAD_PASSWORD | Optional www-authentication
password sent by upload applet to server. Usually this is not required and left empty. |
6. Analytics
| Parameter | Description |
|---|---|
| ENABLE_METRICS | Enable / Disable visitor tracking and measurement. If you have very high traffic and/or use a 3rd party analytics solution you should disable tracking as it places an additional load on the server. |
| TRACK_OUTBOUND_LINKS | Enable tracking of outbound links. This may affect search optimization since outbound tracking uses a redirect. |
| BROWSER_IDENTIFIERS | Keywords used to identify web browsers. The keywords are match with the cgi.http_user_agent
parameter from the web server. |
| SEARCH_IDENTIFIERS | Keywords used to identify search engine agents (robots, "bots", crawlers etc.). |
| FEED_IDENTIFIERS | Keywords used to identify feed agents. |
| CUSTOM_IDENTIFIERS | Keywords used to identify custom agents. |
| UNKNOWN_IDENTIFIERS | Keywords used to identify any agents you do not recognize. |
| EXCLUDE_IP_ADDRESSES | Comma-delimited list of IP addresses which will be excluded from tracking. |
| DENY_IP_ADDRESSES | Comma-delimited list of IP addresses that will not be allowed to access the site. They will be served with a "404 Not Found" response. |
| DENY_REFERER_KEYWORDS | If these keywords are found in the cgi.http_referer
the agent will be denied access and served with a "403 Forbidden" response. Used to exclude comment spam. REFERER is spelt incorrectly so that it the same as the official cgi specifications. |
7. Custom
| Parameter | Description |
|---|---|
| TOOLS_START_URL | Optionally specify url of page to load in main workspace frame of tools when displaying the Tools > Start
screen. Default shows the site homepage, you could also display a hidden category of user information, user guide, style guide etc. For internal links use shortform urls as for the default: /anlink/1,1,0,0,html |
| SITEMAP_VERIFY_CODE | AssetNow can generate a XML sitemap file used by major search engines to index your site. Specify the site map verification code (currently required by Google) here. this will be added to the page metadata. for more information see the Google Sitemap information and site maps protocol information at sitemaps.org |
| GOOGLE_TRACKER_CODE | If you are using Google Analytics
add your Google tracker code here. the code will be used by the AssetNow NX googletracker
widget which inserts the required javascript on the page. |
| CUSTOM_VARS | Comma delimited list of custom variables and values that will be set in the application.config
scope. Variable names are prefixed with CUSTOM_VAR_. Example adding variables myvar1=22,myvar2=54
will result in variables application.config.CUSTOM_VAR_MYVAR1
and application.config.CUSTOM_VAR_MYVAR2
being created with values of 22
and 54
respectively. |
Additional Configuration Parameters
In addition to the above configuration parameters which can be changed using the System > Tools > Setup tool, there are parameters specified in the assetnow-xml.cfm
file that can only be changed by editing the file. Typically these parameters do not need to be changed.
| Parameter | Description |
|---|---|
| SITE_GENERATOR | AssetNow NX version, for example AssetNow NX 5.0.0. You should change this value if you upgrade your AssetNow NX version. |
| MAILER_ID | Default is the AssetNow NX version however you may change this if mailouts are consistently caught in spam filters. |
| SESSION_REFRESH_SECONDS | Refresh period used to maintain Tools session, set to 60 seconds. You should not change this value. |
| ENCODING | Site page enconding, set to UTF-8. We strongly recommended that you do not change this and always use Unicode UTF-8 encoding. |
| SESSION_TIME_MINUTES | ColdFusion session time, default is 20 minutes. You should set this value to match the session time set for your ColdFusion server or if you have changed the session timeout value set in the AssetNow NX Application.cfc
template. |
| COMMITTED_VISIT_SECONDS | Number of seconds after which a visitor is deemed as committed. Default is 90 seconds, the appropriate value depends on the type of site and content. |
| REPEAT_VISITOR_DAYS | Number of days during which a visitor who comes back to the site is treated as a repeat visitor. The default is 30 days. |
| DURATION_SEGENT_SECONDS | Visitors time on the site is measured in segments of equal duration. Default is 30 seconds per segment. |
| CLICKSTREAM_MAX_PAGES | Maximum number of successive pages to measure. Default is 20 pages. |
Links Referenced
- XStandard developer documentation
- http://www.xstandard.com/en/documentation/
- XStandard API documentation
- http://www.xstandard.com/en/documentation/xstandard-dev-guide/api/
- XStandard API documentation
- http://www.xstandard.com/en/documentation/xstandard-dev-guide/api/
- XStandard API documentation
- http://www.xstandard.com/en/documentation/xstandard-dev-guide/api/
- XStandard API documentation
- http://www.xstandard.com/en/documentation/xstandard-dev-guide/api/
- XStandard API documentation
- http://www.xstandard.com/en/documentation/xstandard-dev-guide/api/
- XStandard API documentation
- http://www.xstandard.com/en/documentation/xstandard-dev-guide/api/
- javaZOOM jClientUpload applet documentation
- http://www.javazoom.net/applets/jclientupload/documentation/index.html
- Google Sitemap information
- https://www.google.com/webmasters/tools/docs/en/protocol.html
- site maps protocol information at sitemaps.org
- http://www.sitemaps.org/protocol.html
- Google Analytics
- http://www.google.com/analytics/
Location
http://www.assetnow.com/index.cfm/1,84,278,0,html
Copyright © Orbital Limited 2008
