Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

Engineering Change Management

Modules

Data Structures

Definitions required for CM installation

Used by install types program

Typedefs

Enumerations

Functions

Define Documentation

#define EC_Item_class_name_c   "Item"

Definition at line 29 of file ecm.h.

#define EC_Item_Type_c   "EngChange"

Definition at line 28 of file ecm.h.

#define EC_Rev_class_name_c   "ItemRevision"

Definition at line 31 of file ecm.h.

#define EC_Rev_Type_c   "EngChange Revision"

Definition at line 30 of file ecm.h.

#define ECM_COMPARE_DESCRIPTOR_NAME   "CMP_std_descriptor_ecm_compare"

Definition at line 39 of file ecm.h.

#define ECM_COMPARE_MODE_NAME   "ECM_compare_mode"

Definition at line 38 of file ecm.h.

#define ECMCHECKLISTTASK_TYPE_NAME   "ECMChecklistTask"

Definition at line 34 of file ecm.h.

#define ECMCHECKLISTTASKTEMPLATE_TYPE_NAME   "ECMChecklistTaskTemplate"

Definition at line 37 of file ecm.h.

#define ECMIMPACTANALYSISTASK_TYPE_NAME   "ECMImpactAnalysisTask"

Definition at line 32 of file ecm.h.

#define ECMIMPACTANALYSISTASKTEMPLATE_TYPE_NAME   "ECMImpactAnalysisTaskTemplate"

Definition at line 35 of file ecm.h.

#define ECMPREPAREECOTASK_TYPE_NAME   "ECMPrepareECOTask"

Definition at line 33 of file ecm.h.

#define ECMPREPAREECOTASKTEMPLATE_TYPE_NAME   "ECMPrepareECOTaskTemplate"

Definition at line 36 of file ecm.h.

Typedef Documentation

typedef enum ECM_bom_change_type_e ECM_bom_change_type_t

typedef struct ECM_note_change_info_s ECM_note_change_info_t

typedef struct ECM_variant_change_info_s ECM_variant_change_info_t

Enumeration Type Documentation

enum ECM_bom_change_type_e

Enumerator:
BOM_unknown 
BOM_Add 
BOM_Cancel 
BOM_Quantity_Change 
BOM_Move 
BOM_Reshape 
BOM_Note_Change  New Type for supporting Note Changes
BOM_Variant_Change  New Type for supporting Variant Changes
LBOM_Add  New Type for supporting LBOM Changes
LBOM_Cancel  New Type for supporting LBOM Changes
LBOM_Quantity_Change  New Type for supporting LBOM Changes

Definition at line 43 of file ecm.h.

Function Documentation

ECM_API int ECM_add_contents ( tag_t  ec_rev_tag,
const char *  folder_name,
int  num_of_obj,
tag_t *  obj_tags 
)

This function adds the given object list to the specified pseudo folder.

Parameters:
ec_rev_tag  (I) EC Revision tag
folder_name  (I) EC folder name
num_of_obj  (I) The number of workspace objects in the specified folder
obj_tags  (I) The array of workspace object tags

ECM_API int ECM_append_bomadd_list_of_sup ( tag_t  sup_tag,
tag_t  add_tag 
)

This function appends the specified BOM Add to the Add list of the given supercedure. You will need to lock the supercedure object before calling this method and save and unlock the supercedure afterwards.

Parameters:
sup_tag  (I) Supersedure tag
add_tag  (I) BOM Add tag

ECM_API int ECM_append_bomcancel_list_of_sup ( tag_t  sup_tag,
tag_t  cancel_tag 
)

This function appends the specified BOM Cancel to the Cancel list of the given supercedure. Need to lock the supercedure object before calling this method and save and unlock the supercedure afterwards.

Parameters:
sup_tag  (I) Supercedure tag
cancel_tag  (I) BOM Cancel tag

ECM_API int ECM_bomchange_get_childrens ( tag_t  bomch_tag,
int *  n_children,
tag_t **  child_tags 
)

This function returns all child objects for a given BomChange object. Child objects are either of type BomChange or of type Item. If a sub-assembly is added or removed from the affected assembly, derived BomChange objects of the same type are created up to the lowest level.

