This Standard Operating Procedure (SOP) describes how website should use and manage sessionId for interactions with IP1 web services. It also outlines how the website can identify if IP1 is active.

IP1 sessions and the sessionId in particular are required for almost all other web services to work. The website should have logic in place to establish:

If a session exists, continue using that session OR
Create a new session

The web application is required to store this session ID, until it has expired (refer Session Time Out Length below).

Setup

Session Time Out Length

Session time out lengths can be configured. Eg. A typical length may be 10 to 30 minutes.

This can be configured on the web server. Look for similar folder/file path as below:

C:\IBSAPP\AppServer85\profiles\UAT\installedApps\WebNoteAddress\IBSECommerce.ear\IBSECommerceWebServiceWeb.war\WEB-INF\web.xml

Procedure

It is your responsibility to ensure that you understand this procedure before performing the following tasks.

Note	Deviations from this procedure should be covered by procedures written by your company. Before performing any tasks please ensure all the business rules are set-up accordingly.

Process
Website page loads. If sessionId variable does not exist, website executes createSession to create a session. If sessionId variable does exist, website executes checkSession to establish if session is still valid. If isActive variable from checkSession returns false, website executes createSession. If sessionId variable still doesn’t exist, the website can execute GetBookmasterStatus to check if IP1 is active. The website may display a ‘temporarily unavailable’ message or limit functionality to offline view of data held on the web site if this web service indicates IP1 is not active Notes: createSession requires different input depending on anonymous or registered use: For anoymous use, set loginType = A For registered use, set loginType = L. For futher details on registed login, refer Logging In and Out – Single Account Logging In and Out – Multiple Accounts Where multiple web sites exist, the website will also need to pass relevant siteCode field setting so that IP1 uses appropriate configurations/defaults for that specific web site.

Process

Website page loads.
If sessionId variable does not exist, website executes createSession to create a session.
If sessionId variable does exist, website executes checkSession to establish if session is still valid.
If isActive variable from checkSession returns false, website executes createSession.
If sessionId variable still doesn’t exist, the website can execute GetBookmasterStatus to check if IP1 is active.

1. The website may display a ‘temporarily unavailable’ message or limit functionality to offline view of data held on the web site if this web service indicates IP1 is not active

Notes:

createSession requires different input depending on anonymous or registered use:
- For anoymous use, set loginType = A
- For registered use, set loginType = L.
  - For futher details on registed login, refer
  - Logging In and Out – Single Account
  - Logging In and Out – Multiple Accounts
Where multiple web sites exist, the website will also need to pass relevant siteCode field setting so that IP1 uses appropriate configurations/defaults for that specific web site.