Skip to Content

Microsoft Excel v2 connection

Introduction

A Microsoft Excel connection, created using the Microsoft Excel v2 connector, establishes access to Microsoft Excel. These activities, once configured, interact with Microsoft Excel through the connection.

Create or edit a Microsoft Excel connection

A new Microsoft Excel v2 connection is created using the Microsoft Excel v2 connector from one of these locations:

An existing Microsoft Excel v2 connection can be edited from these locations:

Configure a Microsoft Excel connection

Each user interface element of the Microsoft Excel v2 connection configuration screen is described below.

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Connection Name: Enter a name to use to identify the connection. The name must be unique for each Microsoft Excel v2 connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Microsoft Excel v2 endpoint, which refers to both a specific connection and its activities.

  • URI: Enter the URI.

  • Connection Type: Select the connection type, one of:

    • Auto

    • Local

      • Auth Scheme: Select the authorization scheme, one of:

        • None
    • Amazon S3

      • AWS Region: Select the AWS region, one of:

        • OHIO

        • NORTHERNVIRGINIA

        • NORTHERNCALIFORNIA

        • OREGON

        • CAPETOWN

        • HONGKONG

        • JAKARTA

        • MUMBAI

        • OSAKA

        • SEOUL

        • SINGAPORE

        • SYDNEY

        • TOKYO

        • CENTRAL

        • BEIJING

        • NINGXIA

        • FRANKFURT

        • IRELAND

        • LONDON

        • MILAN

        • PARIS

        • STOCKHOLM

        • ZURICH

        • BAHRAIN

        • UAE

        • SAOPAULO

        • GOVCLOUDEAST

        • GOVCLOUDWEST

      • Auth Scheme: Select the authorization scheme, one of:

        • AwsRootKeys

          • AWS Access Key: Enter the AWS access key.

          • AWS Secret Key: Enter the AWS secret key.

        • AwsEC2Roles

        • AwsIAMRoles

          • AWS Access Key: Enter the AWS access key.

          • AWS Secret Key: Enter the AWS secret key.

          • AWS Role ARN: Enter the AWS role ARN.

          • AWS External Id: Enter the AWS external ID.

        • ADFS

          • User: Enter the user.

          • Password: Enter the password.

          • SSO Login URL: Enter the SSO login URL.

          • Use Lake Formation: When selected, specifies to use lake formation.

          • SSO Properties: Enter the SSO properties.

        • Okta

          • User: Enter the user.

          • Password: Enter the password.

          • SSO Login URL: Enter the SSO login URL.

          • Use Lake Formation: When selected, specifies to use lake formation.

          • SSO Properties: Enter the SSO properties.

        • PingFederate

          • User: Enter the user.

          • Password: Enter the password.

          • SSO Login URL: Enter the SSO login URL.

          • SSO Exchange Url: Enter the SSO exchange URL.

          • Use Lake Formation: When selected, specifies to use lake formation.

          • AWS Principal ARN: Enter the AWS principal ARN.

          • SSO Properties: Enter the SSO properties.

        • AwsMFA

          • AWS Access Key: Enter the AWS access key.

          • AWS Secret Key: Enter the AWS secret key.

          • MFA Serial Number: Enter the MFA serial number.

          • MFA Token: Enter the MFA token.

          • Temporary Token Duration: Enter the temporary token duration.

        • AwsTempCredentials

          • AWS Access Key: Enter the AWS access key.

          • AWS Secret Key: Enter the AWS secret key.

          • AWS Session Token: Enter the AWS session token.

        • AwsCredentialsFile

        • AzureAD

          • Use Lake Formation: When selected, specifies to use lake formation.

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

      • Storage Base URL: Enter the storage base URL.

    • Azure Blob Storage

      • Azure Storage Account: Enter the Azure storage account.

      • Auth Scheme: Select the authorization scheme, one of:

        • AzureAD

          • Use Lake Formation: When selected, specifies to use lake formation.

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

        • AzureMSI

        • AzureServicePrincipal

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

        • AzureServicePrincipalCert

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

        • AccessKey

          • Azure Access Key: Enter the Azure access key.
        • AzureStorageSAS

          • Azure Shared Access Signature: Enter the Azure shared access signature.
    • Azure Data Lake Storage Gen1

      • Azure Storage Account: Enter the Azure storage account.

      • Auth Scheme: Select the authorization scheme, one of:

        • AzureAD

          • Use Lake Formation: When selected, specifies to use lake formation.

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

        • AzureMSI

        • AzureServicePrincipal

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

        • AzureServicePrincipalCert

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

        • AccessKey

          • Azure Access Key: Enter the Azure access key.
        • AzureStorageSAS

          • Azure Shared Access Signature: Enter the Azure shared access signature.
    • Azure Data Lake Storage Gen2

      • Azure Storage Account: Enter the Azure storage account.

      • Auth Scheme: Select the authorization scheme, one of:

        • AzureAD

          • Use Lake Formation: When selected, specifies to use lake formation.

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

        • AzureMSI

        • AzureServicePrincipal

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

        • AzureServicePrincipalCert

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

        • AccessKey

          • Azure Access Key: Enter the Azure access key.
        • AzureStorageSAS

          • Azure Shared Access Signature: Enter the Azure shared access signature.
    • Azure Data Lake Storage Gen2 SSL

      • Azure Storage Account: Enter the Azure storage account.

      • Auth Scheme: Select the authorization scheme, one of:

        • AzureAD

          • Use Lake Formation: When selected, specifies to use lake formation.

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

        • AzureMSI

        • AzureServicePrincipal

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

        • AzureServicePrincipalCert

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

        • AccessKey

          • Azure Access Key: Enter the Azure access key.
        • AzureStorageSAS

          • Azure Shared Access Signature: Enter the Azure shared access signature.
    • Azure Files

      • Azure Storage Account: Enter the Azure storage account.

      • Auth Scheme: Select the authorization scheme, one of:

        • AccessKey

          • Azure Access Key: Enter the Azure access key.
        • AzureStorageSAS

          • Azure Shared Access Signature: Enter the Azure shared access signature.
    • Box

      • Auth Scheme: Select the authorization scheme, one of:

        • OAuth

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth Version: Select the OAuth version, one of:

            • 1.0

              • OAuth Request Token URL: Enter the OAuth request token URL.
            • 2.0

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

        • OAuthJWT

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

          • OAuth JWT Issuer: Enter the OAuth JWT issuer.

          • OAuth JWT Subject: Enter the OAuth JWT subject.

    • Dropbox

      • Auth Scheme: Select the authorization scheme, one of:

        • OAuth

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth Version: Select the OAuth version, one of:

            • 1.0

              • OAuth Request Token URL: Enter the OAuth request token URL.
            • 2.0

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

    • FTP

      • Auth Scheme: Select the authorization scheme, one of:

        • Basic

          • User: Enter the user.

          • Password: Enter the password.

    • FTPS

      • Auth Scheme: Select the authorization scheme, one of:

        • Basic

          • User: Enter the user.

          • Password: Enter the password.

    • Google Cloud Storage

      • Project Id: Enter the project ID.

      • Auth Scheme: Select the authorization scheme, one of:

        • OAuth

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth Version: Select the OAuth version, one of:

            • 1.0

              • OAuth Request Token URL: Enter the OAuth request token URL.
            • 2.0

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

        • OAuthJWT

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

          • OAuth JWT Issuer: Enter the OAuth JWT issuer.

          • OAuth JWT Subject: Enter the OAuth JWT subject.

        • GCPInstanceAccount

    • Google Drive

      • Auth Scheme: Select the authorization scheme, one of:

        • OAuth

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth Version: Select the OAuth version, one of:

            • 1.0

              • OAuth Request Token URL: Enter the OAuth request token URL.
            • 2.0

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

        • OAuthJWT

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

          • OAuth JWT Issuer: Enter the OAuth JWT issuer.

          • OAuth JWT Subject: Enter the OAuth JWT subject.

        • GCPInstanceAccount

    • HDFS

      • Auth Scheme: Select the authorization scheme, one of:

        • None

        • Negotiate

          • User: Enter the user.

          • Password: Enter the password.

          • Kerberos KDC: Enter the Kerberos KDC.

          • Kerberos Realm: Enter the Kerberos realm.

          • Kerberos SPN: Enter the Kerberos SPN.

          • Kerberos Keytab File: Enter the Kerberos keytab file.

          • Kerberos Service Realm: Enter the Kerberos service realm.

          • Kerberos Service KDC: Enter the Kerberos service KDC.

          • Kerberos Ticket Cache: Enter the Kerberos ticket cache.

    • HDFS Secure

      • Auth Scheme: Select the authorization scheme, one of:

        • None

        • Negotiate

          • User: Enter the user.

          • Password: Enter the password.

          • Kerberos KDC: Enter the Kerberos KDC.

          • Kerberos Realm: Enter the Kerberos realm.

          • Kerberos SPN: Enter the Kerberos SPN.

          • Kerberos Keytab File: Enter the Kerberos keytab file.

          • Kerberos Service Realm: Enter the Kerberos service realm.

          • Kerberos Service KDC: Enter the Kerberos service KDC.

          • Kerberos Ticket Cache: Enter the Kerberos ticket cache.

    • HTTP

      • Auth Scheme: Select the authorization scheme, one of:

        • None

        • Basic

          • User: Enter the user.

          • Password: Enter the password.

        • Digest

          • User: Enter the user.

          • Password: Enter the password.

        • OAuth

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth Version: Select the OAuth version, one of:

            • 1.0

              • OAuth Request Token URL: Enter the OAuth request token URL.
            • 2.0

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

        • OAuthJWT

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

          • OAuth JWT Issuer: Enter the OAuth JWT issuer.

          • OAuth JWT Subject: Enter the OAuth JWT subject.

        • OAuthPassword

          • User: Enter the user.

          • Password: Enter the password.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth Version: Select the OAuth version, one of:

            • 1.0

              • OAuth Request Token URL: Enter the OAuth request token URL.
            • 2.0

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

        • OAuthClient

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

        • OAuthPKCE

          • OAuth Client Id: Enter the OAuth client ID.
    • HTTPS

      • Auth Scheme: Select the authorization scheme, one of:

        • None

        • Basic

          • User: Enter the user.

          • Password: Enter the password.

        • Digest

          • User: Enter the user.

          • Password: Enter the password.

        • OAuth

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth Version: Select the OAuth version, one of:

            • 1.0

              • OAuth Request Token URL: Enter the OAuth request token URL.
            • 2.0

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

        • OAuthJWT

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

          • OAuth JWT Issuer: Enter the OAuth JWT issuer.

          • OAuth JWT Subject: Enter the OAuth JWT subject.

        • OAuthPassword

          • User: Enter the user.

          • Password: Enter the password.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth Version: Select the OAuth version, one of:

            • 1.0

              • OAuth Request Token URL: Enter the OAuth request token URL.
            • 2.0

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

        • OAuthClient

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

        • OAuthPKCE

          • OAuth Client Id: Enter the OAuth client ID.
    • IBM Object Storage Source

      • Region: Enter the region.

      • Auth Scheme: Select the authorization scheme, one of:

        • OAuth

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth Version: Select the OAuth version, one of:

            • 1.0

              • OAuth Request Token URL: Enter the OAuth request token URL.
            • 2.0

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

        • HMAC

          • Access Key: Enter the access key.

          • Secret Key: Enter the secret key.

    • OneDrive

      • Auth Scheme: Select the authorization scheme, one of:

        • AzureAD

          • Use Lake Formation: When selected, specifies to use lake formation.

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

        • AzureMSI

        • AzureServicePrincipal

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

        • AzureServicePrincipalCert

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

    • OneLake

      • Auth Scheme: Select the authorization scheme, one of:

        • AzureAD

          • Use Lake Formation: When selected, specifies to use lake formation.

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

        • AzureMSI

        • AzureServicePrincipal

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

        • AzureServicePrincipalCert

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

    • Oracle Cloud Storage

      • Region: Enter the region.

      • Oracle Namespace: Enter the Oracle namespace.

      • Auth Scheme: Select the authorization scheme, one of:

        • HMAC

          • Access Key: Enter the access key.

          • Secret Key: Enter the secret key.

    • SFTP

      • Auth Scheme: Select the authorization scheme, one of:

        • SFTP

          • SSH Auth Mode: Select the SSH auth mode, one of:

            • None

            • Password

              • SSH User: Enter the SSH user.

              • SSH Password: Enter the SSH password.

            • Public_Key

              • SSH Client Cert: Enter the SSH client certificate.

              • SSH Client Cert Type: Select the SSH client certificate type, one of:

                • USER

                • MACHINE

                • PFXFILE

                • PFXBLOB

                • JKSFILE

                • JKSBLOB

                • PEMKEY_FILE

                • PEMKEY_BLOB

                • PPKFILE

                • PPKBLOB

                • XMLFILE

                • XMLBLOB

              • SSH Client Cert Password: Enter the SSH client certificate password.

              • SSH Client Cert Subject: Enter the SSH client certificate subject.

    • SharePoint REST

      • Auth Scheme: Select the authorization scheme, one of:

        • AzureAD

          • Use Lake Formation: When selected, specifies to use lake formation.

          • OAuth Client Id: Enter the OAuth client ID.

          • OAuth Client Secret: Enter the OAuth client secret.

          • Callback URL: Enter the callback URL.

        • AzureMSI

        • AzureServicePrincipal

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

        • AzureServicePrincipalCert

          • Azure Tenant: Enter the Azure tenant.

          • Initiate OAuth: Select the OAuth setting, one of:

            • OFF

              • OAuth Access Token: Enter the OAuth access token.
            • GETANDREFRESH

            • REFRESH

              • OAuth Access Token: Enter the OAuth access token.
          • OAuth Client Id: Enter the OAuth client ID.

          • Scope: Enter the scope.

          • OAuth Authorization URL: Enter the OAuth authorization URL.

          • OAuth Access Token URL: Enter the OAuth access token URL.

          • OAuth Refresh Token URL: Enter the OAuth refresh token URL.

          • OAuth Refresh Token: Enter the OAuth refresh token.

          • OAuth JWT Cert: Enter the OAuth JWT certificate.

          • OAuth JWT Cert Type: Select the OAuth JWT certificate type, one of:

            • USER

            • MACHINE

            • PFXFILE

            • PFXBLOB

            • JKSFILE

            • JKSBLOB

            • PEMKEY_FILE

            • PEMKEY_BLOB

            • PUBLIC_KEY_FILE

            • PUBLIC_KEY_BLOB

            • SSHPUBLIC_KEY_FILE

            • SSHPUBLIC_KEY_BLOB

            • P7BFILE

            • PPKFILE

            • XMLFILE

            • XMLBLOB

            • GOOGLEJSON

            • GOOGLEJSONBLOB

          • OAuth JWT Cert Password: Enter the OAuth JWT certificate password.

          • OAuth JWT Cert Subject: Enter the OAuth JWT certificate subject.

      • Storage Base URL: Enter the storage base URL.

    • SharePoint SOAP

      • Auth Scheme: Select the authorization scheme, one of:

        • Basic

          • User: Enter the user.

          • Password: Enter the password.

        • ADFS

          • User: Enter the user.

          • Password: Enter the password.

          • SSO Login URL: Enter the SSO login URL.

          • Use Lake Formation: When selected, specifies to use lake formation.

          • SSO Properties: Enter the SSO properties.

        • Okta

          • User: Enter the user.

          • Password: Enter the password.

          • SSO Login URL: Enter the SSO login URL.

          • Use Lake Formation: When selected, specifies to use lake formation.

          • SSO Properties: Enter the SSO properties.

        • OneLogin

          • User: Enter the user.

          • Password: Enter the password.

          • SSO Properties: Enter the SSO properties.

      • Storage Base URL: Enter the storage base URL.

  • OAuth Grant Type: Select the OAuth grant type, one of:

    • CODE

    • CLIENT

    • PASSWORD

  • Use Proxy Settings: Select to use private agent proxy settings.

  • Advanced Configurations: When selected, shows the Advanced Configurations Properties table, which is used to add additional configuration properties as key-value pairs.

    Click the add icon add icon to add a row to the table below and enter a key-value pair for each property.

    To save the row, click the submit icon submit icon in the rightmost column.

    To edit or delete a single row, hover over the rightmost column and use the edit icon edit icon or delete icon delete icon.

    To delete all rows, click Clear All.

    Important

    Fields in the Advanced Configurations table display the variable icon Variable icon only in edit mode. For these fields' variable values to be populated at runtime, the agent version must be at least 10.75 / 11.13.

  • Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

  • Save Changes: Click to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Configure OAuth connections

