DOCROOT

The DOCROOT element specifies a path to static resources provided in the deployment path of an application or web service.

Syntax

<DOCROOT>path</DOCROOT>
  1. The path specifies a directory or a subdirectory in the deployment path of an application or web service.

Child elements

There are no child elements.

Usage

You use this element to specify a path to static resources. The static files can be fetched using a specific URL:
  • Applications: 
    http[s]://host:port/ua/web[/group-name]/xcf-file/filename
  • Web services: 
    http[s]://host:port/ws/web[/group-name]/xcf-file/filename

Access to the DOCROOT resources will be verified by the GAS via the ACCESS_CONTROL element at runtime.

Usage example in application configuration file myapp.xcf

# ... myapp.xcf
<EXECUTION>
   <DOCROOT>$(res.deployment.path)/myapp/doc</DOCROOT>
   <PATH>$(res.deployment.path)/myapp</PATH>
   <MODULE>myapp.42m</MODULE>
   <ACCESS_CONTROL>
      <ALLOW_FROM>$(res.access.control)</ALLOW_FROM>
    </ACCESS_CONTROL>
</EXECUTION>
#...
In this usage example, if you have the myHelpFile.pdf file in the /myapp/doc directory, the following URL provides access to the file:
http[s]://host:port/ua/web[/group-name]/myapp/myHelpFile.pdf

Parent elements

This element is a child of EXECUTION (for application) and EXECUTION (for service).