Guide to Creating and Customizing Reports in Wordsmith
This guide provides a comprehensive overview of the Report features in Wordsmith, detailing how to create new reports, customize data columns, apply filters, and manage sharing settings
1. Creating a New Report
Follow these steps to initiate and set up a new report:
- Access the Reports Tab: Navigate to the Reports tab within the Wordsmith interface.
- Start a New Report: Click the New Report button to begin the creation process.
- Define Report Identity: Enter a descriptive name for your report to ensure easy identification.
- Provide Details: Fill in any necessary details to clearly describe the report's purpose and content.
- Finalize Creation: Click Create to generate the new report with the information you have provided.
2. Customizing Report Columns
After creating the report, you can configure the data fields that will be displayed by adding and customizing columns.
- Add a Column: Click Add Column to insert a new data field into your report structure.
- Name the Column: Assign a clear name to the column to indicate the data it will contain.
- Select Column Type: Choose the appropriate type for the column. Common types include:
- Define Extraction Criteria: Specify the exact data you want the column to extract from the source documents.
- Save Configuration: Click Save to apply the column configuration to your report.
3. Adding Documents to the Report
To ensure your report is populated with relevant data, you must link the source documents from your repository or upload from your computer.
- Access Document Selection: Click Add Documents to open the document selection interface.
- Select from Repository or Upload document
- If you Choose Pick from Repository, you will access documents stored in your Wordsmith repository, click on the repository you want to import, and click on the ‘Add documents’ button.
- If you choose Upload document, select the documents you want to upload on your computer.
4. Filtering Report Data
Filtering is essential for narrowing down the data in your report to meet specific analytical requirements.
A. Using Option Value Filters
This method allows for precise filtering based on specific values or provisions within the documents.
- Enter Filter Term: Begin by entering a broad term, such as Termination, to narrow the scope of the data.
- Specify Option Value: Click Option Value to define the specific criteria for the filter.
- Add Filter Options: Enter detailed filter options, such as Termination for Cause or Termination for Convenience, to refine the data set.
- Apply Filter Logic: Navigate to the Filter section to set the logic for how the data is filtered. For instance, you can set a condition like: "Where a Termination for Cause provision exists, select Termination for Cause."
- Save Filter Settings: Click Save to apply the new filter settings to your report.
B. Filtering by Document Title
You can also filter the report based on keywords found in the document titles.
- Access Filter Options: Click Filter to open the available filtering options.
- Select Document Title: Choose Document Title to filter the report data based on document titles.
- Enter Text Criteria: Click Enter Text and type the search term you wish to use for filtering.
- Apply Filter: Click Document Title Contains to apply the title-based filter to your report.
5. Checking and verifying the cells
When you click on each cell, you will see both the full cell content and the reasoning. The reasoning contains citations. You will see the citation within the source document if you click on the citation number in the reasoning.
Once you have viewed the cell answers and the reasoning, you can either approve or flag the cell.
- Approving the cell will turn the cell into green, signifying that you are happy with the result
- If you are concerned about the result, click on the ‘flag’ button it will turn the cell into orange. You can then choose to edit the column Extraction Criteria and rerun the cells to see if the result is improved.
6. Managing and Sharing the Report
Once your report is finalized, you can download it or share it with others.
- Download: Click Download to save a copy of the report to your local device.
- Share: Click Share to access the sharing options.
- Set Access: Determine the appropriate access level:
- Private: Restrict access to only selected users.
- My Organization: Share the report with all users within your organization.
- Select Users (if Private): If the report is private, click Select a user to choose the specific individuals who should have access.
- Copy Link: Click Copy Link to save the report's sharing URL to your clipboard for easy distribution.
- Finish Sharing: Click Done to complete the setup of your report sharing options.
By following these steps, you can efficiently generate detailed and customized reports in Wordsmith, tailored precisely to your analytical needs.
