Documentation
...
Swimlane Solution Packages
Repackage an Unzipped SSP File
repackage a swimlane solution package (ssp) after unzipping and editing it so that it imports correctly into turbine swimlane recommends working with a support representative before editing ssp files manually incorrect edits can cause import failures that are difficult to diagnose at a glance step action 1 unzip the ssp file 2 edit the entity files as needed 3 recompress using the cli zip command (not os level compression) 4 rename the zip to ssp 5 verify the archive structure before importing what is inside an ssp an ssp is a standard zip archive with the ssp extension when you unzip it, you will see manifest json β package metadata (name, version, description) located at the root of the archive entity directories β folders such as application , playbook , workflow , workspace , report , dashboard , sensor , connector , and others each folder contains one or more json files representing individual entities meta directory β internal mapping files that turbine uses to link entities together during import do not rename, delete, or modify files in the meta directory these files are critical for a successful import if they are missing or corrupted, the import will fail guidelines for editing edit only entity json files in the entity directories (such as application , workflow , and so on) change only the specific fields you need to update do not rename files file names are linked to internal mappings do not leave files empty an empty file causes an import error do not add or remove files unless you also understand how to update the internal mappings in the meta directory validate your json malformed json causes a "could not load file" error during import repackage the ssp open a terminal and navigate into the ssp content directory β the folder that contains manifest json and the entity directories verify that you are in the correct directory ls manifest json compress the contents back into a zip file using the cli zip r filename zip x " /\\ " rename the zip file to ssp mv filename zip filename ssp use the cli zip command as shown above do not use your operating system's built in compression (for example, right click and compress on macos or windows) os level tools often create a wrapper directory inside the archive, which causes a "couldn't find mapping in the package" error on import the x " /\\ " flag excludes hidden files (such as ds store on macos) that can interfere with import verify before import after repackaging, verify the structure is correct list the archive contents unzip l filename ssp confirm that manifest json and the entity directories appear at the root level of the archive β not inside a subdirectory correct β files are at the root manifest json application/abc123 json meta/idmapping json workflow/def456 json incorrect β files are nested in a wrapper directory (will fail on import) my package/manifest json my package/application/abc123 json my package/meta/idmapping json if the structure is incorrect, delete the ssp file, navigate into the content directory, and repeat the zip command from step 3 common errors error on import likely cause fix "couldn't find mapping in the package" the archive has a wrapper directory, or the meta directory is missing re zip from inside the content directory so files are at the root "could not load file in package" an entity json file is malformed or empty validate json syntax in all edited files "swimlane solution package required" the file does not have a ssp extension rename the file to end in ssp