Difference between revisions of "Register All Scripts"
From ADF Docs
Gcronkright (talk | contribs) |
Gcronkright (talk | contribs) |
||
| (29 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
=== Register ADF Scripts as CommonSpot Resources === | === Register ADF Scripts as CommonSpot Resources === | ||
| − | Once the [[ADF_Installation|ADF has been installed]] or [[Upgrade_Guide_v2.0|upgraded]] and the [[Reset ADF|ADF Reset]], register the ADF 2. | + | Once the [[ADF_Installation|ADF has been installed]] or [[Upgrade_Guide_v2.0|upgraded]] and the [[Reset ADF|ADF Reset]], register the ADF 2.x ThirdParty Scripts as Resources in CommonSpot 10.x by using the following URL parameters: |
| − | * To register ALL of the ADF 2. | + | '''WARNING:''' This tool should only be used on Authoring or Standalone CommonSpot servers. |
| + | |||
| + | * To register '''ALL''' of the ADF 2.x ThirdParty Scripts for the first time use: | ||
** http://{commonspot-site}/?configADF=1 | ** http://{commonspot-site}/?configADF=1 | ||
''(Any existing ADF scripts/resources will be skipped.)'' | ''(Any existing ADF scripts/resources will be skipped.)'' | ||
| − | * To update/re-register ALL the existing resources ADF 2. | + | * To update/re-register '''ALL''' the existing resources ADF 2.x ThirdParty Scripts use: |
** http://{commonspot-site}/?reconfigADF=1 | ** http://{commonspot-site}/?reconfigADF=1 | ||
''(Any missing ADF scripts/resources will also be added.)'' | ''(Any missing ADF scripts/resources will also be added.)'' | ||
| − | * To only register (or re-register) a minimal set ThirdParty Scripts use these: | + | * To only register (or re-register) a '''minimal''' set ThirdParty Scripts use these: |
** http://{commonspot-site}/?configADF=1&scriptsPackage=min | ** http://{commonspot-site}/?configADF=1&scriptsPackage=min | ||
** http://{commonspot-site}/?reconfigADF=1&scriptsPackage=min | ** http://{commonspot-site}/?reconfigADF=1&scriptsPackage=min | ||
| Line 25: | Line 27: | ||
* ADFLightbox | * ADFLightbox | ||
| − | Note: For compatibility with | + | '''Note:''' For compatibility with the ADF's Custom Fields, Custom Scripts, Datasheet Modules and any additional ADF Apps that maybe installed on your site, it is recommended to register '''All''' resources. |
| − | + | ||
| + | |||
| + | ==== Additional Resource Registration URL Parameters ==== | ||
| + | |||
| + | In addition to the 'configADF', 'reconfigADF' and the 'scriptsPackage' url parameters (discussed above), as of ADF 2.6 and above you can also utilize the following additional url parameters for controlling the ADF Script registration process. | ||
| + | |||
| + | * '''preserveAliases''' (true or false) - 'true' (default) - set to 'false' to allow resource Alias names to be updated as configured in the /ADF/lib/scripts/data/1.0/allScripts.cfm json data file or use 'true' to NOT change any alias names currently assigned to existing resources. | ||
| + | * '''useExternal''' (true or false) - 'false' (default) - set to 'true' for to use external/CDN resources (uses local if CDN url is not configured) | ||
| + | * '''loadingType''' (early or late) - 'late' default - set to 'early' to load javascript resources at the top of the page | ||
| + | * '''useLegacyEarlyJs''' (true or false) - 'false' (default) - set to 'true' to load jQuery and jQueryUI at the top of the page for backwards compantiblity with ealry loading and in-line jquery script blocks | ||
| + | * '''groupList''' (a list or single group name) - Group names assigned in the AllScripts.cfm data file. | ||
| + | * '''aliasList''' (a list or single resource or alias name) - Resource or alias names assigned in the AllScripts.cfm data file. | ||
| + | |||
| + | <!-- * scriptsSource (local or external) - 'local' (default) for /ADF/thirdParty resources or 'external' for CDN resources (uses local if CDN is not configured) --> | ||
| + | |||
| + | Examples: | ||
| + | http://{commonspot-site}/?reconfigADF=1&preserveAliases=true&useExternal=true | ||
| + | http://{commonspot-site}/?reconfigADF=1&preserveAliases=true&useExternal=true&aliasList=jquery | ||
==== ADF Scripts Developer Info ==== | ==== ADF Scripts Developer Info ==== | ||
| − | For more information regarding the registration of ADF 2. | + | For more information regarding the registration of ADF 2.x ThirdParty Scripts as Resources in CommonSpot 10.x, please review the [[ADF Scripts 2.0 Developer Info]] |
'''IMPORTANT:''' The ADF thirdParty scripts libraries will not function when using ADF.scripts_2_0 loadScripts calls unless | '''IMPORTANT:''' The ADF thirdParty scripts libraries will not function when using ADF.scripts_2_0 loadScripts calls unless | ||
| Line 35: | Line 54: | ||
<!-- | <!-- | ||
| − | For more information regarding the registration of ADF 2. | + | For more information regarding the registration of ADF 2.x ThirdParty Scripts as Resources in CommonSpot 10.x, please refer to the README information in the "/lib/scripts/scripts_2_0_READ_ME.txt" file. |
---> | ---> | ||
<!-- | <!-- | ||
| − | To help register the ADF 2. | + | To help register the ADF 2.x Scripts as CommonSpot 10.x resources a couple of URL parameters can be used. |
*http://{commonspot-site}/?configADF=1 | *http://{commonspot-site}/?configADF=1 | ||
| − | **Use to register ADF 2. | + | **Use to register ADF 2.x ThirdParty Scripts for the first time. Any existing resources will be skipped. |
*http://{commonspot-site}/?reconfiglADF=1 | *http://{commonspot-site}/?reconfiglADF=1 | ||
| − | **Use to update/re-register existing the ADF 2. | + | **Use to update/re-register existing the ADF 2.x ThirdParty Scripts. |
*http://{commonspot-site}/?configADF=1&scriptsPackage=min or http://{commonspot-site}/?reconfigADF=1&scriptsPackage=min | *http://{commonspot-site}/?configADF=1&scriptsPackage=min or http://{commonspot-site}/?reconfigADF=1&scriptsPackage=min | ||
| Line 52: | Line 71: | ||
Remember: You must be logged in to the CommonSpot site for these parameters to run. | Remember: You must be logged in to the CommonSpot site for these parameters to run. | ||
| − | For more information regarding the registration of ADF 2. | + | For more information regarding the registration of ADF 2.x ThirdParty Scripts as Resources in CommonSpot 10.x, please review the [[ADF Scripts 2.0 Developer Info]] |
--> | --> | ||
| + | |||
| + | '''WARNING:''' This tool should only be used on Authoring or Standalone CommonSpot servers. | ||
[[Category: How-to Guide]][[Category: CommonSpot Registered Resources]] | [[Category: How-to Guide]][[Category: CommonSpot Registered Resources]] | ||
Latest revision as of 16:19, 25 October 2022
Register ADF Scripts as CommonSpot Resources
Once the ADF has been installed or upgraded and the ADF Reset, register the ADF 2.x ThirdParty Scripts as Resources in CommonSpot 10.x by using the following URL parameters:
WARNING: This tool should only be used on Authoring or Standalone CommonSpot servers.
- To register ALL of the ADF 2.x ThirdParty Scripts for the first time use:
(Any existing ADF scripts/resources will be skipped.)
- To update/re-register ALL the existing resources ADF 2.x ThirdParty Scripts use:
(Any missing ADF scripts/resources will also be added.)
- To only register (or re-register) a minimal set ThirdParty Scripts use these:
Remember: You must be logged in to the CommonSpot site for these parameters to run.
The minimal set of ThirdParty Scripts includes:
- jQuery
- jQueryMigrate
- jQueryUI
- jQueryMobile
- Bootstrap
- ADFLightbox
Note: For compatibility with the ADF's Custom Fields, Custom Scripts, Datasheet Modules and any additional ADF Apps that maybe installed on your site, it is recommended to register All resources.
Additional Resource Registration URL Parameters
In addition to the 'configADF', 'reconfigADF' and the 'scriptsPackage' url parameters (discussed above), as of ADF 2.6 and above you can also utilize the following additional url parameters for controlling the ADF Script registration process.
- preserveAliases (true or false) - 'true' (default) - set to 'false' to allow resource Alias names to be updated as configured in the /ADF/lib/scripts/data/1.0/allScripts.cfm json data file or use 'true' to NOT change any alias names currently assigned to existing resources.
- useExternal (true or false) - 'false' (default) - set to 'true' for to use external/CDN resources (uses local if CDN url is not configured)
- loadingType (early or late) - 'late' default - set to 'early' to load javascript resources at the top of the page
- useLegacyEarlyJs (true or false) - 'false' (default) - set to 'true' to load jQuery and jQueryUI at the top of the page for backwards compantiblity with ealry loading and in-line jquery script blocks
- groupList (a list or single group name) - Group names assigned in the AllScripts.cfm data file.
- aliasList (a list or single resource or alias name) - Resource or alias names assigned in the AllScripts.cfm data file.
Examples: http://{commonspot-site}/?reconfigADF=1&preserveAliases=true&useExternal=true http://{commonspot-site}/?reconfigADF=1&preserveAliases=true&useExternal=true&aliasList=jquery
ADF Scripts Developer Info
For more information regarding the registration of ADF 2.x ThirdParty Scripts as Resources in CommonSpot 10.x, please review the ADF Scripts 2.0 Developer Info
IMPORTANT: The ADF thirdParty scripts libraries will not function when using ADF.scripts_2_0 loadScripts calls unless they are registered as Resources in CommonSpot 10.x.
WARNING: This tool should only be used on Authoring or Standalone CommonSpot servers.
