Provides methods that deal with job scheduling and session variables More...

Public Member Functions
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	DeleteJobSchedule (string sessionId, JobScheduleIdentity jobScheduleIdentity)
	Deletes the specified job schedule. More...

void	DeleteSessionVariable (string sessionId, SessionVariableIdentity sessionVariableIdentity)
	Deletes the specified session variable. 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...

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...

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...

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	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...

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...

Description

Provides methods that deal with job scheduling and session variables

Member Functions

JobScheduleIdentity AddJobSchedule	(	string	sessionId,
		JobSchedule	jobSchedule
	)

Schedule one or more jobs to run at a specific time period or interval.

Parameters

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	Required
JobScheduleIdentity	Identity	Object that has the name of the schedule	Yes - Name is required
Category	Identity	Category the schedule belongs to	Yes - Id or Name is required
ProcessIdentity	Identity	The process to be executed by the schedule	Yes - Id or Name is required
TimeSpanInMinutes	Int64	See Intervals below	No
NoOfOccurs	Int16	Number of times the process should be executed (-1 indicates forever)	No
NoOfOccursProcessed	Int16	Used internally. Do not use	No
NoOfJobsToCreate	Int16	Number of jobs to create at each execution	No
UseStartByDate	Boolean	Indicates whether StartByDate should be used	No
StartByDate	DateTime	Date to start by	Yes - if UseStartByDate is set to `true`
UseEndByDate	Boolean	Indicates whether EndByDate should be used	No
EndByDate	DateTime	Date to end by	Yes - if UseEndByDate is set to `true`
SetTime	DateTime	Set Time	No
VariableMappingCollection	Collection	Collection of initialization parameters	Yes - if the process to schedule has input parameters
Monthly	Int16	See Intervals below	No
UseWeekDays	Boolean	Indicates whether DaysOfWeek should be used	No
DaysOfWeek	Int16	See DaysOfWeek below	No
OneActiveAtTime	Boolean	Indicates only one process can be active at a time	No
ScheduleActive	Boolean	Indicates the schedule is currently active	No
UseBusinessCalendar	Boolean	Indicates the business calendar should be used	No
LastModifiedDate	DateTime	Date the schedule was last modified	No
LockedBy	Identity	Details of the resource that locked the schedule	No

Returns

A JobScheduleIdentity object containing the the details of the new job schedule.

Name	Type	Comment
Id	Int32	Id of the new schedule
Name	String	Name of the new schedule

Remarks

Intervals
The timing of the schedule is determined by a number of the parameters as shown in the following table:

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

If StartDate is set then execution of the schedule begins at this date, otherwise it begins immediately
If EndDate is set then execution ends at this date, otherwise it continues indefinitely
If NoOfOccurs is set then executions ends after this number of executions
If EndDate and NoOfOccurs are both set then the first occurring will halt execution

Days of the week
Each day of the week is assigned its own value:

Day	Value
Sunday	2
Monday	4
Tuesday	8
Wednesday	16
Thursday	32
Friday	64
Saturday	128

To indicate more than one day simply add the values together e.g.:

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

Security: Resource must have at least Read Write access permission on Server ACL.

void AddSessionVariable	(	string	sessionId,
		SessionVariable	sessionVariable
	)

Adds a new session variable with the specified details.

Parameters

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.

Name	Type	Comment	Required
Identity	Identity	Id of the resource	Yes - Name is required
Description	String	Text description of the variable	Yes
Value	String	The value of the variable	No
IsLocalizable	Boolean	Indicates the variable is localizable	No
Category	Identity	Category the variable belongs to	Yes - Id or Name is required

Security: Resource must have at least Read Write access permission on Server ACL.

void DeleteJobSchedule	(	string	sessionId,
		JobScheduleIdentity	jobScheduleIdentity
	)

Deletes the specified job schedule.

Parameters

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.

Name	Type	Comment	Required
Id	In32	Id of the new schedule	Yes - If Name is not specified
Name	String	Name of the new schedule	Yes - If Id is not specified

Security: Resource must have at least Read Write access permission on Server ACL.

void DeleteSessionVariable	(	string	sessionId,
		SessionVariableIdentity	sessionVariableIdentity
	)

Deletes the specified session variable.

Parameters

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.

Name	Type	Comment	Required
Id	String	Id of the variable	Yes
Name	String	Name of the variable	No

Remarks: The session variable must be identified by Id or the method will be suspended.

Security: Resource must have at least Read Write access permission on Server ACL.

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.

Parameters

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.

Name	Type	Comment	Required
AlertExportOptions	Object	Options for exporting alerts	No
Alerts	Collection	The alerts that should be exported	No
DashboardExportImportOptions	Object	Options for exporting dashboards	No
DashboardIdentityCollection	Collection	The dashboards that should be exported	No
Events	Collection	The events that should be exported	No
FormExportOptions	Object	Options for exporting forms	No
Forms	Collection	The forms that should be exported	No
LocalisationIdentityCollection	Collection	The localisation strings that should be exported	No
Processes	Collection	Id, Name and Version of each process to export	No
ProcessExportOption	Object	Options for exporting processes	No
ReportExportOptions	Object	Options for exporting reports	No
Reports	Collection	The reports that should be exported	No
Skins	Collection	The skins that should be exported	No
Targets	Collection	The targets that should be exported	No
WorkAllocationRules	Collection	The work allocation rules that should be exported	No

Returns: Returns a byte [] array which is not directly supported by the TotalAgility designer. For an example of using the returned data please see here

Remarks

At least one member of options must be populated
All of the identity collections have an Id and a Name - either of which can be specified. The following have a version field:

Processes
Forms
Skins
Reports

: and LocalisationIdentityCollection also has a language field and and a new LocalisationIdentity must be specified for each language

Security: Resource must have at least Has Access access permission on Designer ACL.

void ForceAllUsersToChangePasswordOnNextLogon ( string sessionId )

Forces all users to change password on next logon.

Parameters

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.

Security: Resource must have at least Read Write access permission on Server ACL.

void GenerateNewSecurityKey ( string sessionId )

Generates the new security key.

Parameters

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.

Security: No restrictions apply.

byte [] GetAssetData	(	string	sessionId,
		string	assetId
	)

Gets the asset data.

Parameters

sessionId	The session identifier.
assetId	The asset identifier.

Returns: Asset Data

AuditCategorisations GetAuditCategorisations ( string sessionId )

Gets the audit categorisations.

Parameters

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.

Returns: An instance of AuditCategorisations.

Security: No restrictions apply.

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.

Parameters

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.

Returns: A collection of type AuditEntry class.

Security: No restrictions apply.

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.

Parameters

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.
category	The Audit Entry Category enumeration - see Remarks.
level	The Audit Entry Level enumeration - see Remarks.

Returns: An AuditEntry2Collection of type AuditEntry2 class.

Remarks

The enumeration for Category setting follows.

Enumeration	Description
0	All
1	Activity
2	Capture
3	Form
4	Job
5	JobScheduler
6	Process
7	ResourceManagement
8	Security

The enumeration for Level setting follows.

Enumeration	Description
0	All
1	Info
2	Warn
3	Error

Security: No restrictions apply.

AuditTypeCollection GetAuditEntryTypes ( string sessionId )

Gets the audit entry types.

Parameters

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.

Returns: An AuditTypeCollection of type AuditType. The enumeration values for Audit Entry can be found here.

Security: No restrictions apply.

ProjectIdentityCollection GetCaptureProjectsToPreload ( string sessionId )

Gets the capture projects to preload.

Parameters

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.

Returns: A collection of type ProjectIdentity, which holds Classfication and Document Group identities.

Security: No restrictions apply.

LatestImportConnections GetLatestImportConnections ( string sessionId )

Gets the Lastest modified datetime and total import connections.

Parameters

sessionId The session identifier.

Returns: Latest Import Connections

LookupCollection GetLookups2 ( LookupIdentityCollection lookupIdentityCollection )

Gets the lookups for the specified lookup identities.

Parameters

lookupIdentityCollection

A collection of LookupIdentity objects to retrieve lookups for.

Name	Type	Comment	Required
Id	String	Id of the Lookup	Yes
Name	String	Name of the Lookup	No - Not used by this API

Returns: A collection of Lookups for the specified identity collection.

Security: No restrictions apply.

PageRenditionCollection GetPageRenditions ( string sessionId )

Gets the page renditions.

Parameters

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.

Returns: A collection of PageRendition objects.

Security: No restrictions apply.

RetentionPolicyFailureCollection GetRetentionPolicyFailures	(	string	sessionId,
		RetentionPolicyFailureFilterCriteria	filter
	)

Gets the retention policy failures.

Parameters

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

Name	Type	Comment	Required
UseFailureType	Boolean	Indicates if FailureType property should be used	No
FailureType	Int16	The type of failure. See Remarks paragraph below for details	No

Returns: A collection of RetentionPolicyFailure objects.

Remarks

The enumeration for FailureType setting follows.

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

Security: No restrictions apply.

RetentionPolicyFailureTypeCollection GetRetentionPolicyFailureTypes ( string sessionId )

Gets the retention policy failure types.

Parameters

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.

