Contact
Newsletter
Schedule Consultation

WanGridManager - Part 2

WanGridManager.GetListOfUnimportedOfflinePackages

Returns a list of all not imported offline packages.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.

Return Values

Result
Type/Value
Interpretation
Success
string
An XML structure that contains the data of the unimported packages:
<?xmlversion="1.0"encoding="UTF-16"?><packages><packageGUID="[GUID of the package]"type="[crossTank|crossTerm]"project="[local project name]"projectGUID="[GUID of the project the package belongs to]"document="[local document name]"documentGUID="[GUID of the document the package belongs to]"creationDate="[the creation date of the package]"creator="[name of the trusted server or WAN user that created the package]"creatorGUID="[The GUID of the creator]"projectManagerGUID="[The GUID of the project manager]"/></packages>

WanGridManager.GetListOfUnimportedOfflinePackagesForDocument

Returns the list of the unimported offline packages for the specified document.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document.

Return Values

Result
Type/Value
Interpretation
Success
string
The list of unimported offline packages.
Error
16
Document does not exist.

WanGridManager.GetListOfUnimportedOfflinePackagesForLanguage

Returns the list of the unimported packages for specified document in a specified language.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
DocumentGuid
The GUID of the document.
3
int
LanguageLcid
The LCID of the language.

Return Values

Result
Type/Value
Interpretation
Success
string
The list of unimported offline packages.
Error
15
Language does not exist.
Error
16
Document does not exist.

WanGridManager.GetListOfUnimportedOfflinePackagesForProject

Returns a list of unimported offline packages for a specified project.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ProjectGuid
The GUID of the project.

Return Values

Result
Type/Value
Interpretation
Success
string
The list of unimported offline packages.
Error
19
Project does not exist.

WanGridManager.GetMasterServers

Returns the GUIDs of the Master Servers registered in the system.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.

Return Values

Result
Type/Value
Interpretation
Success
string
An array of the server GUIDs of the Master Servers.

WanGridManager.GetMasterServersCSV

Returns the GUIDs of the master servers registered in the system.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.

Return Values

Result
Type/Value
Interpretation
Success
string
The server GUIDs of the Master Servers, separated by semicolons.

WanGridManager.GetPackageGuidByJobGuid

Returns the GUID of the package associated with the supplied job.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the package.
Error
17
Job does not exist.
Error
21
Job has been canceled.

WanGridManager.GetPackageGuidsByName

Returns the GUIDs of all crossGrid packages with the supplied name.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the package.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUIDs of all packages with the supplied name.
Error
53
Task does not exist.

WanGridManager.GetPackageGuidsByNameCSV

Returns the GUIDs of all crossGrid packages with the supplied name.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
Name
The name of the package.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUIDs of all packages with the supplied name as a list of semicolon-separated GUIDs.
Error
53
Task does not exist.

WanGridManager.GetPackageNameByGuid

Returns the name of a crossGrid package by its GUID.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PackageGuid
The GUID of the package.

Return Values

Result
Type/Value
Interpretation
Success
string
The name of the crossGrid package.
Error
53
Task does not exist.

WanGridManager.GetResetcTaAttributes

Gets whether the attributes should be removed when importing offline packages.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.

Return Values

Result
Type/Value
Interpretation
Success
bool
Returns true|false if ProjectAttribute is true|false, true|false if RelationAttribute is true|false, true|false if SubjectAttribute is true|false.

WanGridManager.GetServerContextGuidsByName

Returns the server context GUIDs of the specified server context name.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ContextName
The name of the server context (corresponds with the complete server name as displayed in UI).

Return Values

Result
Type/Value
Interpretation
Success
string
Returns the GUIDs of the server context.
Error
152
The Server Context does not exist.

WanGridManager.GetServerContextGuidsByNameCSV

Returns the server context GUIDs of the specified server context name as a list of semi-colon separated values.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ContextName
The name of the server context (corresponds with the complete server name as displayed in UI).

Return Values

Result
Type/Value
Interpretation
Success
string
Returns the GUIDs of the server context as semicolon-separated values.
Error
152
The Server Context does not exist.

WanGridManager.GetServerContextNameByGuid

Returns the server context name.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
ContextGuid
The GUID of the server context.

Return Values

Result
Type/Value
Interpretation
Success
string
Returns the server context name (corresponds with the complete server name as displayed in the Across client).
Error
152
The Server Context does not exist.

WanGridManager.GetTaskGuidByJobGuid

Returns the GUID of a task according to the GUID of a currently running job.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
JobGuid
The GUID of the job.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the task.
Error
17
Job does not exist.
Error
21
Job has been canceled.

WanGridManager.GetTaskGuidsFromCWU

Returns the GUIDs of the tasks inside the specified CWU or CRU file.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PacketPath
The path of the file from which the list of contained tasks should be returned.

Return Values

Result
Type/Value
Interpretation
Success
string
An array of the GUIDs of the tasks inside the specified CWU.
Error
71
File not found.
Error
100
Cannot retrieve CWU tasks.

WanGridManager.GetTaskGuidsFromCWUCSV

Returns the GUIDs of the tasks inside the specified CWU.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PacketPath
The path of the file from which the list of contained tasks should be returned.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUIDs of the tasks inside the specified CWU, separated by semicolons.
Error
71
File not found.
Error
100
Cannot retrieve CWU tasks.

WanGridManager.GetTaskGuidsOfPackage

Returns the GUIDs of the tasks in a package.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PackageGuid
The GUID of the package.

Return Values

Result
Type/Value
Interpretation
Success
string[]
The GUIDs of the tasks in the package.
Error
53
Task does not exist.
Error
175
Cannot activate all projects.

WanGridManager.GetTaskGuidsOfPackageCSV

Returns the GUIDs of the tasks in a package as semicolon-separated values.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PackageGuid
The GUID of the package.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUIDs of the tasks in the package as semicolon-separated values.
Error
53
Task does not exist.
Error
175
Cannot activate all projects.

WanGridManager.GetTrustedServers

Returns the GUIDs of the Trusted Servers registered in the system.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.

Return Values

Result
Type/Value
Interpretation
Success
string
An array of the server GUIDs of the Trusted Servers.

WanGridManager.GetTrustedServersCSV

Returns the GUIDs of the Trusted Servers registered in the system.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.

Return Values

Result
Type/Value
Interpretation
Success
string
The server GUIDs of the Trusted Servers, separated by semicolons.

WanGridManager.ImportCrossGridClassicByMasterServerAsync

Imports the GRU from a Trusted Server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PacketPath
The filename of the GRU to import.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the created job.
Error
18
Unable to create job.

WanGridManager.ImportCrossGridClassicByTrustedServerAsync

Imports the GWU from a Master Server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PacketPath
The filename of the GWU to import.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the created job.
Error
18
Unable to create job.

WanGridManager.ImportCrossGridPackage

Imports the crossTank and crossTerm packages contained in the crossGrid package on the Master Server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PackageGuid
The GUID of the package.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.

WanGridManager.ImportCrossGridPackageAsync

Imports the crossTank and crossTerm packages contained in the crossGrid package on the Master Server as a crossAPI job.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PackageGuid
The GUID of the package.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the created job.
Tip

Progress queries can be carried out via GetJobProgress. Status queries can be carried out via the GetJobStatus function.

WanGridManager.ImportCrossWanClassic

Imports the CRU file from an offline user.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
TaskGuid
GUID of the task.
3
string
PacketPath
The path of the CRU. The user account under which the crossAPI service runs needs to have access to this directory.
4
bool
ImportCrossTank
Whether the crossTank contents of the package should be imported.
5
bool
ImportCrossTerm
Whether the crossTerm contents of the package should be imported.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
53
Task does not exist.
Error
55
Unable to import crossWAN packages.

WanGridManager.ImportCrossWanClassic2

Imports the CRU file from an offline user.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
TaskGuids
The GUIDs of the tasks inside the CRU that should be imported. Separated by semicolons.
3
string
PacketPath
The path of the CRU. The user account under which the crossAPI service runs needs to have access to this directory.
4
bool
ImportCrossTank
Whether the crossTank contents of the package should be imported.
5
bool
ImportCrossTerm
Whether the crossTerm contents of the package should be imported.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
53
Task does not exist.
Error
55
Unable to import crossWAN packages.
Error
102
Cannot import project.

WanGridManager.ImportCrossWanClassicAsync

Imports the CRU file from an offline user.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
TaskGuid
GUID of the task.
3
string
PacketPath
The path of the CRU. The user account under which the crossAPI service runs needs to have access to this directory.
4
bool
ImportCrossTank
Whether the crossTank contents of the package should be imported.
5
bool
ImportCrossTerm
Whether the crossTerm contents of the package should be imported.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the import job.
Error
18
Unable to create job.
Error
53
Task does not exist.

WanGridManager.ImportCrossWanClassicAsync2

Imports the CRU file from an offline user.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
TaskGuids
The GUIDs of the tasks inside the CRU that should be imported. Separated by semicolons.
3
string
PacketPath
The path of the CRU. The user account under which the crossAPI service runs needs to have access to this directory.
4
bool
ImportCrossTank
Whether the crossTank contents of the package should be imported.
5
bool
ImportCrossTerm
Whether the crossTerm contents of the package should be imported.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the import job.
Error
18
Unable to create job.
Error
53
Task does not exist.

WanGridManager.ImportExchangeData

Imports an MDB file into the Across database.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
FilePath
The path to the file that contains the data to import.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
75
Cannot import exchange data.

WanGridManager.ImportOfflinePackage

Imports an offline package containing either crossTank or crossTerm entries from an offline user or a Trusted Server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PackageGuid
The GUID of the package.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
145
crossTank/crossTerm package does not exist.
Error
146
Cannot import crossTank/crossTerm package.

WanGridManager.ImportOfflinePackageAsync

Asynchronously imports an offline package containing either crossTank or crossTerm entries from an offline user or a trusted server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PackageGuid
The GUID of the package.

Return Values

Result
Type/Value
Interpretation
Success
string
The GUID of the import job.
Error
18
Unable to create job.
Error
145
crossTank/crossTerm package does not exist.

WanGridManager.MigrateExchangeData

Migrates crossWAN/crossGrid packets from a newer version to an older and vice versa.

Parameters

 
Type
Name
Description
1
string
FilePath
The path to the crossGrid or crossWAN package to migrate.
2
int
DBVersion
The version of the database into which the data should be converted.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
84
Cannot adjust DB.
Error
86
Exchange database (CWU/CRU) migration is not supported.

WanGridManager.RemoveOfflinePackage

Removes an offline package.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PackageGuid
The GUID of the package.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
145
crossTank/crossTerm package does not exist.
Error
153
Cannot remove crossTank/crossTerm package.

WanGridManager.SetResetcTaAttributes

Sets whether the attributes should be removed when importing offline packages.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
bool
RemoveProjectAttribute
Specifies whether to remove the corresponding attribute or not.
3
bool
RemoveRelationAttribute
Specifies whether to remove the corresponding attribute or not.
4
bool
RemoveSubjectAttribute
Specifies whether to remove the corresponding attribute or not.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
120
Cannot change settings.

WanGridManager.UploadGridPackage

Uploads the specified crossGrid package to the Master Server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PackageGuid
The GUID of the package.
3
bool
ExportCrossTank
Specifies whether corresponding crossTank entries should also be included in the package.
4
bool
ExportCrossTerm
Specifies whether corresponding crossTerm entries should also be included in the package.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
53
Task does not exist.
Error
133
Cannot upload server task.

WanGridManager.UploadGridPackageAsync

Uploads the specified crossGrid package to the Master Server.

Parameters

 
Type
Name
Description
1
string
ST
A security token for use in other crossAPI SI functions.
2
string
PackageGuid
The GUID of the package.
3
bool
ExportCrossTank
Specifies whether corresponding crossTank entries should also be included in the package.
4
bool
ExportCrossTerm
Specifies whether corresponding crossTerm entries should also be included in the package.

Return Values

Result
Type/Value
Interpretation
Success
Is always empty.
Error
18
Unable to create job.
Error
53
Task does not exist.
Error
133
Cannot upload server task.