gms.h File Reference

#include <gms/libgms_exports.h>
#include <gms/libgms_undef.h>

Go to the source code of this file.

Functions
GMS_API int	GMS_export_objects_to_offline_package (const char *reason, int n_objects, tag_t *object_tags, int n_sites, tag_t *sites, 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, tag_t *briefcase_dataset_tag, char **offline_file_name, int *n_export_log_files, char ***export_log_files)
GMS_API int	GMS_identify_outdated_replica_objects (int replicasite, int numOfInputObjects, tag_t *objList, int *numberOfOutdatedObjects, tag_t **statusObjects)
GMS_API int	GMS_import_objects_from_offline_package (const char *offline_file_name, 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, char **log_file_fmsticket, char **error_file_fmsticket)
GMS_API int	GMS_import_objects_from_offline_package_with_new_objects (const char *offline_file_name, 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, char **log_file_fmsticket, char **error_file_fmsticket, int *n_new_objects, tag_t **new_objects)
GMS_API int	GMS_synchronize_site (int replicaSite, int numOfClasses, char **classNames, int numOfObjectHandles, tag_t *objectHandlesList, int *numOfObjectsToExport, tag_t **objectsToExport)

Detailed Description

Import Export functions

Definition in file gms.h.

Function Documentation

GMS_API int GMS_export_objects_to_offline_package	(	const char *	reason,
		int	n_objects,
		tag_t *	object_tags,
		int	n_sites,
		tag_t *	sites,
		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,
		tag_t *	briefcase_dataset_tag,
		char **	offline_file_name,
		int *	n_export_log_files,
		char ***	export_log_files
	)

Exports objects to the briefcase.

Returns

• ITK_ok on success
• TIE_no_sync_candidates if there are no synchronization candidates.
• GMS_nonbcz_export_modobjs_not_allowed if the non-Briefcase export operation does not support synchronization. Set the "modified_objects_only" option to false, and try to export again
• GMS_zero_target_sites if n_sites is 0.
• TIE_bulk_extract_invalid_sync_option if synchronization is not supported by the "Bulk Extract Briefcase Export" operation.
• TIE_bulk_extract_invalid_target_site_option if the operation "Bulk Extract Briefcase Export" with a target site is not allowed. Remove the target site option.
• SA_not_a_system_administrator if the current user is not a system administrator
• PIE_transferoptionset_not_found if option_set_tag could not be found

Parameters

reason	(I) The Reason for export. This can be a null pointer.
n_objects	(I) The number of objects to be exported.
object_tags	(I) n_objects Objects to be exported.
n_sites	(I) The number of sites to which objects are to be exported.
sites	(I) n_sites Sites to which objects are to be exported.
option_set_tag	(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 Options whose values need to different than in "TransferOptionSet". Some of the valid values are: opt_nx_ds (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
n_session_options	(I) The number of session options
session_option_names	(I) n_session_options Session option names Some of the valid values are: modified_objects_only (True/False) continue_on_error (True/False) unmanaged (True/False) offline (True/False) transfer_site_ownership (True/False) objsForOwnXfer (object tags) offline_create_tcxml_dataset (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
briefcase_dataset_tag	(O) Tag of the dataset representing exported briefcase.
offline_file_name	(OF) File name of the exported briefcase.
n_export_log_files	(O) The number of log files
export_log_files	(OF) n_export_log_files Log files.

GMS_API int GMS_identify_outdated_replica_objects	(	int	replicasite,
		int	numOfInputObjects,
		tag_t *	objList,
		int *	numberOfOutdatedObjects,
		tag_t **	statusObjects
	)

This API finds modifed objects given a list of object tags. an object is considered as out-dated : If it is first time to export, no export record exists. If object is modified since last export.

GMS_API int GMS_import_objects_from_offline_package	(	const char *	offline_file_name,
		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,
		char **	log_file_fmsticket,
		char **	error_file_fmsticket
	)

GMS_API int GMS_import_objects_from_offline_package_with_new_objects	(	const char *	offline_file_name,
		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,
		char **	log_file_fmsticket,
		char **	error_file_fmsticket,
		int *	n_new_objects,
		tag_t **	new_objects
	)

Imports objects from the Offline Package and retrieves the number of newly created objects as well as their tags.

Returns

• ITK_ok on success
• TIE_bulk_load_not_test_env if the site is not configured as a "test environment". The "Bulk Load Briefcase Import" operations can only be run in "test environment"-configured sites.
• TIE_bulk_load_invalid_bcz if an invalid briefcase is provided to the "Bulk Load Briefcase Import" operation. It must have been generated by the "Bulk Extract Briefcase Export" operation.
• TIE_bc_export_import_req_multisite_license if no Multi-Site license (key: multisite_server) is available to export to, or import from, the offline site. Please obtain the license and try again.
• GMS_briefcase_type_import_not_allowed if the source site definition in the DB and in the briefcase creation type do not match. Therefore the briefcase import is not allowed.

Parameters

offline_file_name	(I) Offline file name
option_set_tag	(I) Optionset tag
n_options	(I) Number of options
option_names	(I) Array of all the option set options names and values as indicated by the user
option_values	(I) Option names values
n_session_options	(I) Number of session options
session_option_names	(I) Array of all the session option names (options which are not part of the option set) and values as indicated by the user
session_option_values	(I) Session option values
log_file_fmsticket	(OF) Log file fms ticket
error_file_fmsticket	(OF) Error file fms ticket
n_new_objects	(O) Number of newly created objects
new_objects	(OF) n_new_objects Newly created objects

GMS_API int GMS_synchronize_site	(	int	replicaSite,
		int	numOfClasses,
		char **	classNames,
		int	numOfObjectHandles,
		tag_t *	objectHandlesList,
		int *	numOfObjectsToExport,
		tag_t **	objectsToExport
	)