Returns: A collection of RetentionPolicyFailureType objects.

Security: No restrictions apply.

ScanVrsProfileCollection GetScanVrsProfilesConfiguration	(	string	sessionId,
		ScanVrsProfileIdentityCollection	vrsProfileIdentities
	)

Gets the scan VRS profiles configuration.

Parameters

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.

Returns: An instance of ScanVrsProfileCollection.

Security: No restrictions apply.

ServerSettingsSummary GetServerSettingsSummary ( string sessionId )

Gets the server settings summary.

Parameters

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.

Returns: Returns a ServerSettingsSummary object that details some current KTA server settings

Security: No restrictions apply.

VariableSummaryCollection GetServerVariables	(	string	sessionId,
		ServerVariablesFilter	serverVariablesFilter
	)

Retrieves a list of server variables from the specified server using the given search criteria.

Parameters

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	Required
Category	Identity	Category to return the variables for	No
ServerIdentity	Identity	Server to return the variables for	Yes - Id or Name is required
SearchText	String	All or part of the names to be searched for	No

Returns

Collection of VariableSummary that have the details of the variables found.

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.

Remarks: SearchText is used to match names and will return all variables whose names fully or partially match. Please note it is not case sensitive
For example, setting searchText to 'Ver' would find 'Version', 'REVERSION' and 'SeRvEr'.

Security: No restrictions apply.

SessionVariableCollection GetSessionVariables	(	string	sessionId,
		SessionVariableFilter	sessionVariableFilter
	)

Gets the session variables.

Parameters

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	Required
SearchText	String	All or part of the names to be searched for	Yes - if Category is not specified
Category	Identity	Category the variables belong to	Yes - if SearchText is not specified

Returns

A collection of type SessionVariable that has the details of each session variable found.

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.

Security: No restrictions apply.

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

Parameters

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 bytes that holds the compressed package data. Must be specified

importOptions

A PackageImportOptions3 object containing the import package options information to import the package.

Name	Type	Comment	Required
ProcessImportOptions	Object	Import options for processes	No
FormImportOptions	Object	Import options for forms	No
DashboardImportOptions	Object	Import options for dashboards	No
ReportImportOptions	Object	Import options for reports	No

Process import options 2

Name	Type	Comment	Required
OverwriteExistingProfiles	Boolean	Indicates whether existing profiles should be overwritten	No
ImportCategories	Boolean	Indicates whether categories should be imported	No
ImportResources	Boolean	Indicates whether resources should be imported	No
ImportGroupsWithResourceMembers	Boolean	Indicates whether groups with resource members should be imported	No
OverwriteExistingWQDefinitions	Boolean	Indicates whether existing workqueue definitions should be overwritten	No
OverwriteExistingCheckListData	Boolean	Indicates whether existing check list data should be overwritten	No
OverwriteExistingRoles	Boolean	Indicates whether existing roles should be overwritten	No
OverwriteBusinessRules	Boolean	Indicates whether existing business should be overwritten	No
OverwriteExistingEntityDefinitions	Boolean	Indicates whether existing entity rules should be overwritten	No
OverwriteExistingStaticDataLists	Boolean	Indicates whether existing static data lists should be overwritten	No
SaveLibraryItemsAsOrdinary	Boolean	Indicates whether library items should be saved as ordinary	No

Form import options

Name	Type	Comment	Required
ImportHeader	Boolean	Indicates whether headers should be imported	No
ImportNavigation	Boolean	Indicates whether navigations should be imported	No
ImportGlobalVariables	Boolean	Indicates whether global variables should be imported	No
ImportWebServices	Boolean	Indicates whether web services should be imported	No
ImportBusinessRules	Boolean	Indicates whether business rules should be imported	No
ImportSecurityTokens	Boolean	Indicates whether security tokens should be imported	No
ImportSecurityRoles	Boolean	Indicates whether security roles should be imported	No
ImportRoleMembers	Boolean	Indicates whether role members should be imported	No
ProcessimportOptions	Object	Not used	No

Dashboard import options

Name	Type	Comment	Required
ExportImportCatgeories	Boolean	Indicates whether categories should be imported	No
ExportImportCategoryParentage	Boolean	Indicates whether categories imported should also have their parent categories populated	No
ExportImportResources	Boolean	Indicates whether resources should be imported	No
ExportImportGroupMembers	Boolean	Indicates whether group members should be imported	No
OverwriteDashboard	Boolean	Indicates whether existing dashboards shoulbe be overwritten	No

Report import options

Name	Type	Comment	Required
ImportLinkedReports	Boolean	Indicates whether linked reports should be imported	No
ImportAssociatedProcesses	Boolean	Indicates whether associated processes should be imported	No
ProcessimportOptions	Object	Not used	No

packageImportType A number indicating the type of package to import

Returns

An instance of ImportPackageResult.

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

Remarks: At least one Boolean member of importOptions must be populated
ImportPackageData3 requires a 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.

Security: Resource must have at least Has Access access permission on Designer ACL.

void RemoveAllAuditLogEntries ( string sessionId )

Removes all audit log entries.

Parameters

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.

Security: Resource must have permissions to maintain System Settings

void RemoveAuditLogEntries	(	string	sessionId,
		short	auditType,
		DateTime	fromDate,
		DateTime	toDate
	)

Removes the audit log entries.

Parameters

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.

Security: Resource must have permissions to maintain System Settings.

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.

Parameters

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.

Security: Resource must have at least Read Write access permission on Job Clear Down ACL.

void SavePageRenditions	(	string	sessionId,
		PageRenditionCollection	pageRenditions
	)

Adds the page rendition.

Parameters

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.

Security: No restrictions apply.

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.

Parameters

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.

Name	Type	Comment	Required
FromField	string	Email address of the user who is sending the email.	Yes
ToField	StringCollection	Collection of email addresses of the users to whom the email is sent.	Yes
CCField	StringCollection	Collection of email addresses of the users whom you want to know about the email.	No
BccField	StringCollection	Collection of email addresses of the users you want to know about the email but not announce to everyone else that they are getting a copy.	No
Attachments	EmailAttachment2Collection	A collection type of EmailAttachment2 class which holds the collection of attachments to be sent with the email.	No
Subject	string	Subject of the email.	Yes
Body	string	Body of the email.	Yes
Importance	short	Importance of the email..	Yes
Format	short	Specifies whether the mail format should be in Text or html	Yes

Remarks

Importance takes the following values:

Description	value
Normal	0
Low	1
High	2

Format takes the following values:

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

Parameters

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.

Security: No restrictions apply.

void UpdateJobSchedule	(	string	sessionId,
		JobSchedule	jobSchedule
	)

Modifies the Job schedule.

Parameters

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.

Name	Type	Comment	Required
JobScheduleIdentity	Identity	Object that has the name of the schedule	Yes - Name is required
Category	Identity	Category the schedule belongs to	Yes - Id or Name is required
ProcessIdentity	Identity	The process to be executed by the schedule	Yes - Id or Name is required
TimeSpanInMinutes	Int64	See Intervals below	No
NoOfOccurs	Int16	Number of times the process should be executed (-1 indicates forever)	No
NoOfOccursProcessed	Int16	Used internally. Do not use	No
NoOfJobsToCreate	Int16	Number of jobs to create at each execution	No
UseStartByDate	Boolean	Indicates whether StartByDate should be used	No
StartByDate	DateTime	Date to start by	Yes - if UseStartByDate is set to `true`
UseEndByDate	Boolean	Indicates whether EndByDate should be used	No
EndByDate	DateTime	Date to end by	Yes - if UseEndByDate is set to `true`
SetTime	DateTime	Set Time	No
VariableMappingCollection	Collection	Collection of initialization parameters	Yes - if the process to schedule has input parameters
Monthly	Int16	See Intervals below	No
UseWeekDays	Boolean	Indicates whether DaysOfWeek should be used	No
DaysOfWeek	Int16	See DaysOfWeek below	No
OneActiveAtTime	Boolean	Indicates only one process can be active at a time	No
ScheduleActive	Boolean	Indicates the schedule is currently active	No
UseBusinessCalendar	Boolean	Indicates the business calendar should be used	No
LastModifiedDate	DateTime	Date the schedule was last modified	No
LockedBy	Identity	Details of the resource that locked the schedule	No

Security: Resource must have at least Read Write access permission on Server ACL.

void UpdateServerSettings3	(	string	sessionId,
		ServerSettings3	serverSettingInformation
	)

Updates the server settings.

Parameters

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.

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.

Parameters

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.

Security: Resource must have permissions to maintain System Settings.

void UpdateSessionVariable	(	string	sessionId,
		SessionVariable	sessionVariable
	)

Updates the specified session variable with the given details.

Parameters

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.

Name	Type	Comment	Required
Identity	Identity	Id of the resource	Yes - Id is required
Description	String	Text description of the variable	No
Value	String	The value of the variable	No
IsLocalizable	Boolean	Indicates the variable is localizable	No
Category	Identity	Category the variable belongs to	Yes - Id or Name is required

Remarks: The session variable must be identified by Id or the method will do nothing.

Security: Resource must have at least Read Write access permission on Server ACL.

Public Member Functions

Description

Member Functions