Modifying Custom Code Blocks

To give you more flexibility in your implementation of Hyperscience, we introduced Custom Code Blocks available in custom flows. These blocks allow you to specify business rules for your submissions to transform, add, and validate data before it reaches your downstream systems. When used in tandem with other blocks, such as Routing, Database, and API Blocks, Custom Code Blocks maximize the potential benefits of Hyperscience at your organization.

For more information about potential uses of Custom Code Blocks, see the "Custom Code Blocks" section of Flow Blocks.

If you want to add a Custom Code Block to your flow, reach out to your Hyperscience representative for assistance. After the block has been added, you will be able to change the block's display name and description in Flow Studio. You will also be able to modify the code.

Modifying code

To give you more control over your flows, we're introducing some basic code-editing capabilities, which we will build upon in future versions of Hyperscience.

With guidance from Hyperscience, you can modify code and import it to your Custom Code Block. All custom code must be written in Python. If you are not comfortable making changes to your code, you can ask your Hyperscience representative to make the changes for you. 

Whenever you make changes to your custom code, do so in a non-production environment first (e.g., development, UAT). After you've confirmed that the code works as intended, you can import the new code to your Custom Code Block in production.

Modifying a block's code for the first time

1. Reach out to your Hyperscience representative to let them know that you would like to make changes to your custom code. They will provide you with the original code and provide instructions.

2. Make a copy of this file and leave it unedited as a backup.

3. With the guidance of your Hyperscience representative, make the necessary changes to the Python file they sent you, and save the file.

4. In your non-production environment, duplicate the flow that contains the Custom Code Block you want to change. To learn how, see Managing Flows.

5. On the Flows page, click on the duplicated flow, and then click on the Custom Code Block.

6. In the right-hand sidebar, click Import File.

7. Drag and drop the edited file in the box provided, or click Choose File to find and open the file on your machine.

8. Click Import.

9. Thoroughly test your new code. Your Hyperscience representative will provide guidance in this area.

10. If your code works as intended, import the new file to your production environment's Custom Code Block, just as you did in your non-production environment.

11. If your code doesn't work as intended:

    1. Modify the code and save your changes. 

    2. In your flow, click on the Custom Code Block, and then click on its menu in the right-hand sidebar (  ).

    3. Click Import a New Version, and import your updated file.

    4. Repeat the testing.

    5. Continue modifying, reimporting, and testing your code until it works as intended.

Modifying imported code

If you’ve imported custom code, you can download the imported file and import a new version of the file. You will use both of these features when modifying imported code.

1. Reach out to your Hyperscience representative to let them know that you would like to make changes to your custom code. They will provide instructions for the edits.

2. In your non-production environment, duplicate the flow that contains the Custom Code Block you want to change.

3. On the Flows page, click on the duplicated flow, and then click on the Custom Code Block.

4. Click on the menu in the right-hand sidebar (  ), and then click Download File.

5. Make a copy of this file and leave it unedited as a backup.

6. With the guidance of your Hyperscience representative, make the necessary changes to the downloaded file, and save your changes.

7. Click on the menu in the right-hand sidebar, and then click Import a New Version.

8. Drag and drop the edited file in the box provided, or click Choose File to find and open the file on your machine.

9. Click Import.

10. Thoroughly test your new code. Your Hyperscience representative will provide guidance in this area.

11. If your code works as intended, import the new file to your production environment's Custom Code Block, just as you did in your non-production environment.

12. If your code doesn't work as intended:

    1. Modify the code and save your changes. 

    2. In your flow, click on the Custom Code Block, and then click on its menu in the right-hand side bar.

    3. Click Import a New Version, and import your updated file.

    4. Repeat the testing.

    5. Continue modifying, reimporting, and testing your code until it works as intended.