admAddProjectComponent

Availability

This routine is available starting with katl-commons 2.5.8 / 4.0.16

Syntax

admAddProjectComponent(pkey, compname, compdesc, complead, defaultIsUnassigned)

Starting with version 4.0.16

admAddProjectComponent(pkey, compname, compdesc, complead, defassignee)

Description

Adds a component in the project.

Parameters

Parameter name

Type

Required

Description

pkeystringyesProject key.
compnamestringyesComponent name.
compdescstringyesDescription.
compleadstringyesComponent lead user key.

defaultIsUnassigned/

defassignee (since 4.0.16)

boolean/

number

yes/

yes

If 'true', the default is unassigned. If 'false', if lead has a non-null value, it is assigned to the component lead by default, otherwise to the default project./

Possible values and their respective effects: 0 - project default; 1 - component lead; 2 - project lead; any other value - unassigned.

Return type

boolean

Returns 'true' if the component was added and 'false' otherwise.


See also