This is in grouper_v2_4_0_api_patch_81 and newer.
Generate CSV file to be SFTP'ed to a server. These are scheduled by quartz cron.
Configure
grouper.properties
#####################################################
## CSV reports
## "reportId" is the key of the config, change that for your csv report
#####################################################
# set this to enable the instrumentation
# {valueType: "class", mustExtendClass: "edu.internet2.middleware.grouper.app.loader.OtherJobBase"}
otherJob.reportId.class = edu.internet2.middleware.grouper.app.reports.GrouperCsvReportJob
# cron string
# {valueType: "string"}
otherJob.reportId.quartzCron = 0 21 7 * * ?
# query to run
# {valueType: "string", regex: "^otherJob\\.([^.]+)\\.csvReport\\.query$"}
otherJob.reportId.csvReport.query = select USER_ID, USER_NAME, EMAIL_ADDRESS, AUTH_TYPE, TITLE, DEPARTMENT, CUSTOM_STRING, DAY_PASS, CUSTOM_STRING2, GROUPS from some_view
# database to hit
# {valueType: "string", regex: "^otherJob\\.([^.]+)\\.csvReport\\.database$"}
otherJob.reportId.csvReport.database = pennCommunity
# remove underscores and capitalize headers, go from USER_NAME to UserName
# {valueType: "string", regex: "^otherJob\\.([^.]+)\\.csvReport\\.removeUnderscoresAndCapitalizeHeaders$"}
otherJob.reportId.csvReport.removeUnderscoresAndCapitalizeHeaders = false
# fileName, e.g. myFile.csv or /opt/whatever/myFile.csv. If blank will create a name
# {valueType: "string", regex: "^otherJob\\.([^.]+)\\.csvReport\\.database$"}
otherJob.reportId.csvReport.fileName = MyFile.csv
# sftp config id (from grouper.properties) if sftp'ing this file somewhere, otherwise blank
# https://spaces.at.internet2.edu/display/Grouper/Grouper+Sftp+files
# {valueType: "string", regex: "^otherJob\\.([^.]+)\\.csvReport\\.sftp\\.configId$"}
otherJob.reportId.csvReport.sftp.configId = someSftpServer
# remote file to sftp to if sftp'ing
# {valueType: "string", regex: "^otherJob\\.([^.]+)\\.csvReport\\.sftp\\.fileNameRemote$"}
otherJob.reportId.csvReport.sftp.fileNameRemote = /data01/whatever/MyFile.csv
# if the file should be deleted from the grouper daemon server after sending it
# {valueType: "boolean", regex: "^otherJob\\.([^.]+)\\.csvReport\\.deleteFile$"}
# otherJob.reportId.csvReport.deleteFile = true
Logging
log4j.properties
log4j.logger.edu.internet2.middleware.grouper.app.reports.GrouperCsvReportJob = DEBUG
Sample log message
2019-11-23 21:18:20,119: [main] DEBUG GrouperCsvReportJob.run(140) - - job: csv, database: pennCommunity, query: select USER_ID, USER_NAME, EMAIL_ADDRESS, AUTH_TYPE, TITLE, DEPARTMENT, CUSTOM_STRING, DAY_PASS, CUSTOM_STRING2, GROUPS from some_view, columnsSize: 10, rowsSize: 39193, file: C:\Users\mchyzer\AppData\Local\Temp\PennUsers.csv, fileSizeBytes: 3450123, sftpConfigId: depot, fileNameRemote: /data01/dir/MyFile.csv, tookMillis: 219178
Using the API
You can make individual calls or use a callback to do multiple calls more efficiently
Individual calls
GrouperSftp.sendFile("depot", new File("d:/temp/temp/MyFile.csv"), "/data01/dir/MyFile.csv");
System.out.println(GrouperUtil.toStringForLog(GrouperSftp.listFiles("depot", "/data01/dir/")));
System.out.println(GrouperSftp.existsFile("depot", "/data01/dir/MyFile.csv"));
GrouperSftp.copyFile("depot", "/data01/dir/MyFile.csv", "/data01/dir/MyFile2.csv");
GrouperSftp.moveFile("depot", "/data01/dir/MyFile.csv", "/data01/dir/MyFile3.csv");
GrouperSftp.receiveFile("depot", "/data01/dir/MyFile3.csv", new File("d:/temp/temp/MyFile2.csv"));
GrouperSftp.deleteFile("depot", "/data01/dir/MyFile3.csv");
Multiple calls in callback
GrouperSftp.callback("depot", new GrouperSftpCallback() {
public Object callback(GrouperSftpSession grouperSftpSession) {
grouperSftpSession.sendFile(new File("d:/temp/temp/PennUsers.csv"), "/data01/dir/MyFile.csv");
grouperSftpSession.deleteFile("/data01/dir/whatever.csv");
return null;
}
});