Scrittura Versioned [C#]

Un tutorial su come scrivere step by step le serie temporali Versioned in Artesian con l'SDK C#.

Artesian ti permette non solo di avere un accesso semplice allo storico dei dati ma anche di poterne scrivere di nuovi al suo interno.

Vediamo passo passo come procedere.

Obiettivo

Scrivere i nostri dati in un Versioned Time Serie Market Data.

I dati e i link di riferimento sono fittizi, creati appositamente per questo case. In Artesian è possibile scrivere qualsiasi dato che sia riconducibile a una Time Serie.

Vediamo passo per passo come procedere.

Importazione delle librerie e configurazione di Artesian

La prima cosa da fare per poter utilizzare tutte le funzionalità di Artesian è quella di scaricare l’SDK Artesian da NuGet.

Una volta installato, ed importate le librerie necessarie (linee1-4), possiamo istanziare l’autenticazione verso Artesian, inserendo il link e l’api-key (linea 6).

Per poter estrarre questi due dati importanti, si può far riferimento al tutorial “Come Configurare Artesian C# SDK”.

Terminata la configurazione dell’autenticazione di Artesian possiamo configurare il Market Data Service (linea 15) e procedere alla scrittura dei dati.

				
					using Artesian.SDK.Dto;
using Artesian.SDK.Service;
using Artesian.SDK.Factory;
using NodaTime;

ArtesianServiceConfig cfg = new ArtesianServiceConfig(new Uri("https://arkive.artesian.cloud/{tenantName}/", "{api-key}");

var qs = new MarketDataService(cfg);
				
			


Il MarketData Identifier e i dati necessari per la scrittura della Versioned TimeSeries

Una volta configurato Artesian e il MarketData Service, possiamo definire il nome del Prodiver ed il nome del Market data che insieme rappresentano il MarketData Identifier, con cui il MarketData di distingue dagli altri all’interno del sistema.

Il nome del Provider, in questo caso sarà “C#SDK”, mentre il nome del Market Data è “VersionedWrite”. Una volta definiti questi nomi, ci sarà più facile trovarli sul portale, sia sotto la voce ProviderName, sia successivamente quando avremo più MarketData sotto lo stesso provider, come nel caso di questi tutorials.

Definiti i nomi del market data e del provider, possiamo passare al decidere le caratteristiche di base della nostra Time Serie, come il tipo di Granularità, il tipo della Time Serie, la TimeZone, e l’eventuale Aggregation Rule.

Artesian può supportare diverse granularità come: 10min, 15min, 30min, Hour, Day, Week, Month, Quarter, Season e Year.

Nel momento in cui decidiamo il tipo di granularità del nostro market data, lo dobbiamo scrivere di conseguenza, indicandone i valori. Nel caso di Granularity.Day, i dati corrisponderanno a un determinato giorno, di un determinato mese, di un determinato anno. Nel caso di Granularity.Hour, i dati corrisponderanno a una determinata ora (minuto e secondo) di uno stesso determinato giorno in  un determinato anno.

Le TimeZone va valorizzata con quella corrispondente al dato che stiamo salvando, questo aiuterà il sistema ad applicare le conversioni necessarie ai dati nel caso di estrazioni in una TimeZone differente dall’originale 

L’Aggregation Rule è quella funzionalità di Artesian che permette di estrarre i dati anche a granularità differenti da quella originale. L’operazione di aggregazione/disaggregazione applicata ai dati è definita tramite la valorizzazione di questa proprietà. Le possibili opzioni sono “Undefined”, “SumAndDivide” oppure “AverageAndReplicate”. Nel caso di “Undefined” non sarà ovviamente possibile estrarre i dati a granularità differenti dall’originale.

Il tipo della Time Serie, in questo caso è Versioned, ma potrebbe essere anche Actual, MarketAssessment, BidAsk oppure Auction. Vedi gli altri tutorial.

				
					 var marketDataEntity = new MarketDataEntity.Input()
{ 
    ProviderName = "C#SDK",
    MarketDataName = "VersionedWrite",
    OriginalGranularity = Granularity.Day,
    OriginalTimezone = "CET",
    AggregationRule = AggregationRule.AverageAndReplicate,
    Type = MarketDataType.VersionedTimeSerie
};

var marketDataService = new MarketDataService(cfg);

var marketData = marketDataService.GetMarketDataReference(new MarketDataIdentifier(
         marketDataEntity.ProviderName,
         marketDataEntity.MarketDataName));
				
			


Controllo e registrazione del MarketData

E’ buona prassi, per evitare errori involontari nell’esecuzione del nostro script, di verificare se il MarketData definito esista già o meno a sistema. Per farlo si esegue lo script riportato sotto in cui utilizzando il Provider e MarketData name è possibile richiedere i dati di registrazione di una curva, se questa esiste già, non occorre fare altro, nel caso non vi sia alcun riscontro, è possibile registrare la nuova curva, attraverso il comando “marketData.Register(marketDataEntity)”.

				
					var isRegistered = await marketData.IsRegistered();
await marketData.Register(marketDataEntity);
				
			


Scrittura dei valori del MarketData

L’ultima parte del nostro codice consiste nell’andare a configurare la scrittura verso Artesian, attraverso il comando “EditVersioned”, dove passiamo anche il momento della creazione delle curve.

I parametri necessari per farlo sono:

Il Marketdata identifier che abbiamo definito all’inizio del nostro codice

La TimeZone di riferimento del dato, questa deve essere “CET” nel caso di dati a granularità oraria o inferiore (ovviamente con l’adeguata conversione dei dati se necessario), deve invece corrispondere all’OriginalTimezone nel caso di dati a granularità giornaliera o superiore.

Le rows del nostro Versioned TimeSerie sono un dictionary di dati in cui la copia “chiave” “valore” è articolata come segue:

  • “chiave” che corrisponde al datetime di riferimento del dato
  • “valore” che corrisponde al numero che vogliamo inserire per quell’istante di tempo
 

Nell’esempio di codice riportiamo sia la scrittura di dati giornalieri, con valori per il 18 e 19 Giugno, sia di valori orari per il 18 Giugno, che vanno dalle ore 9AM alle ore 10AM

Scrivere valori a due differenti granularità non è supportato da Artesian, è stato fatto solamente a titolo di esempio. I dati devo sempre essere scritti alla granularità originale del dato, definita in fase di creazione del Marketdata identifier

Un altro campo obbligatorio da scrivere è il “downloadedAt“, un’informazione di tipo metadata che rappresenta quando il dato è stato generato.

Una volta inseriti i valori e definito il momento di generazione dei dati, possiamo caricare il Versioned Time Serie nel sistema, attraverso il comando “Save“.

 

				
					var writeMarketData = marketData.EditVersioned(new LocalDateTime(2022, 6, 19, 00, 00));

#OriginalGranularity = Granularity.Day
#OriginalTimezone = "CET"
    writeMarketData.AddData(new LocalDate(2022, 6, 18), 40);
    writeMarketData.AddData(new LocalDate(2022, 6, 19), 45);

#OriginalGranularity = Granularity.Hour
#OriginalTimezone = "UTC"
    writeMarketData.AddData(new LocalDate(2022, 6, 18, 9, 0, 0), 42);
    writeMarketData.AddData(new LocalDate(2022, 6, 18, 10, 0, 0), 46);

await writeMarketData.Save(downloadedAt: SystemClock.Instance.getCurrentInstant);


				
			


Visualizzazione del nuovo MarketData nel portale Artesian

A meno che non ci siano errori da segnalare, nel terminal non apparirà nulla. Possiamo però, tornando sul portale di Artesian, verificare che la nostra TimeSerie appaia sotto la categoria ProviderName con il nome, datole precedentemente, di “C#SDK”. 

 

Basta eseguire l’operazione una sola volta per poi averla completamente riproducibile e automatizzata nel nostro workflow.

Questo non solo permette di risparmiare tempo, ma permette anche di ridurre al minimo gli errori umani dati dall’eseguire operazioni ripetute su grandi moli di dati o su diversi file Excel. 

Un vantaggio innegabile che ci consente di focalizzarci sull’analisi del dato invece che sulla sua gestione e ottimizzazione.