Modules
	Audit

	Audit Manager

	Discipline

	Group

	Group Member

	Teamcenter Volume Management

	Person

	Role

	Errors

	Site

	tccalendarevent

	Teamcenter File

	Teamcenter Volumes

	User

	WorkContext

Functions
SA_API int	SA_ask_h_group_pfile (const char group_name, char *file_name)

SA_API int	SA_ask_role_pfile (const char role_name[SA_name_size_c+1], char file_name[SS_MAXPATHLEN])

SA_API int	SA_ask_role_pfile2 (const char role_name, char *file_name)

SA_API int	SA_ask_user_home_site (tag_t user_tag, tag_t *home_site_tag)

SA_API int	SA_ask_user_pfile (const char user_id[SA_name_size_c+1], char file_name[SS_MAXPATHLEN])

SA_API int	SA_ask_user_pfile2 (const char user_id, char *file_name)

SA_API int	SA_ask_user_remote_sites_deny_login (tag_t user_tag, int n_remote_sites, tag_t *remote_sites)

SA_API int	SA_exit_module (void)

SA_API int	SA_init_module (void)

SA_API int	SA_read_am_rule_tree (const char *path_name, logical replace_acls)

SA_API int	SA_set_user_home_site (tag_t user_tag, tag_t home_site_tag)

SA_API int	SA_set_user_remote_sites_deny_login (tag_t user_tag, int n_remote_sites, tag_t *remote_sites)

SA_API int	SA_write_am_rule_tree (const char *path_name)

Defines that are common to Person, Group, and Role
#define	SA_name_size_c 32

#define	SA_group_name_size_c 128

#define	SA_person_name_size_c 128

#define	SA_discipline_name_size_c 128

#define	SA_description_size_c 240

#define	SA_full_path_size_c 240

Defines used by Person routines
#define	SA_state_size_c 2

#define	SA_address_size_c 64

#define	SA_city_size_c 32

#define	SA_zip_size_c 10

#define	SA_organization_size_c 32

#define	SA_phone_size_c 32

#define	SA_email_size_c 240

Defines used by Group routines
#define	SA_organization_name_size_c 250

#define	SA_organization_id_size_c 14

#define	SA_organization_type_size_c 4

#define	SA_organization_legal_name_size_c 250

#define	SA_organization_alternate_name_size_c 250

#define	SA_organization_address_size_c 1024

#define	SA_organization_url_size_c 1024

Defines used by User routines
#define	SA_password_size_c 32

#define	SA_user_size_c 32

#define	SA_site_size_c 32

#define	SA_volume_name_size_c 32

#define	SA_pref_code_size_c 32

#define	SA_pref_value_size_c 32

#define	SA_ip_clearance_size_c 128

#define	SA_gov_clearance_size_c 128

#define	SA_nationality_size_c 2

#define	SA_locale_size_c 5

#define	SA_timezone_size_c 32

#define	SA_geography_size_c 2

#define	SA_licenseserver_size_c 128

Defines used by Site routines
#define	SA_node_size_c 4000 /* To Accomodate URL */

Detailed Description

The primary purpose of the System Administration (SA) ITK module is to allow System Administrators to control and manage the access to the Teamcenter Engineering system.

You must use the include file sa.h with the functions in this section.

Common Return Values

CXPOM_invalid_tag - Invalid tag passed in

Macro Definition Documentation

#define SA_address_size_c 64

Definition at line 50 of file sa.h.

#define SA_city_size_c 32

Definition at line 51 of file sa.h.

#define SA_description_size_c 240

Definition at line 41 of file sa.h.

#define SA_discipline_name_size_c 128

Definition at line 40 of file sa.h.

#define SA_email_size_c 240

Definition at line 55 of file sa.h.

#define SA_full_path_size_c 240

Definition at line 42 of file sa.h.

#define SA_geography_size_c 2

Definition at line 86 of file sa.h.

#define SA_gov_clearance_size_c 128

Definition at line 82 of file sa.h.

#define SA_group_name_size_c 128

Definition at line 38 of file sa.h.

#define SA_ip_clearance_size_c 128

Definition at line 81 of file sa.h.

#define SA_licenseserver_size_c 128

Size of the license server name.

Definition at line 90 of file sa.h.

#define SA_locale_size_c 5

Definition at line 84 of file sa.h.

#define SA_name_size_c 32

Definition at line 37 of file sa.h.

#define SA_nationality_size_c 2

Definition at line 83 of file sa.h.

#define SA_node_size_c 4000 /* To Accomodate URL */

Definition at line 97 of file sa.h.

#define SA_organization_address_size_c 1024

Definition at line 67 of file sa.h.

