API di feedback - TIA Portal

Introduzione al TIA Portal

ft:publication_title
Introduzione al TIA Portal
Product
TIA Portal
Version
V21
Publication date
11/2025
Language
it-IT
API di feedback

Introduzione

Esiste la possibilità di utilizzare il servizio di feedback di TIA Portal per mostrare i messaggi all'utente dell'Add-In. Questo consente ad es. di fornire informazioni dettagliate in caso di errore. La posizione nella quale vengono visualizzati questi messaggi dipende dal tipo di Add-In:

  • Scheda standard nella finestra di ispezione

    Tutti i messaggi degli Add-Ins possono essere visualizzati nella finestra di ispezione all'interno della scheda "Informazioni > Generale".

  • Scheda specifica nella finestra di ispezione o nel protocollo

    Se i messaggi di un workflow vengono visualizzati in una scheda specifica della finestra di ispezione o documentati in un protocollo, anche un Add-In può visualizzare i messaggi in questo modo per il workflow interessato. Se un workflow non utilizza una posizione specifica, è comunque possibile visualizzare i messaggi nella finestra di ispezione all'interno della scheda "Informazioni generali > Info".

Nota

DaTIA Portal V21 è stato modificato l'utilizzo di "FeedbackContext".

API

La seguente tabella elenca i metodi per leggere "FeedbackContext" da TIA Portal:

Metodo

Descrizione

GetService<FeedbackProvider>() tramite l'oggetto "TiaPortal"

È possibile accedere al metodo "GetService<FeedbackProvider>" con l'oggetto "TiaPortal". Questo metodo restituisce un servizio "FeedbackContext", il cui valore può essere utilizzato per visualizzare i messaggi nella scheda standard della finestra di ispezione. Questo segue lo schema standard dei fornitori di servizi per l'accesso ai servizi di TIA Portal.

GetService<FeedbackProvider>() tramite l'oggetto "context"

Il metodo "GetService<FeedbackProvider>" può essere richiamato tramite l'oggetto "context".

  • context: Questo parametro contiene l'informazione sul workflow appena eseguito. Il valore viene generato dall'API dell'Add-In del workflow e può essere solo letto e utilizzato.

Il metodo restituisce "FeedbackContext", il cui valore può essere utilizzato per visualizzare i messaggi all'interno di schede specifiche della finestra di ispezione o in un protocollo.

La seguente tabella elenca i metodi di "FeedbackContext":

Metodo

Descrizione

void Log(NotificationIcon notificationIcon, string message)

Questo metodo scrive il messaggio itrasmesso insieme al simbolo di notifica trasmesso nella finestra di ispezione di TIA Portal:

  • notificationIcon: Questo parametro è un Enum che consente di segnalare gli stati "Success", "Information", "Warning" e "Error". In base a questo Enum, nella finestra di ispezione viene visualizzato un simbolo accanto al messaggio.

  • message: Questo parametro contiene il messaggio che deve essere visualizzato nella finestra di ispezione.

Esempio di codice per la visualizzazione dei messaggi nella scheda standard della finestra di ispezione

L'esempio seguente mostra come visualizzare i messaggi nella finestra di ispezione all'interno della scheda "Informazioni > Generale".

//...

var feedbackContext = m_tiaPortal.GetService<FeedbackProvider>();

feedbackContext.Log(NotificationIcon.Success,"Execution succeeded");

//...

Al metodo "GetFeedbackContext" non viene assegnato alcun parametro.

Esempio di codice per la visualizzazione dei messaggi in schede specifiche o in un protocollo

L'esempio seguente mostra come visualizzare i messaggi nella stessa posizione del workflow:

public class ExportWorkflowItem : RfcSimpleLogWorkflowItem

{

public override WorkflowExecutionResult Execute(IEnumerable<IEngineeringObject> selectedObjects, RfcSimpleLogWorkflowContext context)

{

var feedbackContext = context.GetService<FeedbackProvider>();

feedbackContext.Log(NotificationIcon.Success,"Execution succeeded");

//...

}

}

Tenere presente che in questo caso occorre assegnare il contesto come parametro al metodo "GetFeedbackContext".