From 73a1600072dadae9ab6aaf7b43cd54abfcb059b0 Mon Sep 17 00:00:00 2001 From: Wim Jongeneel Date: Fri, 4 Apr 2025 10:18:04 +0200 Subject: [PATCH 1/4] Add docs for security overview export command --- .../general/mx-command-line-tool/_index.md | 8 ++++ .../general/mx-command-line-tool/security.md | 42 +++++++++++++++++++ .../modeling/security/security-overview.md | 4 ++ 3 files changed, 54 insertions(+) create mode 100644 content/en/docs/refguide/general/mx-command-line-tool/security.md diff --git a/content/en/docs/refguide/general/mx-command-line-tool/_index.md b/content/en/docs/refguide/general/mx-command-line-tool/_index.md index 002a10d4d40..994bf8f0082 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/_index.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/_index.md @@ -74,6 +74,14 @@ These are the available [merging and diffing commands](/refguide/mx-command-line | [diff](/refguide/mx-command-line-tool/merge/#diff) | Shows the diff of the *.mpr* files. | | [dump-mpr](/refguide/mx-command-line-tool/dump-mpr/) | Create a JSON description of the model of a Mendix App | +### Security Overview Commands + +These are the available [security overview commands](/refguide/mx-command-line-tool/security/): + +| Command | Description | +| --- | --- | +| [export-security-overview](/refguide/mx-command-line-tool/security/#export-security-overview) | Exports the [Security Overview](/refguide/security-overview/) | + ## Undocumented Options The mx tool contains options that are not described in this document. These options are for internal Mendix usage and are not officially supported. This might change in the future, but these options are used at your own risk. diff --git a/content/en/docs/refguide/general/mx-command-line-tool/security.md b/content/en/docs/refguide/general/mx-command-line-tool/security.md new file mode 100644 index 00000000000..d9424b9f126 --- /dev/null +++ b/content/en/docs/refguide/general/mx-command-line-tool/security.md @@ -0,0 +1,42 @@ +--- +title: "Security Overview Commands" +url: /refguide/mx-command-line-tool/security/ +weight: 50 +description: "Describes the commands related to the Security Overview" +--- + +## Introduction + +The commands in this group are related to the [Security Overview](/refguide/security-overview/). + +## mx export-security-overview Command {#export-security-overview} + +This command can be used to export the data in the Security Overview to either a JSON or xlsx file. + +### Usage + +Use the following command pattern: `mx export-security-overview [OPTIONS] [MPR-FILE]` + +These are the `OPTIONS`: + +| Option | Value | Result +|---------------------------|-------------------|---------- +| `-t, --export-format` | `json` or `xlsx` | The format to export to +| `-t, --exclude-appstore` | *-* | When set, exclude marketplace modules +| `-o, --output-file` | file path | The path to the output file + +### Examples + +This is an example: + +`mx export-security-overview -t json -t -o C:\MyApp\export.json C:\MyApp\MyApp.mpr` + +### Return Codes + +These are the return codes: + +| Return Code | Description | +| --------------| ----------------------------- | +| 0 | Success | +| 200 | An internal error occurred | +| 400 | The MPR could not be loaded | \ No newline at end of file diff --git a/content/en/docs/refguide/modeling/security/security-overview.md b/content/en/docs/refguide/modeling/security/security-overview.md index 73f7d3ace9c..c3bf7a04306 100644 --- a/content/en/docs/refguide/modeling/security/security-overview.md +++ b/content/en/docs/refguide/modeling/security/security-overview.md @@ -99,6 +99,10 @@ To export the **Security Overview**, click the **Export to Excel** button. This 4. Anonymous role: Specifies whether this user roles is an anonymous user role. 5. Administrator role: Specifies whether this user role is the administrator user role. +## CLI export + +The security overview can be exported to a JSON or xlsx file with the `mx` command line tool. See the [export-security-overview](/refguide/mx-command-line-tool/security/#export-security-overview) command. + ## Read More * [User Roles](/refguide/user-roles/) From fc71db6db6ab581402391759124509ce444f827f Mon Sep 17 00:00:00 2001 From: Wim Jongeneel Date: Fri, 4 Apr 2025 14:14:19 +0200 Subject: [PATCH 2/4] Fix flag name --- .../en/docs/refguide/general/mx-command-line-tool/security.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/refguide/general/mx-command-line-tool/security.md b/content/en/docs/refguide/general/mx-command-line-tool/security.md index d9424b9f126..07de204a582 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/security.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/security.md @@ -22,7 +22,7 @@ These are the `OPTIONS`: | Option | Value | Result |---------------------------|-------------------|---------- | `-t, --export-format` | `json` or `xlsx` | The format to export to -| `-t, --exclude-appstore` | *-* | When set, exclude marketplace modules +| `-e, --exclude-appstore` | *-* | When set, exclude marketplace modules | `-o, --output-file` | file path | The path to the output file ### Examples From 36cf40b2ae3592744e90bfbcd8d277ee6214b1f9 Mon Sep 17 00:00:00 2001 From: Wim Jongeneel Date: Tue, 15 Apr 2025 13:49:27 +0200 Subject: [PATCH 3/4] Fix example usage --- .../en/docs/refguide/general/mx-command-line-tool/security.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/refguide/general/mx-command-line-tool/security.md b/content/en/docs/refguide/general/mx-command-line-tool/security.md index 07de204a582..b25983e952d 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/security.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/security.md @@ -29,7 +29,7 @@ These are the `OPTIONS`: This is an example: -`mx export-security-overview -t json -t -o C:\MyApp\export.json C:\MyApp\MyApp.mpr` +`mx export-security-overview -t json -e -o C:\MyApp\export.json C:\MyApp\MyApp.mpr` ### Return Codes From 60b5effd2fe3462e613d3a174c7a5efeba8548c4 Mon Sep 17 00:00:00 2001 From: "MENDIXDOMAIN\\Maria.Shaposhnikova" Date: Wed, 16 Apr 2025 13:29:19 +0200 Subject: [PATCH 4/4] Review --- .../general/mx-command-line-tool/_index.md | 8 ++--- .../general/mx-command-line-tool/security.md | 32 +++++++++---------- 2 files changed, 18 insertions(+), 22 deletions(-) diff --git a/content/en/docs/refguide/general/mx-command-line-tool/_index.md b/content/en/docs/refguide/general/mx-command-line-tool/_index.md index 994bf8f0082..486abf88f35 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/_index.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/_index.md @@ -74,13 +74,9 @@ These are the available [merging and diffing commands](/refguide/mx-command-line | [diff](/refguide/mx-command-line-tool/merge/#diff) | Shows the diff of the *.mpr* files. | | [dump-mpr](/refguide/mx-command-line-tool/dump-mpr/) | Create a JSON description of the model of a Mendix App | -### Security Overview Commands +### Security Overview Command -These are the available [security overview commands](/refguide/mx-command-line-tool/security/): - -| Command | Description | -| --- | --- | -| [export-security-overview](/refguide/mx-command-line-tool/security/#export-security-overview) | Exports the [Security Overview](/refguide/security-overview/) | +The available `export-security-overview` exports the [Security Overview](/refguide/security-overview/). For more information, see [Security Overview Command](/refguide/mx-command-line-tool/security/#export-security-overview). ## Undocumented Options diff --git a/content/en/docs/refguide/general/mx-command-line-tool/security.md b/content/en/docs/refguide/general/mx-command-line-tool/security.md index b25983e952d..0ea5451c353 100644 --- a/content/en/docs/refguide/general/mx-command-line-tool/security.md +++ b/content/en/docs/refguide/general/mx-command-line-tool/security.md @@ -1,5 +1,5 @@ --- -title: "Security Overview Commands" +title: "Security Overview Command" url: /refguide/mx-command-line-tool/security/ weight: 50 description: "Describes the commands related to the Security Overview" @@ -7,36 +7,36 @@ description: "Describes the commands related to the Security Overview" ## Introduction -The commands in this group are related to the [Security Overview](/refguide/security-overview/). +The command is related to the [Security Overview](/refguide/security-overview/). ## mx export-security-overview Command {#export-security-overview} -This command can be used to export the data in the Security Overview to either a JSON or xlsx file. +The `mx export-security-overview` command can be used to export the data in the Security Overview to either a *JSON* or *xlsx* file. ### Usage Use the following command pattern: `mx export-security-overview [OPTIONS] [MPR-FILE]` -These are the `OPTIONS`: + `OPTIONS` are presented in the table below:: -| Option | Value | Result -|---------------------------|-------------------|---------- -| `-t, --export-format` | `json` or `xlsx` | The format to export to -| `-e, --exclude-appstore` | *-* | When set, exclude marketplace modules -| `-o, --output-file` | file path | The path to the output file +| Option | Value | Result | +|---------------------------|-------------------|----------| +| `-t, --export-format` | `json` or `xlsx` | The format to export to. | +| `-e, --exclude-appstore` | *-* | When set, excludes Marketplace modules. | +| `-o, --output-file` | file path | The path to the output file. | ### Examples -This is an example: +An example of the command can be the following: `mx export-security-overview -t json -e -o C:\MyApp\export.json C:\MyApp\MyApp.mpr` ### Return Codes -These are the return codes: +Return codes are presented in the table below: -| Return Code | Description | -| --------------| ----------------------------- | -| 0 | Success | -| 200 | An internal error occurred | -| 400 | The MPR could not be loaded | \ No newline at end of file +| Return Code | Description | +| ----------- | ---------------------------- | +| 0 | Success. | +| 200 | An internal error occurred. | +| 400 | The MPR could not be loaded. | \ No newline at end of file