> For the complete documentation index, see [llms.txt](https://docs.tracr.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tracr.com/tracr-user-guide/2.-quickstart.md). # 2. Quickstart {% stepper %} {% step %} ### Log in to the Tracr platform To begin, log in to Tracr. * Go to the Tracr URL you have received by email from the Tracr Support team. * Read the terms and conditions and privacy policy, then select the checkbox to accept. * Select **Login with JumpCloud**. * Enter your JumpCloud credentials, set up during the onboarding to Tracr, and select **Login**. You can now upload your diamond data to Tracr. {% endstep %} {% step %} ### Prepare your diamond data To register and track diamonds on Tracr, you must upload a CSV file containing the required data, and optional data such as images and videos, whenever the diamond changes form. #### Scanner and CSV templates You should install the appropriate Tracr scanner template to export the reports that Tracr requires. You should also download CSV templates to help you create CSV files containing diamond data in the correct format. Scanner templates, CSV templates, and supporting documentation are part of the Integration toolkit. * From the Tracr menu, select **Integration > Integration Tool**. * Select the **Integration toolkit** button. * Select **Download toolkit** to download the complete integration toolkit or choose the components that you want to download. #### Data Dictionary Review the Data Dictionary, which gives a comprehensive overview of all data points required for uploading data for a diamond, at any stage of its lifecycle. The Data Dictionary is part of the Integration toolkit. {% endstep %} {% step %} ### Upload your diamond data to Tracr Before you start, prepare a CSV file containing your diamond data. Please note that Tracr only accepts sight boxes invoiced by De Beers and certain other producers. #### Select the CSV file to upload To ensure your CSV file is valid and contains the required information, please use one of the CSV templates. * From the Tracr menu, select **Integration > Integration Tool**. * On the **Session history** page, select the **New session** button. * Either drag and drop your prepared CSV file onto the **Upload CSV file** page or select the **Or, select from device** button to browse for and select the file that you want to upload. #### CSV validation Once uploaded, Tracr validates your CSV file. * If the file is valid, Tracr asks you to confirm the integration type. * Select your integration type. It is important that the type you select matches the type defined in your CSV file. If not, the next validation step will fail, and you will get an error. * Select **Continue**. #### What happens next? Tracr validates the selected file to ensure that it matches the integration type that you selected. If validation is successful, Tracr displays the **Required files** page with the **Session overview** tab selected. You must now upload all the files listed in the CSV file before you can complete the upload. #### What to do if your CSV file fails validation If validation fails, Tracr displays the **Upload failed** page. You should review the error text and make the appropriate changes to your CSV file or ensure that you select the correct integration type during the upload process. Select **Quit** and create a new session to continue. {% endstep %} {% step %} ### Upload the required files to Tracr Your CSV file lists the files to associate with each diamond. You need to upload these files before you can submit the session. #### Select the files to upload Before you start, ensure that you have access to all the files associated with your CSV file. You will find a list of the files that Tracr is expecting on the **Missing files** tab. * Either drag and drop the required files onto the **Session overview** tab or select the **Or, select from device** button to browse for and select the files that you want to upload to Tracr.\ As Tracr accepts the files, you will see a green tick appear under the appropriate file type on the **Session overview** tab. An orange exclamation mark indicates a file is missing. A red exclamation mark indicates that the file has failed validation.\ You will not be able to complete your session if there are any missing or failed files. #### Submit the session When all files are uploaded, look for the message ‘Ready to submit. All required files have been accepted and uploaded for this session, submit to continue.’ in the top right corner. * Select the **Submit session** button.\ Tracr displays a summary of the number of diamonds that you are submitting and the number that you have excluded from the upload. * Select **Submit** to complete the upload and submit the session for matching and verification. * On the confirmation page, either select **View in history** to display the submitted session on the **Session history** page or **Download report** to download a report of the completed session. #### What happens next? Tracr processes the session, which appears on the **Session history** page with the status ‘Submitted’. #### What to do if Tracr does not accept a file Tracr validates each file as it is uploaded. If a file fails validation, it is listed on the **Failed files** tab. You should review the details to understand why Tracr did not accept the file. To save the session and continue later when you have the correct file, select the **Quit** button, choose **Save and quit**, and then select **Quit**. The session appears on the **Session history** page with the status ‘In progress’. {% endstep %} {% step %} ### View the processing status of your upload Monitoring is part of the data integration process, and it allows you to monitor the verification status of the diamonds you have uploaded to Tracr. #### Check the verification status of your diamonds * From the Tracr menu, select **Integration > Monitoring**.\ Tracr displays the status of all the diamonds that you have uploaded. * Use the filters at the top of the **Integration monitoring** page to locate your session. #### Status Tracr displays the status of an integration as either ‘Registered’ or ‘Error’. * **Registered** – The diamond is verified and on the Tracr Portal. You can find the diamond in your inventory. * **Invalid** – An error has occurred, and Tracr did not register the diamond. Check the entry in the **Details** column to understand the error. #### What do the error messages mean? If the status is ‘Invalid’, the **Details** column displays the reason Tracr did not verify the diamond. Common errors include: * **Child diamond cannot be heavier than its parent** – The parent diamond carat weight is less than the subject diamond. * **No boxes found** – The box ID in the CSV used to upload a rough diamond has not been found for the sight year and number provided. * **Too many carats** – The total carat weight does not match the expected carat weight as registered against the box by De Beers. * **Too many diamonds** – You are trying to register more diamonds than De Beers assigned to the box. * **Diamond is not unique** – The same diamond ID already exists on Tracr. * **Could not find existing diamond or parent (parent id xxxxxx) for yyyyyy** – You cannot register a split or polish or perform an update because the existing or parent diamond is not registered on Tracr. For more help on these and other error messages that you may see in the **Details** column, please contact {% endstep %} {% step %} ### Review your diamond inventory Once a diamond is registered and assigned a Tracr ID, it appears in your inventory. #### View diamonds in your inventory There are separate diamond inventories for the various lifecycle states: Rough, Split, Polished, and Graded. * From the Tracr menu, select **Inventory > Rough / Split / Polished / Graded**.\ Tracr displays diamonds in the selected inventory. * Use the filters at the top of the **Inventory** page to find diamonds in your inventory. Different filters are available depending on the lifecycle state of the diamond. #### You need to know Tracr automatically manages your inventory, which means that every time you integrate diamonds, and they pass the control process, your inventory is updated. For example, if you have diamonds in your rough inventory and then upload polished data, Tracr automatically moves the diamonds from your rough inventory to your polished inventory. {% endstep %} {% step %} ### View a diamond’s journey (Diamond Details) The Diamond Details page is a visual representation of a diamond's journey through its lifecycle, and it is available for all diamonds in your inventory. #### View the Diamond Details for a diamond You can view the Diamond Details page for a single diamond or multiple diamonds in your inventory. * From the menu, select **Inventory > Rough / Split / Polished / Graded**.\ Tracr displays diamonds in the selected inventory. * Select the checkbox next to the diamond(s) that you want to view. * At the bottom of the page, select **View**.\ Tracr displays the **Diamond Details** for the selected diamond. If you selected multiple diamonds, use the next and previous arrows to display the Diamond Details page for each diamond. #### What does the Diamond Details show? For each diamond, the Diamond Details page displays a photograph of the latest stage of the diamond (if provided), basic information (provenance, carat, shape, colour), and the Tracr ID. Also shown is a summary of the diamond’s stages (Rough > Split (latest version) > Polished) followed by photographs/videos and more details about each stage. You can also view stage-specific details, scan reports, and grading certificates (if provided). {% endstep %} {% step %} ### Share diamond data You can use Tracr to share the details of one or more diamonds with an external party. #### Share diamond data by email You can share diamond(s) from your inventory or from the Diamond Details page. * From inventory: * Open the inventory containing the diamond(s) that you want to share. * Select the diamonds that you want to share and, at the bottom of the page, select **Share**. * From the Diamond Details page: * Display the Diamond Details page for the diamond(s) that you want to share. * Select the **Share** button. * On the **Share** page, check the preview to ensure you are sharing the correct diamond(s). * If you do not want to share a selected diamond, select the diamond in the diamonds selected to share section, and then select **Remove**. * Provide the following information: * **To** – Enter the email address of each recipient, separated by a comma or space. * **Subject** – Enter the subject of the email. * **Message** – Enter a message to the recipient(s). * Select **Send**.\ Recipients receive an email containing a link to view the diamond(s) that you shared. Note that the link is active for seven days. {% endstep %} {% endstepper %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.tracr.com/tracr-user-guide/2.-quickstart.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.