#define SA_organization_alternate_name_size_c 250

Definition at line 66 of file sa.h.

#define SA_organization_id_size_c 14

Definition at line 63 of file sa.h.

#define SA_organization_legal_name_size_c 250

Definition at line 65 of file sa.h.

#define SA_organization_name_size_c 250

Definition at line 62 of file sa.h.

#define SA_organization_size_c 32

Definition at line 53 of file sa.h.

#define SA_organization_type_size_c 4

Definition at line 64 of file sa.h.

#define SA_organization_url_size_c 1024

Definition at line 68 of file sa.h.

#define SA_password_size_c 32

Definition at line 75 of file sa.h.

#define SA_person_name_size_c 128

Definition at line 39 of file sa.h.

#define SA_phone_size_c 32

Definition at line 54 of file sa.h.

#define SA_pref_code_size_c 32

Definition at line 79 of file sa.h.

#define SA_pref_value_size_c 32

Definition at line 80 of file sa.h.

#define SA_site_size_c 32

Definition at line 77 of file sa.h.

#define SA_state_size_c 2

Definition at line 49 of file sa.h.

#define SA_timezone_size_c 32

Definition at line 85 of file sa.h.

#define SA_user_size_c 32

Definition at line 76 of file sa.h.

#define SA_volume_name_size_c 32

Definition at line 78 of file sa.h.

#define SA_zip_size_c 10

Definition at line 52 of file sa.h.

Function Documentation

SA_API int SA_ask_h_group_pfile	(	const char *	group_name,
		char **	file_name
	)

Gets the name of the preference file corresponding to the named group.

Return Values:

SA_group_pfile_not_set - The site preference TC_GROUP_PFILE is not set.
SA_group_pfile_dir_bad - The site preference TC_GROUP_PFILE points to a non-existent directory.
SA_group_pfile_not_found - There is no preference file for the named group.

Parameters

group_name	(I) The name of the group
file_name	(OF) The name of the corresponding preference file

SA_API int SA_ask_role_pfile	(	const char	role_name[SA_name_size_c+1],
		char	file_name[SS_MAXPATHLEN]
	)

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

Parameters

role_name	(I)
file_name	(O)

SA_API int SA_ask_role_pfile2	(	const char *	role_name,
		char **	file_name
	)

Parameters

role_name	(I)
file_name	(OF)

SA_API int SA_ask_user_home_site	(	tag_t	user_tag,
		tag_t *	home_site_tag
	)

Parameters

user_tag	(I) The user tag
home_site_tag	(O) The home site tag

SA_API int SA_ask_user_pfile	(	const char	user_id[SA_name_size_c+1],
		char	file_name[SS_MAXPATHLEN]
	)

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

Parameters

user_id	(I)
file_name	(O)

SA_API int SA_ask_user_pfile2	(	const char *	user_id,
		char **	file_name
	)

Parameters

user_id	(I)
file_name	(OF)

SA_API int SA_ask_user_remote_sites_deny_login	(	tag_t	user_tag,
		int *	n_remote_sites,
		tag_t **	remote_sites
	)

Parameters

user_tag	(I) The user tag
n_remote_sites	(O) Number of remote sites
remote_sites	(OF) n_remote_sites The remote site tags

SA_API int SA_exit_module ( void )

Cleans up and exits the system administration module. You call this function after all SA activity is complete.

SA_API int SA_init_module ( void )

Initializes the system administration module. Call this function immediately before any other SA functions are called.

SA_API int SA_read_am_rule_tree	(	const char *	path_name,
		logical	replace_acls
	)

Read an AM rule tree from the given path, plus decide whether to overwrite existing ACLs. This function replaces any existing rule tree, and saves the new one.

Parameters

path_name	(I)
replace_acls	(I)

SA_API int SA_set_user_home_site	(	tag_t	user_tag,
		tag_t	home_site_tag
	)

Parameters

user_tag	(I) The user tag
home_site_tag	(I) The home site tag

SA_API int SA_set_user_remote_sites_deny_login	(	tag_t	user_tag,
		int	n_remote_sites,
		tag_t *	remote_sites
	)

Parameters

user_tag	(I) The user tag
n_remote_sites	(I) Number of remote sites
remote_sites	(I) n_remote_sites The remote site tags

SA_API int SA_write_am_rule_tree ( const char * path_name )

Write the current AM rule tree to the given file

Parameters

path_name (I)

Modules

Functions

Defines that are common to Person, Group, and Role

Defines used by Person routines

Defines used by Group routines

Defines used by User routines

Defines used by Site routines

Detailed Description

Macro Definition Documentation

Function Documentation