Micro Focus Content Manager SDK 10.1
TRIM.SDK.TrimEnterpriseConfiguration Class Reference

The TrimConfiguration class represents the current configuration of TRIM as managed by the TRIM Enterprise Studio It is only accessible from the server-side machine used to configure the TRIM enterprise. More...

Public Member Functions

 TrimEnterpriseConfiguration ()
 Constructs a TRIM configuration object which will allow you edit details of this configuration More...
 
TrimEnterpriseDataset NewDataset (DatabaseTypes dbType, string dbid, string dbName)
 Creates a new dataset in this configuration More...
 
TrimEnterpriseDataset FindDataset (string withDbid)
 Find a dataset in this configuration with the supplied dataset id More...
 
TrimEnterpriseDataset GetDataset (uint idx)
 Gets the dataset at the nominated index - this allows you to iterate all the datasets in this configuration More...
 
TrimEnterpriseWorkgroupServer NewWorkgroupServer (string serverName, int tcpPortNumber)
 Creates a new workgroup server in this configuration, automatically allocates it a new id More...
 
TrimEnterpriseWorkgroupServer FindWorkgroupServer (string withId)
 Find a workgroup server in this configuration with the supplied id More...
 
TrimEnterpriseWorkgroupServer GetWorkgroupServer (uint idx)
 Gets the workgroup server at the nominated index - this allows you to iterate all the workgroup servers in this configuration More...
 
void Save ()
 Commits the changes made to the configuration by saving the .tcfg file to the appropriate place on the disk. More...
 
void Deploy ()
 Deploys any changes made to the configuration to all workgroup servers in the configuration More...
 

Protected Attributes

bool swigCMemOwn
 

Properties

uint DatasetCount [get]
 Returns the number of datasets in this configuration More...
 
uint WorkgroupServerCount [get]
 Returns the number of workgroup servers in this configuration More...
 
bool IsModified [get]
 Gets a boolean property indicating if there are any changes to this config file that need to be saved or deployed. More...
 
string ConfigFileName [get]
 Gets a string property indicating the name of the .tcfg file being edited More...
 

Detailed Description

The TrimConfiguration class represents the current configuration of TRIM as managed by the TRIM Enterprise Studio It is only accessible from the server-side machine used to configure the TRIM enterprise.

Constructor & Destructor Documentation

◆ TrimEnterpriseConfiguration()

TRIM.SDK.TrimEnterpriseConfiguration.TrimEnterpriseConfiguration ( )

Constructs a TRIM configuration object which will allow you edit details of this configuration

Member Function Documentation

◆ Deploy()

void TRIM.SDK.TrimEnterpriseConfiguration.Deploy ( )

Deploys any changes made to the configuration to all workgroup servers in the configuration

◆ FindDataset()

TrimEnterpriseDataset TRIM.SDK.TrimEnterpriseConfiguration.FindDataset ( string  withDbid)

Find a dataset in this configuration with the supplied dataset id

◆ FindWorkgroupServer()

TrimEnterpriseWorkgroupServer TRIM.SDK.TrimEnterpriseConfiguration.FindWorkgroupServer ( string  withId)

Find a workgroup server in this configuration with the supplied id

◆ GetDataset()

TrimEnterpriseDataset TRIM.SDK.TrimEnterpriseConfiguration.GetDataset ( uint  idx)

Gets the dataset at the nominated index - this allows you to iterate all the datasets in this configuration

◆ GetWorkgroupServer()

TrimEnterpriseWorkgroupServer TRIM.SDK.TrimEnterpriseConfiguration.GetWorkgroupServer ( uint  idx)

Gets the workgroup server at the nominated index - this allows you to iterate all the workgroup servers in this configuration

◆ NewDataset()

TrimEnterpriseDataset TRIM.SDK.TrimEnterpriseConfiguration.NewDataset ( DatabaseTypes  dbType,
string  dbid,
string  dbName 
)

Creates a new dataset in this configuration

◆ NewWorkgroupServer()

TrimEnterpriseWorkgroupServer TRIM.SDK.TrimEnterpriseConfiguration.NewWorkgroupServer ( string  serverName,
int  tcpPortNumber 
)

Creates a new workgroup server in this configuration, automatically allocates it a new id

◆ Save()

void TRIM.SDK.TrimEnterpriseConfiguration.Save ( )

Commits the changes made to the configuration by saving the .tcfg file to the appropriate place on the disk.

Member Data Documentation

◆ swigCMemOwn

bool TRIM.SDK.TrimEnterpriseConfiguration.swigCMemOwn
protected

Property Documentation

◆ ConfigFileName

string TRIM.SDK.TrimEnterpriseConfiguration.ConfigFileName
get

Gets a string property indicating the name of the .tcfg file being edited

◆ DatasetCount

uint TRIM.SDK.TrimEnterpriseConfiguration.DatasetCount
get

Returns the number of datasets in this configuration

◆ IsModified

bool TRIM.SDK.TrimEnterpriseConfiguration.IsModified
get

Gets a boolean property indicating if there are any changes to this config file that need to be saved or deployed.

◆ WorkgroupServerCount

uint TRIM.SDK.TrimEnterpriseConfiguration.WorkgroupServerCount
get

Returns the number of workgroup servers in this configuration