PowerShell Script for File Uploads
This Powershell script is an open source example of how you can upload files from Powershell into Aprimo. This script file is provided as-is and if you need support in running or changing it, contact your Aprimo Customer Success Director and ask to be put in touch with our technical services group for assistance.
This PowerShell script allows you to upload files from a folder to Aprimo DAM. The script can be executed manually or you could use a service such as the Windows Task Scheduler. This script is not executed in the Azure environment but runs on a local server.
For the upload, the script will use the MO REST API (for authentication) and the Aprimo DAM REST API.
Transfers occur over HTTP and will be limited by the upload bandwidth you have available. If you have concerns about ingesting large sets (>10GB) of assets, please contact your Aprimo representative to discuss ingestion options.
PowerShell 4 – 6, windows only. PowerShell 7 support coming soon.
In order for the shell script to work, you have to add the Aprimo DAM URL, MO client ID and authentication token to the app.config file.
The client ID and token must be set up in MO upfront. See MO REST API authentication for more information.
Once you have the necessary information, you can fill out the app.config file:
<?xml version="1.0" encoding="utf-8"?> <configuration> <appSettings> <add key="endpointUri" value="https://yourcompany.dam.aprimo.com" /> <add key="uploadserviceUri" value="https://yourcompany.aprimo.com" /> <add key="authorization" value="[Auth Token]" /> <add key="clientId" value="[Client ID]" /> <add key="logDir" value="C:\scriptlog" /> <add key="logLevel" value="Info" /> </appSettings> </configuration>
The app config file also contains two keys for logging:
- logDir: The destination folder for the log files.
- logLevel: The log level. Valid values are
A sample call for the script:
Aprimo.HotFolderService.ps1 -Path C:\hotfolder -Classification 76f6824d83fc4c7d9440a8630103419c -ClassifySubFolders -ActionOnSuccess DeleteFile -FailedFilesFolder C:\failed -MetaDataFile "C:\HotFolder\metadata.csv" -MetaDataSchema "example1"
Aprimo.HotFolderService.ps1 command accepts the following parameters:
- Path: the path to the folder to scan
- Classification: (Optional) the Id (guid) of the root classification to link the new records to, typically a waiting room or temporary classification. If you specify a classification here, make sure it doesn’t overlap with any classifications that are added via the default value of synchronized Classification List fields!
- ClassifySubFolders: (Optional) add this parameter if you want to create a classification structure based on the folder structure of the path you specified. This structure will be created under the classification you specify, and the new records will be linked to the resp. classification.
- ActionOnSuccess: indicates what should happen to the file after it has been uploaded successfully. Possible values:
- Nothing: leaves the file in place
- DeleteFile: deletes the file
- DeleteBase: deletes all files with the same base name (i.e. filename without extension). This isuseful if you provide metadata in separate files, one for each file that should be uploaded. See Metadata Upload for more information.
- FailedFilesFolder: (Optional) when specified, indicates where to move files that failed to upload
- MetaDataFile: (Optional) specifies the location of a CSV file that contains the metadata of the files, if the metadata file is not located in the same folder as the files themselves. See Metadata Upload for more information.
- MetaDataSchemaName: (Optional) the schema to be used for parsing the metadata, if you also want to upload metadata. See Metadata Upload for more information.
How it works
The script works as follows:
- Upon execution, the script scans one root folder (
Pathparameter) and all subfolders for files.
- For every detected file, a record is created
- in the root classification if the
Classificationparameter is specified
- or in a subclassification that matches the file’s parent folder name if the
ClassifySubFoldersparameter is specified. The subclassification will be created if it doesn’t exist yet.
- or as a draft record if no
Classificationparameter is specified. In that case, the
ClassifySubFoldersparameter is ignored and the draft record will appear on the My uploads page.
- in the root classification if the
- If the MetaDataFile parameter is specified, Aprimo DAM will try to map the metadata in the specified CSV file to fields/properties on the record. See Metadata Upload for more information.
- Files that have been processed are removed or stay in the folder (
- When a file fails to upload, it stays in the folder by default. It can optionally be moved to a failure folder (
The script offers 3 ways to associate metadata with the files you upload:
- Pass the path to the metadata file as a parameter when executing the script. See Script execution
- Add a metadata file for each file you want to upload. Their base name should be identical.
- Add one metadata file for all files in a folder.
The script uses the following logic:
- Check if the path of the metadata file is passed as a parameter to the script.
- If not, check whether the uploaded file has a metadata file with the same base name.
- If not, check whether the folder contains a generic metadata file and whether the filename of the uploaded file appears in it. No record is created if more than one generic metadata file is found: the file is placed in the Failed Files folder.
See Metadata Upload for more information regarding the format, file type, schema etc. to use for metadata upload.