WMConnect

The WMConnect call informs the WFM Engine that other commands will be originating from this source. It allows the connection of external application with the WFM Engine for this series of interactions. You can view the XML input and output parameters which have to be passed in order to establish connection. There is a list of errors and warning that can occur if connection fails.

 

Input Parameter description

 View sample InputXML  

Output Parameter description

 View sample OutputXML

Errors and Warnings

View Sample code

 

 

Input Parameter description

* implies for the mandatory parameter.

Name

Parent Tag

Description

Valid Value

Option *

Root

It refers to the case sensitive call name.

Call Name which is case sensitive

EngineName *

Root

It is the cabinet or database name which has to be  connected.

NA

Name *  

Participant

It is the user name for the cabinet connection.

NA

Password *

Participant

It is the user password for cabinet connection.

NA

Scope  

Participant

It is the scope of the user which is going to login. Either it is for Administration purpose or client base activities.

Admin or Otherwise

ParticipantType

Root

It is the type of user which is going to login.

U-User,

P-Process Server,

C-Configuration Server

UserExist

Root

It specifies whether to login forcefully if the same user is already logged-in.

Y/N

Y-Login forcefully

N-Do not login forcefully

 

 

Output Parameter description

Name

Parent Tag 

Description

Option

Root

It refers to the case sensitive call name.

MainCode

Exception

Error code specified by WAPI.

SessionId

Participant

It refers to the session id provided after the successful connection with the specified cabinet.

ID

Participant

It is the User Id which has established the connection

 

  

Errors and Warnings

Code

Constant Value

Message

1

WM_CONNECT_FAILED

Connect Failed.