Versions Compared

Old Version 40

changes.mady.by.user Rich Walker

Saved on

compared with

New Version 41

changes.mady.by.user Ben Cortez

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Before you begin, make sure your organization has an active Quik! App account

  2. Provide the Quik! team with the following info: send to support@quikforms.com

    1. Your Quik! Customer ID (ask Quik! if you do not know your customer ID)

    2. Your public X.509 CerificateCertificate. This maps to our CertificateBase64 attribute.

    3. Your EntityID aka Audience URI value which must be a unique identifier. This maps to our Name attribute.

      1. NOTE: Your Audience URI can technically be any string of data up to 1024 characters long but is usually in the form of a URL that contains the Service Provider's name within, and is often simply the same URL as the Assertion Consumer Service.

  3. The Quik! team will enable your account for SSO 

  4. You must build infrastructure and UI elements in your environment that support some sort of "Send to Quik!" button for users to enter the Quik! App with a SAML request. See the SAML Project Details above below for more information on which data points to send to Quik! in the SSO event. 

  5. Quik! recommends that you test your SSO implementation with the pre-production SAML endpoint referenced abovebelow.

  6. Once testing is complete, you can use the production SAML endpoint referenced above and begin the SSO process for users in your production environment.

...

Expand
titleSame Account SAML Attributes

NOTE: Items in yellow are valid SAML elements but may still be in development within the Quik! App to consume and use the elements.

Category

Name

Description

Data Type

Required?

Application Data

ApplicationID

The Application ID at Quik!
ALL CUSTOMERS MUST USE VALUE "36" FOR ApplicationID

string

YES

Application Data

AudienceRestriction

Value that specifies who the assertion is for
ALL CUSTOMERS MUST USE VALUE "ServiceProvider" FOR AudienceRestriction

string

YES

Quik! Account Data

CustomerID

Quik! CustomerID assigned to the customer's account

string

YES

Quik! Account Data

CustomerUserID 

Customer's unique UserID from their internal system of record

string

YES

Application Control

TimeoutRedirectURL

A URL to send the user to when their logged in session expires or is logged out

string

YES

Quik! Account Data

UserFirstName 

User's first name

string

YES

Quik! Account Data

UserLastName 

User's last name

string

YES

Quik! Account Data

UserEmail 

User's email address

string

YES

Quik! Account Data

Username 

User's username - if not provided, Quik! will generate a Username for the user

string

NO

Quik! Account Data

Password 

If provided, user's password will be hashed and stored 

string

NO

Quik! Account Data

CustomerUserType 

Type of user being logged in (e.g Advisor, HomeOffice, etc.)

string

NO

Application Data

BrokerDealerID 

The Broker/Dealer's internal ID used with API calls or e-sign

string

NO

Application Data

CustomerClientId 

The ClientID to assign to Owner1 role

string

NO

Application Data

CustomerAccountId 

The account ID to assign to Account 1 role

string

NO

Application Data

FormIDList 

List of FormIDs to add to the shopping cart

csv

NO

Application Data

ClientIDList 

List of Client IDs to lookup from the connected CRM

csv

NO

Application Data

RepIDList

List of Client IDs to lookup sales rep records from the connected CRM

csv

NO

Application Data

Rep1RecordID 

The record ID to assign to Rep 1 role

string

NO

Application Data

RepNumberList 

List of rep numbers to show in the launch screen of the Quik! App

csv

NO

Application Data

Transactions

List of transaction data objects like a tradeblotter, orders, etc. Must contain a root object called “transactions” which will store an array of objects with the following attributes:

  1. id: the Transaction ID (string)

  2. typeId: the Transaction Type (int): TradeBlotter=1


Example:

Code Block
{
  "transactions": [
    {
      "id": "a1H0S0000012ZeKUAU",
      "typeId": 1
    }
  ]
}



json string

NO

Application Data

FormFieldsData

Any Quik! full field name and value to prefill onto the form

{
   "fields":[
           {"n":"1own.FName","v":"Bruce"},
           {"n":"1own.LName","v":"Wayne"},
           {"n":"1own.H.City","v":"Gotham"}
     ]
}

string

NO

E-Sign Meta Data

ClientCode 

The user's client ID

string

NO

E-Sign Meta Data

AccountCode 

The customer's account ID

string

NO

E-Sign Meta Data

RepCode 

The customer's sales rep ID

string

NO

