InternalSystemManager

Method Summary
InternalCloudDomain	addCloudDomain(String enterpriseId, String domain) Adds a new cloud domain associated with the specified enterprise.
String	authUser(String emailOrUsername, String password, String otpToken) Returns the profile ID of the personal profile for this user on success. Must be enabled by cloud settings. This will return null on failure. It will return 'OTP' if the user has OTP enabled in which case you must try again with an OTP value.
InternalKey	copyKey(InternalKey key, String name) Creates copy of this activation key
InternalKey	createActivationKey(String name, Data data) Creates a new InternalKey and binds it to the system enterprise with the specified settings.
	createAuthToken(String palId, String profileId, String ssoToken) Registers an SSO for the given user and pal. Must be enabled by cloud settings. Not permitted for system pals or system admins.
InternalEnterprise	createEnterprise(Data data) Creates an enterprise using the restricted key/values from the map-- see administrator documentation for more details. The active user is established as the owner of the Enterprise. Returns null if the Enterprise was not created successfully.
boolean	createModulePal(String palId) Creates a new global module pal.
boolean	createPalResource(String palId) Creates a new pal resource.
	createRemoteProvider(String providerUrl, Data providerData) Creates a new remote provider.
InternalStatBuilder	createStatBuilder() Returns a new StatBuilder.
String	createUserAccount(String firstName, String lastName, String email, String password, String salt, boolean encrypted) Creates a new user account and returns the profile ID on success.
boolean	deleteActivationKey(String id) Deletes the specified key. The key must not be associated with any pals or transactions. Returns true on success.
	deleteCloudDomain(String domain) Deletes the specified cloud domain.
	deleteRemoteProvider(String providerUrl) Deletes the remote provider.
	enableModulePal(String palId, boolean enable) Disables/enables the module pal.
PacketDataList	executeSQL(String sql) Executes the given select statement.
SystemDataView	getAcmeServices() Returns a view for ACME services.
InternalKey	getActivationKey(String id) Returns the InternalKey identified by id.
SystemDataView	getActivationKeyAdjustments(InternalKey key) Returns a view for accessing adjustments for the specified key. The active user must have the accounting permission.
SystemDataView	getActivationKeyChanges(InternalKey key) Returns a view for accessing the history for the specified key.
SystemDataView	getActivationKeys() Returns a view for accessing all activation keys.
BillingEngine	getBillingEngine(String palId) Returns the billing engine for the specified Pal. Returns null if the Pal's Activation Key does not enable pal billing.
SystemDataView	getBillingHistory() Returns a view for accessing billing history.
InternalCloudDomain	getCloudDomain(String domain) Returns the specified cloud domain.
SystemDataView	getCloudDomains() Returns a view for accessing all cloud domains.
InternalStatement	getCurrentStatement(InternalEnterprise enterprise) Returns the current statement for the specified enterprise. If no statement exists for the current cycle, one is created.
DataList	getDeprecation(String palId) Returns list of deprecation information for the specified pal.
InternalDevelopmentPal	getDevelopmentPal(String palId) Returns the specified development pal.
InternalEnterprise	getEnterprise(String id) Returns the specified enterprise.
CacheManager	getEnterpriseCacheManager(String palId) Returns the CacheManager for the Pal with an access level of enterprise. Any Pal in the enterprise can access and modify cached objects. Use this with caution.
DataList	getMatchingEmails(String email) Returns list of profiles that match the email pattern. Requires support permission
DataList	getModuleDependencies(String palId) Returns a datalist of dependencies for the given module pal.
SystemDataView	getModulePals() Returns a view for accessing all module pals.
CacheManager	getPalCacheManager(String palId) Returns the CacheManager for the Pal.
PalInfo	getPalInfo(String palId) Returns the PalInfo for the specified palId.
InternalPalStore	getPalStore() Returns the Pal Store.
SystemDataView	getProfiles(String type) Returns a view for profiles.
SystemDataView	getRemoteProviders() Returns a view for remote providers.
RuntimePal	getRuntimePal(String palId) Returns the specified pal.
SystemDataView	getScanResults() Returns a view for accessing scan results.
InternalStatement	getStatement(String id) Returns the statement identified by id.
SystemDataView	getStatements() Returns a view for accessing all statements.
DataList	getStorageProviders() Returns list of storage provider ids, names and types registered for the system enterprise
InternalSupportProfile	getSupportProfile(String profileId) Returns specified Profile.
SystemDataView	getSystemDomains(String enterpriseId) Returns a view for accessing domains, optionally for a specific enterprise.
SystemDataView	getSystemEnterprises() Returns a view for accessing enterprises.
SystemDataView	getSystemPals(String enterpriseId) Returns a view for accessing pals, optionally for a specific enterprise.
InternalUser	getUser(String sessionToken) Returns an Internal User from the given sessionToken. See User.createSessionToken().
SystemDataView	getUsers() Returns a view for users.
	optimizeTable(String table) Runs an optimize table request. Warning, this may lock the entire system for an extreme amount of time, depending on the size of the table. Requires system admin permission.
