Modules
	Errors

Macros
#define	SITE_default_ods "ODS_site"

#define	SITE_nonsearchable_sites "ODS_searchable_sites_excluded"

#define	SITE_permitted_sites "IDSM_permitted_sites"

#define	SITE_restricted_sites "IDSM_restricted_sites"

#define	SITE_searchable_sites "ODS_searchable_sites"

Functions
SA_API int	SA_ask_site_info (tag_t site_tag, char sitename[SA_site_size_c+1], int *site_id)

SA_API int	SA_ask_site_info2 (tag_t site_tag, char *sitename, int site_id)

SA_API int	SA_ask_site_info_ex (tag_t site_tag, char sitename[SA_site_size_c+1], int site_id, logical external_app)

SA_API int	SA_ask_site_info_ex2 (tag_t site_tag, char *sitename, int site_id, logical *external_app)

SA_API int	SA_create_site (char sitename[SA_site_size_c+1], int site_id, tag_t *site_tag)

SA_API int	SA_create_site2 (const char sitename, int site_id, tag_t site_tag)

SA_API int	SA_extent_site (int nsites, tag_t *site_tags)

SA_API int	SA_find_site (const char sitename[SA_site_size_c+1], tag_t *site_tag)

SA_API int	SA_find_site2 (const char sitename, tag_t site_tag)

SA_API int	SA_find_site_by_id (int site_id, tag_t *site_tag)

SA_API int	SITE_ask_application_type (tag_t site, int *application_type)

SA_API int	SITE_ask_default_ods (int *site_id)

SA_API int	SITE_ask_geography (tag_t site, char geography[SA_geography_size_c+1])

SA_API int	SITE_ask_geography2 (tag_t site, char **geography)

SA_API int	SITE_ask_gms_url (tag_t site_tag, char url[SA_node_size_c+1])

SA_API int	SITE_ask_gms_url2 (tag_t site_tag, char **url)

SA_API int	SITE_ask_http_site (tag_t site_tag, logical *ids_http_site)

SA_API int	SITE_ask_hub_site (tag_t site_tag, logical *is_hub_site)

SA_API int	SITE_ask_license_server (tag_t site_tag, char **license_server)

SA_API int	SITE_ask_master_deletion_allowed (tag_t site, logical *is_master_delete)

SA_API int	SITE_ask_node_name (tag_t site_tag, char nodename[SA_node_size_c+1])

SA_API int	SITE_ask_node_name2 (tag_t site_tag, char **nodename)

SA_API int	SITE_ask_ods_site (tag_t site_tag, logical *is_ods_site)

SA_API int	SITE_ask_ods_url (tag_t site_tag, char url[SA_node_size_c+1])

SA_API int	SITE_ask_ods_url2 (tag_t site_tag, char **url)

SA_API int	SITE_ask_offline_site (tag_t siteTag, logical *is_offline)

SA_API int	SITE_ask_searchable_sites (int nsites_included, tag_t sites_included, int nsites_excluded, tag_t *sites_excluded, int user_nsites_included, tag_t *user_sites_included, int user_nsites_excluded, tag_t **user_sites_excluded)

SA_API int	SITE_ask_soa_url (tag_t site_tag, char url[SA_node_size_c+1])

SA_API int	SITE_ask_soa_url2 (tag_t site_tag, char **url)

SA_API int	SITE_ask_tcplmxml_site (tag_t siteTag, logical *is_plmxml)

SA_API int	SITE_ask_unmanaged_bb_plugin_site (const tag_t site, logical *is_unmanaged_bb_plugin)

SA_API int	SITE_ask_unmanaged_bb_site (const tag_t site, logical *is_unmanaged_bb)

SA_API int	SITE_ask_unmanaged_site (tag_t siteTag, logical *is_unmanaged)

SA_API int	SITE_is_external_application (tag_t site, logical *is_external)

SA_API int	SITE_set_application_type (tag_t site, int application_type)

SA_API int	SITE_set_geography (tag_t site, const char *geography)

SA_API int	SITE_set_gms_url (tag_t site_tag, const char url[SA_node_size_c+1])

SA_API int	SITE_set_gms_url2 (tag_t site_tag, const char *url)

SA_API int	SITE_set_http_site (tag_t site_tag, logical is_http_site)

SA_API int	SITE_set_hub_site (tag_t site_tag, logical is_hub_site)

SA_API int	SITE_set_license_server (tag_t site_tag, const char *license_server)

SA_API int	SITE_set_master_deletion_allowed (tag_t site, logical is_master_delete)

