Skip to content

Commands

Nathan Dickerson edited this page Aug 30, 2016 · 26 revisions

###Load

Using the "load" command you are able to insert new records and update existing records in the Bullhorn CRM. To load a csv file using dataloader you will need to have the name of the supported entity you are loading at the beginning of the csv file name (eg Candidate.csv, ClientContactForDataLoader.csv). If the entity name is not specified at the beginning of the file name an unknown entity error will occur.

Within the csv file have as many or as few fields populated in order to have a successful load. A list of fields required by the Bullhorn REST API can be found here.

###Delete

###ConvertAttachments

The convertAttachments command gives the capability to convert a locally stored file to html. The supported file types that can be converted are: txt, doc/x, opend, odt, rtf, html and pdf. The format of the CSV dataloader will be reading from is identical to the format of the CSV for LoadAttachments.

When convertAttachments is run, a new folder will be created named convertedAttachments. Within this folder a subfolder will be created which will be named after the entity these converted attachments are to be associated to. Within this entity folder will be the converted attachments. The name of each attachment will be the same as the externalID of the record to which the attachments will be associated, which needs to be associated in the CSV dataloader reads from.

This action will need to be followed by the load command. When the load command is run, dataloader will check the convertedAttachments folder that was created and load any converted attachments that match an externalID in the CSV being read from.

All converted attachments will be pasted into the description field of the entity. Currently, the only supported entities to load converted attachments are Candidates, ClientContacts and ClientCorporations.

###LoadAttachments

The loadAttachments command allows you the ability to load a file stored locally to an existing record in the Bullhorn CRM. Within the CSV, the relativeFilePath column of the file attachment you are uploading and attaching must be specified along with the selector field (for example: candidate.externalID) of the parent entity the attachment is to be associated with. Note that since the attachment process is updating parent entity and not inserting a new entity, the <Entity>ExistField in the properties file must be set. The <Entity>ExistField property must match a column in the CSV file. An example of this format can be seen in the examples/loadAttachments folder. Before the CandidateAttachFile.csv example will work, uncomment the line: candidateExistField=externalID in the properties file.

###DeleteAttachments

###Help

When the help command is invoked a list of suggested actions will be returned and the format required for each action.

Clone this wiki locally