E-Sign Meta Data

FirmCode 

The customer's firm (broker/dealer ID)

string

NO

E-Sign Meta Data

ClientTransNumber 

The customer's transaction number (numeric integer values only)

number

NO

E-Sign Meta Data

ClientTransNumber2 

The customer's transaction number (numeric integer values only) - number 2

number

NO

E-Sign Meta Data

ClientTransNumber3 

The customer's transaction number (numeric integer values only) - number 3

number

NO

E-Sign Meta Data

ClientTransNumber4 

The customer's transaction number (numeric integer values only) - number 4

number

NO

E-Sign Meta Data

ClientTransCode 

The customer's transaction code

string

NO

E-Sign Meta Data

ClientTransCodeType 

The description if any of the ClientTransCode so customer knows what the data represents

string

NO

E-Sign Meta Data

ClientTransCode2 

The customer's transaction code - number 2

string

NO

E-Sign Meta Data

ClientTransCode2Type 

The description if any of the ClientTransCode2 so the customer knows what the data represents

string

NO

E-Sign Meta Data

ClientTransCode3 

The customer's transaction code - number 3

string

NO

E-Sign Meta Data

ClientTransCode3Type 

The description if any of the ClientTransCode3 so the customer knows what the data represents

string

NO

E-Sign Meta Data

ClientTransCode4 

The customer's transaction code - number 4

string

NO

E-Sign Meta Data

ClientTransCode4Type 

The description if any of the ClientTransCode4 so the customer knows what the data represents

string

NO

E-Sign Meta Data

ClientTransMetaData 

Any extra text the customer wants to pass through the meta data service (up to 8000 characters)

string

NO

Application Control

EnableESign

Turns on or off the e-sign feature for the logged in session of the Quik! App

boolean

NO

Application Control

EnableClientSearch

Flag to hide/disable the client search page in the Quik! App

boolean

NO

QFE Properties

LockPrefilledFields 

If TRUE, sets the prefilled fields as read-only on the form

boolean

NO

QFE Properties

ESignCallbackURL 

Sets the value of the e-sign Callback URL

string

NO

QFE Properties

SubmitFormOn 

If TRUE, shows the Submit button in the Quik! Form Viewer

boolean

NO

QFE Properties

SubmitURL 

Sets the value of the Submit button URL (location where submitted form data will be sent)

string

NO

Application Control

DataSourceConnectionID

Quik! Datasource Connection ID to use when requesting client records, if none then whatever connection exists on the account is used

string

NO

Application Control

LockAssignedRoles 

Flag to allow user to change pre-assigned roles

boolean

NO

Application Control

LockRepChoice

Flag to disable/enable the rep drop-down in the Launch page

boolean

NO

Application Control

ESignConnectionName

Determines which e-sign connection user can access by passing the ESign connection name

string

NO

Application Control

LockESignChoice

Flag to disable/enable e-sign drop-down in the Launch page

boolean

NO

QFE Properties

LockAllFields 

If TRUE, sets all fields as read-only on the form

boolean

NO

Application Data

FormGroupIDList 

List of FormGroupIDs to get the related forms to add to the shopping cart

csv

NO

Same Account - Sample SAML

...

Expand
titleReferral Account SAML Attributes

NOTE: Items in yellow are valid SAML elements but may still be in development within the Quik! App to consume and use the elements.

Category

Name

Description

Data Type

Required?

Application Data

ApplicationID

The Application ID at Quik!
ALL CUSTOMERS MUST USE VALUE "36" FOR ApplicationID

string

YES

Quik! Account Data

CustomerID

Quik! CustomerID assigned to the customer's account

string

YES

Quik! Account Data

CustomerUserID 

Customer's unique UserID from their internal system of record

string

YES

Application Control

TimeoutRedirectURL

A URL to send the user to when their logged in session expires or is logged out

string

YES

Application Data

BrokerDealerID 

The Broker/Dealer's internal ID used with API calls or e-sign

string

NO

Application Data

CustomerClientId 

The ClientID to assign to Owner1 role

string

NO

Application Data

CustomerAccountId 

The account ID to assign to Account 1 role

string

NO

Application Data

FormIDList 

List of FormIDs to add to the shopping cart

csv

NO

Application Data

ClientIDList 

List of Client IDs to lookup from the connected CRM

csv

NO

Application Data

RepIDList

List of Client IDs to lookup sales rep records from the connected CRM

