Skip to main content

Rigi Documentation

Upload files to the workspace

  1. Open the required project.

  2. In the project menu, select Workspace > Files.

  3. Click the Upload files button.

    Upload_files.png

  4. Drag and drop a ZIP package containing resource files or click on the gray area to select the package on your local machine.

    Important

    Only source files should be assigned to the workspace. If a target file is assigned to the workspace, it will be regarded as a source file, and its strings will be regarded as source strings.

    Manifest.json

    The ZIP package can optionally contain a manifest file. It will be located in the root folder and named "manifest.json".

    If a manifest file is present, the workspace will be updated with the files listed in the manifest.

    This JSON file contains an array of objects. Each object refers to a file in the ZIP package. Each file contains a filepath and, optionally, the parser ID, target rule name, and file ID.

    { "filepath": "subfolder/myfile.json", // Relative path in the ZIP file "parserId": "json", // If not specified, the default parser will be selected "targetRule": "TR_Json" , // If not specified, the default target rule name will be selected "fileId": "myfile" // If not specified, a default one will be generated }

  5. Click the Upload button. A summary listing the uploaded files will be displayed. The possible options are:

    image.png

    • New files. Files whose full file path is not available in the current workspace.

    • Replace files. Files that were already available in this workspace. They will be replaced, but their parser, target rule, and file ID will remain the same. This happens when new versions of files are uploaded.

    • Delete files. Some files from the workspace were not present in the uploaded ZIP. They will be removed and unassigned from the workspace.

    Alternatively, developers can upload files via the API.

  6. Check if the uploaded files match your expectations.

  7. Click the Accept button.

Validation error

In some rare cases, a validation error can occur. This can, for example, be caused by a corrupted target rule for a file extension of one of the uploaded files. For details on how to fix it, see the Validation error – Troubleshooting section below.

Validation_error.png

 

Warning

The steps described below should only be performed by experienced Rigi users!

If you are unsure about how to perform these steps or what effects they might have, you should be very cautious about doing so.

If that is the case, we recommend that you contact the Rigi team for advice.

Part 1: Analysis – which file extensions are causing the issues?

First, you need to find out which file extension is causing the issues.

  1. Upload a ZIP package containing a file whose file extension is suspected of causing issues. If the validation error occurs, it means that this specific file extension has caused the issues.

  2. Do the same for all file extensions used in your project.

Part 2: Execution – for selected file extensions.

Important

Before proceeding to resolve the file extension problems (as described below), create a backup of your project! For details, see the Clone a project guide.

  1. In the project menu, select Workspace > Files.

  2. From the Advanced dropdown menu, select the Export file IDs option to export an XLSX file containing the current settings.

  3. Unlink all files that have the file extensions that are causing the problems (see the Analysis section above).

  4. In the project menu, select Workspace > Rules.

  5. Make a copy of the target rule for each file extension that is causing the problem.

  6. Delete the target rules for the file extensions that were shown to cause the problems during the analysis.

  7. Upload the files again.

  8. In the project menu, select Workspace > Files .

  9. Click the Advanced > Import file IDs button to import the XLSX file that was created in Step2.

  10. Edit the target rules to match the rules copied in Step 5.

If the problem persists, contact the Rigi team.