If no supercedure is created using the given BomChange object, all of its children will be of type BomChange. However, if a supercedure is created between the input BomChange and another BomChange of reverse type, the BomChange records for common sub-components are deleted. In that case Items of common occurrences are returned as Children of the given BomChange object.

Parameters:
bomch_tag  (I) Tag of Bomchange object
n_children  (O) Number of children
child_tags  (OF) n_children Array of children

ECM_API int ECM_bomchange_is_derived ( tag_t  bomch_tag,
logical *  is_derived 
)

This function returns true if the given BomChange object is a derived Change.

Parameters:
bomch_tag  (I) Tag of BomChange object
is_derived  (O) True if specified BomChange is a derived BomChange

ECM_API int ECM_create_ec_item ( const char *  ec_id,
const char *  ec_rev_id,
const char *  ec_name,
const char *  ec_desc,
tag_t *  ec_item_tag,
tag_t *  ec_rev_tag 
)

This function creates a new EC Item and EC Revision using the given EC ID, Revision ID, name and description. This method saves and unlocks newly created Items and Revisions. It is necessary to set the EC Type using ECM_set_ec_type.

Parameters:
ec_id  (I) EC Item ID
ec_rev_id  (I) EC Revision ID
ec_name  (I) EC Item name
ec_desc  (I) EC Item description
ec_item_tag  (O) Tag of the new EC Item
ec_rev_tag  (O) Tag of the new EC Revision

ECM_API int ECM_create_ec_snapshot ( tag_t  ec_rev,
char *  desc,
tag_t *  snapshot 
)

Creates a snapshot of EngChange Revision. Snapshot is a PLM XML format of the EngChange Revision. We create a file by exporting the EC Revision to PLM XML format and create a Dataset of type "ECSnapshot" to hold the XML file as a named reference. The Dataset will be attached to EC Revision with EC_snapshot_rel relation type.

Parameters:
ec_rev  (I) EngChange Revision Tag
desc  (I) Description
snapshot  (O) Dataset Tag

ECM_API int ECM_create_supercedure ( tag_t  bvr_tag,
logical  is_transfer,
int  n_adds,
tag_t *  add_tags,
int  n_cancels,
tag_t *  cancel_tags,
tag_t *  sup_tag 
)

This function creates and saves a Supercedure object in the database using the supplied BOM Add and Cancel objects. If is_transfer flag is given true, a 'Transfer' will be created. In that case, Item list for adds and cancels must be the same.

Note:
All BOM Adds and Cancels given as input must point to the same EC Revision
Parameters:
bvr_tag  (I) Tag of affected assembly
is_transfer  (I) True if the supersedure to be created is of type Transfer
n_adds  (I) Number of BOM Add tags
add_tags  (I) Array of BOM Add tags
n_cancels  (I) Number of BOM Cancel tags
cancel_tags  (I) Array of BOM Cancel tags
sup_tag  (O) New supercedure tag

ECM_API int ECM_delete_supercedure ( tag_t  sup_tag  ) 

This function deletes the specified supercedure from the database. There is no need to lock the object before calling this method.

Parameters:
sup_tag  (I) Supercedure tag

ECM_API int ECM_find_associated_ec ( tag_t  target_rev_tag,
tag_t *  ec_rev_tag 
)

Parameters:
target_rev_tag  (I)
ec_rev_tag  (O)

ECM_API int ECM_find_bomchanges_of_occ ( tag_t  occ_tag,
int *  bomch_count,
tag_t **  bomch_tags 
)

This function returns all the BOM change objects that were created using the given Occurrence.

Parameters:
occ_tag  (I) Occurrence tag
bomch_count  (O) Number of BomChanges associated
bomch_tags  (OF) bomch_count Array of BomChange tags

ECM_API int ECM_find_ec_revision ( const char *  ec_id,
const char *  ec_rev_id,
tag_t *  ec_rev_tag 
)

This function finds the EC Revision, using the EC ID and the Revision ID as input.

Parameters:
ec_id  (I) EC Item ID
ec_rev_id  (I) EC Revision ID
ec_rev_tag  (O) EC Revision tag

ECM_API int ECM_find_supercedure_of_bomchange ( tag_t  bcTag,
tag_t *  supTag 
)

Parameters:
bcTag  (I) BOM Change Tag
supTag  (O) Supercedure tag of the bom change

