Login
    Contents x
    SharePoint - Send CSV
    • 21 Mar 2024
    • 5 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    SharePoint - Send CSV

    • Updated on 21 Mar 2024
    • 5 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    SharePoint - Send CSV creates a CSV file with the results of the saved query supplied as a trigger (or entities that have been selected in the asset table), and sends it to a specific path on SharePoint.

    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 Axonius. You can change the name according to your needs.
    • Add description - 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.
    • Action name (required) - The name of the Main action. A default value is added by Axonius. You can change the name according to your needs.
    • Configure Dynamic Values - Toggle on to enter a Dynamic Value statement. See Creating Enforcement Action Dynamic Value Statements to learn more about Dynamic Value statement syntax.

    Required Fields

    These fields must be configured to run the Enforcement Action.

    • Site URL - The SharePoint site URL. For example: https://testaxonius.sharepoint.com/sites/TestSite/.
    • Folder path - Specify the folder path. If the path is incorrect, the action will fail. You have to specify the full path and include everything that follows the SharePoint site URL. For example if the SharePoint site URL is https://testaxonius.sharepoint.com/sites/TestSite/ and your folder is in /OurDepartment/OurDeptDocs/CSVFiles/FilesFromThisWeek, you must make sure you list the complete path.
    • File name - The file name.

    • Compute Node - The Axonius node to use when connecting to the specified host. For more details, see Connecting Additional Axonius Nodes.

    Additional Fields

    These fields are optional.

    • Authentication Method - Select the Authentication Method, either User Credentials, or Client Credentials.
    • User name and Password - The credentials for a SharePoint user account that has the read and write permissions to the supplied Site URL and Folder Path. Use when you choose User Credentials as the Authentication Method
    • Client ID and Secret - Use Client ID and Secret when you choose Client Credentials as the Authentication Method
    • Append date and time to file name
      • 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.

    • Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.

    • HTTPS Proxy - Connect the adapter to a proxy instead of directly connecting it to the domain.

    • Create CSV even if no data is returned in the query - Select whether to create and send a CSV file even if the query does not return any results.

    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. If you do not select this option, 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. (note that this value is the maximum value supported by Excel, setting a higher value generates a file that can't be displayed fully or correctly in Excel)

    • Include associated devices (only for Vulnerabilities and Software) - For Software and Vulnerabilities queries. Toggle on this option to include the associated devices with the preferred hostname as a predefined field for each software or vulnerability. When you create a CSV file with associated devices (for Vulnerabilities or Software), if the exported query results are larger than the value set under Maximum rows (or the default value of 1048500), an appropriate notice is displayed at the end of the CSV file.

    • Device fields - This option is available for Software and Vulnerabilities. Select the device fields to add. By default Preferred Host Name is selected. Click add to select more fields. At least one field must be selected. Once you select fields, you can drag and drop to rearrange in the order that you want them to appear in the CSV file. Click the bin icon to remove a device field.

    APIs

    Axonius uses the SharePoint REST operations via the Microsoft Graph REST API
    Refer to Get access without a user for details on obtaining credentials.

    To fetch users Axonius uses the SharePoint List Users endpoint.

    Required Ports

    Axonius must be able to communicate with the value supplied in Host Name or IP Address via the following ports:

    • TCP port 80/443

    Required Permissions

    The value supplied in User name and Password must be associated with credentials that have ReadOnly permissions in order to fetch assets.
    The value supplied in User name and Password must be associated with credentials that have User.ReadBasic.All, permissions in order to fetch users.

    For more details about other Enforcement Actions available, see Action Library.

    Was this article helpful?
    What's Next
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout