EINT_API int EINT__init_classes | ( | ) |
Adds a GroupMember object to the ExternalDataSource accessor list
datasource | (I) The ExternalDataSource object tag |
groupMember | (I) The GroupMember object tag |
EINT_API int EINT_add_external_datasource_proxy_account | ( | tag_t | datasource, | |
const char * | proxyUsername, | |||
const char * | proxyPassword, | |||
EINT_account_type_t | accountType | |||
) |
Adds a new proxy account into the ExternDataSource
datasource | (I) The tag for the ExternalDataSource object |
proxyUsername | (I) The username for the proxy account |
proxyPassword | (I) The password for the proxy account |
accountType | (I) |
Add an ExternalAttribute object to the ObjectMapping key list. The list stores all keys involved in the query for the ObjectMapping
object_mapping | (I) The ObjectMapping object tag |
ext_attr | (I) The External Attribute object tag |
Add an MappedProperty object to the mapped property list. This list represents all the mapped properties associated with the ObjectMapping
object_mapping | (I) The ObjectMapping object tag |
mapped_property | (I) The Mapped Property object tag |
EINT_API int EINT_ask_ext_attribute_datatype | ( | tag_t | ext_attr, | |
int * | attrtype | |||
) |
Set the attribute name for an ExternalAttribute object.
ext_attr | (I) The ExternalAttribute object tag |
attrtype | (O) The attribute type |
EINT_API int EINT_ask_ext_attribute_length | ( | tag_t | ext_attr, | |
int * | length | |||
) |
Returns the attribute length for an ExternalAttribute object.
ext_attr | (I) The ExternalAttribute object tag |
length | (O) The attribute length |
EINT_API int EINT_ask_ext_attribute_name | ( | tag_t | ext_attr, | |
char ** | attr_name | |||
) |
Returns the attribute name for an ExternalAttribute object.
ext_attr | (I) The ExternalAttribute object tags |
attr_name | (OF) The returned external attribute name |
EINT_API int EINT_ask_ext_attribute_tablename | ( | tag_t | ext_attr, | |
char ** | tablename | |||
) |
Returns the tablename attribute for an ExternalAttribute object.
ext_attr | (I) The ExternalAttribute object tags |
tablename | (OF) The table name |
EINT_API int EINT_ask_external_datasource_adaptername | ( | tag_t | datasource, | |
char ** | adaptername | |||
) |
Returns the ExternalDataSource adaptername
datasource | (I) The tag for the ExternalDataSource object |
adaptername | (OF) The return Adapter name |
EINT_API int EINT_ask_external_datasource_groupmember_proxy_account | ( | tag_t | datasource, | |
tag_t | groupmember, | |||
char ** | proxyUsername, | |||
char ** | proxyPassword, | |||
EINT_account_type_t * | accountType | |||
) |
Returns the properties of the proxy account based on the login GroupMember. Each datasource for a give login GroupMember should lead to one proxy account.
datasource | (I) The tag for the ExternalDataSource object |
groupmember | (I) The login GroupMember object tag |
proxyUsername | (OF) The proxy account username |
proxyPassword | (OF) The proxy account password |
accountType | (O) The proxy account type (see EINT_add_external_datasource_proxy_account) |
EINT_API int EINT_ask_external_datasource_hostname | ( | tag_t | datasource, | |
char ** | hostname | |||
) |
Returns the ExternalDataSource hostname
datasource | (I) The tag for the ExternalDataSource object |
hostname | (OF) The return ExternalDataSource hostname |
EINT_API int EINT_ask_external_datasource_name | ( | tag_t | datasource, | |
char ** | datasource_name | |||
) |
Returns the ExternalDataSource object name
datasource | (I) The tag for the ExternalDataSource object |
datasource_name | (OF) The new ExternaDataSource name |
EINT_API int EINT_ask_external_datasource_proxy_account | ( | tag_t | datasource, | |
tag_t | authentication, | |||
char ** | proxyUsername, | |||
char ** | proxyPassword, | |||
EINT_account_type_t * | accountType | |||
) |
Returns the properties of the proxy account based on the authentication object
datasource | (I) The tag for the ExternalDataSource object |
authentication | (I) The Authentication object which represents the proxy account |
proxyUsername | (OF) The proxy account username |
proxyPassword | (OF) The proxy account password |
accountType | (O) The proxy account type (see EINT_add_external_datasource_proxy_account) |
EINT_API int EINT_ask_external_datasource_URLName | ( | tag_t | datasource, | |
char ** | url_name | |||
) |
Returns the ExternalDataSource universal resource locator
datasource | (I) The tag for the ExternalDataSource object |
url_name | (OF) The return ExternalDataSource URL name |
Returns the ExternalAttribute object tag for the given MappedProperty object.
mapped_property | (I) The MappedProperty object tag |
ext_attr | (O) The returned ExternalAttribute object tag |
EINT_API int EINT_ask_mapped_property_tcpropname | ( | tag_t | mapped_property, | |
char ** | tc_propname | |||
) |
Asks the Teamcenter property name attribute for the given MappedProperty object.
mapped_property | (I) The MappedProperty object tag |
tc_propname | (OF) The returned Teamcenter property name |
EINT_API int EINT_ask_mapped_property_tctypename | ( | tag_t | mapped_property, | |
char ** | tc_typename | |||
) |
Asks the TcType name attribute for the given MappedProperty object.
mapped_property | (I) The MappedProperty object tag |
tc_typename | (OF) The returned Teamcenter Type name |
Returns the datasource attribute for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
datasource | (O) The returned External DataSource object tag |
Returns the ExternalObject attribute which represents the Item Id for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
ext_attr | (O) The ExternalAttribute object tag which represents the Item Id |
Returns the ExternalObject attribute which represents the Item description for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
ext_attr | (O) The ExternalAttribute object tag which represents the Item description |
Returns the ExternalObject attribute which represents the Item name for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
ext_attr | (O) The ExternalAttribute object tag which represents the Item name |
Returns the ExternalObject attribute which represents the Item Rev Id for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
ext_attr | (O) The ExternalAttribute object tag which represents the Item Rev Id |
object_mapping | (I) |
itemtype | (O) |
Returns all ExternalAttribute objects from the key list associated with the ObjectMapping.
object_mapping | (I) The ObjectMapping object tag |
num | (O) The number of ExternalAttribute object returned |
ext_attrs | (OF) num The External Attribute object tags |
EINT_API int EINT_ask_object_mapping_mapped_props | ( | tag_t | object_mapping, | |
int * | num, | |||
tag_t ** | mapped_properties | |||
) |
Returns all MappedProperty objects from the key list associated with the ObjectMapping.
object_mapping | (I) The ObjectMapping object tag |
num | (O) The number of MappedProperty object returned |
mapped_properties | (OF) num The Mapped Property object tags |
Returns the persistent flag attribute for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
flag | (O) The persistent flag |
EINT_API int EINT_ask_object_mapping_query_stmt | ( | tag_t | object_mapping, | |
char ** | query_stmt | |||
) |
Returns the query_stmt attribute for the ObjectMapping
object_mapping | (I) The ObjectMapping object tag |
query_stmt | (OF) The SQL statement for the ObjectMapping |
Returns the related to Item flag attribute for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
flag | (O) The returned related to Item flag |
EINT_API int EINT_ask_object_mapping_store_procedure | ( | tag_t | object_mapping, | |
char ** | procedure_name | |||
) |
object_mapping | (I) |
procedure_name | (OF) |
Returns the update on save flag attribute for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
flag | (O) The returned update on save flag |
EINT_API int EINT_clear_external_datasource_accessors | ( | tag_t | datasource | ) |
Removes all GroupMember objects from the ExternalDataSource accessor list
datasource | (I) The ExternalDataSource object tag |
EINT_API int EINT_clear_object_mapping_keys | ( | tag_t | object_mapping | ) |
Removes all keys associated with the ObjectMapping object
object_mapping | (I) The ObjectMapping object tag |
EINT_API int EINT_clear_object_mapping_mapped_props | ( | tag_t | object_mapping | ) |
Removes all mapped properties associated with the ObjectMapping object
object_mapping | (I) The ObjectMapping object tag |
EINT_API int EINT_create_ext_attribute | ( | const char * | datasource_name, | |
const char * | tablename, | |||
const char * | attr_name, | |||
int | attr_datatype, | |||
int | attr_length, | |||
tag_t * | ext_attr | |||
) |
Creates an ExternalAttribute object. An ExternalAttribute object represents each column attribute of each table in the ExternalDataSource. Given a datasource_name, table_name and attr_name will lead to a unique ExternalAttribute object
datasource_name | (I) The ExternalDataSource name |
tablename | (I) The table name |
attr_name | (I) The attribute name |
attr_datatype | (I) The datatype for the attribute |
attr_length | (I) The returned ExternalAttribute object tags |
ext_attr | (O) The attribute length |
EINT_API int EINT_create_external_datasource | ( | const char * | datasource_name, | |
const char * | hostname, | |||
const char * | url, | |||
const char * | adapter_name, | |||
tag_t * | datasource | |||
) |
Creates an ExternalDataSource Object.
Restrictions:
Datasource_name has to be unique
datasource_name | (I) The datasource name for the new ExternalDataSource object |
hostname | (I) The hostname in which the ExternalDataSource reside |
url | (I) The universal resouce locator for the ExternalDataSource |
adapter_name | (I) The datasource adapter used |
datasource | (O) |
EINT_API int EINT_create_mapped_property | ( | tag_t | ext_attr, | |
const char * | tc_typename, | |||
const char * | tc_propname, | |||
tag_t * | property | |||
) |
Create the MappedProperty object given the ExternalAttribute object tag, TcType name and TcProperty name
ext_attr | (I) The ExternalAttribute object tag |
tc_typename | (I) The Teamcenter type name |
tc_propname | (I) The Teamcenter property name |
property | (O) The return MappedProperty object tag |
EINT_API int EINT_create_object_mapping | ( | tag_t | data_source, | |
logical | persistent_flag, | |||
logical | related_to_item_flag, | |||
logical | update_on_save_flag, | |||
tag_t | ext_attr_item, | |||
tag_t | ext_attr_itemrev, | |||
tag_t | ext_attr_itemname, | |||
tag_t | ext_attr_itemdesc, | |||
tag_t | itemtype, | |||
const char * | sql_stmt, | |||
const char * | store_procedure, | |||
tag_t * | object_mapping | |||
) |
Creates a new ObjectMapping object
data_source | (I) The ExternalDataSource tag |
persistent_flag | (I) The flag which indicates if the object created is persistent or not |
related_to_item_flag | (I) This flag indicates if the object created will be related to a Teamcenter Item or not |
update_on_save_flag | (I) This flag indicates if the object will be updated on save |
ext_attr_item | (I) The ExternalAttribute object tag which uses for the ItemId |
ext_attr_itemrev | (I) The ExternalAttribute object tag which uses for the ItemRevId |
ext_attr_itemname | (I) The ExtarnalAttribute object tag which uses for the ItemName |
ext_attr_itemdesc | (I) The ExternalAttribute object tag which uses for the ItemDesc |
itemtype | (I) The ExternalAttribute object tag which uses for the ItemType |
sql_stmt | (I) The SQL statement for the ObjectMapping |
store_procedure | (I) |
object_mapping | (O) The new ObjectMapping object tag |
EINT_API int EINT_external_datasource_add_proxy_account_accessors | ( | tag_t | datasource, | |
tag_t | authentication, | |||
int | n_accessor, | |||
tag_t * | accessors | |||
) |
Grants accessors to the proxy account belongs to the particular ExternalDataSource
datasource | (I) The ExternalDataSource object tag |
authentication | (I) The Authentication which represents the proxy account |
n_accessor | (I) Number of accessors to be granted |
accessors | (I) n_accessor GroupMember tags which represents the accessor list |
EINT_API int EINT_external_datasource_clear_proxy_account_accessors | ( | tag_t | datasource, | |
tag_t | authentication | |||
) |
Removes all accessors from the proxy account belongs to the particular ExternalDataSource
datasource | (I) The ExternalDataSource object tag |
authentication | (I) The Authentication which represents the proxy account |
EINT_API int EINT_external_datasource_list_proxy_account_accessors | ( | tag_t | datasource, | |
tag_t | authentication, | |||
int * | n_groupmember, | |||
tag_t ** | groupMembers | |||
) |
Lists all accessors from the proxy account belongs to the particular ExternalDataSource
datasource | (I) The ExternalDataSource object tag |
authentication | (I) The Authentication which represents the proxy account |
n_groupmember | (O) Number of GroupMember object tags returned |
groupMembers | (OF) n_groupmember GroupMember tags which represents the accessor list |
EINT_API int EINT_external_datasource_remove_proxy_account_accessors | ( | tag_t | datasource, | |
tag_t | authentication, | |||
int | n_accessor, | |||
tag_t * | accessors | |||
) |
Removes accessors from the proxy account belongs to the particular ExternalDataSource
datasource | (I) The ExternalDataSource object tag |
authentication | (I) The Authentication which represents the proxy account |
n_accessor | (I) Number of accessors to be removed |
accessors | (I) n_accessor GroupMember tags which represents the accessor list |
EINT_API int EINT_find_ext_attribute | ( | const char * | datasource_name, | |
const char * | table_name, | |||
const char * | attr_name, | |||
tag_t * | ext_attr | |||
) |
Finds an ExternalAttribute object in the Teamcenter database. An ExternalAttribute object represents each column attribute of each table in the ExternalDataSource. Given a datasource_name, table_name and attr_name will lead to a unique ExternalAttribute object
datasource_name | (I) The ExternalDataSource name |
table_name | (I) The table name |
attr_name | (I) The attribute name |
ext_attr | (O) ExternaAttribute object tags |
EINT_API int EINT_find_external_datasource | ( | const char * | datasource_name, | |
int * | num, | |||
tag_t ** | tags | |||
) |
Finds all externalDataSources in the database according to the datasource_name.
datasource_name | (I) The datasource name for the new ExternalDataSource object. The argument also accepts wildcards. |
num | (O) Number of ExternalDataSource objects return |
tags | (OF) num The tag list for the ExternalDataSource Object |
EINT_API int EINT_find_external_datasource_proxy_account | ( | tag_t | datasource, | |
const char * | proxyUsername, | |||
tag_t * | authentication | |||
) |
Returns the Authentication object which represents the proxy account
datasource | (I) The tag for the ExternalDataSource object |
proxyUsername | (I) The username for the proxy account |
authentication | (O) The return Authentication object tag |
EINT_API int EINT_find_mapped_property | ( | tag_t | ext_attr, | |
const char * | tc_typename, | |||
const char * | tc_propname, | |||
tag_t * | mapped_property | |||
) |
Finds the MappedProperty object given the ExternalAttribute object tag, TcType name and TcProperty name
ext_attr | (I) The ExternalAttribute object tag |
tc_typename | (I) The Teamcenter type name |
tc_propname | (I) The Teamcenter property name |
mapped_property | (O) The return MappedProperty object tag |
Finds all ObjetMapping objects in the Teamcenter database
datasource | (I) The ExternalDataSource tag |
num | (O) Number of ObjectMapping returned |
object_mappings | (OF) num The tags representing the returned ObjectMapping objects |
EINT_API int EINT_init_module | ( | void | ) |
EINT_API int EINT_list_external_datasource_accessors | ( | tag_t | datasource, | |
int * | n_groupmembers, | |||
tag_t ** | groupMembers | |||
) |
Lists all GroupMember objects associated with an ExternalDataSource
datasource | (I) The ExternalDataSource object tag |
n_groupmembers | (O) Number of groupmember tags returns |
groupMembers | (OF) n_groupmembers GroupMember object tags |
EINT_API int EINT_list_external_datasource_proxy_accounts | ( | tag_t | datasource, | |
int * | nFound, | |||
tag_t ** | authentications | |||
) |
Returns all the Authentication objects associated with a ExternalDataSource.
datasource | (I) The tag for the ExternalDataSource object |
nFound | (O) The number of Authentication objects |
authentications | (OF) nFound The Authentication object tags |
EINT_API int EINT_register_runtime_props | ( | void | ) |
Relates the given formtype to the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
formtype | (I) The number of MappedProperty object returned |
Removes a GroupMember object to the ExternalDataSource accessor list
datasource | (I) The ExternalDataSource object tag |
groupMember | (I) The GroupMember object tag |
EINT_API int EINT_remove_external_datasource_proxy_account | ( | tag_t | datasource, | |
const char * | proxyUsername | |||
) |
Removes the proxy account from the external datasource
datasource | (I) The tag for the ExternalDataSource object |
proxyUsername | (I) The username for the proxy account |
Removes an ExternalAttribute object from the key list associated with the ObjectMapping.
object_mapping | (I) The ObjectMapping object tag |
ext_attr | (I) The External Attribute object tag |
Removes an MappedProperty object from the mapped property list associated with the ObjectMapping.
object_mapping | (I) The ObjectMapping object tag |
mapped_property | (I) The Mapped Property object tag |
EINT_API int EINT_set_ext_attribute_datatype | ( | tag_t | ext_attr, | |
int | attrtype | |||
) |
Set the attribute name for an ExternalAttribute object.
ext_attr | (I) The ExternalAttribute object tags |
attrtype | (I) The attribute name |
EINT_API int EINT_set_ext_attribute_length | ( | tag_t | ext_attr, | |
int | length | |||
) |
Set the attribute length for an ExternalAttribute object.
ext_attr | (I) The ExternalAttribute object tag |
length | (I) The attribute length |
EINT_API int EINT_set_ext_attribute_name | ( | tag_t | ext_attr, | |
const char * | attr_name | |||
) |
Set the attribute name for an ExternalAttribute object.
ext_attr | (I) The ExternalAttribute object tag |
attr_name | (I) The attribute name |
EINT_API int EINT_set_ext_attribute_tablename | ( | tag_t | ext_attr, | |
const char * | tablename | |||
) |
Set the tablename attribute for an ExternalAttribute object.
ext_attr | (I) The ExternalAttribute object tags |
tablename | (I) The table name |
EINT_API int EINT_set_external_datasource_adaptername | ( | tag_t | datasource, | |
const char * | adaptername | |||
) |
Set the ExternalDataSource adaptername.
datasource | (I) The tag for the ExternalDataSource object |
adaptername | (I) The input Adapter name |
EINT_API int EINT_set_external_datasource_hostname | ( | tag_t | datasource, | |
const char * | hostname | |||
) |
Set the ExternalDataSource hostname
datasource | (I) The tag for the ExternalDataSource object |
hostname | (I) The input ExternalDataSource hostname |
EINT_API int EINT_set_external_datasource_name | ( | tag_t | datasource, | |
const char * | datasource_name | |||
) |
Set the ExternalDataSource object name
datasource | (I) The tag for the ExternalDataSource object |
datasource_name | (I) The new ExternaDataSource name |
EINT_API int EINT_set_external_datasource_proxy_account | ( | tag_t | datasource, | |
tag_t | authentication, | |||
const char * | proxyUsername, | |||
const char * | proxyPassword, | |||
EINT_account_type_t | accountType | |||
) |
Set the properties of the proxy account based on the authentication object
datasource | (I) The tag for the ExternalDataSource object |
authentication | (I) The Authentication object which represents the proxy account |
proxyUsername | (I) The proxy account username |
proxyPassword | (I) The proxy account password |
accountType | (I) The proxy account type (see EINT_add_external_datasource_proxy_account) |
EINT_API int EINT_set_external_datasource_URLName | ( | tag_t | datasource, | |
const char * | url_name | |||
) |
Set the ExternalDataSource universal resource locator
datasource | (I) The tag for the ExternalDataSource object |
url_name | (I) The input ExternalDataSource URL name |
EINT_API int EINT_set_mapped_property_tcpropname | ( | tag_t | mapped_property, | |
const char * | tc_propname | |||
) |
Set the Teamcenter property name attribute for the given MappedProperty object.
mapped_property | (I) The MappedProperty object tag |
tc_propname | (I) The Teamcenter propertry name |
EINT_API int EINT_set_mapped_property_tctypename | ( | tag_t | mapped_property, | |
const char * | tc_typename | |||
) |
Set the TcType name attribute for the given MappedProperty object.
mapped_property | (I) The MappedProperty object tag |
tc_typename | (I) The Teamcenter type name |
Set the datasource attribute for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
datasource | (I) The ExternalDataSource object tag |
Assigns the ExternalObject attribute which represents the Item Id for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
ext_attr | (I) The ExternalAttribute object tag which represents the ItemId |
Assigns the ExternalObject attribute which represents the Item description for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
ext_attr | (I) The ExternalAttribute object tag which represents the Item description |
Assigns the ExternalObject attribute which represents the Item name for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
ext_attr | (I) The ExternalAttribute object tag which represents the Item name |
Assigns the ExternalObject attribute which represents the Item Rev Id for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
ext_attr | (I) The ExternalAttribute object tag which represents the Item Rev Id |
object_mapping | (I) |
itemtype | (I) |
Set the persistent flag attribute for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
flag | (I) The persistent flag |
EINT_API int EINT_set_object_mapping_query_stmt | ( | tag_t | object_mapping, | |
const char * | query_stmt | |||
) |
Assigned the query_stmt attribute to the ObjectMapping.
object_mapping | (I) The ObjectMapping object tag |
query_stmt | (I) The SQL statement for the ObjectMapping |
Set the related to Item flag attribute for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
flag | (I) The related to Item flag |
EINT_API int EINT_set_object_mapping_store_procedure | ( | tag_t | object_mapping, | |
const char * | procedure_name | |||
) |
object_mapping | (I) |
procedure_name | (I) |
Set the update on save flag attribute for the ObjectMapping object.
object_mapping | (I) The ObjectMapping object tag |
flag | (I) The update on save flag |