The "Transformer Rules" page allows for users to upload their transformers into the account before importing their data into Beckon.
To get to the "Transformer Rules" page from the navigation bar, go to "Connect" > "Load" > "Transformer Rules" as shown in the screenshot:
You will then see a "Transformer Rules (Live)" page:
1 "Download Beckon Rules and Scripts": Provides users with a zip file of all available shared rules and scripts that can be used in their custom transformer
2 "Download Transformer Documentation": Provides users with a pdf documentation of basic transformer rules. This button will be deprecated in the future.
3 "Upload Rules": Allows users to upload their custom transformers
4 List of transformers and scripts: Transformers and scripts that are currently used by an account will be listed here
5 More options: Provides users with more columns that are hidden by default
Learn more about the function of each shared rules and scripts
What can you upload?
The following types of documents are allowed to be uploaded on this page:
- JSON (Account level transformers, transformers)
- Comma delimited files (.txt or .csv - used for mappings)
- Scripts (Python, Groovy or Ruby)
To replace a transformer with an updated version in the app, upload the updated transformer with the same file name.
Beckon currently does not support versioning of transformers. Replacing the transformer by uploading a transformer of the same name means that you will no longer be able to retrieve prior versions of the transformer.
It is recommended for users to keep track of changes and transformer versions with GitHub or any other equivalent software.
Identifying Different Transformers
There will be instances where a transformer with the same name is uploaded but instead of replacing the transformer, it shows as a separate row in the page. In the following example, there are two instances for "beckon_lunches.json".
This is caused by the transformer being uploaded via two different methods. To identify where the transformers were uploaded from, click on the gear icon for more options and select "Uploaded From":
A new column "Uploaded From" will now be available on the far right side of the list:
Transformers uploaded from [B] refers to a transformer / script that was uploaded by a Beckon internal user, or your Beckon Customer Success implementation team.
Transformers uploaded from App refers to a transformer / script that was uploaded by a user through the "Transformer Rules" page.
Only transformers that are uploaded from App can be deleted from the "Transformer Rules" page. For modifications to transformers uploaded by [B], please contact your Customer Success team.
When two transformers of the same names are available as shown in the example above, the one that was uploaded from App will take precedence in Beckon.
Always remember that transformers uploaded here will affect the account's data ingestion effective immediately. It is always recommended to test your transformers before uploading on production. To learn more about testing transformers, read on how to use the "Transformer Sandbox" feature in Beckon.