For a deeper look into our DataScope Select REST API, look into:

Overview |  Quickstart |  Documentation |  Downloads |  Tutorials

question

Upvotes
Accepted
1 2 1 0

Hi, is there any c# sample code available for Stored & scheduled extraction. I have created a instrument list and report tamplate on web GUI and i just want to download it.

dss-rest-apidssdatascope-selecttick-history-rest-apirest-apidss-gui
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Upvotes
Accepted
11.3k 25 8 14

Hi @sadamhussain7707,

Thanks for the clarification. To retrieve the extracted file from the schedule created on GUI, you need to use extractionsContext.ScheduleOperations.GetByName() to get Schedule object.

Below is the sample code which will save the last extracted file for the "myRecurringSchedule" schedule name.

//Retrieve the schedule by using its name, we need it in the next code block:
Schedule recurringSchedule =
    extractionsContext.ScheduleOperations.GetByName("myRecurringSchedule");

try
{
    //Returns details regarding the last extraction (this may be null)
    extractionsContext.LoadProperty(recurringSchedule, "LastExtraction");  //Loads Schedule.LastExtraction property

    //If there is a last extraction, output the status
    if (recurringSchedule.LastExtraction != null)
    {
        //Last extraction
        var extraction = recurringSchedule.LastExtraction;

        //Display extraction status with details:
        Console.WriteLine("\nStatus: {0} - Detailed status: {1}\nExtraction start-end (UTC):\n{2} - {3}",
            extraction.Status, extraction.DetailedStatus,
            extraction.ExtractionStartUtc, extraction.ExtractionEndUtc);

        //Load the files list.
        //Notes:
        //- The toolkit only populates collections inside entities when you explicitly
        //  call LoadProperty(), so we do that to retrieve the files.
        extractionsContext.LoadProperty(extraction, "Files");
        Console.WriteLine("File count: " + extraction.Files.Count + "\n");

        //Retrieve only the extracted data file, ignore the RIC maintenance and
        //extraction notes files:
        ExtractedFile extractedDataFile =
            extraction.Files.FirstOrDefault(f => f.FileType == ExtractedFileType.Full);

        if (extractedDataFile != null)
        {
            Console.WriteLine("Extracted data file (ignore the others):");
            DssStreamResponse streamResponse =
                    extractionsContext.ExtractedFileOperations.GetReadStream(extractedDataFile);

            using (FileStream fileStream = File.Create("output.csv"))
                streamResponse.Stream.CopyTo(fileStream);
        }
    }
}
catch (TimeoutException ex)
{
    Console.WriteLine("\n{0:T} ERROR: extraction timed out:\n", DateTime.Now);
    DebugPrintAndWaitForEnter(ex.Message);
}
catch (Exception ex)
{
    Console.WriteLine("\n{0:T} ERROR: extraction failed:\n", DateTime.Now);
    DebugPrintAndWaitForEnter(ex.Message);
}
icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Upvote
11.3k 25 8 14

Hi @sadamhussain7707,

I'm not sure if I understand your question correctly.

You can find sample and information regarding Schedule Extraction with DSS .NET SDK on the .Net SDK Tutorial 3: GUI control calls: Validate, extraction.

To schedule extraction with instrument list and report template created on GUI using C# application, you need to get the schedule and instrument list id using the following method.

Below is the sample code which creates a Schedule with InstrumentList and Report Template created on DSS GUI.

//Retrieve instrumentList by name (e.g. "myInstrumentList")
InstrumentList instrumentList = extractionsContext.InstrumentListOperations.GetByName("myInstrumentList");
string instrumentListId = instrumentList.ListId;

//Retrieve report template by name (e.g. "MyReportTemplate")
var retrievedTemplate = extractionsContext.ReportTemplateOperations.GetByName("MyReportTemplate");
string reportTemplateId = retrievedTemplate.ReportTemplateId;

//-----------------------------------------------------------------
//Create a schedule:
//-----------------------------------------------------------------
//Create a daily recurring EOD schedule.
//For testing purposes we set it 2 minutes in the future:
int waitMinutes = 2;
DateTimeOffset dateTimeNow = DateTimeOffset.Now;
DateTimeOffset dateTimeSchedule = dateTimeNow.AddMinutes(waitMinutes);
int scheduleHour = dateTimeSchedule.Hour;
int scheduleMinute = dateTimeSchedule.Minute;

string recurringScheduleId = dssClient.CreateTimedRecurringSchedule(
    "myRecurringSchedule", instrumentListId, reportTemplateId,
    scheduleHour, scheduleMinute, "myTimedRecurringExtractionOutput.csv");
DebugPrintAndWaitForEnter("Returned recurring schedule ID: " + recurringScheduleId);

//Retrieve the schedule by using its name, we need it in the next code block:
Schedule recurringSchedule =
    extractionsContext.ScheduleOperations.GetByName("myRecurringSchedule");


icon clock
10 |1500

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Hi @veerapath.rungruengrayubkul,

Thanks for your reply, By download i was mean to retrieve the report CSV file from DSS server to local directory. I have created schedule on web GUI which start extraction at a specific time on everyday, In code i just want to download report CSV file from DSS server.