Guida per l'utente › Gestione del livello di servizio › Ambito di business logic › Come utilizzare Business logic › Oggetti business logic › Oggetto di contesto

Oggetto di contesto

Fornisce informazioni sulla metrica calcolata, come indicato di seguito:

Clusteritem

Restituisce il nome dell'elemento corrente del gruppo (se la metrica corrente è di gruppo) o una stringa vuota (se la metrica non è di gruppo).

ClusterItemId

Restituisce l'ID dell'elemento corrente del gruppo (se la metrica corrente è di gruppo) o 0 (se la metrica non è di gruppo).

ClusterSize

Restituisce le dimensioni del gruppo per le metriche di gruppo. Se la metrica non è di gruppo, il valore restituito è 1.

ConsumptionUnit

Restituisce il nome dell'unità di consumo della metrica corrente, come definito nella pagina Dettagli metrica. L'unità stessa è definita in Progettazione, Entità basilari, Unità. Questo valore può essere lasciato senza impostazioni, nel qual caso viene restituita una stringa vuota. Il valore fa parte della funzionalità Tipi di metrica.

Esempio:

Dim Unit
Unit = Context.ConsumptionUnit

ConsumptionUnitSymbol

Restituisce il simbolo dell'unità di misura della metrica corrente, come definito nella pagina Dettagli metrica. L'unità stessa è definita in Progettazione, Entità basilari, Unità. Questo valore può essere lasciato senza impostazioni, nel qual caso viene restituita una stringa vuota. Il valore fa parte della funzionalità Tipi di metrica.

Esempio:

Dim Sym
Sym = context.measurementunitsymbol

Contratto

Il nome del contratto che contiene la metrica che ha generato l'evento. Se l'evento è stato generato da un adapter, viene restituita una stringa vuota.

ContractEffectiveFrom

Restituisce la data a partire dalla quale il contratto (non solo la versione corrente) è valido.

ContractEffectiveTo

Restituisce la data di scadenza della validità del contratto (non solo della versione corrente).

ContractId

L'ID del contratto che contiene la metrica che ha generato l'evento. Se l'evento è stato generato da un adapter, il valore della proprietà è 0.

ContractParty

Nome del contraente titolare del contratto. Il contratto contiene la metrica che ha generato l'evento. Se l'evento è stato generato da un adapter, viene restituita una stringa vuota.

ContractPartyId

ID del contraente titolare del contratto. Il contratto contiene la metrica che ha generato l'evento. Se l'evento è stato generato da un adapter, il valore della proprietà è 0.

ContractType

Restituisce il valore del tipo di contratto corrente, come definito in nella pagina 'Generale' dei dettagli del contratto. Il valore fa parte della funzionalità End-to-end.

Esempio:

Dim CType
CType = Context.ContractType

CorrectionsApply

Restituisce True se il calcolo corrente prende in considerazione delle correzioni.

CorrectionsFolded

Restituisce True se non vi sono modifiche. Il calcolo corrente viene eseguito per entrambe le modalità WithCorrections e WithoutCorrections.

DomainCategoryRelation

Restituisce la relazione di categoria di dominio (NMT o nlt), come definito nei dettagli della categoria di dominio per la metrica.

Dump

Restituisce una stringa contenente i contenuti dell'oggetto di contesto in un formato leggibile.

EntryPoint

Restituisce il nome dell'ultimo gestore eventi chiamato nello script dall'esterno dello script. I valori possibili sono:

• OnLoad
• OnRegistration
• OnPeriodStart
• OnTimeSlotEnter
• OnTimeSlotExit

Qualsiasi altra funzione chiamata come risultato di un evento.

ExceptionsApply

Restituisce True se il calcolo corrente prende in considerazione delle eccezioni.

ExceptionsFolded

Restituisce True se non vi sono eccezioni. Il calcolo corrente viene eseguito per entrambe le modalità WithExceptions e WithoutExceptions.

Field("Price Per Unit")

