uploadSBDF(filePath, libraryDir, libraryFile=basename(filePath), libraryURL, clientID, clientSecret, accessToken, description=paste("Uploaded from", filePath), overwrite=FALSE, verbose=FALSE)
filePath | a character string specifying the file name of the Spotfire Binary Data File (SBDF) file to upload. |
libraryDir | a character string specifying the directory name on the Spotfire Server where the uploaded file is stored. |
libraryFile | a character string specifying the file name in libraryDir for the uploaded file. If not given, the name defaults to the base file name of filePath. |
libraryURL | a character string specifying the URL for the Spotfire Server, which usually has the form "https://mytss/spotfire". |
clientID | a character string specifying a "client ID": A long string of random characters generated by the Spotfire Server when registering the access API. |
clientSecret | a character string specifying a "client secret": a long string of random characters generated by the Spotfire Server when registering the access API. |
accessToken | a character string specifying an "access token": a long string of random characters generated by the Spotfire Server after authenticating a user name and password, and authorizing the user to upload an SBDF file. |
description | a character string decribing the SBDF file which is associated with the uploaded SBDF file in the library. |
overwrite | a logical value. If FALSE, an error occurs if you attempt to upload a file to a library, and a file by that name already exists. If TRUE, does not give an error, but simply overwrites the existing file. |
verbose | a logical value. If TRUE, extensive messages are printed during the uploading process. |
Note: The name "SBDFUploadClient" can be any name. Also, the user must set the permissions for the upload library directory so that the client ("SBDFUploadClient" in the above example) can browse, access, and modify it.
Note: An access token produced by OAuth2 authentication has a limited lifetime (such as only an hour or two), after which passing it to uploadSBDF generates an error.
## Not run: ## uploading to /mydir/xyz.sbdf using clientID/clientSecret uploadSBDF("c:/temp/xyz.sbdf", "/mydir", libraryURL="http://mytss/spotfire", clientID="cd24...", clientSecret="b7eb9...")## uploading to /mydir/foo using accessToken, ## possibly overwritting, giving a description uploadSBDF("c:/temp/xyz.sbdf", "/mydir", "foo", libraryURL="http://mytss/spotfire", accessToken="eyJraWQ...", description="my foo data", overwrite=TRUE) ## End(Not run)