Identifier

Modules
	IDFR Errors

Functions
TCCORE_API int	IDFR_add_aliasidof (tag_t identifier_tag, int num_identifiables, tag_t *identifiable_tags)
TCCORE_API int	IDFR_ask_aliasidof (tag_t identifier_tag, int *num_identifiables, tag_t **identifiable_tags)
TCCORE_API int	IDFR_ask_altidof (tag_t identifier_tag, tag_t *identifiable_tag)
TCCORE_API int	IDFR_ask_id (tag_t identifier_tag, char **identifier_id)
TCCORE_API int	IDFR_ask_idcontext (tag_t identifier_tag, tag_t *idcontext_tag)
TCCORE_API int	IDFR_ask_supplcontext (tag_t identifier_tag, tag_t *supplcontext_tag)
TCCORE_API int	IDFR_create_aliasid (const char *identifier_type, tag_t *new_identifier_tag)
TCCORE_API int	IDFR_create_altid (const char *identifier_type, tag_t idfbl_tag, tag_t idfbl_rev_tag, tag_t idcontext_tag, tag_t *altid_tag, tag_t *altid_rev_tag)
TCCORE_API int	IDFR_find_identifiers (const char *id, tag_t idcontext_tag, int *num_identifiers, tag_t **identifier_tags)
TCCORE_API int	IDFR_find_suppl_identifiers (tag_t master_idfr_tag, const char *suppl_id, int *num_suppl, tag_t **suppl_idfr_tags)
TCCORE_API int	IDFR_idfbl_ask_disp_altid (tag_t identifiable_tag, tag_t iddisprule_tag, tag_t *altid_tag)
TCCORE_API int	IDFR_idfbl_ask_disp_default (tag_t identifiable_tag, tag_t *altid_tag)
TCCORE_API int	IDFR_idfbl_find_altids (tag_t identifiable_tag, const char *id, tag_t idcontext_tag, int *num_altids, tag_t **altid_tags)
TCCORE_API int	IDFR_idfbl_find_altidsof (const char *id, tag_t idcontext_tag, tag_t identifiable_class_tag, int *num_identifiables, tag_t **identifiable_tags)
TCCORE_API int	IDFR_idfbl_list_aliasids (tag_t identifiable_tag, int *num_aliases, tag_t **aliasid_tags)
TCCORE_API int	IDFR_idfbl_list_altids (tag_t identifiable_tag, int *num_altids, tag_t **altid_tags)
TCCORE_API int	IDFR_idfbl_set_disp_default (tag_t identifiable_tag, tag_t altid_tag)
TCCORE_API int	IDFR_list_suppl_identifiers (tag_t master_idfr_tag, int *num_suppl, tag_t **suppl_idfr_tags)
TCCORE_API int	IDFR_new_alt_id (tag_t idcontext_tag, const char *idfr_type, char **new_id)
TCCORE_API int	IDFR_new_alt_ids (tag_t idcontext_tag, const char *idfr_type, char **new_id, char **new_rev_id)
TCCORE_API int	IDFR_new_rev_id (tag_t idfr_rev_tag, char **new_rev_id)
TCCORE_API int	IDFR_remove_aliasidof (tag_t identifier_tag, int num_identifiables, tag_t *identifiable_tags)
TCCORE_API int	IDFR_revise_altid (tag_t altid_or_rev_tag, tag_t idfbl_rev_tag, tag_t *new_altid_rev_tag)
TCCORE_API int	IDFR_saveas_altid (tag_t altid_rev_tag, tag_t idfbl_rev_tag, tag_t *new_altid_rev_tag)
TCCORE_API int	IDFR_set_altidof (tag_t identifier_tag, tag_t identifiable_tag)
TCCORE_API int	IDFR_set_id (tag_t identifier_tag, const char *identifier_id)
TCCORE_API int	IDFR_set_idcontext (tag_t identifier_tag, tag_t idcontext_tag)
TCCORE_API int	IDFR_set_supplcontext (tag_t identifier_tag, tag_t supplcontext_tag)
TCCORE_API int	IDFR_validate_alt_id (tag_t idcontext_tag, const char *idfr_type, const char *new_id, const char *pattern_name, char **modified_id, IDValid_e *status)
TCCORE_API int	IDFR_validate_alt_ids (tag_t idcontext_tag, const char *idfr_type, const char *new_id, const char *new_rev_id, const char *pattern_name, char **modified_id, char **modified_rev_id, IDValid_e *status)
TCCORE_API int	IDFR_validate_rev_id (tag_t idfr_rev_tag, const char *new_rev_id, const char *pattern_name, char **modified_id, IDValid_e *status)

