Differences

This shows you the differences between two versions of the page.

--- syntax:functions:metadata [2020/07/06 07:10] – created dmitry
+++ syntax:functions:metadata [2021/09/15 14:19] (current) – craigt
@@ Line 1: / Line 1: @@
 ====== Metadata(keyword) ======
+Category:  Special function
-Returns project metadata. They keyword must be a text constant (case-insensitive). References to a field or parameter are not allowed.
+\\
+=====Description=====
+This function returns project metadata - specific details about the project. The keyword must be one of the text constants shown below.
-Currently supported keywords:
+\\
-^  Keyword  ^  Result  ^
+=====Arguments=====
-| current module  |The name of the current module. |
+^Argument^Type^Description^
-| current block   |The name of the current block (tab). |
+|'current module'|Text|The name of the current module.|
-| current table   |The name of the current table. |
+|'current group'|Text|The name of the current table group (tab).|
+|'current table'|Text|The name of the current table.|
+**Return value type:** Text
-**Example**
+\\
-^  Example  ^  Result  ^
+=====Remarks=====
-| metadata('current module')  |Default |
+The text constants are case-insensitive (i.e., both 'Current Module' and 'current module' are acceptable).
-**See also**
+References to a field or parameter are not permitted.
+\\
+=====Examples=====
+{{:transformations:metadata_sample.jpg?800|}}
+\\
+**Refer to the image above for the examples below.**
+\\ \\
+  metadata('current module')  //Returns 'Main'
+  metadata('current group')  //Returns 'Sample'
+  metadata('current table')  //Returns 'Counties_population'
+\\
+=====See also=====
+  * [[syntax:functions:system|System(keyword)]]
-  * [[syntax:functions:system]]