{
// logger configuration fed directly into log4js: https://github.com/nomiddlename/log4js-node
"log4js": {
"appenders": {
"outAppender": {
"type": "stdout",
"layout": {
"type": "pattern",
"pattern": "%[[%d{ABSOLUTE}] [%-5p]%] %m"
}
}
},
"categories": {
"default": {
"appenders": ["outAppender"],
"level": "trace"
}
}
},
"options": {
// general application configuration
"minimumLoggableTimeSlotInMinutes": 30,
"timePeriod": {
"begin": {
// for absolute dates
"dateTime": "2017-01-02T05:00:00",
// for relative dates
"fromNow": "string", // "this", "last", "next"
"unit": "string", // "hour", "day", "week", "month"
// for other relative option, calculated from this current moment
"offset": "-24h" // (+|-) <number> <h|d|w|m>
},
"end": {
// for absolute dates
"dateTime": "2017-01-02T05:00:00",
// for relative dates
"fromNow": "string", // "this", "last"
"unit": "string", // "hour", "day", "week", "month"
// for other relative option, calculated from this current moment
"offset": "0" // 0 | (+|-) <number> <m|h|d|w|M>
}
},
// Optional, falls back to the current environment local timezone
"timeZone": "America/Toronto"
},
"inputs": [{
"type": "string",
"name": "string",
// optional: manage the input storage in this particular path
// if not passed, will use the current location
"storageRelativePath": "string",
// other properties specific to the input type
// Type: GoogleCalendarInput
"calendars": [{
"id": "string",
"includeTags": [
"tag1:value1",
"tag2:value2"
]
}],
// Type: HarvestApp
"accountId": "string",
"token": "string",
"contactInformation": "email@example.com",
}],
"worklogSetOperations": [{
"condition": {
"type": "string"
},
"type": "string",
// other properties specific to this worklog set operation
// (none yet)
}],
"transformations": [{
"condition": {
"type": "string",
// other properties specific to the condition type
// type: hasTag
"tagName": "string",
"tagValue": "string",
// type: summaryMatches
"regex": "string"
},
"action": {
"type": "string",
// other properties specific to the action type
// Type: addTags
"tagsToAdd": [
{ "name": "tag1", "value": "value1" },
{ "name": "tag2", "value": "value2" }
{ "name": "tag3", "extractCaptureFromSummary": "\\[([^\\[\\]]+)\\]" } // example regex: extract expression between square brackets
]
}
}],
"outputs": [{
"type": "string",
"name": "string",
// if true, will not consider this output for the warning of worklogs non processed by any output
"excludeFromNonProcessedWarning": true,
"condition": {
// (see above)
},
"formatter": {
"type": "string",
// other properties specific to the output type
// Type: SummaryTextFormatter
"aggregateByTags": [
// one sub-array for each aggregation/total to calculate
["tag1"],
// if multiple tags are in a sub-array, it will nest tag2 under tag1
["tag1", "tag2"],
],
// Type: SummaryHtmlFormatter
// same properties as SummaryTextFormatter
// can also have the configurations specified by showndown: https://github.com/showdownjs/showdown#valid-options
// Type: TableList
// no configurations available currently
// Type: FormatterAggregator
"formatters": [
// array of formatters to aggregate
// each object with same configuration as the formatter property of the outputs
]
},
// other properties specific to the output type
// Type: TextFile
"filePath": "string",
// Type: HarvestApp
"token": "string",
"accountId": "string",
"contactInformation": "string",
"selectProjectFromTag": "HarvestProject",
"selectTaskFromTag": "HarvestTask",
// Type: JiraWorklog
"JiraUrl": "https://myserver.atlassian.net",
"JiraUsername": "myUsername",
"JiraPassword": "myJiraPassword",
// Type: Logger
// (no configurations)
// Type: AWS-SES
"aws": {
"region": "us-east-1"
},
"fromEmailAddress": "exampleSender@example.com",
"toAddresses": ["email1@example.com", "email2@example.com"],
"subjectTemplate": "Info for {{startDateTime}} to {{endDateTime}}", // info from models/WorklogSet.js
"bodyTemplate": " {{{contents}}} ", // info from models/WorklogSet.js and "contents" for formatted WorklogSet
}]
}TODO: Formatters, conditions, output excludeFromNonProcessedWarning