Webtags: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
1,032 bytes added ,  12:15, 25 September 2022
m
Line 51: Line 51:


The local API methods are described on [[Cumulus_MX_Local_API|their own page]].
The local API methods are described on [[Cumulus_MX_Local_API|their own page]].
== General Format for Web Tags ==
Before using the Webtags, the user must be aware of the formatting.
In the position, in any file to be processed, SQL, or HTTP POST call, where Cumulus is to insert the relevant data, place a web tag in the '''general format''' specified here: 
  <code><#tag_name [optional input selection parameters] [optional output modification parameters]></code>
Only the [[Cumulus_MX_Local_API#General_API_-_HTTP_GET|GET method]] has another format and does  not accept modifiers.
The terminology "optional" is used because some tag names do not accept any parameters, but there are some tag names where a parameter is mandatory. Therefore, check the [[Webtags/Parameters|web tag parameters]] page to learn whether a webtag name requires a mandatory parameter, or to find out which parameters are optionally available.
There is a basic guide to what these parameters can do, and another link to the new page at [[#Input Modification Parameters and Output Modification Parameters]] later on this page.


== Processing files ==
== Processing files ==
Line 57: Line 71:
The configuration should look like the screenshot below:
The configuration should look like the screenshot below:
[[File:Extra Webfiles config.jpg|center]]
[[File:Extra Webfiles config.jpg|center]]




Navigation menu