IDENTIFIER class name and property name constants
#define	IDENTIFIER_class_name_c   "Identifier"
#define	IDENTIFIER_rev_type_name_c   "IdentifierRev"
#define	IDENTIFIER_id   "idfr_id"
#define	IDENTIFIER_idcontext   "idcontext"
#define	IDENTIFIER_altidof   "altid_of"
#define	IDENTIFIER_dispdefault   "disp_default"
#define	IDENTIFIER_supplcontext   "suppl_context"
#define	ALIASID_relation   "IMAN_aliasid"

Messages unique to IDENTIFIER
#define	IDENTIFIER_create_alternate_msg   "IDENTIFIER_create_alternate"
#define	IDENTIFIER_revise_alternate_msg   "IDENTIFIER_revise_alternate"
#define	IDENTIFIER_saveas_alternate_msg   "IDENTIFIER_saveas_alternate"
#define	IDENTIFIER_create_alias_msg   "IDENTIFIER_create_alias"

Detailed Description

Not all Teamcenter objects such as form storage class, type definitions, etc. are allowed to have additional ids. So, an identifiable is an abstract term to describe types of Teamcenter objects that are allowed to have additional ids. In V9.0 of Teamcenter, only items and item revisions will be valid identifiable objects.

An identifier defines id in some IdContext. All ids in a given context (IdContext + Supplemental Context) are unique. A site can sub-class Identifier when additional attributes are desired with the specification of an id. They can sub-type an Identifier or any of its sub-classes when different behavior is desired but additional attributes are not needed.

An identifier can be an Alternate identifier for an object as well as an Alias identifier for other objects at the same time. Similar to item, the ids of an identifier are supposed to be case insensitively unique. To support that properly, the administrator must install a unique functional index. Not doing so will severely degrade performance.

Use AOM functionality to refresh, save, and delete identifier objects. Use MEM_free to release allocated storage. Use AOM_ask_value and AOM_set_value functionality to ask/set custom properties or commercial properties.

All types of Identifier support the following messages:

1. IDENTIFIER_create_alternate_msg
2. IDENTIFIER_revise_alternate_msg
3. IDENTIFIER_saveas_alternate_msg
4. IDENTIFIER_create_alias_msg
5. TC_save_msg
6. TC_delete_msg
7. TC_refresh_msg
8. TC_import_msg
9. TC_export_msg
10. TCTYPE_createprops_msg
11. TCTYPE_viewerprops_msg

Macro Definition Documentation

#define ALIASID_relation   "IMAN_aliasid"

Definition at line 78 of file idfr.h.

#define IDENTIFIER_altidof   "altid_of"

Definition at line 75 of file idfr.h.

#define IDENTIFIER_class_name_c   "Identifier"

Definition at line 71 of file idfr.h.

#define IDENTIFIER_create_alias_msg   "IDENTIFIER_create_alias"

Definition at line 88 of file idfr.h.

#define IDENTIFIER_create_alternate_msg   "IDENTIFIER_create_alternate"

Definition at line 85 of file idfr.h.

#define IDENTIFIER_dispdefault   "disp_default"

Definition at line 76 of file idfr.h.

#define IDENTIFIER_id   "idfr_id"

Definition at line 73 of file idfr.h.

#define IDENTIFIER_idcontext   "idcontext"

Definition at line 74 of file idfr.h.

