Skip to end of metadata
Go to start of metadata

Availability

This routine is available starting with SIL Engine™ 2.5.8.

Syntax

admUpdateProject(pkey, pname, description, lead, url, categoryName, defaultIsUnassigned, avatarId)

Starting with version 4.0.11

admCreateProject(pkey, pname, description, lead, url, categoryName, defaultIsUnassigned, avatarId, projectTypeKey)


Description

Updates the project properties.

The project key cannot be changed, it's the only thing that identifies the project.

Parameters

Parameter name

Type

Required

Description

 pkeystringyesProject key. Must exist.
pnamestringyesProject name.
descriptionstringyesProject description.
leadstringyesRepresents a valid user that should be assignable on the project.
urlstringyesURL of the project. Leave blank if no URL is available.
categoryNamestringyesName of the category.
defaultIsUnassignedbooleanyesSet it to 'true' if you don't want to assign issues to the project lead above.
avatarIdnumericyesSet it to a negative number or zero for the default avatar id. Otherwise, you need to choose a valid avatar id.
projectTypeKeystringnoSet the project type key.

Return type

boolean

Returns 'true' if the project was updated and 'false' if not.

Example

Example 1

admUpdateProject("T3", "Thunderbolt3", "Three thunderbolts in a single hole", "zeus", "http://thunderbolts.olimpus.gr", "PUBLIC", false, 12010);

Example 2

admUpdateProject("T3", "Thunderbolt3", "Three thunderbolts in a single hole", "zeus", "http://thunderbolts.olimpus.gr", "PUBLIC", false, 12010, "software");

You will need permissions to update the project.

See also