User guide
Prerequisites
This integration needs any Tempo app pre-installed. While certain routines are very general, other ones target a Tempo plugin specifically, for example, the allocations routines are available only if a Planner plugin is installed.
Routines
- tempoDeleteAllocationForUser — This routine deletes the allocation for a given user between specified dates, optionally filtering for a given issue.
- tempoAddAllocation — Routine adds a new Tempo Planner allocation.
- tempoClearIssueTeam — Removes any value the team may be set on that issue. Returns true if the issue was cleared, false if not.
- tempoAddIssueToTeam — Allocates the issue to the specified team.
- tempoAddAllocationForUser — Routine adds another allocation for the user on the specified issue. Reviewer is optional. Allocation time is leveled to accommodate the existing allocation of the user.
- tempoGetAccount — Returns the account with the specified id, key, or name.
- tempoGetAccountForIssue — Returns the account set on the issue, if any.
- tempoGetAllocations — Routine returns the allocations that might exists for a user between the specified dates, optionally filtered by projects or even for individual issues
- tempoGetCustomerAccounts — Returns the customer accounts, optionally filtered by the status.
- tempoGetGlobalAccounts — Returns all the global accounts you might have defined in Tempo.
- tempoGetIssueTeam — Returns the team responsible for a given issue.
- tempoGetTeam — Returns the team either by id (stringified), name or key of the team.
- tempoGetTeamUsers — Returns an array of the current active members of a team (user keys).
- tempoGetWorklogAttribute — Returns the value of the worklog attribute, as a string.
- tempoIsUserInTeam — Returns true if the user belongs to the active base of the team at the time of the call.
- tempoSetAccountForIssue — Sets the issue account. Returns true if the set has been performed.
- tempoSetWorklogAttribute — Sets the value of the work log attribute, as a string. Such work log should exist, as well as the TEMPO attribute on it.
Types
Here is a list of predefined structures that are used throughout SIL™, usually with specific routines. Not enough for you? You can also define custom structures. Check our example in the Syntax section and roll your own.
Note that the structure fields can be modified, but the changes are not saved in the database. If you change a field for a project version variable, the project version will not be affected. Simply put, the structures are 'detached'.
Name | Field | Type | Notes |
|---|---|---|---|
id | integer | ||
key | string | ||
name | string | ||
lead | string | User (lead) | |
contact | string | Any contact for the customer set into the account | |
status | string | One of: OPEN, CLOSED, ARCHIVED | |
customer_id | integer | ||
customer_key | string | ||
customer_name | string | ||
category_id | integer | ||
category_key | string | ||
category_name | string | ||
monthly_budget | number | ||
global | boolean | ||
billable | boolean | ||
id | integer | ||
parentId | integer | Allocations are hierachical | |
scopeId | integer | ||
scopeType | string | list of values: "account", "board", "project", "team", "folio", "none" | |
planItemId | integer | ||
planItemType | string | list of values: "component", "epic", "issue", "project", "sprint", "version" | |
assignee | string | ||
assigneeType | string | list of values: "team", "user" | |
commitment | number | ||
description | string | ||
workPerDay | number | number of hours | |
includeNonWorkingDays | boolean | ||
startDate | date | ||
endDate | date | ||
createdBy | string | User who created it | |
created | date | ||
updatedBy | string | ||
updated | date | ||
recurring | boolean | ||
recurrenceRule | string | list of values: "NEVER", "WEEKLY", "BI-WEEKLY", "MONTHLY" | |
recurrenceEnds | date | ||
planApprovalId | number | ||
planApprovalReviewer | string | ||
id | integer | ||
name | string | ||
mission | string | ||
summary | string | ||
lead | string | User (lead) | |
program_id | integer | ||
program_name | string | ||
program_manager | string | User, the Program Manager for the team |