#define IDENTIFIER_rev_type_name_c   "IdentifierRev"

Definition at line 72 of file idfr.h.

#define IDENTIFIER_revise_alternate_msg   "IDENTIFIER_revise_alternate"

Definition at line 86 of file idfr.h.

#define IDENTIFIER_saveas_alternate_msg   "IDENTIFIER_saveas_alternate"

Definition at line 87 of file idfr.h.

#define IDENTIFIER_supplcontext   "suppl_context"

Definition at line 77 of file idfr.h.

Function Documentation

TCCORE_API int IDFR_add_aliasidof	(	tag_t	identifier_tag,
		int	num_identifiables,
		tag_t *	identifiable_tags
	)

Adds the given identifier as an Alias id for the given identifiable objects.

Parameters

identifier_tag	(I) Tag of existing identifier
num_identifiables	(I) Number of identifiable objects
identifiable_tags	(I) An array of tags to identifiable objects

TCCORE_API int IDFR_ask_aliasidof	(	tag_t	identifier_tag,
		int *	num_identifiables,
		tag_t **	identifiable_tags
	)

Returns the identifiable objects for which the given identifier is an Alias.

Parameters

identifier_tag	(I) Tag of existing identifier
num_identifiables	(O) Number of identifiable objects
identifiable_tags	(OF) num_identifiables An array of tags to identifiable objects

TCCORE_API int IDFR_ask_altidof	(	tag_t	identifier_tag,
		tag_t *	identifiable_tag
	)

Returns the identifiable object for which the given identifier is an Alternate.

Restrictions:

The altidof property cannot be set.

Parameters

identifier_tag	(I) Tag of existing identifier
identifiable_tag	(O) Tag of identifiable object

TCCORE_API int IDFR_ask_id	(	tag_t	identifier_tag,
		char **	identifier_id
	)

Returns the id attribute of the identifier.

Parameters

identifier_tag	(I) Tag of existing identifier
identifier_id	(OF) Id attribute value for the given identifier

TCCORE_API int IDFR_ask_idcontext	(	tag_t	identifier_tag,
		tag_t *	idcontext_tag
	)

Returns the reference to the idcontext object of the identifier.

Restrictions:

The idcontext property cannot be set.

Parameters

identifier_tag	(I) Tag of existing identifier
idcontext_tag	(O) Tag of idcontext reference to the identifier

TCCORE_API int IDFR_ask_supplcontext	(	tag_t	identifier_tag,
		tag_t *	supplcontext_tag
	)

If the identifier is a supplemental alternate, the returned tag is that of the master alternate identifier of which it is a supplemental. Otherwise, the returned tag will be null tag.

Restrictions:

The supplcontext property cannot be set.

Parameters

identifier_tag	(I) Tag of existing identifier
supplcontext_tag	(O) Tag of Alternate identifier or null tag

TCCORE_API int IDFR_create_aliasid	(	const char *	identifier_type,
		tag_t *	new_identifier_tag
	)

Deprecated:

This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

This call creates a new Alias identifier in memory of the given type, but does not save it in the database. It supports IDENTIFIER_create_alias_msg.

If identifier_type is null, base type of "Identifier" is assumed.

If the system administrator has not configured the IdContextRule to allow the given combination as a valid alias identifier creation, the create will fail.

Parameters

identifier_type	(I) Type of Alias identifier instance to be created
new_identifier_tag	(O) Tag of new Alias identifier

TCCORE_API int IDFR_create_altid	(	const char *	identifier_type,
		tag_t	idfbl_tag,
		tag_t	idfbl_rev_tag,
		tag_t	idcontext_tag,
		tag_t *	altid_tag,
		tag_t *	altid_rev_tag
	)

Deprecated:

This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

This call creates a new master alternate identifier of type <identifier type> and a new supplemental alternate identifier of type <identifier type>Rev in memory for an identifiable and identifiable revision in the given identifier context. It does not save these objects in the database.

This call should be used directly to create a master alternate and supplemental alternate identifier. This function supports IDENTIFIER_create_alternate_msg.

