SharinPix Imports Requirements

This article outlines the requirements for the following SharinPix imports:

• Image import

• Tag migration

• Tag bulk deletion

Required Import Information

Mass image imports and tag migrations is recommended to be performed by the SharinPix team.

For such imports, kindly contact the SharinPix support team first at [email protected] with:

1. A description of the import you want to achieve.

2. The number of records/ images/tags included.

3. The average image size if applicable.

Once the import is validated by our team, you will need to provide the following additional information:

• Your organization ID.

• A CSV file including all your import data. Please refer to the Image Import, Tag Migration, Tag Bulk Deletion sections for more information on the CSV file format in each case.

• Your organization's API limit.

• Kindly also state if tag action or image sync be launched after the import.

Note:

For small volume imports, the SharinPix package already includes Apex methods that you can easily run on your side. Some of these methods are:

• uploadAttachment : Uploads Salesforce attachments to SharinPix albums.

• uploadContentDocument : Uploads Salesforce ContentDocuments to SharinPix albums.

• uploadFromUrl : Uploads an image to SharinPix using an URL.

For more information on how to call the above methods and other SharinPix import Apex methods, please refer to the following article: Utils methods

Image Import

Image Import from Storage to SharinPix

For image imports from your storage (for example Amazon S3) to SharinPix, the CSV file should include the following columns:

• album_id : The album_id column should contain the 18-digit record ID (which also corresponds to the album id) on which you want the image to be uploaded.

• url : The url column should contain the public image URLs as appeared in your storage.

• tags : The tags column should contain the tag or tags to be applied to each image. If two or more tags should be applied, please ensure that all tags are added in a single cell and separated by commas as follows: tag1,tag2,tag3

Image Import from Salesforce Content Document to SharinPix

For image imports from Salesforce files to SharinPix, the CSV file should include the following columns:

• album_id : The album_id column should contain the 18-digit record IDs (which also correspond to the album IDs) on which you want the image to be uploaded.

• content_document_id : The content_document_id column should contain the 18-digit Content Document record IDs

• tags : The tags column should contain the tag or tags to be applied to each image. If two or more tags should be applied, please ensure that all tags are added in a single cell and separated by commas as follows: tag1,tag2,tag3

Tag Migration

For tag migrations from one organization to another, the CSV file should include the following columns:

• Id : The Id column should contain the IDs of tags to be migrated.

• Name : The Name column should contain the tags' technical name.

• Label : The Label column should contain the tags' labels.

• Public : The Public column indicates if the tag should be public or not. Note: This column can only contain true or false as values since Public field is of type boolean.

• Listed : The Listed column indicates whether the tags should be made available in your organization or not. Note: This column can only contain true or false as values since Listed field is of type boolean.

• Visible : The Visible column indicates if the tags should be visible within your organization or not. Note: This column can only contain true or false as values since Listed field is of type boolean.

• Color : The Color column should contain the tags' label color in Hex format.

• Allow download : The Allow download column indicates if the tags should be allowed for download or not. Note: This column can only contain true or false as values since Listed field is of type boolean.

Note:

The SharinPix Global Settings has a Download: CSV option at the bottom of the tags page that enable users to download a CSV file containing all tags included in the organization along with all columns required for tag migrations.

Tag Bulk Deletion

For tag bulk deletions, only Id column is required. The Id column should contain the IDs of all tags to be deleted.

Tip:

You can make use of the SharinPix Global Settings' Download: CSV option located at the bottom of the tags page to retrieve the desired tag IDs.