Base Steps SyncPack Release Notes, version 1.5.0

Version 1.5.0 of the "Base Steps" SyncPack includes support for sending multiple payloads using the new "PostREST" and "GetREST" steps. This release also includes a new "DeleteREST" step and a new "PutREST" step.

This version of the "Base Steps" SyncPack requires version 2.2.1 or later of the PowerFlow Platform.

Features Included in this Release

The following features were included in this release of the "Base Steps" SyncPack:

Created the "PutREST" step to facilitate PUT interactions. This step returns the returned data dictionary and specified headers as data to the next step.

Created a utility, HTTPBaseStep.py, and extended steps for POST, PUT, GET and DELETE: "PostREST", "PutREST", "GetREST", and "DeleteREST", respectively. Starting with this release of the "Base Steps" SyncPack, the "QueryREST" has been deprecated. You can continue to use this step, but the step will be removed from future versions of this SyncPack. In addition to the existing "QueryREST" functionality, these new steps include the following parameters:

auth_method. Select an authentication method: http_basic (default), OAuth, or no_auth.
pickle_output. Enable this option if you want to pickle the output of the step.
verify_ssl. Enable this option if you want the SSL certificate to be checked.
api_parameters. You can add API parameters in this text box, so instead of having to set the URL, such as https://test.url/file_systems?region=unique_id, you can set the URL to https://test.url/file systems and set the api_parameters parameter to {"region": "unique_id"} in the step's configuration.

The payload_from_input and url_from_input options for this step should be enabled only when the payload or the URL is retrieved from a previous step.
Updated the "HTTPBaseStep" object to allow for a list of dictionaries containing payloads or payloads and relative URLs to be posted using the same session for the new extended REST steps. If you have retry enable and the step encounters an error, the when the step is retried, the application starts from the first failed payload instead of executing previously successful REST calls again. This step also includes a new multiple_request_payloads parameter to indicate that the payload or previous step data contains sub-payloads.

The following code snippet shows a sample input payload:
```
[
    {
        "payload": {"c-foo": "bar"},

        "relative_url": "/api/device/1",
    },
    {
        "payload": {"c-foo": "bar"},
        "relative_url": "/api/device/2",
    },
]
```

To view release notes and manuals for all versions of the SL1 PowerFlow Platform, see SL1 PowerFlow Platform Documentation. To view release notes and manuals for PowerFlow SyncPacks, see SL1 PowerFlow SyncPack Documentation.

Known Issues

This version of the SyncPack had the following known issue:

PowerFlow applications that use SSH keys do not support the use of SSH keys that are generated on a FIPS-enabled system.

Prerequisites for the SyncPack

To install this SyncPack, you must have ScienceLogic administrator access to the Administration Portal.

This version of the "Base Steps" SyncPackrequires version 2.2.1 or later of the PowerFlow Platform.

ScienceLogic highly recommends that you disable all firewall session-limiting policies. Firewalls will drop HTTPS requests, which results in data loss.

Installing the SyncPack

A SyncPack file has the .whl file extension type. You can download the SyncPack file from the ScienceLogic Support site.

To locate and download the SyncPack:

Go to the ScienceLogic Support site at https://support.sciencelogic.com/s/.
Click the Product Downloads tab and select PowerPacks.
In the Search PowerPacks field, search for this SyncPack and select it from the search results. The Release Version page appears.
On the Files tab, click the down arrow next to the SyncPack version that you want to install, and select Show File Details. The Release File Details page appears.
Click the Download File button to download the .zip file containing the SyncPack.

After you download a SyncPack, you can import it to the PowerFlow platform using the PowerFlow user interface.

To import a SyncPack in the PowerFlow user interface:

On the SyncPacks page, click Import SyncPack. The Import SyncPack page appears.
Click Browse 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 Import. PowerFlow registers and uploads the SyncPack. The SyncPack is added to the SyncPacks page.

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.

To activate and install a SyncPack in the PowerFlow user interface:

On the SyncPacks page, click the Actions 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 Yes 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" PowerFlow 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 Actions button () for that SyncPack and select Change active version to activate a different version other than the version that is currently running.