Provides methods that deal with job scheduling and session variables More...
Public Member Functions | |
string | AddAssetData (string sessionId, string assetName, byte[] assetData) |
Adds the asset with the specified name to default category and type as miscellaneous. More... | |
JobScheduleIdentity | AddJobSchedule (string sessionId, JobSchedule jobSchedule) |
Schedule one or more jobs to run at a specific time period or interval. More... | |
void | AddSessionVariable (string sessionId, SessionVariable sessionVariable) |
Adds a new session variable with the specified details. More... | |
void | DeleteAssetData (string sessionId, string assetId) |
Deletes the asset with the specified asset Id. More... | |
void | DeleteJobSchedule (string sessionId, JobScheduleIdentity jobScheduleIdentity) |
Deletes the specified job schedule. More... | |
void | DeleteRecentItems (string sessionId) |
Deletes all the latest accessed items from the recent items table for the current loggedon user. More... | |
void | DeleteSessionVariable (string sessionId, SessionVariableIdentity sessionVariableIdentity) |
Deletes the specified session variable. More... | |
void | ExecuteAutoStoreNode (string sessionId, IntegrationSiteIdentity2 integrationSiteIdentity, string documentId, string folderId, short fileType, bool submitRejectedDocuments) |
Sends document or documents in a folder to Autostore server with the specified file type. More... | |
byte[] | ExportPackage (string sessionId, PackageExportOptions options) |
This function is deprecated. Please use ExportPackage2 instead Compresses the specified processes, reports, skins, forms, dashboards, work allocation rules, localistaion strings, alerts and events into a compressed package for export to a file. More... | |
byte[] | ExportPackage2 (string sessionId, PackageExportOptions2 options) |
Compresses the specified processes, reports, skins, forms, dashboards, work allocation rules, localistaion strings, alerts and events into a compressed package for export to a file. More... | |
void | ForceAllUsersToChangePasswordOnNextLogon (string sessionId) |
Forces all users to change password on next logon. More... | |
void | GenerateNewSecurityKey (string sessionId) |
Generates the new security key. More... | |
byte[] | GetAssetData (string sessionId, string assetId) |
Gets the asset data. More... | |
AuditCategorisations | GetAuditCategorisations (string sessionId) |
Gets the audit categorisations. More... | |
AuditEntryCollection | GetAuditEntries (string sessionId, AuditTypeCollection auditTypes, DateTime fromDate, DateTime toDate) |
This function is deprecated. Please use GetAuditEntries2 instead Retrieves the audit log entries based on the requested audit type. More... | |
AuditEntry2Collection | GetAuditEntries2 (string sessionId, AuditTypeCollection auditTypes, DateTime fromDate, DateTime toDate, short category, short level) |
Retrieves the audit log entries based on the requested audit type, category, level and date filters. More... | |
AuditEntry2Collection | GetAuditEntries3 (string sessionId, AuditEntriesFilter filter) |
Retrieves the audit log entries based on the filter. More... | |
AuditTypeCollection | GetAuditEntryTypes (string sessionId) |
Gets the audit entry types. More... | |
ProjectIdentityCollection | GetCaptureProjectsToPreload (string sessionId) |
Gets the capture projects to preload. More... | |
LatestImportConnections | GetLatestImportConnections (string sessionId) |
Gets the Lastest modified datetime and total import connections. More... | |
LookupCollection | GetLookups2 (LookupIdentityCollection lookupIdentityCollection) |
Gets the lookups for the specified lookup identities. More... | |
PageRenditionCollection | GetPageRenditions (string sessionId) |
Gets the page renditions. More... | |
RecentItemCollection | GetRecentItems (string sessionId, RecentItemFilter recentItemFilter) |
Retrieves the latest accessed items of the loggedon user. More... | |
ReportingTagCollection | GetReportingTags (string sessionId) |
Gets the reporting tags. More... | |
RetentionPolicyFailureCollection | GetRetentionPolicyFailures (string sessionId, RetentionPolicyFailureFilterCriteria filter) |
Gets the retention policy failures. More... | |
RetentionPolicyFailureTypeCollection | GetRetentionPolicyFailureTypes (string sessionId) |
Gets the retention policy failure types. More... | |
ScanVrsProfileCollection | GetScanVrsProfilesConfiguration (string sessionId, ScanVrsProfileIdentityCollection vrsProfileIdentities) |
Gets the scan VRS profiles configuration. More... | |
ServerSettingsSummary | GetServerSettingsSummary (string sessionId) |
Gets the server settings summary. More... | |
VariableSummaryCollection | GetServerVariables (string sessionId, ServerVariablesFilter serverVariablesFilter) |
Retrieves a list of server variables from the specified server using the given search criteria. More... | |
SessionVariableCollection | GetSessionVariables (string sessionId, SessionVariableFilter sessionVariableFilter) |
Gets the session variables. More... | |
void | ImportPackage (ImportPackageParameter importParameter) |
This function is deprecated. Please use ImportPackage3 instead Imports a package fro ma compressed file More... | |
ImportPackageResult | ImportPackage2 (string sessionId, byte[] packageData, PackageImportOptions2 importOptions) |
This function is deprecated. Please use ImportPackage3 instead Imports a compressed package More... | |
ImportPackageResult | ImportPackage3 (string sessionId, byte[] packageData, PackageImportOptions3 importOptions, short packageImportType) |
Extracts contents from compressed package and imports them in to DB based on Package Import Type More... | |
void | RemoveAllAuditLogEntries (string sessionId) |
Removes all audit log entries. More... | |
void | RemoveAuditLogEntries (string sessionId, short auditType, DateTime fromDate, DateTime toDate) |
Removes the audit log entries. More... | |
void | RemoveCompletedJobs (string sessionId, DateTime dateFrom, DateTime dateTo) |
Removes jobs completed within the given period. The dateFrom and dateTo parameters are mandatory. If their values are not provided, an exception is raised. If incorrect dateTime value is provided as input, a conversion exception is raised. More... | |
void | SavePageRenditions (string sessionId, PageRenditionCollection pageRenditions) |
Adds the page rendition. More... | |
void | SaveReportingTags (string sessionId, ReportingTagCollection reportingTags) |
Adds the reporting tags. More... | |
void | SendEmail2 (string sessionId, EmailInfo2 emailInfo) |
Sends the email to the recipients specified in the EmailInfo2 class fields through the preconfigured SMTP server in the KTA designer. More... | |
void | UpdateFederatedAuthenticationSetting (string sessionId, bool useFederatedAuthentication) |
Updates the system settings to turn Federated Authentication on or off More... | |
void | UpdateJobSchedule (string sessionId, JobSchedule jobSchedule) |
Modifies the Job schedule. More... | |
void | UpdateServerSettings3 (string sessionId, ServerSettings3 serverSettingInformation) |
Updates the server settings. More... | |
string | UpdateServerSettings4 (string sessionId, ServerSettings3 serverSettingInformation, short settingsSection) |
Updates the server settings. More... | |
void | UpdateServerVariables (string sessionId, VariableValue2Collection updatedVariables) |
Updates the value of the specified server variables. If one of the variables in the collection has an incorrect ID or incorrect type of value, no variables are updated. If no variables are provided for update, the “value cannot be null” exception is raised. More... | |
void | UpdateSessionVariable (string sessionId, SessionVariable sessionVariable) |
Updates the specified session variable with the given details. More... | |
RuleValidationResult | ValidateRule (string sessionId, Agility.Sdk.Model.Rules.Rule rule) |
Validates the rule. More... | |
RuleValidationResultCollection | ValidateRules (string sessionId, RuleCollection rules) |
Validates the rule. More... | |
Provides methods that deal with job scheduling and session variables
string AddAssetData | ( | string | sessionId, |
string | assetName, | ||
byte[] | assetData | ||
) |
Adds the asset with the specified name to default category and type as miscellaneous.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
assetName | Asset name that needs to be added |
assetData | Asset data in bytes. |
JobScheduleIdentity AddJobSchedule | ( | string | sessionId, |
JobSchedule | jobSchedule | ||
) |
Schedule one or more jobs to run at a specific time period or interval.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobSchedule | JobSchedule that conatins the details of the job schedule to add.
|
Name | Type | Comment |
---|---|---|
Id | Int32 | Id of the new schedule |
Name | String | Name of the new schedule |
Interval | Monthly | TimeSpanInMinutes | DaysOfWeek | StartDate | EndDate | NoOfOccurs |
---|---|---|---|---|---|---|
Once | 0 | 0 | Not Used | Used | Not used | Not used |
Every (x) minutes | 0 | x | See DaysOfWeek for details | Used | Used | Used |
Hourly | 0 | 60 * number of hours | See DaysOfWeek for details | Used | Used | Used |
Daily | 0 | 1440 * number of days | See DaysOfWeek for details | Used | Used | Used |
Weekly | 0 | 10080 * number of weeks | Not Used | Used | Used | Used |
Monthly | 1 | number of months | Not Used | Used | Used | Used |
Day | Value |
---|---|
Sunday | 2 |
Monday | 4 |
Tuesday | 8 |
Wednesday | 16 |
Thursday | 32 |
Friday | 64 |
Saturday | 128 |
Days | Values to add | Result |
---|---|---|
Mon,Weds,Fri | 4 + 16 + 64 | 84 |
Mon - Fri | 4 + 8 + 16 + 32 + 64 | 124 |
Mon - Sun | 2 + 4 + 8 + 16 + 32 + 64 + 128 | 254 |
void AddSessionVariable | ( | string | sessionId, |
SessionVariable | sessionVariable | ||
) |
Adds a new session variable with the specified details.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
sessionVariable | A SessionVariable object that has the details of the session variable to add.
|
void DeleteAssetData | ( | string | sessionId, |
string | assetId | ||
) |
Deletes the asset with the specified asset Id.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
assetId | Id of the asset that has to be deleted. |
void DeleteJobSchedule | ( | string | sessionId, |
JobScheduleIdentity | jobScheduleIdentity | ||
) |
Deletes the specified job schedule.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
jobScheduleIdentity | The job schedule identity.
|
void DeleteRecentItems | ( | string | sessionId | ) |
Deletes all the latest accessed items from the recent items table for the current loggedon user.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
void DeleteSessionVariable | ( | string | sessionId, |
SessionVariableIdentity | sessionVariableIdentity | ||
) |
Deletes the specified session variable.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
sessionVariableIdentity | The SessionVariableIdentity to be deleted.
|
void ExecuteAutoStoreNode | ( | string | sessionId, |
IntegrationSiteIdentity2 | integrationSiteIdentity, | ||
string | documentId, | ||
string | folderId, | ||
short | fileType, | ||
bool | submitRejectedDocuments | ||
) |
Sends document or documents in a folder to Autostore server with the specified file type.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
integrationSiteIdentity | A integrationSiteIdentity object containing the integration identity for AutoStore server. |
documentId | The document id to be passed, if a single document needs to submit into the AutoStore server. |
folderId | The folder id to be passed, if all documents in the folder needs to submit into the AutoStore server. |
fileType | The file type of the file. |
submitRejectedDocuments | Represents whether or not to submit rejected documents with the RejectionReason "Unable to submit to ControlSuite". |
byte [] ExportPackage | ( | string | sessionId, |
PackageExportOptions | options | ||
) |
This function is deprecated. Please use ExportPackage2 instead
Compresses the specified processes, reports, skins, forms, dashboards, work allocation rules, localistaion strings, alerts and events into a compressed package for export to a file.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options | PackageExportOptions object that conatins the export options.
|
byte []
array which is not directly supported by the TotalAgility designer. For an example of using the returned data please see herebyte [] ExportPackage2 | ( | string | sessionId, |
PackageExportOptions2 | options | ||
) |
Compresses the specified processes, reports, skins, forms, dashboards, work allocation rules, localistaion strings, alerts and events into a compressed package for export to a file.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options | A PackageExportOptions2 object containing various options to export a package.
|
byte []
array which is not directly supported by the TotalAgility designer. For an example of using the returned data please see herevoid ForceAllUsersToChangePasswordOnNextLogon | ( | string | sessionId | ) |
Forces all users to change password on next logon.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
void GenerateNewSecurityKey | ( | string | sessionId | ) |
Generates the new security key.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
byte [] GetAssetData | ( | string | sessionId, |
string | assetId | ||
) |
Gets the asset data.
sessionId | The session identifier. |
assetId | The asset identifier. |
AuditCategorisations GetAuditCategorisations | ( | string | sessionId | ) |
Gets the audit categorisations.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
AuditEntryCollection GetAuditEntries | ( | string | sessionId, |
AuditTypeCollection | auditTypes, | ||
DateTime | fromDate, | ||
DateTime | toDate | ||
) |
This function is deprecated. Please use GetAuditEntries2 instead
Retrieves the audit log entries based on the requested audit type.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
auditTypes | A collection of type AuditType containing various AuditEntryType values. |
fromDate | From date. |
toDate | To date. The time part of the datetime will be ignored and always gets set to 23:59:59, use GetAuditEntries3 if you want the time part applied |
AuditEntry2Collection GetAuditEntries2 | ( | string | sessionId, |
AuditTypeCollection | auditTypes, | ||
DateTime | fromDate, | ||
DateTime | toDate, | ||
short | category, | ||
short | level | ||
) |
Retrieves the audit log entries based on the requested audit type, category, level and date filters.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
auditTypes | A collection of type AuditType containing various AuditEntryType values. |
fromDate | From date. |
toDate | To date. The time part of the datetime will be ignored and always gets set to 23:59:59, use GetAuditEntries3 if you want the time part applied |
category | The Audit Entry Category enumeration - see Remarks. |
level | The Audit Entry Level enumeration - see Remarks. |
Enumeration | Description |
---|---|
0 | All |
1 | Activity |
2 | Capture |
3 | Form |
4 | Job |
5 | JobScheduler |
6 | Process |
7 | ResourceManagement |
8 | Security |
Enumeration | Description |
---|---|
0 | All |
1 | Info |
2 | Warn |
3 | Error |
AuditEntry2Collection GetAuditEntries3 | ( | string | sessionId, |
AuditEntriesFilter | filter | ||
) |
Retrieves the audit log entries based on the filter.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
filter | The filter. |
AuditTypeCollection GetAuditEntryTypes | ( | string | sessionId | ) |
Gets the audit entry types.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
ProjectIdentityCollection GetCaptureProjectsToPreload | ( | string | sessionId | ) |
Gets the capture projects to preload.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
LatestImportConnections GetLatestImportConnections | ( | string | sessionId | ) |
Gets the Lastest modified datetime and total import connections.
sessionId | The session identifier. |
LookupCollection GetLookups2 | ( | LookupIdentityCollection | lookupIdentityCollection | ) |
Gets the lookups for the specified lookup identities.
lookupIdentityCollection | A collection of LookupIdentity objects to retrieve lookups for.
|
PageRenditionCollection GetPageRenditions | ( | string | sessionId | ) |
Gets the page renditions.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
RecentItemCollection GetRecentItems | ( | string | sessionId, |
RecentItemFilter | recentItemFilter | ||
) |
Retrieves the latest accessed items of the loggedon user.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
recentItemFilter | A recentItemFilter object containing the search criteria to retrieve the recent items. |
ReportingTagCollection GetReportingTags | ( | string | sessionId | ) |
Gets the reporting tags.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
RetentionPolicyFailureCollection GetRetentionPolicyFailures | ( | string | sessionId, |
RetentionPolicyFailureFilterCriteria | filter | ||
) |
Gets the retention policy failures.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
filter | A RetentionPolicyFailureFilterCriteria object containing the resource id to identify the resource
|
Enumeration | Description |
---|---|
0 | The delete job failed |
1 | The delete business process failed |
2 | The delete business rule failed |
3 | The delete form failed |
4 | The delete internal user failed |
5 | The delete external user failed |
6 | The delete classification group failed |
7 | The delete extraction group failed |
8 | The delete document failed |
9 | The delete skin failed |
10 | The delete audit failed |
11 | The delete packs failed |
RetentionPolicyFailureTypeCollection GetRetentionPolicyFailureTypes | ( | string | sessionId | ) |
Gets the retention policy failure types.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
ScanVrsProfileCollection GetScanVrsProfilesConfiguration | ( | string | sessionId, |
ScanVrsProfileIdentityCollection | vrsProfileIdentities | ||
) |
Gets the scan VRS profiles configuration.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
vrsProfileIdentities | The VRS profile identities in ScanVrsProfileIdentityCollection. |
ServerSettingsSummary GetServerSettingsSummary | ( | string | sessionId | ) |
Gets the server settings summary.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
VariableSummaryCollection GetServerVariables | ( | string | sessionId, |
ServerVariablesFilter | serverVariablesFilter | ||
) |
Retrieves a list of server variables from the specified server using the given search criteria.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
serverVariablesFilter | A ServerVariablesFilter object defining the search parameters
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Details of the variable |
Id | String | Id of the variable |
DisplayName | String | Dsiplay name of the variable |
VariableType | Int16 | The type of the variable |
TypeOfValue | Int16 | The type of Value |
Value | Object | The value assigned to the variable |
Dynamic | Boolean | Indicates the variable is dynamic |
Grouping | Identity | Deprecated. This will only be populated in installations upgraded from TotalAgility 5.5. |
Category | Identity | Category the variable belongs to |
VariableBaseType | Int16 | The base type of the variable |
Entity | Identity | Deprecated. This will only be populated in installations upgraded from TotalAgility 5.5. |
SessionVariableCollection GetSessionVariables | ( | string | sessionId, |
SessionVariableFilter | sessionVariableFilter | ||
) |
Gets the session variables.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
sessionVariableFilter | A SessionVariableFilter object used to specify which session variables should be searched for.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Id of the resource |
Description | String | Text description of the variable |
Value | String | The value of the variable |
IsLocalizable | Boolean | Indicates the variable is localizable |
Category | Identity | Category the variable belongs to. Only Id is populated. |
void ImportPackage | ( | ImportPackageParameter | importParameter | ) |
This function is deprecated. Please use ImportPackage3 instead
Imports a package fro ma compressed file
importParameter | A ImportPackageParameter that has the details of the package to import
Process import options
|
ImportPackageResult ImportPackage2 | ( | string | sessionId, |
byte[] | packageData, | ||
PackageImportOptions2 | importOptions | ||
) |
This function is deprecated. Please use ImportPackage3 instead
Imports a compressed package
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
packageData | An array of byte s that holds the compressed package data. Must be specified | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
importOptions | A PackageImportOptions2 object containing the import package options information to import the package
Form import options
Dashboard import options
Report import options
Process import options
|
Name | Type | Comment |
---|---|---|
ProcessImportErrors | Collection | Details of all process import errors |
FormImportErrors | Collection | Details of all form import errors |
DashboardImportErrors | Collection | Details of all dashboard import errors |
BusinessAlertImportErrors | Object | Details of all business alert import errors |
BusinessEventImportErrors | Object | Details of all business event import errors |
BusinessTargetImportErrors | Object | Details of all business target import errors |
WorkAllocationRuleImportErrors | Collection | Details of all work allocation rule import errors |
ReportImportErrors | Collection | Details of all report import errors |
LocalisationStringsImportErrors | Collection | Details of all work localisation string import errors |
Boolean
member of importOptions must be populated byte []
parameter that is not directly supported by the TotalAgility designer. In order to for the call to work please follow the instructions found here. ImportPackageResult ImportPackage3 | ( | string | sessionId, |
byte[] | packageData, | ||
PackageImportOptions3 | importOptions, | ||
short | packageImportType | ||
) |
Extracts contents from compressed package and imports them in to DB based on Package Import Type
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
packageData | An array of byte s that holds the compressed package data. Must be specified | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
importOptions | A PackageImportOptions3 object containing the import package options information to import the package.
Process import options 2
Form import options
Dashboard import options
Report import options
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
packageImportType | A number indicating the type of package to import |
Name | Type | Comment |
---|---|---|
ProcessImportErrors | Collection | Details of all process import errors |
FormImportErrors | Collection | Details of all form import errors |
DashboardImportErrors | Collection | Details of all dashboard import errors |
BusinessAlertImportErrors | Object | Details of all business alert import errors |
BusinessEventImportErrors | Object | Details of all business event import errors |
BusinessTargetImportErrors | Object | Details of all business target import errors |
WorkAllocationRuleImportErrors | Collection | Details of all work allocation rule import errors |
ReportImportErrors | Collection | Details of all report import errors |
LocalisationStringsImportErrors | Collection | Details of all work localisation string import errors |
Boolean
member of importOptions must be populated byte []
parameter that is not directly supported by the TotalAgility designer. In order to for the call to work please follow the instructions found here. void RemoveAllAuditLogEntries | ( | string | sessionId | ) |
Removes all audit log entries.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
void RemoveAuditLogEntries | ( | string | sessionId, |
short | auditType, | ||
DateTime | fromDate, | ||
DateTime | toDate | ||
) |
Removes the audit log entries.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
auditType | Type of the AuditEntryType. |
fromDate | From date. |
toDate | To date. |
void RemoveCompletedJobs | ( | string | sessionId, |
DateTime | dateFrom, | ||
DateTime | dateTo | ||
) |
Removes jobs completed within the given period.
The dateFrom and dateTo parameters are mandatory. If their values are not provided, an exception is raised.
If incorrect dateTime value is provided as input, a conversion exception is raised.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
dateFrom | The date from when the jobs should be removed. |
dateTo | The date up to which the jobs should be removed. |
void SavePageRenditions | ( | string | sessionId, |
PageRenditionCollection | pageRenditions | ||
) |
Adds the page rendition.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
pageRenditions | The page renditions. |
void SaveReportingTags | ( | string | sessionId, |
ReportingTagCollection | reportingTags | ||
) |
Adds the reporting tags.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
reportingTags | The reporting Tags. |
void SendEmail2 | ( | string | sessionId, |
EmailInfo2 | emailInfo | ||
) |
Sends the email to the recipients specified in the EmailInfo2 class fields through the preconfigured SMTP server in the KTA designer.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||
emailInfo | A EmailInfo2 object containing the information of the email that is to be sent.
|
Description | value |
---|---|
Normal | 0 |
Low | 1 |
High | 2 |
Description | value |
---|---|
Text | 0 |
Html | 1 |
This API cannot be called from a process or form as byte[] is not supported.
void UpdateFederatedAuthenticationSetting | ( | string | sessionId, |
bool | useFederatedAuthentication | ||
) |
Updates the system settings to turn Federated Authentication on or off
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
useFederatedAuthentication | If set to true turn Federated Authentication on, otherwise off. |
void UpdateJobSchedule | ( | string | sessionId, |
JobSchedule | jobSchedule | ||
) |
Modifies the Job schedule.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
jobSchedule | The job scheduler.
|
void UpdateServerSettings3 | ( | string | sessionId, |
ServerSettings3 | serverSettingInformation | ||
) |
Updates the server settings.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
serverSettingInformation | The server setting information. |
string UpdateServerSettings4 | ( | string | sessionId, |
ServerSettings3 | serverSettingInformation, | ||
short | settingsSection | ||
) |
Updates the server settings.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
serverSettingInformation | The server setting information. |
settingsSection | The server settings section enumeration - see Remarks. |
Enumeration | Description |
---|---|
2 | DatabaseSettings |
void UpdateServerVariables | ( | string | sessionId, |
VariableValue2Collection | updatedVariables | ||
) |
Updates the value of the specified server variables.
If one of the variables in the collection has an incorrect ID or incorrect type of value, no variables are updated.
If no variables are provided for update, the “value cannot be null” exception is raised.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
updatedVariables | A collection of type VariableValue2 object that holds the variables whose values need to be updated. |
void UpdateSessionVariable | ( | string | sessionId, |
SessionVariable | sessionVariable | ||
) |
Updates the specified session variable with the given details.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||
sessionVariable | The SessionVariable to be updated.
|
RuleValidationResult ValidateRule | ( | string | sessionId, |
Agility.Sdk.Model.Rules.Rule | rule | ||
) |
Validates the rule.
sessionId | The session identifier. |
rule | The rule. |
RuleValidationResultCollection ValidateRules | ( | string | sessionId, |
RuleCollection | rules | ||
) |
Validates the rule.
sessionId | The session identifier. |
rules | The rule. |