For both the Master and Supplemental identifiers to be created, the system administrator needs to configure the IdContextRule:

• idfbl_type, identifier_type, and idcontext as well as
• idfbl_rev_type, identifier_type+"Rev", and idcontext

If the IdContextRule for the Supplemental (Rev) is not configured, this call will create only a Master alternate identifier. If the idfbl_rev_tag is null, this call will create only a Master alternate identifier.

Parameters

identifier_type	(I) Type of Alternate identifier instance to be created
idfbl_tag	(I) Tag of existing identifiable item object
idfbl_rev_tag	(I) Tag of existing identifiable item Revision object
idcontext_tag	(I) Tag of identifier context object
altid_tag	(O) Tag of new (master) alternate identifier
altid_rev_tag	(O) Tag of new supplemental alternate identifier

TCCORE_API int IDFR_find_identifiers	(	const char *	id,
		tag_t	idcontext_tag,
		int *	num_identifiers,
		tag_t **	identifier_tags
	)

Returns all the identifiers that have the given id in the given idcontext. Uses case-insensitive search and allows wildcards in id. If idcontext_tag is null tag, the search is performed on all idcontexts. It returns all identifiers including those for which the user may not have read permission.

Parameters

id	(I) Id attribute value for the given identifier
idcontext_tag	(I) Tag of idcontext reference to the identifier or null tag
num_identifiers	(O) Number of identifier objects
identifier_tags	(OF) num_identifiers An array of tags to identifier objects

TCCORE_API int IDFR_find_suppl_identifiers	(	tag_t	master_idfr_tag,
		const char *	suppl_id,
		int *	num_suppl,
		tag_t **	suppl_idfr_tags
	)

Performs a case insensitive search with wildcards for id of supplemental alternates given the master alternate. It could return zero supplemental alternates.

Parameters

master_idfr_tag	(I)
suppl_id	(I) Id of the desired supplemental. Wildcards allowed. Case insensitive search is performed.
num_suppl	(O) Number of supplemental alternate objects
suppl_idfr_tags	(OF) num_suppl An array of tags to supplemental alternate objects

TCCORE_API int IDFR_idfbl_ask_disp_altid	(	tag_t	identifiable_tag,
		tag_t	iddisprule_tag,
		tag_t *	altid_tag
	)

Finds and Alternate identifier, given an identifiable and identifier display rule that satisfies the rule. If the identifiable does not have any identifier in the contexts specified by the rule, the function returns a null tag. If the iddisprule_tag is null tag, the current display rule of the user is assumed.

Parameters

identifiable_tag	(I) Tag of identifiable object
iddisprule_tag	(I) Tag of identifier display rule object or null tag
altid_tag	(O) Tag of the Alternate identifier or null tag

TCCORE_API int IDFR_idfbl_ask_disp_default	(	tag_t	identifiable_tag,
		tag_t *	altid_tag
	)

Returns the Alternate identifier that is the display default identifier of the identifiable. The output could be a null tag if there is no default.

Parameters

identifiable_tag	(I) Tag of identifiable object
altid_tag	(O) Tag of the default Alternate identifier or null tag

TCCORE_API int IDFR_idfbl_find_altids	(	tag_t	identifiable_tag,
		const char *	id,
		tag_t	idcontext_tag,
		int *	num_altids,
		tag_t **	altid_tags
	)

A case-insensitive search performed to find the Alternate identifiers of a given identifiable with a given id. If id in context is implemented, this search can find more than one Alternate identifier that meets the criteria. The user may not have read permission to all the returned alternates.

Parameters

identifiable_tag	(I) Tag of identifiable object
id	(I) Id attribute value for the given identifiable object
idcontext_tag	(I)
num_altids	(O) Number of Alternate identifiers
altid_tags	(OF) num_altids An array of tags to Alternate identifier objects

TCCORE_API int IDFR_idfbl_find_altidsof	(	const char *	id,
		tag_t	idcontext_tag,
		tag_t	identifiable_class_tag,
		int *	num_identifiables,
		tag_t **	identifiable_tags
	)