SA_API int	SITE_set_node_name (tag_t site_tag, const char nodename[SA_node_size_c+1])

SA_API int	SITE_set_node_name2 (tag_t site_tag, const char *nodename)

SA_API int	SITE_set_ods_site (tag_t site_tag, logical is_ods_site)

SA_API int	SITE_set_ods_url (tag_t site_tag, const char url[SA_node_size_c+1])

SA_API int	SITE_set_ods_url2 (tag_t site_tag, const char *url)

SA_API int	SITE_set_offline_site (tag_t siteTag, logical is_offline)

SA_API int	SITE_set_soa_url (tag_t site_tag, const char url[SA_node_size_c+1])

SA_API int	SITE_set_soa_url2 (tag_t site_tag, const char *url)

SA_API int	SITE_set_tcplmxml_site (tag_t siteTag, logical is_plmxml)

SA_API int	SITE_set_unmanaged_bb_plugin_site (const tag_t site, const logical is_unmanaged_bb_plugin)

SA_API int	SITE_set_unmanaged_bb_site (const tag_t site, const logical is_unmanaged_bb)

SA_API int	SITE_set_unmanaged_site (tag_t site, logical is_unmanaged)

Directory Services Preferences
#define	ODS_permitted_sites "ODS_permitted_sites"

#define	ODS_restricted_sites "ODS_restricted_sites"

Detailed Description

Common Return Values

SITE_DEFAULT_ODS_ERROR - A default ODS is not defined.

Macro Definition Documentation

#define ODS_permitted_sites "ODS_permitted_sites"

Which sites ODS will allow access

Definition at line 57 of file site.h.

#define ODS_restricted_sites "ODS_restricted_sites"

Which sites ODS will not permit access

Definition at line 60 of file site.h.

#define SITE_default_ods "ODS_site"

Site Preferences

Definition at line 37 of file site.h.

#define SITE_nonsearchable_sites "ODS_searchable_sites_excluded"

Which sites this site can not search

Definition at line 49 of file site.h.

#define SITE_permitted_sites "IDSM_permitted_sites"

Which sites can access this site

Definition at line 40 of file site.h.

#define SITE_restricted_sites "IDSM_restricted_sites"

Which sites can not access this site

Definition at line 43 of file site.h.

#define SITE_searchable_sites "ODS_searchable_sites"

Which sites can this site search

Definition at line 46 of file site.h.

Function Documentation

SA_API int SA_ask_site_info	(	tag_t	site_tag,
		char	sitename[SA_site_size_c+1],
		int *	site_id
	)

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

Returns the name and ID of the specified site.

Parameters

site_tag	(I)
sitename	(O)
site_id	(O)

SA_API int SA_ask_site_info2	(	tag_t	site_tag,
		char **	sitename,
		int *	site_id
	)

Returns the name and ID of the specified site.

Parameters

site_tag	(I)
sitename	(OF)
site_id	(O)

SA_API int SA_ask_site_info_ex	(	tag_t	site_tag,
		char	sitename[SA_site_size_c+1],
		int *	site_id,
		logical *	external_app
	)

Deprecated:: It will be removed from Tc12.
From Tc10 onwards, please use SA_ask_site_info_ex2 the corresponding ITK version2

Returns the name, ID and external app status of the specified site.

Parameters

site_tag	(I)
sitename	(O)
site_id	(O)
external_app	(O)

SA_API int SA_ask_site_info_ex2	(	tag_t	site_tag,
		char **	sitename,
		int *	site_id,
		logical *	external_app
	)

Returns the name, ID and external app status of the specified site.

Parameters

site_tag	(I)
sitename	(OF)
site_id	(O)
external_app	(O)

SA_API int SA_create_site	(	char	sitename[SA_site_size_c+1],
		int	site_id,
		tag_t *	site_tag
	)

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

Creates a Site object. It is not saved to the database until an explicit call to AOM_save occurs. You must specify a unique sitename and a unique site_id.

Restrictions:

This function can only be accessed when logged in as a system administrator.

Parameters

sitename	(I)
site_id	(I)
site_tag	(O)

SA_API int SA_create_site2	(	const char *	sitename,
		int	site_id,
		tag_t *	site_tag
	)

Creates a Site object. It is not saved to the database until an explicit call to AOM_save occurs. You must specify a unique sitename and a unique site_id.

Restrictions:

This function can only be accessed when logged in as a system administrator.

Parameters

sitename	(I)
site_id	(I)
site_tag	(O)

SA_API int SA_extent_site	(	int *	nsites,
		tag_t **	site_tags
	)

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

The client is responsible for deallocating the array of site_tags. Use MEM_free to free the memory pointed to by site_tags.

Parameters

nsites	(O) Stores the size of the array
site_tags	(OF) nsites Points to the array of tags

SA_API int SA_find_site	(	const char	sitename[SA_site_size_c+1],
		tag_t *	site_tag
	)

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

Finds a site with the specified name. The site_name is unique in the database. If an error occurs, then a non-zero integer returns. If no site exists with the specified name, then a zero returns, and a NULLTAG returns for the site_tag.

Parameters

sitename	(I)
site_tag	(O)

SA_API int SA_find_site2	(	const char *	sitename,
		tag_t *	site_tag
	)

Finds a site with the specified name. The site_name is unique in the database. If an error occurs, then a non-zero integer returns. If no site exists with the specified name, then a zero returns, and a NULLTAG returns for the site_tag.

Parameters

sitename	(I)
site_tag	(O)

SA_API int SA_find_site_by_id	(	int	site_id,
		tag_t *	site_tag
	)

Returns the tag of the specified site.

Returns SA_finding_site if unable to find site with the specified site_id.

Parameters

site_id	(I) Site ID of the specified site
site_tag	(O) Site tag of the specified site

SA_API int SITE_ask_application_type	(	tag_t	site,
		int *	application_type
	)

Parameters

site	(I)
application_type	(O)

SA_API int SITE_ask_default_ods ( int * site_id )

Returns the site ID of the default ODS.

Parameters

site_id (O) Site ID of the site that is currently designated as the default ODS

SA_API int SITE_ask_geography	(	tag_t	site,
		char	geography[SA_geography_size_c+1]
	)

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

Returns the value of the geography attribute of the specified site.

Parameters

site	(I)
geography	(O)

SA_API int SITE_ask_geography2	(	tag_t	site,
		char **	geography
	)

Returns the value of the geography attribute of the specified site.

Parameters

site	(I)
geography	(OF)

SA_API int SITE_ask_gms_url	(	tag_t	site_tag,
		char	url[SA_node_size_c+1]
	)

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

Parameters

site_tag	(I)
url	(O) Returned url name for gms node

SA_API int SITE_ask_gms_url2	(	tag_t	site_tag,
		char **	url
	)

Parameters

site_tag	(I)
url	(OF) Returned url name for gms node

SA_API int SITE_ask_http_site	(	tag_t	site_tag,
		logical *	ids_http_site
	)

Parameters

site_tag	(I)
ids_http_site	(O)

SA_API int SITE_ask_hub_site	(	tag_t	site_tag,
		logical *	is_hub_site
	)

Parameters

site_tag	(I)
is_hub_site	(O)

SA_API int SITE_ask_license_server	(	tag_t	site_tag,
		char **	license_server
	)

Retrieves the license server of the specified site.

Returns

ITK_ok on success
ITK_invalid_license_server_name will be returned if the license server tag is invalid.

Parameters

site_tag	(I) Tag of the site whose status is to be queried
license_server	(OF) Default license server for the site

SA_API int SITE_ask_master_deletion_allowed	(	tag_t	site,
		logical *	is_master_delete
	)

Parameters

site	(I) The site which master deletion status is to be queried
is_master_delete	(O) Indicates if the objects replicated through Global Multi-Site Services can be deleted. It has no impact on the Multi-Site Collaboration.

SA_API int SITE_ask_node_name	(	tag_t	site_tag,
		char	nodename[SA_node_size_c+1]
	)

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

Returns the nodename where the ODS and/or IDSM daemon(s) are running for the specified site.

Parameters

site_tag	(I) Tag of the specified site
nodename	(O) Returned node name

SA_API int SITE_ask_node_name2	(	tag_t	site_tag,
		char **	nodename
	)

Returns the nodename where the ODS and/or IDSM daemon(s) are running for the specified site.

Parameters

site_tag	(I) Tag of the specified site
nodename	(OF) Returned node name

SA_API int SITE_ask_ods_site	(	tag_t	site_tag,
		logical *	is_ods_site
	)

Returns the status of the specified site as to whether or not it is ODS-capable (i.e., objects can be published to it).

Parameters

site_tag	(I) Tag of the site whose status is to be queried
is_ods_site	(O) Set to TRUE if specified site is ODS-capable and FALSE if not

