Adds a new attachment to a Confluence page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| page-id* | text | the id of the page | ||
| filename* | text | the name of the attachment on the Confluence server | ||
| comment | text | the comment of the attachment on the Confluence server | ||
| content-type | text | application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | application/pdf | type of the file to be attached |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Adds a new comment to a Confluence page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| page-id* | text | the id of the page | ||
| content-type | text | application/json application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | application/json | type of the file to be attached |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Calls a Confluence REST API function.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | the name of the Confluence connection used | |||
| api-path* | the (relative) API path (e.g. /rest/api/content) | |||
| http-method | GET POST HEAD PUT DELETE PATCH | the HTTP method used (e.g. GET, POST) | ||
| content-type | text | application/json application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | type of the content | |
| result-type | zagreus json | json | the return type of the result (if the operation has a result) |
| Name | Type | Description |
|---|---|---|
| http_response_code | the HTTP response code received from the Confluence server |
| Name | Type | Possible Values | Description |
|---|
|
|
Defines a Confluence connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | name of the connection | ||
| url* | text | URL of the Confluence installation | ||
| token* | text | the authentication token. If it is an API token, the format is: "mailaddress:token" BASE64-encoded. For Personal Access Token, specify the token itself | ||
| pat | boolean | true | whether the token is a Personal Access Token. For Server installations, it needs to be set to true, otherwise, for Cloud installation set it to false | |
| proxy | text | the proxy definition in the following format: [user:password@]host[:port] | ||
| space | text | the space; the value specified here can be overridden in the individual actions | ||
| custom-date-format | text | yyyy-MM-dd'T'HH:mm:ss.SSSX | this attribute can override the assumed date formats from server side |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
|
|
Creates a new Confluence page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| space | text | the space for the created page; if not set, the one specified in the connection is used | ||
| title* | text | the title text of the created page | ||
| ancestor-id | text | the ID of the ancestor for the created page; if not set, the new page will be created in the root of the specified space | ||
| content-type | text | application/json application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | application/json | type of the file to be attached |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
Deletes a comment from a Confluence page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| comment-id* | text | the id of the comment |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Deletes a Confluence page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| page-id* | text | the id of the page |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Creates a new Confluence page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| space | text | the space for the created page; if not set, the one specified in the connection is used | ||
| page-title* | text | the title text of the created page | ||
| ancestor-id | text | the ID of the ancestor for the created page; if not set, the one ... | ||
| type | text | json zagreus | json | the result type |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Retrieves a Confluence page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| space | text | the space for the page (in case when the page-title is set); if not set, the one specified in the connection is used | ||
| content | boolean | true | if set, the content of the page is also retrieved |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | text | the ID of the page | |
| title | text | the title of the page | |
| version | number | the version of the page | |
| content | text | the type of the issue | |
| comments | number | the number of comments of the page | |
| attachments | number | the number of attachments of the page | |
| sub-pages | number | the number of sub-pages if the page |
|
|
Lists the attachments of a given page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| page-id* | text | the id of the page |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of comments retrieved |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | text | the ID of the attachment | |
| filename | text | the filename of the attachment | |
| content-type | text | the content type of the attachment (e.g. application/pdf) | |
| size | number | the file size of the attachment (in bytes) | |
| comment | text | the comment of the attachment | |
| creation-time | text | the time when the the comment of the attachment was created | |
| author-id | text | the user ID of the user who is the owner of the attachment | |
| author-name | text | the display name of the user who is the owner of the attachment (e.g. "John Smith") | |
| author-email | text | the e-mail address of the user who is the owner of the attachment. Due to GDPR restrictions affecting the Confluence installations, this might not be visible (depending on the actual setting of the user) | |
| web-link | text | the web link of the attachment | |
| download-link | text | the download link of the attachment |
|
|
|
|
Lists the comments of a given page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| page-id* | text | the id of the page |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of comments retrieved |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | text | the ID of the comment | |
| content | text | the content (i.e. text) of the comment | |
| creation-time | date | the time when the comment was created | |
| author-id | text | the user ID of the user who is the author of this comment | |
| author-name | text | the display name of the user who is the author of this comment (e.g. "John Smith") | |
| author-email | text | the e-mail address of the user who is the author of this comment. Due to GDPR restrictions affecting the Jira installations, this might not be visible (depending on the actual setting of the user) |
|
|
|
|
Lists all the pages of a space, or the sub-pages of a given page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| space | text | the space for the listed pages; if not set, the one specified in the connection is used. It is ignored if the page-id is set | ||
| page-id | text | the id of the parent page. If not set, all pages of the given space will be listed |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of comments retrieved |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | text | the ID of the page or sub-page | |
| title | text | the title of the page or sub-page | |
| status | text | the status of the page or sub-page | |
| ancestor-id | text | the ID of the ancestor page of the sub-page (if any) | |
| ancestor-title | text | the title of the ancestor page of the sub-page (if any) |
|
|
|
|
Refers to a parameter of the confluence:call action
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | name of the parameter | |||
| value | value of the parameter. Does not have to be URL-encoded |
|
|
Updates an existing comment in a Confluence page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| comment-id* | text | the id of the comment | ||
| content-type | text | application/json application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | application/json | type of the comment |
| append | boolean | false | if set to true, the content will be appended to the end of the original message |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Updates an existing Confluence page.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| space | text | the space for the updated page; if not set, the one specified in the connection is used | ||
| append | boolean | true | if set, the specified text will be appended to the existing content | |
| content-type | text | application/json application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | application/json | type of the file to be attached |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Begins a new sql transaction. The transaction can be interrupted with db:rollback action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection |
| Name | Type | Description |
|---|---|---|
| execution_time | number | Time interval while the action is executed. |
|
|
Executes a stored procedure specified by the procedure name.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | Name of the connection. If the called procedure has output arguments, these should be registered by the "param" action, and their value will be accessible via the result attributes of action. | ||
| dbms-output | boolean | false | If set to true, the output of the call will be put into the result attribute "dbms_output". Works only for Oracle-type DBMS. |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| dbms_output | text | the DBMS output |
| execution_time | number | Time interval while the action is executed. |
|
|
Closes the database connection. All the connections will be closed when execution is finished in the container where the connection is defined, but close action provides a way to close connections manually. The connection is reopened automatically when needed.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection |
| Name | Type | Description |
|---|---|---|
| execution_time | number | Time interval while the action is executed. |
|
|
Commits the current sql transaction.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection |
| Name | Type | Description |
|---|---|---|
| execution_time | number | Time interval while the action is executed. |
|
|
Defines a jdbc connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | name of the connection | ||
| domain* | text | domain name in the connection string | ||
| driver* | text | java class name of the jdbc driver | ||
| server* | text | SQL server name or address | ||
| port | number | port address of the SQL server | ||
| user | text | user name when authentication is needed | ||
| password | text | password for user authentication | ||
| cpassword | text | encrypted password for user authentication | ||
| database | text | name of the required database | ||
| connection-string | text | The jdbc connection string. If it is not specified, Zagreus builds the connection string from the connection data. This property allows expert users to override the generated value. Username and password attributes must be filled. Those parameters cannot be passed in connection-string. Oracle connection can be defined only by using attribute connection-string. | ||
| cstring | text | the same as connection-string | ||
| autocommit | true | If autocommit mode is enabled, each SQL statement forms a single transaction on its own. | ||
| null-value | The value which will be used instead of null values. | |||
| number-format | text | The numeric type result fields of the db:sql and db:execute actions will be formatted following the specified format. | ||
| date-format | text | The date type result fields of the db:sql and db:execute actions will be formatted following the specified format. | ||
| time-format | text | The time type result fields of the db:sql and db:execute actions will be formatted following the specified format. |
| Name | Type | Description |
|---|---|---|
| domain | text | domain name in the connection string |
| driver | text | java class name of the jdbc driver |
| server | text | SQL server name or address |
| port | number | port address of the SQL server |
| user | text | user name when authentication is needed |
| db | text | name of the required database |
| autocommit | boolean | If autocommit mode is enabled, each SQL statement forms a single transaction on its own. |
| null-value | The value which will be used instead of null values | |
| date-format | text | The format of the date type result fields applied in the db:sql and db:execute actions |
| time-format | text | The format of the time type result fields applied in the db:sql and db:execute actions |
| number-format | text | The format of the numeric type result fields applied in the db:sql and db:execute actions |
| execution_time | number | Time interval while the action is executed. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Inserts data rows into the specified table of the target connection. It can handle various source-data elements, like: db:sql, excel:read or z:parse.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the target connection | ||
| table* | text | Target table name. For SQL-Server, it is recommended to use SCHEMA.TABLE format. | ||
| replace-method | text | append delete truncate | append | The way how to handle existing data in the target table. "append": append all new rows to the existing ones. "delete": uses delete fromsql command to delete all existing rows before inserting new rows. "truncate": uses truncate table sql command to truncate table before inserting new rows. WARNING! In Oracle 'truncate table' cannot be used in transaction! |
| transaction | text | all delete insert | all | The way how to use transactions during deleting / inserting."all": applies transaction around deleting and inserting together."delete": applies transaction only for deleting."insert": applies transaction only for inserting. |
| execute | boolean | true | If the action actually executes the generated commands. If true, it is generating and executing the commands, otherwise it is only generating the commands. | |
| source-data | boolean | A custom child action. The result of the child db:sql action provides the data for the load action. The connection-name of the child db:sql action is the source-connection-name. |
| Name | Type | Description |
|---|---|---|
| deleted_rowcnt | number | number of rows deleted. Can be still 0 if replace-method was set to "truncate" |
| inserted_rowcnt | number | number of rows inserted |
| execution_time | number | Time interval while the action is executed. |
| Name | Type | Possible Values | Description |
|---|
|
|
Defines an odbc connection. NOTICE: ODBC connections are not supported in Java8! Please, use JDBC connection instead if Zagreus runs on Java8!
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | name of the connection | ||
| dsn* | text | ODBC Data Source Name | ||
| user | text | user name when authentication is needed | ||
| password | text | password for user authentication | ||
| cpassword | text | encrypted password for user authentication | ||
| database | text | name of the required database | ||
| autocommit | true | Autocommit | ||
| number-format | text | The numeric type result fields of the db:sql and db:execute actions will be formatted following the specified format. | ||
| date-format | text | The date type result fields of the db:sql and db:execute actions will be formatted following the specified format. | ||
| time-format | text | The time type result fields of the db:sql and db:execute actions will be formatted following the specified format. |
|
|
Set an input parameter for action "sql", or register an argument for stored procedure calling "call".
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| id* | text | the index of the output argument | ||
| type* | text | bit tinyint smallint integer bigint float real double numeric decimal char varchar longvarchar date time timestamp binary varbinary longvarbinary boolean blob clob | Type of the argument. | |
| name | text | Name of the variable that will store the argument. The arguments should be represented by a question-mark character in the calling sql expression. The index of the argument can be calculated by the number of the preceding output arguments in the calling expression, plus 1. The output argument will be accessible via the db:call action result attributes, using the specified name. The input arguments should be set without name specified. Some database server requires that the type of the output argument should be known, that are specified in the type attribute. |
|
|
Rolls back the current sql transaction.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection |
| Name | Type | Description |
|---|---|---|
| execution_time | number | Time interval while the action is executed. |
|
|
Executes an sql command or performs an sql query. It is possible to use the parameterized format, i.e. setting parameter values applying db:param actions. In this case binary contents also can be sent.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| log-sql | boolean | false | If set, the executed SQL command will be logged. |
| Name | Type | Description |
|---|---|---|
| executed_sql | text | the executed SQL command |
| rowcnt | number | number of resulted rows |
| execution_time | number | Time interval while the action is executed. |
|
|
Defines input source for the "workbook" action. The content of the action will be inserted into the generated xls resource. Inserting an exported MSTR report (via the "mstr:report" action) will insert the data into the Excel file along with the formatting (i.e. colors, bold or italic fonts, etc.).
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| sheet | text | Name of the Excel sheet to write. If this attribute is not specified, the system tries to use the result-attribute "resultname". If it does not exist, value "data" will be used. | ||
| row | number | the starting row position where to write | ||
| column | text | The starting column position where to write. Excel column notation is used, e.g. the first column is A. | ||
| header | boolean | true | if set to "true", the first row will contain the column names of the source | |
| reuse | The source sheet name from the template xls file. If the original sheet contained diagrams, they might be omitted from the new sheet, or they can still refer to the original sheet | |||
| formatting | boolean | true | if set to "true", cell formats will be modified according to the source style, otherwise the cell formats won't be changed | |
| location | text | body headerleft headercenter headerright footerleft footercenter footerright | body | target location on the sheet |
| rel-row | number | Offset for the starting row position. The new starting row position is calculated as the sum of the previous starting row position and the value set in the "rel-row" attribute. | ||
| rel-column | number | Offset for the starting column position. The new starting column position is calculated as the sum of the previous starting column position and the value set in the "rel-column" attribute. | ||
| column-width | number | Column width specification. Its format is a semicolon (;) separated list of column info, where column info describes the width of a column in characters. Column info has the format "columnname:width", width value can be "auto", meaning that the corresponding column width will be fit to the inserted content. It is possible to use more values (including "auto" keyword as well) separated by comma (,), specifying the widths of the following columns, allowing shorter expression form. Thus, "A:10;B:20;C:30;F:5" and "A:10,20,30;F:5" are equivalent, and "A:10,auto,auto;F:5" is also valid. | ||
| preservercolumnwidth | boolean | false | if set to "true", the width of the columns won't be changed | |
| protection | boolean | false | If set to "true", the cells of the target sheet will be read-only protected. Protection needs password or cpassword. | |
| password | text | Password for the protection. Using this password the sheet can be locked. | ||
| cpassword | text | Encrypted password for the protection. To generate encrypted passwords, use "Tools/Password converter..." in GUI. | ||
| header-format | text | Specifies the formatting parameters for the header part. It overrides the formatting settings from the source. | ||
| data-format | text | number-format font-name color font-size font-style:italic font-weight:bold background-color text-align:left/center/right vertical-align:top/middle/bottom border-style:solid border-style-top:solid border-style-bottom:solid border-style-left:solid border-style-right:solid border-color border-color-top border-color-bottom border-color-left border-color-right word-wrap | Specifies the formatting parameters for the body part. It overrides the formatting settings from the source. Multiple values can be used (separated by ";"). | |
| autodetect-types | boolean | true | If set to "true" data types will be detected automatically (number, date, etc.). If set to "false" everything will be handled as text. | |
| mstrcolumnheader | boolean | false | if set to "true", the MSTR column header will be displayed | |
| printarea | text | Sets the print area for the given sheet (in the standard format, e.g. "A4:E43"). "none" results in removing the previously set print area (not implemented for binary Excel format) |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
|
|
|
|
|
|
|
|
Reads sheet names from a workbook.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename* | text | the name of the excel file to load |
| Name | Type | Description |
|---|---|---|
| sheetcnt | number | number of sheets in the workbook |
| rowcnt | number | number of rows generated (same as sheetcnt) |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Reads data from an excel resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename* | text | the name of the excel file to load | ||
| sheet | text | the sheet name to read from | ||
| row | number | the starting row of the data in the sheet to read | ||
| column | text | The starting column of the data in the sheet to read. Excel column notation is used, e.g. the name of the first column is A. | ||
| to-row | number | The ending row of the data in the sheet to read. If not specified, the parsing will continue until the first row that starts (at position column) with an empty cell. | ||
| to-column | text | The ending column of the data in the sheet to read. If not specified, the parsing will continue until the first empty cell. | ||
| header | boolean | true | If yes or true, the first row will be treated as the header, the column names of the returned table will be imported. Otherwise the column indices will be used as column names. | |
| hidden-data | boolean | false | If yes or true, all the cells will be read, otherwise only non hidden cells will be processed. Default value is true. Used only for xslx workbooks. | |
| bigint | boolean | false | if yes or true, all the cells containing a number will be treated as strings |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Creates an excel resource in Office 97 or Office 2007 (XLSX) binary format.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | Name of the connection for the excel server. If not specified or empty, the built-in jxl engine will be used. | ||
| template | text | The position of the excel file used as a template. This xls file will be read, and its sheets can be reused using the attribute "reuse" of "data" action. | ||
| hide-unused-sheets | boolean | false | if set to "false", all the sheets will be copied from the template, otherwise only those that are used in a "data" action | |
| excel2007 | boolean | true | If set to "true", the workbook will be created in the Office 2007 ("xlsx") format, otherwise an old, binary format workbook will be created. When using the "template" attribute, the version of the template Excel file will be applied, regardless of the "excel2007" setting. | |
| recalculate | text | true false force | false | If set to "true", the formulas in the workbook will be recalculated before saving. Setting it to "force" we force Excel to recalculate the formulas when opening the workbook. |
| streaming | boolean | false | When set to "true", the workbook will be created continuously with a data stream, where only the last 100 rows of the current sheet is in the memory during creation. The action will use much less memory, but can provide a redundant (much larger) Excel file, or sometimes it fails to create a workbook (if we try to access rows which were already written to disk). Can only be used with "Excel 2007" workbook format. The template attribute can interfere with the streaming=true mode. When streaming=true, only one excel:data child action shall be used. | |
| output | text | If specified, the results of the action will be saved to the given location. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
|
|
|
|
|
|
|
|
Closes the file connection. All the connections will be closed when execution is finished in the container where the connection is defined, but close action provides a way to close connections manually. The connection is reopened automatically when needed.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Defines a file connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | name of the connection | ||
| filename | text | name of the file to open | ||
| mode | text | read write append | read | mode for opening |
| encoding | text | ISO-8859-1 ISO-8859-2 UTF-8 UTF-16 UTF-32 UTF-16LE UTF-16BE UTF-32LE UTF-32BE | UTF-8 | the encoding to use when connecting to the file |
| Name | Type | Description |
|---|---|---|
| filename | text | name of the created file and its path |
| mode | text | mode for opening |
| execution_time | number | the length of time the action was executed |
|
|
Copies a resource to a specified location. When parameter to is specified and it is a folder, the file will be copied to that folder with the same name. When parameter to is specified and it is a file, the target file will be overwritten with the source file. When parameter to is NOT specified, the folder and the name values can be specified using to-folder and to-name parameters, respectively. In one of these value is empty, the value (folder or name) of the source will be used.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| from | text | source data address | ||
| to | text | target data address | ||
| to-folder | text | target folder | ||
| to-name | text | target name | ||
| overwrite | text | true | If a resource with the name used already exists in the target folder, we can set with this attribute what will happen. Value "true" indicates that this file will be overwritten; value "false" indicates that no file will be created. If some other string is specified (like "Copy of "), it will be added to the beginning of the resource title; if there is also a resource with this name, the first free number will be added to the end (like "Copy of Test Script (16)"). | |
| all-versions | boolean | false | should we copy all versions of the resource or not |
| Name | Type | Description |
|---|---|---|
| execution time | number | time interval while the action is executed |
|
|
|
|
Deletes the resource at the specified location.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename | text | data location |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Return the list of files in the folder at a specified location or returns details if the target is a file.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| path | text | Folder or file location. In case of a file the result will be only the specified file with its details if details=true. | ||
| filename | text | filter expression for file names that can contain wildcard characters | ||
| details | boolean | false | whether to include file details | |
| recursive | boolean | false | whether to list files recursively |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of resources listed |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| filename | text | the relative file name of the actual resource | |
| id | text | the id of the actual resource | |
| size | number | file size (in bytes) | |
| dir | boolean | whether the actual resource is a folder | |
| type | text | user home group home folder script cron time schedule event schedule file template connection filesystem | the type of the actual resource |
| owner | text | the owner (i.e. user) of the actual resource | |
| creationtime | date | the date when the actual resource was created. If it is not available (e.g. on the file system), it will be the last modification time | |
| createdby | text | the user who created the actual resource (if available) | |
| lastmodtime | date | the date when the actual resource was last modified | |
| lastmodifiedby | text | the user who last modified the actual resource (if available) | |
| contenttype | text | the content type of the actual resource (e.g. "application/octet-stream") | |
| scheduled | boolean | whether the actual resource is scheduled | |
| hidden | boolean | whether the actual resource is hidden | |
| readable | boolean | whether the actual resource is readable | |
| writable | boolean | whether the actual resource is writable | |
| executable | boolean | whether the actual resource is executable | |
| description | text | the description of the actual resource | |
| lastmodificationtime | date | the date when the actual resource was last modified; same as "lastmodtime" | |
| filecnt | number | the number of (directly) contained non-folder resources, if the actual resource is a folder; otherwise 0 | |
| foldercnt | number | the number of (directly) contained folders, if the actual resource is a folder; otherwise 0 | |
| allfilecnt | number | the number of (directly or indirectly) contained non-folder resources, if the actual resource is a folder; otherwise 0 | |
| allfoldercnt | number | the number of (directly or indirectly) contained folders, if the actual resource is a folder; otherwise 0 |
|
|
|
|
|
|
Tests the file connection for "End of File" status.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | Name of the file connection |
| Name | Type | Description |
|---|---|---|
| execution_time | number | Time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Returns true value if the if the file or folder exists in the specified location.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename | text | File location. In the last part of the path, wildcards (* and ?) can be used. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | Time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Moves a resource to a specified location When parameter to is specified and it is a folder, the file will be copied to that folder with the same name. When parameter to is specified and it is a file, the target file will be overwritten with the source file. When parameter to is NOT specified, the folder and the name values can be specified using to-folder and to-name parameters, respectively. In one of these value is empty, the value (folder or name) of the source will be used.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| from | text | source data address | ||
| overwrite | text | true | If a resource with the name used already exists in the target folder, we can set with this attribute what will happen. Value "true" indicates that this file will be overwritten; value "false" indicates that no file will be created. If some other string is specified (like "Copy of "), it will be added to the beginning of the resource title; if there is also a resource with this name, the first free number will be added to the end (like "Copy of Test Script (16)"). |
| Name | Type | Description |
|---|---|---|
| execution time | number | time interval while the action is executed |
|
|
|
|
Tests the file connection for "Not End of File" status.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the file connection |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Reads data from a specified location.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename | text | data address | ||
| binary | boolean | false | If true, the resource is handled as a binary file, i.e., the new line characters will not be translated. | |
| encoding | text | the encoding of the input (text) file | ||
| head | number | we can specify to keep only a fixed number of the first lines for text files | ||
| tail | number | we can specify to keep only a fixed number of the last lines for text files | ||
| skip-head | number | 0 | we can specify to discard the first specified number of lines for text files. Formerly this attribute was called "skip" | |
| skip-tail | number | 0 | we can specify to discard the last specified number of lines for text files |
| Name | Type | Description |
|---|---|---|
| bytes | number | it is set when reading binary files, its value is the length of the file |
| lines | number | it is set when reading text files, its value is the number of lines read |
| rowcnt | number | it is set when reading text files, its value is the number of lines read (so it is the same as "lines") |
| encoding | text | The used encoding for reading the text file. It can be added by the "encoding" attribute, but it is also overwritten when a BOM is found at the beginning of the file. Choose from this set: ISO-8859-1, ISO-8859-2, UTF-8, UTF-16, UTF-32, UTF-16LE, UTF-16BE, UTF-32LE, UTF-32BE. |
| foundbom | boolen | it is true when the read parser found a BOM at the beginning of a text file |
| filename | text | the relative file name of the actual resource |
| id | text | the id of the actual resource |
| size | text | file size (in bytes) |
| dir | boolean | whether the actual resource is a folder |
| type | text | the type of the actual resource |
| owner | text | owner of the file |
| creationtime | date | The date when the actual resource was created. If it is not available (e.g., on the file system), it will be the last modification time. |
| createdby | text | the user who created the actual resource (if available) |
| lastmodtime | date | the date when the actual resource was last modified |
| contenttype | text | the content type of the actual resource (e.g., "application/octet-stream") |
| scheduled | boolean | whether the actual resource is scheduled |
| hidden | boolean | whether the actual resource is hidden |
| readable | boolean | whether the actual resource is readable |
| writable | boolean | whether the actual resource is writable |
| executable | boolean | whether the actual resource is executable |
| description | text | the description of the actual resource |
| lastmodificationtime | date | the date when the actual resource was last modified; same as "lastmodtime" |
| filecnt | number | |
| foldercnt | number | |
| allfilecnt | number | |
| allfoldercnt | number | |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
|
|
Reads a line from the specified file connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the file connection |
| Name | Type | Description |
|---|---|---|
| length | number | the length of the line read |
| encoding | text | The used encoding for reading the text file. It can be added by the "encoding" attribute, but it is also overwritten when a BOM is found at the beginning of the file. Choose from this set: ISO-8859-1, ISO-8859-2, UTF-8, UTF-16, UTF-32, UTF-16LE, UTF-16BE, UTF-32LE, UTF-32BE |
| foundbom | boolean | it is true when the read parser found a BOM at the beginning of a text file |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Writes the lines of the input file into several files, based on the content of their specific columns. It can be used for data validation (checking the number of columns in all rows) by using group-by without value.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename* | the name of the input file | |||
| folder | the target folder where the resulting file(s) will be written | |||
| target-name* | The expression of the target filenames. It may contain references to actual column values in the form "\3" (meaning value of 3rd column). | |||
| group-by | Contains a list of column indices (separated by ","s); lines having the same values in all these columns will go to one file. If left empty, then only the check of the number of columns is performed, so attributes "target-name" is ignored. | |||
| delimiter | ; | the delimiter of the columns in the file | ||
| encoding | text | ISO-8859-1 ISO-8859-2 UTF-8 UTF-16 UTF-32 UTF-16LE UTF-16BE UTF-32LE UTF-32BE | The used encoding for input and output files. | |
| error-filename | If specified, lines with the wrong number of columns will be written to this file, regardless of the values the columns specified in the "group-by" attribute. The expected number of columns can be set by either the "expected-header" or the "expected-column-count" attribute | |||
| expected-header | A reference header; the number of expected columns will be determined by counting the columns of this attribute value. If "expected-column-count" is also set, both "expected-header" and "expected-column-count" has to be correct otherwise an error will be thrown. | |||
| expected-column-count | This attribute can be used to set the number of expected columns. If expected-column-count="from-file", the number of columns will be calculated based on the first line of the input file. If "expected-header" is also set, both "expected-column-count" and "expected-header" has to be correct otherwise an error will be thrown. | |||
| input-header | boolean | false | Specifies whether the first line of the input file contains a header. If set to true and attribute "expected-header" is set, the two headers must match. See also attribute "include-header". | |
| include-header | boolean | false | If set to "true" and there is a header (set either by attribute "expected-header", or found in the first line of the input file when "input-header" is set to true), each output file and the error file will start with this header line. | |
| row-separator | any (meaning either \r, \n or \r\n) \r \n \r\n | any | Specifies the row separator of the source file. |
| Name | Type | Description |
|---|---|---|
| readlines | number | |
| writtenlines | number | |
| errorlines | number | |
| files | table |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Writes its contents to a specified file.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the file connection | ||
| filename* | text | target location | ||
| append | boolean | false | append the file or not | |
| encoding | text | ISO-8859-1 ISO-8859-2 UTF-8 UTF-16 UTF-32 UTF-16LE UTF-16BE UTF-32LE UTF-32BE | UTF-8 | the encoding to use when writing text mode files |
| bom | boolean | false | if the write action append a BOM according to the encoding attribute, at the beginning of the file |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
|
|
Writes its contents to a specified location, and writes a newline character.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the file connection | ||
| filename | text | target location | ||
| encoding | text | ISO-8859-1 ISO-8859-2 UTF-8 UTF-16 UTF-32 UTF-16LE UTF-16BE UTF-32LE UTF-32BE | UTF-8 | the encoding to use when writing text mode files |
| append | boolean | false | append the file or not |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Applies the xsl:fo processor to generate a resource with the the specified type from the source fo file.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| target | text | pcl png ps rtf | output file format | |
| config-file | text | The path of the FOP configuration file, relative to the worker root folder. Default is conf/fop.xconf. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Changes the actual remote directory. Actions mput and and mget will use this location when relative folder path is given. The name of directory can be relative, in this case the new position will be calculated relative to the old path.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| folder | text | name of the folder |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Changes group ownership of a file.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| filename | text | name of the file | ||
| group | text | changes the group ownership to this group |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Changes access permissions (rwx) of a file.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| filename | text | name of the file | ||
| permissions | text | permissions defined by binary references |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Changes the owner of a file.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| filename | text | name of the file | ||
| user | text | changes the ownership to this user |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Closes the FTP connection. All the connections will be closed when execution is finished in the container where the connection is defined, but close action provides a way to close connections manually. The connection is reopened automatically when needed.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Defines an FTP connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | name of the connection | ||
| server* | text | FTP server name or IP address | ||
| port | number | port address of the server | ||
| user | text | user name if authentication is needed | ||
| password | text | password for user authentication | ||
| cpassword | text | encrypted password for user authentication | ||
| secure | false | boolean value for the security protocol of the connection (ftp or sftp) | ||
| timeout | timeout value in milliseconds | |||
| passive | false | Whether the connection is passive. If true, action will wait “passively” for the server to supply the needed information. | ||
| keepalive-timeout | number | if greater than zero, in every timeout milliseconds an ftp command will be sent to the server to keep alive the connection | ||
| proxy-address | text | proxy address | ||
| proxy-port | number | proxy port | ||
| proxy-user | text | proxy server account name | ||
| proxy-password | text | proxy server account password | ||
| proxy-cpassword | text | proxy server encrypted account password | ||
| proxy-type | text | none SITE remotehost USER user USER proxyuser USER user proxyuser USER user | proxy server type | |
| path | text | remote path to open when connecting | ||
| encoding | text | "ISO-8859-1" | Control encoding for the connection. Only for non-secure connections. |
| Name | Type | Description |
|---|---|---|
| server | text | FTP server name or IP address |
| port | number | port address of the server |
| user | text | user name if authentication is needed |
| proxy-user | text | proxy server account name |
| secure | boolean | boolean value for the security protocol of the connection (ftp or sftp) |
| passive | boolean | whether the connection is passive |
| encoding | text | control encoding for the connection |
| execution_time | number | the length of time the action was executed |
|
|
Deletes file from the actual remote directory.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| filename | text | Name of the file to delete. It can contain wildcards. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Lists the content of the actual remote directory.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| filename* | text | filter expression that can contain wildcards | ||
| details | boolean | false | sets whether to include file details or just filenames | |
| recursive | boolean | false | sets whether display files recursively |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| filename | text | the file name of the actual resource | |
| size | number | file size (in bytes) | |
| dir | boolean | whether the actual resource is a folder | |
| owner | text | the owner of the actual resource | |
| lastmodtime | text | the last modification time of the actual resource | |
| link | text | whether the actual resource is a link | |
| permissions | text | the permissions of the actual resource |
|
|
|
|
Gets a file from the specified FTP connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| filename | text | name of the file to get | ||
| binary | boolean | true | if "true", the resource is handled as a binary file, i.e., the new line characters will not be translated |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Changes the actual local directory. Actions mput and mget will use this location when relative folder path is given. The name of directory can be relative, in this case the new position will be calculated relative to the old path.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| folder | text | name of the folder |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Makes a new folder on the specified ftp server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| folder | text | Name of the folder to create. The new folder will be created in the actually selected directory. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Gets multiple files from the specified FTP connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| from | text | File names to get. Joker characters ? and * can be used. | ||
| to | text | local folder to store the files | ||
| binary | boolean | true | if "true", the resource is handled as a binary file, i.e., the new line characters will not be translated |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Puts multiple files to the specified FTP connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| from | text | File names to get. Joker characters ? and * can be used. | ||
| to | text | remote folder to store the files | ||
| binary | boolean | true | if "true", the resource is handled as a binary file, i.e., the new line characters will not be translated |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Puts the content to the specified FTP connection. The name of the file in the target system should be specified by the filename attribute.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| filename | text | name of the file to put | ||
| binary | boolean | true | if "true", the resource is handled as a binary file, i.e., the new line characters will not be translated |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Renames remote file on the specified ftp server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| from | text | file path to rename | ||
| to | text | new name (path) of the file |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Defines an HTTP connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | name of the connection | ||
| port | number | 80 | port address of the server. If not set, the default is 80 for HTTP and 443 for HTTPs | |
| user | text | user name when authentication is needed | ||
| password | text | password for user authentication | ||
| cpassword | text | encrypted password for user authentication | ||
| proxy | text | proxy server address | ||
| path | text | prefix for all requests | ||
| server* | text | the http server name or IP address |
| Name | Type | Description |
|---|---|---|
| server | text | the http server name or IP address |
| port | number | port address of the server |
| execution_time | number | time interval while the action is executed |
|
|
|
|
|
|
|
|
|
|
|
|
Performs a http get request.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| query | text | the query of the request, see the examples. | ||
| url | text | if filled, this url value overrides all the other attribute settings from http:connection. See the examples. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
|
|
|
|
|
|
|
|
|
|
Performs a http post request.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| request | text | name of the requested page | ||
| url | text | if filled, this url value overrides all the other attribute settings from http:connection. See the examples. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Adds a new attachment to a Jira issue.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| issue-key* | text | the key of the issue | ||
| filename* | text | the name of the attachment on the Jira server | ||
| content-type | text | application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | application/pdf | type of the file to be attached |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
|
|
Adds a new comment to a Jira issue. The text of the comment must be specified as the child text of the action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| issue-key* | text | the key of the issue |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Calls a Jira REST API function.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | the name of the Jira connection used | |||
| api-path* | the (relative) API path (e.g. /rest/api/2/project) | |||
| http-method | GET POST HEAD PUT DELETE PATCH | the HTTP method used (e.g. GET, POST) | ||
| content-type | text | application/json application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | type of the content | |
| result-type | zagreus json | json | the return type of the result (if the operation has a result) |
| Name | Type | Description |
|---|---|---|
| http_response_code | the HTTP response code received from the Jira server |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Defines a Jira connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | name of the connection | ||
| url* | text | URL of the Jira installation | ||
| token* | text | the authentication token. If it is an API token, the format is: "mailaddress:token" BASE64-encoded. For Personal Access Token, specify the token itself | ||
| pat | boolean | true | whether the token is a Personal Access Token. For Server installations, it needs to be set to true, otherwise, for Cloud installation set it to false | |
| proxy | text | the proxy definition in the following format: [user:password@]host[:port] | ||
| custom-date-format | text | yyyy-MM-dd'T'HH:mm:ss.SSSX | this attribute can override the default Jira date format |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Creates a new Jira issue.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| type* | text | the type of the issue (e.g. "Task", "Bug", "Story"). It can be case insensitive, and must be defined for the specified project | ||
| title* | text | the title text of the issue | ||
| assignee-id | text | the ID of the user who the issue will be assigned to. Use action jira:list-users to get this user ID | ||
| reporter-id | text | the ID of the user who reports the issue. Use action jira:list-users to get this user ID. If not specified, the user who belongs to the token will be used | ||
| status-name | text | the name of the status (or column) of the issue (e.g. "TO DO", "In progress"). It can be case insensitive, and must be defined for the specified project | ||
| priority | number | the priority of the issue. For most of the installations, values 1 to 5 are valid (1 = Highest, 5 = Lowest). If not specified, value=3 will be used on server side |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Deletes a comment from a Jira issue.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| issue-key* | text | the key of the issue | ||
| comment-id* | text | the ID of the comment |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Deletes a Jira issue.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| issue-key* | text | the key of the issue |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Retrieves information about Jira issues, specified by a Jira Query Language (JQL) filter. See "https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/" and "https://support.atlassian.com/jira-service-management-cloud/docs/advanced-search-reference-jql-fields/" for reference about JQL queries.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| jql* | text | the JQL filter | ||
| content | boolean | false | if set, the content of the issue is also retrieved | |
| only-keys | boolean | false | if set, only the keys of the issues will be returned in a list. This setting also overrides the "content" attribute |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | text | the ID of the issue | |
| key | text | the key of the issue | |
| title | text | the title of the issue | |
| type | text | the type of the issue | |
| project-id | text | the ID of the project which the issue belongs to | |
| project-key | text | the key of the project which the issue belongs to | |
| project-name | text | the name of the project which the issue belongs to | |
| priority | text | the priority of the issue (usually a number between 1 and 5) | |
| priority-name | text | the priority name of the issue (e.g. "Highest") | |
| status-name | text | the status (or column) name of the issue (e.g. "In Progress") | |
| assignee-id | text | the user ID of the user who this issue is assigned to | |
| assignee-name | text | the display name of the user who this issue is assigned to (e.g. "John Smith") | |
| assignee-email | text | the e-mail address of the user who this issue is assigned to. Due to GDPR restrictions affecting the Jira installations, this might not be visible (depending on the actual setting of the user) | |
| reporter-id | text | the user ID of the user who reported this issue | |
| reporter-name | text | the display name of the user who reported this issue (e.g. "Jane Doe") | |
| reporter-email | text | the e-mail address of the user who reported this issue. Due to GDPR restrictions affecting the Jira installations, this might not be visible (depending on the actual setting of the user) | |
| creation-time | text | the time when the issue was created | |
| modification-time | text | the time when the issue was last modified | |
| content | text | the content (i.e. description) of the issue |
|
|
|
|
Retrieves information about a Jira issue.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| issue-key* | text | the key of the issue | ||
| content | boolean | true | if set, the content of the issue is also retrieved |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | text | the ID of the issue | |
| key | text | the key of the issue | |
| title | text | the title of the issue | |
| type | text | the type of the issue | |
| project-id | text | the ID of the project which the issue belongs to | |
| project-key | text | the key of the project which the issue belongs to | |
| project-name | text | the name of the project which the issue belongs to | |
| priority | text | the priority of the issue (usually a number between 1 and 5) | |
| priority-name | text | the priority name of the issue (e.g. "Highest") | |
| status-name | text | the status (or column) name of the issue (e.g. "In Progress") | |
| assignee-id | text | the user ID of the user who this issue is assigned to | |
| assignee-name | text | the display name of the user who this issue is assigned to (e.g. "John Smith") | |
| assignee-email | text | the e-mail address of the user who this issue is assigned to. Due to GDPR restrictions affecting the Jira installations, this might not be visible (depending on the actual setting of the user) | |
| reporter-id | text | the user ID of the user who reported this issue | |
| reporter-name | text | the display name of the user who reported this issue (e.g. "Jane Doe") | |
| reporter-email | text | the e-mail address of the user who reported this issue. Due to GDPR restrictions affecting the Jira installations, this might not be visible (depending on the actual setting of the user) | |
| creation-time | text | the time when the issue was created | |
| modification-time | text | the time when the issue was last modified | |
| content | text | the content (i.e. description) of the issue | |
| attachments | table | the attachments of the issue. Each attachment is described by the following fields: "filename", "size", "content-type" and "link"; the content can be downloaded using the provided link |
|
|
|
|
Lists the attachments of a given issue.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| issue-key* | text | the key of the issue |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of comments retrieved |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| filename | text | the filename of the attachment | |
| size | number | the file size of the attachment (in bytes) | |
| content-type | text | the content type of the attachment (e.g. application/pdf) | |
| link | text | the download link of the attachment |
|
|
Lists the comments of a given issue.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| issue-key* | text | the key of the issue |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of comments retrieved |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | text | the ID of the comment | |
| content | text | the content (i.e. text) of the comment | |
| creation-time | text | the time when the comment was created | |
| modification-time | text | the time when the comment was last modified | |
| author-id | text | the user ID of the user who is the author of this comment | |
| author-name | text | the display name of the user who is the author of this comment (e.g. "John Smith") | |
| author-email | text | the e-mail address of the user who is the author of this comment. Due to GDPR restrictions affecting the Jira installations, this might not be visible (depending on the actual setting of the user) |
|
|
|
|
Lists the projects available on a given Jira installation.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of comments retrieved |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | text | the ID of the project | |
| key | text | the key of the project | |
| name | text | the name of the project |
|
|
Lists the users associated with a given project.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of comments retrieved |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | text | the user ID of the user | |
| name | text | the display name of the user (e.g. "John Smith") | |
| text | the e-mail address of the user. Due to GDPR restrictions affecting the Jira installations, this might not be visible (depending on the actual setting of the user) | ||
| active | boolean | whether the user is active | |
| type | text | the type of the user (e.g. "atlassian") |
|
|
Refers to a parameter of the jira:call action
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | name of the parameter | |||
| value | value of the parameter. Does not have to be URL-encoded |
|
|
Updates an existing comment in a Jira issue. The text of the comment must be specified as the child text of the action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| issue-key* | text | the key of the issue | ||
| comment-id* | text | the ID of the comment to be updated | ||
| append | boolean | false | if set to true, the content will be appended to the end of the original message |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Edits an existing Jira issue.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the connection | ||
| issue-key* | text | the key of the issue | ||
| type | text | the new type of the issue (e.g. "Task", "Bug", "Story"). It can be case insensitive, and must be defined for the specified project | ||
| title | text | the new title text of the issue | ||
| assignee-id | text | the ID of the user who the issue will be assigned to. Use action jira:list-users to get this user ID | ||
| status-name | text | the name of the new status (or column) of the issue (e.g. "TO DO", "In progress"). It can be case insensitive, and must be defined for the specified project | ||
| priority | number | the new priority of the issue. For most of the installations, values 1 to 5 are valid (1 = Highest, 5 = Lowest). If not specified, value=3 will be used on server side |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
|
|
|
|
Inserts an element (a JSON, or a Zagreus type of boolean, null, number or text) into a JSON array (JSON element with type of array), specified by the content of the action. The result will be the JSON after this insertion. Some json types: array: ["element1", "element2"] object: {"keystring" : "string value", "keynumber" : 1234} For further details check JSON specification: https://www.json.org/json-en.html
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| parent-path* | the path of the parent JSON element; the specified element will be inserted under this parent element. The path must start from the root, and can contain numbers (to access specified elements of the JSON array) and other texts (to refer to the key of a specific JSON element). "/" refers to the root element Note: the parent (target of inserting) must be a JSON element with the type of array. | |||
| index | number | the end of the list | the index of the element to insert. Indexing starts with 1. If attribute 'index' is set and there is already a value on that index the original value will be overwritten. If the defined 'index' value is greater than the last index of the array NULL values will be inserted to the empty indexes. | |
| element* | the JSON element (or a boolean, null, number or text) to insert |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
|
|
Adds a property (a JSON, or a Zagreus type of boolean, null, number or text) into a JSON object, specified by the content of the action. The result will be the JSON after this insertion
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| parent-path* | the path of the parent JSON element; the specified element will be inserted under this parent element. The path must start from the root, and can contain numbers (to access specified elements of the JSON array) and other texts (to refer to the key of a specific JSON element). "/" refers to the root element | |||
| name* | the property name for insert | |||
| value* | the JSON element (or a boolean, null, number or text) to insert |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
|
|
Creates the JSON representation of a Zagreus variable.
| Name | Type | Possible Values | Default Value | Description |
|---|
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of lines in the result; it is set when the result is of type list. |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Gets a list element or a property from a JSON definition, specified by the content of the action. The result will be the JSON text of this property / element
| Name | Type | Possible Values | Default Value | Description |
|---|
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Parses the content json into a Zagreus variable. The result, depending on the JSON object used as input, can be list, record, number or text
| Name | Type | Possible Values | Default Value | Description |
|---|
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of lines in the result; it is set when the result is of type list. |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Parses an element of the content json into a Zagreus variable. The result, depending on the JSON object used as input, can be list, record, number or text
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| text-output | boolean | false | whether the result should be the JSON text of the specified element (true) or a Zagreus variable (false) |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of lines in the result; it is set when the result is of type list. |
|
|
|
|
|
|
Removes a list element or a property from a JSON definition, specified by the content of the action. The result will be the source JSON text without the specified property / element
| Name | Type | Possible Values | Default Value | Description |
|---|
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Defines a Kafka connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | name of the connection | ||
| server* | text | the Kafka server name | ||
| port* | number | 9092 | port address of the server | |
| server-cluster* | text | The Kafka server cluster. Entries have to take the form host:port, separated by commas. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
|
|
Consumes one or all of the new messages.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the Kafka connection used | ||
| consumer-group* | text | the name of the consumer group | ||
| topic* | text | the topic from which the message(s) will be consumed | ||
| only-next | boolean | false | If set to true, only one message will be consumed. If set to false, all the new messages will be consumed from the given topic. | |
| message-type | text | string number record date time binarydata | string | The message-type is applied for deserialization of the message. |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of messages consumed |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| partition | number | ||
| offset | number | ||
| message | text | ||
| message-key | text |
|
|
|
|
|
|
List the topics of the Kafka connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the Kafka connection used | ||
| consumer-group | text | the name of the consumer group | ||
| details | boolean | false | If false, the returning result is a simple list of the topic names. Otherwise it is a table with details of the topics. Each partition is a separate line in the result. |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of topics or partitions listed |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| topic | text | ||
| partition | number | ||
| leader_host | text | ||
| leader_id | text | ||
| leader_id_str | text | ||
| leader_insync_hosts | text | ||
| leader_insync_ids | text | ||
| offset | number |
|
|
Produces a new message.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | the name of the Kafka connection used | ||
| client-id | text | zagreus_producer | the client id of the producer | |
| topic* | text | the topic which the message will be produced to | ||
| message-key | text | A random generated GUID for equally distribution among the brokers. | The message key for the produced message. If not specified, a round robin algorithm will be applied. | |
| message-type | text | string number record date time binarydata | string | The message-type is applied for serialization of the message. |
| Name | Type | Description |
|---|---|---|
| partition | number | the partition of the produced message |
| offset | number | the offset of the produced message |
| topic | text | the topic which the message was produced to |
| execution_time | number | time interval while the action is executed |
|
|
|
|
Sets the cursor position (offset) for the Kafka partition.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the Kafka connection used | ||
| consumer-group* | text | the name of the consumer group | ||
| topic* | text | the topic which contain the target partitions | ||
| partition* | number/text | the target partition(s); can also be "all" | ||
| offset* | number/text | the target offset; can also be "begin" and "end" |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Defines an LDAP connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | name of the connection | ||
| server* | text | LDAP server name or IP address | ||
| port | number | 389 | port address of the server | |
| user-dn | text | user name for authentication (ignored, if authentication-mode is set to "none") | ||
| password | text | password for user authentication | ||
| cpassword | text | encrypted password for user authentication | ||
| protocol | text | ldap ldaps | ldap | the protocol used |
| authentication-method | text | none simple | none | the method of authentication for the LDAP server |
| base-dn | text | a suffix of the distinguished name used in other LDAP actions; the base-dn will be concatenated to the appropriate attributes (e.g. user-dn, filter), separated by a comma |
| Name | Type | Description |
|---|---|---|
| server | text | the http server name or IP address |
| protocol | text | the protocol used |
| execution_time | number | Time interval while the action is executed. |
|
|
|
|
|
|
Performs an LDAP search.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the LDAP connection used | |||
| node-filter* | the node filter for the LDAP search | |||
| object-filter | * | the object filter for the LDAP search | ||
| details | boolean | false | whether to list only the found accout common names or also all the details | |
| attribute-names | a comma-separated list of the columns in the result | |||
| scope | subtree object one-level | subtree | the scope of the result |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | Number of the returned records. |
| execution_time | number | Time interval while the action is executed. |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Test authenticating into a given LDAP server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name of the LDAP connection used | ||
| user-dn* | text | the user distinguished name | ||
| password | text | password for user authentication | ||
| cpassword | text | encrypted password for user authentication |
| Name | Type | Description |
|---|---|---|
| execution_time | number | Time interval while the action is executed. |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Specifies an attachment part for the send action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| content-type | text | application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | type of the file to be attached | |
| filename | text | path of the file to be attached | ||
| inline | auto true false | auto | whether the attachment is inline (e.g. image displayed in the mail body). When set to "auto", images are set to inline |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| content-type | text | Type of the attached file. | |
| filename | text | File path of the attachment. | |
| inline | text | Whether the attachment is inline (e.g. image displayed in the mail body). When set to "auto", images are set to inline |
|
|
Specifies the body part for the send action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| content-type | text | text/plain text/html | Type of the file to be attached |
|
|
Closes the mail connection. All the connections will be closed when execution is finished in the container where the connection is defined, but close action provides a way to close connections manually. The connection is reopened automatically when needed.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection |
| Name | Type | Description |
|---|---|---|
| execution_time | number | Time interval while the action is executed. |
|
|
Defines a mail connection. Additional properties can be defined in the mail:property child action(s).
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | name of the connection | ||
| server* | text | server name or IP address | ||
| port | number | port address of the server | ||
| user | text | user name for the smtp server, if authentication is needed | ||
| password | text | password for user authentication | ||
| cpassword | text | encrypted password for user authentication | ||
| secure | boolean | false | If "true", ssl (Secure Socket Layer) will be used for communication. Server certification must be added to keystore. | |
| tls | false | If "true", TLS (Transport Layer Security) will be used for communication. Server certification must be added to keystore. | ||
| mail-debug | false | If "true", the debug output will be written into the file "log/mailDebug.log" in the Worker module's root folder. | ||
| protocol | smtp pop3 imap | the used protocol |
| Name | Type | Description |
|---|---|---|
| server | text | server name or IP address |
| port | number | port address of the server |
| user | text | user name when authentication is needed |
| protocol | text | the used protocol |
| secure | text | ssl (Secure Socket Layer) is used for communication |
| tls | boolean | |
| execution_time | number | Time interval while the action is executed. |
|
|
|
|
Gets informations about a folder. This action differs from "get-msg" only that there will be no messages fetched, only the result attributes will be set.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name to identify the defined connection | ||
| folder | text | INBOX | The folder name where from the messages should be fetched. Default value is 'INBOX', and this is the only possible value when using POP3-based connection. |
| Name | Type | Description |
|---|---|---|
| message | number | number of all messages |
| read | number | number of read messages |
| unread | number | number of unread messages |
| execution_time | number | Time interval while the action is executed. |
|
|
Gets mail messages.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name to identify the defined connection | ||
| folder | text | INBOX | The folder name where from the messages should be fetched. Default value is "INBOX", and this is the only possible value when using POP3-based connection. | |
| from | text | 1 | The index of the first message to fetch. The oldest message has index 1, the second oldest has index 2, and so on. The newest message can also be accessible with using index -1, the second newest with index -2, and so on. | |
| to | text | the index of the last message to fetch | ||
| idx | text | The index of the message to fetch. When specifying this attribute, it sets the attributes "from" and "to" to the specified value. | ||
| message-id | text | the message-id of the message to fetch | ||
| delete | boolean | false | if "true", the fetched messages will be deleted from the folder | |
| message-filter | text | read unread all | all | specifies which type of messages should pass the filtering |
| move-to | text | empty | The name of the folder where the messages should be copied into. Default value is empty, in this case the messages will not be copied. | |
| fetch-content | boolean | true | if "false", only the message headers will be processed, message body and attachments are not | |
| header | boolean | false | if "true", the full header will be returned in the field "header" |
| Name | Type | Description |
|---|---|---|
| message | number | number of messages queried |
| read | number | number of messages read |
| unread | number | number of messages unread |
| rowcnt | number | number of rows generated |
| execution_time | number | Time interval while the action is executed. |
|
|
Specifies one or more property for a mail connection. Besides the attributes, textual list can be used to specify the properties in the standard name=value syntax.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | name of the property | ||
| value | text | value of the property |
|
|
|
|
Sends a mail message. The address fields can contain more than one address by using comma as separator character. If the content of these fields is not a simple text, but an iterable expression instead (list or record), a comma separated list is created from the expression.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | text | name to identidy the defined connection | ||
| from* | text | from field of the message | ||
| from-display-name | text | display name for the from field of the message | ||
| to* | text | to field of the message | ||
| cc | text | cc field of the message | ||
| bcc | text | bcc field of the message | ||
| reply-to | text | reply-to field of the message | ||
| reply-to-display-name | text | display name for the reply-to field of the message | ||
| subject | text | subject of the message | ||
| multipart | boolean | true | if set to true, all parts (body, attachments, inline attachments) are packed into a multipart container; otherwise body is handled as a plain-text part. When set to "false" attachments are not applied. When "mail:body" is missing or empty the mail is sent as plain text regardless of this setting. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | Time interval while the action is executed. |
|
|
|
|
Executes an MDX discover action. It may also contain mdx:restriction elements to restrict the result.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| output-type | text | table xml | table | the format of the output |
| cube | text | name of the cube (optional) | ||
| command | text | the actual discover command |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of rows returned (if output-type is "table") |
|
|
Executes an MDX execute action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the connection | ||
| output-type | text | table xml | table | the format of the output |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of rows returned (if output-type is "table") |
|
|
Defines a restriction criterion for the mdx:discover action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | the name of the restriction | ||
| value | text | the value of the restriction |
|
|
Defines an XMLA connection for the MDX actions.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | the name of the connection | ||
| url | text | the URL of the connection | ||
| provider | text | the provider of the connection (e.g. "MSOLAP", "Mondrian", etc.) | ||
| datasource | text | the datasource (e.g. "local", "MondrianFoodMart", etc.) | ||
| catalog | text | the catalog of the connection | ||
| user | text | the user of the connection | ||
| password | text | the password of the connection | ||
| cpassword | text | the encrypted password of the connection |
|
|
Defines a Microsoft connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | name of the connection | |||
| authority* | the authority of the connection | |||
| client-id* | the client ID of the connection | |||
| client-secret* | the client secret of the connection | |||
| scope | the scope of the connection | |||
| mailbox-user-name | the user name of the mailbox. It can be also set in the actual mail action |
|
|
Copies a mail to another location.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| mailbox-user-name | the user name of the mailbox. If not set, it will be read from the connection | |||
| message-id* | the message id to copy |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Creates a new folder.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| parent-path* | path of the parent folder. Root folder is denoted by "/" | |||
| folder-name* | name of the new folder to create |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Deletes a resource item.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| item-id* | id of the item to delete |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Deletes a mail from the mailbox.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| mailbox-user-name | the user name of the mailbox. If not set, it will be read from the connection | |||
| message-id* | the message id to delete |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Downloads a file from a folder.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| folder-path* | path of the folder to download the file from | |||
| file-name* | the filename of the file on the Sharepoint drive |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Obtains an access token which can be re-used.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the Microsoft Sharepoint connection used |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Gets one mail message.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| mailbox-user-name | the user name of the mailbox. If not set, it will be read from the connection | |||
| message-id* | the message id to get | |||
| attachments | boolean | false | whether download the attached files as well | |
| attachments-target-path | if set, all attachments will be saved into this folder |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | |||
| internet_message_id | |||
| subject | |||
| sender_address | |||
| sender_name | |||
| from_address | |||
| from_name | |||
| to_recipients_address | |||
| to_recipients_name | |||
| cc_recipients_address | |||
| cc_recipients_name | |||
| bcc_recipients_address | |||
| bcc_recipients_name | |||
| reply_to_recipients_address | |||
| reply_to_recipients_name | |||
| parent_folder_id | |||
| draft | boolean | ||
| read | boolean | ||
| has_attachments | boolean | ||
| body_content | |||
| body_content_type | |||
| body_preview | |||
| sent_date_time | |||
| received_date_time |
|
|
|
|
Lists the drives.
| Name | Type | Possible Values | Default Value | Description |
|---|
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of resources listed |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | |||
| name |
|
|
|
|
Lists the contents of a folder.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| folder-path* | path of the folder to list |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of resources listed |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | |||
| name | |||
| type |
|
|
Lists mail folders.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| mailbox-user-name | the user name of the mailbox. If not set, it will be read from the connection | |||
| folder-id | if set, only the specified folder info is returned | |||
| folder-path | if set, only the specified folder info is returned | |||
| parent-folder-id | if set, only mail folders in the specified folder id will be listed | |||
| parent-folder-path | if set, only mail folders in the specified folder path will be listed |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of resources listed |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | |||
| name | |||
| parent_folder_id | |||
| child_folder_count | number | ||
| unread_item_count | number | ||
| total_item_count | number | ||
| child_folder_count | number | ||
| size | number |
|
|
|
|
Lists mail messages.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| mailbox-user-name | the user name of the mailbox. If not set, it will be read from the connection | |||
| parent-folder-id | if set, only mails in the specified folder id will be listed | |||
| parent-folder-path | if set, only mails in the specified folder path will be listed | |||
| top | number | the limit of the number of messages to fetch | ||
| skip | number | the number of messages to skip when fetching | ||
| select | id internetMessageId subject sender replyTo from isRead isDraft hasAttachments receivedDateTime sentDateTime body bodyPreview toRecipients ccRecipients bccRecipients parentFolderId | if set, we retrieve only the listed fields from the messages. The delimiter is "," | ||
| from | if set, this filter will be applied to the "from" field of the messages. The filter works by checking if the field contains the attribute value | |||
| body | if set, this filter will be applied to the body field of the messages. Only works for text-format message bodies, HTML bodies are not supported. The filter works by checking if the field contains the attribute value | |||
| subject | if set, this filter will be applied to the subject field of the messages. The filter works by checking if the field contains the attribute value | |||
| filter-type | and or | and | if multiple filters (i.e. "from", "body" and "subject") are set, this field controls the logical operation between the filter parts | |
| only-unread | boolean | true | whether to fetch only unread mails or all mails | |
| api-path | for paging the results, use this attribute to retrieve the next page of mail results. The value should be the previous action 'nextlink' result attribute. |
| Name | Type | Description |
|---|---|---|
| nextlink | The next link that can be used for paging the results. Only filled when there are no filters applied in the action. Use it for the next list-mails action 'api-path' attribute. | |
| rowcnt | number | the number of resources listed |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | |||
| internet_message_id | |||
| subject | |||
| sender_address | |||
| sender_name | |||
| from_address | |||
| from_name | |||
| to_recipients_address | |||
| to_recipients_name | |||
| cc_recipients_address | |||
| cc_recipients_name | |||
| bcc_recipients_address | |||
| bcc_recipients_name | |||
| reply_to_recipients_address | |||
| reply_to_recipients_name | |||
| parent_folder_id | |||
| draft | boolean | ||
| read | boolean | ||
| has_attachments | boolean | ||
| body_content | |||
| body_content_type | |||
| body_preview | |||
| sent_date_time | |||
| received_date_time |
|
|
Lists the sites.
| Name | Type | Possible Values | Default Value | Description |
|---|
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of resources listed |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | |||
| name |
|
|
Moves a mail to another location.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| mailbox-user-name | the user name of the mailbox. If not set, it will be read from the connection | |||
| message-id* | the message id to move |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Uploads a file to a folder.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| folder-path* | path of the folder to upload the file to | |||
| file-name* | the filename of the new file uploaded on the Sharepoint drive | |||
| content-type | application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | application/pdf | the content type of the file | |
| overwrite | boolean | false | whether overwrite the file (if exists) |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Refers to a display form of an attribute
| Name | Type | Possible Values | Default Value | Description |
|---|
|
|
Refers to an attribute which can be put on a certain axis.
| Name | Type | Possible Values | Default Value | Description |
|---|
|
|
Defines an axis for a report or export. An axis can contain attributes and one metrics element (which also may contain metric elements). If an axis is undefined, it will remain in the state it was, except that attributes and the metrics element which are defined on other axes will be moved there. If the metrics element is not defined on any axis, it will remain on its original one as the last element.
| Name | Type | Possible Values | Default Value | Description |
|---|
|
|
Performs cache actions. Currently it is supported only for the type "cube"
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| action | invalidate delete load unload | invalidate | the action to perform on the cache |
| Name | Type | Description |
|---|---|---|
| msgid | text | message id |
| jobid | text | job id |
| user | text | user name |
| project | text | name of project |
| sessionid | text | session id |
| rowcnt | number | the number of cache entries listed |
| execution_time | the length of time the action was executed |
|
|
Lists the actual cache entries on the MSTR server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| type | report document cube | report | the type of cache to list | |
| details | boolean | true | whether to include details or not | |
| current-project | boolean | true | whether to list cache entries for the current project only |
| Name | Type | Description |
|---|---|---|
| msgid | text | message id |
| jobid | text | job id |
| user | text | user name |
| project-name | text | parent project name |
| sessionid | text | session id |
| rowcnt | number | the number of cache entries listed |
| filter_details | text | filter details |
| execution_time | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | the id of the cache | ||
| source-id | the id of the source report or document | ||
| source-name | the name of the source report or document | ||
| type | the type of the cache | ||
| project-name | the name of the project | ||
| status | the status of the cache | ||
| creator | the ID of the creator of the cache entry | ||
| creatorname | the name of the creator of the cache entry | ||
| hits | the number of hits of the actual cache entry (numeric) | ||
| size | the size of the actual cache entry in kB (numeric) | ||
| creationtime | the time of creation | ||
| expire | the time of expiration | ||
| lasthittime | the time of last hit | ||
| lastupdatetime | the time of last update | ||
| locale | the locale of the cache entry | ||
| datalocale | the locale of the data (only when detals = true) | ||
| filename | cache file name (only when detals = true) | ||
| lastloadtime | last load date of cache (only when detals = true) | ||
| waitinglist | (only when detals = true) |
|
|
Cancels the execution of one or more MicroStrategy jobs.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| job-id* | the job IDs to cancel, separated by ;s |
| Name | Type | Possible Values | Description |
|---|
|
|
Closes the MSTR connection. All the connections will be closed when execution is finished in the container where the connection is defined, but close action provides a way to close connections manually. The connection is reopened automatically when needed.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used |
|
|
Defines an MSTR connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | name of the connection | |||
| server* | MSTR intelligence server name or IP address | |||
| port | number | 34952 | port address of the server | |
| user* | user name for authentication | |||
| password | password for user authentication | |||
| cpassword | encrypted password for user authentication | |||
| project | Microstrategy Tutorial | project name to use | ||
| project-id | project ID to use | |||
| path | default path for the resources | |||
| cache | boolean | false | default cache setting, can be overrided | |
| locale | 1030 = da_DK 1031 = de_DE 1043 = nl_NL 3082 = es_ES 1033 = en_US 2057 = en_GB 1049 = ru_RU 1045 = pl_PL 1036 = fr_FR 4108 = fr_CH 2060 = fr_BE 1040 = it_IT 2064 = it_CH 1041 = ja_JP 1042 = ko_KR 1046 = pt_BR 1053 = sv_SE 2052 = zh_CN 1028 = zh_TW | default locale ID. We also support Java-style locale strings, e.g. "en_US" or "en-US". For a list of possible locale numbers supported by MicroStrategy, please see https://community.microstrategy.com/s/article/KB6423-The-complete-list-of-Locale-IDs-for-MicroStrategy-Developer?language=en_US | ||
| request-timeout | number | timeout value for requests | ||
| server-busy-timeout | number | Server busy timeout value | ||
| page-by-timeout | number | the default page-by timeout, can be overrided | ||
| authentication | standard ldap database | standard | the type of authentication | |
| encoding | the default character encoding type of the returned xml | |||
| ssl | boolean | false | If set to "true", the connection will be established with SSL. The proper certification needs to be installed in the worker-side trusted store. | |
| connect-now | boolean | false | If set to "true", this action does not only defines the connection, but also connects to the server immediately. In this case the result of the action will be the session ID. |
| Name | Type | Description |
|---|---|---|
| name | text | name of the connection |
| server | text | connected server |
| port | number | connection port |
| user | text | user name who makes the connection |
| project | text | connected project |
| authorization | text | authorization protocol |
| ssl | boolean | ssl is used or not |
| encoding | text | connection encoding |
| execution_time | number | time interval while the action is executed |
|
|
Copies a report to another folder or title.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| title | the title of the new report | |||
| type | AggMetric Attribute AttributeForm Catalog CatalogDefn Column Configuration Consolidation ConsolidationElement Datamart DatamartReport DBConnection DBLogin DBMS DBRole DbTable Dimension DocumentDefinition DrillMap Fact FactGroup Filter Folder Format Function FunctionPackageDefinition Generic Link Locale MDSecurityFilter Metric Monitor Project Prompt PromptAnswer PromptAnswers PropertySet ReportDefinition Request Reserved ReservedLastOne Resolution Role ScheduleEvent ScheduleObject ScheduleTrigger Schema Script Search SearchFolder SecurityRole ServerDef Shortcut Style SubscriptionDevice Table TableSource Template Unknown User | ReportDefinition | the type of the report to copy |
| Name | Type | Description |
|---|---|---|
| id | text | report id of the new report |
| msgid | text | ?????? |
| name | text | name of the new report |
| jobid | text | ?????? |
| user | text | username who performed the copy action |
| project | text | project name where the copy action executed |
| user | text | username who performed the copy action |
| sessionid | text | session id |
| rowcnt | number | ???????? |
| filter_details | text | ???????????? |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Creates a new MSTR resource (currently only Folder type is supported).
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| title* | the title of the new resource | |||
| type | Folder | Folder | the type of the new resource; currently only Folder is implemented | |
| description | the description of the new resource |
| Name | Type | Description |
|---|---|---|
| msgid | text | message id |
| jobid | text | job id |
| user | text | username who performed the create action |
| project | text | the number of cache entries listed |
| sessionid | text | the number of cache entries listed |
| rowcnt | number | number of returned rows |
| filter_details | text | filter details |
| id | text | id of new resource |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Lists the actual database connections of the MSTR server. It can be filtered by inserting mstr:filter actions into it; its "variable" attribute has to be set to the appropriate result attribute of the mstr:databaseconnectionlist action, the "operator" attribute has to be "in", "between", "=", "<", "<=", ">" and ">=", and the "value" attribute has to contain the value used for filtering. Multiple values can be used if separated by ";"s. All filter conditions will be applied at the same time (i.e. they are AND-ed).
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| sort-field | we can sort the results using the name of a result attribute | |||
| sort-order | ascending descending | ascending | the order during sorting |
| Name | Type | Description |
|---|---|---|
| msgid | text | message id |
| jobid | text | job id |
| user | text | username who performed the create action |
| project | text | the number of cache entries listed |
| sessionid | text | the number of cache entries listed |
| rowcnt | number | number of returned rows |
| filter_details | text | filter details |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | the id of the database connection | ||
| name | the name of the database connection | ||
| number | number | the number of the database connection | |
| instancename | the database instance name | ||
| status | number | the status of the database connection | |
| statusname | the status name of the database connection | ||
| loginname | the database login name | ||
| servername | the name of the server | ||
| username | the user name of the database connection |
|
|
|
|
Deletes a resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| type | AggMetric Attribute AttributeForm Catalog CatalogDefn Column Configuration Consolidation ConsolidationElement Datamart DatamartReport DBConnection DBLogin DBMS DBRole DbTable Dimension DocumentDefinition DrillMap Fact FactGroup Filter Folder Format Function FunctionPackageDefinition Generic Link Locale MDSecurityFilter Metric Monitor Project Prompt PromptAnswer PromptAnswers PropertySet ReportDefinition Request Reserved ReservedLastOne Resolution Role ScheduleEvent ScheduleObject ScheduleTrigger Schema Script Search SearchFolder SecurityRole ServerDef Shortcut Style SubscriptionDevice Table TableSource Template Unknown User | ReportDefinition | the type of the resource to delete |
|
|
Lists the contents of a folder, or an user group.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| details | boolean | false | whether to list only the resource names or also all the details | |
| recursive | boolean | false | specifies recursive listing | |
| distinct | boolean | false | specifies whether each object is returned only once (e.g. users can be present in several user groups). If set to true, from elements appearing multiple times, either the children of the "root" are kept, or those with the longest path | |
| type | AggMetric Attribute AttributeAbstract AttributeForm AttributeRole AttributeTransformation Catalog CatalogDefn Column Configuration Consolidation ConsolidationElement CustomGroup DBConnection DBLogin DBMS DBRole DBTable DBTablePMT Datamart DatamartReport DbTable Dimension DimensionOrdered DimensionSystem DimensionUser DimensionUserHierarchy DocumentDefinition DrillMap Fact FactGroup Filter Folder FormNormal FormSystem Format Function FunctionPackageDefinition InBox InBoxMsg Link Locale MDSecurityFilter Metric MetricDMX Monitor MonitorDBConnections MonitorJobs MonitorPerformance MonitorUserConnections Project Prompt PromptAnswer PromptAnswerBigDecimal PromptAnswerBoolean PromptAnswerDate PromptAnswerDimty PromptAnswerDouble PromptAnswerElements PromptAnswerExpression PromptAnswerExpressionDraft PromptAnswerLong PromptAnswerObjects PromptAnswerString PromptAnswers PromptBigDecimal PromptBoolean PromptDate PromptDimty PromptDouble PromptElements PromptExpression PromptExpressionDraft PromptLong PromptObjects PromptString PropertyGroup PropertySet ReportBase ReportCube ReportDatamart ReportDefinition ReportEngine ReportGraph ReportGrid ReportGridAndGraph ReportIncrementalRefresh ReportNonInteractive ReportText ReportTransaction ReportWritingDocument Request Resolution Role RoleTransformation ScheduleEvent ScheduleObject ScheduleTrigger Schema Script Search SearchFolder SecurityRole ServerDef Shortcut Style SubscriptionDevice SubtotalDefinition SystemSubtotal Table TablePartitionMD TablePartitionWH TableSource Template User UserGroup | ReportDefinition | Filter for resources based on subtype or type. If empty, will list all resources. If a type and a subtype has the same name (e.g. User), will choose subtype. |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of MSTR resources listed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | |||
| displayname | |||
| name | |||
| type | |||
| subtype | |||
| typenum | number | ||
| subtypenum | number | ||
| abbreviation | |||
| path | |||
| ownername | |||
| owner | |||
| ownerid | |||
| parentid | |||
| parentname | |||
| parentdisplayname | |||
| hidden | boolean | ||
| creationtime | date | ||
| lastmodtime | date | ||
| description | |||
| state | number | ||
| datasources | |||
| flags | number |
|
|
|
|
|
|
|
|
Gets an MSTR document or dossier in pdf or Office 2000 Excel format.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| format | pdf excel mstr xml | the format the result will be saved in | ||
| async | boolean | false | if set to true, the action returns immediately, without waiting for the execution of the document | |
| cache | boolean | true | if set, the execution will use the caching feature | |
| history | boolean | false | if set, the report will be inserted into the history list | |
| page-by-timeout | number | Timeout value for page generation. Overrides value specified in the connection. | ||
| layouts | Sets the layouts for export; can be separated by ";", "all" means all possible layouts in separate files (i.e. in a Zagreus list), while "all-in-one" means that all possible layouts should be exported in one file. "all-in-one" is currently supported for Excel and PDF. | |||
| embed-fonts | boolean | true false documentsetting | documentsetting | if set to "true", the used fonts will be embedded in the generated PDF. If set to "false", the fonts will not be embedded. By leaving this attribute empty or entering "documentsetting", the setting of the document will be used. |
| Name | Type | Description |
|---|---|---|
| id | document id of the document requested | |
| msgid | message id of the document requested | |
| name | name of the document requested | |
| user | login name of the connected user | |
| project | project name where the document is located | |
| error | MSTR error code when an error occurs | |
| errorMessage | MSTR error message when an error occurs | |
| jobid | the job id; when multiple documents were executed (e.g. page-bys), their job ids are separated by ; | |
| childreportjobid | the job id(s) of the child report(s); when multiple documents were executed (e.g. page-bys), their job ids are separated by ; |
|
|
Gets an MSTR dossier in PDF or Excel format.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| format | pdf excel mstr xml | the format the result will be saved in | ||
| async | boolean | false | if set to true, the action returns immediately, without waiting for the execution of the dossier | |
| cache | boolean | true | if set, the execution will use the caching feature | |
| history | boolean | false | if set, the report will be inserted into the history list | |
| page-by-timeout | number | Timeout value for page generation. Overrides value specified in the connection. | ||
| orientation | portrait landscape | portrait | the orientation of the pdf file | |
| paper-width | number | the paper width of the pdf file | ||
| paper-height | number | the paper height of the pdf file | ||
| paper-type | letter legal ledger executive folio statement A3 A4 A5 B4 B5 | the paper type of the pdf file | ||
| measurement-unit | cm in mm pt pc | cm | the measurement unit for the attributes paper-width and paper-height when exporting to pdf | |
| range | page chapter dossier | dossier | the export range when exporting to pdf | |
| detail-level | fullpage visualization both | fullpage | the detail level when exporting to pdf | |
| show-filter | no page chapter both | chapter | filter display options when exporting to pdf. Only applicable for MSTR level 11.2 or above | |
| grid-settings | scale extend-cols extend-cols-repeat | scale | specific grid settings (scaling to page width, extend columns over pages with or without repeating attribute columns) when exporting to pdf. Only applicable for MSTR level 11.2 or above | |
| header | boolean | dossier default | if set, the exported PDF dossier will show the header on every page | |
| footer | boolean | dossier default | if set, the exported PDF dossier will show the footer (typically page numbers) on every page | |
| embed-fonts | boolean | true false dossiersetting | dossiersetting | if set to "true", the used fonts will be embedded in the generated PDF. If set to "false", the fonts will not be embedded. By leaving this attribute empty or entering "dossiersetting", the setting of the dossier will be used. |
| Name | Type | Description |
|---|---|---|
| id | resource id of the dossier requested | |
| msgid | message id of the dossier requested | |
| name | name of the dossier requested | |
| user | login name of the connected user | |
| project | project name where the document is located | |
| error | MSTR error code when an error occurs | |
| errorMessage | MSTR error message when an error occurs | |
| jobid | the job id; when multiple documents were executed (e.g. page-bys), their job ids are separated by ; | |
| childreportjobid | the job id(s) of the child report(s); when multiple dossiers were executed (e.g. page-bys), their job ids are separated by ; |
|
|
Gets an MSTR report in Office 2000 Excel format.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| subscription-id | ID of the subscription to use. If the report is also specified, it is required that the subscription belongs to the given report | |||
| cache | boolean | true | if set, the execution will use the caching feature | |
| update-cache | boolean | true | if set, the execution will modify the cache | |
| history | boolean | false | if set to true target report - set by "id" or "name" attributes - will be added to history list | |
| page-by-required | boolean | false | if set, the result attribute page_by will be set | |
| filter-details-required | boolean | false | if set, the result attribute filter_details will be set | |
| expand-all-pages | boolean | false | if set, all pages will be exported | |
| export-filter-details | boolean | false | if set, filter details will be exported | |
| export-headers-as-text | boolean | false | if set, the headers will be exported as text | |
| export-metrics-as-text | boolean | false | if set, the metrics will be exported as text | |
| export-remove-extra-columns | boolean | false | if set, the empty columns will be removed | |
| use-separate-sheets | boolean | false | if set, export will appear in separate sheets | |
| sql | boolean | false | if set, sql information will be returned in the "sql" result attribute | |
| append-filter | and or false | false | If you are using filters, you may want to add the new filter to the filters of the document which are already set. If you set this attribute to "and", the new filter will be "and"-ed to the already existing one; if you set it to "or", they will be connected via an "or" connection; otherwise, use "false". | |
| encoding | UTF-8 ISO-8859-1 ISO-8859-2 | The character encoding type of the returned xml. If not specified, the value specified at the connection definition will be applied. |
| Name | Type | Description |
|---|---|---|
| id | report id of the requested report | |
| msgid | message id of the requested report | |
| name | name of the requested report | |
| jobid | the job id; when multiple reports were executed (e.g. page-bys), their job ids are separated by ; | |
| user | login name of the connected user | |
| project | project name where the requested report is located | |
| page_by | attributes of the generated page. When generating more pages, it is a list | |
| filter_details | text value containing filter details | |
| sql | text value containing the SQL query | |
| rowcnt | number | number of rows generated |
| error | MSTR error code when an error occurs | |
| errorMessage | MSTR error message when an error occurs |
|
|
Specifies an MSTR execution flag for report execution.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| value | DssXmlExecutionFresh DssXmlExecutionDefaultPrompt DssXmlExecutionUseCache DssXmlExecutionUpdateCache DssXmlExecutionInboxKeepAsIs DssXmlExecutionSaveToInbox DssXmlExecutionResolve DssXmlExecutionGenerateSQL DssXmlExecutionCheckWebCache DssXmlExecutionUseWebCacheOnly DssXmlExecutionGenerateDatamart DssXmlExecutionSubsetting DssXmlExecutionReBuildPreviewOnly DssXmlExecutionExport DssXmlExecutionDefault DssXmlExecutionDrillByManipulation | name of the execution flag |
|
|
Collects the "execution-flag" settings.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| append | boolean | true | if set, the original execution-flags will be not cleared before setting the corresponding execution-flags |
|
|
Gets an mstr report in text format.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| subscription-id | ID of the subscription to use. If the report is also specified, it is required that the subscription belongs to the given report | |||
| subscription-name | name of the subscription of the report to use. Only works if the report ID or name is specified. When multiple subscriptions of the same report share the same name, the index can be specified by ()s (e.g. "subscriptionname(3)") | |||
| cache | boolean | true | if set, the execution will use the caching feature | |
| update-cache | boolean | true | if set, the execution will modify the cache | |
| daf | boolean | false | if set, the attribute forms will be displayed in the exported report | |
| separator | the separator which will be used between cells upon calling the export method. | |||
| header | boolean | true | if set to false, the first line will be skipped | |
| header-prefix | the prefix which will be prepended at the beginning of each header cell in the exported report. | |||
| header-postfix | the postfix which will be appended at the end of each header cell in the exported report. | |||
| metric-prefix | the prefix which will be prepended at the beginning of each metric value in the exported report. | |||
| metric-postfix | the postfix which will be appended at the end of each metric value in the exported report. | |||
| page-by-required | boolean | false | if set, the result attribute page_by will be set | |
| filter-details-required | boolean | false | if set, the result attribute filter_details will be set. It is filled only when the report filter is set by mstr-web or mstr-developer applications. Otherwise result attribute "filter_details" is shown but it has an empty-text value. | |
| sql | boolean | false | if set, sql information will be returned in the "sql" result attribute | |
| append-filter | and or false | false | if you are using filters, you may want to add the new filter to the filters of the document which are already set. If you set this attribute to "and", the new filter will be "and"-ed to the already existing one; if you set it to "or", they will be connected via an "or" connection; otherwise, use "false" | |
| export-remove-extra-columns | boolean | if set, the empty columns will be removed | ||
| include-report-name | boolean | false | if set, the report name will be included in the result | |
| include-report-filter | boolean | false | if set, the report filter will be included in the result | |
| encoding | UTF-8 ISO-8859-1 ISO-8859-2 | The character encoding type of the returned xml. If not specified, the value specified at the connection definition will be applied |
| Name | Type | Description |
|---|---|---|
| id | report id of the requested report | |
| msgid | message id of the requested report | |
| name | name of the requested report | |
| jobid | the job id; when multiple reports were executed (e.g. page-bys), their job ids are separated by ; | |
| user | login name of the connected user | |
| project | project name where the requested report is located | |
| page_by | attributes of the generated page. When generating more pages, it is a list | |
| filter_details | text value containing filter details | |
| sql | text value containing the SQL query | |
| rowcnt | number | number of rows generated |
| error | MSTR error code when an error occurs | |
| errorMessage | MSTR error message when an error occurs |
|
|
Groups filter expressions for the mstr:report action (and its similar counterparts, mstr:export, mstr:excel and mstr:pdf). It can contain filter definitions and other filter-groups also, making possible to compose complex filtering expressions.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| operator* | and, && or, || not, ! | the relation of the grouping |
|
|
Defines a filter expression for the mstr:report action (and its similar counterparts, mstr:export, mstr:excel mstr:pdf). Usually it is contained by mstr:filter-group, but can be used without explicit grouping also; in this case the filter expressions will be stored an implicitly created AND group.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | Name of the variable (attribute, metric, or attribute form) to filter to. To use attribute forms the attribute also has to be specified, like "Region.ID" or "Country:DESC"; characters ".", ":" and "\" can be used. | |||
| operator* | =, equals, exactly <>, !=, not equals, different >, greater, more <, less >=, greater or eq, more or eq <=, less or eq between (for numerical values) not between (for numerical values) null, is null not null in, in list not in, not in list | the relation of the check | ||
| value | A constant value. If the operator specified accepts or requires more values, these can be separated by ";"; in the case of "between" and "not between" operators, the two values can be separated by the word "and". |
|
|
|
|
Triggers an MSTR event.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used |
| Name | Type | Description |
|---|---|---|
| id | report id of the requested report | |
| msgid | message id of the requested report | |
| name | name of the requested report | |
| jobid | the job id; when multiple reports were executed (e.g. page-bys), their job ids are separated by ; | |
| user | login name of the connected user | |
| project | project name where the requested report is located | |
| sessionid | session id | |
| rowcnt | number | number of rows generated |
| filter_details | text value containing filter details | |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Gets an mstr report in flash format.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| cache | boolean | true | if set, the execution will use the caching feature | |
| history | boolean | true | if set to true, the document will be inserted into the history list | |
| format | format of the flash exporting. If format is "mht", one mht file will be generated that will contains all data. If format is "files", separated files will be created for the swf file, for data for resources, for html page, and so on. Saving these files into a folder and starting the browser on the html file, the exported flash file can be displayed | |||
| page-by-timeout | number | timeout value for page generation. Overrides value specified in the connection |
| Name | Type | Description |
|---|---|---|
| id | report id of the document requested | |
| msgid | message id of the document requested | |
| name | name of the document requested | |
| user | login name of the connected user | |
| project | project name where the document requested is located | |
| error | MSTR error code when an error occurs | |
| errorMessage | MSTR error message when an error occurs |
|
|
Gets the information of a project specified by id or name, or all projects.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| id | the id of the project | |||
| name | the name of the project |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of projects listed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| project-id | |||
| project-name | |||
| alias | |||
| description | |||
| status | active errorstate execidle fullidle metadataidle offline offlinepending onlinepending requestidle warehouseidle whexecidle | ||
| statusnum | number |
|
|
|
|
Gets the project status (a text) of the given project, and its display mode.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used |
| Name | Type | Description |
|---|---|---|
| msgid | text | message id |
| jobid | text | job id |
| user | text | username who performed the copy action |
| project | text | project name where the copy action executed |
| sessionid | text | session id |
| rowcnt | number | the number of returned rows |
| filter_details | text | text value containing filter details |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| status | |||
| show | top bottom false |
|
|
Retrieves the set prompt answers of a given subscription, document or report. If a subscription is specified (via subscription-id or subscription-name attributes), the prompt of that subscription will be retrieved; otherwise the report or document is handled. Note that it is possible to specify the id or name of the report/document along with subscription-name; this can help for better identification of the subscription (e.g. if we specify the report id and the subscription name at the same time, then the action checks only the subscriptions of the given report, thus confusion with several subscriptions with the same name but belonging to different reports/documents can be avoided).
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| prompt-id | the id of the prompt retrieved | |||
| prompt-name | the id of the prompt retrieved | |||
| prompt-idx | number | the index of the prompt retrieved | ||
| xml | true false all | true | whether to return the XML of the prompt answer ("true"), return the text answer ("false"), or return both ("all"). In the case of "all", both "value" and "idvalue" fields are returned. Currently false is implemented only for specific prompt types |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of prompt answers returned |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | |||
| name | |||
| index | |||
| type | elements expression constant dimensionality objects time | ||
| value | |||
| idvalue |
|
|
|
|
Gets the entries in the MSTR history.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of history list entries listed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| msgid | |||
| name | |||
| creationtime | date | ||
| starttime | date | ||
| finishtime | date | ||
| statusid | |||
| statusmsg | |||
| msgnum | |||
| msgtype | |||
| displayname | |||
| projectname | |||
| projectid | |||
| creator | |||
| subscriptionid | |||
| requesttype | |||
| objectid | |||
| folderid | |||
| foldername |
|
|
Gets an MSTR htmldocument in html format.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| async | boolean | false | if set to true, the action returns immediately, without waiting for the execution of the document | |
| cache | boolean | true | if set, the execution will use the caching feature | |
| history | boolean | false | if set, the report will be inserted into the history list | |
| page-by-timeout | number | Timeout value for page generation. Overrides value specified in the connection. |
| Name | Type | Description |
|---|---|---|
| id | document id of the document requested | |
| msgid | message id of the document requested | |
| name | name of the document requested | |
| user | login name of the connected user | |
| project | project name where the document is located | |
| error | MSTR error code when an error occurs | |
| errorMessage | MSTR error message when an error occurs |
|
|
Lists the actual jobs on the MSTR server. It can be filtered by inserting mstr:filter actions into it. One cannot filter for result attributes which appear only when details is set to "true". All filter conditions will be applied at the same time (i.e. they are AND-ed).
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| details | boolean | false | whether to include details or not | |
| sort-field | We can sort the results using the name of a result attribute. One cannot sort on result attributes which appear only when details is set to "true". | |||
| sort-order | ascending descending | ascending | the type of sorting (i.e. ascending or descending) |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of jobs listed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| jobid | |||
| status | |||
| statusname | canceled completed error executing ready stopped waiting waiting-for-auto-prompt waiting-for-cache waiting-for-children waiting-for-fetching-results waiting-for-project waiting-on-governer | ||
| username | |||
| userloginname | |||
| description | |||
| server-name | |||
| priority | number | ||
| project-id | number | ||
| project-name | |||
| project-dssid | |||
| creationtime | date | ||
| duration | number | ||
| client-machine | |||
| template (details) | |||
| filter-name (details) | |||
| task-num (details) | number | ||
| finished-task-num (details) | number | ||
| client-machine-port (details) | number | ||
| sql (details) |
|
|
|
|
Refers to a metric inside a mstr:metrics element, to put it on a certain axis.
| Name | Type | Possible Values | Default Value | Description |
|---|
|
|
Refers to the metrics collection, to put it on a certain axis. May contain mstr:metric elements. If no such elements are specified, the metrics collection will contain elements as stated in the report definition.
|
|
Gives information about a specified MSTR resource. Returned fields might differ based on the actual object type.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| type | AggMetric Attribute AttributeAbstract AttributeForm AttributeRole AttributeTransformation Catalog CatalogDefn Column Configuration Consolidation ConsolidationElement CustomGroup DBConnection DBLogin DBMS DBRole DBTable DBTablePMT Datamart DatamartReport DbTable Dimension DimensionOrdered DimensionSystem DimensionUser DimensionUserHierarchy DocumentDefinition DrillMap Fact FactGroup Filter Folder FormNormal FormSystem Format Function FunctionPackageDefinition InBox InBoxMsg Link Locale MDSecurityFilter Metric MetricDMX Monitor MonitorDBConnections MonitorJobs MonitorPerformance MonitorUserConnections Project Prompt PromptAnswer PromptAnswerBigDecimal PromptAnswerBoolean PromptAnswerDate PromptAnswerDimty PromptAnswerDouble PromptAnswerElements PromptAnswerExpression PromptAnswerExpressionDraft PromptAnswerLong PromptAnswerObjects PromptAnswerString PromptAnswers PromptBigDecimal PromptBoolean PromptDate PromptDimty PromptDouble PromptElements PromptExpression PromptExpressionDraft PromptLong PromptObjects PromptString PropertyGroup PropertySet ReportBase ReportCube ReportDatamart ReportDefinition ReportEngine ReportGraph ReportGrid ReportGridAndGraph ReportIncrementalRefresh ReportNonInteractive ReportText ReportTransaction ReportWritingDocument Request Resolution Role RoleTransformation ScheduleEvent ScheduleObject ScheduleTrigger Schema Script Search SearchFolder SecurityRole ServerDef Shortcut Style SubscriptionDevice SubtotalDefinition SystemSubtotal Table TablePartitionMD TablePartitionWH TableSource Template User UserGroup | ReportDefinition | the resource type; DocumentDefinition can be abbreviated as "document" and ReportDefinition as "report". It is required to set the correct object type |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| id | |||
| displayname | |||
| name | |||
| type | |||
| subtype | |||
| typenum | number | ||
| subtypenum | number | ||
| abbreviation | |||
| path | |||
| ownername | |||
| owner | |||
| ownerid | |||
| parentid | |||
| parentname | |||
| parentdisplayname | |||
| hidden | boolean | ||
| creationtime | date | ||
| lastmodtime | date | ||
| description | |||
| state | number | ||
| datasources | |||
| flags | number |
|
|
|
|
Specifies that during a report or document export, all possible page-by values should be exported.
|
|
Contains a list of page-by elements for report or document export.
|
|
A page-by entry nested in an mstr:page-by-selection action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| value | the value of the page-by |
|
|
Can be used to specify the parameters for the swf file for the mstr:flash action. The required parameters depend on the swf file.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | The name of the parameter | |||
| value* | The value of the parameter | |||
| type | constant resource | constant | the type of the parameter |
|
|
Gets an MSTR report in PDF format.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| subscription-id | ID of the subscription to use. If the report is also specified, it is required that the subscription belongs to the given report | |||
| subscription-name | name of the subscription of the report to use. Only works if the report ID or name is specified. When multiple subscriptions of the same report share the same name, the index can be specified by ()s (e.g. "subscriptionname(3)") | |||
| cache | boolean | true | if set, the execution will use the caching feature | |
| update-cache | boolean | true | if set, the execution will modify the cache | |
| page-by-required | boolean | false | if set, the result attribute page_by will be set | |
| filter-details-required | boolean | false | if set, the result attribute filter_details will be set | |
| page-by-timeout | number | Timeout value for page generation. Overrides value specified in the connection. | ||
| expand-all-pages | boolean | false | if set, all pages will be exported | |
| margin-left | number | left margin in units specified in parameter "measurement-unit" | ||
| margin-right | number | right margin in units specified in parameter "measurement-unit" | ||
| margin-top | number | top margin in units specified in parameter "measurement-unit" | ||
| margin-bottom | number | bottom margin in units specified in parameter "measurement-unit" | ||
| header-left | left header value | |||
| header-center | center header value | |||
| header-right | right header value | |||
| footer-left | left footer value | |||
| footer-center | center footer value | |||
| footer-right | right footer value | |||
| coverpage | boolean | if set, cover page will be exported | ||
| max-header-size | number | max height of the header in units specified in parameter "measurement-unit" | ||
| max-footer-size | number | max height of the footer in units specified in parameter "measurement-unit" | ||
| orientation | portrait landscape | page orientation | ||
| paper-width | number | paper width in units specified in parameter "measurement-unit" | ||
| paper-height | number | paper height in units specified in parameter "measurement-unit" | ||
| paper-type | letter legal executive folio A3 A4 A5 | paper type | ||
| scale-percentage | number | percentage of page scale of the exported PDF | ||
| scale-pages-wide | boolean | false | if set, fits report width to page width | |
| scale-pages-tall | boolean | false | if set, fits report height to page height | |
| measurement-unit | cm in mm pt pc | cm | unit type for measurement | |
| sql | boolean | false | if set, sql information will be returned in the "sql" result attribute | |
| append-filter | and or false | false | If you are using filters, you may want to add the new filter to the filters of the document which are already set. If you set this attribute to "and", the new filter will be "and"-ed to the already existing one; if you set it to "or", they will be connected via an "or" connection; otherwise, use "false". | |
| embed-fonts | boolean | true false reportsetting | reportsetting | if set to "true", the used fonts will be embedded in the generated PDF. If set to "false", the fonts will not be embedded. By leaving this attribute empty or entering "reportsetting", the setting of the report will be used. |
| encoding | UTF-8 ISO-8859-1 ISO-8859-2 | The character encoding type of the returned xml. If not specified, the value specified at the connection definition will be applied. |
| Name | Type | Description |
|---|---|---|
| id | report id of the requested report | |
| msgid | message id of the requested report | |
| name | name of the requested report | |
| jobid | the job id; when multiple reports were executed (e.g. page-bys), their job ids are separated by ; | |
| user | login name of the connected user | |
| project | project name where the requested report is located | |
| page_by | Attributes of the generated page. When generating more pages, it is a list. | |
| filter_details | text value containing filter details | |
| sql | text value containing the SQL query | |
| rowcnt | number | number of rows generated |
| error | MSTR error code when an error occurs | |
| errorMessage | MSTR error message when an error occurs |
|
|
Sets answers for filter prompts.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| id | the identifier of the filter prompt question | |||
| name | the name or path of the filter prompt question | |||
| value* | the answer for the prompt |
|
|
|
|
|
|
|
|
Purges the cache of the MSTR server for the given project.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| cache-type | element object report all | report | the type of cache to purge |
|
|
Purges the cache of the MSTR server for the given project.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| cache-type | element object report all | report | the type of cache to purge |
|
|
Renames an MSTR resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| type | AggMetric Attribute AttributeForm Catalog CatalogDefn Column Configuration Consolidation ConsolidationElement Datamart DatamartReport DBConnection DBLogin DBMS DBRole DbTable Dimension DocumentDefinition DrillMap Fact FactGroup Filter Folder Format Function FunctionPackageDefinition Generic Link Locale MDSecurityFilter Metric Monitor Project Prompt PromptAnswer PromptAnswers PropertySet ReportDefinition Request Reserved ReservedLastOne Resolution Role ScheduleEvent ScheduleObject ScheduleTrigger Schema Script Search SearchFolder SecurityRole ServerDef Shortcut Style SubscriptionDevice Table TableSource Template Unknown User | ReportDefinition | the type of the report to rename | |
| new-name* | the new name of the resource |
|
|
Gets an mstr report in xml format or as an image.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| subscription-id | ID of the subscription to use. If the report is also specified, it is required that the subscription belongs to the given report | |||
| subscription-name | name of the subscription of the report to use. Only works if the report ID or name is specified. When multiple subscriptions of the same report share the same name, the index can be specified by ()s (e.g. "subscriptionname(3)") | |||
| banding | boolean | false | it sets the cell grouping | |
| rows | number | it limits the maximum number of rows to get | ||
| async | boolean | false | if set, the action returns immediately, without waiting for the execution of the report | |
| history | boolean | false | if set, the report will be inserted into the history list | |
| sql | boolean | false | if set, sql information will be included in the xml, and the "sql" result attribute is also filled | |
| cache | boolean | true | if set, the execution will use the caching feature | |
| update-cache | boolean | true | if set, the execution will modify the cache | |
| graph | boolean | false | if set to "true" result is returned as a graph/chart in image format | |
| page-by-required | boolean | false | if set, the result attribute page_by will be set | |
| filter-details-required | boolean | false | if set, the result attribute filter_details will be set | |
| page-by-timeout | number | it sets the page-by timeout | ||
| append-filter | and or false | false | If you are using filters, you may want to add the new filter to the filters of the document which are already set. If you set this attribute to "and", the new filter will be "and"-ed to the already existing one; if you set it to "or", they will be connected via an "or" connection; otherwise, use "false". | |
| encoding | UTF-8 ISO-8859-1 ISO-8859-2 | The character encoding type of the returned xml. If not specified, the value specified at the connection definition will be applied. |
| Name | Type | Description |
|---|---|---|
| id | report id of the requested report | |
| msgid | message id of the requested report | |
| name | name of the requested report | |
| jobid | the job id; when multiple reports were executed (e.g. page-bys), their job ids are separated by ; | |
| user | login name of the connected user | |
| project | project name where the requested report is located | |
| page_by | attributes of the generated page. When generating more pages, it is a list | |
| filter_details | text value containing filter details | |
| sql | text value containing the SQL query | |
| rowcnt | number | number of rows generated |
| error | MSTR error code when an error occurs | |
| errorMessage | MSTR error message when an error occurs |
|
|
Specifies an MSTR result flag for report execution.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| value | DssXmlResultDtlsExprNothing DssXmlResultDtlsExprEmbedded DssXmlResultDtlsExprAll DssXmlResultXmlSQL DssXmlResultDtlsTemplateLimits DssXmlResultDtlsTemplateUnit DssXmlResultWorkingSet DssXmlResultNoDerivedPromptXml DssXmlResultXmlDisplayProperties DssXmlResultNoResolution DssXmlResultGraph DssXmlResultFilter DssXmlResultBandingAutoApply DssXmlResultRawData DssXmlResultDrillHigh DssXmlResultDrillMedium DssXmlResultDrillLow DssXmlResultGrid DssXmlResultBandingStyle DssXmlResultFolderPath DssXmlResultRelatedReports DssXmlResultNoPageHeader DssXmlResultMinimal DssXmlResultViewReport DssXmlResultPutToInboxRead DssXmlResultStatusOnlyIfNotReady DssXmlResultNoNumberFormatting DssXmlResultInboxMessage DssXmlResultDefaultFormatProperties DssXmlResultDatamartTableName DssXmlResultPageTreeStyle DssXmlResultPreserve DssXmlResultPositiveFlags | name of the result flag |
|
|
Collects the "result-flag" settings.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| append | boolean | true | if set, the original result-flags will be not cleared before setting the corresponding result-flags |
|
|
Specifies an MSTR session flag for connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| value | DssXmlSessionCancelActiveJobsOnClose DssXmlSessionChangePwdOnCreate DssXmlSessionCheckWebCache DssXmlSessionDeleteReadMsgsOnClose DssXmlSessionDeleteUnreadMsgsOnClose DssXmlSessionKeepPromptJobOnClose DssXmlSessionPreserveFlags DssXmlSessionUseWebCacheOnly | DssXmlSessionCheckWebCache | name of the session flag |
|
|
Collects the "session-flag" settings for session flags for MSTR connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| append | boolean | true | if set, the original session-flags will be not cleared before setting the corresponding session-flags |
|
|
Sets the description of a specified MSTR resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| type | AggMetric Attribute AttributeAbstract AttributeForm AttributeRole AttributeTransformation Catalog CatalogDefn Column Configuration Consolidation ConsolidationElement CustomGroup DBConnection DBLogin DBMS DBRole DBTable DBTablePMT Datamart DatamartReport DbTable Dimension DimensionOrdered DimensionSystem DimensionUser DimensionUserHierarchy DocumentDefinition DrillMap Fact FactGroup Filter Folder FormNormal FormSystem Format Function FunctionPackageDefinition InBox InBoxMsg Link Locale MDSecurityFilter Metric MetricDMX Monitor MonitorDBConnections MonitorJobs MonitorPerformance MonitorUserConnections Project Prompt PromptAnswer PromptAnswerBigDecimal PromptAnswerBoolean PromptAnswerDate PromptAnswerDimty PromptAnswerDouble PromptAnswerElements PromptAnswerExpression PromptAnswerExpressionDraft PromptAnswerLong PromptAnswerObjects PromptAnswerString PromptAnswers PromptBigDecimal PromptBoolean PromptDate PromptDimty PromptDouble PromptElements PromptExpression PromptExpressionDraft PromptLong PromptObjects PromptString PropertyGroup PropertySet ReportBase ReportCube ReportDatamart ReportDefinition ReportEngine ReportGraph ReportGrid ReportGridAndGraph ReportIncrementalRefresh ReportNonInteractive ReportText ReportTransaction ReportWritingDocument Request Resolution Role RoleTransformation ScheduleEvent ScheduleObject ScheduleTrigger Schema Script Search SearchFolder SecurityRole ServerDef Shortcut Style SubscriptionDevice SubtotalDefinition SystemSubtotal Table TablePartitionMD TablePartitionWH TableSource Template User UserGroup | ReportDefinition | the resource type; DocumentDefinition can be abbreviated as "document" and ReportDefinition as "report" | |
| description* | the new description of the MSTR resource |
|
|
|
|
|
|
Sets the status (a text) of the current project. The status has to be specified as the child text.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| show | top bottom false or no | where to display the status |
|
|
Creates a new subscription or edits an existing one on the MSTR server for the given report or document. For editing subscription-id or subscription-name has to be specified, otherwise a new subscription will be created. If editing a subscriptions, not all mandatory attributes have to be specified (i.e. for creating a new subscription the trigger has to be specified either by "trigger-id" or "trigger-name"; when editing an already existing subscription, we can leave these attributes empty, meaning no change in triggers).
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| type | Inbox or History List Mobile E-mail or Email File Print or Printer | Inbox | the type of the new subscription | |
| recipient | the recipients of the subscription; a subscription can have several recipients, which have to be separated by ";"s | |||
| title | the name (title) of the subscription will be set (in the case of a new subscription) or changed (in the case of an existing subscription) to the value specified by this attribute | |||
| format | HTML Excel CSV Plain Text or PlainText or Text Flash Export Flash or ExportFlash HTML Flash View Editable Interactive Streaming | HTML | The result format of the new subscription. It depends on the actual report/document and the subscription type, which ones are supported. | |
| send-now | boolean | false | whether to send a copy now | |
| overwrite | boolean | false | whether to overwrite older versions of results at execution | |
| filename | the name of the resulting file for types "E-mail" and "File" | |||
| subject | the subject of the e-mail for type "E-mail" | |||
| zip-filename | the name of zip file for types "E-mail" and "File" (no zipping will occur if left empty) | |||
| zip-password | the password of zip file for types "E-mail" and "File" (no encryption will occur if left empty) | |||
| copies | number | 1 | the number of copies to print for type "Printer" | |
| collate | boolean | false | whether to collate the pages to print for type "Printer" | |
| print-range | number | the interval of pages to print for type "Printer" (e.g. "5" or "9-13"); by default, all pages are printed | ||
| expire | the date of the expiration of the new subscription | |||
| allow-change-delivery | boolean | false | whether to allow the recipients to change delivery settings | |
| allow-change-personalization | boolean | false | whether to allow the recipients to change personalization | |
| allow-unsubscribe | boolean | false | whether to allow the recipients to unsubscribe | |
| expand-layouts | boolean | false | whether to expand layouts | |
| expand-pagebys | true false separate | false | whether to expand layouts | |
| delimiter | the new delimiter of the subscription (if allowed) |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Lists the available subscriptions and their details on the MSTR server. The result can be filtered by using a number of parameters; there is an AND connection between them. Subscriptions with several recipients will be multiply shown.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| id | the id of the report or document for filtering | |||
| name | the id of the report or document for filtering | |||
| subscription-id | the id of the subscription for filtering | |||
| subscription-name | the id of the subscription for filtering | |||
| type | Inbox or History List Mobile E-mail or Email File Print or Printer | the type of the subscription for filtering | ||
| format | HTML Excel CSV Plain Text or PlainText or Text Flash Export Flash or ExportFlash HTML Flash View Editable Interactive Streaming | the result format of the new subscription for filtering | ||
| recipient | the recipients subscription for filtering | |||
| owner | the owner subscription for filtering | |||
| trigger-id | the trigger id filter | |||
| trigger-name | the trigger name filter (e.g. "All the Time") | |||
| max-list-attempts | number | 3 | Number of max. list attempts before looking for no further subscriptions. |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of subscriptions listed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| subscription-id | |||
| subscription-name | |||
| owner-id | |||
| owner | |||
| report-id | |||
| report-name | |||
| trigger-id | |||
| trigger-name | |||
| type | |||
| format | |||
| description | |||
| personalized | boolean | ||
| expire | date | ||
| isexpired | boolean | ||
| overwrite | boolean | ||
| filename | |||
| subject | |||
| compressed | boolean | ||
| zip-filename | |||
| zip-encrypted | boolean | ||
| zip-password | |||
| copies | number | ||
| collate | boolean | ||
| portrait | boolean | ||
| use-print-range | boolean | ||
| print-range-start | number | ||
| print-range-end | number | ||
| allow-change-delivery | boolean | ||
| allow-change-personalization | boolean | ||
| allow-unsubscribe | boolean | ||
| recipient | |||
| child-subscription-id | |||
| address-name | |||
| address-value |
|
|
|
|
|
|
Creates a new user or edits an existing one on the MSTR server. If the user is specified via either id, login or fullname, it will be edited; otherwise a new user is created.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| id | id of the user to edit | |||
| login | login of the user to edit | |||
| fullname | full name of the user to edit | |||
| enabled | boolean | true | by using this attribute we can enable or disable the given user | |
| newlogin | The new login of the user. If a new user is created, this is required. | |||
| newfullname | the new full name of the user | |||
| description | the new description | |||
| password | the new password | |||
| cpassword | the new encrypted password | |||
| groups | the parent user groups, separated by ;s | |||
| can-change-password | boolean | sets whether the user can change his or her password | ||
| must-change-password | boolean | sets whether the user has to changes his or her password after the next login | ||
| standard-auth-allowed | boolean | sets whether standard authentication is allowed | ||
| password-expires | boolean | sets whether the user's password will expire | ||
| password-expiration-freq | number | the frequency of the password's expiration in days. If set, it also changes password-expires to true | ||
| password-expiration-date | number | the date of the password's expiration. If set, it also changes password-expires to true | ||
| win-login | the new Windows login of the user | |||
| ldap-login | the new LDAP login of the user | |||
| database-login | the new database login of the user | |||
| database-password | the new database password | |||
| database-cpassword | the new encrypted database password | |||
| trusted-login | the new trusted login user id of the user |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Lists the actual user connections of the MSTR server. It can be filtered by inserting mstr:filter actions into it; its "variable" attribute has to be set to the appropriate result attribute of the mstr:userconnectionlist action, the "operator" attribute has to be "in", "between", "=", "<", "<=", ">" and ">=", and the "value" attribute has to contain the value used for filtering. Multiple values can be used if separated by ";"s. All filter conditions will be applied at the same time (i.e. they are AND-ed).
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used | |||
| sort-field | we can sort the results using the name of a result attribute | |||
| sort-order | ascending descending | ascending | the type of sorting (i.e. ascending or descending) |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of user connections listed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| clientid | the client id of the user connection | ||
| clientport | number | the client port of the user connection | |
| clienttype | mobile officews webservices agent scheduler sysadmin web | the client type of the user connection | |
| username | the user name of the owner of the connection | ||
| loginname | the login name of the owner of the connection | ||
| sessionid | the session ID of the connection | ||
| servername | the name of the server | ||
| projectid | the DSS ID of the project | ||
| projectidnum | number | the ID of the project | |
| projectname | the name of the project | ||
| openjobs | number | the number of open jobs | |
| connectiontime | date | the time when the connection was connected | |
| duration | number | the duration of the connection in seconds | |
| firstjobtime | the first time a job was submitted in this connection | ||
| lastjobtime | the last time a job was submitted in this connection |
|
|
|
|
Lists the currently loaded projects on the MSTR server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of web projects listed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| project-name | the name of the project | ||
| project-id | the ID of the project | ||
| alias | the type of the project | ||
| description | the description of the project | ||
| status | executing pause stopped | the status of the project | |
| statusnum | number | the status constant value of the project |
|
|
Sends an xml content to the MSTR server
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR connection used |
| Name | Type | Possible Values | Description |
|---|
|
|
Calls a MSTR REST API function.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | the name of the MSTR REST connection used | |||
| api-path* | the (relative) API path (e.g. /api/folders) | |||
| http-method* | GET POST HEAD PUT DELETE PATCH | the HTTP method used (e.g. GET, POST) | ||
| result-type | zagreus json | the return type of the result (if the operation has a result). The "json" type is automatically beautified | ||
| result-encoding | text | UTF-8 | the encoding of the server response, e.g. UTF-16 |
| Name | Type | Description |
|---|---|---|
| http_method | the HTTP method of the rest call | |
| rest_url | the complete rest url sent to the server | |
| request_body | the request body sent to the server in case of e.g. a POST call | |
| request_parameters | the request parameters sent to the server in case of a GET or DELETE call | |
| header_parameters | the HTTP header parameters sent to the server | |
| http_response_code | number | the response code returned by the server |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
Closes the MSTR REST connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | the name of the MSTR REST connection used |
|
|
Defines an MSTR REST connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | the name of the connection | |||
| url | http://127.0.0.1:8080/MicroStrategyLibrary | MSTR REST URL full address (with port) | ||
| user* | the user name for authentication | |||
| password | the password for user authentication | |||
| cpassword | the encrypted password for user authentication | |||
| proxy | text | the proxy definition in the following format: [user:password@]host[:port] | ||
| project* | MicroStrategy Tutorial | the project name to use | ||
| authentication | standard ldap | standard | the type of authentication |
|
|
Creates a new MSTR cube instance. The columns of the cube has to be set in child mstrrest:header elements.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | the name of the MSTR REST connection used | |||
| cube-name* | the name of the cube to create | |||
| table-name* | the name of the table inside the cube |
| Name | Type | Description |
|---|---|---|
| create_cube_json | the JSON string sent to the MSTR REST server |
| Name | Type | Possible Values | Description |
|---|
|
|
Refers to a header parameter of the mstrrest:call action. Note: when using "X-MSTR-ProjectID" parameter in this action, it overrides the ProjectID value defined in the mstrrest:connection!
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | name of the header parameter | |||
| value | value of the header parameter |
|
|
|
|
Refers to an attribute or metric for the mstrrest:createcube action
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | name of the attribute or metric | |||
| datatype* | STRING INTEGER BIGINTEGER BOOL DOUBLE BIGDECIMAL DATE TIME DATETIME | the data type of the attribute or metric | ||
| type | attribute metric | attribute | this attribute specifies whether the given header element is an attribute or a metric |
|
|
Pushes data to an MSTR cube instance through an MSTR REST connection. The data must be set in a Zagreus record or a Zagreus table structure.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name* | name of the MSTR REST connection used | |||
| cube-id* | ID of the cube to push data into | |||
| table-name* | name of the table inside the cube to push data into |
| Name | Type | Description |
|---|---|---|
| open_session_json | the JSON string sent to open the MSTR REST upload session | |
| push_data_json | the JSON string sent to push the data | |
| session_id | the upload session ID | |
| rowcnt | number | number of rows parsed and sent |
|
|
Refers to a request parameter of the mstrrest:call action
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | name of the parameter | |||
| value | value of the parameter |
|
|
Extracts images from a PDF resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| pdf-name | text | the path of the file to be read from. As an alternative, binary data can be put inside as a child action. | ||
| read-password | text | the password of the input PDF if encrypted | ||
| pages | text | filter for specific pages of the input PDF; e.g. "3-8,12". | ||
| image-name | text | filter for specific image name obtained by action "pdf:list-resources". | ||
| format | text | jpg gif png bmp | jpg | Image format. |
| target-folder-path | text | the path to save the extracted images to. |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| name | text | the name of the actual image | |
| format | text | the format of the resource (e.g. "png") | |
| content | binary | actual image data |
|
|
Extracts text from a PDF resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| pdf-name | text | the path of the file to be read from. As an alternative, binary data can be put inside as a child action. | ||
| read-password | text | the password of the input PDF if encrypted | ||
| pages | text | filter for specific pages of the input PDF; e.g. "3-8,12". Leaving it empty results in processing all pages |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Lists the resources (e.g. images) of a given PDF document. The resulting data can be used for e.g. saving the individual images by the "pdf:extract-images action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| pdf-name | text | the path of the file to be read from. As an alternative, binary data can be put inside as a child action. | ||
| read-password | text | the password of the input PDF if encrypted | ||
| pages | text | filters specific pages of the input PDF; e.g. "3-8,12"; only the related resources are listed. |
| Name | Type | Description |
|---|---|---|
| size | text | PDF file size (in bytes) |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| name | text | the name of the actual resource | |
| type | text | the type of the resource (e.g. "image") | |
| page | number | the number of the page this resource relates to |
|
|
Loads a PDF from binary data with options of filtering and password handling.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| pdf-name | text | the path of the file to be read from. As an alternative, binary data can be put inside as a child action. | ||
| read-password | text | the password of the input PDF if encrypted | ||
| pages | text | filters specific pages of the input PDF; e.g. "3-8,12" | ||
| encrypt-output | boolean | false | If true, the result PDF will be encrypted. By default, the original password (if any) is kept. | |
| encrypt-password | text | The password used for encrypting the result PDF. Only works if attribute "encrypt-output" is set to true. |
| Name | Type | Description |
|---|---|---|
| size | text | PDF file size (in bytes) |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
|
|
Merges several PDF documents into one PDF resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| encrypt-password | text | The password used for encrypting the result PDF. |
| Name | Type | Description |
|---|---|---|
| size | text | PDF file size (in bytes) |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Converts the pages of a PDF document to images.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| pdf-name | text | the path of the file to be read from. As an alternative, binary data can be put inside as a child action. | ||
| read-password | text | the password of the input PDF if encrypted | ||
| pages | text | filter for specific pages of the input PDF; e.g. "3-8,12". If not set, all pages will be processed. | ||
| format | text | jpg gif png bmp | jpg | Image format. |
| target-folder-path | text | the path to save the extracted images to. | ||
| filename | text | page | the filename to save the extracted images as. If it contains a "\page" string, the actual page number will be substituted (e.g. "\pageth_page" leads to files "10th_page", "20th_page" etc.); otherwise the page number will be added to the end of the value to which this attribute was set. | |
| leading-zero | boolean | false | If set to true, the page numbers will be written with leading zeros (e.g. 001, 002). The number of digits will be adapted to the largest number of page saved; for example, exporting pages 1..99 with leading zeros will lead to "01", "02", ..., "99". | |
| dpi | number | 300 | The DPI value for rendering the images. |
| Name | Type | Description |
|---|---|---|
| size | text | PDF file size (in bytes) |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| name | text | the name of the actual image (page01, page02 etc.) | |
| format | text | the format of the resource (e.g. "png") | |
| content | binary | actual image data |
|
|
|
|
|
|
Calls a REST API function.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| api-path | text | the (relative) API path, which will be appended to the base path defined in the rest:connection (e.g. /rest/api/2/project) | ||
| http-method | GET POST HEAD PUT DELETE PATCH | the HTTP method used (e.g. GET, POST) | ||
| content-type | text | application/json application/octet-stream application/pdf application/zip image/jpeg image/gif image/png text/html text/plain | type of the content | |
| result-type | json text binary | the return type of the result (if the operation has a result). The "json" type is automatically beautified | ||
| result-encoding | text | UTF-8 | the encoding of the server response, e.g. UTF-16 | |
| multipart | boolean | false | If set, the body of the request will be handled as a multipart request. In this case, rest:part children are expected. |
| Name | Type | Description |
|---|---|---|
| http_method | the HTTP method of the rest call | |
| rest_url | the complete rest URL sent to the server | |
| request_body | the request body sent to the server in case of e.g. a POST call | |
| request_parameters | the request parameters sent to the server in case of a GET or DELETE call | |
| header_parameters | the HTTP header parameters sent to the server | |
| http_response_code | number | the HTTP response code received from the REST server |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
Defines a REST connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | name of the connection | ||
| url* | text | Base URL of the server with the REST service | ||
| proxy | text | the proxy definition in the following format: [user:password@]host[:port] |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Refers to a header parameter of the rest:call action
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | name of the header parameter | |||
| value | value of the header parameter |
|
|
|
|
Refers to a multipart item of the rest:call action in case when attribute multipart is set to true.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| content-type | content-type of the multipart item. If it is a binary, default value is "application/octet-stream". For textual input, it is not mandatory, and there is no default value |
|
|
|
|
|
|
Refers to a parameter of the rest:call action
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | name of the parameter | |||
| value | value of the parameter |
|
|
Copies a resource to a specified location in the worker file system.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| from | text | source worker file system ID or path to be copied | ||
| to-folder | text | target folder on the worker file system | ||
| to-name | text | target name | ||
| overwrite | text | true | If a resource with the name used already exists in the target folder, we can set with this attribute what will happen. Value "true" indicates that this file will be overwritten; value "false" indicates that no file will be created. If some other string is specified (like "Copy of "), it will be added to the beginning of the resource title; if there is also a resource with this name, the first free number will be added to the end (like "Copy of Test Script (16)"). |
| Name | Type | Description |
|---|---|---|
| execution time | number | time interval while the action is executed |
|
|
|
|
Deletes the resource at the specified location in the worker file system.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename* | text | worker file system ID or path to be deleted |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
Return the list of files in the folder at a specified worker file system folder or returns details if the target is a file on the worker file system.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| path | text | Folder or file location on the worker file system. In case of a file, the result will only be the specified file with its details if details=true. | ||
| filename | text | filter expression for file names that can contain wildcard characters | ||
| details | boolean | false | whether to include file details | |
| recursive | boolean | false | whether to list files recursively |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of resources listed |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| filename | text | the relative file name of the actual resource | |
| fullpath | text | the relative file name of the actual resource | |
| id | text | the id of the actual resource | |
| size | number | file size (in bytes) | |
| dir | boolean | whether the actual resource is a folder | |
| type | text | folder file | the type of the actual resource |
| hidden | boolean | whether the actual resource is hidden | |
| readable | boolean | whether the actual resource is readable | |
| writable | boolean | whether the actual resource is writable | |
| executable | boolean | whether the actual resource is executable | |
| creationtime | date | the date when the actual resource was created. If it is not available (e.g. on the file system), it will be the last modification time | |
| lastmodificationtime | date | the date when the actual resource was last modified |
|
|
|
|
|
|
Returns true value if the file or folder exists in the specified location in the worker file system.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename | text | File location in the worker file system. In the last part of the path, wildcards (* and ?) can be used. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | Time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Moves a resource to a specified location in the worker file system.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| from | text | source worker file system ID or path to be moved | ||
| overwrite | text | true | If a resource with the name used already exists in the target folder, we can set with this attribute what will happen. Value "true" indicates that this file will be overwritten; value "false" indicates that no file will be created. If some other string is specified (like "Copy of "), it will be added to the beginning of the resource title; if there is also a resource with this name, the first free number will be added to the end (like "Copy of Test Script (16)"). |
| Name | Type | Description |
|---|---|---|
| execution time | number | time interval while the action is executed |
|
|
|
|
Reads data from a specified file on the worker file system.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename | text | worker file system ID or path | ||
| binary | boolean | false | If true, the resource is handled as a binary file, e.g., the new line characters will not be translated. | |
| encoding | text | the encoding of the input (text) file | ||
| head | number | we can specify to keep only a fixed number of the first lines for text files | ||
| tail | number | we can specify to keep only a fixed number of the last lines for text files | ||
| skip-head | number | 0 | we can specify to discard the first specified number of lines for text files. Formerly this attribute was called "skip" | |
| skip-tail | number | 0 | we can specify to discard the last specified number of lines for text files |
| Name | Type | Description |
|---|---|---|
| bytes | number | it is set when reading binary files, its value is the length of the file |
| lines | number | it is set when reading text files, its value is the number of lines read |
| rowcnt | number | it is set when reading text files, its value is the number of lines read (so it is the same as "lines") |
| encoding | text | The used encoding for reading the text file. It can be added by the "encoding" attribute, but it is also overwritten when a BOM is found at the beginning of the file. Choose from this set: ISO-8859-1, ISO-8859-2, UTF-8, UTF-16, UTF-32, UTF-16LE, UTF-16BE, UTF-32LE, UTF-32BE. |
| foundbom | boolean | it is true when the read parser found a BOM at the beginning of a text file |
| filename | text | the relative file name of the actual resource |
| fullpath | text | the full path of the actual resource |
| id | text | the id of the actual resource |
| size | text | file size (in bytes) |
| dir | boolean | whether the actual resource is a folder |
| type | text | the type of the actual resource |
| hidden | boolean | whether the actual resource is hidden |
| readable | boolean | whether the actual resource is readable |
| writable | boolean | whether the actual resource is writable |
| executable | boolean | whether the actual resource is executable |
| description | text | the description of the actual resource |
| creationtime | date | The date when the actual resource was created. If it is not available (e.g., on the file system), it will be the last modification time. |
| lastmodtime | date | the date when the actual resource was last modified |
| lastmodificationtime | date | the date when the actual resource was last modified; same as "lastmodtime" |
| execution_time | number | time interval while the action is executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
|
|
Writes its contents to a specified file on the worker file system.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename* | text | worker file system ID or path | ||
| append | boolean | false | append the file or not | |
| encoding | text | ISO-8859-1 ISO-8859-2 UTF-8 UTF-16 UTF-32 UTF-16LE UTF-16BE UTF-32LE UTF-32BE | UTF-8 | the encoding to use when writing text mode files |
| bom | boolean | false | if the write action append a BOM according to the encoding attribute, at the beginning of the file |
| Name | Type | Description |
|---|---|---|
| execution_time | number | time interval while the action is executed |
|
|
|
|
Calls a webservice.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | name of the function to call | ||
| namespace | text | namespace of the webservice method | ||
| connection-name | text | name of the connection | ||
| address | text | address of the webservice method | ||
| action | text | |||
| ns-prefix | text | namespace prefix | ||
| result-format | text | format of the result |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of rows returned (if output-type is "table") |
|
|
Creates a webservice connection.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | name of the connection | ||
| server | text | name of the server to connect | ||
| port | number | number of the port to connect | ||
| user | text | name of the user | ||
| password | text | password for the user | ||
| cpassword | text | encripted password for the user | ||
| wsdl-uri | text | path of the WSDL file to use | ||
| address | text | the address of the webservice | ||
| proxy-address | text | the address of a proxy used. Format is address[:port] | ||
| proxy-type | text | HTTP SOCKS DIRECT | HTTP | the type of the proxy. |
|
|
Specified a parameter for webservice method calling.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | name of the parameter | ||
| type | text | type of the parameter | ||
| ns-prefix | text | namespace of the parameter | ||
| null | boolean | if yes or true, the value will be handled as null value |
|
|
Specifies a parameter value for the xslt processor.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | the xslt parameter name |
| Name | Type | Possible Values | Description |
|---|
|
|
Executes an xquery expression on an xml resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| xquery | text | the xquery expression | ||
| omit-xml-declaration | boolean | true | if "true", the starting xml declaration tag will be omitted |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
Transforms the content by using the specified xslt file. Parameters can be set by the xslt:param action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| xsl | text | the XSLT file name that transforms the source XML | ||
| xsl-value | text | XSLT code that transforms the source XML | ||
| write-xml-header | boolean | true | if "true", a standard header will be included in the result XML | |
| merging | boolean | false | if "true", the source XML files are merged | |
| encoding | text | ISO-8859-1 ISO-8859-2 UTF-8 UTF-16 UTF-32 UTF-16LE UTF-16BE UTF-32LE UTF-32BE | The used encoding for the XSLT file. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
|
|
|
|
Defines a variable with a given name. The variable value will be set to the evaluated value of the content. Alias is the synonym of "variable".
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | the name of the variable | ||
| monitor | boolean | false | if "true", the variable can be monitored in real-time by the Zagreus Monitor | |
| scope | text | local global | local | the scope of the variable |
|
|
|
|
|
|
|
|
Creates an associated array from its content. The items of the generated array can be accessed by using their index or, if the source item action has an alias attribute, this alias can be used as an identifier.
| Name | Type | Possible Values | Default Value | Description |
|---|
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Encapsulates further Zagreus actions; can be used to define logical levels within a script. Also affects the visibility of variables.
|
|
|
|
Breaks the current loop processing in actions z:while, z:foreach, z:for. Calling this action will finish the execution of the closest ancestor loop.
|
|
Calls a template defined by the z:template action. The values of the contained z:param subactions will be propagated as actual parameters of the template.
| Name | Type | Possible Values | Default Value | Description |
|---|
|
|
Executes its content when its specified value matches its parent action z:switch test expression
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| value* | text | expression that is compared with the test expression. | ||
| value-reg* | text | regular expression that is compared with the test expression. |
|
|
Converts the content to a different data type. For tables and records, the individual columns might be treated differently, specified either by the "columns" attribute, or the "z:column" child action
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| type* | text | boolean date number text time auto | The data type to be cast to. If the affected columns are also specified, then multiple data types can be listed (separated by ";"s), but this number must match the number of columns set. | |
| columns* | text | If the input is a table or a record, the affected columns / fields can be specified (separated by ";"s) | ||
| autodetect-type | boolean | false | If set to true, all values will be autodetected to the supported types (i.e. null, boolean, number, date, time or text), based on the actual individual value. For tables and records, the columns specified in the "columns" attribute or in the z:column child action are exceptions to this rule | |
| input-number-format | text | The format used for parsing numbers; applies for all numeric columns | ||
| input-locale | text | The locale used for parsing numbers (e.g. "de", "en", "at"); applies for all numeric columns | ||
| input-date-format | text | The format used for parsing dates; applies for all date columns |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Specifies column information for the "z:cast" parent action
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | If name of the column | ||
| type* | text | boolean date number text time auto | The data type to be cast to | |
| input-number-format | text | The format used for parsing numbers; applies for all numeric columns | ||
| input-locale | text | The locale used for parsing numbers (e.g. "de", "en", "at"); applies for all numeric columns | ||
| input-date-format | text | The format used for parsing dates; applies for all date columns |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | the length of time the action was executed |
|
|
Compares the results of the first 2 child actions. Comparing is done in row-oriented way like unix command "diff". The result is a boolean value indicating whether the two compared things are the same or no; the actual differences are stored in a result attribute.
| Name | Type | Description |
|---|---|---|
| differences | text | a list of differences, each entry in this list is a pair of the corresponding intervals where the difference was found |
| count | number | number of differences (the size of the differences list) |
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
Breaks the current loop processing in actions z:while, z:for and z:foreach and proceeds with the next element. Calling this action will finish the execution of the closest ancestor loop.
|
|
Converts a list or table object to a CSV format text
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| row-separator | text | new line character | the row separator | |
| column-separator | text | ; | the column separator | |
| header | boolean | true | whether or not include header |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Decodes the content. The input and the optional further parameters (key and iv) can be binary or text; another option is to specify them in a hexadecimal format, using the "hex:" prefix (e.g. "hex:06FF")
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| method | text | BASE64 AES-256 or AES-256-CBC | BASE64 | method used for decoding |
| result-type | text | text binary BASE64 hex | text | the format of the decrypted result |
| key | text/binary | the key for the AES-256 decryption | ||
| iv | text/binary | the iv for the AES-256 decryption | ||
| encoding | text | character encoding of the input/output strings (if any) |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Generates the (set-like) difference of the result of subcontents; i.e. the result will contain those elements of the first subcontent which are not present in the second one. Designed to work well for tables, lists, records and texts.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| symmetric | boolean | false | If true, the result will contain the elements of both sets which are not present in the other; if false, the result will contain only the elements of the first subcontent which are not present in the second one. |
|
|
|
|
Executes the enclosing content while the test condition is evaluated as true (but at least once). Execution can be stopped by calling action "z:break".
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| test-expr* | text | loop condition expression | ||
| loop-counter | text | specifies the name of the implicit variable which is used for counting the loops. If set, this variable is changing its value in every loop cycle. | ||
| monitor-counter | boolean | false | if set to true, the loop counter variable will be set as a monitoring variable |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| loopcnt | number | the total count the loop was executed |
|
|
Creates a documentation of the specified script in pdf format.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename* | text | the location of the source script | ||
| version | text | the version of the source script | ||
| justicon | boolean | false | draw just icons for the main script | |
| graphview | boolean | true | should we draw the hierarchical structure | |
| graphpage | text | A4portrait A4landscape A3portrait A3landscape | A4portrait | the page type of the hierarchical structure |
| graphsize | text | normal small tiny | normal | the size of the icons in the hierarchical structure |
| display-level | number | until which level should we draw the elements in the details view. They all will be listed, however | ||
| elements | text | we also draw these elements in the details view, regardless of the value of "display-level" | ||
| header-left | text | Zagreus v#{zagreusversion} | left header of a page | |
| header-center | text | #{scriptname} | center header of a page | |
| header-right | text | #{logo} | right header of a page | |
| footer-left | text | © Etixpert GmbH. | left footer of a page | |
| footer-center | text | #{page} of #{numpages} | center footer of a page | |
| footer-right | text | #{date} | right footer of a page | |
| zagreus-version | text | 1.5 | the version of Zagreus | |
| include-xml | boolean | true | should we also include the XML source |
|
|
Defines an else block inside a z:if statement
|
|
Encodes the content. The input and the optional further parameters (key and iv) can be binary or text; another option is to specify them in a hexadecimal format, using the "hex:" prefix (e.g. "hex:06FF")
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| method | text | BASE64 AES-256 or AES-256-CBC | BASE64 | method used for encoding |
| result-type | text | binary BASE64 hex | binary | the format of the encrypted result |
| key | text/binary | the key for the AES-256 encryption | ||
| iv | text/binary | the iv for the AES-256 encryption | ||
| encoding | text | character encoding of the input/output strings (if any) |
|
|
|
|
|
|
Evaluates the content of the action as a script. Operates similarly to the "eval" function.
|
|
Executes the specified external script (e.g. python, R, Powershell) with the predefined executor binary. The content of the external script can be specified as a child element / child text content, or by filling the id / name attributes. The external script is first saved in the worker filesystem temporary folder. Its name can be customized with the "tempfilename" attribute, otherwise it will be generated automatically with the current timestamp.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| id | text | the id of the resource containing the external script | ||
| name | text | the full path of the resource containing the external script | ||
| type | text | the type of the script to be executed externally (e.g. python). The types are configured dynamically in the worker.properties file | ||
| async | boolean | false | if set to "true", script execution does not wait for the end of the execution, it returns immediately | |
| params | text | Additional command line parameters for the execution can be specified in this attribute. When it is empty, the first parameter after the executor binary is the script copied to the temporary worker filesystem folder. If this attribute is filled, the parameters specified in this attribute will be concatenated after the path of the saved script. If, however, the value of this attribute contains the "#tempfilename" string, then the full path of the saved script will be inserted at the position specified by this string. Use it this way when the script path is not the first parameter of the full command line. (See the examples below.) | ||
| tempfilename | text | Specifies the file name of the saved external script. If left empty, but the value of the "name" attribute is filled, the name and extension of the source file path will be used. If the "name" attribute is left blank as well, the filename "script" will be used instead. In the latter two cases, the execution time stamp will also be added to the actual filename. |
| Name | Type | Description |
|---|---|---|
| exit_value | number | exit value (e.g. error code) of the external process when async="false" |
| output_filename | text | filename containing the output stream of the external process when async="true" |
| error_filename | text | filename containing the error stream of the external process when async="true" |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
|
|
Exits from the execution engine. The content of the action or the value of the "message" attribute will be propagated to the server as the return value.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| message | text | the result message of the script. When set to "invisible", the job will not be listed in Finished jobs list or in the Monitor. | ||
| status | text | finished error cancelled | finished | the intended status of the executed job |
|
|
|
|
Selects the items from its contained iterable data that matches the specified selection expression. Some characters ("\", "*", "(" and ")") must be escaped with "\". E.g.: "(Q1)" can be used in where-expr as "\(Q1\)".
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| select | text | Select and/or rename columns of the data (works only on tables). The supported format is the comma separated list of column specifiers. Column specifier is the name of the column, and here it is possible to rename the column name using the format "new_name = old_name". | ||
| key | text | this | name of the variable that refers to the current item | |
| where-expr | text | the selection expression | ||
| row-separator | text | row separator character when parsing multi-line texts | ||
| distinct | boolean | if "true", the action returns only distinct (different) items |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows selected |
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
|
|
Sends an event to the Zagreus server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| event-id* | text | the identifier of the event to fire |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Defines a for loop. Only operates with integer values. Execution can be stopped by calling action "z:break", and "z:continue" is handled as usual.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| loop-counter* | text | loop counter variable name | ||
| from* | number | numeric value where the for loop initiates | ||
| to* | number | numeric value where the for loop ends | ||
| step | number | 1 | numeric value for the step size | |
| monitor-counter | boolean | false | if set to true, the loop counter variable will be set as a monitoring variable |
| Name | Type | Description |
|---|---|---|
| loopcnt | number | the total count the loop was executed |
| execution_time | number | the length of time the action was executed |
|
|
|
|
Executes the enclosing content on all items of an iterable expression. Execution can be stopped by calling action "z:break". When performing parallel execution, the id of the actual thread can be accessed by the inner variable "parallelThreadId".
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| in* | text | The iterable expression. Instead of an attribute, a nested action "z:in" can also be used (see the examples). | ||
| key* | text | the name of the variable that will refer to the current item | ||
| parallel | number | 1 | the number of parallel executable loop items | |
| loop-counter | text | specifies the name of the implicit variable which is used for counting the loops. If set, this variable is changing its value in every loop cycle. | ||
| monitor-counter | boolean | false | if set to true, the loop counter variable will be set as a monitoring variable |
| Name | Type | Description |
|---|---|---|
| loopcnt | number | the total count the loop was executed |
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
|
|
Transforms the contained data to formatted textual representation.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| type | text | text ini xml html | text | format specifier |
| row-separator | text | row separator character | ||
| column-separator | text | column separator character | ||
| header | boolean | false | if "false", the header information will not be generated |
|
|
|
|
Filters the result of the child actions to keep only the first N lines. If the input is a list, then it keeps the first N elements. If the skip attribute is set, then the first given number of lines are ignored.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| lines | number | 10 | the number of lines to keep | |
| skip | number | 0 | the number of lines which will be skipped from the start of the input |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
|
|
|
|
|
|
Executes one of its enclosed subactions "z:then" or "z:else" depending on the test condition.
| Name | Type | Possible Values | Default Value | Description |
|---|
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Includes and executes the content of a specified script file.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename* | text | the location of the script file |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Generates the (set-like) intersection of the result of subcontents. Designed to work well for tables, lists, records and texts.
|
|
Calls an external java method. The specified method should be static, should have String[] as input parameter. When calling, the results of the z:param subactions of the z:java action will be passed as parameters. If z:param is specified with name, the name, starting with a dash symbol will be inserted before the value. The result of the action will be the text value that converted from the result of the method call.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| class* | text | the class name. The specified class should be accessible for the engine, so the jar file that contains it should be in a folder that configured as classpath folder | ||
| method | text | execute | the method name in the specified class. The method should be static, and only have one String[] argument |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
Joins the information of its subactions. The limit for joining 2 tables with 4GB worker memory is the following (for both tables table): input table size is ca. 400 MB with c.a. 1.000.000 rows and 16 columns where one row contains ca. 400 bytes information (e.g. one ID column with integers and each other columns contain 27 characters)
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| select* | text | Select and/or rename columns of the data (works only on tables). The supported format is the comma separated list of column specifiers. Column specifier is the name of the column, and here it is possible to rename the column name using an alias. Both "alias = column_reference" and "column_reference = alias" works; the one which does not contain a dot will be handled as the alias. Note that it is not checked whether the referenced columns indeed exist in the input tables; if not, then these will be handled as missing values, which might lead to an empty result. | ||
| where-expr | text | Selection condition expression. This expression uses the alias parameters of the subactions "from" to identify the data source. Join operators: = No Outer Join += Right Outer Join =+ Left Outer Join +=+ Full Outer Join | ||
| distinct | boolean | false | if set to "true", rows with the same values will be filtered out | |
| case-insensitive | boolean | false | if set to "true", the join will be performed in a case insensitive way (i.e. case of letters will not matter) |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
Creates a list typed value from its content.
|
|
|
|
Writes its content to the connected logging device. When there is a custom log connection specified by action "z:logfile", this action writes into the given file. Otherwise in standalone mode it displays the log info on the standard output, while in embedded mode it sends data to the server logger. The log message will be only displayed when its level is not after the specified loglevel in the ordered list of possible values.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| level | text | user error warning info debug | user | the log level of the message |
| null-format | text | The format of the "null" elements in the result of the action. "_empty" refers to an empty string, otherwise the given text will be used. Default value is "". |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Specifies a custom log target.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename | text | Path of the target. If not specified or its value is empty, the log target will be switched back to the system logger. | ||
| indent | boolean | true | if set to "true", the log file will show structure information by using indenting |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Specifies the log level for the current action context. A log message will be only displayed when its level is not after the specified loglevel in the ordered list of possible values.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| level | text | user error warning info debug | user | the log level |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Inverts the boolean value comes from its content.
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Creates an error handler for the specified error. The content of the action is executed when a not handled error is happened somewhere in the descendent actions of the parent action. During the handler execution the local variable "error" can be used to access the context where the handled error happened. After handling the error it will not be propagated to the next handler upwards, unless "z:raise" action is invoked directly.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| error-name* | text | the name of the error to handle |
|
|
|
|
|
|
|
|
Creates an event handler for the specified event. The content of this action will be executed when the specified event occurrs.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| event-name * | text | before-child before-all-children after-child after-all-children | before-all-children | name of the event to handle |
|
|
Defines a parameter for template definition (action z:template) and for template calling (action z:call-template). The parameter value is set to the evaluated content expression.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name * | text | name of the parameter |
|
|
|
|
Transforms the contained textual content to iterable expression.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| row-separator | text | \n | character that used for separating rows | |
| column-separator | text | \t | character that used for separating columns | |
| column-names | text | Comma separated list of names, that will be used as column names. If specified, attribute "header" has no effect. | ||
| fixed-fields | text | Defines the beginning and ending of columns. If specified, column-separator char setting will not be used. The format of this attribute is a comma separated list of column definition sequences in the form "from-to". "from" and "to" measure character position in a row, the first character has position 1. If "from" or "to" are missing, their values will be 1 or the length of the row, respectively. | ||
| header | boolean | false | if "true", the first row is treated as header info for columns | |
| type | text | If set to "ini", the source will be handled as ini file, i.e. rows of name=value pairs. In this case the generated text uses the row-separator as line separator, attributes "column-separator" and "header" have no effect. | ||
| quotation | text | Defines the character (e.g. double quote character) which is used to indicate the special case when there is a column-separator character is present inside the text. | ||
| quotation-start | text | If the quotation starting and ending characters are different, this attribute can be used to specify the starting one. | ||
| quotation-end | text | If the quotation starting and ending characters are different, this attribute can be used to specify the ending one. |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| columncnt | number | number of columns generated |
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Throws an error with the specified name. The generated error should be handled by an error handler (action z:on-error) for an ascendant action, otherwise the execution of the script will stop with error.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| error-name* | text | the name of the error to raise |
|
|
|
|
Return from the parent action. The parent action will get the result of z:return action as content.
| Name | Type | Description |
|---|---|---|
| stackTrace | text | the stacktrace of the last error |
| errorMessage | number | the last error message |
|
|
Reverses the result of the child actions: if the input is a list or a table, it reverses the order of elements; if the input is text, it reverses the lines.
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | the length of time the action was executed |
|
|
Sorts the content of the action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| key | text | this | the variable that represents the row | |
| order-by* | text | Ordering expression. Ordering expression contain field expressions, separated by commas. Field expressions are expressions that can refer to row dependent data (e.g. the fields of the variable that specified in the "key" attribute). Field expressions can include the ordering direction: "asc" or "desc". | ||
| distinct | boolean | false | if set to "true", rows with the same values will be filtered out |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | the length of time the action was executed |
|
|
Executes one of its enclosed subaction "z:case" or "z:else" depending on the test condition.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| test-expr* | text | selection condition expression |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Waits finishing all async executions that started within the action. Async executions are action executions that supply async event listener. At this moment the only available action of this kind is the "zs:runscript".
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Executes the contained external command, and returns the generated standard output as result.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| async | boolean | false | if set to "true", script execution does not wait for the end of the execution, it returns immediately | |
| shell | text | sh cmd | Specifies the command processor that will be used for executing. "sh" for Linux and Unix systems, "cmd" for Windows system. | |
| shell-param | text | -c /c | Specifies the first parameter for the command processor. This attribute should inform the command processor that the next argument is a text that contains the executing expression. "-c" for "sh" shell, "/c" for "cmd" command processor. | |
| encoding | text | the encoding name to use for output encoding | ||
| parse-quotes | boolean | false | whether we should treat parts inside quotes as one token or no | |
| success-exit-codes | text | 0 | the comma-separated list of acceptable exit codes (treated as success). In some special cases, not only exit-code=0 is treated successful. Only applied when async="false" |
| Name | Type | Description |
|---|---|---|
| exit_value | number | return value of the system |
| rowcnt | number | number of rows generated |
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
|
|
Filters the result of the child actions to keep only the last N lines. If the input is a list, then it keeps the last N elements. If the skip attribute is set, then the first given number of lines are first ignored.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| lines | number | 10 | the number of lines to keep | |
| skip | number | 0 | the number of lines which will be skipped from the end of the input. Takes precedence over "lines", i.e. lines="10" skip="5" will keep the 6th...15th lines from the end. If only "skip" is specified, all other lines will be kept |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Defines a template with the specified name. The content of the template will be executed when the template is called by z:call-template. The values of the contained z:param subactions defines the formal parameters with their default values, these parameters can be modified by the actual parameters of the z:call-template.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | name of the template to define |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Creates a text typed value from its content.
|
|
|
|
|
|
Defines a then block inside a z:if statement
|
|
Generates the unions of the result of subcontents.
|
|
Defines a variable with a given name. The variable value will be set to the evaluated value of the content. Variable is the synonym of "alias".
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | the name of the variable | ||
| monitor | boolean | false | if "true", the variable can be monitored in real-time by the Zagreus Monitor | |
| scope | text | local global | local | the scope of the variable |
|
|
|
|
|
|
|
|
Executes the enclosing content while the test condition is evaluated as true. Execution can be stopped by calling action "z:break".
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| test-expr* | text | loop condition expression | ||
| loop-counter | text | specifies the name of the implicit variable which is used for counting the loops. If set, this variable is changing its value in every loop cycle. | ||
| monitor-counter | boolean | false | if set to true, the loop counter variable will be set as a monitoring variable |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| loopcnt | number | the total count the loop was executed |
|
|
Reads the entry names from a zipped file.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename | text | name the zipped file | ||
| path | text | the item prefix in the zipped file | ||
| details | boolean | false | whether to include file details |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | number of rows generated |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| filename | text | the name of the resource in the zip file | |
| size | number | the size of the resource in the zip file | |
| dir | text | whether the resource is a directory or not in the zip file | |
| lastmodtime | date | last modification time of the resource in the zip file | |
| compressedsize | number | the compressed size of the resource in the zip file |
|
|
|
|
Creates a zip resource. The contained item resources will be packed into the created resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| password | text | the password for the file | ||
| cpassword | text | the encrypted password for the file | ||
| wildcard | text | It is a path to the target file(s). When specified, the filtered items by the wildcard are also added to the ZIP file. Asterisk (*) and question mark (?) characters can also be used. Note: other child action (e.g. file:read) is not needed. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
|
|
Specifies an item to packed into a zip file. Its content will be packed and stored in a zip resource file using the specified name.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename | text | the name of the item in the packed file |
| Name | Type | Possible Values | Description |
|---|
|
|
Reads an entry from a zipped file.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| filename | text | name the zipped file | ||
| path | text | the item name in the zipped file | ||
| password | text | the password for the item (if any) | ||
| cpassword | text | the encrypted password for the item | ||
| binary | boolean | true | if true, the readed item will handled as binary file |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Creates a backup dump of the Zagreus SQL metadata.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| folder* | text | The root target folder for the backup. It is an operational system native path (e.g. "C:\BackupFolder"). | ||
| zip | boolean | false | if set to "true", the result will be packed into a zip file |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Cancels a job on a remote Zagreus server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Defines a connection to another Zagreus server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | Name of the connection. This name has to be used in the other Zagreus Server actions; if left blank, the action will refer to the Zagreus server where the actual script is stored. | ||
| server* | text | the name or IP address of the server | ||
| port | number | 7323 | port address of the server | |
| user* | text | user name for authentication | ||
| password | text | password for user authentication | ||
| cpassword | text | encrypted password for user authentication | ||
| secure | boolean | false | whether the connection should be secure or non-secure |
| Name | Type | Description |
|---|---|---|
| server | text | the name or IP address of the server |
| port | number | port address of the server |
| user | text | user name for authentication |
| secure | boolean | whether the connection should be secure or non-secure |
| execution_time | number | the length of time the action was executed |
|
|
Copies a resource to another folder (but within the same Zagreus server).
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| target-name | text | the new name of the copied resource | ||
| copy-parameters | boolean | false | should the script parameters (variables and options) be also copied or not | |
| overwrite | text | true | If a resource with the name used already exists in the target folder, we can set with this attribute what will happen. Value "true" indicates that this file will be overwritten; value "false" indicates that no file will be created. If some other string is specified (like "Copy of "), it will be added to the beginning of the resource title; if there is also a resource with this name, the first free number will be added to the end (like "Copy of Test Script (16)"). | |
| all-versions | boolean | true | should we copy all versions of the resource or not |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Creates an event schedule.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| event-name* | text | the name of the new event schedule | ||
| event-id | text | the id of the new event | ||
| description | text | the description of the new event schedule | ||
| overwrite | text | true | If a resource with the name used already exists in the target folder, we can set with this attribute what will happen. Value "true" indicates that this file will be overwritten; value "false" indicates that no file will be created. If some other string is specified (like "Copy of "), it will be added to the beginning of the resource title; if there is also a resource with this name, the first free number will be added to the end (like "Copy of Test Script (16)"). |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Creates a resource on the Zagreus server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| resource-name* | text | the name of the new resource | ||
| resource-id | text | the id of the new resource. The version of the script can be specified by the version number written at the end of the ID (e.g.: |&1.0.0.2). | ||
| type | text | binary connection event folder script template timeschedule | script | the type of the new resource |
| description | text | the description of the new resource | ||
| current | boolean | true | if set, this version should be the current version | |
| overwrite | text | true | If a resource with the name used already exists in the target folder, we can set with this attribute what will happen. Value "true" indicates that this file will be overwritten; value "false" indicates that no file will be created. If some other string is specified (like "Copy of "), it will be added to the beginning of the resource title; if there is also a resource with this name, the first free number will be added to the end (like "Copy of Test Script (16)"). |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Creates a time schedule. All timing parameters which are not set are set to the first available option if they are smaller than the first set parameter, and to "every" if they are greater. Thus, if only hour="10" is set, the time schedule will fire every day at 10:00:00. If hour="10" and month="1-4" is set, the time schedule will fire every day at 10:00:00 in January, February, March and April (and, of course, every year).
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| schedule-name* | text | the name of the new time schedule | ||
| schedule-id | text | the id of the new time schedule | ||
| description | text | the description of the new time schedule | ||
| overwrite | text | true | If a resource with the name used already exists in the target folder, we can set with this attribute what will happen. Value "true" indicates that this file will be overwritten; value "false" indicates that no file will be created. If some other string is specified (like "Copy of "), it will be added to the beginning of the resource title; if there is also a resource with this name, the first free number will be added to the end (like "Copy of Test Script (16)"). | |
| year | number | the year parameter | ||
| day-of-week | number | the day-of-week parameter | ||
| month | number | the month parameter | ||
| day | number | the day parameter; if set, overrides the day-of-week parameter | ||
| hour | number | the hour parameter | ||
| minute | number | the minute parameter | ||
| second | number | the second parameter |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Creates a script on the Zagreus server. There is the possibility to set the script parameters and options.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | number | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| script-name* | number | the name of the new script | ||
| script-id | number | The id of the new script. The version of the script can be specified by the version number written to the end of the ID (e.g.: |&1.0.0.2). | ||
| description | number | the description of the new script | ||
| overwrite | text | true | If a resource with the name used already exists in the target folder, we can set with this attribute what will happen. Value "true" indicates that this file will be overwritten; value "false" indicates that no file will be created. If some other string is specified (like "Copy of "), it will be added to the beginning of the resource title; if there is also a resource with this name, the first free number will be added to the end (like "Copy of Test Script (16)"). |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Deletes a resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Makes the server side recycle bin empty.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Groups filter expressions for the zs:joblist action. It can contain filter definitions and other filter-groups also, making possible to compose complex filtering expressions.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| operator* | text | AND OR NOT | the relation of the check |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Defines a filter expression for the zs:joblist action. Usually, it is contained by zs:filter-group, but can be used without explicit grouping also, in this case, the filter expressions will be stored in an implicitly created AND group.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| variable* | text | Name of the variable (job property) to check. The "job.status" property can be filtered both by integer and string values. | ||
| operator* | text | < <= = <> => > between in like | the relation of the check | |
| value* | text | a constant value; for between and in, multiple values can be defined, separated by ";"s |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Fires an event on a remote Zagreus server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Gives the status of the lastly executed job of a given script.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running |
| Name | Type | Description |
|---|---|---|
| jobId | text | the ID of the last job |
| status | number | the status of the last job |
| statusname | text | the status of the last job |
| scriptid | text | the ID of the script |
| scriptname | text | the name of the script |
| scriptpath | text | the path of the script |
| beginexectime | date | the begin execution time of the last job |
| endexectime | date | the end execution time of the last job |
| beginqueuetime | date | the begin queue time of the last job |
| endqueuetime | date | the end queue time of the last job |
| caller | text | the caller of the last job |
| callertype | number | the caller type of the last job |
| callertypename | text | the caller type of the last job |
| execpriority | number | the priority of the last job |
| execmode | number | |
| numoflogs | number | |
| workerid | number | |
| userid | number | |
| parentjobid | text | |
| resulttimeout | number | |
| workercontrollerid | number | |
| resulttype | number | |
| result | ||
| message | text | |
| variables | text | |
| options | text | |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Gets the log file of the job specified by its id.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| job-id | text | the job identifier |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Downloads a resource from the Zagreus server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| output | text | the name of the local file to download to |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Gives a list of the skipped jobs. Skipped jobs are ones which were scheduled via a time schedule, but were not even queued (e.g. because the Zagreus server was down). The list can be filtered to a time interval.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| subscription-id | number | the id of the subscription | ||
| from* | date | The skipped jobs will be listed starting from this time. The format of this attribute can be a simple string: yyyy-MM-dd hh:mm:ss, or it can be defined as a date type (see example below). | ||
| to | date | the actual time | the skipped jobs will be listed up to this time |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of jobs found |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| subscriptionid | number | ||
| scriptid | |||
| scriptname | |||
| scriptpath | |||
| scheduleid | |||
| schedulename | |||
| schedulepath | |||
| time | date |
|
|
|
|
Gets the variables and options of a resource, job, user or group. The variables and options are available as result-attributes. If no variables nor options are specified, all variables and options will be returned; otherwise only the ones which were listed inside this action with the zs:variable and zs:option actions.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
Gives information about a specified job.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| job-id* | text | the id of the job to query |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| jobId | |||
| status | number | ||
| statusname | |||
| scriptid | |||
| scriptname | |||
| scriptpath | |||
| beginexectime | date | ||
| endexectime | date | ||
| beginqueuetime | date | ||
| endqueuetime | date | ||
| execmode | |||
| execpriority | number | ||
| numoflogs | number | ||
| workerid | number | ||
| userid | number | ||
| caller | |||
| callertype | number | ||
| callertypename | text | ||
| parentjobid | |||
| resulttimeout | |||
| workercontrollerid | number | ||
| resulttype | |||
| result | |||
| message | text | ||
| variables | |||
| options |
|
|
Gives a list of all the jobs. By default jobs which are currently running, shutting down, or are queued are listed, but this can be changed, either by using numeric or text values. Moreover, the jobs can be filtered on every possible property.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| status | text | finished queued cancelled error debugging running runningtimeout queuetimeout starting suspended | running;queued | list of the states of jobs to be listed, separated by semicolons (";") |
| order | text | One can also set the order in which the jobs are returned. All returned fields can be set; when multiple attributes are chosen, they must be separated by ";"s. By default, jobs are sorted in ascending order; descending can be specified by adding "desc" after an attribute, separated by ":". E.g. "status;endexecutiontime:desc" sorts the jobs returned by status; jobs with the same status are sorted by end execution time, in descending order. | ||
| max-rows | number | 100 | the maximum number of jobs returned |
| Name | Type | Description |
|---|---|---|
| rowcnt | the number of jobs found | |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| jobId | |||
| status | number | ||
| statusname | |||
| scriptid | |||
| scriptname | |||
| scriptpath | |||
| beginexecutiontime | date | ||
| endexecutiontime | date | ||
| beginqueuetime | date | ||
| endqueuetime | date | ||
| caller | |||
| callertype | number | ||
| callertypename |
|
|
Lists the child resources of a given resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| current-version-only | boolean | false | if set to "true", only the current versions will be listed | |
| recursive | boolean | false | if "true", the content of all subfolders will also be listed |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of resources found |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| name | |||
| id | |||
| fullpath | |||
| ownderid | number | ||
| parentid | |||
| creationtime | date | ||
| createdby | number | ||
| modificationtime | date | ||
| type | |||
| description | |||
| contenttype | |||
| current | boolean | ||
| deleted | boolean |
|
|
zs:migrate-subscription is designed for migrating subscriptions between two Zagreus servers. It copies all data of the subscriptions, including variables, options, aliases, and their active status. The subscriptions to be migrated can be specified by scripts, schedules, or both. Further filtering can be applied by specifying the alias(es) of the subscriptions as well. Note that the IDs of both the schedules and the scripts have to be the same on the two Zagreus servers for all subscriptions involved. Also note that the IDs of the subscriptions will not match.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| source-connection-name | text | name of the source Zagreus connection | ||
| target-connection-name | text | name of the target Zagreus connection | ||
| alias-filter | text | the alias of the subscriptions to be migrated to the target server. Can be separated by ";"s or ","s. | ||
| delete-existing | boolean | false | If "true", the subscriptions matching the specified criteria will first be deleted on the target server. See the examples below. | |
| set-inactive | boolean | false | If "true", the migrated subscriptions will be set to inactive on the target server. |
| Name | Type | Description |
|---|---|---|
| migrated_subscriptions | list | A list of records (table) of the migrated subscriptions. |
| skipped_subscriptions | list | A list of records (table) of the subscriptions which were skipped because the script/schedule with the given ID did not exist on the target server, or was of different type. |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
|
|
|
|
|
|
zs:migrate-user-group is a complex action for migrating users or groups between two Zagreus servers. It can create groups for user migration as well if needed.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| source-connection-name | text | name of the source Zagreus connection | ||
| target-connection-name | text | name of the target Zagreus connection | ||
| auto-group-creation | boolean | false | If "true", the groups mapped to user rights will be created on the target side. If false, and the particular groups do not exist on target side, an error is thrown. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
zs:migrate is a complex action for migrating resources between two Zagreus servers. It can migrate simple resources or folder structures as well. If the resource does not exist in the target folder with the given name, it will be created and the source resource ID will be used. If the resource exists in the target folder with the same name, there are two options based on the resource ID of the resource: - if resource IDs are the same, the target resource will be overwritten - if resource IDs are different, an error message will be thrown. When a folder is copied, the structure is processed in recursive way. The settings are applied to single resources one by one.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| source-connection-name | text | name of the source Zagreus connection | ||
| target-connection-name | text | name of the target Zagreus connection | ||
| overwrite | boolean | true | If "true", the specific resource with the same version will be overwritten on the target side. If false, the target will be left unchanged. If increment-version is set to true, overwrite attribute will be ignored. | |
| overwrite-options-and-variables | boolean | true | In case of the resource is a script, if this attribute is "true", the variables and options of the source script will overwrite the variables and options of the existing resource. When set to "false", the variables and options of the target script will remain. | |
| all-versions | boolean | false | If "true", all versions of a resource will be migrated. If it is set to false, only the current version, or the specified version will be copied. | |
| force-current-version | boolean | false | If "true", the copied resource will be set to current on the target side. This setting is ignored if all-versions is true. | |
| keep-current-version | text | source target | source | If it is set to source, the source side version of the resource will be set on target after copying. If increment-version = true, the incremented one is set to current on the target side. If it is set to target, if there was an existing target resource, the current version will not be altered. |
| increment-version | boolean | false | If "true" all versions on the source side are saved as new versions (incremented ones) on the target side. If target was not existing, we copy simply all the versions as they are. Overwrite attribute is ignored in this case. | |
| keep-id | boolean | true | weather the migration process keeps the source ids for folders and other resources. | |
| only-content | boolean | false | If it is "false", the migration process does not create the first parent folder, only scans its content recursively. It is the only way to rename a parent folder by migration, e.g.: source-name: /users/test, target-name=/users/test2. | |
| keep-dates | boolean | true | if set to "true", it keeps the original creation and modification times; if set to false, these will be set to the current server time | |
| recursive | boolean | true | This setting is valid only if the source resource is a folder. If set to true, all the folder contents will be migrated recursively as well, otherwise only the folder will be created. | |
| copy-filesystem | boolean | true | If the content of the filesystem folder would be migrated. When it is set to false, no filesystem resources will be migrated. It works only in case of user migration. If "source-name" is a user and copy-filesystem="true", the content of the filesystem will be migrated as well. Otherwise only the metadata content will be copied on the target. If the source user name and the target user name are different you can use only-content="true" attribute to metadata and filesystem content will be in the right place. |
| Name | Type | Description |
|---|---|---|
| migratedresources | list | A list of records (table) of the migrated resources. |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
|
|
|
|
|
|
Moves a resource to another folder, or renames it. The id of the resource remains the same.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| target-name | text | the new name of the resource | ||
| overwrite | text | Copy of | If a resource with the name used already exists in the target folder, we can set with this attribute what will happen. Value "true" indicates that this file will be overwritten; value "false" indicates that no file will be created. If some other string is specified (like "Copy of "), it will be added to the beginning of the resource title; if there is also a resource with this name, the first free number will be added to the end (like "Copy of Test Script (16)"). |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Defines an option for a resource, job, user or group.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | the name of the option | ||
| value | text | The value of the option. If left blank, the content of the action will be used instead. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Gives information about a specified resource.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| name | text | ||
| id | text | ||
| fullpath | text | ||
| ownerid | number | ||
| parentid | text | ||
| creationtime | date | ||
| createdby | number | ||
| modificationtime | date | ||
| modifiedby | number | ||
| type | text | ||
| statusname | boolean | ||
| description | text | ||
| contenttype | text | ||
| current | boolean | ||
| deleted | boolean |
|
|
|
|
Runs a script on the Zagreus server. Variables and options of the new job can also be set. If the execution is done in async mode, the result will be the ID of the job; otherwise the result will be the result of the job.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| async | boolean | true | this attribute specifies the async mode of executing the script | |
| sync-timeout | number | 0 | the amount of time (in ms) which we wait for the job to finish (only if async is false). -1 means infinite |
| Name | Type | Description |
|---|---|---|
| jobid | text | the ID of the job |
| scriptid | text | the ID and version of the script to run |
| scriptpath | text | the path of the script to run |
| scriptname | text | the name and version of the script to run |
| beginexectime | date | the begin execution time of the script to run |
| beginqueuetime | date | the begin queue time of the script to run |
| endexectime | date | the end execution time of the script to run |
| endqueuetime | date | the end queue time of the script to run |
| execmode | the execution mode of the script to run | |
| execpriority | number | the execution priority of the script to run |
| numoflogs | number | the numoflogs value of the script to run |
| status | number | the status of the script to run |
| statusname | text | the status name of the script to run |
| workerid | number | the id of the worker |
| userid | number | the id of the user |
| caller | text | the caller of the script |
| callertype | number | the type of the caller |
| callertypename | text | the name of the caller type |
| parentjobid | text | the id of the parent job |
| resulttimeout | number | the result time out |
| workercontrollerid | number | the id of the worker controller |
| resulttype | number | the type of the result |
| result | text | the result |
| message | text | the message |
| variables | text | the list of records (table) of the executed script |
| options | text | the options |
| execution_time | number | the length of time the action was executed |
|
|
Runs a subscription on the Zagreus server. The result will be the ID of the job.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| subscription-id* | number | the id of the subscription to run |
| Name | Type | Description |
|---|---|---|
| jobid | text | the ID of the job |
| scriptid | text | the ID and version of the script to run |
| scriptpath | text | the path of the script to run |
| scriptname | text | the name and version of the script to run |
| beginexectime | date | the begin execution time of the script to run |
| beginqueuetime | date | the begin queue time of the script to run |
| endexectime | date | the end execution time of the script to run |
| endqueuetime | date | the end queue time of the script to run |
| execmode | the execution mode of the script to run | |
| execpriority | number | the execution priority of the script to run |
| numoflogs | number | the numoflogs value of the script to run |
| status | number | the status of the script to run |
| statusname | text | the status name of the script to run |
| workerid | number | the id of the worker |
| userid | number | the id of the user |
| caller | text | the caller of the script |
| callertype | number | the type of the caller |
| callertypename | text | the name of the caller type |
| parentjobid | text | the id of the parent job |
| resulttimeout | number | the result time out |
| workercontrollerid | number | the id of the worker controller |
| resulttype | number | the type of the result |
| result | text | the result |
| message | text | the message |
| variables | text | the list of records (table) of the executed script |
| options | text | the options |
| execution_time | number | the length of time the action was executed |
|
|
Executes a server control command with parameter specified as the content of the action. Multiple parameters must be added by ';' separated text. Returns the result of the command.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| command* | text | set-enable-queue get-enable-queue set-enable-scheduler get-enable-scheduler set-enable-runscript get-enable-runscript get-use-priority-algorithm set-use-priority-algorithm set-enable-filetrigger get-enable-filetrigger set-enable-watchers get-enable-watchers | the name of the command |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Sets the current version of a script.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| version* | text | the version to set as current |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
Changes the description of a resource, user or group. The new description has to be specified in the text content of the action.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
desc
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name | text | and | asd | desc |
| Name | Type | Description |
|---|---|---|
| asd | desc |
|
|
Defines variables and options for a resource, job, subscription, user or group. In case of script variable, if one needs to set the ordering of a particular variable, a special format of the key should be used, e.g. x:1 means that variable x will be saved as the first variable in the ordering.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| append | boolean | true | defines that the listed variables and options should be appended to the existing ones, or the old ones should first be cleared |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
|
|
Creates a new Zagreus subscription, which is a relation of a schedule and a script. Note that subscriptions can have variables and options specified, which will be used during the corresponding script executions. Note that in subscriptions versions are ignored and the current version is used.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| subscription-alias | text | The alias of the subscription | ||
| active | boolean | true | whether the subscription should be active | |
| reset-variables | boolean | false | if set to true, the variables are first reset before setting the new ones (makes sense only when editing an existing subscription) | |
| reset-options | boolean | false | if set to true, the options are first reset before setting the new ones (makes sense only when editing an existing subscription) |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Lists the subscriptions of the given type. If no attributes are set, no filtering is done, and the action returns all subscriptions of the actual user.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| subscription-id | number | The id of the subscription. If it is set, only the given subscription will be listed, and the other attributes will be ignored. | ||
| script-id | text | the id of the resource to get its subscriptions | ||
| script-name | text | the full path of the resource to get its subscriptions | ||
| schedule-id | text | the id of the resource to get its subscriptions | ||
| schedule-name | text | the full path of the resource to get its subscriptions | ||
| subscription-alias | text | the alias of the subscriptions to filter. A part of the alias is enough to match. When subscription-id is used in the action, subscription-alias will be ignored. | ||
| active | boolean | if set, only the subscriptions with the given activation status will be listed |
| Name | Type | Description |
|---|---|---|
| rowcnt | the number of subscriptions found | |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| subscriptionid | number | ||
| subscription-alias | |||
| scriptid | |||
| scriptname | |||
| scriptpath | |||
| scheduleid | |||
| schedulename | |||
| schedulepath | |||
| scheduledby | |||
| active | boolean | ||
| creationtime | date | ||
| variables | |||
| options |
|
|
|
|
|
|
|
|
Removes the assignation of a time or event schedule to a script. If no subscription ID is specified, both script-name/ID and schedule-name/ID must be specified.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| subscription-id | number | The id of the subscription. If it is set, only the given subscription will be deleted, and the other attributes will be ignored. | ||
| script-id | text | the id of the script for the subscriptions to delete | ||
| script-name | text | the full path of the script for the subscriptions to delete | ||
| schedule-id | text | the id of the time or event schedule for the subscriptions to delete | ||
| schedule-name | text | the full path of the time or event schedule for the subscriptions to delete | ||
| active | boolean | if set, only the subscriptions with the given activation status will be deleted |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of subscriptions deleted |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
|
|
|
|
|
|
Lists the users on a remote Zagreus server.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| id | text | the ids of the accounts to list; can be separated by ;s | ||
| name | text | the names of the accounts to list; can be separated by ;s | ||
| only-logged-in | boolean | false | this attribute sets whether we should list the users who are currently logged in |
| Name | Type | Description |
|---|---|---|
| rowcnt | number | the number of users found |
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|---|---|---|
| userid | |||
| username | |||
| title | |||
| firstname | |||
| lastname | |||
| admin | boolean | ||
| lastloggedin | date | ||
| lastactivity | date | ||
| loggedin | boolean | ||
| clienttype | |||
| loggedinaddress | |||
| description |
|
|
|
|
Defines a variable for a resource, job, user or group.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| name* | text | the name of the variable | ||
| value | text | The value of the variable. If left blank, the content of the action will be used instead. |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
|
|
Waits until the execution of a job is finished. If the execution has been already finished, the action does not wait at all.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| job-id* | text | job identifier, returned by the zs:runscript action |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
| Name | Type | Possible Values | Description |
|---|
|
|
Executes a worker control command.
| Name | Type | Possible Values | Default Value | Description |
|---|---|---|---|---|
| connection-name | text | name of the ZS connection used; if left empty, the action will work on the Zagreus server on which the current script is running | ||
| command* | text | start stop restart enable disable | the name of the command | |
| worker-controller-id* | number | the id of the worker controller | ||
| worker-id* | number | the id of the worker |
| Name | Type | Description |
|---|---|---|
| execution_time | number | the length of time the action was executed |
|
|
If specified, the attributes of the given action will be stored in the specified variable, then they can be referenced the action-attributes value and the proper attribute name. See example.
|
|
If specified, the result of the action will be stored in the specified variable.
If specified, the result of the action will be stored in the specified global variable.
If specified, the result of the action will be stored in the specified local variable.
The date / time type results of the action will be formatted by the specified date-format. Default is: YYYY-MM-dd for dates, HH:mm:ss.SSS for time.
If specified, and the script is executed in debug mode the results of the action will be saved to the given location. If the result contains more items, and these items have no binary content, all the items will be stored in the same file, separated by the newline character. In the case of binary content, only the item references will be displayed.
If true, the generated result will parsed as script expression.
If true, script execution will finish after this action with a "finished" status.
If the exit attribute is set to true, the results message of the script will be set to this value.
This is the label attribute for goto connections in the script logic. For managing goto connections, right-click the action and select "Manage goto expressions..." in the graph editor.
If true, the generated result will be logged.
If true, the attributes of the action will be logged.
If true, the result attributes of the action will be logged.
Specifies a custom log target.
This attribute sets the logging level, available values: user, info, warning, error, debug.
The line separator character, used when writing files. Default value is platform-dependent: for Linux, for Windows.
The format of the "null" elements in the result of the action. "_empty" refers to an empty string, otherwise the given text will be used. Default value is "".
The numeric type results of the action will be formatted by the specified number-format. The format sets the position of thousand separator character(s) and one decimal separator character. In the value, thousand separator character is always comma, while decimal separator character is dot. There can be multiple thousand separator characters and only one decimal separator character in a format definition. E.g.: 0,000.00 or ###,000,000.000 To change the displayed thousand and decimal separator characters, use attribute "number-language-format".
It sets the locale to number formatting (decimal points, thousands separator), e.g.: en, de, hu. Displays the appropriate thousand separator character - comma, space or dot - and decimal separator character - comma or dot - according to the given locale code.
If true, the text element of the action will not be parsed (evaluating expressions / variables will not happen).
If true, the generated result of the action will not be used.
If yes, it directs the system that when an error happens during processing of a child action, the execution will continue on the next child action. Otherwise the processing of the caller action will be stopped.
If yes, it directs the system that when an error happens during processing of an action, the execution will continue on the next sibling action. Otherwise the error handling will be forwarded to the parent action, see common attribute on-error-next-child.
If specified, the results of the action will be saved to the given location. If the result contains more items, and these items have no binary content, all the items will be stored in the same file, separated by the newline character. In the case of binary content the items are saved the same way as described at attribute output-separated.
It specifies the encoding of the file defined by output and debug-output attributes. Possible values are: ISO-8859-1, ISO-8859-2, UTF-8, UTF-16, UTF-32, UTF-16LE, UTF-16BE, UTF-32LE, UTF-32BE
if specified, the results of the action will be saved to the locations derived from the given name. The generated filenames are built from the base part of the given output filename, followed by an underscore and the item name (or its index if name is not available) and finally the extension part. Also see action file:write.
If specified, the results of the action will be saved to the given location on the worker file system. If the result contains more items, and these items have no binary content, all the items will be stored in the same file, separated by the newline character. In the case of binary content the items are saved the same way as described at attribute output-separated.
If specified, the result attributes will be stored in the specified variable. Otherwise the variable namespace_actorname will be used. For example the default variable for mstr:report result attributes is mstr_report. This attribute will be ignored if result-attributes-global is set
If specified, the result attributes will be stored in the specified global variable.
It evaluates the value expression of this attribute, and skips action execution if the result is false.
| Name | Return Type | Description |
|---|---|---|
| abs(number) | number | Gives back the absolute value of the number. |
| binary(text) | binary | Decodes the input text using BASE64. Note that in the log output the original BASE64 text is shown! |
| boolean(input-object) | boolean | Returns a boolean type from the input. |
| capitalize(text) | text | Capitalizes the input text: the first letter of each word will be in upper case, while the rest will be in lower case. |
| coalesce(input-object1, input-object2, ...) | object | Returns the first non-null parameter. |
| concat(input-object) | text | Concatenates the elements of input-object (for example, if it is a record or table). |
| concat(input-object, delimiter-text) | text | Concatenates the elements of input-object (for example, if it is a record or table) with the specified delimiter. |
| concatobject(input-object, input-object) | object | Concatenates the elements of the two input-objects. Returns the same type as the first input-object. The possible types of the parameters are: binary, text, list and record types. |
| contains(text, search-text) | boolean | Returns 'true' if 'text' contains 'search-text'. |
| containskey(input-object, key) | boolean | Returns whether the input-object (record, list or table type) contains the specified key. |
| createid(id-text) | text | Creates a fully qualified resource ID with the default version. |
| createid(id-text, version-text) | text | Creates a fully qualified resource ID. |
| date(date-text) | date | Returns a date type from the input text with the default date format (yyyy-MM-dd). |
| date(date-text, date-format-text) | date | Returns a date type from the input text using the specified date format. |
| dateadd(date-part-text, number, date) | date | Returns a new date. The specified date-part will be increased/decreased by the number specified. |
| datediff(date-part-text, date1, date2) | number | Returns the difference between date1 and date2 in terms of date-part-text (e.g. months, days etc.). Always a non-negative value. |
| datepart(date-part-text, date) | number | Returns a number that represents the specified datepart of the specified date. |
| decode(input-text) | binary | Decodes the input text using BASE64. Note that in the log output the original BASE64 text is shown! |
| decode(input-object, method) | binary | Decodes the input object using the method specified; can be 'BASE64' and 'AES-256-CBC' (or 'AES-256'). |
| decode(input-object, method, key) | binary | Decodes the input object using the method specified; can be 'BASE64' and 'AES-256-CBC' (or 'AES-256'). For AES-256, the 'key' parameter is used as well |
| decode(input-object, method, key, iv) | binary | Decodes the input object using the method specified; can be 'BASE64' and 'AES-256-CBC' (or 'AES-256'). For AES-256, the 'key' and 'iv' parameters are used as well |
| encode(input-object) | text | Encodes the input object in BASE64. |
| encode(input-object, method) | text | Encodes the input object using the method specified; can be 'BASE64' and 'AES-256-CBC' (or 'AES-256'). |
| encode(input-object, method, key) | text | Encodes the input object using the method specified; can be 'BASE64' and 'AES-256-CBC' (or 'AES-256'). For AES-256, the 'key' parameter is used as well |
| encode(input-object, method, key, iv) | text | Encodes the input object using the method specified; can be 'BASE64' and 'AES-256-CBC' (or 'AES-256'). For AES-256, the 'key' and 'iv' parameters are used as well |
| endswith(text, search-text) | boolean | Returns 'true' if 'text' ends with 'search-text'. |
| eval(text) | object | Evaluates 'text'. |
| floor(number) | number | Returns the floor value of the number. |
| format(input-object, format-specifier) | object | Sets the format described by format-specifier to the given input-object. Returns the same type as the input. NOTE: It won't create a new object, only affects the format of the original object! |
| getidpart(input-text) | text | Returns only the ID part (i.e. without the version) of the full resource ID. |
| getversionpart(input-text) | text | Returns only the version of the full resource ID. For null returns the default version (i.e. '1.0.0.0'). |
| gettype(input-object) | text | Returns the type of the given input-object. |
| hash(input-object) | number | Returns the hash value of the object. |
| hex(input-object) | text | Returns the hexadecimal representation of the input binary value. |
| index(text, search-text) | number | Returns the index of the first occurrence of search-text in text. -1 if text does not contain search-text. |
| isboolean(input-object) | boolean | Returns whether input-object is of boolean type. |
| isbinary(input-object) | boolean | Returns whether input-object is of binary type. |
| isdate(input-object) | boolean | Returns whether input-object is of date type. |
| isdefined(input-object) | boolean | Returns whether input-object can be evaluated (e.g. variable is defined, array element exists). |
| islist(input-object) | boolean | Returns whether input-object is of list type. |
| isnull(input-object) | boolean | Returns whether input-object is null. |
| isnumber(input-object) | boolean | Returns whether input-object can be parsed as a number. |
| isrecord(input-object) | boolean | Returns whether input-object is of record type. |
| istext(input-object) | boolean | Returns whether input-object is of text type. |
| istime(input-object) | boolean | Returns whether input-object is of time type. |
| isxml(input-object) | boolean | Returns whether input-object is of XML type. |
| keys(input-object) | record | Returns a record containing the keys of the input record, list or table. |
| left(text, number) | text | Returns the left part of a text with the specified number of characters. |
| length(input-object) | number | Returns the length of the input object. Types are: text, record, list, table, binary |
| levenshtein(text1, text2) | number | Returns the (character-level) Levenshtein distance of the two input texts |
| list(input-object) | list | Returns a list containing the elements of input-object (if it is iterable) or input-object itself. |
| locate(text, search-text) | number | Returns the index of the first occurrence of search-text in text. -1 if text does not contain search-text. |
| lower(text) | text | Return the input text in lower case. |
| ltrim(text) | text | Returns a character string after truncating all leading blanks. |
| mod(number, number) | number | Returns the remainder after dividing the first parameter with the second one. Works only for integers. |
| number(input-object) | number | Returns a number type from the input-object. |
| number(input-object, format-text) | number | Returns a number type from the input-object using the given format. |
| number(input-object, format-text, language-text) | number | Returns a number type from the input-object using the given format specific to the given language. |
| parentpath(input-text) | text | Returns the parent path of the given path parameter. |
| println(input-object) | Prints the given input-object. | |
| purge() | Calls the Java garbage collector. | |
| reverse(text) | text | Returns the input text reversed. |
| repeat(text, number) | text | Returns the input text repeated the specified number of times. |
| replace(text, source-text, target-text) | text | Returns the input text where all occurrences of source-text are replaced by target-text. |
| right(text, number) | text | Returns the right part of a text with the specified number of characters. |
| rlocate(text, search-text) | number | Returns the index of the last occurrence of search-text in text. -1 if text does not contain search-text. |
| rand() | number | Returns a random value with an uniform distribution in the range [0, 1). |
| rand(number) | number | Returns a random value with an uniform distribution in the range [0, param). |
| randn() | number | Returns a random value with a normal (i.e. Gaussian) distribution. |
| round(number) | number | Returns the rounded value of the number. |
| rtrim(text) | text | Returns a character string after truncating all trailing blanks. |
| sleep(number) | Waits for the specified amount of milliseconds. | |
| split(text, regular-expression-text) | list | Returns a list containing the split parts of the input text. |
| startswith(text, search-text) | boolean | Returns 'true' if 'text' starts with 'search-text'. |
| stringdiff(text1, text2) | text | Returns the part of the second string which is not found in the first string. If the second string is empty or it is null, returns the first string. |
| substring(text, start-position-number) | text | Returns the substring of the input text starting at the specified position. |
| substring(text, start-position-number, end-position-number) | text | Returns the substring of the input text starting at the specified start position and ending at the specified end position. Both positions are inclusive. |
| text(input-object) | text | Returns a text type from the input-object. |
| text(input-object, encoding) | text | Returns a text type from the input-object using the specified character encoding. |
| time(time-text) | time | Returns a time type from the input text with the default time format (HH:mm:ss.SSS). |
| time(time-text, time-format-text) | time | Returns a time type from the input text using the specified time format. |
| translate(input-text, source-text, target-text) | text | All characters of input-text will be replaced with the corresponding character in target-text based on source text. |
| trim(text) | text | Returns a character string after truncating all leading and trailing blanks. |
| upper(text) | text | Return the input text in upper case. |
| urlencode(text) | text | URL-encodes the input text. |
| workingday(date) | boolean | Returns 'true' if the given date is a working day for the country specified by the default locale. |
| workingday(date, language-text) | boolean | Returns 'true' if the given date is a working day for the given country. |
| workingdayofmonth(date) | number | Returns which working day of the month is the date specified. E.g. for 2020-05-13 (which is a Wednesday) returns 8. |
| workingdayofmonth(date, language-text) | number | Returns which working day of the month is the date specified for the given country. E.g. for 2020-05-13 (which is a Wednesday) returns 8. |
| workingdaysafter(date, number) | date | Increments the input date by the number of working days specified. |
| workingdaysafter(date, number, language-text) | date | Increments the input date by the number of working days specified for the given country. |
| xmltype(xml-text) | xml | Returns an XML type from the input text. |
| Name | Type | Description |
|---|---|---|
| date | date | Gives back the current date. |
| jobId | text | Variable for the current job id. |
| callerName | text | The user name who runs the script. If the script was scheduled, it returns the schedule id. If it was run by zs:runscript, it is the caller script id. |
| callerType | text | Return values can be: "scheduler", "event", "gui", "script" (zs:runscript locally), "remote script" (zs:runscript remotely), "autorun", "webservice". |
| callerIP | text | When the script was run remotely by zs:runscript, it stores the caller server IP address. |
| currentActionNumber | text | The currently executed action ordering number. |
| currentUserId | text | The user id who is running the script. |
| executionMode | text | Return values can be: "direct", "scheduled", "fired" |
| errorMessage | text | The last error message. |
| errorTrace | text | The last error stack trace. |
| home | text | The path of the user or group home folder. |
| parallelThreadId | number | The id of the actual thread for z:foreach |
| queueTimeout | number | The queue timeout applied for this script. |
| runTimeout | number | The running timeout applied for this script. |
| scheduleId | text | The id of the schedule that runs the script. |
| scheduleName | text | The name of the schedule that runs the script. |
| schedulePath | text | The name of the schedule that runs the script. |
| scriptId | text | The id of the current script. |
| scriptDesc | text | The description of the current script. |
| scriptName | text | The name of the current script. |
| scriptParentFolder | text | The parent folder path of the current script. |
| scriptPath | text | The path of the current script. |
| scriptVersion | text | The version of the current script. |
| serverHost | text | The host of the Zagreus Server. |
| serverOS | text | The operating system of the Zagreus Server. |
| serverPort | text | The port of the Zagreus Server. |
| serverWorkingFolder | text | The working folder root of the Zagreus Server. |
| startingVariables | tabular | The (resolved) starting variables of the actual script. |
| stackTrace | text | The stacktrace of the last error. |
| subscriptionId | text | If the script was run by a scheduled subscription, it returns the subscription id. |
| threadId | number | The current thread id. |
| time | time | The current time. |
| workerOS | text | The OS of the worker. |
| zagreusVersion | text | The current version of the Zagreus System. |