Box - Send CSV
- 16 Mar 2023
- 4 Minutes to read
-
Print
-
DarkLight
-
PDF
Box - Send CSV
- Updated on 16 Mar 2023
- 4 Minutes to read
-
Print
-
DarkLight
-
PDF
Box - Send CSV creates a CSV file with the results of the saved query supplied as a trigger (or assets that have been selected in the asset table) and sends it to a specific path on Box.
See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.
General Settings
- Enforcement Set name (required) - The name of the Enforcement Set. A default value is added by Axonious. You can change the name according to your needs.
- Add description (optional) - Click to add a description of the Enforcement Set. It is recommended to describe what the Enforcement Set does.
- Run action on assets matching following query (required) - Select an asset category and a query. The Enforcement Action will be run on the assets that match the query parameters.
- A query only returns results for the asset type it was created for.
- Not all asset categories are supported for all Enforcement Actions.
- See Actions supported for Activity Logs and Adapter Fetch History Modules
- Action name - The name of the Main action. A default value is added by Axonious. You can change the name according to your needs.
- Configure Action Conditions - Toggle on to enter a condition statement. See Configuring Enforcement Action Conditions to learn more about condition statement syntax.
Connection Settings
- Box Platform private key configuration file (required) - The private key configuration file that provides the Required Permissions to fetch assets.
- Folder ID (required) - The folder ID. If the supplied folder ID is 0, the file will be created in the root folder of the app account. Otherwise, the file will be created in the supplied folder ID.
- File name (required, default: axonius_data) -The file name.
- Append date and time to file name (required, default: False)
- If enabled, the date and time (in UTC) of enforcement action execution will be added as a suffix to the generated CSV file name. For example, axonius_data_2020-01-06-16:48:13.csv.
- If disabled, the CSV file will be stored based on the specified/default file name.
- HTTPS proxy (optional, default: empty) - A proxy to use when connecting to Box Platform APIs.
- If supplied, Axonius will utilize the proxy when connecting to Box Platform APIs.
- If not supplied, Axonius will connect directly to Box Platform APIs.
Additional CSV Settings
- Split by asset entities - Select to create a CSV file where each asset on a device is shown as a separate row. This separates each asset as the 'expand' option in the application. It separates each asset by its entity. For example, you will be able to know which values were fetched from each adapter connection.
a. If supplied, each value on a device or user is shown as a separate row.
b. If not supplied all values on a device are in the same cell on the CSV file. - Split by field values - Choose field value - For complex fields and lists you can create a CSV file where the values of complex fields and lists are represented as separate rows in the file. From the drop-down box select the value that you want to display in the file, 'Tags' for instance. Only fields that have been discovered are available. For example, if you export by Installed Software, you will be able to see each installed Software name and its version.
- Don't split complex objects into columns - When selected, complex objects appear in a single column in JSON format. By default, each field in a complex object is split into a separate column in the CSV file.
- Export CSV delimiter to use for multi-value fields (default: Export CSV delimiter to use for multi-value fields field under the System Settings section in the GUI Settings) - Specify a delimiter to separate between values within the same field of an exported CSV file, otherwise the delimiter defined in Export CSV delimiter to use for multi-value fields is used.
- Maximum rows (default: 1048500) - Specify the maximum number of rows to be included in the CSV file. When you set a value here the generated CSV file will include the top x rows, based on the specified values. Otherwise, the generated CSV file will include the default maximum rows, set as 1048500.
APIs
Axonius uses the following BOX APIs:
- Upload file - for file size up to 20MB.
- Create upload session - for file size over 20MB.
Required Permissions
The values supplied in Box Platform private key configuration file refer to the generated private key configuration file for your Custom App using JWT authentication:
- Set up a Custom App - Set up a Custom App using JWT authentication. For details, see Box Guides - Setup with JWT.
- Create Box Platform private key configuration file - After a Custom App has been created to use JWT authentication, there is an option available in the Developer Console to have Box create a configuration file. This file will include the keypair as well as a number of other application details that are used during authentication.
- Click on the "Configuration" option from the left sidebar in your application and scroll down to the "Add and Manage Public Keys" section.
- Click the "Generate a Public/Private Keypair" button to have Box generate a keypair. This will trigger the download of a JSON configuration file that you can move to your application code.
- Upload this file as the Box Platform private key configuration file.
- Click on the "Configuration" option from the left sidebar in your application and scroll down to the "Add and Manage Public Keys" section.
- Application Scopes - The configured app must have the following application scopes:
- Read all files and folders stored in Box
- Read and write all files and folders stored in Box
For more details about other Enforcement Actions available, see Action Library.