TbServices API

Sommario
Nel presente articolo sono descritti i metodi web del Web Service TbServices.

Elenco metodi web
Per facilitare la ricerca di uno specifico metodo sono di seguito elencati i metodi web trattati nel proseguo dell'articolo:

• CloseTB
• CreateTB
• GetCachedFile
• GetData
• GetDocumentSchema
• GetReportSchema
• GetTbLoaderInstantiatedListXML
• GetXMLEnum
• GetXMLHotLink
• Init
• IsAlive
• IsTbLoaderInstantiated
• KillProcess
• KillThread
• ReleaseTB
• SetData
• StopProcess
• StopThread
• XmlGetParameters

CloseTB
Il metodo CloseTB consente di chiudere una specifica istanza del TBLoader.

void CloseTB(string easyToken)

Parametri input

CreateTB
Il metodo CreateTB permette di creare un'istanza del TBLoader.

int CreateTB(
             string authenticationToken, 
             DateTime applicationDate, 
             bool checkDate, 
	     out string easyToken)

Parametri input

Parametri output

Valore di ritorno
Se l'istanza del TBLoder è stata creata o trovata con successo il valore di ritorno è positivo ed indica il numero della porta, altrimenti il valore è negativo ed assume il seguente significato:

GetCachedFile
Il metodo GetCachedFile consente di ottenere un file disponibile nella cartella di installazione del prodotto.

string GetCachedFile(
                     string authenticationToken, 
                     string nameSpace,
                     string user, 
                     string company
)

Parametri input

Valore di ritorno
Stringa valorizzata con il file richiesto.

GetData
Il metodo GetData permette di avere un insieme di documenti in formato xml che soddisfano i parametri.

StringCollection GetData(
                         string authenticationToken, 
                         string parameters, 
			 DateTime applicationDate, 
			 int loadAction, 
			 int resultType, 
			 int formatType,
			 bool useApproximation	
)

Parametri input

Valore di ritorno
Collezione di stringhe xml contenente i dati dei documenti.

GetDocumentSchema
Il metodo GetDocumentSchema consente di ottenere una stringa contenente lo schema di un profilo di esportazione di un documento.

string GetDocumentSchema(
                     string authenticationToken, 
                     string nameSpace,
                     string profileName, 
                     string forUser
)

Parametri input

Valore di ritorno
Stringa valorizzata con lo schema del profilo di esportazione del documento.

GetReportSchema
Il metodo GetReportSchema permette di avere una stringa contenente lo schema di un profilo di un report.

string GetReportSchema(
                     string authenticationToken, 
                     string reportNamespace,
                     string forUser
)

Parametri input

Valore di ritorno
Stringa valorizzata con lo schema del profilo di esportazione del report.
 

GetTbLoaderInstantiatedListXML
Il metodo GetTbLoaderInstantiatedListXML fornisce l'elenco delle istanze del TBLoder.

string GetTbLoaderInstantiatedListXML(string authenticationToken)

Parametri input

Valore di ritorno
Stringa valorizzata con le informazioni di tutte le istanze del TBLoder.
La struttura della stringa XML è la seguente:

<Processes>
    <Process> 
      <Threads>
          <Thread name="" 
                  title="" 
                  company="" 
                  user="" 
                  operationDate="" 
                  loginthreadname="" 
                  loginthreadid="" 
                  documentthread=""
                  canbestopped="" 
                  remoteinterfaceattached="" 
                  inactivitytime="" 
                  modalstate="" 
                   />
        </Thread>
     </Process>  
</Processes>  

GetXMLEnum
Il metodo GetXMLEnum consente di ottenere una stringa localizzata con le informazione relative ad un enumerativo.

string GetXMLEnum(
                     string authenticationToken, 
                     int enumID,
                     string userLanguage, 
)

Parametri input

Valore di ritorno
Stringa contenente il valore dell'enumerativo espresso nella lingua passata.
La stringa è la rappresentazione di un file XML con la seguente sintassi:

<?xml version=\"1.0\" encoding=\"utf-8\"?>
<enum>
     <description></description>
     <item>
         <description></description> 
         <stored></stored> 
     </item>
</enum>  

GetXMLHotLink
Il metodo GetXMLHotLink permette di avere la descrizione di un HotLink legata ad un campo specifico.

string GetXMLHotLink(
                     string authenticationToken, 
                     string docNamespace,
                     string nsUri, 
                     string fieldXPath
)

Parametri input

Valore di ritorno
Stringa xml valorizzata con la descrizione del HotLink legata ad un campo specifico.

Init
Il metodo Init consente di resettare un'istanza del TBServices.

void Init()

IsAlive
Il metodo IsAlive controlla la risposta del TbServices Web Service.

bool IsAlive()

Valore di ritorno
Valore booleano che indica se il metodo è vivo e riceve la richiesta.

IsTbLoaderInstantiated
Il metodo IsTbLoaderInstantiated consenti di sapere se almeno un processo TBLoader.exe è già caricato.

bool IsTbLoaderInstantiated(string authenticationToken)

Parametri input

Valore di ritorno
Valore booleano che indica se un processo TBLoader.exe è disponibile.

KillProcess
Il metodo KillProcess permette di chiudere uno specifico processo.

void KillProcess(int processId, string authenticationToken)

Parametri input

KillThread
Il metodo KillThread consente di chiudere uno specifico thread all'interno di un processo TbLoader.

void KillThread(int threadId, int processId, string authenticationToken)

Parametri input

ReleaseTB
Il metodo ReleaseTB permette di rimuovere una specifica istanza del TBLoader.

void ReleaseTB(string easyToken)

Parametri input

SetData
Il metodo SetData permette di inserire, modificare ed eliminare un documento.

bool SetData(
             string authenticationToken, 
             string data, 
             DateTime applicationDate, 
             int postingAction, 
             bool useApproximation, 
	     out string result)

Parametri input

Parametri output

Valore di ritorno
Valore che indica se l'operazione eseguita ha avuto esito positivo.

StopProcess
Il metodo StopProcess permette di arrestare uno specifico processo.

bool StopProcess(int processId, string authenticationToken)

Parametri input

Valore di ritorno
Valore booleano che se impostato a true indica che il metodo è stato completato con successo.

StopThread
Il metodo StopThread consente di arrestare uno specifico thread all'interno di un processo TbLoader.

void StopThread(int threadId, int processId, string authenticationToken)

Parametri input

Valore di ritorno
Valore booleano che se impostato a true indica che il metodo è stato completato con successo.

XmlGetParameters
Il metodo XmlGetParameters permette di avere i parametri di un documento con i valori di default.

string XmlGetParameters(
             string authenticationToken, 
             string parameters, 
             DateTime applicationDate, 
             bool useApproximation)

Parametri input

Valore di ritorno
Stringa XML valorizzata con tutti i parametri del documento.