Review File Import Library
Overview
This library is for importing Lightning Review review files.
Normally, you would need to launch the Lightning Review application to access the review files.
Using this library eliminates the need to launch the application, allowing you to import from your own programs or environments.
This allows you to acquire and analyze information from a large number of review files in bulk.
This library is released as open-source software (OSS).
What the Library Can Do
Traditionally, the Lightning Review program analyzed the information in review files,
but this library allows you to acquire data directly from the review files without going through a program.
This enables the following: * Analyzes from unique perspectives not supported by the program.
- Items that cannot be listed in Review Explorer (processes, custom fields, etc.)
- Items that cannot be aggregated even with pivot analysis (density of issues based on actual output, etc.)
- Automatically aggregates and analyzes review data at the organizational level on a regular basis (monthly/weekly).
- By saving the aggregated results, you can understand changes in the review quality situation.
- Aggregates review files for all projects/organizations with a single button click, without setting up Review Explorer.
For users who are struggling with wanting to analyze from perspectives not output by Lightning Review,
Why not try it out first?
Key Points
- Extremely fast processing.
Loading 1,000 review files can be processed in seconds. - Easy to call up.
- Can be read not only from programs but also from the command line.
- Acquired data can be output in JSON format.
For example, by "importing the output JSON file into Excel,"
you can see information that was not available in previous versions of Lightning Review (such as the density of criticisms).
Operating Environment and Processing Details
Please refer to the following page.
"GitHub: LightningReview-ReviewFile"
For details on the information that can be obtained, please refer to "Explanation of Output Fields" on the above page.
"Usage Example - Reading from Command Line and Expanding to Excel"" introduces
how to read from the command line and expand the information of the review file into Excel.
How to Obtain the Library
This library is available on GitHub.
Please obtain it from the following page and use it freely.
"GitHub: LightningReview-ReviewFile"
Notes
- This library is updated regularly.
Please note that it may be changed without notice.
Please check the linked page for update status. - This library is open-source software (OSS).
Therefore, the user is responsible for guaranteeing the results of using the library.
(For the same reason, please understand that support is not provided for tool-related matters.) - If you have any requests or unexpected behavior regarding this library, please feel free to contact the support team.
We will answer and advise you to the best of our ability.
Example of Use: Displaying Review File Data in Excel by Running a Command Line Program
We will introduce a concrete example of using this library with a video.
Here, the following steps are performed:
-
Step 1: Run a command line program to output the review file data.
-
Step 2: Display the data from the output review file in a table format in Excel.
Step 1: Execute the command-line program to output the review file data.
This program outputs the feedback data registered in the review files stored in multiple locations within the folder in JSON format.
In the video below, the program is executed by specifying the folder containing the Lightning Review files in the Windows command prompt, outputting a file named output.json.
Step 2: Display the data from the output review file in a table format in Excel.
JSON format data can be converted to a table format using Excel's functions.
In the video below, the JSON format data (output.json) obtained in Step 1 is converted to a table in Excel.
This allows you to list the raw data held by the Lightning Review file, and then analyze it in your preferred format.
