Data Structures
struct	SA_user_profile_props_s

Typedefs
typedef struct SA_user_profile_props_s	SA_user_profile_props_t

Functions
SA_API int	SA_ask_os_user_name (tag_t user, char os_user_name[SA_name_size_c+1])

SA_API int	SA_ask_os_user_name2 (tag_t user, char **os_user_name)

SA_API int	SA_ask_user_citizenships (tag_t user, int n_citizenships, char **citizenships)

SA_API int	SA_ask_user_declared_geography (tag_t user, char **geography)

SA_API int	SA_ask_user_default_local_volume (tag_t user, char volume_name[SA_volume_name_size_c+1])

SA_API int	SA_ask_user_default_local_volume2 (tag_t user, char **volume_name)

SA_API int	SA_ask_user_default_volume (tag_t user, char volume_name[SA_volume_name_size_c+1])

SA_API int	SA_ask_user_default_volume2 (tag_t user, char **volume_name)

SA_API int	SA_ask_user_geography (tag_t user, char geography[SA_geography_size_c+1])

SA_API int	SA_ask_user_geography2 (tag_t user, char **geography)

SA_API int	SA_ask_user_gov_clearance (tag_t user, char gov_clearance[SA_gov_clearance_size_c+1])

SA_API int	SA_ask_user_gov_clearance2 (tag_t user, char **gov_clearance)

SA_API int	SA_ask_user_home_folder (tag_t user, tag_t *folder)

SA_API int	SA_ask_user_identifier (tag_t user, char user_id[SA_user_size_c+1])

SA_API int	SA_ask_user_identifier2 (tag_t user, char **user_id)

SA_API int	SA_ask_user_ip_clearance (tag_t user, char ip_clearance[SA_ip_clearance_size_c+1])

SA_API int	SA_ask_user_ip_clearance2 (tag_t user, char **ip_clearance)

SA_API int	SA_ask_user_login_group (tag_t user, tag_t *group)

SA_API int	SA_ask_user_mailbox (tag_t user, tag_t *folder)

SA_API int	SA_ask_user_nationality (tag_t user, char nationality[SA_nationality_size_c+1])

SA_API int	SA_ask_user_nationality2 (tag_t user, char **nationality)

SA_API int	SA_ask_user_newstuff_folder (tag_t user, tag_t *folder)

SA_API int	SA_ask_user_person (tag_t user, tag_t *person)

SA_API int	SA_ask_user_person_name (tag_t user, char person_name[SA_person_name_size_c+1])

SA_API int	SA_ask_user_person_name2 (tag_t user, char **person_name)

SA_API int	SA_ask_user_sponsorability (tag_t user, int *sponsorable)

SA_API int	SA_ask_user_ttc_date (tag_t user, date_t *ttc_date)

SA_API int	SA_ask_user_vis_license_level (tag_t user, int *vis_license_level)

SA_API int	SA_change_user_password (tag_t user, const char new_password[SA_password_size_c+1], const char old_password[SA_password_size_c+1])

SA_API int	SA_change_user_password2 (tag_t user, const char new_password, const char old_password)

SA_API int	SA_create_licensed_user (const char user_id[SA_user_size_c+1], const char person_name[SA_person_name_size_c+1], const char password[SA_password_size_c+1], int license_level, int user_status, tag_t *user)

SA_API int	SA_create_licensed_user2 (const char user_id, const char person_name, const char password, int license_level, int user_status, tag_t user)

SA_API int	SA_create_licensed_user3 (const char user_id, const char person_name, const char password, int license_level, const char license_bundle, int user_status, tag_t *user)

SA_API int	SA_create_user (const char user_id[SA_user_size_c+1], const char person_name[SA_person_name_size_c+1], const char password[SA_password_size_c+1], tag_t *user)

SA_API int	SA_create_user2 (const char user_id, const char person_name, const char password, tag_t user)

SA_API int	SA_create_user_with_license_information (const char user_id, const char person_name, const char password, int license_level, const char license_bundle, const char license_server, int user_status, tag_t user)

SA_API int	SA_delete_user (tag_t user, tag_t new_owning_user, tag_t new_owning_group, logical delete_objects)

SA_API int	SA_delete_user_objects (tag_t user)

SA_API int	SA_extent_active_user (int n_users, tag_t *users)

SA_API int	SA_extent_user (int n_users, tag_t *users)

SA_API int	SA_find_user (const char user_id[SA_user_size_c+1], tag_t *user)

SA_API int	SA_find_user2 (const char user_id, tag_t user)

