All Classes Namespaces Functions Properties Pages
Public Member Functions | List of all members
PackageService Class Reference

Provides methods to import and export packages More...

Public Member Functions

byte[] ExportPackageToBytes (string sessionId, SpaPackageIdentity packageIdentity)
 Exports the package as a byte[]. More...
 
byte[] ExportPackageToBytes2 (string sessionId, SpaPackageIdentity packageIdentity, PackageDeploymentIdentity deploymentIdentity)
 Exports the package as a byte[]. More...
 
void ExportPackageToFile (string sessionId, SpaPackageIdentity packageIdentity, string fileLocationToSave)
 Exports the package to the specified file location on the TotalAgility server. More...
 
void ExportPackageToFile2 (string sessionId, SpaPackageIdentity packageIdentity, PackageDeploymentIdentity deploymentIdentity, string fileLocationToSave)
 Exports the package to the specified file location on the TotalAgility server. More...
 
SpaPackageImportResult ImportPackageFromBytes (string sessionId, byte[] packageData, SpaPackageImportOptions3 importOptions)
 Imports the package from a byte[]. More...
 
PackageImportResult ImportPackageFromFile (string sessionId, string packageDataPath, SpaPackageImportOptions3 importOptions)
 Imports the package located in the specified file path on the TotalAgility server. More...
 

Description

Provides methods to import and export packages

Member Functions

byte [] ExportPackageToBytes ( string  sessionId,
SpaPackageIdentity  packageIdentity 
)

Exports the package as a byte[].

Parameters
sessionIdA string that uniquely identifies the session for the current logged on user. An exception will be raised for an invalid sessionId.
packageIdentityA Package object containing the details of the package to be exported.
Returns
Returns the byte array of the exported package
Remarks
This API is not supported to be called from TotalAgility processes or forms, it is only callable from custom code. Use this API to export the package to a client machine that is a calling a remote TotalAgility server.
byte [] ExportPackageToBytes2 ( string  sessionId,
SpaPackageIdentity  packageIdentity,
PackageDeploymentIdentity  deploymentIdentity 
)

Exports the package as a byte[].

Parameters
sessionIdA string that uniquely identifies the session for the current logged on user. An exception will be raised for an invalid sessionId.
packageIdentityA Package object containing the details of the package to be exported.
deploymentIdentityA Package Deployment object containing the details of the deployment. If specified, then the deployment specific values will be exported. If it is null, the full package including the deployment configurations defined in the package will be exported.
Returns
Returns the byte array of the exported package
Remarks
This API is not supported to be called from TotalAgility processes or forms, it is only callable from custom code. Use this API to export the package to a client machine that is a calling a remote TotalAgility server.
void ExportPackageToFile ( string  sessionId,
SpaPackageIdentity  packageIdentity,
string  fileLocationToSave 
)

Exports the package to the specified file location on the TotalAgility server.

Parameters
sessionIdA string that uniquely identifies the session for the current logged on user. An exception will be raised for an invalid sessionId.
packageIdentityA Package object containing the details of the package to be exported
fileLocationToSaveThe file location to save the package ZIP file.
Remarks
This API is not supported for multi-tenanted TotalAgility installations. Use this API when exporting a package from KTA processes or forms and saving the package to file path on the server.
void ExportPackageToFile2 ( string  sessionId,
SpaPackageIdentity  packageIdentity,
PackageDeploymentIdentity  deploymentIdentity,
string  fileLocationToSave 
)

Exports the package to the specified file location on the TotalAgility server.

Parameters
sessionIdA string that uniquely identifies the session for the current logged on user. An exception will be raised for an invalid sessionId.
packageIdentityA Package object containing the details of the package to be exported
deploymentIdentityA Package Deployment object containing the details of the deployment. If specified, then the deployment specific values will be exported. If it is null, the full package including the deployment configurations defined in the package will be exported.
fileLocationToSaveThe file location to save the package ZIP file.
Remarks
This API is not supported for multi-tenanted TotalAgility installations. Use this API when exporting a package from KTA processes or forms and saving the package to file path on the server.
SpaPackageImportResult ImportPackageFromBytes ( string  sessionId,
byte[]  packageData,
SpaPackageImportOptions3  importOptions 
)

Imports the package from a byte[].

Parameters
sessionIdA string that uniquely identifies the session for the current logged on user. An exception will be raised for an invalid sessionId.
packageDataThe package data that needs to be imported. while importing LastModified date and version is updated with package data Last Modified Date and Version.
importOptionsAn ImportOptions object containing the package import options to be considered while importing the package.
Returns
An ImportResult object containing details of the artifacts that are failed to import.
Remarks
This API is not supported to be called from TotalAgility processes or forms, it is only callable from custom code. Use this API to export the package to a client machine that is a calling a remote TotalAgility server.
PackageImportResult ImportPackageFromFile ( string  sessionId,
string  packageDataPath,
SpaPackageImportOptions3  importOptions 
)

Imports the package located in the specified file path on the TotalAgility server.

Parameters
sessionIdA string that uniquely identifies the session for the current logged on user. An exception will be raised for an invalid sessionId.
packageDataPathLocation at which the package ZIP file is present.
importOptionsAn ImportOptions object containing the package import options to be considered while importing the package.
Returns
An ImportResult object containing details of the artifacts that are failed to import.
Remarks
This API is not supported for multi-tenanted TotalAgility installations. Use this API when importing a package from KTA processes or forms and importing the package from a file path on the server.