Restituisce una mappa della tabella Prezzo unitario definita nella pagina Dettagli metrica. Questa mappa consente all'utente di cercare i valori di prezzo nella tabella per utilizzarli a livello di business logic. La mappa fa parte della funzionalità Modulo finanziario.

Esempio:

Dim PPUMap
Set PPUMap = Context.Field("Price Per Unit")

Per ogni elemento nella mappa
   x = element
Avanti

Formula

Restituisce il nome della formula.

FormulaId

Restituisce l'ID della formula.

GetRegistrations

Restituisce una mappa di mappe che, in fase di runtime, fornisce all'utente un elenco delle registrazioni definite nella metrica di calcolo corrente.

Nota: la mappa generale contiene solo le mappe che includono le informazioni di registrazione.

Esempio:

Dim rMap
Set rMap = Context.GetRegistrations

HasService

Restituisce un valore booleano che specifica se la metrica corrente dispone di un servizio associato (alcuni tipi di metrica, ad esempio KPI, non dispongono di servizi). Il valore fa parte della funzionalità Metriche senza servizio.

Esempio:

Dim WithService
WithService = Context.HasService

IntervalLength

L'intervallo di lunghezza (nelle unità rilevate nella proprietà TimeUnit) del calcolo che ha generato l'evento. Se l'evento è stato generato da un adapter, la proprietà contiene il valore 0. Se l'evento è stato generato da una metrica, ma non mediante il calcolo del periodo di riferimento, il valore di questa proprietà è sempre 1. Se l'evento è stato generato dal periodo di riferimento della metrica, il valore corrisponde al numero di TimeUnits del periodo di riferimento.

IsInForecast

Restituisce un valore booleano che indica se il calcolo corrente viene eseguito per la previsione della metrica. Il valore fa parte della funzionalità Previsione.

Esempio:

Dim Forecasting
Previsione = Context.IsForecast

IsTargetDynamic

Restituisce un valore booleano che specifica se la metrica corrente è dinamica. Il valore fa parte della funzionalità Destinazione dinamica.

Esempio:

Dim IsDynamic
IsDynamic = Context.IsTargetDynamic

IsTrackingPeriod

Se l'evento è stato inviato dal calcolo del periodo di riferimento di una metrica, il valore è True. Se l'evento è stato inviato dall'adapter, il valore è False.

IsWithinTimeSlot

Restituisce True se l'evento si è verificato durante il periodo di applicazione della metrica.

MainIndicator

Restituisce il valore dell'indicatore principale della metrica corrente, come definito nella pagina Dettagli metrica. Il valore fa parte della funzionalità Tipi di metrica.

Esempio:

Dim Indicator
Indicatore = Context.MainIndicator

MainMode

Restituisce True se ExceptionsApply o ExceptionsFolded sono True e CorrectionsApply o CorrectionsFolded sono True. In altre parole, MainMode restituisce True se il calcolo corrente si applica a entrambe le modalità WithCorrections e WithExceptions.

MeasurementUnit

Restituisce il nome dell'unità di misura della metrica corrente, come definito nella pagina Dettagli metrica. L'unità stessa è definita in Progettazione, Entità basilari, Unità. Se non viene impostato alcun valore, viene restituita una stringa vuota. Il valore fa parte della funzionalità Tipi di metrica.

Esempio:

Dim Unit
Unit = Context.MeasurementUnit

MeasurementUnitSymbol

Restituisce il simbolo dell'unità di misura della metrica corrente, come definito nella pagina Dettagli metrica. L'unità stessa è definita in Progettazione, Entità basilari, Unità. Se non viene impostato alcun valore, viene restituita una stringa vuota. Il valore fa parte della funzionalità Tipi di metrica.

Esempio:

Dim Sym
Sym = context.measurementunitsymbol

RegistrationTime

Restituisce l'ultima chiamata della procedura OnRegistration.

Poiché OnRegistration, a differenza di altri gestori eventi, non include un parametro di tempo, utilizzare RegistrationTime per ottenere l'ora corrente.