boolean	removeModulePal(String palId) Deletes the unused module pal.
boolean	removePalResource(String palId) Deletes the pal resource.
	repairTable(String table) Runs a repair table request. Warning, this may lock the entire system for an extreme amount of time, depending on the size of the table. Requires system admin permission.
boolean	syncPalResource(String palId) Re-deploys the pal resource, updating its content with the underlying test pal.
	updateRemoteProvider(String providerUrl, Data providerData) Updates the remote provider.

Method Detail

InternalCloudDomain addCloudDomain(String enterpriseId, String domain)

Adds a new cloud domain associated with the specified enterprise.

Parameters:

String enterpriseId Required parameter.
String domain Required parameter.

Returns: InternalCloudDomain

Since: 04-03-2021

top

String authUser(String emailOrUsername, String password, String otpToken)

Returns the profile ID of the personal profile for this user on success. Must be enabled by cloud settings. This will return null on failure. It will return 'OTP' if the user has OTP enabled in which case you must try again with an OTP value.

Parameters:

String emailOrUsername Required parameter. Maximum allowed size of parameter: 80
String password Required parameter. Maximum allowed size of parameter: 255
String otpToken Maximum allowed size of parameter: 10

Returns: String

Since: 03-29-2022

top

InternalKey copyKey(InternalKey key, String name)

Creates copy of this activation key

Parameters:

InternalKey key - key to copy. Required parameter.
String name - new key name. Required parameter.

Returns: InternalKey

Since: 01-16-2012

top

InternalKey createActivationKey(String name, Data data)

Creates a new InternalKey and binds it to the system enterprise with the specified settings.

Parameters:

String name - activation key name. Required parameter. Maximum allowed size of parameter: 50
Data data Required parameter.

Returns: InternalKey

Since: 03-08-2010

top

createAuthToken(String palId, String profileId, String ssoToken)

Registers an SSO for the given user and pal. Must be enabled by cloud settings. Not permitted for system pals or system admins.

Parameters:

String palId Required parameter.
String profileId Required parameter.
String ssoToken Required parameter. Maximum allowed size of parameter: 255

Since: 12-14-2023

top

InternalEnterprise createEnterprise(Data data)

Creates an enterprise using the restricted key/values from the map-- see administrator documentation for more details. The active user is established as the owner of the Enterprise. Returns null if the Enterprise was not created successfully.

Parameters:

Data data Required parameter.

Returns: InternalEnterprise

Since: 10-15-2019

top

boolean createModulePal(String palId)

Creates a new global module pal.

Parameters:

String palId

Returns: boolean

Since: 04-29-2021

top

boolean createPalResource(String palId)

Creates a new pal resource.

Parameters:

String palId

Returns: boolean

Since: 12-08-2015

top

createRemoteProvider(String providerUrl, Data providerData)

Creates a new remote provider.

Parameters:

String providerUrl
Data providerData

Since: 07-17-2013

top

InternalStatBuilder createStatBuilder()

Returns a new StatBuilder.

Returns: InternalStatBuilder

Since: 02-18-2011

top

String createUserAccount(String firstName, String lastName, String email, String password, String salt, boolean encrypted)

Creates a new user account and returns the profile ID on success.

Parameters:

String firstName Required parameter. Maximum allowed size of parameter: 30
String lastName Required parameter. Maximum allowed size of parameter: 30
String email Required parameter. Maximum allowed size of parameter: 80
String password - If empty, a random password will be generated. Maximum allowed size of parameter: 255
String salt Maximum allowed size of parameter: 255
boolean encrypted - If true, you are providing a password and salt that meet the cloud's configured hash algorithm and therefore it will be stored intact.. Required parameter.

Returns: String

Since: 08-08-2017

top

boolean deleteActivationKey(String id)

Deletes the specified key. The key must not be associated with any pals or transactions. Returns true on success.

Parameters:

String id Required parameter.

Returns: boolean

Since: 06-07-2010

top

deleteCloudDomain(String domain)

Deletes the specified cloud domain.

Parameters:

String domain Required parameter.

Since: 04-03-2021

top

deleteRemoteProvider(String providerUrl)

Deletes the remote provider.

Parameters:

String providerUrl

Since: 07-17-2013

top

enableModulePal(String palId, boolean enable)

Disables/enables the module pal.

Parameters:

String palId
boolean enable

Since: 04-29-2021

top

PacketDataList executeSQL(String sql)

Executes the given select statement.

Parameters:

String sql

Returns: PacketDataList

Since: 04-08-2024

top

SystemDataView getAcmeServices()

Returns a view for ACME services.

Returns: SystemDataView

DataList Name: AcmeServices

DataList Keys/Column Name	Column Type	Read Only
enterpriseId	String
enterpriseName	String
domain	String
status	String
orderStatus	String
target	String
email	String
jobId	String
createDate	Date
modifiedDate	Date
renewalDate	Date
lastTrigger	Date
includeRoot	Boolean

Since: 08-30-2021

top

InternalKey getActivationKey(String id)

Returns the InternalKey identified by id.

Parameters:

String id Required parameter.

Returns: InternalKey

Since: 03-08-2010

top

SystemDataView getActivationKeyAdjustments(InternalKey key)

Returns a view for accessing adjustments for the specified key. The active user must have the accounting permission.

Parameters:

InternalKey key - activation key. Required parameter.

Returns: SystemDataView

DataList Name: SystemKeyAdjustments

DataList Keys/Column Name	Column Type	Read Only
id	Number
statementId	Number
createDate	Date
effectiveDate	Date
description	String
amount	Decimal
type	Number
firstName	String
lastName	String

Since: 04-15-2010

top

SystemDataView getActivationKeyChanges(InternalKey key)

Returns a view for accessing the history for the specified key.

Parameters:

InternalKey key - activation key. Required parameter.

Returns: SystemDataView

DataList Name: SystemKeyChanges

DataList Keys/Column Name	Column Type	Read Only
id	Number
modifiedDate	Date
pricingModel	String
pricingPlan	String
firstName	String
lastName	String

Since: 04-16-2010

top

SystemDataView getActivationKeys()

Returns a view for accessing all activation keys.

Returns: SystemDataView

DataList Name: SystemKeys

DataList Keys/Column Name	Column Type	Read Only
id	String
name	String
authEnabled	Boolean
storeEnabled	Boolean
repoEnabled	Boolean
createDate	Date
modifiedDate	Date
nextChangeDate	Date
nextChangeComment	Date
active	Boolean
status	String
type	String
pricingModel	String
pricingPlan	String
enterpriseName	String
firstName	String
lastName	String
modFirstName	String
modLastName	String

Since: 03-08-2010

top

BillingEngine getBillingEngine(String palId)

Returns the billing engine for the specified Pal. Returns null if the Pal's Activation Key does not enable pal billing.

Parameters:

String palId Required parameter.

Returns: BillingEngine

Since: 10-08-2020

top

SystemDataView getBillingHistory()

Returns a view for accessing billing history.

Returns: SystemDataView

DataList Name: SystemBillingHistory

DataList Keys/Column Name	Column Type	Read Only
id	Number
worker	String
billingDate	Date
customersInvoiced	Number
newTransactions	Number
totalTransactions	Number
finishDate	Date

Since: 05-13-2010

top

InternalCloudDomain getCloudDomain(String domain)

Returns the specified cloud domain.

Parameters:

String domain Required parameter.

Returns: InternalCloudDomain

Since: 04-03-2021

top

SystemDataView getCloudDomains()

Returns a view for accessing all cloud domains.

Returns: SystemDataView

DataList Name: CloudDomains

DataList Keys/Column Name	Column Type	Read Only
domain	String
logoutUrl	String
cancelUrl	String
createDate	Date
modifiedDate	Date
title	String
fromName	String
fromEmail	String
palName	String
palId	String
enterpriseName	String
enterpriseId	String

Since: 04-03-2021

top

InternalStatement getCurrentStatement(InternalEnterprise enterprise)

Returns the current statement for the specified enterprise. If no statement exists for the current cycle, one is created.

Parameters:

InternalEnterprise enterprise Required parameter.

Returns: InternalStatement

Since: 09-03-2010

top

DataList getDeprecation(String palId)

Returns list of deprecation information for the specified pal.

