Versions Compared

Key

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

...

Rw ui tabs macro
Rw tab
titleRep File (.REP)

Rep File (.REP)

This file allows Docupace to build relationships between Rep code, OSJ Office, Sales Office, and Region. It also allows Docupace to build out the information for the Advisor to support the hierarchical access within the system. It contains additional information associated with individual Reps. In this file, each line is equivalent to a Rep code.

Note

Warning: Always load the REP file before the ACL file.

To upload a REP file into Docupace, follow the process below:

  1. Fill out this template:

    View file
    namerep.csv
    using MS Excel.

  2. Click File > Save As to save the file as a .csv.

  3. Locate the file on your device and change the file extension from .csv to .rep.

  4. Follow these instructions to upload the file.

Required Fields/Columns:

  1. Rep Number (A)

  2. Rep First Name (C)

  3. Rep Last Name (D)

  4. BD Number (F)

  5. Phone Number (H)

  6. Email Address (I)

What Does Each Column 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

  • The Rep code - a unique Broker-Dealer Rep Number

  • Will be used for hierarchical access from the User File (.ACL)

B

clearing1 (nfs)

30

  • Clearinghouse Rep Number (if applicable)

  • Not required

  • In many cases, it is the same as the rep number

  • Can be left blank. Not used for routing/hierarchical purposes.

  • Labeled “NFS” by default.

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

Any number value

  • In most cases, you should set this field to 7.

  • All rows should have this number unless there are multiple BDs in the network.

  • (Consult Docupace for additional values).

G

RESERVED1 (do not fill)

0

Leave blank.

Warning

Attention: Do NOT remove this column.

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.

Warning

Attention: Do NOT remove this column.

L

rep_field_osj_first_name

30

OSJ First Name

Note

Important: OSJ First Name, OSJ Last Name, and OSJ Office Branch Number are ignored for split Rep codes (if the split_rep column (AA) is set to T).

M

rep_field_osj_last_name

30

OSJ Last Name

Note

Important: OSJ First Name, OSJ Last Name, and OSJ Office Branch Number are ignored for split Rep codes (if the split_rep column (AA) is set to T).

N

RESERVED3 (do not fill)

0

Leave blank.

Warning

Attention: Do NOT remove this column.

O

rep_osj_office_branch_number

30

Rep’s OSJ Office Branch Number

Note

Important: OSJ First Name, OSJ Last Name, and OSJ Office Branch Number are ignored for split Rep codes (if the split_rep column (AA) is set to T).

P

rep_ssn

9 (9)

  • Rep’s Social Security Number

  • Without dashes. Only nine digits.

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

  • Clearinghouse Rep Number (if applicable)

  • Not required.

  • In many cases, it is the same as the Rep number

  • Can be left blank. Not used for routing/hierarchical purposes.

  • Labeled “Pershing” by default.

Z

RESERVED4 (do not fill) 

0

Leave blank.

Warning

Attention: Do NOT remove this column.

AA

split_rep (T/F)

T or F

Is the Rep code shared with one or more Advisors for commission purposes?

Note

Important: If the split_rep column (AA) is set to T, then values in columns L, M and O (rep_field_osj_first_name, rep_field_osj_last_name, rep_osj_office_branch_number) are ignored and not imported.

AB

rep_dob

MM/DD/YYYY

The Date of Birth of the Registered Rep

AC

pershing_rep_number

