Differences

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

--- engine:import:extract [2020/03/12 02:08] – [Syntax] Scott Cunliffe
+++ engine:import:extract [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 7: / Line 7: @@
 ===== Syntax ====
 ''Extract(field, offset, length, record);''
-//string field;//\\
-//Integer offset;//\\
-//Integer length;//\\
-//Integer record;//\\
 ^ Variable ^ Type ^ Description ^ Min Length ^ Max Length ^ Min Value ^ Max Value ^
-|field| String | The field to be set by this extraction.|1|128||
+|field| String | The field to be set by this extraction.|1|128| | |
 |offset| Integer | The zero based offset of the data to be extract, or the element index of a CSV element or SQL element. In the event that the data being processed is CSV based, a value of zero indicates that the raw CSV string should be extracted rather than an individual CSV element.|1|10|-214748364 |2147483647|
-|length| Integer| The length of the data to be extracted if the data is text based, or the maximum data length for CSV or SQL data.||1|10|-214748364 |2147483647|
+|length| Integer| The length of the data to be extracted if the data is text based, or the maximum data length for CSV or SQL data.|1|10|-214748364 |2147483647|
-|record| Integer|The record within a header, if the value is non-zero and the data is text based. A record that is not a header if the value is zero and the data is text based. For CSV and SQL data this argument is ignored.||1|10|-214748364 |2147483647|
+|record| Integer|The record within a header, if the value is non-zero and the data is text based. A record that is not a header if the value is zero and the data is text based. For CSV and SQL data this argument is ignored.|1|10|-214748364 |2147483647|
-==== Example ====
+===== Example =====
-**Extract: Extract VOLUME field from offset 10, length 6 of the body of a report.**
+Extract VOLUME field from offset 10, length 6 of the body of a report.
-|Extract(VOLUME, 10, 6, 0);|
+<code>
+Extract(VOLUME, 10, 6, 0);
+</code>
+Extract VOLUME field from the 2nd element of a CSV file.
+<code>
+SetCSVDelimiter(",");
+Extract(VOLUME, 2, 6, 0);
+</code>
-**Extract: Extract VOLUME field from the 2nd element of a CSV file.**
+Extract REPOSITORY field from offset 70, length 4 of the 3rd record of a header.
-|SetCSVDelimiter(",");|
+<code>
-|Extract(VOLUME, 2, 6, 0);|
+Extract(REPOSITORY, 70, 4, 3);
+</code>
+===== See Also =====
-**Extract: Extract REPOSITORY field from offset 70, length 4 of the 3rd record of a header.**
+[[engine:import|Import Engine Functions]] \\
-|Extract(REPOSITORY, 70, 4, 3);|
+[[cli:sync_fields|Sync Engine Fields]] \\
+[[cli:tmss10sync|TMSS10Sync]]
 {{tag> import_engine sync_engine}}