Parameters:

String palId Required parameter.

Returns: DataList

DataList Name: deprecationList
DataList Fields: name, tag, attribute

Since: 07-25-2018

top

InternalDevelopmentPal getDevelopmentPal(String palId)

Returns the specified development pal.

Parameters:

String palId

Returns: InternalDevelopmentPal

Since: 08-02-2020

top

InternalEnterprise getEnterprise(String id)

Returns the specified enterprise.

Parameters:

String id Required parameter.

Returns: InternalEnterprise

Since: 09-03-2010

top

CacheManager getEnterpriseCacheManager(String palId)

Returns the CacheManager for the Pal with an access level of enterprise. Any Pal in the enterprise can access and modify cached objects. Use this with caution.

Parameters:

String palId

Returns: CacheManager

Since: 04-22-2021

top

DataList getMatchingEmails(String email)

Returns list of profiles that match the email pattern. Requires support permission

Parameters:

String email

Returns: DataList

DataList Name: emails
DataList Fields: profileId, email

Since: 05-13-2015

top

DataList getModuleDependencies(String palId)

Returns a datalist of dependencies for the given module pal.

Parameters:

String palId

Returns: DataList

Since: 04-29-2021

top

SystemDataView getModulePals()

Returns a view for accessing all module pals.

Returns: SystemDataView

DataList Name: ModulePals

DataList Keys/Column Name	Column Type	Read Only
id	String
palId	String
name	String
description	String
createDate	Date
modifiedDate	Date
enterpriseGuid	String
enterpriseName	String
enabled	Boolean

Since: 04-29-2021

top

CacheManager getPalCacheManager(String palId)

Returns the CacheManager for the Pal.

Parameters:

String palId

Returns: CacheManager

Since: 04-22-2021

top

PalInfo getPalInfo(String palId)

Returns the PalInfo for the specified palId.

Parameters:

String palId

Returns: PalInfo

Since: 05-13-2015

top

InternalPalStore getPalStore()

Returns the Pal Store.

Returns: InternalPalStore

Since: 06-12-2018

top

SystemDataView getProfiles(String type)

Returns a view for profiles.

Parameters:

String type Required parameter. Allowed values: personal, enterprise, system.

Returns: SystemDataView

DataList Name: SystemProfiles

DataList Keys/Column Name	Column Type	Read Only
id	String
firstName	String
lastName	String
email	String
lastAccess	Date
disabled	Boolean
deleted	Boolean
systemDisabled	Boolean
enterpriseId	Number
enterprise	String

Since: 09-19-2012

top

SystemDataView getRemoteProviders()

Returns a view for remote providers.

Returns: SystemDataView

DataList Name: RemoteProviders

DataList Keys/Column Name	Column Type	Read Only
remoteUrl	String
company	String
productSite	String
comments	String
status	String
createDate	Date
modifiedDate	Date
modifiedBy	String

Since: 07-17-2013

top

RuntimePal getRuntimePal(String palId)

Returns the specified pal.

Parameters:

String palId

Returns: RuntimePal

Since: 01-31-2022

top

SystemDataView getScanResults()

Returns a view for accessing scan results.

Returns: SystemDataView

DataList Name: ScanResults

DataList Keys/Column Name	Column Type	Read Only
scanId	Number
fileSize	Number
scanTime	Number
clean	Boolean
virus	String
available	Boolean
scanDate	Date
filename	String
testPal	Boolean
palName	String
palId	String
enterprise	String
eid	Number

Since: 12-11-2018

top

InternalStatement getStatement(String id)

Returns the statement identified by id.

Parameters:

String id Required parameter.

Returns: InternalStatement

Since: 04-27-2010

top

SystemDataView getStatements()

Returns a view for accessing all statements.

Returns: SystemDataView

DataList Name: SystemStatements

DataList Keys/Column Name	Column Type	Read Only
enterpriseName	String
enterpriseId	Number
autoInvoice	Boolean
invoiceMethod	Boolean
statementId	Number
billingId	Number
statementDate	Date
amount	Decimal
failReason	String
authorization	String
transactionId	String
status	Number
paidDate	Date
docExecCount	Number
docStorageCount	Number
txExecCount	Number
txAccessCount	Number
txArchiveCount	Number
consolePersonalCount	Number
consoleEnterpriseCount	Number
webCount	Number
datasetCount	Number
storageCount	Number
docExecFee	Decimal
docStorageFee	Decimal
txExecFee	Decimal
txAccessFee	Decimal
txArchiveFee	Decimal
consolePersonalFee	Decimal
consoleEnterpriseFee	Decimal
webFee	Decimal
datasetFee	Decimal
monthlyFee	Decimal
hostingFee	Decimal
storageFee	Decimal
adjustmentFee	Decimal
palBillingFee	Decimal
totalFee	Decimal