SA_API int	SA_find_user_objects (tag_t user, int n_objects, tag_t *objects)

SA_API int	SA_get_mapped_user_attr_list (int n_attributes, char **list)

SA_API int	SA_get_user_data_source (const tag_t user, int *data_source)

SA_API int	SA_get_user_last_sync_date (const tag_t user, date_t *sync_date)

SA_API int	SA_get_user_status (const tag_t user, int *status)

SA_API int	SA_initialize_user (tag_t user, const char user_id[SA_user_size_c+1], const char person_name[SA_person_name_size_c+1], const char password[SA_password_size_c+1])

SA_API int	SA_initialize_user2 (tag_t user, const char user_id, const char person_name, const char *password)

SA_API int	SA_set_os_user_name (tag_t user, char os_user_name[SA_name_size_c+1])

SA_API int	SA_set_os_user_name2 (tag_t user, const char *os_user_name)

SA_API int	SA_set_user_citizenships (tag_t user, int n_citizenships, const char **citizenships)

SA_API int	SA_set_user_data_source (const tag_t user, int data_source)

SA_API int	SA_set_user_declared_geography (tag_t user, const char *geography)

SA_API int	SA_set_user_default_local_volume (tag_t user, const char volume_name[SA_volume_name_size_c+1])

SA_API int	SA_set_user_default_local_volume2 (tag_t user, const char *volume_name)

SA_API int	SA_set_user_default_volume (tag_t user, const char volume_name[SA_volume_name_size_c+1])

SA_API int	SA_set_user_default_volume2 (tag_t user, const char *volume_name)

SA_API int	SA_set_user_geography (tag_t user, const char *geography)

SA_API int	SA_set_user_gov_clearance (tag_t user, const char *gov_clearance)

SA_API int	SA_set_user_identifier (tag_t user, const char user_id[SA_user_size_c+1])

SA_API int	SA_set_user_identifier2 (tag_t user, const char *user_id)

SA_API int	SA_set_user_ip_clearance (tag_t user, const char *ip_clearance)

SA_API int	SA_set_user_last_sync_date (const tag_t user, date_t sync_date)

SA_API int	SA_set_user_license_status (tag_t user, int user_status, int license_level, const char license_bundle, int purchased, int used, int purchased_bundles, int *used_bundles)

SA_API int	SA_set_user_license_status_with_server (tag_t user, int user_status, int license_level, const char license_bundle, const char license_server, int purchased, int used, int purchased_bundles, int used_bundles)

SA_API int	SA_set_user_login_group (tag_t user, tag_t group)

SA_API int	SA_set_user_nationality (tag_t user, const char *nationality)

SA_API int	SA_set_user_person (tag_t user, tag_t person)

SA_API int	SA_set_user_profile_attributes (tag_t user, int n_profile_props, const SA_user_profile_props_t *profile_props)

SA_API int	SA_set_user_sponsorability (tag_t user, int sponsorable)

SA_API int	SA_set_user_status (const tag_t user, int new_status)

SA_API int	SA_set_user_ttc_date (tag_t user, date_t ttc_date)

SA_API int	SA_set_user_vis_license_level (tag_t user, int vis_license_level)

Detailed Description

Typedef Documentation

typedef struct SA_user_profile_props_s SA_user_profile_props_t

Structure that holds property name and value(s) of the additional properties of User object that are defined on Fnd0CustomUserProfile

Function Documentation

