Contents

User Management Interface overview About the User Management Interface software Architecture Deployment Scalability Security Installation Prerequisite checks The InForm integration user Installing the User Management Interface software Verifying the installation Provisioning service that is hosted behind an F5 load balancer Uninstalling the User Management Interface software Silent mode Silent installation Default setup.iss file Silent uninstallation Changing the HTTP and HTTPS port numbers If the InForm software is reinstalled on a system with the User Management Interface Deployment Deployment types Default deployment Load balanced deployment LAN access deployment Choosing the deployment type Study registration Study request restrictions Programming model and conventions How requests are processed Changing the processing mode Writing requests WSDL SOAP header Example: SOAP header Increasing the allowable time difference between client and server Identifier sets Example: Identifier sets Best practices Choosing whether to get identifier sets when putting data Associating new users with a rights group Improving provisioning performance Example: Associating a user with multiple sites Configuring settings to improve performance for large operations Secure development Transport layer protection Web service authentication Study authorization SQL injections XML injections Operations AddUsersToSite Example: AddUsersToSite CookMedML Example: CookMedML GetIdentifierSetList Example: GetIdentifierSetList GetInFormVersion Example: GetInFormVersion GetLatestStudyVersion Example: GetLatestStudyVersion GetProvisioningVersion Example: GetProvisioningVersion GetStudyVersions Example: GetStudyVersions GetUserDetails Example: GetUserDetails GetUserNames Example: GetUserNames GetUserNamesByType Example: GetUserNamesByType GetUserSites Example: GetUserSites PutProvisioningData Example: PutProvisioningData PutProvisioningDataAndGetIdentifierSets Example: PutProvisioningDataAndGetIdentifierSets PutUserImageProvisioningData Example: PutUserImageProvisioningData RemoveAllUsersFromGroups Example: RemoveAllUsersFromGroups RemoveUsersFromGroups Example: RemoveUsersFromGroups UpdateSiteNameAndMnemonic Example: UpdateSiteNameAndMnemonic VerifyPassword Example: VerifyPassword Use Cases Users Creating users Updating users Changing passwords Resetting passwords Verifying passwords Changing the state of a user Retrieving user names Retrieving user identifier information Retrieving user attribute information Insert an image for a user Sites Creating sites Updating sites Changing the site name and mnemonic of an existing site Adding users to a site Getting a list of users and adding them to a site Removing users from a site Removing all users from a site Changing the site study version Retrieving site information Rights groups Creating a rights group Updating a rights group Changing a users rights group Removing a user from a rights group Retrieving group identifier information Query groups Creating a query group Updating a query group Changing a users query group Removing a user from a query group Signature groups Associating a user with a signature group Removing a user from a signature group Reporting groups Creating a reporting group Updating a reporting group Adding a user to a reporting group Removing a user from a reporting group Study versions Retrieving study versions Error handling About error handling HTTP errors SOAP errors Examples: SOAP errors Troubleshooting Processing the study Enable WSDL MedML restrictions Oracle listener refuses connections or unavailable