Returns all the identifiable objects that have the given Alternate identifier in the given idcontext and are of the given identifiable class or its subclasses. Uses case-insensitive search and allows wildcards in id. If idcontext_tag is null tag, the search is performed on all idcontexts for the given id. If identifiable_class_tag is null tag, the returned identifiable objects can be of any class. The user may not have read permission to all the returned alternates.

Parameters

id	(I) Id attribute value for the given identifier
idcontext_tag	(I) Tag of idcontext reference to the Alternate identifier or null tag
identifiable_class_tag	(I) Tag of class of the identifiable object or null tag
num_identifiables	(O) Number of identifiable objects
identifiable_tags	(OF) num_identifiables An array of tags to identifiable objects

TCCORE_API int IDFR_idfbl_list_aliasids	(	tag_t	identifiable_tag,
		int *	num_aliases,
		tag_t **	aliasid_tags
	)

Lists all Alias identifiers associated to a given identifiable. The user may not have read permission to all the returned aliases.

Parameters

identifiable_tag	(I) Tag of identifiable object
num_aliases	(O) Number of Alias identifiers
aliasid_tags	(OF) num_aliases An array of tags to Alias identifier objects

TCCORE_API int IDFR_idfbl_list_altids	(	tag_t	identifiable_tag,
		int *	num_altids,
		tag_t **	altid_tags
	)

Lists all Alternate identifiers associated to a given identifiable. The user may not have read permission to all the returned alternates.

Parameters

identifiable_tag	(I) Tag of identifiable object
num_altids	(O) Number of Alternate identifiers
altid_tags	(OF) num_altids An array of tags to Alternate identifier objects

TCCORE_API int IDFR_idfbl_set_disp_default	(	tag_t	identifiable_tag,
		tag_t	altid_tag
	)

Sets the given Alternate identifier as the display default identifier of the identifiable. The input altid_tag could be a null tag to remove the default. To change the default, the user needs to have write access to the identifiable, existing default identifier if any, and new default identifier if any.

Parameters

identifiable_tag	(I) Tag of identifiable object
altid_tag	(I) Tag of the new default Alternate identifier or null tag

TCCORE_API int IDFR_list_suppl_identifiers	(	tag_t	master_idfr_tag,
		int *	num_suppl,
		tag_t **	suppl_idfr_tags
	)

Returns all supplemental alternate identifiers associated with the given master alternate.

Parameters

master_idfr_tag	(I) Tag of existing master identifier
num_suppl	(O) Number of supplemental alternate objects
suppl_idfr_tags	(OF) num_suppl An array of tags to supplemental alternate objects

TCCORE_API int IDFR_new_alt_id	(	tag_t	idcontext_tag,
		const char *	idfr_type,
		char **	new_id
	)

Returns an alternate identifier value for the given identifier type value in the given idcontext.

Parameters

idcontext_tag	(I) Tag of idcontext reference to the identifier
idfr_type	(I) Alternate identifier type value
new_id	(OF) New alternate id attribute value

TCCORE_API int IDFR_new_alt_ids	(	tag_t	idcontext_tag,
		const char *	idfr_type,
		char **	new_id,
		char **	new_rev_id
	)

Returns an alternate identifier value and an alternate identifier revision value for the given identifier type value in the given idcontext. The identifier revision value will be returned as null, in case the Supplemental IdContext rule is not defined.

Parameters

idcontext_tag	(I) Tag of idcontext reference to the identifier
idfr_type	(I) Alternate identifier type value
new_id	(OF) New alternate id attribute value
new_rev_id	(OF) New alternate revision id attribute value

TCCORE_API int IDFR_new_rev_id	(	tag_t	idfr_rev_tag,
		char **	new_rev_id
	)

Returns an alternate identifier revision value for the given identifier revision tag.

Parameters

idfr_rev_tag	(I) Tag of alternate identifier revision
new_rev_id	(OF) New alternate revision id attribute value