Resources(<resourceGroup>, <resourceType>, <withContractParty>, <withService>)

I parametri forniti filtrano questo elenco di risorse:

• Se viene fornito il parametro resourceGroup, vengono restituite unicamente le risorse di questo gruppo.
• Se viene fornito il parametro resourceType, vengono restituite unicamente le risorse di questo tipo.
• Se withContractParty è True, vengono restituite unicamente le risorse appartenenti al contraente corrente.
• Se withService è True, vengono restituite unicamente le risorse appartenenti al servizio corrente.

Resources(resourceGroup, resourceType, withContractParty, withService, time)

Simile a ResourcesOfType, tranne per il fatto che restituisce solo le risorse connesse:

• Al gruppo di risorse
• Al tipo di risorsa della metrica corrente del contratto alla data/ora specificate.

• Se viene fornito il parametro resourceGroup, vengono restituite unicamente le risorse di questo gruppo.
• Se viene fornito il parametro resourceType, vengono restituite unicamente le risorse di questo tipo.
• Se il parametro DirectDescendantsOnly è specificato come True, vengono restituiti unicamente i discendenti diretti dell'oggetto corrente.

Esempio:

Dim map
Set map = Context.Resources "ThisResourceGroup", "ThisResourceType", True, False, #01/01/06 12:45:00#

ResourceDisplayNameById (resourceId)

Restituisce il nome visualizzato di una risorsa per un dato ID risorsa.

Esempio:

Dim resourceDisplayNameById
resourceDisplayNameById = context. resourceDisplayNameById(1000)

ResourceDisplayNameByName ("resourceName")

Restituisce il nome visualizzato di una risorsa per un dato nome di risorsa.

Esempio:

Dim resourceDisplayNameByName
resourceDisplayNameByName = context. resourceDisplayNameByName("London")

ResourcesOfContractParty(<resourceType>)

Simile a ResourcesOfType, tranne per il fatto che questo metodo restituisce solo le risorse connesse al contraente del contratto corrente al momento.

ResourcesOfContractParty(resourceType, time)

Simile a ResourcesOfType, tranne per il fatto che restituisce solo le risorse connesse al contraente del contratto corrente alla data/ora specificate.

Esempio:

Dim map
Set map = Context.ResourcesOfContractParty
"ThisResourceType", #01/01/06 12:45:00#

ResourcesOfContractPartyAndService(<resourceType>)

Simile a ResourcesOfType, tranne per il fatto che questo metodo restituisce solo le risorse:

• Connesse al servizio della metrica corrente
• Il contraente del contratto corrente al momento.

ResourcesOfContractPartyAndService(resourceType, time)

Simile a ResourcesOfType, tranne per il fatto che restituisce solo le risorse:

• Al gruppo di risorse
• Il tipo di risorsa della regola corrente alla data/ora specificate, quando sono connesse al servizio della regola corrente.
• Il contraente del contratto corrente alla data/ora specificate.

Esempio:

Dim map
Set map = Context.ContractPartyAndService "ThisResourceType", #01/01/06 12:45:00#

ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

Simile a ResourcesOfType, tranne per il fatto che restituisce solo le risorse connesse:

• Al gruppo di risorse
• Al tipo di risorsa della regola corrente del contratto alla data/ora specificate.

• Se viene fornito il parametro resourceGroup, vengono restituite unicamente le risorse di questo gruppo.
• Se viene fornito il parametro resourceType, vengono restituite unicamente le risorse di questo tipo.
• Se il parametro DirectDescendantsOnly è specificato come True, vengono restituiti unicamente i discendenti diretti dell'oggetto corrente.

Esempio:

Dim map
Set map = Context.ResourcesOfResourceGroup "ThisResourceGroup", "ThisResourceType", #01/01/06 12:45:00#, True

ResourcesOfService (<resourceType>)

