<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <title>Metrix Sync CLI on Metrix User Guide</title>
    <link>https://help.metrixassets.com/categories/metrix-sync-cli.html</link>
    <description>Recent content in Metrix Sync CLI on Metrix User Guide</description>
    <generator>Hugo -- gohugo.io</generator>
    <language>en-au</language>
    <lastBuildDate>Wed, 21 Feb 2024 09:31:21 +1100</lastBuildDate><atom:link href="https://help.metrixassets.com/categories/metrix-sync-cli/index.xml" rel="self" type="application/rss+xml" />
    <item>
      <title>Configuration File</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/3_reports/1_config.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/3_reports/1_config.html</guid>
      <description>The Report Runner tool leverages a simple configuration file to instruct it on which report(s) to fetch, and where to store the downloaded CSV file(s).The following outlines the required configuration parameters. Also shown, is an example configuration file.
log_file: the file path to which the Report Runner tool should write its log output to. This can be useful for debugging and monitoring purposes.
reports: an ARRAY of report objects that the Report Runner tool should fetch and download.</description>
    </item>
    <item>
      <title>Database Requirements</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/1_sync/1_database_requirements.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/1_sync/1_database_requirements.html</guid>
      <description>The Metrix Sync CLI tool handles all of the database initialisation, and data population. The only pre-requisite is that you have a locally configured SQL Server database prepared for the tools use. The only requirement we have around this database is for the specific collation that is compatible with the Metrix Sync CLI tool - SQL_Latin1_General_CP1_CS_AS. This collation is case-sensitive and accent-sensitive, ensuring that string comparisons within the database are performed accurately according to the Metrix Sync CLI tool&amp;rsquo;s requirements.</description>
    </item>
    <item>
      <title>The Basics</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/0_generic.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/0_generic.html</guid>
      <description>This is generally your first step when using the Metrix Sync CLI tool. It basically involves registering a valid Metrix API token with the Metrix Sync CLI tool so that it can use that token to authenticate with the Metrix API for subsequent operations. Additionaly, we recommend running our built-in update fetcher to ensure that you are always using the latest version of the Metrix Sync CLI tool.
With the above in mind, this help guide is broken into the following (ordered) sections:</description>
    </item>
    <item>
      <title>Configure Sync Tool</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/1_sync/2_configure.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/1_sync/2_configure.html</guid>
      <description>Configuring the Metrix Sync CLI Sync tool is (typically) a one-time process that involves supplying the connection parameters for the SQL Server database that will store the locally synced Metrix data. To configure the tool, simply run the following command and follow the prompts with connection details:
./metrix-sync.exe sync configureYou will be asked for the following details:
SQL Server Host: the name of the database server where the SQL Server instance is running.</description>
    </item>
    <item>
      <title>Sync Tool</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/1_sync.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/1_sync.html</guid>
      <description>The Metrix Sync CLI&amp;rsquo;s Sync tool provides users with the ability to create a local copy of their Metrix data, within a locally configured SQL Server database environment. The sync processes can be configured to run periodically through Scheduled Tasks (or other cron-job runners) and each sync operation will update only the records that have been altered since it was last run.
Using the Metrix Sync CLI Sync tool The following sections are detailed within this section of the help-guide:</description>
    </item>
    <item>
      <title>Update Checks</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/0_generic/2_updates.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/0_generic/2_updates.html</guid>
      <description>To perform an update check with the Metrix Sync CLI tool, simply run the following command:
./metrix-sync.exe updateThe tool will call our secure Metrix update servers to check if you are running the latest stable version of the Metrix Sync CLI tool.
If any updates are available, the tool will return a download link for the latest version of the Metrix Sync CLI tool. Simply click the link (or copy and paste it to your browser) to download the new version.</description>
    </item>
    <item>
      <title>Metrix Sync CLI</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync.html</link>
      <pubDate>Tue, 07 Nov 2023 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync.html</guid>
      <description>The Metrix Sync CLI tool allows administrators to automate off-system tasks as they pertain to the Metrix platform, as well as maintain a local database (SQL Server currently supported) of their entire Metrix dataset.
