Custom Redirects

You are here: Administrators Reference > Site Administration > Static Content Generation > Miscellaneous > Custom Redirects

Custom Redirects

It is possible to code your own “Redirect” files (the static files placed in the static directory for files that are dynamic). You may want to write your own redirect file if:

You want to change the message/javascript processing contained in the default redirect.

You want to take advantage of server-side scripting languages like JSP or ASP to handle redirects instead of sending them to the client.

To create a custom redirect file, simply place a redirect-custom.cfm file in the root of your site. You will have the following attributes variables available to your custom redirect:

Attributes.params - (a structure with the following keys).

RedirectSize – the maximum size of the redirect file (if your redirect file is over this limit, pages using the redirect will appear in the Validate Static Content report as having File Size Inconsistencies)

SupressDocTypeAndComments – (default = 0) if you want to put out your own DocType and Comments then you can set this to 1.

DynamicURL – the value for the dynamic URL to the page (where your redirect should “redirect” to)

IncludeURLParams – any URL parameters that were passed to the redirect page.

Your redirect-custom.cfm module will be called when any page is updated or its static state changes, causing the static redirect file to need updating. Your module will be called via <CFMODULE> and it should output the HTML you wish to be stored in the redirect file.

For example, the default redirect module does the following:

</head>

<body><br/>If this page does not automatically refresh, please click

<!--

rUrl = "#attributes.dynamicURL#";

// -->

</script>

</body></html>

</CFOUTPUT>

Related Links

You can download PDF versions of the Content Contributor's, Administrator's, and Elements Reference documents from the support section of paperthin.com (requires login).

The following guides are available locally on your CommonSpot Server:

You can also download these other guides from the support section of paperthin.com (with login):

For technical support:

http://www.paperthin.com/support/