Simile a ResourcesOfType, tranne per il fatto che il metodo restituisce solo le risorse connesse al servizio del contratto corrente al momento.

ResourcesOfService (<resourceGroup>, <resourceType>)

Simile a ResourcesOfType, tranne per il fatto che il metodo restituisce solo le risorse contenute (direttamente e indirettamente) nel gruppo di risorse definito al momento.

ResourcesOfService(resourceGroup, resourceType, time)

Simile a ResourcesOfType, tranne che per il fatto che il metodo restituisce solo le risorse contenute (direttamente e indirettamente) nel gruppo di risorse definito alla data/ora specificate.

Esempio:

Dim map
Set map = Context.ResourcesOfService
"ThisResourceGroup", "ThisResourceType", #01/01/06 12:45:00#

ResourcesOfService(resourceType, time)

Simile a ResourcesOfType, tranne per il fatto che restituisce solo le risorse connesse al servizio del contratto corrente alla data/ora specificate.

Esempio:

Dim map
Set map = Context.ResourcesOfService
 "ThisResourceType", #01/01/06 12:45:00#

ResourcesOfType, ResourcesOfContractParty, ResourcesOfService, ResourcesOfResourceGroup, Resources, ResourcesOfContractPartyAndService

Tutte queste funzioni hanno un nuovo parametro facoltativo chiamato Time (Ora). Se il parametro non è specificato, viene utilizzata l'ora corrente.

• ResourcesOfType(resourceType, time)

  Restituisce una mappa di ID di risorsa. Ogni voce della mappa restituita include la chiave e il valore impostati per l'ID di risorsa.

  • Se viene fornito un parametro di risorse Type, questo metodo restituisce tutte le risorse:
    • Esistenti e collegate al tipo di risorsa indicato per il periodo visualizzato.
  • Se viene fornito il parametro resourceType, questo metodo restituisce un elenco di tutte le risorse:
    • Esistenti alla data/ora specificate.
  • Se il parametro temporale non è specificato, viene utilizzata l'ora corrente.

  Esempio:

  Dim map
  Set map = Context.ResourcesOfType "ThisResourceType", #01/01/06 12:45:00#
  

• ResourcesOfContractParty(resourceType, time)

  Simile a ResourcesOfType, tranne per il fatto che restituisce solo le risorse connesse al contraente del contratto corrente alla data/ora specificate.

  Esempio:

  Dim map
  Set map = Context.ResourcesOfContractParty
   "ThisResourceType", #01/01/06 12:45:00#
  

• ResourcesOfService(resourceType, time)

  Simile a ResourcesOfType, tranne per il fatto che restituisce solo le risorse connesse al servizio del contratto corrente alla data/ora specificate.

  Esempio:

  Dim map
  Set map = Context.ResourcesOfService
   "ThisResourceType", #01/01/06 12:45:00#
  

• ResourcesOfService(resourceGroup, resourceType, time)

  Simile a ResourcesOfType, tranne che per il fatto che il metodo restituisce solo le risorse contenute (direttamente e indirettamente) nel gruppo di risorse definito alla data/ora specificate.

  Esempio:

  Dim map
  Set map = Context.ResourcesOfService
   "ThisResourceGroup", "ThisResourceType", #"01/01/06 12:45:00#
  

• ResourcesOfContractPartyAndService(resourceType, time)

  Simile a ResourcesOfType, tranne per il fatto che restituisce solo le risorse connesse al servizio:

  • Della regola corrente
  • Del contraente del contratto corrente alla data/ora specificate.

  Esempio:

  Dim map
  Set map = Context.ContractPartyAndService "ThisResourceType", #01/01/06 12:45:00#
  

