Create Connection (ivnCreateConnection)

§

This web service invoked to create the connection to the reporting data source in Intelliview NXT.

§

User requires “Admin” privilege (User parameter in ivnInitialize) for the execution of this API.

 Web Service Request:

public string ivnCreateConnection(string SessionToken, int CompanyID, string ConnectionName, string ConnectionType, string DatabaseServer, int DatabasePort, string DatabaseName, string DatabaseUser, string DatabasePassword, string AuthenticationMethod)

Web Service Request Parameters:

Parameters

Data
Type

Description

Remarks

SessionToken

String

The unique Identification assigned for the
Intelliview NXT Session

 

Company ID

Integer

The unique Identification assigned to the
Company by Intelliview NXT.

 

ConnectionName

String

Connection Name (Maximum Length = 200)

 

ConnectionType

String

Connection Type

 
 
 
 

Valid Values:

  •  

MS SQL

  •  

ORACLE

  •  

DB2

  •  

MYSQL
MYSQLConnector

DatabaseServer

String

Database Server (Maximum Length = 200)

 

DatabasePort

Integer

Database Port

 

DatabaseName

String

Database Name (Maximum Length = 200)

 

DatabaseUser

String

Database User ID (Maximum Length = 200)

 

DatabasePassword

String

Database User Password (Maximum
Length = 250)

 

AuthenticationMethod

String

Authentication Method (Maximum Length =
500). Default value: Null

This parameter is only
applicable for DB2
database. Valid
Values for DB2:

'Server'
'Client'
'Server Encrypt'
'Data Encrypt'
'DataEncryptcmp'

Web Service Response (Success):

<ResponseMessage>

<Message ID='SYN_REP_INFO_7552'/>

<Response Message= 'Connection creation is successful'/>

<Connection ID='6'/>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Response (Error):

<ResponseMessage>

<Message ID='SYN_REP_ERROR_7511'/>

<Response Message= 'Company ID is not valid'/>

<Company ID='23'/>

<Version No='1.3.1.1'/>

</ResponseMessage>

Web Service Return Parameters:

Parameters

Data
Type

Description

Remarks

Message ID

String

The unique identification assigned to the
response message in Intelliview NXT.

 

ResponseMessage

String

The Response Message is received from
Intelliview NXT.

Only English
Language is
supported in the
current version.

Company ID

Integer

The unique Identification assigned to the
Company in Intelliview NXT.

 

Connection ID

Integer

The unique Identification assigned to the

Returned on

Connection in Intelliview NXT.

success;

Version No

String

The last digit after the third decimal point
indicates the web service version

 

Response Messages:

Srl.No.

Message ID

Message

1

SYN_REP_ERROR_5043

Invalid connection details

2

SYN_REP_ERROR_5044

Connection name already exists

3

SYN_REP_ERROR_5094

Unable to create Connection

4

SYN_REP_ERROR_5035

Exception has occurred. Contact your Administrator

5

SYN_REP_INFO_7552

Connection creation is successful

6

SYN_REP_ERROR_7501

Intelliview NXT session is expired or not initialized or
not valid

7

SYN_REP_ERROR_7511

Company ID is not valid

8

SYN_REP_ERROR_7512

Connection name is not valid

9

SYN_REP_ERROR_7513

Connection Type is not valid

10

SYN_REP_ERROR_7514

Database Server is not valid

11

SYN_REP_ERROR_7516

Database name is not valid

12

SYN_REP_ERROR_7517

Database user is not valid

13

SYN_REP_ERROR_7518

Database password is not valid

14

SYN_REP_ERROR_7559

Authentication Method is not valid

 

top.jpg

 

Update Connection Details (ivnUpdateConnection) >>