1,635
edits
Webtags: Difference between revisions
m
→Using Webtags
m (→Using Webtags) |
|||
| Line 67: | Line 67: | ||
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]]. | ||
== How CumulusMX handles unknown Webtags == | == 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. | |||
=== How CumulusMX handles unknown Webtags === | |||
When CumulusMX is processing through tag names and finds one it cannot understand, a "*** web tag error - see MXdiags file ***" message will appear in the engine console (if running interactively, when running as a service it will be in the ''ServiceConsoleLog'' file), and the diagnostic file will include something like this: | When CumulusMX is processing through tag names and finds one it cannot understand, a "*** web tag error - see MXdiags file ***" message will appear in the engine console (if running interactively, when running as a service it will be in the ''ServiceConsoleLog'' file), and the diagnostic file will include something like this: | ||
| Line 78: | Line 89: | ||
If you are sure the Webtag does exist (Check the [[Webtags#The_local_List|Local List]]) and you think you are correctly using parameters, it is time to bring the problem to the forum. | If you are sure the Webtag does exist (Check the [[Webtags#The_local_List|Local List]]) and you think you are correctly using parameters, it is time to bring the problem to the forum. | ||
== Processing files == | == Processing files == | ||