The tools currently available within the Metrix Sync CLI are discussed in detail within this section, and include:
Sync: Creating and maintaining a local cache of Metrix data Cache: This is an extension of the sync tool, and will create a GeoPackage cache of the local Metrix data Reports: Generating and downloading any CSV Report from the Metrix environment (as a one off, or periodically) Aditionally to the above, the Metrix Sync CLI also comes with built-in configuration commands for setting itself up, including:</description>
    </item>
    <item>
      <title>Configuration Examples</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/3_reports/2_config_examples.html</link>
      <pubDate>Tue, 07 Nov 2023 09:13:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/3_reports/2_config_examples.html</guid>
      <description>Report Template Configuration Parameters The following outlines the required configuration parameters for some of the most commonly used report templates within the Metrix Asset Management system. For any report templates not listed below, please contact our support team.
If a report you wish to generate is not listed here, please reach out to our support team and we will help you and update these notes accordingly.
Component Data Export Template ID: RTO_E3MWCDP</description>
    </item>
    <item>
      <title>API Token Generation</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/0_generic/3_token_generation.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/0_generic/3_token_generation.html</guid>
      <description>Creating an API token for the Metrix Sync CLI tool is a simple process that just requires you to generate it from the Metrix Asset Management system directly. Firstly, log in to your Metrix environment, and then:
Navigate to the &amp;ldquo;My Profile&amp;rdquo; section by clicking the User Icon in the upper-right corner of the layout, and selecting &amp;ldquo;My Profile&amp;rdquo; from the dropdown menu. The subsequent page has a left-hand navigation menu.</description>
    </item>
    <item>
      <title>Cache Tool</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/2_cache.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/2_cache.html</guid>
      <description>The cache tool option within the Metrix Sync CLI allows users to generate a snapshot GeoPackage of the views from the EXISTING local SQL Server database configured with the Metrix Sync CLI tool. That is, it requires that the local SQL Server database has already been populated (and maintained) with the necessary Metrix data through a prior sync pull operation.
The GeoPackage file is optimised for fast read-only access to your Metrix data.</description>
    </item>
    <item>
      <title>Running the Sync Tool (Pull)</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/1_sync/3_pull.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/1_sync/3_pull.html</guid>
      <description>Once you have configured the Metrix Sync CLI, you can use it to pull data from the Metrix servers into your local SQL Server database. To do this, run the following command:
./metrix-sync.exe sync pullFor the first time you run this command, it may take a few minutes as it will pull all the relevant data from the Metrix servers and triage that into your local SQL Server database. Subsequent runs will be faster as only new or updated data will be pulled.</description>
    </item>
    <item>
      <title>Rebuilding the Local Database</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/1_sync/4_rebuild.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/1_sync/4_rebuild.html</guid>
      <description>In the case where you feel that the local SQL Server database is not reflecting the correct state of your Metrix data, you can use the rebuild command as a first pass troubleshooting step. The rebuild command will fully reconstruct the database - without running a sync pull step.
./metrix-sync.exe sync rebuild</description>
    </item>
    <item>
      <title>Registering an API Token with Metrix Sync CLI</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/0_generic/4_register_token.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/0_generic/4_register_token.html</guid>
      <description>To register an API token with the Metrix Sync CLI tool, use the following command:
./metrix-sync.exe register-token &amp;lt;your_api_token&amp;gt;Replace &amp;lt;your_api_token&amp;gt; with your actual API token. This will allow the CLI tool to authenticate with the Metrix servers and perform authorised operations.
Note The token is registered so that your user account can authenticate with the Metrix servers. That is, if another user logs onto the machine, they will need to register their own API token separately.</description>
    </item>
    <item>
      <title>Report Tool</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/3_reports.html</link>
      <pubDate>Tue, 07 Nov 2023 09:13:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/3_reports.html</guid>
      <description>The Report Runner tool available for sites using the Metrix Asset Management system allows users to automate the running and subsequent download of any CSV report available through the system. This can be useful for sites that wish to store spreadsheet versions of their asset data in a local file system for use by other applications or the like.
Running the Report Runner Tool To run the Report Runner tool, simply execute it by calling the following from a command line interface:</description>
    </item>
    <item>
      <title>De-registering an API Token with Metrix Sync CLI</title>
      <link>https://help.metrixassets.com/7_integration/2_metrix_sync/0_generic/5_deregister_token.html</link>
      <pubDate>Wed, 21 Feb 2024 09:31:21 +1100</pubDate>
      <guid>https://help.metrixassets.com/7_integration/2_metrix_sync/0_generic/5_deregister_token.html</guid>
      <description>To de-register an API token with the Metrix Sync CLI tool, use the following command:
./metrix-sync.exe deregister-tokenThis will remove the registered API token from the Metrix Sync CLI tool, effectively de-authenticating your user account from the Metrix servers.</description>
    </item>
  </channel>
</rss>