intouch v2.2.3 guide - m.adaptondemand.com...the intouch web service can communicate with multiple...
TRANSCRIPT
inTouch v2.2.3
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Version: 1.2 Date: September 2015 Authors: C.Dewar-English, A.Taperek
Information and installation pack
inTouch v2.2
Features are dependent on Adapt version and inTouch service version. See the Compatibility Chart (Appendix III) for further details.
Main Features • Fully connected with live data • Configurable searches tailored to your
requirements • Configurable record views • Integrates with Email and Phone
functions • View Tasks, Diary and Journal • Run Workflow • Document Library access • Favourites synchronised with Adapt
New in v2.2 • Full support for Android, Windows Phone,
Blackberry etc. via the mobile web service • Improved and simplified server installation • inTouch system configuration console (for easy
system setup) • Various bug fixes and enhancements
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
inTouch components
Device (App or mobile web browser) Native iOS app for iPhone/iPod Touch/iPad Mobile web site for modern smartphones Communicates with inTouch Web Service
Web Service Running in IIS 6 or later Communicates with Devices Communicates with inTouch Data Service
Data Service Standard Windows Service Communicates with inTouch Web Service Communicates with Adapt via the V11 Web Services
Quick setup
Quick setup
inTouch is comprised of three components - the mobile device and two inTouch services
1
2
3
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
DevicesinTouch
Web ServiceinTouch
Data Service
Standard
Multiple AdaptSystems
e.g. OnDemand
Load BalancedWeb Servers
One Web Server, multiple Data
Servers
Adapt
The inTouch Web Service can communicate with multiple inTouch Data Services on different servers
The inTouch Data Service can communicate with multiple Adapt Systems on different servers
Flexible configurationsThe inTouch services can be installed in various configurations depending on architecture and individual requirements.
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
InstallationThis inTouch v2.2 setup guide is for use with inTouch with Adapt v11 only.
Adapt v9 requires the inTouch v2.1 services (with Adapt Net Tools). See the inTouch v2.1 installation guide for further details.
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Prerequisites
1. A working Adapt v11 system • 11.7 / 9.1
• or 11.6.8 SP6 or higher (with supplemental Business Objects for workflow, available from:
https://m.adaptondemand.com/intouch/resources/)
2. A Windows server which can connect to Adapt to host the Data Service (Can be the existing Adapt application server)
• Windows Server 2003 R2 or later
• .NET framework 4.0 or later
3. A web server which can connect to the Adapt Data Service • Windows Server 2003 R2 or later
• .NET framework 4.0 or later
• IIS 6.0 or later
• TLS/SSL certificate
inTouch requires the following components:
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 1. Data Service Installation
1. Download the latest release of the Data Service Installer from:
https://m.adaptondemand.com/intouch/resources/
There is both a 32 and 64-bit version of the Data Services. Make sure you install the correct version for the platform your server is using. See Appendix I for details
2. Run the Windows Installer package (.msi)
3. Specify the install location
4. Specify a communication port (e.g. 9009) - ensure the firewall allows incoming connections
from the web server to this port.
5. Complete the installation
6. Check the service is running: Bond Mobile Data Access Service (v2.2)
Check the Windows Event Viewer (Application Log) for additional details.
All steps complete
4
6
3
Install the inTouch data service on any machine on the Adapt network
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 2. Web Service Installation
1. Download the latest release of the Web Service Installer from:
https://m.adaptondemand.com/intouch/resources/
There is both a 32 and 64-bit version of the Web Services. Make sure you install the correct version for the platform your server is using. See Appendix I for details.
2. Run the Windows Installer package (.msi)
3. Specify the install location
4. Choose the platform type which IIS is running under (32-bit or 64-bit), this may be different to the
computer’s actual architecture.
3
4
Install the inTouch web service on a secure Web Server running IIS 6 or 7
Continued...
If you are installing the 32-bit version of the web services, the page shown to the right does not appear during the installation and 32-bit is automatically selected.
(See Appendix II for additional details on determining the platform for the IIS application pool)
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 2. Web Service Installation
5. Specify whether the web service will be accessed over HTTPS (recommended) or HTTP
HTTPS Secure connections will require a TLS/SSL certificate which can be obtained from a Certificate Authority (CA)
http://en.wikipedia.org/wiki/Certificate_authority
6. Specify the external web address.
i.e. the full URL including Domain name
7. Create the web service management console user
Specify a secure password (you will use this username and password later)
8. Complete the installation
5
6
7
(continued)
All steps complete
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 3a. IIS 7 configuration
1. Launch IIS Manager
2. Right-click the folder where you installed the web services
3. Choose Convert to Application
4. Click OK
5. Complete any other non-Adapt IIS tasks, such as installing a TLS certificate
6. Complete any other non-Adapt IIS tasks, such as installing a TLS certificate. The server must have
the correct .NET framework installed, as well as the .svc ASAPI filters and HTTP-activation components
(installed via Control Panel’s Add Windows features options)
2
3
The following steps apply only if you are using IIS 7.
All steps complete
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 3b. IIS 6 configuration1. Launch IIS Manager
2. View the properties for the folder where you installed the web services
3. Click Create to convert to an application
4. Click Configuration...
5. In the upper section, Edit the Application Extension for “.aspx”
6. Ensure the Executable is set to:
C:\WINDOWS\microsoft.net\Framework\v4.0.30319\aspnet_isapi.dll
Click OK
7. In the lower section, Insert a Wildcard Application Map:
8. Set the Executable to:
C:\WINDOWS\microsoft.net\Framework\v4.0.30319\aspnet_isapi.dll
Un-Check Verify that file exists
Click OK
9. Click OK
10. Complete any other non-Adapt IIS tasks, such as installing a TLS certificate. The server must have
the correct .NET framework installed, as well as the .svc ASAPI filters and HTTP-activation
components (installed via Control Panel’s Add Windows features options)
34
57
6
8
The following steps apply only if you are using IIS 6.
All steps complete
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 4. Adapt Setup
1. Log into Adapt V11 SysAdmin
2. Edit the WebUser profile
3. Under the WebServices section ensure Metadata access is ticked.
4. Create a new user used for inTouch background processes (This is to allow codes,
config and roles retrieval)
5. Assign the new user to the WebUser Profile
All steps complete
3
5
2
4
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 5. System setup
1. Navigate to the website’s /console page
e.g. https://abcrecruit.co.uk/bondmobilewebservices/console
2. Login with the credentials you created during the web service installation
Note: Login credentials are not necessary when logging in directly on the webserver via localhost i.e. https://localhost/bondmobilewebservices/console
3. Click Create new system...
4. Provide a system name (this will be used on devices when connecting to inTouch)
5. Enter the connection details for inTouch data service
• IP address or network/machine name
• Port number (as specified when installing the Data Service)
6. Enter the details for the Adapt V11 server
• Adapt Server
• Adapt Domain
• The Domain Profile which users will log in with (which allows Adapt web services access)
7. Provide the details for the inTouch background user (see previous page) and specify a locale (click
Refresh to populate the list)
8. Click Create system
Use the inTouch console web page to specify the Adapt system and inTouch data service details.
4
5
6
7
8
All steps complete
2
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 6. Publish Configuration
1. Install the Bond Mobile Configuration Tool on any PC on your network
2. Run the tool
3. Click File -> New -> Project...
4. Select inTouch V11 Config from the templates list
5. Provide a new project name and click OK
6. When the Project Settings page appears, enter the Web Address and the System Name
7. Click Test
8. A dialog box will appear to confirm the settings are valid and the system is online. Click OK
The Mobile Configuration, which defines how the records, searches and workflow appears on a device, is created, edited and published via the Bond Mobile Configuration Tool.
4
5
67
Continued...
8
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 6. Publish Configuration
9. Click Publish
10. Click Yes to confirm you wish to publish to the server
11. Click Yes to refresh the project cache
12. Enter the credentials for an Adapt V11 user with configuration rights and click OK
13. The configuration will be published
14. Close the Bond Mobile Configuration Tool
11
(continued)
All steps complete
10
9
12
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
12
Step 6a. Connect with the inTouch iOS app
Create a new connection to the inTouch web service
1. Tap ‘+’ to add a new system connection
2. Fill out the details of the inTouch system
• Web Server URL e.g. https://abcrecruit.com/BondMobileWebServices
• System Name
3. Tap Create
4. The server will respond and a new connection to the specific system will be created for the app
5. Tap Accept or Decline the Quality Control message
1
2
3
5
All steps complete
Download and launch the inTouch App from the App Store
Alternatively new users with the iOS app can be sent an email to their device from the system administrator with a customised hyperlink. When the user clicks the link the app will launch (if installed) and the new connection details screen will automatically load with the web server URL and system name pre-filled.
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 6b. Login via the inTouch iOS app
1. Tap the system name
2. Enter the credentials for an Adapt user (with domain profile access to web services)
3. Tap Go on the keyboard
4. A ‘New config update’ dialog will appear whenever the app’s local copy of the configuration data is
missing or out-of-date.
• Tap Update to download the latest published configuration data
5. The login will complete
1
4
All steps complete
Once a connection has been created, use it to login to Adapt
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Step 6c. Logging in via a web browser
1.Launch a web browser
2.Enter the Web Server URL in the browser’s address bar
e.g. https://abcrecruit.com/BondMobileWebServices
3.Select the Adapt system from the drop-down list
4.Enter the credentials for an Adapt user (with domain profile access to web services)
5.Tap Log on
6.The login will complete
inTouch also works on most modern smartphone web browsers
• Android • Windows Phone • Blackberry • PC or Mac desktop web browsers
ABCRecruitment
All steps complete
3
4
5
Alternatively new users can be sent an email to their device from the system administrator with a
customised hyperlink with the system name and username pre-filled.
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Appendix I - Checking your computer’s platform
Windows XP or Windows Server 2003:
1. Open Control Panel
2. Double click on System
3. Under the System section, if x64 Edition is displayed then it is a 64-bit platform. If it does
not display this then it is a 32-bit platform:
Windows 7 or Windows 8:
1. Open Control Panel,
2. Click on System and Security, then click System
3. The platform type will appear in the System section, next to the System type label.
If the operating system is 64 bit then you should use the x64 version of the installer.
If it is 32-bit then you should use the x86 version.
You can check your computer’s platform by following these steps:
The inTouch services have both 64-bit and 32-bit installers. Check your platform to determine which version should be installed.
64-bit
Not 64-bit
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Appendix II - Checking IIS Application Pool platform setting
IIS 6 (Windows XP and Windows 2003)
On IIS 6, all application pools run in either 32-bit or 64-bit mode.
1. Open IIS Manager
2. Expand the server details, and click Web Service Extensions
3. Look for the ASP.NET v4.0.30319 item with a status of Allowed. In brackets it will display 32-
bit or 64-bit. This is the platform type you will need to select in the installation.
IIS 7+ (Windows 7 and later)
On IIS7 and later, it is possible to run some application pools in 32-bit mode and others in 64-bit mode.
1. Open IIS Manager
2. Expand the computer name and click Application Pools
3. Select the application pool that the inTouch Web Services will be using, and click Advanced Settings
If Enable 32-Bit Applications is set to True, the application pool will be running in 32-bit mode,
and this should be selected in the web service installer.
If Enabled 32-Bit Applications is set to False, the application pool will be running in 64-bit
mode, and this should be selected in the web service installer.
To determine the platform for the IIS application pool, follow these steps:
2
3
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Appendix IIa - Manually changing the IIS Platform TypeIf you select the wrong platform type during the Web Service installation, you will receive errors when you attempt to use the inTouch web client or iOS application.
A. There will be a Warning event in the web server’s Event
Log (Application Log) for ASP.NET 4.0.30319.0
B. The exception type is BadImageFormatException
A
To resolve the issue, follow these steps on the web server:
1. Open Windows Explorer
2. Navigate to the installation location for the web services, and go to the bin
folder
3. Delete the SQLite.Interop.dll file
4. Open the x64 subfolder if you require the 64-bit version, or x86 subfolder if
you require the 32-bit version, and copy the SQLite.Interop.dll file
5. Go back to the bin folder and paste the file
B
2
3
4
The problem is now resolved and the errors will no longer appear.
It is not necessary to restart IIS or the web server for the change to take effect.
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Appendix III - Compatibility chartThe following two charts show the version compatibility of the inTouch components (data service, web service and iOS app) with Adapt v11 and Adapt v9.
The recommended versions of the inTouch components are shown in red.
The iOS app is designed to be backwards compatible with all previous versions of the inTouch services. The latest version in the app store is recommended at all times.
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Web Service
Data Service
iOS app
Recommended versionKey
inTouch for Adapt v11
Older version
inTouch for Adapt v9
Aug ’11 Dec ’12 Mar ’13Aug ’11 Aug ’13May ’11 July ’12Sept ’11
v1.2.2 v2.0v1.1 v2.1 v2.2v1.2v1.0 v1.2.1
v1.2.2 v2.0v1.1 v2.1 v2.2v1.2v1.0 v1.2.1
v1.2.2 v2.0v1.1 v2.1 v2.2v1.2v1.0 v1.2.1
Web Service
Data Service
iOS app
v1.2.2 v2.0v1.1 v2.1v1.2v1.0 v1.2.1
v1.2.2v1.1 v1.2v1.0 v1.2.1
v1.2.2 v2.0v1.1 v2.1v1.2v1.0 v1.2.1
Apr ’14 Nov ‘14 Sept ‘15
v2.2.1 v2.2.2 v2.2.3
v2.2.1 v2.2.2 v2.2.3
v2.2.1 v2.2.2 v2.2.3
v2.2.1 v2.2.2 v2.2.3v2.2
Appendix IV - inTouch version historyThe following shows the features and changes in each version of inTouch
Search and Find • Configurable searches tailored to your requirements. • Fully connected, live data. • Search results formatted to your requirements. Data access • Configurable record views. • Direct access to phone numbers and email addresses • Integrates with Email and Phone functions.
Tasks •View tasks and diary •View calendar for meetings, appointments etc. Activity •Access up-to-date journal activity. •View consultant notes
v2.0
v1.2.1
v1.2.2
v1.0
v2.1
v2.2
• Multiple language support • Updated registration process
• Direct connection to server • No pre-registration keys
• Multiple UI enhancements • Stability and performance improvements
• Use shorter registration keys
• Simplified registration Process • Direct Record Lookups • Improved stability, security and UI • Improved diary and tasks • Various bug fixes and minor enhancements
• Run Workflow (Adapt V11 only) • Document Library access (Adapt V11 only) • Favourites sychronised with Adapt (Adapt V11 only) • UI updates
• Expandable notes in Journal, Tasks and Diary • Improved graphics • iPhone 5 compatibility
• User settings • Diary, Tasks and Journal default days to show • Document cache size
• Full support for Android, Windows Phone, Blackberry etc via the mobile web service
• Improved and simplified server installation • inTouch system configuration console (for easy system
setup) • Various bug fixes and enhancements
• Dynamic Code updates • Encrypted trafficv1.1
v1.2 • Enable cross-references • Stability and UI improvements
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
v2.2.1
v2.2.2
v2.2.3
• Multiple UI enhancements • Faster favourites
• Fix for when users click a hyperlink to launch inTouch with the details of a new connection
• Updated screenshots gallery • Support for iOS8
• Support for iOS9 • Fix issue with dates in Journals • 64-bit support
inTouch communications overviewAppendix V
The following pages provide a general overview of the communication stages between the iOS app and the inTouch web service
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
iOS app connection creation sequence
inTouch Web Server
User submits Web Server URL & System
Name
System name sent to web server URL Anonymous login request Check system name
Success (System name is found)
System not found... Ask user to try again
Success... Create connection entry on main
screen (Store URL and System Name)
Show Quality Assurance message
Ready to login....
Failure Unknown system name (Error 340)
iPhone
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Repe
at
iOS app login sequence with no valid local configuration data on device
inTouch server version higher than app?
iPhoneinTouch
Web ServerAnonymous login (no user credentials)
Server Version + Supported Features List + Language pack info
Check Config and Codes versions
Send user’s credentials + System NameSend current CONFIG Version and CODES Version
Config mismatch (ERROR 7)
Config needs updating
Read config from Web Server’s cache / retrieve latest config from
inTouch Data ServiceRequest Config (GetConfigSecure)
Send Config DataReceive config data
Update Config Version number
User submits Username and Password
System name + current language pack Anonymous login request Find system details
Requires upgrade via AppStore, otherwise continue...
• First time logging-in • or Configuration data has changed and been republished since the user last connected (new screens,
new workflow etc)
• or User has deleted the local config cache
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Repe
at
iOS app login sequence with valid configuration data, but no valid codes data
inTouch server version higher than app?
User submits Username and Password
Anonymous login (no user credentials)System name + current language pack
Send user’s credentials + System NameSend current CONFIG Version and CODES Version
CODES mismatch (ERROR 8) + List of Code Group hash values
Codes need updating Check server’s code group hash
values with local hash codes.
Read Code Group data from Web Server’s cache / retrieve
latest Codes data from inTouch Data Service
Automatically respond. Request Codes for specific out-of-date Code Groups
Send Codes Data for requested Code Groups
Receive Codes data Store Codes and CodeGroup
hash values Store Codes Version number
Check Config and Codes versions
Server Version + Supported Features List + Language pack info
Anonymous login request Find system details
Requires upgrade via AppStore, otherwise continue...
• First time logging-in (after the configuration data has been updated)
• or Codes have been updated/changed on the server
• or User has deleted the local config cache
iPhoneinTouch
Web Server
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
iOS app login sequence with valid configuration data and codes data• Normal day-to-day behaviour
• or after configuration and/or codes have been updated from a previous login attempt
User submits Username and Password
Anonymous login (no user credentials)
inTouch server version higher than app?
System name + current language pack
Send user’s credentials + System NameSend current CONFIG Version and CODES Version
Config and Codes versions are good
Ready to use...
Check Config and Codes versions
Login Successful
Anonymous login request Check system name
Server Version + Supported Features List + Language pack infoRequires upgrade via
iPhoneinTouch
Web Server
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3
Appendix VI - Login shortcuts / hyperlinksUsers can be provided with hyperlinks to get them connected quickly and easily
•Standard address https://<WebServer URL>/<Web service>
e.g. https://ABCRecruit.co.uk/BondMobileWebServices/ •To pre-fill system name, use /LogOn/<SystemName>
https://<WebServer URL>/<Web service>/LogOn/<SystemName>
e.g. https://ABCRecruit.co.uk/BondMobileWebServices/LogOn/ABCRecruit •To pre-fill system name and username use /LogOn/<SystemName>/<Username>
https://<WebServer URL>/<Web service>/LogOn/<SystemName>/<Username>
e.g. https://ABCRecruit.co.uk/BondMobileWebServices/LogOn/ABCRecruit/joebloggs
inTouch Mobile web browser login screen shortcuts
inTouch iOS app new connectionNew users with the iOS app can be sent an email to their device from the system administrator with a customised
hyperlink. When the user clicks the link the app will launch (if installed) and the new connection details screen will
automatically load with the web server URL and system name pre-filled.
https://<WebServer URL>/<Web service>Redirect.svc/newsystem?name=<System Name>&desc=<System Description>
e.g. https://ABCRecruit.co.uk/BondMobileWebServices/Redirect.svc/
newsystem?name=ABCRecruit&desc=ABC%20Recruit%20System
ABCRecruit
jbloggs
www.bondadapt.comCopyright 2015 - Bond International Software
v2.2.3