Table of Contents

Class AnaliseWS

Namespace
PHCWS
Assembly
PHCWS.dll
[WebService(Namespace = "http://www.phcgo.net/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class AnaliseWS : PHCGenericWS, IComponent, IDisposable, IServiceProvider
Inheritance
AnaliseWS

Methods

analiseanual_getanalisebase(decimal, bool, string, string, List<VarsVO>)

[WebMethod]
public PHCResult analiseanual_getanalisebase(decimal qualanalise, bool lRecalc, string cTabela, string cStamp, List<VarsVO> cVars)

Parameters

Nome Tipo Descrição
qualanalise decimal
lRecalc bool
cTabela string
cStamp string
cVars List<VarsVO>

Returns

PHCResult

analiseanual_getanalisemensal(decimal, bool, string, string, List<VarsVO>)

Executes an annual analysis

[WebMethod]
public PHCResult analiseanual_getanalisemensal(decimal qualanalise, bool lRecalc, string cTabela, string cStamp, List<VarsVO> cVars)

Parameters

Nome Tipo Descrição
qualanalise decimal

Analysis fusqlid

lRecalc bool

Recalculates again without using cache. TODO: Remove

cTabela string

Entity name of the record we want to execute the analysis for.

cStamp string

Record stamp

cVars List<VarsVO>

Analysis parameters needed for the execution

Returns

PHCResult

analiseextracto_getanalisebase(decimal, bool, string, string, List<VarsVO>, bool)

Executes an extract analysis

[WebMethod]
public PHCResult analiseextracto_getanalisebase(decimal qualanalise, bool lRecalc, string cTabela, string cStamp, List<VarsVO> cVars, bool paraGrafico)

Parameters

Nome Tipo Descrição
qualanalise decimal

Analysis fusqlid

lRecalc bool

Recalculates again without using cache. TODO: Remove

cTabela string

Entity name of the record we want to execute the analysis for. TODO: Remove

cStamp string

Record stamp

cVars List<VarsVO>

Analysis parameters needed for the execution

paraGrafico bool

If it's to be used in graphic, returns 30 results

Returns

PHCResult

analisemensal_getanalisebase(decimal, bool, string, string, List<VarsVO>)

Executes an monthly analysis

[WebMethod]
public PHCResult analisemensal_getanalisebase(decimal qualanalise, bool lRecalc, string cTabela, string cStamp, List<VarsVO> cVars)

Parameters

Nome Tipo Descrição
qualanalise decimal

Analysis fusqlid

lRecalc bool

Recalculates again without using cache. TODO: Remove

cTabela string

Entity name of the record we want to execute the analysis for.

cStamp string

Record stamp

cVars List<VarsVO>

Analysis parameters needed for the execution

Returns

PHCResult

analisenormal_intexecutar(decimal, string, string, List<VarsVO>, bool)

[WebMethod]
public PHCResult analisenormal_intexecutar(decimal qualanalise, string cQual, string cStamp, List<VarsVO> cVars, bool lChecked)

Parameters

Nome Tipo Descrição
qualanalise decimal
cQual string
cStamp string
cVars List<VarsVO>
lChecked bool

Returns

PHCResult

analiseranking_getanalisebase(decimal, bool, string, string, List<VarsVO>, bool)

[WebMethod]
public PHCResult analiseranking_getanalisebase(decimal qualanalise, bool lRecalc, string cTabela, string cStamp, List<VarsVO> cVars, bool paraGrafico)

Parameters

Nome Tipo Descrição
qualanalise decimal
lRecalc bool
cTabela string
cStamp string
cVars List<VarsVO>
paraGrafico bool

Returns

PHCResult

analisesporuser(bool, string, string)

Gets the list of analysis

[WebMethod]
public PHCResult analisesporuser(bool lRecalc, string cTabela, string cStamp)

Parameters

Nome Tipo Descrição
lRecalc bool

If true, the result is calculated, otherwise is retrieved from the cache if it's already there.

cTabela string

Identifier the table, when it's an analysys from a specific record, it's the record table

cStamp string

Identifies the record, when it's an analysis for a specific record

Returns

PHCResult

PHCResult containing the FusqlVO request or error messages produced by this query process.

analisesporuseruma(decimal, bool, string, string, List<VarsVO>, string, string)

Executes an normal analysis

[WebMethod]
public PHCResult analisesporuseruma(decimal qualanalise, bool lRecalc, string cTabela, string cStamp, List<VarsVO> cVars, string cStamp2, string cColuna)

Parameters

Nome Tipo Descrição
qualanalise decimal

Analysis fusqlid

lRecalc bool

Recalculates again without using cache. TODO: Remove

cTabela string

Entity name of the record we want to execute the analysis for. TODO: Remove

cStamp string

Record stamp

cVars List<VarsVO>

Analysis parameters needed for the execution

cStamp2 string

Identifier of the record clicked to show his sub-analysis. Should be the "stamp" property of that record

cColuna string

Clicked column index. TODO: Remove

Returns

PHCResult

comparacaoanual_getanalisebase(decimal, bool, string, string, List<VarsVO>)

Executes an annual comparison analysis

[WebMethod]
public PHCResult comparacaoanual_getanalisebase(decimal qualanalise, bool lRecalc, string cTabela, string cStamp, List<VarsVO> cVars)

Parameters

Nome Tipo Descrição
qualanalise decimal

Analysis fusqlid

lRecalc bool

Recalculates again without using cache. TODO: Remove

cTabela string

Entity name of the record we want to execute the analysis for.

cStamp string

Record stamp

cVars List<VarsVO>

Analysis parameters needed for the execution

Returns

PHCResult

emailExportAnalysisRecords(EmailExportAnalysisVO)

Send an analysis file exportation to e-mail

[WebMethod]
public PHCResult emailExportAnalysisRecords(EmailExportAnalysisVO emailExportAnalysisVO)

Parameters

Nome Tipo Descrição
emailExportAnalysisVO EmailExportAnalysisVO

In this parameter we have the necessary info to execute and send to e-mail the analysis

Returns

PHCResult

exportAnalysisRecords(ExportAnalysisVO)

Export an analysis to file

[WebMethod]
public PHCResult exportAnalysisRecords(ExportAnalysisVO exportAnalysis)

Parameters

Nome Tipo Descrição
exportAnalysis ExportAnalysisVO

In this parameter we have the necessary info to execute and export the analysis

Returns

PHCResult

getAllSnapshots(string)

[WebMethod]
public PHCResult getAllSnapshots(string searchTerm)

Parameters

Nome Tipo Descrição
searchTerm string

Returns

PHCResult

getAnalysis(string, string)

Get an analysis and the parameters/variables all at once

[WebMethod]
public PHCResult getAnalysis(string fusqlstamp, string recordstamp)

Parameters

Nome Tipo Descrição
fusqlstamp string

Identifies de Analysis we want to retrieve

recordstamp string

Returns

PHCResult

getChart(int, List<KeyValueVO>)

Get a snapshot of an analysis

[WebMethod]
public PHCResult getChart(int id, List<KeyValueVO> parameters)

Parameters

Nome Tipo Descrição
id int
parameters List<KeyValueVO>

Returns

PHCResult

getCharts(List<HomeAnalyticVO>)

Get a list of calculated analysis

[WebMethod]
public PHCResult getCharts(List<HomeAnalyticVO> listChartsConfig)

Parameters

Nome Tipo Descrição
listChartsConfig List<HomeAnalyticVO>

Returns

PHCResult

getScreenSnapshots(string)

Get a list of calculated snapshots

[WebMethod]
public PHCResult getScreenSnapshots(string entity)

Parameters

Nome Tipo Descrição
entity string

Returns

PHCResult

getSnapshot(string, bool, string)

Get a snapshot of a specific analysis

[WebMethod]
public PHCResult getSnapshot(string stamp, bool recalc, string recordstamp)

Parameters

Nome Tipo Descrição
stamp string
recalc bool
recordstamp string

Returns

PHCResult

getSnapshotsRecalc(bool)

[WebMethod]
public PHCResult getSnapshotsRecalc(bool lRecalc)

Parameters

Nome Tipo Descrição
lRecalc bool

Returns

PHCResult

getanalise(decimal, string, string)

Get an analysis

[WebMethod]
public PHCResult getanalise(decimal qualanalise, string cTabela, string cStamp)

Parameters

Nome Tipo Descrição
qualanalise decimal

Analysis identifier

cTabela string

TODO: Este parâmetro já não é utilizado, remover

cStamp string

Returns

PHCResult

getvariaveis(decimal)

[WebMethod]
public PHCResult getvariaveis(decimal qualanalise)

Parameters

Nome Tipo Descrição
qualanalise decimal

Returns

PHCResult

hasAccessToSnapshot(string)

Get a list of calculated snapshots

[WebMethod]
public PHCResult hasAccessToSnapshot(string stamp)

Parameters

Nome Tipo Descrição
stamp string

Returns

PHCResult

loadSnapshotByEntity(string, string, bool)

Get all snapshots by Entity

[WebMethod]
public PHCResult loadSnapshotByEntity(string entity, string recordStamp, bool byRecord)

Parameters

Nome Tipo Descrição
entity string
recordStamp string
byRecord bool

Returns

PHCResult

pedirSnapshot(string, bool)

[WebMethod]
public PHCResult pedirSnapshot(string stamp, bool lrecalc)

Parameters

Nome Tipo Descrição
stamp string
lrecalc bool

Returns

PHCResult

sendEmail(string, string, string, string, string, string, string, bool)

[WebMethod]
public PHCResult sendEmail(string companylabel, string efrom, string eto, string ecc, string ebcc, string esubject, string ebody, bool ehtml)

Parameters

Nome Tipo Descrição
companylabel string
efrom string
eto string
ecc string
ebcc string
esubject string
ebody string
ehtml bool

Returns

PHCResult

simularSnapshot(decimal)

[WebMethod]
public PHCResult simularSnapshot(decimal qualanalise)

Parameters

Nome Tipo Descrição
qualanalise decimal

Returns

PHCResult

subanalises(int, string, string)

[WebMethod]
public PHCResult subanalises(int qualanalise, string cTabela, string cStamp)

Parameters

Nome Tipo Descrição
qualanalise int
cTabela string
cStamp string

Returns

PHCResult