Populates attribute 100016 in the Rep domain (Pershing #)

AD

adv_order

1, 2 or 3

Sets whether the Rep is Advisor 1, Advisor 2, or Advisor 3 for a split Rep code

AE

create_adv_folders

Y or N

Determines whether Advisors Office folders should be created for this Rep code

There should be separate records for each Rep code for an Advisor. So, if you have four Rep codes for an Advisor, you should create duplicate records with all the same data except the Rep code value. (In the example below, each Advisor only has a single associated Rep code).

The image show Rep Load details in columns.

As explained in more detail in the ACL file section, you can implement a hierarchical layer using O, R, and S codes for Advisors assigned to several Rep codes. This allows for a quicker user setup. For instance, if you have an OSJ group, you can add a user to ALL the associated Rep codes by setting up an O code. Docupace provides up to three levels of hierarchy.

Where is the Information Stored?

The information from the REP data file will populate three different domains in Docupace. A domain is a table with records of the same type and their details.

Advisor Table

The majority of the information resides here. 

Note: There should only be one record per Advisor.

The Advisor Table record example.

Rep Table

This is where the Rep code(s) are listed. An Advisor may have multiple Rep codes associated with them. Each Rep code will appear in the Rep table. The Advisor will then be associated with that Rep. There are situations where multiple Advisors may be linked to the same Rep code, called a Split Rep code.

The Rep Code Table example

Email Recipients Table

For each Advisor, an Email Recipient record is created, and the Advisor's email is linked to all associated Rep codes.

Email Recipient table
Rw tab
titleUser File (.ACL)

User File (.ACL)

The ACL file provides the mechanism to add/disable 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.

Tip

Best Practice: We recommend that you ALWAYS use the ACL file when adding or making changes to Docupace users for consistency and ease of user management. There are two exceptions:

  1. You should create Admin users manually.

  2. Manually remove users whose access to the system must be terminated immediately.

Info

Important features of the ACL File:

  • Controls which documents each user can access (via Client Folder and Subfolder access)

  • Provides automatic initial user setup

  • Allows to update the user’s data role if the user’s role has changed.

To upload an ACL file into Docupace, follow the process below:

  1. Fill out this template:

    View file
    nameacl.csv
    using MS Excel.

  2. Click File > Save As to save the file as a .csv.

  3. Locate the file on your device and change the file extension from .csv to .acl.

  4. Follow these instructions to upload the file.

What Does Each Column Mean?

The following 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

Description

Max length (Min length)

Details

A

bd

Broker-Dealer number (By default, this is 7)

any number value

All fields in this column should have the same number unless there are multiple BDs in the network.

B

user_name

User ID of a person (first initial, last name; all lowercase)

50 (1)

Tip

Best Practice Tip: We recommend maintaining a consistent user ID naming convention.

Note

Important Note: This may vary based on 3rd-party integrations. Please consult with the Docupace team.

C

user_first_name

User’s First Name

50

D

user_last_name

User’s Last Name

50

E

user_email

xxxx@xxxx.com

50

F

user_status

  • Active=A

  • Inactive=T

 A or T

This value determines ongoing system access. To terminate the user's access, set this field to T.

Note

Billing: When the user_status (F) is set to A, then Docupace Finance reviews the user_role (K) to identify if the user is billable. Confirm that both columns are correct before loading this file.

G

record_type

  • R – Region

  • O - OSJ

  • S – Sales Office

  • B – Broker-Dealer

  • RC – Rep code

2 (1)

This field specifies the hierarchy level of the user's access rights. Choose whether the user can access a single Rep code (RC) or a group of Rep codes within the Broker-Dealer, Sales Office, Office of Supervisory Jurisdiction, or the entire Region.

Note: The REP file also references O, S, and R.

H

acl

Code associated with the Record Type.

30

This field in combination with the value in the record_type column (G) determines which Advisor Records the user has access to. See a more detailed explanation below.

Tip

Tip: The codes that may be assigned to each Record Type come from the REP file.

Tip

Tip: You do not need a value in the H column (acl) for a record type B because Back Office/Broker-Dealer users have unfiltered access to all Advisors/Rep. This is the only Record Type that does not require an acl value.

I

primary_flag

Is this the Primary Rep code

 Y or N

Determines if the associated Rep code is the Advisor's primary, in case the Advisor has access to more than one.

Tip

Note: The system automatically marks this as Y if the Advisor only has one Rep code.

Note

For Advisors with several Rep codes: Fill out a single line in the ACL file for each Rep code that the Advisor needs to access. Specify Y for the record with the primary Rep code and N for all other records.

Note: This field is only relevant for Advisor users.

J

RESERVED

Leave blank

0

Warning

Attention: Do NOT remove this column.

K

user_role

Docupace User Data Role examples:

  • For Field: Processor

  • For BackOffice:  Super BO Processor

50

This column determines the user’s data role in the Docupace system. The data role determines the types of actions that a user can take in the system.

Tip

Tip: The available data roles can vary by site. Contact Support or your onboarding team for assistance in filling out this field.

Note

Billing: When the user_status (F) is set to A, Docupace Finance reviews the user_role (K) to identify billable users. Confirm that both columns are correct before loading this file.

L

bill_status

Import into the User Access domain for the given user ID (Y/N)

 ‘Y’ or ’N'

This field helps you track if a user is a billable user. Imports the status into the User Access domain for the given user ID.

 Y or N

Note

Important Note: This field is not used for Docupace billing purposes. It is an internal column that firms can use to audit against the invoices that Docupace sends.

M

entity

Office Association

50

The Entity associated with a user will determine which Forms this user can access in Docupace. This will drive which Forms are added to a new Work Item created through Starting Point.

Important Note: Contact Support or your onboarding team for assistance filling out this field. Usually, users on a single site are associated with the same entity.

N

RESERVED

Leave blank

0

Warning

Attention: Do NOT remove this column.

O

auto_assign_creator

Y or N only

 ‘Y’ or ’N'

For field users, this should be set to Y. For Home Office, it should be set to N. This 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.

 Y or N

For field users, this should be set to Y. For Home Office, it should be set to N. 

Note

Important Note: Contact Support or your onboarding team for assistance filling out this field.

P

trusted_sso

Other systems, such as CRMs that are integrated with Docupace and are authorized to send data through Single Sing-On (SSO).

Examples:

  • Salesforce

  • Redtail

  • Ebix

  • Connect

50

Note: By default, this field is set to Connect.

Note

Important Note: Contact Support or your onboarding team for assistance filling out this field.

Tip

Best Practice: If you use several integrations, add multiple lines per user - one for each connected system and its corresponding alias_user_name (V).

Q

grant_access

Grants other users access to the Client Documents created by this user. E.g., allows you to find the documents through Retrieve.

Specific user IDs separated by a comma or a semicolon with no spaces: dbuckley,jfriedman,

125 per value

Note: If left blank, it will default to this user's ID.

R

allowed_proc

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:  dbuckley,jfriedman,

125 per value

Note: If left blank, it will default to this user's ID.

S

user_type

  • Advisor

  • Back Office Executive

  • Back Office User

  • Docupace Administrator

  • Field Support

  • Tester

30

Provides details for billing reports. 

Info

Note: Typically, all Advisor users should be set to Advisor, Office Staff/Sales Assistants to Field Support,  and Home Office users to Back Office User. (User Type names may be customized to your site)

T

billable_user

This column is for Support users. Enter a billable user ID.

50

Enter the billable user ID with which the user should be associated. If an admin supports an Advisor, enter the Advisor's user ID here.

Note

Important Note: This field is not used for Docupace billing purposes. It is an internal column that firms can use to audit against the invoices Docupace sends.

Note: This field is only relevant to field users.

How Does the Record Type Column Work with the ACL Column?

The Record Type column determines the hierarchy of access rights in the system. The graph shows some examples of how this access might work.

Tip

Why use an R, O, or S code? As explained in File Load Hierarchy, this gives a user an extra level of access hierarchy without creating and maintaining separate lines/records in the ACL file for each Rep code. For instance, if you have an OSJ that supports 50 Rep codes (Advisors), you can replace 50 records/lines (for each RC/Rep code) with just a single entry using the O code. That single record will grant the user access to all associated Rep codes. You do not need to use every record type. Most organizations use B, O,and RC.

Example: For a user who should be able to access all work performed within a certain Office of Supervisory Jurisdiction, select O in the G column (record_type) and enter the corresponding OSJ code in the H column (acl). Upon loading the REP file, the system will do the following:

  • Locate all the Advisors with that associated OSJ Code

  • Locate all the Rep codes linked to those Advisors

  • Link the user to those Rep codes

The value in the ACL column should correspond to your selection in the Record Type column. 

Info

Example: If you enter RC in the Record Type column, place the associated Rep code in the ACL column. 

If you need to link a user with multiple Rep codes, add multiple lines per user - one for each Rep code value.

Example: Carl needs to have two different Rep codes assigned to him.

  1. Fill out a row in the ACL file with Carl's information, starting with the Primary Rep code.

  2. Set Column I (Primary_flag) to Y.

  3. Copy the row to a blank one.

  4. Update the value in Column G (record_type) with RC.

  5. Update the value in Column H (acl) with the second Rep code.

  6. Change that row's Column I value to N.

Record Types for Access Hierarchy

Record Type Value

(Column G)

Represents

Description

B

Back Office/Broker-Dealer

 All Back Office/Broker-Dealer users should utilize this code. This will default the user to FULL Rep Access in the system. No limitations.

Tip

Tip: You do not need a value in the H column (acl) for a record type B because Back Office/Broker-Dealer users have unfiltered access to all Advisors/Rep. This is the only Record Type that does not require an acl value.

R

Region Code

This will grant the user access to all the Rep codes associated with the Advisor's Region Code. This references the R code from the Rep table.

O

OSJ Code

This will grant the user access to all the Rep codes assigned to the Advisor's OSJ code. This references the O code from the Rep table.

S

Sales Office Code

This will grant the user access to all the Rep codes associated with the Advisor's Sales Code. This references the S code from the Rep table.

RC

Rep Code

This will grant the user access to a single assigned Rep code.

Rw tab
titleLicensing File (.LIC)

Licensing File (.LIC)

Docupace can perform licensing validation checks as part of the workflow validations for a task. The validations review the Advisor's licensing information that has been imported into Docupace.

Tip

Note: The system checks if an Advisor already has licensing information for the state. If they do, then the system overwrites the existing licensing information. Otherwise, it creates a new licensing record.

Licensing File Example

To upload an LIC file into Docupace, follow the process below:

  1. Fill out this template:

    View file
    namelic.csv
    using MS Excel.

  2. Click File > Save As to save the file as a .csv.

  3. Locate the file on your device and change the file extension from .csv to .lic.

  4. Follow these instructions to upload the file.

What Does Each Column Mean?

To fill out the template correctly, see the description of each column below:

Column

Field/ Header

Description

Max length (Min length)

A

rep_ssn

  • Rep’s Social Security Number

  • Without dashes. Only nine digits.

9 (9)

B

license_type

The type of license (typically State)

30

C

license

Two-character abbreviation of the state the Advisor is licensed in

Note: This field is only used when the license type is State.

30

D

start_date

-

yyyy-mm-dd or
mm/dd/yyyy

E

term_date

Termination Date

yyyy-mm-dd or
mm/dd/yyyy

Rw tab
titleAdditional Pooled Actors (.APA)

Additional Pooled Actors (.APA)

Docupace can add extra layers of processing hierarchy beyond the typical relationship between a Field Advisor and OSJ. Only some sites need this file. Check with Support to determine if this applies to your site. In this file, each line item is equivalent to a user’s assignment to a specific Pool of Work Items.

Notes: If a user needs to access workflow queues for multiple Reps, create a record for each Rep code. A workflow queue may be associated with a data role or a user (generally a user). The process is guided by the Docupace Delivery Team.

Additional Pooled Actors

To upload an APA file into Docupace, follow the process below:

  1. Fill out this template:

    View file
    nameapa.csv
    using MS Excel.

  2. Click File > Save As to save the file as a .csv.

  3. Locate the file on your device and change the file extension from .csv to .apa.

  4. Follow these instructions to upload the file.

What Does Each Column Mean?

Column

Field/ Header

Description

Max Length

Details

A

task_assignment_type

Task Type from the Workflow Configuration, for which the system needs to use Pooled Actors

30

ADocupace Business Analyst will provide the Task Type to include here.

B

pooled_actorid

The data role or a user ID who will be assigned the task

50

C

rep_number

Specific Rep code that will drive the task assignment

30

Rw tab
titleClient File (.CLT)

Client File (.CLT)

The Client file load is a mechanism to deliver a one-time load or an ongoing update of client information. In this file, each line item is equivalent to an Account (Subfolder) for a Client. If you plan to add only the Client Folder information (and no account information), fill out only the columns with the client-level details.

Note: Client Type dictates whether you use First/Last names or Company Name.

Client Field CSV Example

Generating a Subfolder

Tip

Tip: Each filled line in the spreadsheet will create a newSubfolder.

The Subfolder Type is the only required field to generate a Subfolder for a Client record.

  • One record per Subfolder (if there are more than one Subfolders, duplicate everything except the Subfolder type)

  • If you do not fill out any Subfolder info, only a general folder will be 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. 

Tip

Tip: If you create a single Client Folder record, ONE Subfolder will also be created (automatically) with a Subfolder type of General.

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

  1. SSN/TIN

  2. Rep ID

  3. Client Type

    1. If person: First Name/Last Name must be added to the client information

    2. If entity: Company Name must be added to the client information

    3. Business Type (consult with your Docupace Team for this value)

    4. Status

To upload a CLT file into Docupace, follow the process below:

  1. Fill out this template:

    View file
    nameclt.csv
    using MS Excel.

  2. Click File > Save As to save the file as a .csv.

  3. Locate the file on your device and change the extension from .csv to .clt.

  4. Follow these instructions to upload the file.

What Does Each Column Mean?

The information below provides the fields that must be considered.

Column 

Field/ Header

Max length (Min length)

Description

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

  • Person

  • Trust

  • Business/Entity

  • Vendor

  • Beneficiary

  • Other

  • Prospect

Warning

Warning: Different fields are required based on the Client Type field (Column E). Incomplete records will result in file load errors.

  • Client Type PersonFirst Name, Last Name, SSN, and Rep required

  • Client Type EntityCompany Name, SSN, and Rep required

F

ssn

9 (9)

  • Client’s Social Security Number or Tax ID

  • Without dashes. Only nine digits.

G

business_type

30

Varies by site. Normally, there are at least two types - BD/RIA and Non-BD/RIA. Typically, BD/RIA is replaced with the BD’s name.

Note

Important: Contact Docupace Support or your onboarding team for assistance filling out this field.

H

client_status

30

Active or Inactive

I

rep#

30 per value

Rep code

Note

Important: Add a separate row if multiple Reps are associated with a Client/Account combination.

Info

Example: If an account is shared by two unique Rep codes (not a split Rep code):

  1. Copy the row with the first Rep code to a blank row.

  2. Update the I column (rep#)

J

account#

30 per value

The account number

K

Subfolder_type

30

These values are based on a system dropdown. This is a required field for each Subfolder (Account) that you want to add. The record will fail to load if you don’t select a value in this column.

The values will be determined by your Delivery Team.

L

registration

50

These values are based on a system dropdown.

Note

Important: Contact Docupace Support or your onboarding team for assistance filling out this field.

M

sponsor

254

These values are based on a system dropdown.

Note

Important: Contact Docupace Support or your onboarding team for assistance filling out this field.

N

product_type

50

These values are based on a system dropdown.

Note

Important: Contact Docupace Support or your onboarding team for assistance filling out this field.

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

yyyy-mm-dd or
mm/dd/yyyy

Open Date for the Account

S

close_date

yyyy-mm-dd or
mm/dd/yyyy

Close 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

Warning

Attention: Do NOT remove this column.

V

account_status

30

Open or Closed

Tip

Tip: Some sites may use Active and Inactive instead.

W

middle_name

100

Used for a Person

X

suffix

30

Used for a Person

Y

gender

30

Used for a Person

Z

dob

yyyy-mm-dd or
mm/dd/yyyy

Date 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

email

100

AK

home_phone

15 (10)

999-999-9999 format

AL

mobile_phone

15 (10)

999-999-9999 format

AM

work_phone

15 (10)

999-999-9999 format

AN

empl_company_name

100

AO

empl_company_addr

254

AP

drivers_license#

100

AQ

dl_issue_date

yyyy-mm-dd or
mm/dd/yyyy

Driver’s License issue date

-AR

dl_exp_date

yyyy-mm-dd or
mm/dd/yyyy

Driver’s License expiration date

AS

RESERVED

Leave blank

Warning

Attention: Do NOT remove this column.

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

RESERVED

0

Leave blank

Warning

Attention: Do NOT remove this column.

BC

RESERVED

0

Leave blank

Warning

Attention: Do NOT remove this column.

BD

RESERVED

0

Leave blank

Warning

Attention: Do NOT remove this column.

BE

subregistration

50

Account Sub-registration type

Warning

Attention: Must match the Registration Type

BF

 crm_source      

-

Used by 3rd-party integrations

BG

 crm_external_id

-

Used by 3rd-party integrations

Info

Important: Some sites may have additional address fields available, such as:

  • mailing_province

  • mailing_country

  • legal_province

  • legal_country

Rw tab
titleREP Transfer File Process (.RCG) – OPTIONAL

REP Transfer File Process (.RCG)

A recent addition to the data file process - the RCG file allows for an easier way to navigate the Rep Reassignment process, including adding, removing, reassigning/replacing Rep codes at the Client folder and Subfolder level.

What Does Each Column Mean?

See the description of each column below:

Column

Field/ Header

Max Length

Target Domain

Description

A

process_level

-

  • Client Folder

  • Client Subfolder

  • Client causes the system to locate a Client Account Subfolder to adjust

  • Accountcauses the system to make adjustments at the Account Subfolder level

B

client_last_name

-

  • Client Folder

  • Client Subfolder

The last name of the affected Client

C

client_ssn

9

  • Client Folder

  • Client Subfolder

Client’s 9-digit Social Security Number

D

account

-

Client Subfolder

If changing at the Subfolder level, this column will include the account numbers to be adjusted

E

current_rep

-

  • Client Folder

  • Client Subfolder

This column represents the current assigned Rep

  • If process_type is AddRep One

  • If process_type is RemoveRep One

  • If process_type is ReplaceRep One

F

rep_code_to_process

-

  • Client Folder

  • Client Subfolder

This column represents the new Rep or the change to the Rep code

  • If process_type is AddRep One

  • If process_type is RemoveRep One

  • If process_type is ReplaceRep Two

G

process_type

-

  • Client Folder

  • Client Subfolder

This code will determine what change happens

  • Add a New Rep: Add

  • Remove a Rep: Remove

  • Replace with a new Rep: Replace

Warning

Attention: Values in this column are case-sensitive.