SA_API int SITE_ask_ods_url	(	tag_t	site_tag,
		char	url[SA_node_size_c+1]
	)

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

Parameters

site_tag	(I)
url	(O) Returned url name for ods node

SA_API int SITE_ask_ods_url2	(	tag_t	site_tag,
		char **	url
	)

Parameters

site_tag	(I)
url	(OF) Returned url name for ods node

SA_API int SITE_ask_offline_site	(	tag_t	siteTag,
		logical *	is_offline
	)

SA_API int SITE_ask_searchable_sites	(	int *	nsites_included,
		tag_t **	sites_included,
		int *	nsites_excluded,
		tag_t **	sites_excluded,
		int *	user_nsites_included,
		tag_t **	user_sites_included,
		int *	user_nsites_excluded,
		tag_t **	user_sites_excluded
	)

Parameters

nsites_included	(O)
sites_included	(OF) nsites_included
nsites_excluded	(O)
sites_excluded	(OF) nsites_excluded
user_nsites_included	(O)
user_sites_included	(OF) user_nsites_included
user_nsites_excluded	(O)
user_sites_excluded	(OF) user_nsites_excluded

SA_API int SITE_ask_soa_url	(	tag_t	site_tag,
		char	url[SA_node_size_c+1]
	)

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

Parameters

site_tag	(I)
url	(O) Returned url name for soa node

SA_API int SITE_ask_soa_url2	(	tag_t	site_tag,
		char **	url
	)

Parameters

site_tag	(I)
url	(OF) Returned url name for soa node

SA_API int SITE_ask_tcplmxml_site	(	tag_t	siteTag,
		logical *	is_plmxml
	)

SA_API int SITE_ask_unmanaged_bb_plugin_site	(	const tag_t	site,
		logical *	is_unmanaged_bb_plugin
	)

Checks if a site is marked as an unmanaged briefcase-browserwith plugin site.

Returns

ITK_ok on success
CXPOM_wrong_class if site is not a site object.
POM_invalid_tag will if site is invalid.

Parameters

site	(I) Tag of the site whose unmanaged briefcase-browser with plugin status is to be queried
is_unmanaged_bb_plugin	(O) Status of the site: `true` if the site is unmanaged briefcase-browser with plugin.

SA_API int SITE_ask_unmanaged_bb_site	(	const tag_t	site,
		logical *	is_unmanaged_bb
	)

Checks if a site is marked as an unmanaged briefcase-browser site.

Returns

ITK_ok on success
CXPOM_wrong_class if site is not a site object.
POM_invalid_tag will if site is invalid.

Parameters

site	(I) Tag of the site whose unmanaged briefcase-browser status is to be queried
is_unmanaged_bb	(O) Status of the site: `true` if the site is unmanaged briefcase-browser.

SA_API int SITE_ask_unmanaged_site	(	tag_t	siteTag,
		logical *	is_unmanaged
	)

Parameters

siteTag	(I) Tag of the site whose unmanaged status is to be queried
is_unmanaged	(O) return TRUE if specified site is unmanaged and FALSE if not

SA_API int SITE_is_external_application	(	tag_t	site,
		logical *	is_external
	)

Parameters

site	(I)
is_external	(O)

SA_API int SITE_set_application_type	(	tag_t	site,
		int	application_type
	)

Parameters

site	(I)
application_type	(I)

SA_API int SITE_set_geography	(	tag_t	site,
		const char *	geography
	)

Sets the geography attribute of the specified site.

Parameters

site	(I)
geography	(I)

SA_API int SITE_set_gms_url	(	tag_t	site_tag,
		const char	url[SA_node_size_c+1]
	)

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

Parameters

site_tag	(I)
url	(I) Site name url where GMS is deployed

SA_API int SITE_set_gms_url2	(	tag_t	site_tag,
		const char *	url
	)

Parameters

site_tag	(I)
url	(I) Site name url where GMS is deployed

SA_API int SITE_set_http_site	(	tag_t	site_tag,
		logical	is_http_site
	)

Parameters

site_tag	(I)
is_http_site	(I)

SA_API int SITE_set_hub_site	(	tag_t	site_tag,
		logical	is_hub_site
	)

Parameters

site_tag	(I)
is_hub_site	(I)

SA_API int SITE_set_license_server	(	tag_t	site_tag,
		const char *	license_server
	)

Sets the default license server for the specified site.

Returns

ITK_ok on success
ITK_invalid_license_server_name will be returned if the license server tag is invalid.

Parameters

site_tag	(I) Tag of the specified site
license_server	(I) Default license server for the site

