Baseline functionality

It is a collection of node versions (snapshot of whole tree or a dedicated set of its branches) that are locked by an assigned tag (name).

baseline_list_types

returns list of all possible types of baselines could be registered in the pbs

QUERY_FUNCTION baseline_list_types: LIST OF STRING


baseline_create

registers new baseline in current state of pbs according to specified input
To call the query logged in user shall be associated with a person granted with administrative privileges over whole pbs (ADMIN_TYPE for the person or group where the person is registered)

QUERY_FUNCTION baseline_create(subject: v_baseline): v_baseline

Parameters:
subject input parameters of newly created baseline, see v_baseline
The following attributes of input structure are ignored
  • subject.item.instance_id
  • subject.item.introduced (replaced with time stamp)
  • subject.item.created (the baseline is associated with logged in user)
  • subject.exported_to

Returns actual attributes of the newly created baseline (see v_baseline)


baseline_get

gets baseline representation specified by its instance ID
To call the query logged in user shall be associated with a person granted with reader privileges over whole pbs (READER_TYPE, EDITOR_TYPE, ADMIN_TYPE for the person or group where the person is registered).

QUERY_FUNCTION baseline_get(id: INTEGER): v_baseline

Parameters:
id instance db ID of the baseline instance

Returns actual data of the required baseline (see v_baseline)


baseline_list

lists data of all registered in target model baselines.
To call the query logged in user shall be associated with a person granted with reader privileges over whole pbs (READER_TYPE, EDITOR_TYPE, ADMIN_TYPE for the person or group where the person is registered).

QUERY_FUNCTION baseline_list: LIST OF v_baseline

Returns list of baselines registered in target model (see v_baseline)


baseline_update

updates data of baseline registered before. The baseline is specified by db ID of the instance.
To call the query logged in user shall be associated with a person granted with administrative privileges over whole pbs (ADMIN_TYPE for the person or group where the person is registered).

QUERY_FUNCTION baseline_update(subject: v_baseline): v_baseline

Parameters:
subject updated data to be stored in model (see v_baseline). Target instance specified by subject.item.instance_id.
The following attributes are ignored:
  • subject.item.introduced
  • subject.item.creator

Returns actual data of the updated baseline (see v_baseline)


baseline_cancel

cancels the specified by instance db ID baseline registration in the pbs. The baseline is defined as cancelled and could not be used any more in references after that. The instance of the baseline is removed only if it was not used in any relationships.
To call the query logged in user shall be associated with a person granted with administrative privileges over whole pbs (ADMIN_TYPE for the person or group where the person is registered).

QUERY_FUNCTION baseline_cancel(id: INTEGER): BOOLEAN

Parameters:
id instance db ID of the baseline instance

Returns TRUE if the instance deleted (was not used), FALSE if just cancelled


baseline_extract

extracts nodes that collected in specified baseline in whole depth from target model with or without its history to an external data model.

QUERY_FUNCTION baseline_extract(
      id             : INTEGER;
      with_history   : BOOLEAN;
      user_comment,
      target_model,
      PDI_file       : STRING):  STRING
Parameters:
id interesting for extraction baseline instance id
with_history TRUE to include into extraction all prev. versions
target_model (optional), qualified name of the target model in form "rep_name.mod_name", if unset or empty model is named by system_get_config('EXPORT', 'REPOSITORY') + '.' + system_get_config('EXPORT', 'MM_PREFIX') + system_get_config('COUNTERS', 'MM_MODEL')
PDI_file name of file to store PDI info

Returns qualified name of the target model

See also pbs_extract

baseline_extract_ext

extracts nodes that collected in specified baseline in whole depth from target model with or without its history to an external data model with extended output

QUERY_FUNCTION baseline_extract(
      id             : INTEGER;
      with_history   : BOOLEAN;
      user_comment,
      target_model,
      PDI_file       : STRING):  extract_result
Parameters:
id interesting for extraction baseline instance id
with_history TRUE to include into extraction all prev. versions
target_model (optional), qualified name of the target model in form "rep_name.mod_name", if unset or empty model is named by system_get_config('EXPORT', 'REPOSITORY') + '.' + system_get_config('EXPORT', 'MM_PREFIX') + system_get_config('COUNTERS', 'MM_MODEL')
PDI_file name of file to store PDI info

Returns structure extract_result with the following attributes:

see also pbs_extract_ext
Back to Home page