csv

NO

Application Data

Rep1RecordID 

The record ID to assign to Rep 1 role

string

NO

Application Data

RepNumberList 

List of rep numbers to show in the launch screen of the Quik! App

csv

NO

Application Data

Transactions

List of transaction data objects like a tradeblotter, orders, etc. Must contain a root object called “transactions” which will store an array of objects with the following attributes:

  1. id: the Transaction ID (string)

  2. typeId: the Transaction Type (int): TradeBlotter=1


Example:

Code Block
{
  "transactions": [
    {
      "id": "a1H0S0000012ZeKUAU",
      "typeId": 1
    }
  ]
}



json string

NO

Application Data

FormFieldsData

Any Quik! full field name and value to prefill onto the form

{
   "fields":[
           {"n":"1own.FName","v":"Bruce"},
           {"n":"1own.LName","v":"Wayne"},
           {"n":"1own.H.City","v":"Gotham"}
     ]
}

string

NO

E-Sign Meta Data

ClientCode 

The user's client ID

string

NO

E-Sign Meta Data

AccountCode 

The customer's account ID

string

NO

E-Sign Meta Data

RepCode 

The customer's sales rep ID

string

NO

E-Sign Meta Data

FirmCode 

The customer's firm (broker/dealer ID)

string

NO

E-Sign Meta Data

ClientTransNumber 

The customer's transaction number (numeric integer values only)

number

NO

E-Sign Meta Data

ClientTransNumber2 

The customer's transaction number (numeric integer values only) - number 2

number

NO

E-Sign Meta Data

ClientTransNumber3 

The customer's transaction number (numeric integer values only) - number 3

number

NO

E-Sign Meta Data

ClientTransNumber4 

The customer's transaction number (numeric integer values only) - number 4

number

NO

E-Sign Meta Data

ClientTransCode 

The customer's transaction code

string

NO

E-Sign Meta Data

ClientTransCodeType 

The description if any of the ClientTransCode so customer knows what the data represents

string

NO

E-Sign Meta Data

ClientTransCode2 

The customer's transaction code - number 2

string

NO

E-Sign Meta Data

ClientTransCode2Type 

The description if any of the ClientTransCode2 so the customer knows what the data represents

string

NO

E-Sign Meta Data

ClientTransCode3 

The customer's transaction code - number 3

string

NO

E-Sign Meta Data

ClientTransCode3Type 

The description if any of the ClientTransCode3 so the customer knows what the data represents

string

NO

E-Sign Meta Data

ClientTransCode4 

The customer's transaction code - number 4

string

NO

E-Sign Meta Data

ClientTransCode4Type 

The description if any of the ClientTransCode4 so the customer knows what the data represents

string

NO

E-Sign Meta Data

ClientTransMetaData 

Any extra text the customer wants to pass through the meta data service (up to 8000 characters)

string

NO

Application Control

EnableESign

Turns on or off the e-sign feature for the logged in session of the Quik! App

boolean

NO

Application Control

EnableClientSearch

Flag to hide/disable the client search page in the Quik! App

boolean

NO

QFE Properties

LockPrefilledFields 

If TRUE, sets the prefilled fields as read-only on the form

boolean

NO

QFE Properties

ESignCallbackURL 

Sets the value of the e-sign Callback URL

string

NO

QFE Properties

SubmitFormOn 

If TRUE, shows the Submit button in the Quik! Form Viewer

boolean

NO

QFE Properties

SubmitURL 

Sets the value of the Submit button URL (location where submitted form data will be sent)

string

NO

Application Control

DataSourceConnectionID

Quik! Datasource Connection ID to use when requesting client records, if none then whatever connection exists on the account is used

string

NO

Application Control

LockAssignedRoles 

Flag to allow user to change pre-assigned roles

boolean

NO

Application Control

LockRepChoice

Flag to disable/enable the rep drop-down in the Launch page

boolean

NO

Application Control

ESignConnectionName

Determines which e-sign connection user can access by passing the ESign connection name

string

NO

Application Control

LockESignChoice

Flag to disable/enable e-sign drop-down in the Launch page

boolean

NO

QFE Properties

LockAllFields 

If TRUE, sets all fields as read-only on the form

boolean

NO

Application Data

FormGroupIDList 

List of FormGroupIDs to get the related forms to add to the shopping cart

csv

NO

Referral Account - Sample SAML Request

...