ECM_API void ECM_free_notechange_info_struct ( ECM_note_change_info_t  info  ) 

This ITK can be used to free memory of all members of ECM_note_change_info_t structure

ECM_API void ECM_free_variantchange_info_struct ( ECM_variant_change_info_t  info  ) 

This ITK can be used to free memory of all the members of ECM_variant_change_info_t structure

ECM_API int ECM_get_affected_bvr_of_bomchange ( tag_t  bomch_tag,
tag_t *  affected_bvr 
)

This function returns the affected assembly associated with the given BomChange object.

Parameters:
bomch_tag  (I) Tag of the BomChange object
affected_bvr  (O) Tag of the affected assembly

ECM_API int ECM_get_affected_items ( tag_t  ec_rev_tag,
int *  n_items,
tag_t **  itemTags 
)

This function returns all affected revisions for the given EC Revision. The affected revisions are searched using Teamcenter Engineering Relation type name/names mentioned in the "ECM_affected_item_relation" site preference.

Parameters:
ec_rev_tag  (I) EC Revision tag
n_items  (O) Number of affected revisions
itemTags  (OF) n_items Array of affected revision tags

ECM_API int ECM_get_bom_changes ( tag_t  ec_rev_tag,
tag_t  affected_bvr,
ECM_bom_change_type_t  bomch_type,
int *  num_of_bomch,
tag_t **  bomch_tags 
)

This function returns all BomChange objects of a specified type for the specified affected assembly and EC Revision combination. The output also includes all derived BomChange objects. Currently there are three supported types: BOM_Add, BOM_Cancel and BOM_Quantity_Change.

Parameters:
ec_rev_tag  (I) EC Revision tag
affected_bvr  (I) Affected assembly tag
bomch_type  (I) Type of BOM change requested
num_of_bomch  (O) The number of BOM change objects found
bomch_tags  (OF) num_of_bomch The array of BOM Change tags found

ECM_API int ECM_get_bomchange_type ( tag_t  bomch_tag,
ECM_bom_change_type_t *  bomch_type 
)

This function returns the type of the given BomChange object. Supported types are BOM_Add, BOM_Cancel and BOM_Quantity_Change, as defined in ECM_bom_change_type_t enum (ecm.h).

Parameters:
bomch_tag  (I) Tag of the BomChange object
bomch_type  (O) BOM Change type

ECM_API int ECM_get_contents ( tag_t  ec_rev_tag,
const char *  folder_name,
int *  num_of_obj,
tag_t **  obj_tags 
)

This function returns all of the objects contained by the specified pseudo folder of the given EC Revision.

Parameters:
ec_rev_tag  (I) EC Revision tag
folder_name  (I) EC folder name
num_of_obj  (O) The number of workspace objects in the specified folder
obj_tags  (OF) num_of_obj The array of workspace object tags

ECM_API int ECM_get_ec_pseudofolder_names ( int *  nFolder,
char ***  folderNames,
char ***  relnNames 
)

This function returns all Pseudo-folders and corresponding Teamcenter Engineering Relation names defined for EC Revision in the "ECM_Pesudofolder_names" site preference.

Parameters:
nFolder  (O) Number of EC folder
folderNames  (OF) nFolder EC folder name
relnNames  (OF) nFolder EC relation names

ECM_API int ECM_get_ec_type ( tag_t  ec_rev_tag,
char **  ec_type 
)

This function returns the EC Type of the given EC Revision.

Parameters:
ec_rev_tag  (I) EC Revision tag
ec_type  (OF) EC Type

ECM_API int ECM_get_ecrev_of_bomchange ( tag_t  bomch_tag,
tag_t *  ec_rev_tag 
)

This function returns the EC Revision associated with the given BomChange object.

Parameters:
bomch_tag  (I) Tag of the BomChange object
ec_rev_tag  (O) EC Revision tag

ECM_API int ECM_get_form_relation ( char **  formRelationType  ) 

This function returns the Teamcenter Engineering Relation type to be used while attaching EC Forms to the EC Revision. The Relation type is set by the site DBA in "ECM_form_relation" site preference.

Parameters:
formRelationType  (O) Default relation type for EC forms

ECM_API int ECM_get_note_change_details ( tag_t  note_change_tag,
ECM_note_change_info_t *  notechange_details 
)

