- General Information
- Connecting Third-party Systems
- crossConnect for content systems
- crossConnect for External Editing
- Purpose and usage
- Requirements
- Implementation
- Across XLIFF format
- Across-specific Extensions
- <xliff> Element Attributes
- <file> Element Extensions
- <trans-unit> Element Extension
- Paragraph States
- Paragraph State Flags
- <source> and <target> Element Content
- <bpt> Element Attributes
- <ph> Element Attributes
- <x> Element Attributes
- Across-specific Properties
- Analysis Results
- Sample Files
- Across XLIFF - import, export and segmentation
- Context information
- Exporting best matches in Across XLIFF
- Hyperlinks to XLIFF
- Secure file handling with C#
- Secure file handling with JAVA
- Workflow and vendor configuration
- Sample code - Integrated solution
- Across XLIFF format
- Generic File Connector
- Display Texts
- APIs
- APIs - Technology
- crossTank API v1
- crossTank API v2
- crossTerm API v1
- crossTerm API v2
- crossAPI SI
- Requirements
- Function Return Types
- crossAPI SI and Java
- List of Objects in crossAPI SI
- Sample - transferring checkout files via FileManager
- Sample - VBS
- Text Preprocessing API
WanGridManager - Part 1
WanGridManager.AssignCrossGridPackageToTask
Assigns a task to 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 to which the task should be assigned. |
3 | string | DocumentGuid | The GUID of the document from which a task should be assigned. |
4 | int | TargetLanguageLcid | The LCID of the target language. |
5 | int | SourceLanguageLcid | The LCID of the source language. |
6 | string | TaskTemplateGuid | The GUID of the task template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the task. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 26 | Unable to assign user to document. |
Error | 27 | Task template does not exist. |
Error | 38 | Unable to carry out relay assignment. More detailed information can be found in the error description. |
Error | 79 | crossGrid package does not exist. |
WanGridManager.AssignCrossGridPackageToTask2
Assigns a task to 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 to which the task should be assigned. |
3 | string | TaskGuid | GUID of the task. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the task. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 26 | Unable to assign user to document. |
Error | 27 | Task template does not exist. |
Error | 38 | Unable to carry out relay assignment. More detailed information can be found in the error description. |
Error | 79 | crossGrid package does not exist. |
WanGridManager.AssignCrossGridPackageToTask3
Assigns a task to 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 to which the task should be assigned. |
3 | string | DocumentGuid | The GUID of the document from which a task should be assigned. |
4 | int | TargetLanguageLcid | The LCID of the target language. |
5 | int | SourceLanguageLcid | The LCID of the source language. |
6 | string | PartitionIndexes | A list of partition indexes separated by ;. |
7 | string | TaskTemplateGuid | The GUID of the task template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the task. |
Error | 15 | Language does not exist. |
Error | 16 | Document does not exist. |
Error | 26 | Unable to assign user to document. |
Error | 27 | Task template does not exist. |
Error | 38 | Unable to carry out relay assignment. More detailed information can be found in the error description. |
Error | 79 | crossGrid package does not exist. |
WanGridManager.AssignCrowdToTaskAsync
Assigns a task to a user crowd.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | int | CrowdId | The ID of the crowd the task should be assigned to. |
3 | string | TaskGuid | GUID of the task. |
Return Values
Result | Type/Value | Interpretation |
Success | ||
Error |
WanGridManager.AssignUserToTaskAsync
Assigns an offline user to a task and creates the crossTank and crossTerm packages.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | DocumentGuid | The GUID of the document from which a task should be assigned. |
4 | int | TargetLanguageLcid | The LCID of the target language. |
5 | int | SourceLanguageLcid | The LCID of the source language. |
6 | string | TaskTemplateGuid | The GUID of the task template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | If UserGuid specified an online user, the return value is the GUID of the task the user has been assigned to. If it specified an offline user, the return value is the GUID of the job that has been created. See also GetJobStatus and GetJobProgress. |
Error | 18 | Unable to create job. |
AssignUserToTaskAsync can be used to carry out so-called relay translations. In that case, SourceLanguageLcid can deviate from the language of the source document.
For example, a German document should be translated into both English and Chinese. The designated Chinese translator can translate from English but not from German, so the English translator begins translating from German into English and the Chinese translator, in turn, begins translating from English into Chinese. In this case, one would state English and not German as the source language of the task for the Chinese translator.
WanGridManager.AssignUserToTaskAsync2
Assigns a user to an offline task. Allows setting the options to be used.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | DocumentGuid | The GUID of the document from which a task should be assigned. |
4 | int | TargetLanguageLcid | The LCID of the target language. |
5 | int | SourceLanguageLcid | The LCID of the source language. |
6 | string | TaskTemplateGuid | The GUID of the task template. |
7 | string | XMLSettings | The settings that should be used during assignment. Please see the info below for a detailed description. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the job that builds the offline package for the user. |
Error | 18 | Unable to create job. |
Error | 120 | Cannot change settings. |
The XML structure used for the parameter XMLSettings is a subset of the structure used for BuildCrossGridPackageAsync2. Here that subset is shown. To get descriptions for the shown tags, please refer to the WanGridManager.BuildCrossGridPackageAsync2 section.
WanGridManager.AssignUserToTaskAsync3
Assigns a user to an offline task. Allows setting the options to be used.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | DocumentGuid | The GUID of the document from which a task should be assigned. |
4 | int | TargetLanguageLcid | The LCID of the target language. |
5 | int | SourceLanguageLcid | The LCID of the source language. |
6 | string | TaskTemplateGuid | The GUID of the task template. |
7 | string | CrossWanPackagingTemplateGuid | The GUID of the crossWAN packaging template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the job that builds the offline package for the user. |
Error | 18 | Unable to create job. |
Error | 120 | Cannot change settings. |
WanGridManager.AssignUserToTaskAsync4
Assigns a user to an offline task. Allows setting the options to be used.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | TaskGuid | GUID of the task. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the job that builds the offline package for the user. |
Error | 18 | Unable to create job. |
Error | 120 | Cannot change settings. |
WanGridManager.AssignUserToTaskAsync5
Assigns a user to an offline task. Allows setting the options to be used.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | TaskGuid | GUID of the task. |
4 | string | XMLSettings |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the job that builds the offline package for the user. |
Error | 18 | Unable to create job. |
Error | 120 | Cannot change settings. |
WanGridManager.AssignUserToTaskAsync6
Assigns a user to an offline task. Allows setting the options to be used.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | TaskGuid | GUID of the task. |
4 | string | CrossWanPackagingTemplateGuid | The GUID of the crossWAN packaging template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the job that builds the offline package for the user. |
Error | 18 | Unable to create job. |
Error | 120 | Cannot change settings. |
WanGridManager.AssignUserToTaskAsync7
Assigns a user to an offline task. Allows setting the options to be used.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | UserGuid | The GUID of the user. |
3 | string | DocumentGuid | The GUID of the document from which a task should be assigned. |
4 | int | TargetLanguageLcid | The LCID of the target language. |
5 | int | SourceLanguageLcid | The LCID of the source language. |
6 | string | PartitionIndexes | A list of partition indexes separated by ;. |
7 | string | TaskTemplateGuid | The GUID of the task template. |
8 | string | CrossWanPackagingTemplateGuid | The GUID of the crossWAN packaging template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the job that builds the offline package for the user. |
Error | 18 | Unable to create job. |
Error | 120 | Cannot change settings. |
WanGridManager.BuildCrossGridPackageAsync
Creates a job that builds the crossGrid 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 that should be built. |
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 | string | The GUID of the job. |
Error | 18 | Unable to create job. |
Error | 79 | crossGrid package does not exist. |
WanGridManager.BuildCrossGridPackageAsync2
Builds the specified crossGrid package so it can be downloaded by the trusted server. Allows the setting of the options and the selection of the tasks to be built.
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 that should be built. |
3 | string | XMLSettings | The settings that should be used for building the package. Please see the info below for a detailed description. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the job that builds the package. |
Error | 18 | Unable to create job. |
Error | 79 | crossGrid package does not exist. |
Error | 120 | Cannot change settings. |
You can find the PackageSettings.xsd here or in the installation folder of the SDK: %ProgramFiles%\Across\Across SDK\Tools\crossAPI SI\PackageSettings.xsd.
WanGridManager.BuildCrossGridPackageAsync3
Builds the specified crossGrid package so it can be downloaded by the trusted server. Allows the setting of the options and the selection of the tasks to be built.
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 that should be built. |
3 | string | CrossGridPackagingTemplateGuid | The GUID of the crossGrid packaging template. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the job that builds the package. |
Error | 18 | Unable to create job. |
Error | 79 | crossGrid package does not exist. |
Error | 120 | Cannot change settings. |
WanGridManager.CancelJob
Cancels the specified job. The function only works for jobs created from WanGridManager functions.
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 | Is always empty. | |
Error | 17 | Job does not exist. |
Error | 87 | Job already finished. |
Error | 88 | Canceling is not supported for the job. |
WanGridManager.CloseCrossGridPackageForAssignments
Closes the package for assignments.
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 | Close | Specifies whether the package should be closed for assignments (true) or not (false). |
Return Values
Result | Type/Value | Interpretation |
Success | ||
Error |
WanGridManager.CreateCrossGridPackage
Creates a crossGrid package to which tasks can be assigned.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | TrustedServerGuid | The installation GUID of the Trusted Server. |
3 | string | Name | The name of the package. |
4 | string | Description | The description of the package. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the package. |
Error | 78 | The crossGrid Server does not exist. |
Error | 80 | Cannot create crossGrid package. |
WanGridManager.DownloadGridPackage
Downloads the specified crossGrid package from 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 | ImportCrossTank | Whether the crossTank contents of the package should be imported. |
4 | 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 | 134 | Cannot download server task. |
WanGridManager.DownloadGridPackage2
Downloads the specified crossGrid package from 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 | ImportCrossTank | Whether the crossTank contents of the package should be imported. |
4 | bool | ImportCrossTerm | Whether the crossTerm contents of the package should be imported. |
5 | bool | Confirm | Specifies whether to confirm the package and its tasks (true) or not (false) upon reception. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 53 | Task does not exist. |
Error | 134 | Cannot download server task. |
WanGridManager.DownloadGridPackageAsync
Downloads the specified crossGrid package from 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 | ImportCrossTank | Whether the crossTank contents of the package should be imported. |
4 | bool | ImportCrossTerm | Whether the crossTerm contents of the package should be imported. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 18 | Unable to create job. |
Error | 53 | Task does not exist. |
Error | 134 | Cannot download server task. |
WanGridManager.DownloadGridPackageAsync2
Downloads the specified crossGrid package from 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 | ImportCrossTank | Whether the crossTank contents of the package should be imported. |
4 | bool | ImportCrossTerm | Whether the crossTerm contents of the package should be imported. |
5 | bool | Confirm | Specifies whether to confirm the package and its tasks (true) or not (false) upon reception. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 18 | Unable to create job. |
Error | 53 | Task does not exist. |
Error | 134 | Cannot download server task. |
WanGridManager.ExportAllUsersExchangeData
Exports users, ratings, languages, subjects, groups, and user settings into an MDB file.
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 should receive the data. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 84 | Cannot adjust DB. |
WanGridManager.ExportCrossGridClassicForMasterServerAsync
Creates a GRU that can be used on the Master Server to import the data supplied from the 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 that should be exported. |
3 | string | PacketPath | The filename of the GWU to create. |
4 | bool | ExportCrossTank | Specifies whether corresponding crossTank entries should also be included in the package. |
5 | bool | ExportCrossTerm | Specifies whether corresponding crossTerm entries should also be included in the package. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the created job. |
Error | 18 | Unable to create job. |
Error | 79 | crossGrid package does not exist. |
WanGridManager.ExportCrossGridClassicForTrustedServer
Creates a GWU that can be used on the Trusted Server to import the 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 that should be exported. |
3 | string | PacketPath | The filename of the GWU to create. |
Return Values
Result | Type/Value | Interpretation |
Success | Is always empty. | |
Error | 79 | crossGrid package does not exist. |
Error | 82 | Cannot export crossGrid classic package. |
WanGridManager.ExportCrossWanClassic
Exports the data for an offline user as CWU file.
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 CWU. The user account under which the crossAPI service runs needs to have access to this directory. |
4 | bool | ExportCrossTank | Specifies whether corresponding crossTank entries should also be included in the package. |
5 | 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 | 54 | Unable to export crossWAN packages. |
WanGridManager.ExportCrossWanClassic2
Exports the data for an offline user as CWU file.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | TasksGuids | The GUIDs of the tasks that should be exported to the CWU file. The GUIDs are separated by semicolons. |
3 | string | PacketPath | The path of the CWU. The user account under which the crossAPI service runs needs to have access to this directory. |
4 | bool | ExportCrossTank | Specifies whether corresponding crossTank entries should also be included in the package. |
5 | 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 | 54 | Unable to export crossWAN packages. |
WanGridManager.ExportCrossWanClassicAsync
Exports the data for an offline user as CWU file.
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 CWU. The user account under which the crossAPI service runs needs to have access to this directory. |
4 | bool | ExportCrossTank | Specifies whether corresponding crossTank entries should also be included in the package. |
5 | bool | ExportCrossTerm | Specifies whether corresponding crossTerm entries should also be included in the package. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the export job. |
Error | 18 | Unable to create job. |
Error | 53 | Task does not exist. |
WanGridManager.ExportCrossWanClassicAsync2
Exports the data for an offline user as CWU file.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | TasksGuids | The GUIDs of the tasks that should be exported to the CWU file. The GUIDs are separated by semicolons. |
3 | string | PacketPath | The path of the CWU. The user account under which the crossAPI service runs needs to have access to this directory. |
4 | bool | ExportCrossTank | Specifies whether corresponding crossTank entries should also be included in the package. |
5 | bool | ExportCrossTerm | Specifies whether corresponding crossTerm entries should also be included in the package. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUID of the export job. |
Error | 18 | Unable to create job. |
Error | 53 | Task does not exist. |
WanGridManager.GenerateCrossTankTermPackets
Generates crossTank and crossTerm packages.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | TasksGuids | The GUIDs of the tasks, separated by semicolons. |
3 | bool | RebuildIfExists | Specifies whether to rebuild the packages (true) or not (false), even if they already exist. |
4 | bool | SkipCrossTank | Specifies whether to skip the crossTank package build (true) or not (false). |
5 | bool | SkipCrossTerm | Specifies whether to skip the crossTerm package build (true) or not (false). |
Return Values
Result | Type/Value | Interpretation |
Success | ||
Error |
WanGridManager.GetCrossGridPackagingTemplateGuidByName
Returns the crossGrid packaging template GUID of the specified package.
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 | ||
Error |
WanGridManager.GetCrossWanPackagingTemplateGuidByName
Returns the crossWAN packaging template GUID of the specified package.
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 | ||
Error |
WanGridManager.GetExternalProjectID
Returns the external project ID of the specified project. The external project ID is the ID of the project on the Master Server.
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 | int | The external project ID. |
Error | 19 | Project does not exist. |
Error | 103 | The project does not have an external ID. |
Error | 104 | External project ID is not set. |
WanGridManager.GetGridPackageList
Returns the list of available packages on the specified Master Server.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | MasterServerGuid | The GUID of the Master Server from which the list of packages should be retrieved. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUIDs of the packages. |
Error | 131 | Cannot apply profile. |
Error | 132 | Cannot create crossWAN/crossGrid session. |
Please note that the SCP file (crossGrid certificate) of the Master Server has to be imported in the system settings of Across beforehand.
WanGridManager.GetGridPackageList2
Returns the list of available packages on the specified master server.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | MasterServerGuid | The GUID of the Master Server from which the list of packages should be retrieved. |
3 | int | Status |
|
Return Values
Result | Type/Value | Interpretation |
Success | string | The GUIDs of the packages. |
Error | 131 | Cannot apply profile. |
Error | 132 | Cannot create crossWAN/crossGrid session. |
Please note that the SCP file (crossGrid certificate) of the Master Server has to be imported in the system settings of Across beforehand.
WanGridManager.GetGridPackageServerContext
Returns the server context of the crossGrid 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. |
3 | bool | ForSyn | Specifies whether to sync (true) or not (false). |
Return Values
Result | Type/Value | Interpretation |
Success | string | The server context GUID. |
Error | 152 | The Server Context does not exist. |
WanGridManager.GetGridServerName
Returns the name of a crossGrid server. Works for both Master and Trusted Servers.
Parameters
Type | Name | Description | |
1 | string | ST | A security token for use in other crossAPI SI functions. |
2 | string | ServerGuid | The GUID of the crossGrid server. |
Return Values
Result | Type/Value | Interpretation |
Success | string | The name of the crossGrid server. |
Error | 78 | The crossGrid Server does not exist. |
WanGridManager.GetJobProgress
Returns the progress of a job. The function only works for jobs created from WanGridManager functions.
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 | int | The progress of the job in percent. |
Error | 17 | Job does not exist. |
Error | 21 | Job has been canceled. |
Other return values are possible. They depend on the executed job and mean the job itself failed.
Do not use this method to find out whether a job is finished or not. A progress of 100 does not necessarily mean that the job is finished already. Use GetJobStatus instead.
WanGridManager.GetJobResult
Returns the result of a finished job. The function only works for jobs created from WanGridManager functions.
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 | int | The progress of the job in percent. |
Error | 17 | Job does not exist. |
Error | 21 | Job has been canceled. |
Error | 43 | The job has not yet been completed. |
Other return values are possible. They depend on the executed job and mean the job itself failed.
WanGridManager.GetJobStatus
Returns the status of a job. The function only works for jobs created from WanGridManager functions.
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 | int |
|
Error | 17 | Job does not exist. |