Import Swimlane Solution Packages

import swimlane solution packages (ssps, file extension ssp ) into a turbine instance packages contain one or more applications, applets, playbooks, builder components, or builder solutions along with all associated entities at a glance step action 1 upload the ssp or json file 2 review and select the entities to import 3 optionally enable the import playbooks in enabled state toggle 4 resolve any duplicate or overwrite conflicts 5 resolve any plugin version requirements 6 monitor import progress 7 review results and resolve actionable issues 8 enable any remaining disabled playbooks and webhooks 9 reconfigure credentials, key store values, and secure asset fields importing ssps requires the system administrator role connectors are not included in ssps install and configure required connectors separately before importing during import, turbine displays connector cards showing which connectors are needed so you can verify they are installed upload and import an ssp open the applications and applets page click the plus icon and select import or export a package drag and drop your ssp or json file into the dialog, or click browse to select it wait for turbine to upload and validate the package a spinner indicates upload progress after validation, turbine either proceeds to the entity selection screen (if the ssp contains a relationship graph) or directly to import (for older ssp formats) select entities to import after validation, turbine displays a tree view of all entities in the package the tree shows each entity with its type label and any child entities nested beneath it review the entity tree by default, all entities are selected use the select all / deselect all toggle to change the selection in bulk click individual check boxes to include or exclude specific entities optionally, enable the import playbooks in enabled state toggle (see below) click import to proceed import playbooks in enabled state by default, playbooks are disabled during export and remain disabled after import the import playbooks in enabled state toggle appears on the entity selection screen toggle state behavior on playbooks are imported in an enabled state and begin running immediately after import off (default) playbooks are imported in a disabled state you must enable them manually after import enable this toggle when you want the solution to be fully operational immediately after import, such as when deploying a tested package to a production environment partial import warning if you deselect some entities from the package, turbine displays a confirmation dialog you are choosing not to bring in all the content of this solution this will likely cause the solution not to work as intended you can click cancel to return to the selection screen, or install anyway to proceed with the partial import ssps exported from turbine versions before 11 4 0 do not support selective entity import all entities in those packages are imported automatically handle connectors during import ssps reference connectors by name but do not include connector packages when you select entities that reference connectors, turbine displays a connector panel next to the entity tree the panel shows the number of connectors required (for example, "in order for this ssp to import successfully, we must import 2 connectors first " ) a card for each connector showing its icon , title , and author from the marketplace a view details link on each card to open the connector's full marketplace details if a referenced connector is not installed on the target system note the connector name from the panel install it from the marketplace before or after import if you import without the connector, turbine displays a warning you can install the connector later and manually link it resolve duplicate and overwrite conflicts if an entity in the package already exists in the target environment, turbine alerts you non selectable ssps (no relationship graph) if the ssp does not contain a relationship graph, turbine displays a list of duplicate entities with a warning icon you must confirm the overwrite for all duplicates review the list of existing entities that will be overwritten in the confirmation dialog, press and hold the mouse button on the overwrite button to confirm release to complete the overwrite selectable ssps (with relationship graph) if the ssp contains a relationship graph, turbine shows duplicate entities highlighted in the entity tree with an overwrite icon conflict type description action uid conflict an entity with the same unique identifier already exists select the entity to overwrite it, or deselect to skip name or acronym conflict a different entity with the same name or acronym exists select to overwrite, or deselect to skip a warning message appears at the top of the selection screen certain items already exist in the environment selecting these items will overwrite the existing files if any selected entity requires an overwrite, the import button changes to overwrite click it, then press and hold to confirm import errors same name, different sharing id sometimes the entity tree does not list an item as a simple duplicate, but the import still stops with errors when turbine saves packaged entities typical messages include builder component buildercomponent named '\<name>' already exists in this environment with a different sharing id to proceed further with the import, the existing buildercomponent must be renamed playbook playbook with name '\<name>' already exists asset or other entities an error was encountered while saving the asset or save of \<entity> failed (often with a chain of dependent builder components listed in the error text) what this means the target tenant already has an entity with the same name as something in the package, but that existing entity came from another export or solution and has a different sharing identity than the one in the ssp turbine does not merge those automatically the text is intentional so you know exactly which name conflicts and that you must act before the import can succeed approach when to use it rename or delete the conflicting entity in the target tenant you want to keep the version from the ssp and the ui directs you to free the name (for example rename the existing builder component or playbook) change what you import on the entity selection screen, deselect types or items you do not need, if overlapping content from two solutions makes part of the package redundant adjust the package work with your team to rename entities inside the ssp (or re export from a clean source) when bulk collisions are hard to fix in the tenant use a clean tenant you need a full import without resolving many collisions (for example a new environment used only for that solution) for long error lists, use copy notes or download notes on the import results screen, or capture a har file while reproducing the import, so support can see the same messages you see resolve plugin version requirements if the ssp requires plugins that are a different version than what is installed on the target system, turbine pauses the import and displays a notification review the list of plugins that need to be upgraded upgrade each plugin to the required version after all plugins are upgraded, click continue to resume the import if the target system has a newer plugin version than the ssp expects and the ssp requires a downgrade, the import cannot proceed re export the ssp from a system with a compatible plugin version monitor import progress after you start the import, turbine displays a progress spinner with a percentage and a real time status label progress status label 0% preparing to start the import 10% validating package contents 20% installing required connectors 30% processing entities to import 40% validating entities 50% importing entities 70% linking and verifying relationships between entities 80% running integrity checks 90% finalizing import 100% import complete the progress indicator shows the current percentage in the center of the spinner if the import fails, the spinner displays import failed with an error message below it you cannot cancel an import once it has started wait for the import to complete or fail before taking further action review import results after the import completes, turbine displays a results screen with up to three tabs tab contents take action actionable issues you can resolve inline a yellow badge shows the count of remaining issues take note non actionable informational warnings these do not prevent the solution from functioning import inventory a read only tree of all entities that were imported actionable vs non actionable issues category description examples actionable (take action tab) issues that require your action for the solution to be fully functional resolving them inline marks them as complete a secure credential was removed; a key store reference was stripped; an asset configuration needs updating non actionable (take note tab) informational warnings you should be aware of but that do not require immediate action a playbook was disabled during export; a webhook url was modified each actionable issue shows the affected entity name, the issue description, and a control to resolve it (for example, reconfigure a credential or enable a disabled task) after you resolve an issue, it is marked as complete and the count decreases post import actions from the results screen footer, you can button action go to application opens the imported application in the builder so you can review and fix issues go to applet opens the imported applet in the builder import more returns to the upload screen to import another ssp close closes the import dialog copy or download import notes from the results screen header, you can save a summary of all issues and warnings click copy notes to copy the summary to your clipboard click download notes to save it as a txt file named swimlane import package txt enable playbooks and webhooks after import unless you used the import playbooks in enabled state toggle during entity selection, playbooks and webhooks are imported in a disabled state you must enable them for the solution to be fully operational enable playbooks after a successful import, if there are disabled playbooks, turbine displays an info banner some playbooks were disabled during export enable them all now or later click enable n playbooks (where n is the count) to enable all disabled playbooks at once alternatively, navigate to the playbooks page and enable them individually the include scheduled tasks toggle controls whether scheduled trigger playbooks are included in the bulk enable toggle it off to exclude scheduled playbooks from the bulk action enable webhooks if there are disabled webhooks, a similar banner appears some webhooks were disabled during export enable them all now or later click enable n webhooks to enable all at once alternatively, enable them individually from the webhook configuration enable builder playbooks if the ssp contains builder solutions with disabled builder playbooks, you can enable them in bulk from the import results screen turbine clears the "disabled" status and removes the associated informational messages reconfigure credentials and secure values during export, the following are removed for security item post import action secure credentials in assets open each asset and re enter the credentials key store values mapped to task inputs open the application and add the key store references secure values in asset configurations open each asset and reconfigure the secure fields dynamic orchestration asset credentials open each do asset and re enter credentials sensor credentials open each sensor and re enter credentials webhook urls verify and update webhook urls if they have changed these items appear on the take action tab of the import results resolve each one to mark it as complete deploy from content library when importing from the content library (deploy flow), the experience is the same as a standard import with the following differences difference standard import content library deploy terminology "import," "importing" "deploy," "deploying" dialog title "import" or "package import" "deploy package" or entity specific (for example, "deploying playbook") inventory tab label "import inventory" "deployed inventory" import more button "import more" "deploy more" (if applicable) all other functionality (entity selection, overwrite handling, progress tracking, and result review) is identical version history and revert when working with content library content, the import dialog includes additional tabs for managing versions view version history open the content from the content library select the version history tab review the table showing each version with its version number , last modified timestamp, and commit message revert to a previous version if a newer version introduces issues, you can revert to a previous version in the version history tab, click revert select the version you want to revert to by clicking its radio button enter a new version number for the reverted content the version must be valid and unique enter a reason for reverting in the commit message field click revert to confirm on success, turbine displays a confirmation \[package name] has been successfully reverted in your library after reverting in the content library, the version in tenant environments may be out of sync redeploy the reverted content to each tenant to apply the change if the revert fails, turbine displays an error message wait a few minutes and try again if the error persists, contact support troubleshooting issue cause resolution import fails with "incompatible swimlane version" the ssp was exported from a newer turbine version upgrade the target turbine instance import fails with "plugin upgrade required" the target system has an older version of a required plugin upgrade the plugin from the notification, then click continue import fails with "plugin downgrade required" the target system has a newer plugin version than the ssp expects re export the ssp from a system with the matching plugin version import fails with "dynamic orchestration feature flag required" the ssp uses dynamic orchestration but the flag is not enabled enable the dynamic orchestration feature flag, then retry import fails with "python version" error the ssp requires a different python version verify the python runtime version on the target system "could not load file in package" a file is missing or corrupted in the ssp re export the ssp from the source system, or see docid\ iddmad crfd dy032gwyu playbooks not running after import playbooks are disabled during export by default enable playbooks from the import results screen, or use the import playbooks in enabled state toggle during entity selection "no connector matching the provided name exists" a referenced connector is not installed on the target system install the connector from the marketplace before retrying "solution not working as intended" after partial import some dependent entities were not imported re import the ssp with all entities selected import stalls at a percentage a network or server issue interrupted the process wait for the import to time out, then retry if the issue persists, check server logs