Skip to content

omx/omx-company-upload-guidelines

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 

Repository files navigation

Overview

If you are a suitably permissioned company user on OMX, you can upload a list of companies to the marketplace which will appear as "pinned" organizations on your Companies page. This specification explains the requirements for creating an uploadable CSV of companies, which may change over time.

Once a file has been validated, it will be uploaded in real-time into OMX and analyzed to ascertain if each company is:

  • A reasonably definitive match with an existing organization in OMX, in which case that organization will be automatically pinned, although you will have an opportunity to override that match.
  • A possible match with an existing organization in OMX, in which case you will have an opportunity to confirm whether the match is or is not correct
  • Not a match with any organization in OMX, in which case the organization will be added on your behalf and then automatically pinned

Important

Although not all available columns are mandatory, it is strongly recommended that the company data you upload contain as many attributes as possible. Uploading a minimum of attributes will decrease the number of automatic matches against existing organizations in the OMX database, which will decrease the quality of your experience in OMX.

Please take the time to create a robust, attribute-rich dataset before uploading to OMX.

File Requirements

  • Maximum file size is 5MB
  • Maximum rows per file is 1,000
  • File must have a CSV file extension
  • File must have a text MIME type
  • Header rows are optional, but if present must match the column names exactly
  • Columns must be in the same order as in the "Column Requirements" section

Column Requirements

Column Mandatory? Format Max Length Comments
company_name Yes Text 100
duns No Numeric 9
lei No Text 20
website Yes URL 100
phone Yes Numeric 15 Must only contain integers
street_address Yes Text 100
city Yes Text 50
province_state No Text 50
country_code Yes Text 2 Must be a valid two-letter ISO country code
postal_code No Text 10
spend_level No Text 10 Must be one of the following values: "low", "medium", "high", "critical"
employees_total No Numeric Must be an integer greater than or equal to 0
annual_sales No Numeric Value must be in thousands of USD. Must be greater than or equal to 0
aboriginal_owned No Text 3 Must be one of the following values: "Yes" or empty
aboriginal_led No Text 3 Must be one of the following values: "Yes" or empty
women_owned No Text 3 Must be one of the following values: "Yes" or empty
women_led No Text 3 Must be one of the following values: "Yes" or empty
lgbtq_owned No Text 3 Must be one of the following values: "Yes" or empty
lgbtq_led No Text 3 Must be one of the following values: "Yes" or empty
veteran_owned No Text 3 Must be one of the following values: "Yes" or empty
veteran_led No Text 3 Must be one of the following values: "Yes" or empty
minority_owned No Text 3 Must be one of the following values: "Yes" or empty
minority_led No Text 3 Must be one of the following values: "Yes" or empty
external_id No Text 20

What Happens When a Company is Uploaded

The uploader first validates that the file is properly formatted. If it finds errors, it reports the first few and asks you to fix the file (and any identical subsequent errors) before re-uploading. If the file is valid, each company is then used to search for a matching company in the database. Where possible matches are found, those matches are presented to the uploading user to confirm. If a company can't be matched, a new company is created. When a new company is created, the company name, location, website, LEI code, etc. are used to create that company in the database. Further, if a pin or tag has been specified, that pin or tag is applied on behalf of the uploading user.

No existing company data is overwritten as part of the uploading process.

Abuse

Although validation errors are allowed, errors which result from what appear to be deliberate attempts to inject false data or malware into OMX, or to break or compromise OMX in any way, will cause the offending user and company to be banned, and may also result in legal redress.

Please Contact Us

Although every effort has been made to ensure that this documentation accurately reflects the process for company upload in OMX, please advise us if you discover any discrepancies.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published