Installing OneSpan Sign Embedded Integration for Microsoft SharePoint

OneSpan Sign also has an out-of-the-box Integration Platform that allows you to use a single solution to connect eSignatures to your favorite business applications in an easy, secure, and cost-efficient way. For more information, see OneSpan Sign With SharePoint.

Not all OneSpan Sign features are supported by an integration with this Connector. However, most if not all, features supported by this integration can be found in this Connector's documentation. For questions about a specific feature, please ask in our Forums. If a feature you're looking for is not supported, please let your sales contact know so that an official request can be made.

To install OneSpan Sign Embedded Integration for Microsoft SharePoint 2013 for the first time:

1. Create the required OneSpan Sign Web App by doing the following:

   1. Go to the Central Administration site.

   2. Select Manage Web Applications: (Application Management > Web applications),

   3. Select New.

   4. Create a new IIS website by specifying the following fields (then click OK):

      • Name: SharePoint – 80 (or any desired and available port)

      • Port: 80 (or any desired and available port)

      • Host Header: Use this Host Header for any domain or sub-domain name.

        Keep all other default settings.

        

2. Note the Web application URL and Site Collection URL where this solution package will be installed.

   

3. Create the required Site Collection by clicking Application Management > Site Collections. The following pages appear.

   

   

4. Note the Site Collection you have just created.

5. Add and install WSP as follows:

   1. Ensure that the WSP and the PowerShell script are in the same folder.

   2. Open SharePoint PowerShell in Console mode and in Administrator mode.

      

   3. Move to the directory where WSP resides.

   4. Execute the Deploy.ps1script by typing the following line:

      .\deploy.ps1

      If you cannot execute the deployment script, perform the steps in the link Cannot Execute the Deployment Script.

   5. Enter the Web Application URL where you want to deploy the solution.

      

   6. The deployment script should have installed two solution packages in the SharePoint Farm.

      

6. Go to General Application Settings in Central Admin, and configure the settings in Steps 7-11.

   

7. Click Database Settings under OneSpan Sign, select the correct web application, and complete the details in the Database Connection string as follows:

   Server={SERVER_NAME}; Database={DATABASE_NAME}; Trusted_Connection=True;

   Replace {SERVER_NAME} with the name of the server, and replace {DATABASE_NAME} with the name of the database created in Installing the Required Database.

   

8. Click API Settings, and select the correct web application. Then enter: (a) your unique API key; (b) the OneSpan Sign API URL below that applies to you:

   Your configuration settings depend on the URL you use to log in. If you are uncertain about which URL to use, please refer to the email you received when you signed up, and follow the link Log into your account. You will be directed to a login page, and your login URL will appear in your browser's address bar.

   • For new clients: (1) who have signed up for an OneSpan Sign Production account; (2) who are deploying to a US Production Environment; (3) whose login URL is https://apps.esignlive.com/login:

     • API URL:

       https://apps.esignlive.com/api

   • For new clients: (1) who have signed up for an OneSpan Sign Sandbox account; (2) who are deploying to a US Sandbox Environment; (3) whose login URL is https://sandbox.esignlive.com/login:

     • API URL:

       https://sandbox.esignlive.com/api

   • For existing clients: (1) who signed up for their OneSpan Sign Production account; (2) who are deploying to a US Production Environment; (3) whose login URL is https://apps.esignlive.com/login:

     • API URL:

       https://apps.eSignLive.com/api

   • For existing clients: (1) who signed up for their OneSpan Sign Sandbox account; (2) who are deploying to a US Sandbox Environment; (3) whose login URL is https://sandbox.OneSpan Sign.com/login:

     • API URL:

       https://sandbox.eSignLive.com/api

   • For Canadian customers: (1) who are deploying to a Canadian Production Environment; (2) whose login URL is https://apps.e-SignLive.ca/login:

     • API URL:

       https://apps.e-SignLive.ca/api

   • For Canadian customers: (1) who are deploying to a Canadian Sandbox Environment; (2) whose login URL is https://sandbox.e-SignLive.ca/login:

     • API URL:

       https://sandbox.e-SignLive.ca/api

   

9. Click Notification Settings under OneSpan Sign, select the correct web application, and complete the details in the settings as specified in the description. For example:

   {SITE}/PostEvent.svc/PostESLEvent

   Replace {SITE} with the URL specified in the last step of the procedure Installing the Push Notification Service.

   

