Cluster Coordinator Context Reference

The following functions are added to the Cluster Coordinator global configuration context when its Enabled property is checked. All functions are also available as actions in the context menu of the Cluster Coordinator.

Add Tenant

Add a tenant to the cluster.

Function Name	addTenant
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	tenantID	String	Unique ID of the tenant.
	tenantDescription	String	Description of the tenant.
Output Records:	0
Output Format:	None

Remove Tenant

Remove the specified tenant from the cluster.

Function Name	removeTenant
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	removeTenant	String	Unique ID of the tenant.
Output Records:	0
Output Format:	None

Add Resource

This function helps the horizontal cluster to “register” an resource that already exists on a primary node. This resource gets added to the cluster’s resource registry and further managed by the cluster.

Add Resource function is normally used internally by the cluster once a primary node reports that a new resource was created. It should not be called manually.

Function Name	addResource
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	tenantID	String	Unique ID of the tenant to that the resource will be added.
	orgUnitUID	String	Unique ID of the organization unit to that the resource will be added.
	userUID	String	Unique ID of the user.
	resourcePath	String	Resource context path on the primary node.
	uid	String	Unique ID of the primary node to lookup the resource on.
Output Records:	0
Output Format:	None

Remove Resource

This function “unregisters” the resource from the cluster coordinator.

Remove Resource function is normally used internally by the cluster once a primary node reports that a resource was deleted. It should not be called manually.

Function Name	removeResource
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	tenantID	String	Unique ID of the tenant.
	resourcePath	String	Context path pf the resource.
	uid	String	Unique ID of the primary node.
Output Records:	0
Output Format:	None

Get Resources

List the resources and associated node information which belong to the target tenant, organization and user.

Function Name	getResources
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	tenantID	String	Unique ID of the tenant.
	orgUnitUID	String	Unique ID of the organization unit.
	userUID	String	Unique ID of the user.
Output Records:	0…unlimited
Output Format:	Name	Type	Description
	primaryNodeServerID	String	Primary node server ID.
	primaryNodeIpAddress	String	Primary node server address.
	primaryNodePort	String	Primary node server port.
	primaryNodeLogin	String	Primary node user login.
	primaryNodePassword	String	Primary node user password.
	primaryNodeResources	Data Table	Primary node resources table, with the columns: contextPath: Path to the resource permissionLevel: Permission level needed to access the resource

Get Permissions

Returns a list of permissions required to access resources which belong to a target tenant, organization and user.

This function is used internally by login servers. In most cases, is should not be called manually.

Function Name	getPermissions
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	tenantID	String	Unique ID of the tenant.
	orgUnitUID	String	Unique ID of the organization.
	userUID	String	Unique ID of the user.
Output Records:	0…Unlimited
Output Format:	Name	Type	Description
	contextPath	String	Path of the resource context.
	permissionLevel	String	Permission level needed to access the resource.

Allocate Node

Determines which primary node a new resource should be created on.

Function Name	allocateNode
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	tenantID	String	Unique ID of the tenant.
	orgUnitUID	String	Unique ID of the organization unit.
	userUID	String	Unique ID of the user.
	defaultTable	Data Table	Default table for the allocation expression evaluator.
Output Records:	1
Output Format:	Name	Type	Description
	primaryNodeServerID	String	Primary node server ID.
	primaryNodeIpAddress	String	Primary node server address.
	primaryNodePort	String	Primary node server port.
	primaryNodeLogin	String	Primary node user login.
	primaryNodePassword	String	Primary node user password.

Check Resource Name Availability

Check if a given resource path is available to be registered.

Function Name	checkResourceNameAvailability
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	tenantID	String	Unique ID of the tenant.
	resourcePath	String	Resource context path to check
Output Records:	1
Output Format:	Name	Type	Description
	nameAvailable	Boolean	Indicates whether the indicated resource path is available.
	path	String	Resource path.
	nodeUID	String	Node ID.

Add Primary Node

Adds a primary node to the cluster.

Function Name	addPrimaryNode
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	tenantID	String	Unique ID of the tenant.
	primaryNodeIpAddress	String	Primary node server address.
	primaryNodePort	String	Primary node server port.
	primaryNodeLogin	String	Primary node user login.
	primaryNodePassword	String	Primary node user password.
Output Records:	1
Output Format:	Name	Type	Description
	primaryNodeServerID	String	Primary node server ID.
	status	String	Status message.
	applicationParameters	Data Table	A table listing results of registering applications on the newly created node. It has the following fields: Application name Application deployment results

Remove Primary Node

Removes the indicated primary node and migrates all its resources according to the allocation rules. Returns a list of migrated resources and their migration status.

Function Name	removePrimaryNode
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	uid	String	Server ID of the primary node to be removed.
	tenantID	String	Unique ID of the tenant.
Output Records:	0…unlimited
Output Format:	Name	Type	Description
	primaryNodeServerID	String	ID of the primary node the resource was migrated to.
	resourceLocationsResourcePath	String	Resource context path.
	creationStatus	String	Resource creation status on the new primary node.
	removalStatus	String	Resource removal status.

Migrate Resources

Migrate the resources from indicated primary node and tenant according to allocation rules.

Function Name	migrateResources
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	uid	String	Primary node server ID.
	tenantID	String	Tenant ID.
	resourcesToMigrate	Data Table	Table of resources to migrate: contextPath - Path of resource serverId - Server ID to which to migrate resource
Output Records:	0…unlimited
Output Format:	Name	Type	Description
	primaryNodeServerID	String	Primary node server ID.
	resourceLocationsResourcePath	String	Unique resource path.
	creationStatus	String	Resource creation status on new primary node.
	removalStatus	String	Primary node removal status.

Scan Resources

Scan the primary node and tenant resources and populate the cluster coordinator with any unregistered resources. Only resources which passed the Allocation Rules will be added to the cluster coordinator.

Function Name	scanResources
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	uid	String	Primary node server ID.
	tenantID	String	Unique tenant ID.
Output Records:	0…unlimited
Output Format:	Name	Type	Description
	resourceLocationsResourcePath	String	Unique resource path.
	creationStatus	String	Resource creation status on cluster coordinator.

Drop Table

Removes specified table from the cluster coordinator database.

Function Name	dropTable
Permissions	Accessible at Administrator permission level
Input Format:	Name	Type	Description
	tableName	String	Name of table to remove.
	indexName	String	Name of index to remove.
	resourceFilters	Data Table	Resource Filters: filterExpression - Filter expression filterMask - Context mask
Output Records:	0
Output Format:	None

DPF_EXPORT_V5.8.8 / TIME_1743710566 / 2025-04-03 20:02:46 / STRLEN_28941 / STRLEN_HTML_31625

{VERSION}

Was this page helpful?