Custom Script Element

You are here: Elements Reference > Miscellaneous Elements > Custom Script Elements > Custom Script Element

Custom Script Element

After selecting Custom Script from the Miscellaneous Elements section of the Element Gallery dialog, click “Click here to define the Custom Script Element” or click the Element Tool icon and select Edit to open the Custom Script Element dialog.

Use this dialog to select the ColdFusion module to render and choose a caching option for the Element. The module must already reside on your site or in the subsite's /customcf directory. Use Tools - File Upload from the CommonSpot top-level menu as described in the CommonSpot Contributor's Reference.

Properties Tab

Note: When adding a ColdFusion module, the file name cannot include spaces.

There are two options for specifying a CFM module to be rendered.

Existing CFM Modules list box - Contains all of the existing ColdFusion modules within the current subsite and all of its parents and grandparents. Only CFM modules within the customcf directory are displayed. More information on creating ColdFusion modules is within the CommonSpot Developer's Guide.

Explicit Module - Name an existing ColdFusion module. When explicitly specifying a module outside the current subsite scope, you must specify both the logical and physical paths for the ColdFusion module. The logical path is based on your ColdFusion or HTTP server mappings, while the physical path is the full path of the module on the server machine.
Static Content - If checked, the content included within the custom ColdFusion module is static in nature. If it is static, CommonSpot can cache the output appropriately, which optimizes the rendering of the content.

Parameters tab

Use this tab to enter variable name-value pairs that CommonSpot passes to the ColdFusion module using the attributes scope. Enter one name-value pair per line. CommonSpot spaces these values exactly as entered; if you include quotes around the values, the quotes are passed along with the value.

custom script element parameters tab

Dependencies Tab

Only after the custom script has been selected and save, will you see the Depenencies Tab.You can automatically load resources and libraries required by custom modules once you register them in CommonSpot. This field displays any registered resources loaded by your custom script. See Site Administration - Resources and Libraries.

Click Save to save your settings and return to the page.

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 from the support site and are in the /docs/directory of 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/