TCCORE_API int IDFR_remove_aliasidof	(	tag_t	identifier_tag,
		int	num_identifiables,
		tag_t *	identifiable_tags
	)

Removes the given identifier as an Alias for the given identifiable objects.

Parameters

identifier_tag	(I) Tag of existing identifier
num_identifiables	(I) Number of identifiable objects
identifiable_tags	(I) An array of tags to identifiable objects

TCCORE_API int IDFR_revise_altid	(	tag_t	altid_or_rev_tag,
		tag_t	idfbl_rev_tag,
		tag_t *	new_altid_rev_tag
	)

This call creates a new Alternate revision identifier in memory for a given master or supplemental alternate identifier and item revision identifiable, but does not save it in the database.

This call should be used directly to revising an existing master or supplemental alternate identifier.

In case there is no IdContextRule for the Supplemental, this call would return an error.

Parameters

altid_or_rev_tag	(I) Tag of existing master or supplemental alternate identifier
idfbl_rev_tag	(I) Tag of existing identifiable item revision object
new_altid_rev_tag	(O) Tag of new supplemental alternate identifier

TCCORE_API int IDFR_saveas_altid	(	tag_t	altid_rev_tag,
		tag_t	idfbl_rev_tag,
		tag_t *	new_altid_rev_tag
	)

This call creates a new Alternate saveas identifier in memory for a given supplemental alternate identifier, but does not save it in the database.

This call should be used directly to saveas an existing supplemental alternate identifier.

Parameters

altid_rev_tag	(I) Tag of existing supplemental alternate revision identifier
idfbl_rev_tag	(I) Tag of identifiable to which new alternate revision identifier to be saved as
new_altid_rev_tag	(O) Tag of new revision alternate identifier

TCCORE_API int IDFR_set_altidof	(	tag_t	identifier_tag,
		tag_t	identifiable_tag
	)

Parameters

identifier_tag	(I)
identifiable_tag	(I)

TCCORE_API int IDFR_set_id	(	tag_t	identifier_tag,
		const char *	identifier_id
	)

Sets the id attribute of the identifier. If the given identifier tag is a master alternate, and any of its supplemental alternates are released, you will not be able to modify this.

Parameters

identifier_tag	(I) Tag of existing identifier
identifier_id	(I) Id attribute value for the given identifier

TCCORE_API int IDFR_set_idcontext	(	tag_t	identifier_tag,
		tag_t	idcontext_tag
	)

Parameters

identifier_tag	(I)
idcontext_tag	(I)

TCCORE_API int IDFR_set_supplcontext	(	tag_t	identifier_tag,
		tag_t	supplcontext_tag
	)

Parameters

identifier_tag	(I)
supplcontext_tag	(I)

TCCORE_API int IDFR_validate_alt_id	(	tag_t	idcontext_tag,
		const char *	idfr_type,
		const char *	new_id,
		const char *	pattern_name,
		char **	modified_id,
		IDValid_e *	status
	)

Parameters

idcontext_tag	(I)
idfr_type	(I)
new_id	(I)
pattern_name	(I)
modified_id	(OF)
status	(O)

TCCORE_API int IDFR_validate_alt_ids	(	tag_t	idcontext_tag,
		const char *	idfr_type,
		const char *	new_id,
		const char *	new_rev_id,
		const char *	pattern_name,
		char **	modified_id,
		char **	modified_rev_id,
		IDValid_e *	status
	)

Parameters

idcontext_tag	(I)
idfr_type	(I)
new_id	(I)
new_rev_id	(I)
pattern_name	(I)
modified_id	(OF)
modified_rev_id	(OF)
status	(O)

TCCORE_API int IDFR_validate_rev_id	(	tag_t	idfr_rev_tag,
		const char *	new_rev_id,
		const char *	pattern_name,
		char **	modified_id,
		IDValid_e *	status
	)

Parameters

idfr_rev_tag	(I)
new_rev_id	(I)
pattern_name	(I)
modified_id	(OF)
status	(O)