Since: 04-27-2010

top

DataList getStorageProviders()

Returns list of storage provider ids, names and types registered for the system enterprise

Returns: DataList

DataList Name: providers
DataList Fields: sid, name, type

Since: 06-16-2015

top

InternalSupportProfile getSupportProfile(String profileId)

Returns specified Profile.

Parameters:

String profileId

Returns: InternalSupportProfile

Since: 05-13-2015

top

SystemDataView getSystemDomains(String enterpriseId)

Returns a view for accessing domains, optionally for a specific enterprise.

Parameters:

String enterpriseId

Returns: SystemDataView

DataList Name: SystemDomains

DataList Keys/Column Name	Column Type	Read Only
guid	String
dnsDomainName	String
active	Boolean
enterpriseName	String
enterpriseId	String

Since: 01-27-2021

top

SystemDataView getSystemEnterprises()

Returns a view for accessing enterprises.

Returns: SystemDataView

DataList Name: SystemEnterprises

DataList Keys/Column Name	Column Type	Read Only
id	String
name	String
address	String
city	String
state	String
zip	String
country	String
phone	String
fax	String
timezone	String
language	String
invoiceDay	Number
createDate	Date
deleted	Boolean
disabled	Boolean
markedForDelete	Boolean
autoInvoice	Boolean
autoDelete	Boolean
autoArchive	Boolean
storeEnabled	Boolean
globalOptOut	Boolean
strongPasswords	Boolean
passwordInterval	Number
resellerId	Number
resellerClientCode	String
vaultId	String
licensedUsers	Number
partnerStatus	String

Since: 09-03-2010

top

SystemDataView getSystemPals(String enterpriseId)

Returns a view for accessing pals, optionally for a specific enterprise.

Parameters:

String enterpriseId

Returns: SystemDataView

DataList Name: SystemPals

DataList Keys/Column Name	Column Type	Read Only
id	String
palId	String
name	String
description	String
category	String
host	String
authDomain	String
createDate	Date
modifiedDate	Date
deprecated	Date
runDate	Date
testPal	Boolean
modeConsole	Boolean
modeTransaction	Boolean
modeWeb	Boolean
type	String
autoTest	Boolean
resource	Boolean
enterpriseId	Number
module	Boolean
enterpriseName	String

Since: 02-18-2011

top

InternalUser getUser(String sessionToken)

Returns an Internal User from the given sessionToken. See User.createSessionToken().

Parameters:

String sessionToken Required parameter.

Returns: InternalUser

Since: 01-27-2021

top

SystemDataView getUsers()

Returns a view for users.

Returns: SystemDataView

DataList Name: SystemUserAccounts

DataList Keys/Column Name	Column Type	Read Only
id	String
firstName	String
lastName	String
email	String
systemDisabled	Boolean
lastAccess	Date
createDate	Date
disabled	Boolean
deleted	Boolean
deleted	Boolean
exclusive	Boolean
authLevel	Small unsigned integer
uId	String

Since: 06-26-2015

top

optimizeTable(String table)

Runs an optimize table request. Warning, this may lock the entire system for an extreme amount of time, depending on the size of the table. Requires system admin permission.

Parameters:

String table Required parameter.

Since: 02-07-2019

top

boolean removeModulePal(String palId)

Deletes the unused module pal.

Parameters:

String palId

Returns: boolean

Since: 04-29-2021

top

boolean removePalResource(String palId)

Deletes the pal resource.

Parameters:

String palId

Returns: boolean

Since: 12-08-2015

top

repairTable(String table)

Runs a repair table request. Warning, this may lock the entire system for an extreme amount of time, depending on the size of the table. Requires system admin permission.

Parameters:

String table Required parameter.

Since: 02-07-2019

top

boolean syncPalResource(String palId)

Re-deploys the pal resource, updating its content with the underlying test pal.

Parameters:

String palId

Returns: boolean

Since: 12-08-2015

top

updateRemoteProvider(String providerUrl, Data providerData)

Updates the remote provider.

Parameters:

String providerUrl
Data providerData

Since: 07-17-2013

top

API Date: Dec 03, 2024 10:24 AM