Install Microsoft Planner Connector on Windows

To install the Microsoft Planner Connector on Windows, use the following procedure.

To install the Microsoft Planner Connector

  1. Run the Microsoft Planner Connector installation program.

    The installation wizard opens.

  2. Read the installation instructions and click Next.

    The License Agreement dialog box opens.

  3. Read the license agreement. If you agree to its terms, click I accept the agreement and click Next.

    The Installation Directory dialog box opens.

  4. Choose an installation folder for Microsoft Planner Connector and click Next.

    The Service Name dialog box opens.

  5. In the Service name box, type a name to use for the connector’s Windows service and click Next.

    The Service Port and ACI Port dialog box opens.

  6. Type the following information, and click Next.

    Service port The port used by the connector to listen for service actions.
    ACI port The port used by the connector to listen for actions.

    The License Server Configuration dialog box opens.

  7. Type the following information, and click Next.

    License server host The host name or IP address of your License server.
    License server port The ACI port of your License server.

    The IDOL database dialog box opens.

  1. In the IDOL Database box, type the name of the IDOL database that you want to index data into, and click Next.

    The Proxy Server dialog box opens.

  2. If you have installed the connector on a machine that is behind a proxy server, type the following information and then click Next.

    Proxy host The host name or IP address of the proxy server to use to access the repository.
    Proxy port The port of the proxy server to use to access the repository.
    Proxy username The user name to use to authenticate with the proxy server.
    Proxy password The password to use to authenticate with the proxy server.

    The OAuth Authentication Parameters dialog box opens.

  3. Type the following information and click Next.

    AppKey The application key that was provided by Microsoft when you set up an application to represent the connector.
    AppSecret The application key that was provided by Microsoft when you set up an application to represent the connector.
    RedirectUrl The URL at which the OAuth tool will run. For example, http://localhost:7878/oauth. Ensure this is the same as the URL you specified when you created the application to represent the connector.
  4. Choose whether to install a new CFS.

    • To install a new CFS, select the Install a new CFS check box and click Next.

      The Installation directory dialog box opens. Go to the next step.

    • To use an existing CFS, clear the Install a new CFS check box and click Next.

      The CFS dialog box opens. Type the Hostname and Port of your existing CFS. Click Next and go to step 16.

  1. Choose an installation folder for the Connector Framework Server and then click Next.

    The Installation name dialog box opens.

  2. In the Service name box, type a unique name for the Connector Framework service and click Next. The name must not contain any spaces.

    The CFS dialog box opens.

  3. Type the following information, and click Next.

    Service port

    The port used by CFS to listen for service actions.

    ACI port The port used by CFS to listen for actions.
  4. Type the following information and click Next.

    IDOL Server hostname The host name or IP address of the IDOL server that you want to index documents into.
    ACI port The ACI port of the IDOL server.

    The Pre-Installation Summary dialog box opens.

  5. Review the installation settings. If necessary, click Back to go back and change any settings. If you are satisfied with the settings, click Next.

    The connector is installed.

  1. Complete the installation procedure. You can run the OAuth tool, which obtains the access token necessary to retrieve information from Microsoft Planner.

    • To run the OAuth tool, select the Run OAuth tool check box, and click Next.

      Your default web browser opens to the web site, so that you can authorize the connector to access Microsoft Planner.

      After you authorize the connector, the OAuth tool obtains the access token from Microsoft Planner and creates a file named oauth.cfg, in the connector's installation folder. This file contains the token required by the connector to retrieve information from Microsoft Planner. The default configuration automatically uses the token to authenticate with Microsoft Planner because the parameters in oauth.cfg are included in the connector configuration (for information about how to include configuration parameters from other files, see Include an External Configuration File).

      You can now configure fetch tasks. For information about how to do this, see Use the Connector.

    • To finish installing the connector without running the OAuth tool, clear the Run OAuth tool check box, click Next, and then click Finish. For information about how to run the OAuth tool at a later time, see Configure OAuth Authentication.