This method will return the note change details for the input Note Change object. Information includes the list of changed note types, their values in problem and affected assembly. Form field related members of the output structure wouldn’t be filled as output of this ITK method. They are reserved for future use.

Restrictions:

If input BomChange object is not an affected side BomChange, this ITK will return an error code

Parameters:
note_change_tag  (I) Note Change Tag
notechange_details  (O) Output structure of type ECM_note_change_info_t

ECM_API int ECM_get_note_change_history_info ( tag_t  bomline_tag,
int *  number_of_notechanges,
ECM_note_change_info_t **  details 
)

This method will return details of all note changes with respect to the occurrence of the input BOM Line and it’s parent assembly. In addition to the changed note type name/value pairs number of pre-defined (as per ECM_notehistory_extra_columns site preference) BomChange Form fields and their values are also returned as part of the output structure.

Parameters:
bomline_tag  (I) BOM Line Tag
number_of_notechanges  (O) Number of Note Change records returned
details  (OF) number_of_notechanges Array of structure of type ECM_note_change_info_t

ECM_API int ECM_get_occurrence_of_bomchange ( tag_t  bomch_tag,
tag_t *  occ_tag 
)

This function returns the Occurrence object associated with the given BomChange object.

Parameters:
bomch_tag  (I) Tag of the BomChange object
occ_tag  (O) Occurrence tag

ECM_API int ECM_get_prev_bvr ( tag_t  ec_rev_tag,
tag_t  bvr_tag,
tag_t *  prev_bvr_tag 
)

This function returns the problem assembly of the given affected assembly with the context of the given EC Revision. The relationship is obtained using the internal affected to problem relationship between the corresponding affected Revision and its related problem revision.

Parameters:
ec_rev_tag  (I) EC Revision tag
bvr_tag  (I) Tag of affected assembly
prev_bvr_tag  (O) Tag of problem assembly

ECM_API int ECM_get_problem_of_affected ( tag_t  ec_rev_tag,
tag_t  affected_ir,
tag_t *  problem_ir 
)

This function returns the corresponding problem revision for the given affected revision of the specified EC Revision.

Parameters:
ec_rev_tag  (I) EC Revision tag
affected_ir  (I) Tag of affected revision
problem_ir  (O) Tag of problem revision

ECM_API int ECM_get_relation_of_folder ( const char *  folder_name,
char **  reln_name 
)

This function returns the corresponding Teamcenter Engineering Relation type name of the given EC Pseudo-folder name.

Parameters:
folder_name  (I) EC folder name
reln_name  (OF) EC relation name

ECM_API int ECM_get_variant_change_details ( tag_t  variant_change_tag,
ECM_variant_change_info_t *  variantchange_details 
)

This method returns the variant change details for the input Variant Change object. Information includes the Variant Condition values in problem and affected assembly.

This method will return the variant change details for the given Variant Change object. Information includes the variant Condition tags in both problem and affected assembly. Form field related members of the output structure wouldn’t be filled as output of this ITK method.

Restrictions:

If input BomChange object is not an affected side BomChange, this ITK will return an error code.

Parameters:
variant_change_tag  (I) Variant Change Tag
variantchange_details  (O) Output structure of type ECM_variant_change_info_t

ECM_API int ECM_get_variant_change_history_info ( tag_t  bomline_tag,
int *  number_of_variantchanges,
ECM_variant_change_info_t **  details 
)

This method will return details of all variant changes with respect to the occurrence of the input BOM Line and it’s parent assembly. In addition to the changed Variant Condition Value number of pre-defined (as per ECM_varianthistory_extra_columns site preference) BomChange Form fields and their values are also returned as part of the output structure.

Parameters:
bomline_tag  (I) BOM Line Tag
number_of_variantchanges  (O) Number of Variant Change records returned
details  (OF) no_of_variantchanges Array of structure of type ECM_variant_change_info_t

ECM_API int ECM_init_module ( void   ) 

ECM_API int ECM_is_affected_rev ( tag_t  ec_rev_tag,
tag_t  ir_tag,
logical *  is_affected 
)

This function returns true if the specified Revision is an affected revision for the given EC Revision.

Note:
The results returned by this function is controlled by the ECM_affected_item_relations site preference. For more information about this preference, see the Configuration Guide.
Parameters:
ec_rev_tag  (I) EC Revision tag
ir_tag  (I) Item Revision tag
is_affected  (O) True, if the specified revision is an affected revision

