About the Cleanup instruction

Hubert CANEVET
Hubert CANEVET Explorer
in TRTH

Hello everybody,

I remark the instruction "Cleanup" at the end of the examples given by the example application.

I presume I have to pass it all objects created in the function I write. I tempted to read a documentation about that, the search engine was not very direct about that. This is to clean the memory, and changes nothing on the server, right ?

Tagged:

Best Answer

  • Christiaan Meihsl
    Christiaan Meihsl LSEG
    Answer ✓

    @Hubert CANEVET,

    To cleanup is to delete the extracted files, the schedule, the instrument list and report template. The C# example app has a "Cleanup" example under "Scheduled Extractions" that shows how you could do that. Both the C# example app and the tutorials cleanup after execution, so as not to leave any unused objects in your environment.

    But cleaning up is not an obligation. If you created a recurring schedule, then you certainly don't want to delete its objects, because the schedule will require them the next time it runs !

    Cleaning up or not depends on your workflow. If you want to reuse objects you created (be it the instrument list, the report template or the schedule), then you should not delete them !

    Added later:


    When you create objects like an instrument list, a report template, or a schedule, they are stored on the DSS server, and will stay there until you delete them. So the best practice is to delete them IF and WHEN you do not need them any more.


    So just to be quite clear: the cleanup is not about garbage cleaning, process memory and such. It is just the action of deleting objects that are no longer required (instrument list, report template, schedule).

    The C# example app implemented that and named it "Cleanup", but it is not an API call, that is why it is not in the documentation.

Answers

  • Hubert CANEVET
    Hubert CANEVET Explorer

    Hello, thank you for your answer.

    But cleaning up is not an obligation. If you created a recurring 
    schedule, then you certainly don't want to delete its objects, because 
    the schedule will require them the next time it runs !

    Well, this is exactly why I wanted to verify whether the aim of Cleanup is just to clean up the memory, and changes nothing on the server.

    Of course, the next time, I get the schedule back by its name (rather than its id, as I have to create it again if it is not found).

  • Hubert CANEVET
    Hubert CANEVET Explorer

    Oh, thank you.

    Sorry for the delay, I read more clearly today.

Categories