gms_publication.h File Reference

#include <tc/tc_startup.h>
#include <tccore/aom.h>
#include <publication/libpublication_exports.h>
#include <publication/libpublication_undef.h>

Go to the source code of this file.

Functions
PUBLICATION_API int	GMS_check_replica_sync_state (int n_items, tag_t *n_objects, AOM_sync_type_t sync_type, AOM_sync_state_t **sync_state, int **ifails)
PUBLICATION_API int	GMS_request_import_from_offline_package (const char *offline_package_file_path, tag_t option_set_tag, int n_options, const char **option_names, const char **option_values, int n_session_options, const char **session_option_names, const char **session_option_values, int priority, logical email_notification, int n_email_addrs, const char **email_addrs, char **msg_id)
PUBLICATION_API int	GMS_request_ownership_transfer (tag_t changeOwnershipToSite, logical dryrun, logical isSourceSiteExtinct, logical email_notification, int n_email_addrs, char **email_addrs, char **msg_id)
PUBLICATION_API int	GMS_request_ownership_transfer_using_date_range (tag_t changeOwnershipToSite, logical dryrun, logical isSourceSiteExtinct, logical email_notification, int n_email_addrs, char **email_addrs, const char *startDate, const char *endDate, char **msg_id)
PUBLICATION_API int	GMS_request_remote_export (int n_items, tag_t *objects, int n_sites, tag_t *target_sites, char *reason, tag_t option_set, int n_options, char **option_names, char **option_values, int n_session_options, char **session_option_names, char **session_option_values, int priority, logical email_notification, int n_email_addrs, char **email_addrs, int *n_msg_ids, char ***msg_ids)
PUBLICATION_API int	GMS_request_remote_import (int n_items, tag_t *n_objects, int *owning_site_ids, char *reason, tag_t option_set_tag, int n_options, char **option_names, char **option_values, int n_session_options, char **session_option_names, char **session_option_values, int priority, logical email_notification, int n_email_addrs, char **email_addrs, int *n_msg_ids, char ***msg_id)
PUBLICATION_API int	GMS_send_replica_deletion_notification (tag_t owning_site, int n_replicaGSIdentityStrings, char **replicaGSIdentityStrings, int n_stubGSIdentityStrings, char **stubGSIdentityStrings)

Function Documentation

PUBLICATION_API int GMS_check_replica_sync_state	(	int	n_items,
		tag_t *	n_objects,
		AOM_sync_type_t	sync_type,
		AOM_sync_state_t **	sync_state,
		int **	ifails
	)

PUBLICATION_API int GMS_request_import_from_offline_package	(	const char *	offline_package_file_path,
		tag_t	option_set_tag,
		int	n_options,
		const char **	option_names,
		const char **	option_values,
		int	n_session_options,
		const char **	session_option_names,
		const char **	session_option_values,
		int	priority,
		logical	email_notification,
		int	n_email_addrs,
		const char **	email_addrs,
		char **	msg_id
	)

For Remote Export in GMS environment Parameters: option_names (option_values) Example: opt_do_struct (True/False), opt_rev_select (latestRevisionOnly/allReleasedRevisionsOnly/ etc) opt_entire_bom (True/False) for extensive list, please see PLM XML Export Import Administration Tool

session_option_names(session_option_values) are following modified_objects_only (True/False) continue_on_error (True/False) dry_run (True/False) offline (True/False) transfer_site_ownership (True/False)

PUBLICATION_API int GMS_request_ownership_transfer	(	tag_t	changeOwnershipToSite,
		logical	dryrun,
		logical	isSourceSiteExtinct,
		logical	email_notification,
		int	n_email_addrs,
		char **	email_addrs,
		char **	msg_id
	)

PUBLICATION_API int GMS_request_ownership_transfer_using_date_range	(	tag_t	changeOwnershipToSite,
		logical	dryrun,
		logical	isSourceSiteExtinct,
		logical	email_notification,
		int	n_email_addrs,
		char **	email_addrs,
		const char *	startDate,
		const char *	endDate,
		char **	msg_id
	)