10. Click Designer Settings under OneSpan Sign, select the correct web application, and specify the following settings:

    • For new clients: (1) who have signed up for an OneSpan Sign Production account; (2) who are deploying to a US Production Environment; (3) whose login URL is https://apps.esignlive.com/login:

      • Designer URL:

        https://apps.esignlive.com/auth?senderAuthenticationToken={0}&target=https://apps.esignlive.com/designer/{1}?profile=SharePoint2013

      • Signing URL:

        https://apps.esignlive.com/auth?signerAuthenticationToken={0}&target=https://apps.esignlive.com/packages/{1}/sign

    • For new clients: (1) who have signed up for an OneSpan Sign Sandbox account; (2) who are deploying to a US Sandbox Environment; (3) whose login URL is https://sandbox.esignlive.com/login:

      • Designer URL:

        https://sandbox.eSignLive.com/auth?senderAuthenticationToken={0}&target=https://sandbox.eSignLive.com/designer/{1}?profile=SharePoint2013

      • Signing URL:

        https://sandbox.eSignLive.com/auth?signerAuthenticationToken={0}&target=https://sandbox.eSignLive.com/packages/{1}/sign

    • For existing clients: (1) who signed up for their OneSpan Sign Production account; (2) who are deploying to a US Production Environment; (3) whose login URL is https://apps.esignlive.com/login:

      • Designer URL:

        https://apps.eSignLive.com/auth?senderAuthenticationToken={0}&target=https://apps.eSignLive.com/designer/{1}?profile=SharePoint2013

      • Signing URL:

        https://apps.eSignLive.com/auth?signerAuthenticationToken={0}&target=https://apps.eSignLive.com/packages/{1}/sign

    • For existing clients: (1) who signed up for their OneSpan Sign Sandbox account; (2) who are deploying to a US Sandbox Environment; (3) whose login URL is https://sandbox.eSignLive.com/login:

      • Designer URL:

        https://sandbox.eSignLive.com/auth?senderAuthenticationToken={0}&target=https://sandbox.eSignLive.com/designer/{1}?profile=SharePoint2013

      • Signing URL:

        https://sandbox.eSignLive.com/auth?signerAuthenticationToken={0}&target=https://sandbox.eSignLive.com/packages/{1}/sign

    • For Canadian customers: (1) who are deploying to a Canadian Production Environment; (2) whose login URL is https://apps.e-SignLive.ca/login:

      • Designer URL:

        https://apps.e-SignLive.ca/auth?senderAuthenticationToken={0}&target=https://apps.e-SignLive.ca/designer/{1}?profile=SharePoint2013

      • Signing URL:

        https://apps.e-SignLive.ca/auth?signerAuthenticationToken={0}&target=https://apps.e-SignLive.ca/packages/{1}/sign

    • For Canadian customers: (1) who are deploying to a Canadian Sandbox Environment; (2) whose login URL is https://sandbox.e-SignLive.ca/login:

      • Designer URL:

        https://sandbox.e-SignLive.ca/auth?senderAuthenticationToken={0}&target=https://sandbox.e-SignLive.ca/designer/{1}?profile=SharePoint2013

      • Signing URL:

        https://sandbox.e-SignLive.ca/auth?signerAuthenticationToken={0}&target=https://sandbox.e-SignLive.ca/packages/{1}/sign

    

11. Click Languages under OneSpan Sign, select the correct web application, and specify language settings using the following format (you can add multiple languages by separating successive languages by a semi-colon):

    English-en; Français-fr

    Also configure the following country parameters:

    1. In the Default Country field, specify the default country's international telephone code.

    2. In the Preferred Countries field, list the countries that you want to appear before others in the drop-down menu of the SMS Authentication Method.

    3. In the Countries to Exclude field, list the countries that you want to exclude from that drop-down menu.

    4. In the Only Include field, list the only countries that you want to appear in that drop-down menu.

       For information about international country codes, see: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.

       

12. Restart the related websites and application pools in IIS.

    If changes are ever made to the preceding settings in this procedure, the related websites and application pools in IIS must be restarted.

13. The OneSpan Sign Farm Feature should be activated by default. If it is not activated, activate it as shown below. Click System Settings, then Farm Features.

    

14. Click Central Admin > Monitoring > Timer Jobs > Review Jobs Definitions, and check if the OneSpan Sign timer job is successfully installed and configured.

    

15. Navigate to the web application where the solution has been installed, and do the following:

    1. Navigate to Site Actions > Site Settings > Site Collection Features.

       1. If the OneSpan Sign Site Collection Feature is not activated, click Activate.

       2. If it has been activated, click Deactivate, and then click Activate.  

    2. Navigate to Site Actions > Site Settings > Site Features.

       1. If the OneSpan Sign Site Feature is not activated, click Activate.

       2. If it has been activated, click Deactivate, and then click Activate.

          

16. Go to Site Actions > Site Permissions, and locate the group named as follows:

    {SITE_NAME} ESL Template Admins

    If a site is inheriting permissions from its parent, and the ESL feature is enabled on it, the ESL Template Admins group is created on its parent. Any user on the site who wants to be able to create a template should be added to this group. If this site is later changed to having unique permissions, a group called <Site Title> ESL Template Admins should be created manually on this site, and all template users should be added to this group.

    

17. If you want to add users who will work with OneSpan Sign templates, open this group.

    

18. Verify that the following OneSpan Sign ribbon appears on the site where OneSpan Sign has been activated.