The following instructions for metadata job setup assume basic familiarity with CFP account mapping. Please consult elsewhere in the knowledgebase for information on account mapping.
Job Configuration: Metadata Map Generation
- Create an account mapping job as you normally would. You must use the new map flow; contact email@example.com to add this to your account if you do not have it. When you get to the Source and Target Accounts screen, you will have the option to upload your metadata .csv file in the Specifying Metadata Box.
- Upload one or more .csv files that contain your metadata. See Account Mapping – Metadata Job Preparation for details on creating the .csv file.
- Continue to generate your mapping as usual. You may select data for transfer in addition to the files that will contain metadata.
Metadata Spreadsheet Editing
- When the map generation is complete, complete the user and group mappings as you normally would.
- You will see a tab in the spreadsheet called ‘Metadata CSV To Templates.’ This is the tab where you will match metadata fields on the source to metadata fields on the target.
- The fields from your source .csv’s can be matched to any template fields created on the target. Here’s a sample:
- You must specify the data type for each metadata item in the Source Data Type Column:
- number for numbers
- string for text or dropdown field (enum) types
- date for dates. If you specify date for the Source Data Type, you must also specify a Source Date Format in the next column. See the section “How to Specify Dates” below.
- Additionally, you must ensure that the metadata in your spreadsheet is compatible with the Source Data Type. For example, if you have a format of number specified, none of the metadata for that particular field can contain letters in any of your files.
How to Specify Dates in Source Date Format Field
CFP supports the following date formats:
|SOURCE DATE FORMAT||SUPPORTED FORMATS:||EXAMPLE DATE|
|RFC3339||%Y-%m-%dT%H:%M:%S.%f%Z, %Y-%m-%dT%H:%M:%S%Z, %Y-%m-%dT%H:%M:%S.%fZ, %Y-%m-%dT%H:%M:%SZ. Time is required.||2017-06-15T13:05:44.12EST.|
|ISO8601||same as formats listed for listed for RFC3339; time parameters and time zone are optional.||2017-06-15|
|Custom strings. Sample entry:
%b %d, %Y
|Any date string compliant with strftime.||Jun 15, 2017|
See the Python strftime docs for additional information on date formats.
- You’ll note one field at the end of the listing for each .csv file that you load: Source Path, which is mapped to a field from the Standard template. That is an internal CFP template; you won’t find it in Box. You must have a line for Source path from the Standard template for each .csv that you have uploaded.
- For jobs whose source is a multi account filesystem such as Dropbox, you’ll see a second field, Source Owner, listed for each source template. It will also be from the Standard template. You must retain this row in the spreadsheet for it to validate. You will not see this row for shared filesystems such as Windows, but you can add it if you wish.
- When you have completed editing your spreadsheet, upload it and allow it to validate. You then run your job as usual.
- When the job completes, you can click on a file in Box, and under the Info tab, it will contain your metadata.