Persefoni: Fetch Transactions Template

Introduction

This guide provides instructions for successfully implementing the Persefoni Fetch Transactions Chain Template. It covers the key items that will be required to successfully implement, including importing Wdata objects, enabling the Chain template, connecting objects, and testing the process. Following this guide will help ensure a smooth and efficient implementation process.

Prerequisites

Chains

• The following connectors must be enabled and configured in your workspace:
  • Persefoni
  • JSON
  • File Utilities
  • Tabular Transformation
  • Handlebars
  • Workiva
• The following Workspace variables must be created within your workspace:
  • wsv_ResourceGroupId
  • wsv_LanguageId
  • wsv_WdataLoadWarningThreshold

Tables and Queries

• The following file will need to be downloaded locally for import later in the process:
  • Persefoni_Date_Model.cb 

Note: There are packages or files that need to be imported/enabled to complete the setup.

Deploy the Chain

The Persefoni | Fetch Transactions Chain Template is located in the Workiva Chains section of the Templates screen.

Here's how to find it:

1. In Chain Builder, go to the Templates tab
2. Select Workiva Chains from the menu at the top
3. Search for Persefoni | Fetch Transactions Chain Template at the top right and open the template

After locating your template, configure it for your workspace using the variables and runtime inputs listed below.

Note: For detailed instructions on creating a chain from a template, see the Create and manage chains article.

Variables

Build your Data Model

The data model is included in the support article as a Wdata file (.cb file), ensure this has been downloaded locally before continuing with this step.

Here’s how to import the Wdata File:

1. Go to Wdata Home.
2. At the top left, click Create > Import > Import Workiva File.
3. Click Browse to open your computer's file viewer and select the .cb file downloaded.
4. Choose an upload location in your workspace, add a prefix if desired, and click Import to finish.

Note: For detailed instructions on importing a Wdata object, see the Import of Export Wdata Objects Between Workspaces article

The contents of the .cb file include:

Setting up the Template

Once the Prerequisites and Importing Resources steps have been completed, the sample data will need to be imported, and the Chains and Wdata objects will need to be connected.

Here’s how to import the sample data for each of the tables:

1. Go to Wdata Home
2. Select the Table data will be imported into
3. At the top right corner of the table, click on “Add Dataset” dropdown > Select Add File > Click Upload File 
4. Click Browse > Select the equivalent Persefoni Data file for the Table
5. Click Add Data

Note: For detailed instructions on importing a file into a table, see the Manage Table Datasets article

Associating Tables

To effectively run the chain process as well as to start seeing results, the associated Persefoni will need to align with their respective variables within Chains.

Here’s how to input the Table Ids to their respective Chain Variables in the “Persefoni | Fetch Transactions" Chain

1. Navigate to your enabled “Persefoni | Fetch Transactions Chain” chain.

2. Click on Chain Settings.
3. Update the respective Table Ids for the Persefoni Transactions data
4. Make sure to align each with the appropriate Table that was imported from the .cb file.

Importing & Connecting

After the table data has been imported and the table ids have been input into the chain variables, the Persefoni - Workiva Template can be validated.

Here’s how to test the validity of your template setup:

1. Navigate to the “Persefoni | Fetch Transactions Chain”, click on the vertical ellipsis and select “Execute”
2. Click “Run with Inputs”
3. From the Input selection select all the Transaction Types to run the validity test for (Emissions, Activity, Facilities) and click start
   

4. Review the chain execution, once it has completed and a successful status is displayed, navigate to the corresponding tables selected for the run.
5. Navigate to one of the queries that the table is utilized in within Wdata.
6. Run the Query with associate parameters
7. Verify the dataset
8. After validating the data, connect the queries to the respective spreadsheets for implementation. To connect a query to a spreadsheet, follow these steps