This connector supports a connection using OAuth by using specific configuration properties. After selecting an auth scheme that includes Initiate OAuth, you will be able to specify the configuration in the fields that are displayed.

Note

Additional IDs, secrets, scopes, and other authentication tokens may be required in order to successfully complete the OAuth authentication. Check the endpoint documentation for additional information on their requirements.

For this connector, two scenarios are supported. In either scenario, you will need to use a third-party tool (such as Postman or a similar tool) to obtain the required access token or tokens from the endpoint involved. both of these scenarios work only for single-agent groups. These are agent groups that consist of a single agent.

  • Scenario 1: Using an OAuth access token that expires after a set period of time.

    With this configuration, you supply an OAuth access token that lasts for a set period of time, as determined by the particular endpoint. The connector will use the token to make the connection. The connection, however, will no longer work once the access token expires. You would configure the connector to use the token by setting these properties:

    Configuration Property Value
    Initiate OAuth OFF
    OAuth Access Token Set to the value of the OAuth access token obtained from the endpoint
  • Scenario 2: Using an OAuth access token combined with an OAuth refresh token to enable automatic refresh of access.

    With this configuration, the connector will use a refresh token to obtain a new access token once the current access token has expired. This is generally the best method of configuring OAuth.

    You supply an OAuth access token and an OAuth refresh token, as determined by the particular endpoint. You would configure the connector to use these tokens by setting these properties:

    Configuration Property Value
    Initiate OAuth REFRESH
    OAuth Access Token Set to the value of the OAuth access token obtained from the endpoint
    OAuth Refresh Token Set to the value of the OAuth refresh token obtained from the endpoint

Note

If using multiple OAuth-based Microsoft Excel v2 connections on the same private agent, set the configuration property OAuthSettingsLocation to a unique writeable agent path for each connection. In the jitterbit.conf file for the agent, set EnableLocalFileLocation=true. If you don't perform these two steps, the multiple connections will use the same default path and overwrite each other.

Next steps

After a Microsoft Excel connector connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

  • Query: Retrieves records from a table at Microsoft Excel and is intended to be used as a source in an operation.

  • Create: Inserts a record into a table at Microsoft Excel and is intended to be used as a target in an operation.

  • Update: Updates a record in a table at Microsoft Excel and is intended to be used as a target in an operation.

  • Delete: Deletes a record from a table at Microsoft Excel and is intended to be used as a target in an operation.

  • Execute: Executes a procedure at Microsoft Excel and is intended to be used as a target in an operation.