Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Warning |
---|
Warning: You must upload files in the following order:
|
Rep File (.REP)
The Rep REP file contains all rep Rep codes for an advisor. The . ACL file references the Rep number to determine team members and assistants who should have access to work items created by a particular rep. The information from this data file will populate three different domain tables in DocupaceRep.
Note |
---|
Attention: Each rep code must have its own row in the excel fileline in this file is equivalent to a Rep code. For example, if Rep A has three rep Rep codes, you would must add 3 three separate rows. |
The information from the REP data file will populate three different domain tables in Docupace.
Advisor Table
The majority of the information resides here.
Note: There should only be one record per Advisor.
Rep Table
This is where the Rep code(s) are listed. An The Rep domain lists the Rep codes assigned to Advisors. An Advisor may have multiple Rep codes they are associated with them. Each Rep code will show appear in the rep Rep table. The system then associates an Advisor Advisor will then be associated with that repRep. There There are situations where multiple Advisors may be linked to the same Rep code, called a Split Rep code.
Recipients Table
For each Advisor, an Email Recipient record is created, and the Advisor's email with is linked to all associated Rep codes.
Required Fields/Columns:
Rep Number (A)
Rep First Name (C)
Rep Last Name (D)
BD Number (F)
Phone Number (H)
Email Address (I)
What Does Each Column
DefinitionsReview the table below for help completing each column in the .Rep File. Asterisks (*) identify which columns must contain information.Mean?
To fill out the template correctly, see the description of each column below:
Column | Field/ Header | Max (min) |
---|
Characters | Details |
A |
---|
rep_number | 30 |
|
C*
| ||
B | clearing1 (nfs) | 30 |
---|
NFS Rep Code
| |||
C | rep_first_name | 100 | Advisor's First Name |
---|---|---|---|
D |
rep_last_name | 100 | Advisor's Last Name | |
E | rep_full_name | 30 | Advisor's full name |
F |
rep_bd_number |
7
Any number value |
|
G
| |||||
G | RESERVED1 (do not fill) | 0 | Leave blank.
| ||
---|---|---|---|---|---|
H |
rep_business_phone | 15 (10) |
Rep’s Business phone number |
I |
---|
rep_email_address | 100 |
Reps’ email address | ||
J | rep_fax_number | 15 (10) |
---|
Rep’s Business fax number | |||||
K | RESERVED2 (do not fill) | 0 | Leave blank.
| ||
---|---|---|---|---|---|
L | rep_field_osj_first_name | 30 | OSJ First Name
| ||
M | rep_field_osj_last_name | 30 | OSJ Last Name |
N
| |||||
N | RESERVED3 (do not fill) | 0 | Leave blank.
| ||
---|---|---|---|---|---|
O | rep_osj_office_branch_number | 30 | Rep’s OSJ Office Branch Number |
P
rep_ssn
9 (9)
Advisor’s SSN xxxxxxxxx
| |||
P | rep_ssn | 9 (9) |
|
---|---|---|---|
Q | region_code | 30 | Region Code |
R | osj_code | 30 | OSJ Code |
S | sales_office_code | 30 | Sales Office Code |
T | address_line1 | 254 |
Rep Address Line 1 | ||
U | address_line2 | 254 |
---|
Rep Address Line 2 | ||
V | city | 30 |
---|
Rep City | ||
W | state | 2 (2) |
---|
Rep State | ||
X | zip_code | 10 (5) |
---|
Rep Zip Code | |||
Y | clearing2 (pershing) | 30 |
|
---|
|
| |||||
Z | RESERVED4 (do not fill) | 0 | Leave blank.
| ||
---|---|---|---|---|---|
AA | split_rep (T/F) |
Y
|
N
| Is the Rep |
code shared with one or more |
Advisors for commission purposes? |
AB
rep_dob
MM/DD/YYYY
The Date of Birth of the Registered Advisor
AC
pershing_rep_number
3
Pershing IP Number
Note: used only for Pershing NAO API
| |||
AB | rep_dob |
| The Date of Birth of the Registered Rep |
---|---|---|---|
AC | pershing_rep_number | Populates |
attribute 100016 in the Rep domain (Pershing #) | |||
AD | adv_order |
| Sets |
---|
whether the |
Rep is Advisor 1, Advisor 2, or Advisor 3 for a split |
Rep code | |||
AE | create_adv_folders |
| Determines whether Advisors |
---|
Office folders should be created for this Rep code |
User Access File (.ACL)
The ACL file provides the mechanism to add/disable users into the system. This file provisions users in the system, systematically. The ACL file can create, update, and/or terminates users. user access to the Docupace site in bulk. In this file, each line item is equivalent to one Docupace user with a specific data role. The information in this file updates the User Access domain and the user field in the Rep domain. It also updates the corresponding settings in Security Realm.
Tip |
---|
Best Practice Tip: We recommend that you ALWAYS use the . ACL file when adding or making changes to Docupace users for consistency and ease of user management. However, you should manually remove terminated users . There are two exceptions:
|
Info |
---|
Important features of the ACL File: For a given user, controls the documents that a
|
Associating Assistants with Advisors
Each association requires three rows. It's important that the rows The rows must get loaded in this order. The third row isn't required for the association, but you need to include it is necessary if you want to correct the name/email of the assistant after making the association.
Defines Rep
Creates and associates Assistant
Updates Assistant’s name and email
When adding row number two, the system uses the following logic to associate the rep Rep and assistant records.
Processor SA (assistant) must match on First and Last Name, SSN, or Email, AND Primary Flag or Split Rep =
Y
The owned_rep Rep column (Col J) must contain the advisor’s rep Rep code.
The allowed_proc column (Col R) must contain the advisor’s user name.
What Does Each Column Mean?
The information below provides the fields that must be considered when using an ACL Filefollowing table describes the columns in an ACL file. Identify what each row should be. It can be a unique user or the same user entered multiple times to add extra data roles or additional user aliases for integrated CRM systems.
Column | Field/Header | Max (min) Characters | Details |
---|---|---|---|
A | bd |
| Firm number. You should enter |
B | user_name | 125 (1) | Enter the user’s email address |
C | user_first_name | 50 | User’s First Name |
D | user_last_name | 50 | User’s Last Name |
E | user_email | 50 |
|
F | user_status | |
This |
value determines ongoing |
system access. To terminate the user's access, set this field to | |||
G | record_type | 2 (1) |
This field determines which Advisor Records a user has access to. |
---|---|---|---|
H | acl | 30 | Enter the corresponding |
Rep code from the |
REP file.
|
|
|
| ||
I | primary_flag | |
---|
Sets the |
Rep code |
as the Advisor’s Primary Rep Code.
|
|
Note: The system |
automatically |
marks this as | |||||
J | assoc_user | ||||
---|---|---|---|---|---|
K | user_role | 50 | Docupace User Data Role examples: Field Users:
Back Office Users:
| ||
L | bill_status |
| Always set this field to | ||
M | entity | 100 | Enter the firm name. You can find this |
in the Firm domain. Most sites associate users to a single entity.
|
| |||||
N | RESERVED | 0 | Leave blank
| ||
---|---|---|---|---|---|
O | auto_assign_creator | |
Y
. For Back Office users, it should be set to N
. This will determine whether a Work Item created by the user will be automatically assigned to that same user for processing or placed in a Pool of Work Items available to other users.
| |||
P | trusted_sso | 50 | Other systems, such as CRMs that are integrated with Docupace and are authorized to send data through Single Sing-On (SSO). Examples:
|
---|
Connect
Practifi
Note: By default, this field is set to
|
Connect
|
|
|
Salesforce;Connect
| |||
Q | grant_access | 125 per value | Enter one or more other user |
---|
IDs. |
IDs you enter into this field will have access to the user’s unindexed documents. (list separated by comma or semi-colon with no spaces) Note: If left blank, it will default to the user |
ID from column B. | ||
R | allowed_proc | 125 per value |
---|
Enter one or more other user ids. IDs you enter here will be able to process work items on behalf of the user.
Grants other users access to the Work Items created by this user. Shows the Assign to Me button in the Work Item. Specific user IDs separated by a comma or a semicolon with no spaces:
Note: If left blank, it will default to the user |
ID from column B. | |||
S | user_type | 30 |
Provides details for billing |
---|
Reports.
| ||
T | billable_user | 125 |
---|
Associates the user with a billable user |
ID. If an admin supports an Advisor, the Advisor's user |
ID would show here. Note: |
Only use this field when setting up Field users. | |||
U | alias_user_name_clear |
| Clears out the alias in the User Access domain:
This column clears the alias_user_name field so that you can re-populate the alias field with the correct alias |
---|
ID with one file load.
| |||
V | alias_user_name | 125 | Populates the Alias field in the User Access domain. |
---|
Typically, CRMs such as Redtail or Salesforce |
use columns U and V. Alternatively, you can use them as part of SSO.
|
|
Client File (.CLT)
You will only need to import the . CLT file during your initial site setup. It imports your client data into the Docupace system. Each row corresponds with an Account Folder or Subfolder for a clientIn this file, each line item is equivalent to an Account (Subfolder) for a Client. If you plan to add only add the Client Folder information (and not no account information), you only need to add fill out only the columns with the client-level detaildetails.
Note: Client type Type dictates whether you use First/Last names or Company Name.
Generating a Subfolder
tipTip:Each filled
line (orrow
)in the spreadsheet will create a new Client Subfolder.
Subfolder type is the ONLY required field to generate a Subfolder for a Client record
Record per Subfolder (if there are more than one everything is duplicated except the Subfolder type)To create a subfolder, enter a value in the Subfolder Type column.
To create multiple subfolders for the same client, create duplicate rows and edit the data in the Subfolder Type column.
If you do not populate the Subfolder info, ONLY a general folder is created with the Client folder
The fields that contain Client Folder information are the only required fields. You are not required to add Client Subfolder (account) information if you do not have it available.
Type column, the system will create a
General
Subfolder under the Client Folder.
Adding Multiple Rep Codes to the Same Client
When two or more reps work with the same Client, you will have the same Client Type, same Company, and same TIN with two different Rep codes. Include the Rep code as the unique key field to handle this situation.
Required Fields for Client File
SSN/TIN (F)
Rep ID (I)
Client Type
If
person
: Last_name (A) and first_name (B)If
entity
: entity_name (D)Business Type (consult with your Docupace team about this value)
Status
What Does Each Column Mean?
The following table describes the information you need for each column.
Column | Field/Header | Max length (Min length) | Field Details |
---|---|---|---|
A | last_name | 100 |
Used for a Person | ||
B | first_name | 100 |
---|
Used for a Person | |||
C | group_name | 100 | A Group can represent a Household unit |
---|
D | entity_name | 100 | Used for a Company or a Trust | ||
---|---|---|---|---|---|
E | client_type | 30 |
|
| |||
F | ssn | 9 (9) | Format the ssn without dashes.
|
---|---|---|---|
G | business_type | 30 |
The available values can vary based on your site setup. A typical site includes |
Many sites use the BD’s name in place of |
.
|
| |||
H | client_status | 30 |
|
---|---|---|---|
I |
Rep# | 30 per value | Rep code. You can find this in Column G of the |
REP file |
. You can also find this in the Rep record if the Rep already exists.
|
|
|
|
| |||
J | account# | 30 per value | The account number |
---|---|---|---|
K | Subfolder_type | 30 |
The system requires this column for each |
Subfolder ( |
Account) you want to |
create. |
The available values |
can vary based on |
your site setup.
|
|
|
| ||
L | registration | 50 |
---|
The available values |
can vary based on |
your site setup.
|
| ||
M | sponsor | 254 |
---|
The available values |
can vary based on |
your site setup.
|
| ||
N | product_type | 50 |
---|
The available values |
can vary based on |
your site setup.
|
| ||
O | other_desc | 254 |
---|
Additional description | |||
P | state | 2 | A 2-digit state code |
---|---|---|---|
Q | short_name | 100 |
A short name |
for the account | ||
R | open_date |
|
---|
MM/DD/YYYY
formatOpen Date for the Account | ||
S | close_date |
|
---|
MM/DD/YYYY
formatClose Date for the Account | |||||
-T | external_id | 50 | Subfolder External ID. This field is frequently used for 3rd-party integrations. | ||
---|---|---|---|---|---|
U | RESERVED | 0 | Leave blank
| ||
V | account_status | 30 |
| ||
W | middle_name | 100 |
Used for a Person | ||
X | suffix | 30 |
---|
Used for a Person | |||
Y | gender | 30 |
|
---|---|---|---|
Z | dob |
|
MM/DD/YYYY
formatDate of Birth for a Person | ||
AA | citizenship | 30 per value |
---|
AB | mailing_addr | 254 |
---|
AC | mailing_city | 30 |
---|
AD | mailing_state | 2 |
---|
AE | mailing_zip | 10 (5) |
---|
AF | legal_addr | 254 |
---|
AG | legal_city | 30 |
---|
AH | legal_state | 2 |
---|
AI | legal_zip | 10 (5) |
---|
AJ | 100 |
---|
AK | home_phone | 15 (10) |
|
---|---|---|---|
AL | mobile_phone | 15 (10) |
|
AM | work_phone | 15 (10) |
|
AN | empl_company_name | 100 | - |
AO | empl_company_addr | 254 | - |
AP | drivers_license# | 100 | - |
AQ | dl_issue_date |
|
MM/DD/YYYY
formatDriver’s License issue date | ||
-AR | dl_exp_date |
|
---|
MM/DD/YYYY
formatDriver’s License expiration date | |||||
AS | RESERVED2 | Leave blank
| |||
---|---|---|---|---|---|
AT | bank_name | 100 |
AU | bank_city | 30 |
---|
AV | bank_state | 2 |
---|
AW | bank_routing# | Any number value |
---|
AX | bank_account# | 30 |
---|
AY | client_marital_status | 30 |
---|
AZ | client_occupation | 100 |
---|
BA | client_id | 50 |
---|
Client ID used by 3rd-party integrations | |||||
BB | RESERVED3 | 0 | Leave blank
| ||
---|---|---|---|---|---|
BC | RESERVED4 | 0 | Leave blank
| ||
BD | RESERVED5 | 0 | Leave blank
| ||
BE | subregistration | 50 | Account Sub-registration type
| ||
BF | crm_source | - | Used by 3rd-party integrations | ||
BG | crm_external_id | - | Used by 3rd-party integrations |