• ResourcesOfResourceGroup (resourceGroup, resourceType, time, DirectDescendantsOnly)

  Simile a ResourcesOfType, tranne per il fatto che restituisce solo le risorse connesse:

  • Al gruppo di risorse
  • Al tipo di risorsa
  • Della regola corrente
  • Del contratto corrente alla data/ora specificate.
  • Se viene fornito il parametro resourceGroup, vengono restituite unicamente le risorse di questo gruppo.
  • Se viene fornito il parametro resourceType, vengono restituite unicamente le risorse di questo tipo.
  • Se il parametro DirectDescendantsOnly è specificato come True, vengono restituiti unicamente i discendenti diretti dell'oggetto corrente.

  Esempio:

  Dim map
  Set map = Context.ResourcesOfResourceGroup "ThisResourceGroup", "ThisResourceType", #01/01/06 12:45:00#, True
  

• Resources(resourceGroup, resourceType, withContractParty, withService, time)

  I parametri forniti filtrano questo elenco di risorse:

  • Se viene fornito il parametro resourceGroup, vengono restituite unicamente le risorse di questo gruppo.
  • Se viene fornito il parametro resourceType, vengono restituite unicamente le risorse di questo tipo.
  • Se withContractParty è True, vengono restituite unicamente le risorse appartenenti al contraente corrente.
  • Se withService è True, vengono restituite unicamente le risorse appartenenti al servizio corrente.
  • Se il parametro di tempo è definito, l'elenco viene creato per la data specificata. In caso contrario verrà utilizzata l'ora corrente.

  Esempio:

  Dim map
  Set map = Context.Resources "ThisResourceGroup", "ThisResourceType", True, False, #01/01/06 12:45:00#
  

ResourceNameById

Restituisce il nome di una risorsa o un gruppo di risorse per uno specifico ID di risorsa.

Esempio:

Dim MyResourceName
MyResourceName = Context. ResourceNameById (1234)

ResourceIdByName

Restituisce l'ID per la risorsa o un gruppo di risorse, con l'ID specificato.

Esempio:

Dim MyResourceId
MyResourceId = Context. ResourceIdByName (“MyResource”)

Regola

Restituisce il nome della metrica.

RuleId

Restituisce l'ID della metrica.

RulePeriodTimeUnit

Restituisce l'unità di tempo del periodo di riferimento della metrica. Se il periodo di riferimento della metrica è un mese e l'unità di tempo corrente è un anno, il valore restituito è un mese.

Servizio

Restituisce il nome del servizio.

ServiceId

Restituisce l'ID del servizio.

Target

Restituisce la destinazione della metrica oppure null se la metrica non dispone di una destinazione.

ThresholdRed

Restituisce il valore Soglia rossa che è stato impostato nella scheda Soglie della metrica. Se non è stato impostato alcun valore, viene restituito il valore -1.

Esempio:

Dim RedThreshold
RedThreshold = Context.ThresholdRed

ThresholdYellow

Restituisce il valore Soglia gialla che è stato impostato nella scheda Soglie della metrica. Se non è stato impostato alcun valore, viene restituito il valore -1.

Esempio:

Dim YellowThreshold
YellowThreshold = Context.ThresholdYellow

TimeOfLastEvent

Restituisce il valore dell'ultimo evento (entrambi i dati non elaborati e l'evento di metrica) inviato per la business logic. In altre parole, restituisce la data e l'ora dell'evento che ha causato l'esecuzione della riga corrente che contiene la chiamata a questa proprietà. Il valore fa parte della funzionalità Riusabilità dell'evento.

Esempio:

Dim EventTime
EventTime = Context.TimeOfLastEvent

Periodo di applicazione

Restituisce il nome del periodo di applicazione.

TimeSlotId

Restituisce l'ID del periodo di applicazione.

TimeslotDescription

Restituisce la descrizione del periodo di applicazione utilizzato dalla metrica. Se il campo Descrizione è vuoto, il valore restituito è il nome del periodo di applicazione.

Unità di tempo

Se l'evento ha generato la metrica, questa proprietà contiene l'unità di tempo del calcolo. Tale valore può essere: HOUR, DAY, WEEK, MONTH, QUARTER, YEAR. Se il valore è una stringa vuota, significa che l'evento è stato generato da un adapter.