PUBLICATION_API int GMS_request_remote_export	(	int	n_items,
		tag_t *	objects,
		int	n_sites,
		tag_t *	target_sites,
		char *	reason,
		tag_t	option_set,
		int	n_options,
		char **	option_names,
		char **	option_values,
		int	n_session_options,
		char **	session_option_names,
		char **	session_option_values,
		int	priority,
		logical	email_notification,
		int	n_email_addrs,
		char **	email_addrs,
		int *	n_msg_ids,
		char ***	msg_ids
	)

Launches a remote export.

Returns

• ITK_ok on success
• GMS_offline_cannot_transfer_ownership if the site ownership cannot be changed in the offline transfer mode.
• PIE_transferoptionset_not_retrieved if the TransferOptionSets cannot be retrieved from the database.
• GMS_fail_to_login_to_global_services if an error has occurred while logging into Global Services.

Parameters

n_items	(I) Number of objects to be exported.
objects	(I) n_items Objects to be exported. If an invalid object is provided, it is ignored.
n_sites	(I) The number of sites to which objects are to be exported. If value of n_sites is 0, it does not launches a remote export.
target_sites	(I) n_sites Sites to which objects are to be exported. If an invalid site is provided, it is ignored.
reason	(I) The Reason for export. This can be a null pointer.
option_set	(I) The object of type "TransferOptionSet".
n_options	(I) The number of transfer options whose values need to different than in "TransferOptionSet".
option_names	(I) n_options Option names. If same options given as in "TransferOptionSet" then values of options will be override. Some of the valid values are: opt_do_struct (True/False) opt_rev_select (latestRevisionOnly/allReleasedRevisionsOnly/ etc) opt_entire_bom (True/False) For the extensive list, please refer to the documentation of the PLM XML Export Import administration tool.
option_values	(I) n_options Option values. If an invalid value is provided, the default value of the option is used.
n_session_options	(I) The number of session options.
session_option_names	(I) n_session_options Session option names If same options given as in "TransferOptionSet" provided, the values of session options are overrided. Some of the valid values are: modified_objects_only (True/False) continue_on_error (True/False) unmanaged (True/False) dry_run (True/False) transfer_site_ownership (True/False) For the extensive list, please refer to the documentation of the PLM XML Export Import administration tool.
session_option_values	(I) n_session_options Session option values. If an invalid value is provided, the default value of the session option is used.
priority	(I) Priority to schedule the call of export. Some of the valid values are: PRIORITY_IMMEDIATE (-1) PRIORITY_OFFHOURS (-2) If an invalid value is provided, the default value PRIORITY_OFFHOURS is used.
email_notification	(I) The boolean value indicates that should sent email or not.
n_email_addrs	(I) Number of email recipients. If n_email_addresses is set to a value of -1, this will get the email address from the Person object of the logged in user.
email_addrs	(I) n_email_addrs Email addresses. If an invalid address is provided, no mail is sent to this recipient.
n_msg_ids	(O) The number of message IDs.
msg_ids	(OF) n_msg_ids Message IDs that need to passed to Global Services to enable the end user to identify and monitor a remote import or export request. The format of the generated a message ID is as : <object id> [<remote_site>] <time stamp>

PUBLICATION_API int GMS_request_remote_import	(	int	n_items,
		tag_t *	n_objects,
		int *	owning_site_ids,
		char *	reason,
		tag_t	option_set_tag,
		int	n_options,
		char **	option_names,
		char **	option_values,
		int	n_session_options,
		char **	session_option_names,
		char **	session_option_values,
		int	priority,
		logical	email_notification,
		int	n_email_addrs,
		char **	email_addrs,
		int *	n_msg_ids,
		char ***	msg_id
	)

For Remote Export in GMS environment Parameters: option_names (option_values) Example: opt_do_struct (True/False), opt_rev_select (latestRevisionOnly/allReleasedRevisionsOnly/ etc) opt_entire_bom (True/False) for extensive list, please see PLM XML Export Import Administration Tool

session_option_names(session_option_values) are following modified_objects_only (True/False) continue_on_error (True/False) dry_run (True/False) offline (True/False) transfer_site_ownership (True/False)

PUBLICATION_API int GMS_send_replica_deletion_notification	(	tag_t	owning_site,
		int	n_replicaGSIdentityStrings,
		char **	replicaGSIdentityStrings,
		int	n_stubGSIdentityStrings,
		char **	stubGSIdentityStrings
	)