see

Dedication report

Go application to retrieve donations in a timeframe and output them as a CSV.

The user provides an Engage token and a date range. See the Usage section for more information.

Prerequisites

1. A current version of Go. There are lots of articles on the web about installing Go. The official installation steps can be found by clicking here.
2. An Engage API token.

Installation

This package is part of the GoEngage package on Github. Use these steps to install goengage.

go get github.com/salsalabs/goengage
go install github.com/salsalabs/goengage

The source for this package can be found in the cmd/activity/fundraise/see directory in goengage.

Operation

The easiest way to run this app is to start in a console window.

cd ~/go/src/github/salsalabs.com/goengage
go run cmd/activity/fundraise/see/main.go --help

Use --help shows the usage summary.

usage: see --login=LOGIN [<flags>]

Write donations to a CSV

Flags:
  --help                         Show context-sensitive help (also try --help-long and --help-man).
  --login=LOGIN                  YAML file with API token
  --startDate="2020-12-14"       Start date, YYYY-MM-YY, default is Monday of last week at midnight
  --endDate="2020-12-20"         End date, YYYY-MM-YY, default is the most recent Monday at midnight
  --timezone="America/New_York"  Client's timezone, defaults to EST/EDT
  --donationType="All"           Choose All, One_Time or Recurring

Command-line arguments

YAML file

This application needs an API token. Tokens are are really long and typically hard to remember. This application stores that problem by expecting a YAML file containing the API token. Here's an example.

token: 82874335-aedd-4f9e-918d-8ad78088a811

If you've stored your token in company.yaml, then you'll need to use a command like this to start the deduplication report.

go run cmd/activity/fundraise/see/main.go --login company.yaml

Outputs

Console

The application logs all status to the console. Errors are really obvious. Here's a sample of the console output for a successful application run.

2020/12/30 09:58:33 WaitForReaders: Waiting for 5 readers
2020/12/30 09:58:33 ReadActivities-1: begin
2020/12/30 09:58:33 ReadActivities-0: begin
2020/12/30 09:58:33 ReadActivities-2: begin
2020/12/30 09:58:33 ReadActivities-3: begin
2020/12/30 09:58:33 WriteCSV: begin
2020/12/30 09:58:33 ReadActivities-4: begin
2020/12/30 09:58:33 ReportFundraising: processing 366 FUNDRAISE records
2020/12/30 09:58:33 ReportFundraising: waiting for terminations
2020/12/30 09:58:37 ReadActivities-2: offset     40 of    366,   6 adds
2020/12/30 09:58:39 ReadActivities-3: offset     60 of    366,   5 adds
2020/12/30 09:58:40 ReadActivities-4: offset     80 of    366,  13 adds
2020/12/30 09:58:42 ReadActivities-4: offset    140 of    366,   9 adds
2020/12/30 09:58:44 ReadActivities-3: offset    120 of    366,  11 adds
2020/12/30 09:58:46 ReadActivities-2: offset    100 of    366,  11 adds
2020/12/30 09:58:46 ReadActivities-3: offset    180 of    366,   8 adds
2020/12/30 09:58:48 ReadActivities-2: offset    200 of    366,   7 adds
2020/12/30 09:58:51 ReadActivities-0: offset     20 of    366,  10 adds
2020/12/30 09:58:51 ReadActivities-4: offset    160 of    366,  16 adds
2020/12/30 09:58:52 ReadActivities-3: offset    220 of    366,  17 adds
2020/12/30 09:58:55 ReadActivities-4: offset    280 of    366,   8 adds
2020/12/30 09:58:55 ReadActivities-3: offset    300 of    366,  11 adds
2020/12/30 09:58:58 ReadActivities-3: offset    340 of    366,   9 adds
2020/12/30 09:58:58 ReadActivities-4: offset    320 of    366,   8 adds
2020/12/30 09:58:58 ReadActivities-3: offset    360 of    366,   2 adds
2020/12/30 09:58:58 ReadActivities-3: end
2020/12/30 09:58:58 WaitForReaders: Waiting for 4 readers
2020/12/30 09:58:59 ReadActivities-4: end
2020/12/30 09:58:59 WaitForReaders: Waiting for 3 readers
2020/12/30 09:59:01 ReadActivities-1: offset      0 of    366,   9 adds
2020/12/30 09:59:01 ReadActivities-1: end
2020/12/30 09:59:01 WaitForReaders: Waiting for 2 readers
2020/12/30 09:59:02 ReadActivities-0: offset    260 of    366,  12 adds
2020/12/30 09:59:02 ReadActivities-0: end
2020/12/30 09:59:02 WaitForReaders: Waiting for 1 readers
2020/12/30 09:59:03 ReadActivities-2: offset    240 of    366,  10 adds
2020/12/30 09:59:03 ReadActivities-2: end
2020/12/30 09:59:03 WaitForReaders: done
2020/12/30 09:59:03 WriteCSV: done
2020/12/30 09:59:03 ReportFundraising done

CSV output

Donations with see are stored in see.csv in the current directory. Here's a sample.

PersonName,PersonEmail,AddressLine1,AddressLine2,City,State,Zip,TransactionDate,Amount,DedicationType,Dedication,Notify,DedicationAddress
John Cheeseburger,john@cheeseburger.com.com,,,,,,2020-12-19 21:08:03.533 +0000 UTC,51.69,IN_HONOR_OF,The Cheeseburger Family,Uncle Dan,404 Redbug, Baton Rouge, LA,12345
Anne Souvlaki,anne@Souvlaki.com,,,,,,2020-12-15 17:41:28.178 +0000 UTC,1912.50,IN_HONOR_OF,Our wonderful Souvlaki family,,Aunt Mary,404 Tatziki, Jolie Blanc, LA,12345

Advanced usage

If you'll be using this app a lot, then it will be a good idea to create a native program.

go build -o ~/go/bin/fundraise_see cmd/activity/fundraise/see/main.go

The output will be an executable in ~/go/bin in your home directory. Add ~/go/bin to the PATH list that your OS uses and you'll be able to invoke the program with a command like this.

fundraise_see --login company.yaml

Questions? Comments?

Use the GitHub issues page to report problems, ask questions or make comments. Please don't bother the nice folks at Salsalabs. This is their nesting season and they will bite intruders.