Item ID Registry

Modules
	IIR Errors

Macros
#define	ITEM_REGISTRY_ACTIVE   "ITEM_id_registry"
#define	ITEM_REGISTRY_ALLOW_IF_SERVER_DOWN   "ITEM_id_allow_if_registry_down"
#define	ITEM_REGISTRY_REGISTER_ON_CREATE   "ITEM_id_always_register_on_creation"
#define	ITEM_REGISTRY_SITE   "ITEM_id_registry_site"
#define	ITEM_REGISTRY_UNREGISTER_ON_DELETE   "ITEM_id_unregister_on_delete"

Functions
PUBLICATION_API int	IIR_is_item_id_registered (const char *item_id, int *verdict, int site_id)
PUBLICATION_API int	IIR_is_item_with_mfk_registered (tag_t item_tag, int *verdict, int site_id)
PUBLICATION_API int	IIR_postaction_register_item_id (const char *item_id, int site_id)
PUBLICATION_API int	IIR_register_item_id (const char *item_id, int site_id)
PUBLICATION_API int	IIR_register_item_with_mfk (tag_t item_tag, int site_id)
PUBLICATION_API int	IIR_unregister_item_id (const char *item_id, int site_id)
PUBLICATION_API int	IIR_unregister_item_with_mfk (tag_t item_tag, int site_id)

Detailed Description

The Item ID Registry is a centralized database of all Item Ids that have been assigned throughout the Teamcenter Engineering federation.

Macro Definition Documentation

#define ITEM_REGISTRY_ACTIVE   "ITEM_id_registry"

Definition at line 28 of file iir_itk.h.

#define ITEM_REGISTRY_ALLOW_IF_SERVER_DOWN   "ITEM_id_allow_if_registry_down"

Definition at line 31 of file iir_itk.h.

#define ITEM_REGISTRY_REGISTER_ON_CREATE   "ITEM_id_always_register_on_creation"

Definition at line 32 of file iir_itk.h.

#define ITEM_REGISTRY_SITE   "ITEM_id_registry_site"

Definition at line 29 of file iir_itk.h.

#define ITEM_REGISTRY_UNREGISTER_ON_DELETE   "ITEM_id_unregister_on_delete"

Definition at line 30 of file iir_itk.h.

Function Documentation

PUBLICATION_API int IIR_is_item_id_registered	(	const char *	item_id,
		int *	verdict,
		int	site_id
	)

Parameters

item_id	(I)
verdict	(O)
site_id	(I)

PUBLICATION_API int IIR_is_item_with_mfk_registered	(	tag_t	item_tag,
		int *	verdict,
		int	site_id
	)

Parameters

item_tag	(I)
verdict	(O)
site_id	(I)

PUBLICATION_API int IIR_postaction_register_item_id	(	const char *	item_id,
		int	site_id
	)

Registers the specified Item in the PostAction extension of Item Create event.

Returns

• ITK_ok on success
• IIR_registry_not_active if the item registry is not active
• IIR_invalid_item_id_arg if an invalid item_id is supplied
• ODS_function_unavailable if an incompatible ODS server is used for Item registration
• Possibly a BMF (Business Modeler Framework) error if there are any issues with the customization for this method.

Parameters

item_id	(I) The item_id used for registering the item.
site_id	(I) Object Directory Services (ODS) site ID

PUBLICATION_API int IIR_register_item_id	(	const char *	item_id,
		int	site_id
	)

This function is used to register an item id.

Parameters

item_id	(I) The item id to be registered
site_id	(I)

PUBLICATION_API int IIR_register_item_with_mfk	(	tag_t	item_tag,
		int	site_id
	)

Parameters

item_tag	(I)
site_id	(I)

PUBLICATION_API int IIR_unregister_item_id	(	const char *	item_id,
		int	site_id
	)

This function is used to unregister an item id.

Return Values:

IIR_item_not_registered - Item ID not found in registry database

Parameters

item_id	(I) The item id to be unregistered
site_id	(I)

PUBLICATION_API int IIR_unregister_item_with_mfk	(	tag_t	item_tag,
		int	site_id
	)

Parameters

item_tag	(I)
site_id	(I)