SA_API int SITE_set_master_deletion_allowed	(	tag_t	site,
		logical	is_master_delete
	)

Parameters

site	(I) The site which master deletion status is to be set
is_master_delete	(I) Indicates if the objects replicated through Global Multi-Site Services can be deleted. It has no impact on the Multi-Site Collaboration.

SA_API int SITE_set_node_name	(	tag_t	site_tag,
		const char	nodename[SA_node_size_c+1]
	)

Deprecated:: It will be removed from Tc12.
In Tc10 onwards, please use SITE_set_node_name2

Sets the nodename where the ODS and/or IDSM daemon(s) will run for the specified site.

Parameters

site_tag	(I) Tag of the specified site
nodename	(I) Node name where the ODS and/or IDSM daemon(s) will run for the specified site

SA_API int SITE_set_node_name2	(	tag_t	site_tag,
		const char *	nodename
	)

Sets the nodename where the ODS and/or IDSM daemon(s) will run for the specified site.

Parameters

site_tag	(I) Tag of the specified site
nodename	(I) Node name where the ODS and/or IDSM daemon(s) will run for the specified site

SA_API int SITE_set_ods_site	(	tag_t	site_tag,
		logical	is_ods_site
	)

Sets the status of the specified site as to whether or not it is ODS-capable (i.e., objects can be published to it).

Parameters

site_tag	(I) Tag of the site whose ODS-capability status is to be set
is_ods_site	(I) If TRUE, then the specified site will be flagged as ODS-capable; otherwise it will be flagged as not ODS-capable.

SA_API int SITE_set_ods_url	(	tag_t	site_tag,
		const char	url[SA_node_size_c+1]
	)

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

Parameters

site_tag	(I)
url	(I) Site name url where ODS daemon(s) will run

SA_API int SITE_set_ods_url2	(	tag_t	site_tag,
		const char *	url
	)

Parameters

site_tag	(I)
url	(I) Site name url where ODS daemon(s) will run

SA_API int SITE_set_offline_site	(	tag_t	siteTag,
		logical	is_offline
	)

SA_API int SITE_set_soa_url	(	tag_t	site_tag,
		const char	url[SA_node_size_c+1]
	)

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

Parameters

site_tag	(I)
url	(I) Site name url where SOA daemon(s) will run

SA_API int SITE_set_soa_url2	(	tag_t	site_tag,
		const char *	url
	)

Parameters

site_tag	(I)
url	(I) Site name url where SOA daemon(s) will run

SA_API int SITE_set_tcplmxml_site	(	tag_t	siteTag,
		logical	is_plmxml
	)

SA_API int SITE_set_unmanaged_bb_plugin_site	(	const tag_t	site,
		const logical	is_unmanaged_bb_plugin
	)

Marks a site as an unmanaged briefcase-browser with plugin site.

Returns

ITK_ok on success
CXPOM_wrong_class if site is not a site object.
POM_invalid_tag will if site is invalid.
SITE_LOCAL_UNMANAGED_ERROR if site is local site.

Parameters

site	(I) The site which unmanaged briefcase-browser with plugin status is to be set
is_unmanaged_bb_plugin	(I) Status of the site: `true` if the site is unmanaged briefcase-browser with plugin.

SA_API int SITE_set_unmanaged_bb_site	(	const tag_t	site,
		const logical	is_unmanaged_bb
	)

Marks a site as an unmanaged briefcase-browser site.

Returns

ITK_ok on success
CXPOM_wrong_class if site is not a site object.
POM_invalid_tag will if site is invalid.
SITE_LOCAL_UNMANAGED_ERROR if site is local site.

Parameters

site	(I) The site which unmanaged briefcase-browser status is to be set
is_unmanaged_bb	(I) Status of the site: `true` if the site is unmanaged briefcase-browser.

SA_API int SITE_set_unmanaged_site	(	tag_t	site,
		logical	is_unmanaged
	)

Checks if a site is marked as an unmanaged site.

Returns

ITK_ok on success
CXPOM_wrong_class if site is not a site object.
POM_invalid_tag will if site is invalid.
SITE_LOCAL_UNMANAGED_ERROR if site is local site.

Parameters

site	(I) The site which unmanaged status is to be set
is_unmanaged	(I) If TRUE, then the specified site will be flagged as unmanaged; otherwise it will be flagged as not unmanaged.

Modules

Macros

Functions

Directory Services Preferences

Detailed Description

Macro Definition Documentation

Function Documentation