ECM_API int ECM_is_problem_relation_set ( tag_t  ec_rev_tag,
tag_t  affected_ir,
logical *  is_set 
)

This function returns true if the affected problem relation is set for the given affected revision of the specified EC Revision.

Parameters:
ec_rev_tag  (I) EC Revision tag
affected_ir  (I) Tag of the affected revision
is_set  (O) True, if affected to problem relation is set

ECM_API int ECM_is_problem_rev ( tag_t  ec_rev_tag,
tag_t  ir_tag,
logical *  is_problem 
)

This function returns true if the specified Revision is a problem revision for the given EC Revision.

Parameters:
ec_rev_tag  (I) EC Revision tag
ir_tag  (I) Item Revision tag
is_problem  (O) True if the specified revision is a problem revision

ECM_API int ECM_remove_all_relations ( tag_t  ec_rev_tag  ) 

This function removes the contents of all the EC pseudo folders for the given EC Revision. The pseudo folder names are obtained from the site preference ECM_pseudofolder_names.

Note:
This method does not remove EC forms referenced by the EC Revision.
Parameters:
ec_rev_tag  (I) EC Revision tag

ECM_API int ECM_remove_bomadd_from_sup ( tag_t  sup_tag,
tag_t  add_tag 
)

This function removes the specified BOM Add from the supercedure. You need to lock the supercedure object before calling this method and save and unlock the supercedure afterwards. This must not be called if the specified Add tag is the only BOM Add for the given supercedure.

Parameters:
sup_tag  (I) Supercedure tag
add_tag  (I) BOM Add tag

ECM_API int ECM_remove_bomcancel_from_sup ( tag_t  sup_tag,
tag_t  cancel_tag 
)

This function removes the specified BOM Cancel from the supercedure. You need to lock the supercedure object before calling this method and save and unlock the supercedure afterwards. This must not be called if the specified Cancel tag is the only BOM Cancel for the given supercedure.

Parameters:
sup_tag  (I) Supercedure tag
cancel_tag  (I) BOM Cancel tag

ECM_API int ECM_remove_contents ( tag_t  ec_rev_tag,
const char *  folder_name,
int  num_of_obj,
tag_t *  obj_tags 
)

This function removes the given object list from the specified pseudo-folder of the given EC Revision.

Parameters:
ec_rev_tag  (I) EC Revision tag
folder_name  (I) EC folder name
num_of_obj  (I) The number of workspace objects to remove from the specified folder
obj_tags  (I) The array of workspace object tags

ECM_API int ECM_save_bom_changes ( tag_t  ec_rev_tag,
tag_t  bom_window 
)

This function saves BOM Add, Cancel and Quantity change records for the given BOM window containing an affected assembly of the specified EC Revision.

Parameters:
ec_rev_tag  (I) EC Revision tag
bom_window  (I) BOM window containing affected assembly

ECM_API int ECM_set_ec_type ( tag_t  ec_rev_tag,
const char *  ec_type 
)

This function sets a new EC Type for the given EC Revision. This method does not create a new set of EC forms as per the new EC Type. It is necessary to detach the old set of forms and attach the desired form(s) using ITK functions from the EC Type and Form modules.

Parameters:
ec_rev_tag  (I) EC Revision tag
ec_type  (I) EC Type to set

ECM_API int ECM_set_problem_of_affected ( tag_t  ec_rev_tag,
tag_t  affected_ir,
tag_t  problem_ir 
)

This function creates an affected to problem relation between the given affected revision and problem revision of the specified EC Revision.

Parameters:
ec_rev_tag  (I) EC Revision tag
affected_ir  (I) Tag of affected revision
problem_ir  (I) Tag of the problem revision

ECM_API int ECM_snapshot_apply_stylesheet ( tag_t  ec_snapshot,
char *  stylesheet_file,
char **  output_dir,
char **  output_file 
)

Applies the stylesheet on XML file of the EC Snapshot. if no XSL file is passed, default XSL will be applied

Parameters:
ec_snapshot  (I) EC Snapshot tag
stylesheet_file  (I) Full path of Style Sheet file
output_dir  (OF) resultant file directory
output_file  (OF) resultant file name