This 
) of the PowerFlow user interface to import, install, and view SyncPacks, which are also called "SyncPacks".
PowerFlow and SyncPacks content not created by ScienceLogic is not supported by ScienceLogic. This includes custom steps, PowerFlow applications, and SyncPacks.
What is a SyncPack?
A SyncPack contains all of the code and logic needed to perform integrations on the PowerFlow platform. A SyncPack is saved as a Python .whl file, and it typically includes Python steps that are listed in PowerFlow applications and shipped with one or configuration objects:
You can access the latest steps, applications, and configurations for PowerFlow or a third-party integration, such as ServiceNow, by downloading the most recent SyncPack for that integration. You can download SyncPacks from the PowerPacks page at the ScienceLogic Support Site at https://support.sciencelogic.com/s/.
You can access all SyncPacks that have been uploaded to your PowerFlow system on the SyncPacks page.
A SyncPack is highly customizable, and you can modify the contents of a SyncPack to meet your business needs, instead of changing your SL1 configuration. You can categorize and segment your business integration solutions using a SyncPack.
SyncPacks let you distribute content to simplify installations, upgrades, and maintenance of integration solutions. Just like PowerPacks, you can also share SyncPacks. In addition, SyncPacks protect a company's intellectual property using licensing and encryption technologies.
Viewing the List of Synchronization PowerPacks
The SyncPacks page provides a list of the SyncPacks on your PowerFlow system.
Searching for a SyncPack
You can search for a specific SyncPack by typing the name of that SyncPack in the Search field at the top of the SyncPacks page. The user interface filters the list as you type. You can also filter the list by typing in the text box above a column header, and sort by clicking most column headers.
If you have more than one version of a SyncPack the active version of the SyncPack is highlighted in green in the Versions column.
Click the Filter icon (
) at the top right of the SyncPacks page and select Toggle Inactive SyncPacks to show all SyncPacks on the PowerFlow system.
Viewing a Detail Page for a SyncPack
Click the name of a SyncPack from the list to view the detail page for the SyncPack.
At the top of this page you can view additional metadata, including the active version, the minimum PowerFlow platform version, and other details.:
In the Package Contents section, you can view more details about the steps, applications, and configuration objects include with that SyncPack:
- The tab includes a link to the detail page for each application, along with a list of steps in the application (with the option of clicking the step name to view the code for that step), and a thumbnail image of the workflow for the application.
- The tab includes a link to the Step Code dialog for each step, along with a list of any applications that are using that step. You can also click the name of the application from the list to go to the detail page for that application.
- The tab includes a link to the detail page for each configuration object, along with a list of any PowerFlow applications that are aligned with that configuration object (with the option of clicking the application name to view the detail page for that application).
Using the Actions Button to Manage SyncPacks
On the SyncPacks page of the PowerFlow user interface, you can access the following SyncPack options by clicking the button (
) next to a SyncPack:
-
Activate & Install. Before you can use a SyncPack, you will need to activate and install it. An activated SyncPack has been installed and is ready to be used. For more information, see Activating and Installing a Synchronization PowerPack.
If you try to activate and install a SyncPack that is already activated and installed, you can choose to "force" installation across all the nodes in the PowerFlow system.
-
Change active version. If you have more than one SyncPack installed, select this option to specify a new active version (other than the version that is currently running).
-
Uninstall. Select this option if you want to completely remove all versions of a SyncPack, instead of deleting one or more versions using the Delete option, below.
-
Delete. Remove one or more versions of a SyncPack from PowerFlow. You cannot delete the active version of a SyncPack (the version that is currently running).
Click the Filter icon () at the top right of the SyncPacks page and select Toggle Inactive SyncPacks to show all SyncPacks on the PowerFlow system.
Importing and Installing a SyncPack
The SyncPacks page in the PowerFlow user interface lets you import and install the latest version of a SyncPack. After you install a SyncPack, PowerFlow considers that SyncPack to be activated and ready to be used.
By default, the SyncPacks page displays all activated and installed SyncPacks. If you do not see the PowerPack that you want to install, click the Filter icon (
) on the SyncPacks page and select Toggle Inactive SyncPacks to see a list of the imported PowerPacks.
After you install a SyncPack, that SyncPack is available on the SyncPacks page of the PowerFlow user interface. The PowerFlow applications from that SyncPack are added to the Applications page of the user interface. You can click the name of that SyncPack to view the detail page for that SyncPack.
If you want to upload and install multiple ServiceNow SyncPacks at the same time, you should upload all of the SyncPacks first, and then install them to address any dependencies between the SyncPacks.
Also, you can click the dropdown arrow next to the button to import or view dependencies for PowerFlow SyncPacks. For more information, see Locating and Importing Dependencies for a SyncPack.
If a SyncPack has a dependency on another specific SyncPack version, you will need to install that SyncPack version on the PowerFlow system before you can install the SyncPack with the dependency. For more information, see the SL1 PowerFlow Dependency Matrix page at https://docs.sciencelogic.com/latest/Content/Web_General_Information/Doc_Archive/powerflow_release_matrix.htm.
You must have the Develop or Administrator role to install a SyncPack. For more information, see Managing Users in PowerFlow.
If your PowerFlow system uses self-signed certificates, you will need to manually accept the certificate before you can upload SyncPacks. Go to https://<IP address of PowerFlow>:3141/isadmin, accept the certificate, and then exit out of the tab. When you log into PowerFlow again, you will be able to upload SyncPacks.
Locating and Downloading a SyncPack
A SyncPack file has the .whl file extension type. You can download the SyncPack file from the ScienceLogic Support site.
If you are upgrading to this version of the SyncPack from a previous version, make a note of any settings you made on the Configuration pane of the various PowerFlow applications in this SyncPack, as these settings are not retained when you upgrade.
To locate and download the SyncPack:
- Go to the ScienceLogic Support Site at https://support.sciencelogic.com/s/.
- Click the tab and select PowerPack.
- In the Search PowerPacks field, search for the SyncPack and select it from the search results. The Release Version page appears.
- On the tab, click the name of the SyncPack version that you want to install. The Release File Details page appears.
- Click the button or click the name of the .zip file containing the .whl file for this SyncPack to start downloading the file.
After you download a SyncPack, you can import it to your PowerFlow system using the PowerFlow user interface.
If you are installing or upgrading to the latest version of this SyncPack in an offline deployment, see "Installing or Upgrading in an Offline Environment" in the SyncPack release notes to ensure you install any external dependencies.
Importing a SyncPack
To import a SyncPack in the PowerFlow user interface:
- On the SyncPacks page () of the PowerFlow user interface, click . The Import SyncPack page appears.
- Click and select the .whl file for the SyncPack you want to install. You can also drag and drop a .whl file to the Import SyncPack page.
- Click . PowerFlow registers and uploads the SyncPack. The SyncPack is added to the SyncPacks page.
- You will need to activate and install the SyncPack in PowerFlow. For more information, see Activating and Installing a Synchronization PowerPack.
You cannot edit the content package in a SyncPack published by ScienceLogic. You must make a copy of a ScienceLogic SyncPack and save your changes to the new SyncPack to prevent overwriting any information in the original SyncPack when upgrading.
Activating and Installing a SyncPack
To activate and install a SyncPack in the PowerFlow user interface:
-
On the SyncPacks page of the PowerFlow user interface, click the button (
) for the SyncPack you want to install and select Activate & Install. The Activate & Install SyncPack modal appears.If you try to activate and install a SyncPack that is already activated and installed, you can choose to "force" installation across all the nodes in the PowerFlow system.
If you do not see the PowerPack that you want to install, click the Filter icon (
) on the SyncPacks page and select Toggle Inactive SyncPacks to see a list of the imported PowerPacks.
- Click to confirm the activation and installation. When the SyncPack is activated, the SyncPacks page displays a green check mark icon (
) for that SyncPack. If the activation or installation failed, then a red exclamation mark icon (
) appears. - For more information about the activation and installation process, click the check mark icon () or the exclamation mark icon () in the Activated column for that SyncPack. For a successful installation, the "Activate & Install SyncPack" application appears, and you can view the Step Log for the steps. For a failed installation, the Error Logs window appears.
- If you have other versions of the same SyncPack on your PowerFlow system, you can click the button () for that SyncPack and select Change active version to activate a different version other than the version that is currently running.
Locating and Importing Dependencies for a Synchronization PowerPack
The most common error that occurs when installing a SyncPack is that the SyncPack dependencies are not installed. If a SyncPack has a dependency on another specific SyncPack version, you will need to import and install that SyncPack version on the PowerFlow system before you can install the SyncPack with the dependency.
Review the "System Requirements" section of the release notes for that SyncPack to ensure that you have installed all of the required applications for that SyncPack.
To view a list of additional PowerFlow and SL1 products that are required by the various Synchronization PowerPacks, see the SL1 PowerFlow Dependency Matrix page at https://docs.sciencelogic.com/latest/Content/Web_General_Information/Doc_Archive/powerflow_release_matrix.htm.
In addition, you can click the dropdown arrow next to the button to import or view dependencies for PowerFlowSyncPacks.
To view a list of available dependency files:
- Click the down arrow icon (
) next to the button and select View Dependencies. A devpi dependencies page appears. - To view more information about a dependency, click the link in the Info page column.
- To download a dependency file, click the link in the Releases column.
To import a dependency:
-
Click the down arrow icon (
) next to the button and select Import Dependency. -
Click and select the relevant dependency file from the previous step.
You can also drag and drop a file onto the Import SyncPacks page.
- Click . The dependency file is added to the PowerFlow system .
Default SyncPacks
When you install PowerFlow, the following SyncPacks are added to the SyncPacks page by default:
If you need to install these SyncPacks, click the button () and select Activate & Install for each SyncPack.
Base Steps SyncPack
The "Base Steps" SyncPack contains a default set of steps that are used in a variety of different SyncPacks. You must install and activate this SyncPack before you can run any of the other SyncPacks.
This SyncPack is included with the most recent release of the PowerFlow Platform. You can also download newer versions of this SyncPack, if available, from the PowerPacks page of the ScienceLogic Support Site at https://support.sciencelogic.com/s/.
Starting with version 1.5.0 of the "Base Steps" SyncPack, the "QueryREST" has been deprecated.
For more information about the latest releases of this SyncPack, see the SL1 PowerFlow Synchronization PowerPack Release Notes.
Contents of the SyncPack
Click to view the contents
This SyncPack contains the "Template App" PowerFlow application. You can use the "Template App" application as a template for building new PowerFlow applications.
Click the down arrow icon (
) next to the application name to view the steps and workflow for that application. Click the application name to go to the Application detail page.
This SyncPack includes the following steps, which you can use in new and existing applications:
- Cache Delete. Deletes data from the cache.
- Cache Read. Reads data from the cache using the save_key option and sets the returned data for the next step.
- Cache Save. Takes any input data and saves it to a cache with the key specified in the save_key parameter. The key the data was saved with is saved for the next step.
- DeleteREST. Facilitates REST DELETE interactions, returns the returned data dictionary and specified headers as data for the next step.
- Deprecated: Direct Cache Read. Attempts to read from cache without using any N1QL or indexes.
- Deprecated: Query REST. Facilitates REST interactions, returns the returned data dictionary and specified headers as data for the next step.
- GetREST. Facilitates REST GET interactions, returns the returned data dictionary and specified headers as data for the next step.
- Jinja Template Data Render. Transforms the incoming data using a defined Jinja2 template.
- MS-SQL Describe. Executes a Microsoft SQL SP_HELP Statement.
- MS-SQL Insert. Executes a Microsoft SQL INSERT Statement.
- MS-SQL Select. Executes a Microsoft SQL SELECT statement.
- MySQL Delete. Executes a MySQL DELETE statement.
- MySQL Describe. Executes a MySQL DESC statement.
- MySQL Insert. Executes a MySQL INSERT statement.
- MySQL Select. Executes a MySQL DELETE statement.
- PostREST. Facilitates REST POST interactions, returns the returned data dictionary and specified headers as data for the next step.
- PutREST. Facilitates REST PUT interactions, returns the returned data dictionary and specified headers as data for the next step.
- Query GraphQL. Queries a remote GraphQL endpoint and retrieves the data.
- QueryRest: BearerAuth. Makes a RESTful request to an endpoint with BearerAuth.
- QueryRest: OAuth. Makes a RESTful request to an endpoint with OAuth.
- Run a command through an SSH tunnel. SSHes into the provided system and executes a command.
- Trigger Application. Lets you trigger any number of the same application based on application variables or input data. If this step is set to have an output_to setting, the step will automatically wait until all of its child triggered applications are completed. If output_to is not set, the step will simply trigger the child applications and then report success or failure. If this step is not set with an output_to value, you can manually enable waiting for child_failure with the wait_for_child_completion parameter. For more information, see Creating an Application that Uses a Trigger Application Operator.
To view the code for a step, select a SyncPack from the SyncPacks page, click the tab, and select the step you want to view.
Flow Control SyncPack
The "Flow Control" SyncPack contains just one item: the "IfStep" step that enables the logical branching used by the PowerFlow builder. The most recent version of this SyncPack is version 1.0.1, and it is included in the PowerFlow Platform release.
System Utils SyncPack
The "System Utils" SyncPack is a Standard SyncPack that contains applications, a configuration object, and steps. Version 1.1.5 of this SyncPack is included with PowerFlow version 2.6.0.
You must install the "Base Steps" SyncPack before you can install this SyncPack. For the latest release notes with a list of System Requirements, see SL1 PowerFlow Synchronization PowerPack Release Notes.
You can download newer versions of this SyncPack (when available) from the PowerPacks page of the ScienceLogic Support Site.
Contents of the SyncPack
Click to view the contents
The latest "System Utils" SyncPack includes the following PowerFlow applications:
-
Collect PowerFlow OTEL Metrics. Collects basic PowerFlow OpenTelemetry content metrics, including:
- The number of applications, steps, configuration objects, and Synchronization PowerPacks on the system.
- The number of applications run during the past day.
- Data about all of the content in the current PowerFlow system, including names and versions of all steps, configuration objects, and Synchronization PowerPacks.
- Platform services versions.
You can use this application to send the collected metrics and PowerFlow content to a metrics server in JSON format. You can also use this application to send those metrics to a OTEL collector using a OTEL GRPC endpoint, which is configurable as an application variable. These features are disabled by default.
-
Integration Service Backup. Creates a backup file of the Couchbase database used by PowerFlow and sends the file to a remote location.
-
Integration Service Restore. Restores a Couchbase backup file that was created up with the "Integration Service Backup" application.
-
PowerFlow Check Connections. Gathers system connectivity health data from third-party applications, and that data is used by the Workflow Health and Interconnectivity widget on the Control Tower page (
). You can edit the number of days of data to query by editing the Configuration pane for this application. When a step path is not configured correctly because a step, application, or SyncPack does not exist in the PowerFlow system, the "PowerFlow Check Connections" application will ignore that path and keep checking all the step paths that were configured.
-
PowerFlow Control Tower HealthCheck. Queries PowerFlow, gathers health data about the system, and displays the data in the PowerFlow System Health widget on the PowerFlow Control Tower page.
-
PowerFlow PFCTL HealthCheck. Uses the powerflowcontrol (pfctl) utility to gather HealthCheck data, and then the application saves that data into a health cache document.
-
PowerFlow System Diagnostics. Displays a report of platform diagnostics for the services used by PowerFlow.
-
Read SL1 RBA Queue and Retry PowerFlow Applications. Pulls and retries any failed Run Book Actions that failed because PowerFlow was not available. Requires Base Steps SyncPack version 1.3.2 or later.
-
Run PowerFlow Application and Remove It from SL1 RBA Queue. Runs the PowerFlow application and removes it from the Run Book Action queue. This application is triggered by the "Read SL1 RBA Queue and Retry PowerFlow Applications" and does not need to be configured.
-
Timed Removal. Removes logs from Couchbase on a regular schedule.
Click the down arrow icon () next to the application name to view the steps and workflow for that application. Click the application name to go to the Application detail page.
This SyncPack includes the following configuration objects:
- IS - System Backup Configuration Example. Contains the structure needed for the "Integration Service Backup" and "Integration Service Restore" PowerFlow applications.
- PF - System Diagnostic Configuration Example. Contains the structure needed for the "PowerFlow System Diagnostics" application.
- PF Check Connection Configuration Example. Contains the structure needed for the "PowerFlow Check Connnection" application.
- PF Control Tower Configuration Example. Contains the structure needed for the "PowerFlow Control Tower HealthCheck" application.
- PF PFCTL Healthcheck Configuration Example. Contains the structure needed for the "PowerFlow PFCTL HealthCheck " application.
- PF - RBA retry Configuration Example. Contains the structure needed for run book action retries. Includes variables for the SL1 system from which the data will be read, the number of rows to be read from the SL1 run book action queue in every run, and the generate_report variable to create a report about triggered PowerFlow applications.
You should do a Save As with the example configuration objects, above, to make a new configuration object that you can customize for your specific PowerFlow system. You cannot use an example configuration object to run PowerFlow applications.
This SyncPack also includes the following steps, which are used in the PowerFlow applications listed above:
- Collect IS diagnostics
- CollectPFOtelMetrics
- Create Integration Service Backup
- Diagnostic reporter
- Get Couchbase Metrics
- PowerFlow Check Connection
- PowerFlow Failover Actions Reporter
- PowerFlow PFCTL HealthCheck
- PowerFlow PFCTL Credentials to run PFCTL healthcheck app
- Process PowerFlow System Health Status Data
- Pull And Process Failover Actions from SL1
- Query an IS Node
- Query Application Logs and Remove
- Query IS Manager node
- Remove Dex Sessions and their tokens
- Restore Couchbase From Backup
- Set Template Data for the next step
To view the code for a step, select a SyncPack from the SyncPacks page, click the tab, and select the step you want to view.