SA_API int SA_ask_os_user_name	(	tag_t	user,
		char	os_user_name[SA_name_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_ask_os_user_name2

Returns the value of the OS user name attribute for a user.

Parameters

user	(I)
os_user_name	(O)

SA_API int SA_ask_os_user_name2	(	tag_t	user,
		char **	os_user_name
	)

Returns the value of the OS user name attribute for a user.

Parameters

user	(I)
os_user_name	(OF)

SA_API int SA_ask_user_citizenships	(	tag_t	user,
		int *	n_citizenships,
		char ***	citizenships
	)

Retrieves user citizenships

Returns

ITK_ok on success
SA_no_privilege_for_citizenship if the login user is not system admin or user himself.
PROP_invalid_object if user is not valid User tag.

Parameters

user	(I) The tag of the user whose citizenship is to be retrieved.
n_citizenships	(O) Number of citizenships
citizenships	(OF) n_citizenships The citizenships

SA_API int SA_ask_user_declared_geography	(	tag_t	user,
		char **	geography
	)

Retrieves the value of "User Declared Geography" attribute of the Teamcenter user.

Returns

ITK_ok on success.
SA_Invalid_User if user is not a valid user.

Parameters

user	(I) The user for which the user declared geography is being set.
geography	(OF) The country code of the country representaed in ISO 3166 format. Or an empty string (i.e. "") if the given user has not declared georaphical location via SA_set_user_declared_geography far.

SA_API int SA_ask_user_default_local_volume	(	tag_t	user,
		char	volume_name[SA_volume_name_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_ask_user_default_local_volume2

Returns the default local volume name attribute for the user.

Parameters

user	(I)
volume_name	(O)

SA_API int SA_ask_user_default_local_volume2	(	tag_t	user,
		char **	volume_name
	)

Returns the default local volume name attribute for the user.

Parameters

user	(I)
volume_name	(OF)

SA_API int SA_ask_user_default_volume	(	tag_t	user,
		char	volume_name[SA_volume_name_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_ask_user_default_volume2

Returns the default volume name attribute for the user.

Parameters

user	(I)
volume_name	(O)

SA_API int SA_ask_user_default_volume2	(	tag_t	user,
		char **	volume_name
	)

Returns the default volume name attribute for the user.

Parameters

user	(I)
volume_name	(OF)

SA_API int SA_ask_user_geography	(	tag_t	user,
		char	geography[SA_geography_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_ask_user_geography2

Returns the value of the geography attribute of a Teamcenter user.

Parameters

user	(I)
geography	(O)

SA_API int SA_ask_user_geography2	(	tag_t	user,
		char **	geography
	)

Returns the value of the geography attribute of a Teamcenter user.

Parameters

user	(I)
geography	(OF)

SA_API int SA_ask_user_gov_clearance	(	tag_t	user,
		char	gov_clearance[SA_gov_clearance_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_ask_user_gov_clearance2

Returns the value of the Government clearance attribute of a Teamcenter user.

Parameters

user	(I)
gov_clearance	(O)

SA_API int SA_ask_user_gov_clearance2	(	tag_t	user,
		char **	gov_clearance
	)

Returns the value of the Government clearance attribute of a Teamcenter user.

Parameters

user	(I)
gov_clearance	(OF)

SA_API int SA_ask_user_home_folder	(	tag_t	user,
		tag_t *	folder
	)

Returns the value of the home folder attribute for a user.
The home folder was implicitly created when you created the user.

Parameters

user	(I)
folder	(O)

SA_API int SA_ask_user_identifier	(	tag_t	user,
		char	user_id[SA_user_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_ask_user_identifier2

Returns the value of the identifier attribute for a user.

Parameters

user	(I)
user_id	(O)

SA_API int SA_ask_user_identifier2	(	tag_t	user,
		char **	user_id
	)

Returns the value of the identifier attribute for a user.

Parameters

user	(I)
user_id	(OF)

SA_API int SA_ask_user_ip_clearance	(	tag_t	user,
		char	ip_clearance[SA_ip_clearance_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_ask_user_ip_clearance2

Returns the value of the IP (Intellectual Property) clearance attribute of a Teamcenter user.

Parameters

user	(I)
ip_clearance	(O)

SA_API int SA_ask_user_ip_clearance2	(	tag_t	user,
		char **	ip_clearance
	)

Returns the value of the IP (Intellectual Property) clearance attribute of a Teamcenter user.

Parameters

user	(I)
ip_clearance	(OF)

SA_API int SA_ask_user_login_group	(	tag_t	user,
		tag_t *	group
	)

Returns the default login group attribute for the user.

Parameters

user	(I)
group	(O)

SA_API int SA_ask_user_mailbox	(	tag_t	user,
		tag_t *	folder
	)

Returns the value of the mailbox tag attribute for this user.
The mailbox was implicitly created when you created the user.

Parameters

user	(I)
folder	(O)

SA_API int SA_ask_user_nationality	(	tag_t	user,
		char	nationality[SA_nationality_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_ask_user_nationality2

Returns the value of the nationality attribute of a Teamcenter user.

Parameters

user	(I)
nationality	(O)

SA_API int SA_ask_user_nationality2	(	tag_t	user,
		char **	nationality
	)

Returns the value of the nationality attribute of a Teamcenter user.

Parameters

user	(I)
nationality	(OF)

SA_API int SA_ask_user_newstuff_folder	(	tag_t	user,
		tag_t *	folder
	)

Returns the value of the newstuff folder tag attribute for this user.
The mailbox was implicitly created when you created the user.

Parameters

user	(I)
folder	(O)

SA_API int SA_ask_user_person	(	tag_t	user,
		tag_t *	person
	)

Returns the value of person attribute for a user.

Parameters

user	(I)
person	(O)

SA_API int SA_ask_user_person_name	(	tag_t	user,
		char	person_name[SA_person_name_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_ask_user_person_name2

Returns the value of the name attribute for a user.

Parameters

user	(I)
person_name	(O)

SA_API int SA_ask_user_person_name2	(	tag_t	user,
		char **	person_name
	)

Returns the value of the name attribute for a user.

Parameters

user	(I)
person_name	(OF)

SA_API int SA_ask_user_sponsorability	(	tag_t	user,
		int *	sponsorable
	)

Retrieves the value of sponsorable attribute of the Teamcenter user.
If the value is 1, the user can be used for sponsored authentication.

Returns

ITK_ok on success.
SA_Invalid_User if the given user is invalid.

Parameters

user	(I) Tag of an existing user
sponsorable	(O) Sponsorable flag of given user

SA_API int SA_ask_user_ttc_date	(	tag_t	user,
		date_t *	ttc_date
	)

Returns the value of the ttc_date (technology transfer certification date) attribute of a Teamcenter user.

Parameters

user	(I)
ttc_date	(O)

SA_API int SA_ask_user_vis_license_level	(	tag_t	user,
		int *	vis_license_level
	)

Retrieves the value of "VIS License Level" attribute for the Teamcenter user.

Returns

ITK_ok on success.
SA_Invalid_User if user is not a valid user.

Parameters

user	(I) The user for which the VIS license level is requested.
vis_license_level	(O) The VIS License Level.

SA_API int SA_change_user_password	(	tag_t	user,
		const char	new_password[SA_password_size_c+1],
		const char	old_password[SA_password_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_change_user_password2

Changes the password attribute of the user. You must be logged in as the user referenced by user to change the password.
The system administrator can also change the password.

Parameters

user	(I)
new_password	(I)
old_password	(I)

SA_API int SA_change_user_password2	(	tag_t	user,
		const char *	new_password,
		const char *	old_password
	)

Changes the password attribute of the user. You must be logged in as the user referenced by user to change the password.
The system administrator can also change the password.

Parameters

user	(I)
new_password	(I)
old_password	(I)

SA_API int SA_create_licensed_user	(	const char	user_id[SA_user_size_c+1],
		const char	person_name[SA_person_name_size_c+1],
		const char	password[SA_password_size_c+1],
		int	license_level,
		int	user_status,
		tag_t *	user
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_create_licensed_user2

Creates a User object. It is not saved to the database until an explicit call to AOM_save occurs. You must specify the user_id, person_name, password, license_level and status for the user. The valid values for licenseLevel are 'author' = 0,'consumer' = 1, 'occasionaluser' = 2. The valid values for status are 'active' = 0 or 'inactive' = 1. You must also specify the login group and OS user name by calling SA_set_user_login_group and SA_set_os_user_name.

Restrictions:
This function is only valid when you are logged in as the system administrator.

Parameters

user_id	(I)
person_name	(I)
password	(I)
license_level	(I)
user_status	(I)
user	(O)

SA_API int SA_create_licensed_user2	(	const char *	user_id,
		const char *	person_name,
		const char *	password,
		int	license_level,
		int	user_status,
		tag_t *	user
	)

Creates a User object.
It is not saved to the database until an explicit call to AOM_save occurs.
You must specify the user_id, person_name, password, license_level and status for the user.
The valid values for licenseLevel are 'author' = 0,'consumer' = 1, 'occasionaluser' = 2. The valid values for status are 'active' = 0 or 'inactive' = 1.
You must also specify the login group and OS user name by calling SA_set_user_login_group and SA_set_os_user_name.

Restrictions:
This function is only valid when you are logged in as the system administrator.

Parameters

user_id	(I)
person_name	(I)
password	(I)
license_level	(I)
user_status	(I)
user	(O)

SA_API int SA_create_licensed_user3	(	const char *	user_id,
		const char *	person_name,
		const char *	password,
		int	license_level,
		const char *	license_bundle,
		int	user_status,
		tag_t *	user
	)

Creates a User object.
It is not saved to the database until an explicit call to AOM_save occurs.
The login group and OS user name must be specified by calling the ITKs SA_set_user_login_group and SA_set_os_user_name.

This function validates that the specified status, license level, and license bundle are valid and that

the user may be created with these values. It sets the status and license level properties for the unsaved User object, but the license bundle property must be set by calling SA_set_user_license_status after SA_create_licensed_user3 and AOM_save.

A purchased license bundle may include a base license level. If the license_level parameter does not match the license level contained in the specified bundle, the user's license level is set to the level contained in the bundle.

Returns

ITK_ok on success
SA_Invalid_User if the user id is invalid
ITK_invalid_licensebundle_name if the license bundle name is invalid
ITK_insufficient_licensebundles if there are not enough available license bundles
SA_not_a_system_administrator if the caller is not an administrator

Note: This function is only valid when you are logged in as the system administrator.

Parameters

user_id	(I) The user ID
person_name	(I) The person name
password	(I) The login password
license_level	(I) The license level. Valid values are 0: author 1: consumer 2: occasional user
license_bundle	(I) The license bundle. This should be a valid bundle name or null.
user_status	(I) The user status. Valid values are 0: active 1: inactive
user	(O) The newly created user

SA_API int SA_create_user	(	const char	user_id[SA_user_size_c+1],
		const char	person_name[SA_person_name_size_c+1],
		const char	password[SA_password_size_c+1],
		tag_t *	user
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_create_user2

Creates a User object with 'active' status and 'author' license level. It is not saved to the database until an explicit call to AOM_save occurs. You must specify the user_id, person_name and password. You must also specify the login group and OS user name by calling SA_set_user_login_group and SA_set_os_user_name.

Restrictions: This function is only valid when you are logged in as the system administrator.

Parameters

user_id	(I)
person_name	(I)
password	(I)
user	(O)

SA_API int SA_create_user2	(	const char *	user_id,
		const char *	person_name,
		const char *	password,
		tag_t *	user
	)

Creates a User object with 'active' status and 'author' license level.
It is not saved to the database until an explicit call to AOM_save occurs.
You must specify the user_id, person_name and password.
You must also specify the login group and OS user name by calling SA_set_user_login_group and SA_set_os_user_name.

Restrictions: This function is only valid when you are logged in as the system administrator.

Parameters

user_id	(I)
person_name	(I)
password	(I)
user	(O)

SA_API int SA_create_user_with_license_information	(	const char *	user_id,
		const char *	person_name,
		const char *	password,
		int	license_level,
		const char *	license_bundle,
		const char *	license_server,
		int	user_status,
		tag_t *	user
	)

Creates a User object.
It is not saved to the database until an explicit call to AOM_save occurs.
The login group and OS user name must be specified by calling the ITKs SA_set_user_login_group and SA_set_os_user_name.

This function validates that the specified status, license server, license level, and license bundle are valid and that the user may be created with these values. It sets the status and license level properties for the unsaved User object, but the license bundle property must be set by calling SA_set_user_license_status after SA_create_user_with_license_information and AOM_save.

A purchased license bundle may include a base license level. If the license_level parameter does not match the license level contained in the specified bundle, the user's license level is set to the level contained in the bundle.

Returns

ITK_ok on success
SA_Invalid_User if the user id is invalid
ITK_invalid_licensebundle_name if the license bundle name is invalid
ITK_insufficient_licensebundles if there are not enough available license bundles
SA_not_a_system_administrator if the caller is not an administrator

Note: This function is only valid when you are logged in as the system administrator.

Parameters

user_id	(I) The user id
person_name	(I) The person name
password	(I) The login password
license_level	(I) The license level. Valid values are 0: author 1: consumer 2: occasional user
license_bundle	(I) The license bundle. This should be a valid bundle name or null.
license_server	(I) The license server. This should be a valid server name or null.
user_status	(I) The user status. Valid values are 0: active 1: inactive
user	(O) The newly created user

SA_API int SA_delete_user	(	tag_t	user,
		tag_t	new_owning_user,
		tag_t	new_owning_group,
		logical	delete_objects
	)

new_owning_user and new_owning_group may be NULLTAG, provided delete_objects is true

Parameters

user	(I)
new_owning_user	(I)
new_owning_group	(I)
delete_objects	(I)

SA_API int SA_delete_user_objects ( tag_t user )

Deprecated:: It will be removed from Tc9.
Use SA_delete_user instead.

Deletes the specified user's objects. This function provides a means to delete all the objects belonging to a user. If objects cannot be deleted because they are referenced by another user, then the object's ownership is changed to the current logged in user; this frees the user object for deletion. This function does not delete the User. You must call AOM_delete to delete the user.

Restrictions:
You must be the system administrator to call this function.
Otherwise, returns an integer error code.

Parameters

user (I)

SA_API int SA_extent_active_user	(	int *	n_users,
		tag_t **	users
	)

This suppresses deactivated users from the list

Parameters

n_users	(O) Number of users
users	(OF) n_users Users

SA_API int SA_extent_user	(	int *	n_users,
		tag_t **	users
	)

Allocates an array of tags and stores in the array all users in the database.

Parameters

n_users	(O) Number of users
users	(OF) n_users Users in the database

SA_API int SA_find_user	(	const char	user_id[SA_user_size_c+1],
		tag_t *	user
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_find_user2

Finds a user with the specified user_id. The user_id is unique in the database.
If user_id does not exist, user will be NULLTAG.

Note: This ITK is NOT case sensitive in regards to user ID.

Parameters

user_id	(I)
user	(O)

SA_API int SA_find_user2	(	const char *	user_id,
		tag_t *	user
	)

Finds a user with the specified user_id. The user_id is unique in the database.
If user_id does not exist, user will be NULLTAG.

Note: This ITK is NOT case sensitive in regards to user ID.

Parameters

user_id	(I)
user	(O)

SA_API int SA_find_user_objects	(	tag_t	user,
		int *	n_objects,
		tag_t **	objects
	)

Allocates an array of tags and stores in the array all tags of objects owned by the specified user.

Parameters

user	(I)
n_objects	(O) Stores the size of the array
objects	(OF) n_objects Points to the array of tags

SA_API int SA_get_mapped_user_attr_list	(	int *	n_attributes,
		char ***	list
	)

Returns the list of mapped attributes for a user.

Parameters

n_attributes	(O)
list	(OF) n_attributes

SA_API int SA_get_user_data_source	(	const tag_t	user,
		int *	data_source
	)

Returns the user data source.

Parameters

user	(I)
data_source	(O)

SA_API int SA_get_user_last_sync_date	(	const tag_t	user,
		date_t *	sync_date
	)

Returns the user last sync date.

Parameters

user	(I)
sync_date	(O)

SA_API int SA_get_user_status	(	const tag_t	user,
		int *	status
	)

Returns the user status.

Parameters

user	(I)
status	(O)

SA_API int SA_initialize_user	(	tag_t	user,
		const char	user_id[SA_user_size_c+1],
		const char	person_name[SA_person_name_size_c+1],
		const char	password[SA_password_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_initialize_user2

Initializes a User object. It is not saved to the database until an explicit call to POM_save occurs.
You must specify the user_id, person_name and password.

You normally use this function with a subclass of User.
For example, if you defined a class special User, you would first call POM_create_instance to create the object in memory.
Then you would use this function to initialize the attributes which were inherited from User.
Finally, you would use additional POM calls to initialize the attributes comprising your specialization of User.

Restrictions: This function is only valid when you are logged in as the system administrator.

Parameters

user	(I)
user_id	(I)
person_name	(I)
password	(I)

SA_API int SA_initialize_user2	(	tag_t	user,
		const char *	user_id,
		const char *	person_name,
		const char *	password
	)

Initializes a User object. It is not saved to the database until an explicit call to POM_save occurs.
You must specify the user_id, person_name and password.

You normally use this function with a subclass of User.
For example, if you defined a class special User, you would first call POM_create_instance to create the object in memory.
Then you would use this function to initialize the attributes which were inherited from User.
Finally, you would use additional POM calls to initialize the attributes comprising your specialization of User.

Restrictions: This function is only valid when you are logged in as the system administrator.

Parameters

user	(I)
user_id	(I)
person_name	(I)
password	(I)

SA_API int SA_set_os_user_name	(	tag_t	user,
		char	os_user_name[SA_name_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_set_os_user_name2

Sets the operating system user name attribute of a Teamcenter Engineering user.

Parameters

user	(I)
os_user_name	(I)

SA_API int SA_set_os_user_name2	(	tag_t	user,
		const char *	os_user_name
	)

Sets the operating system user name attribute of a Teamcenter Engineering user.

Parameters

user	(I)
os_user_name	(I)

SA_API int SA_set_user_citizenships	(	tag_t	user,
		int	n_citizenships,
		const char **	citizenships
	)

Sets user citizenships.

Note: If the number of citizenships is zero, it will empty user citizenships.

Returns

ITK_ok on success
SA_invalid_citizenship will returned if each citizenship is not two-letter string.
PROP_invalid_object will be returned if user input tag is not valid User tag.

Parameters

user	(I) The tag of the user to whom the citizenships are to be set
n_citizenships	(I) The number of citizenships.
citizenships	(I) n_citizenships Citizenships to be set to the user

SA_API int SA_set_user_data_source	(	const tag_t	user,
		int	data_source
	)

Sets the data source for the user

Parameters

user	(I)
data_source	(I)

SA_API int SA_set_user_declared_geography	(	tag_t	user,
		const char *	geography
	)

Sets the value of "User Declared Geography" attribute of the Teamcenter user.
Appropriate values for geography are two-character codes from ISO 3166. NULL value is allowed for user declared geography, if the value is NULL then the default value is considered to be an empty string (i.e. "").

Returns

ITK_ok on success.
SA_Invalid_User if user is not a valid user.
SA_no_system_admin_for_user_property if user is neither the System Administrator nor same as that of the logged in user.

Parameters

user	(I) The user for which the user declared geography is being set.
geography	(I) The country code of the country representaed in ISO 3166 format. NULL value is allowed for user declared geography, if the value is NULL then the default value is considered to be an empty string (i.e. "")

SA_API int SA_set_user_default_local_volume	(	tag_t	user,
		const char	volume_name[SA_volume_name_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_set_user_default_local_volume2

Sets the default local volume name attribute of the user.

Restrictions:

Parameters

user	(I)
volume_name	(I)

SA_API int SA_set_user_default_local_volume2	(	tag_t	user,
		const char *	volume_name
	)

Sets the default local volume name attribute of the user.

Restrictions:

Parameters

user	(I)
volume_name	(I)

SA_API int SA_set_user_default_volume	(	tag_t	user,
		const char	volume_name[SA_volume_name_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_set_user_default_volume2

Sets the default volume name attribute of the user.

Restrictions:

Parameters

user	(I)
volume_name	(I)

SA_API int SA_set_user_default_volume2	(	tag_t	user,
		const char *	volume_name
	)

Sets the default volume name attribute of the user.

Restrictions:

Parameters

user	(I)
volume_name	(I)

SA_API int SA_set_user_geography	(	tag_t	user,
		const char *	geography
	)

Sets the geography attribute of a Teamcenter user.

Parameters

user	(I)
geography	(I)

SA_API int SA_set_user_gov_clearance	(	tag_t	user,
		const char *	gov_clearance
	)

Sets the Government clearance attribute of a Teamcenter user.

Parameters

user	(I)
gov_clearance	(I)

SA_API int SA_set_user_identifier	(	tag_t	user,
		const char	user_id[SA_user_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_set_user_identifier2

Sets the user identifier attribute of the user.

Parameters

user	(I)
user_id	(I)

SA_API int SA_set_user_identifier2	(	tag_t	user,
		const char *	user_id
	)

Sets the user identifier attribute of the user.

Parameters

user	(I)
user_id	(I)

SA_API int SA_set_user_ip_clearance	(	tag_t	user,
		const char *	ip_clearance
	)

Sets the IP (Intellectual Property) clearance attribute of a Teamcenter user.

Parameters

user	(I)
ip_clearance	(I)

SA_API int SA_set_user_last_sync_date	(	const tag_t	user,
		date_t	sync_date
	)

Sets the data source for the user

Parameters

user	(I)
sync_date	(I)

SA_API int SA_set_user_license_status	(	tag_t	user,
		int	user_status,
		int	license_level,
		const char *	license_bundle,
		int *	purchased,
		int *	used,
		int *	purchased_bundles,
		int *	used_bundles
	)

Sets the license level, license bundle and status of the desired user.
The number of purchased and used licenses for specified license_level and license_bundle are returned.

Returns

SA_Invalid_User if the user id is invalid
SA_low_on_available_licenses if the number of available licenses are less than the threshold value set by license_warning_level preference
SA_low_on_available_license_bundles if the number of available licenses in the bundle are less than the threshold value set by license_warning_level preference
ITK_invalid_licensebundle_name if the license bundle name is invalid
ITK_mismatch_in_license_level if the desired user license level does not match with the one present in the license bundle
ITK_insufficient_licensebundles if there are not enough number of license bundles
SA_not_a_system_administrator if the caller is not an administrator

Note: This function is only valid when you are logged in as the system administrator.

Parameters

user	(I) An existing user
user_status	(I) The user status. Valid values are 0: active 1: inactive
license_level	(I) The license level. Valid values are 0: author 1: consumer 2: occasional user
license_bundle	(I) The license bundle. This should be a valid bundle name or null.
purchased	(O) Number of purchased licenses
used	(O) Number of used licenses
purchased_bundles	(O) Number of purchased bundles
used_bundles	(O) Number of used bundles

SA_API int SA_set_user_license_status_with_server	(	tag_t	user,
		int	user_status,
		int	license_level,
		const char *	license_bundle,
		const char *	license_server,
		int *	purchased,
		int *	used,
		int *	purchased_bundles,
		int *	used_bundles
	)

Sets the license level, license bundle and status of the desired user.
The caller must be a Teamcenter system administrator.
The number of purchased and used licenses for license_level and license_bundle are returned.

Returns

SA_Invalid_User if the user id is invalid
SA_low_on_available_licenses if the number of available licenses are less than the threshold value set by license_warning_level preference
SA_low_on_available_license_bundles if the number of available licenses in the bundle are less than the threshold value set by license_warning_level preference
ITK_invalid_licensebundle_name if the license bundle name is invalid
ITK_mismatch_in_license_level if the desired user license level does not match with the one present in the license bundle
ITK_insufficient_licensebundles if there are not enough number of license bundles

Parameters

user	(I) An existing user
user_status	(I) The user status. Valid values are 0: active 1: inactive
license_level	(I) The license level. Valid values are 0: author 1: consumer 2: occasional user
license_bundle	(I) The license bundle. This should be a valid bundle name or null.
license_server	(I) The license server. This should be a valid server name or null
purchased	(O) Number of purchased licenses
used	(O) Number of used licenses
purchased_bundles	(O) Number of purchased bundles
used_bundles	(O) Number of used bundles

SA_API int SA_set_user_login_group	(	tag_t	user,
		tag_t	group
	)

Sets the default login group attribute of the user.

Parameters

user	(I)
group	(I)

SA_API int SA_set_user_nationality	(	tag_t	user,
		const char *	nationality
	)

Sets the nationality attribute of a Teamcenter user.

Parameters

user	(I)
nationality	(I)

SA_API int SA_set_user_person	(	tag_t	user,
		tag_t	person
	)

Sets the person attribute of the user.

Parameters

user	(I)
person	(I)

SA_API int SA_set_user_profile_attributes	(	tag_t	user,
		int	n_profile_props,
		const SA_user_profile_props_t *	profile_props
	)

Creates a Custom User Profile for the given user if it does not already exist.
This ITK can also be used to modify the properties of an existing Custom User Profile.

It validates that the specified properties are valid and that the Custom User Profile may be created with these values. It also sets the property fnd0custom_user_profile on the User object with newly created Custom User Profile.

Custom User profiles enable customers to define custom properties on User objects. The custom properties of User should be defined on the Fnd0CustomUserProfile business object to see them on any of the Teamcenter client interfaces.

Returns

ITK_ok on success.
SA_Invalid_User if the given user is invalid.
SA_invalid_custom_user_profile_property if the supplied Fnd0CustomUserProfile properties are invalid.
SA_invalid_custom_user_profile_value if the supplied values for the Fnd0CustomUserProfile properties are invalid.

Restrictions: This function only supports setting of primitive property types.

Parameters

user	(I) Tag of an existing user
n_profile_props	(I) Number of profile properties
profile_props	(I) n_profile_props Custom User Profile properties

SA_API int SA_set_user_sponsorability	(	tag_t	user,
		int	sponsorable
	)

Sets the sponsorable attribute of a Teamcenter user.
The value is set to 0 at the time of the user creation.

Returns

ITK_ok on success.
SA_Invalid_User if the given user is invalid.

Parameters

user	(I) Tag of an existing user
sponsorable	(I) Value of Sponsorable flag to be set

SA_API int SA_set_user_status	(	const tag_t	user,
		int	new_status
	)

Sets the user status.

Parameters

user	(I)
new_status	(I)

SA_API int SA_set_user_ttc_date	(	tag_t	user,
		date_t	ttc_date
	)

Sets the ttc_date (technology transfer certification date) attribute of a Teamcenter user.

Parameters

user	(I)
ttc_date	(I)

SA_API int SA_set_user_vis_license_level	(	tag_t	user,
		int	vis_license_level
	)

Sets the value of "VIS License Level" attribute for the Teamcenter user.
The value is set to 0 (Base VIS License) at the time of the user creation.

Returns

ITK_ok on success.
SA_Invalid_User if user is not a valid user.
PROP_invalid_value if vis_license_level is not a valid Visualization License Level. The valid values for vis_license_level are 0 (base), 1 (standard), 2 (professional) or 3 (mockup).

Parameters

user	(I) The user for which the VIS license level is requested.
vis_license_level	(I) The VIS License Level.

Data Structures

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation