How to create a return kit?

I would like to create a plugin that allows the user to create a return kit and upload to the server from the Editor View.

What is the best method to access this functionality from the API?

Parents Reply Children
  • Not really, this creates a Studio Return Package. I am looking for one that can be uploaded to SDL WorldServer.

    This method produces a return package that for some reason cannot be imported to WorldServer, it produces this error message: "The import attempt failed because the selected file "Testpackage-2016516-10h59m0s.sdlrpx" does not have a recognizable extension by WorldServer, or metadata file is missing from the contents of the selected file if the file is a zip archive."


    What is needed is an *.wsxz package created from this *.sdlrpx. The wsxz is essentially a stripped down xliff in a zip file that can be imported by the WorldServer.

  • Hi Balázs,

    I understand your question now.
    It appears there is nothing in the Public API to support this though unfortunately.
  • I was afraid of that, I studied the APIs for hours and I could not figure it out. It seems that the Converters should be accessible somehow and the project converted. I have this other topic going:
    community.sdl.com/.../7571
    I was able to get to a lot of parts of Studio through the APIs (by studying the source codes on GitHub) that seemed inaccessible through the APIs first.
    So maybe there is some indirect way in through once of the APIs. I still have not given up.
  • I have no idea if this would work, but my understanding is the same as your in that the return package is simply an sdlxliff inside a compressed folder that has the extension of .sdlrpx.wsxz instead of zip. Have you tried simply zipping up the sdlxliff(s) from the project folder and renaming it to match the standard above? I am not a developer so i couldn't say if those calls exist in the SDL SDK but am familiar enough to know that those functions are pretty basic, as long as SDL lets you get to the sdlxliff you could likely give it a go.
  • Hi Eric,
    Thanks. Well, the WSXZ is a zip file alright, but in there lies a since xlf (in WorldSever format) not an sdlxliff.
    So unfortunately WS does not recognize it. Even if I extract the sdlxliff and rename it to xlf and upload to WS, I don't get error, only the message that no items were imported.
    So there needs to be a conversion from sdlxliff to WS xliff.
    And you know what, it is a simple conversion. So I can't think that this is not exposed by the APIs. I very much would prefer to access the function via the APIs rather then writing a conversion code myself... (which is still an option though), but I prefer not.
    Best, Balázs
  • Hi Balázs,

    Yes, the documentation is very poor, so there are a lot of undocumented features.
    However, the Sdl.TranslationStudio.Packaging.Convertors.WorldServer.dll is not marked for public use, so if you try to use it you will get an error when Trados loads your plug-in.

    You may be able to use a workaround though like Eric Bishop mentions, i.e. zip the files yourself.

    You can generate the sdlxliff file to the xliff and then zip it.

    To generate the xliff data, use the RunAutomaticTask function:

    Example:

     or

  • Hi Jesse,
    Thanks for the reply. Well, the sdlxliff generation is exposed easily with these simple lines of code:

     
    This is a ZIP file, so you can then access the current sdlxliff in the target folder. Only this xliff is incompatible with WS.
    When you create a return package with Studio, it puts the sdlrpx file through a conversion and outputs a wsxz file, which also has an xlf inside, but it is it the WS xliff format that is understood by the WS and can be imported.

    So there is a converter and of course I could write another one, but I hope I can access the one someway through the exposed APIs.

  • Thanks for the example code lines. This API does not have the needed conversions. Actually the EditorController.SaveTargetAs() is better for this: community.sdl.com/.../28261