Overview
Overview
Google Drive is a Cloud-Based Storage Solution that allows you to save files online and access them anywhere from any smartphone, tablet, or computer. Drive also makes it easy for others to edit and collaborate files. OneDrive is the Microsoft Cloud service that connects you to all the files. It lets you store and protect the files and get to them from anywhere on all your services.
The features provided by the Drive library are as follows:
Drive Operations: FindDriveItem, CreateDriveFolder and Connect Drive
Downloading and Uploading: DownloadDriveFile and UploadDriveFile
Moving, Deleting and Sharing: CopyDriveItem, MoveDriveItem, DeleteDriveItem and ShareDriveItem
Common properties
Common properties
MORE OPTIONS
Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
On Error | Combination box | N | - | N | Specify an action to carry out when an error occurs at the time of execution. - --Ignore--: Ignore the error. - --Retry--: Try the activity one more time. - --Goto--: Try the scenario for the specified time if the activity fails. - _Event: Select an event created within the project. |
DESCRIPTION
Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|
DESCRIPTION | Text | N | - | N | Enter the description for the activity card. The Description entered in the DESCRIPTION field is used as an description of the property. A representative value will be displayed in the absence of the DESCRIPTION input. |
ConnectDrive
ConnectDrive
Overview
This activity cards initiate authentication for the Drive you want to connect to.
Application procedures
In the [Output] Result field, enter the variable to store the connection information.
In the ServiceDrive field, select the drive (GoogleDrive) to connect.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|---|
N | [Output] RESULT | Variable | Y | - | N | Enter the variable to store the connection information. |
N | ServiceDrive | Select Box | Y | - | N | Select the drive you want to connect.(ex. 'GoogleDrive') |
N | AuthenticationType | String | Y | - | N | Select the type of authentication you want to use to access the Drive service. The following options are displayed for GoogleDrive:- OAuth2ClientID (attended) and - ServiceAccoutKey (unattended) |
N | CientID | String | If DriveName is GoogleDrive and AuthenticationType is OAuth2ClientID (attended), Y else, N | - | N | Enter the credential ID of the user account. |
N | ClientSecret | Secure String | If DriveName is GoogleDrive and AuthenticationType is OAuth2ClientID (attended), Y else, N | - | N | Enter the credentials secret of the user account password. - Normal: The password input is saved as a plain text. - Credential: The password input is encrypted and retrieved from shared resources. - Secure: The password input is encrypted for saving. |
Y | - | - | - | - | Common properties of Drive Library. | |
Y | - | - | - | - | Common properties of Drive Library. |
Example of utilization
Connect to Google Drive using ConnectDrive.
Sample file
Menu > Help > Samples > Sample > Drive > P_ConnectDrive_GoogleDrive_Test
Used variables
this.connection = Variable to store connection information
this.clientId = Client Id for the drive account
Used properties
[Output] = this.connection
SeviceDrive = Google Drive
Autenticationype = 0Auth2ClientId (attended)
ClientId = this.clientId
ClientSecret = Enter the password
Related/Similar activities
UploadDriveFile, DownloadDriveFile
ConnectDrive (OneDrive)
Overview
This activity cards initiate authentication for the Drive you want to connect to.
Application procedures
In the [Output] Result field, enter the variable to store the connection information.
In the ServiceDrive field, select the drive (OneDrive) to connect.
In the ApplicationId field, enter the application (client) ID assigned by the Azure active folder.
The unique application (client) ID assigned by the Azure Active Folder when you registered your app during Setup. The application (client) ID represents an instance of a Microsoft Office 365 application. A single organization can have multiple application (client) IDs for their Microsoft Office 365 account. Each application (client) ID contains its own permissions and authentication requirements.
The unique Folder (tenant) ID assigned by the Azure Active Folder when you registered your app during Setup. Required for multi-tenant applications. The Folder (tenant) ID can be found in the overview page of your registered application (under the application (client) ID).
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Discription |
---|---|---|---|---|---|---|
N | [Output] RESULT | Variable | Y | - | Y | Enter the variable to store the connection information. |
N | ServiceDrive | Select Box | Y | - | N | Select the drive you want to connect.OneDrive |
N | AuthenticationType | String | Y | - | N | Select the type of authentication you want to use to access the Drive service. The below options are displayed for One Drive: - InteractiveToken(attended) - UserAccountandPassword(unattended) |
N | ApplicationID | String | Y | - | N | Enter the application (User) ID . |
N | Tenant | String | Y | - | N | Enter the Tenant ID. |
N | UserAccount | String | Y | - | N | Enter the microsoft office 365 account. |
N | Password | String | Y | - | N | Enter the passoword of microsoft office 365 account. |
Y | - | - | - | - | Common property of Drive library. | |
Y | - | - | - | - | Common property of Drive library. |
Example of utilization
Connect to One Drive using ConnectDrive.
Sample file
Menu > Help > Samples > Sample > Drive > P_ConnectDrive_OneDrive_Test
Used variables
this.connection = Variable to store connection information
this.ApplicationId = ApplicationId assigned by the Azure active folder
this.Tenant = TenantId assigned by the Azure active folder
Used properties
[Output] Connection = this.connection
ServiceDrive = One Drive
AuthenticationType = Interactive Token (attended)
ApplicationId = this.ApplicationId
Tenant = this.Tenant
Related/Similar activites
UploadDriveFile, DownloadDriveFile
FindDriveItem
FindDriveItem
Overview
This activity card find the files, metadata, and contents that match the values of your search parameters on Drive and returns the file information, including the name, size, and ID.
Application procedures
1. In the [Output] RESULT field, enter the variable to store the information. 2. In the [Input] Connection field, enter the variable of the connection.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|---|
N | [Output] Result | Variable | Y | - | N | Enter the variable to store the information. |
N | [Input] Connection | Variable | Y | - | Y | Enter the variable in which the connection information is stored. |
N | SearchFolderID | String | N | - | N | Enter the folderID. |
N | SearchExperssion | String | N | - | Y | Enter the search parameters to locate files and folders. |
N | Searchtype | Select Box | Y | - | Y | Select to search only: Files, Folders, or Files and Folders |
N | ResultType | Select Box | Y | - | Y | Select whether to return: Id, or Object |
N | ResultMaxNumber | Int | N | - | N | Enter the maximum number of files and folder that should be returned. |
N | Index | Int | N | - | N | Enter a zero-based Index that specifies which element of current collection is being iterated. |
Y | - | - | - | - | Common property of Drive library. | |
Y | - | - | - | - | Common property of Drive library. |
Example of utilization
After connecting to Drive, upload a file and find the corresponding item.
Sample file
Menu > Help > Samples > Sample > Drive > P_FindDriveItem_Test
Used variables
RESULT = Variable to store the output information
this.connection = Variable to store connection information
this.searchFolderId = Variable to search the Folder Id
this.searchExpression = Variable to search parameters
Used properties
[Output] Result = RESULT
[Input] Connection = this.connection
SearchFolderID = this.searchFolderId
SearchExpression = this.searchExpression
SearchType = Files
ResultType = Id
ResultMaxNumber = this.resultMaxNumber
Index = this.index
Related/Similar activities
CreateDriveFolder
CreateDriveFolder
Overview
This activity card creates a new folder on Drive.
Application procedures
In the [Output] FolderId field, enter the variable to store the folder Id.
In the [Input] Connection field, enter the variable of the connection to create the folder.
In the NewFolderName field, enter a string variable to create a new folder name.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|---|
N | [Output] FolderId | Variable | Y | - | Y | Enter the variable to store the folder Id. |
N | [Input] Connection | Variable | Y | - | N | Enter the variable of the connection to create Folder. (Default: RESULT, refers to the connection that is currently connected.) |
N | NewFolderName | String | Y | - | N | Enter a string variable to create a NewFolderName. |
N | TargetFolderID | String | N | - | N | Enter the name of the parent folder. |
Y | - | - | - | - | Common property of Drive library. | |
Y | - | - | - | - | Common property of Drive library. |
Example of utilization
Connect to drive using the ConnectDrive card, create a new folder in drive using CreateDriveFolder card, and upload the file in the drive.
Sample file
Menu > Help > Samples > Sample > Drive > P_CreateDriveFolder_Test
Used variables
this.connection = Variable to store connection information
this.folderId = Variable to enter the Id
this.targetFolderId = Variable to enter the Id of parent folder
this.newFolderName = Variable to enter the new folder name
Used properties
[Output] FolderId = this.folderId
[Input] Connection = this.connection
TargetFolderId = this.targetFolderId
NewFolderName = this.newFolderName
Related/Similar activities
DownloadDriveFile
DownloadDriveFile
Overview
This activity card downloads the specified file from Drive to the specified local path.
Application procedures
In the [Input] Connection field, enter the variable for the connection to download file.
In the FileId field, enter the Id of the file to be downloaded.
In the LocalDirPath field, enter the path of the file to be downloaded.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|---|
N | [Input] Connection | Variable | Y | - | N | Enter the variable for the connection to download file. (Default : RESULT. It refers to the connection that is currently connected.) |
N | FileId | String | Y | - | N | Enter the Id of the file to be downloaded. |
N | LocalDirPath | String | Y | - | N | Enter the local path of the file to be downloaded. |
N | OverWrite | Toggle button | N | - | N | Select whether to overwrite the download file. (Default : Not Use - gray) |
Y | - | - | - | - | Common property of Drive library. | |
Y | - | - | - | - | Common property of Drive library. |
Example of utilization
Connect to drive using the ConnectDrive card, upload the file in the drive. And then download the file.
Sample file
Menu > Help > Samples > Sample > Drive > P_DownloadDriveFile_Test
Used variables
this.connection = Variable to store connection information
this.fileId = Variable to input Id of the file
this.LocalDirPath = Variable to input the local path of directory to download the file
Used properties
[Input] Connection = this.connection
FileId = this.fileId
LocalDirPath = this.localDirpath
Overwrite = On
Related/Similar activities
UploadDriveFile
UploadDriveFile
Overview
This activity card uploads a file to the Drive.
Application procedure
In the [Output] UploadedFileId field, enter the uploaded file Id.
In the [Input] Connection field, enter the variable of connection to upload a file.
In the LocalFilePath field, enter the full path of local files that are to be uploaded.
In the TargetFolderID field, to upload the file enter the Id of the parent folder.
Card properties
Common | Properties | Type | Required | Unit | Auto-Setting | Description |
---|---|---|---|---|---|---|
N | [Output] UploadedFileId | Variable | Y | - | Y | Enter a variable to store the uploaded file ID. |
N | [Input] Connection | Variable | Y | - | N | Enter the variable connection to upload a file. (Default: RESULT, refers to the connection that is curently connected.) |
N | LocalFilePath | String | Y | - | N | Enter the path to the file to be uploaded |
N | TargetFolderID | String | Y | - | N | Enter the Id of the parent folder to upload the file. |
N | Force | Toggle button | N | - | N | Select whether to upload any existing file with the same name in the path. |
Y | - | - | - | - | Common property of Drive library. | |
Y | - | - | - | - | Common property of Drive library. |
Example of utilization
Connect to the drive using the connect drive card and upload the files to the drive.
Sample file
Menu > Help > Samples > Sample > Drive > P_UploadDriveFile_Test
Used variables
this.uploadedFileId = Variable to upload the file Id
this.connection = Variable to store connection information
this.localFilePath = Variable to input the full path of local files to uploaded
this.targetFolderId = Variable to enter the Id of parent folder
Used properties
[Output] UploadedFileId = this.uploadedfileId
[Input] Connection = this.connection
LocalFilePath = this.localFilePath
TargetFolderId = this.TargetFolderId
Force = On
Related/Similar activities
CopyDriveItem
CopyDriveItem
Overview
This activity card copies a file or folder on Drive.
Application procedure
In the [Output] CopiedItemId field, enter the variable to store the copied file or folder.
In the [Input] Connection field, enter the variable of connection to copy a file.
In the ItemId field, enter the Id to copy the file or folder.
In the TargetFolderID field, enter the folder Id to copy the Item.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|---|
N | [Output] CopiedItemId | String | Y | - | Y | Enter the variable to store the copied file or folder. |
N | [Input] Connection | Variable | Y | - | N | Enter the variable of connection to copy a file. (Default: RESULT refers to the connection that is currently connected.) |
N | ItemId | String | Y | - | N | Enter the Id of file or folder to copy. |
N | TargetFolderID | String | N | - | N | Enter the ID of the parent folder of the file or folder to be copied. |
N | Force | Toggle button | N | - | N | Select whether to copy any existing file with the same name and path. |
Y | - | - | - | - | Common property of Drive library. | |
Y | - | - | - | - | Common property of Drive Library. |
Example of utilization
Connect to drive using the connect drive card, uploaded the file in the drive. And copy the file to the target folder.
Sample file
Menu > Help > Samples > Sample > Drive > P_CopyDriveItem_Test
Used variables
this.connection = Variable to store connection information
this.itemId = Variable to copy the file
this.targetFolderId = Variable to enter the Id of parent folder
Used properties
[Output] CopiedItemId
[Input] Connection
ItemId = this.ItemId
TargetFolderId = this.targetFolderId
Force = Off
Related/Similar activities
MoveDriveItem
MoveDriveItem
Overview
This activity card moves a file or folder on Drive under another folder.
Application procedures
In the [Output] MovedItemId field, enter the variable to store the new file or folder to be that is moved.
In the [Input] Connection field, enter the variable of the connection to move a file.
In the ItemId field, enter the Id to move the file or folder.
In the TargetFolderID field, enter the folder Id to move the item.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|---|
N | [Output] MovedItemId | String | Y | - | Y | Enter the variable to store the new file or folder to be that is moved. |
N | [Input] Connection | Variable | Y | - | N | Enter the variable for the connection to move a file. (Default: RESULT refers to the connection that is currently connected.) |
N | ItemId | String | Y | - | N | Enter the Id to move the file or folder. |
N | TargetFolderID | String | N | - | N | Enter the ID of the parent folder of the file or folder to be moved. |
N | Force | Toggle button | N | - | N | Select whether to move any existing file with the same name and path. |
Y | - | - | - | - | Common property of Drive library | |
Y | - | - | - | - | Common property of Drive library. |
Example of utilization
Connect to drive using the connect drive card, upload the file in drive, and move the file to the target folder.
Sample file
Menu > Help > Samples > Sample > Drive > P_MoveDriveItem_Test
Used variables
this.connection = Variable to store connection information
this.itemId = Variable to copy the file
this.targetFolderId = Variable to enter the Id of parent folder
Used properties
[Output] MovedItemId = this.moveItemId
[Input] Connection = this.connection
ItemId = this.ItemId
TargetFolderId = this.targetFolderId
Force = Off
Related/Similar activities
DeleteDriveItem
DeleteDriveItem
Overview
This activity card deletes a specified file or folder from a Drive.
Application procedures
In the [Input] connection field, enter the variable of the connection to delete the file.
In the ItemId field, enter the Id to move the file or folder.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|---|
N | [Input] connection | Variable | Y | - | N | Enter the variable of the connection to delete the file. (Default: RESULT refers to the connection that is currently connected.) |
N | ItemId | String | Y | - | N | Enter the Id of file and folder to delete. |
Y | - | - | - | - | Common property of Drive library. | |
Y | - | - | - | - | Common property of Drive library. |
Example of utilization
Connect to drive using the connect drive card, upload the file in drive, and delete the file from the drive.
Sample file
Menu > Help > Samples > Sample > Drive > P_DeleteDriveItem_Test
Used variables
this.connection = Variable to store connection information
this.itemId = Variable to copy the file
Used properties
[Input] Connection = this.connection
ItemId = this.itemId
Related/Similar activities
ShareDriveItem
ShareDriveItem
Overview
This activity card shares a file or folder with the specified recipients.
Application procedures
In the [Output] ItemPermission field, enter the variable for storing the granted permissions of file or folder.
In the [Input] connection field, enter the variable of the connection to share the file.
In the ItemId field, enter the Id of file or folder to share.
Card properties
Common | Properties | Type | Required | Unit | Auto-setting | Description |
---|---|---|---|---|---|---|
N | [Output] ItemPermission | Variable | Y | - | N | Enter the variable for storing the granted permissions of file or folder. |
N | [Input] Connection | Variable | Y | - | N | Enter the variable of the connection to share the file. (Default: RESULT refers to the connection that is currently connected.) |
N | ServiceDrive | Combo box | Y | - | N | Select the drive to connect. Google Drive, One Drive |
N | ItemId | Variable | Y | - | N | Enter the Id of file or folder to share. |
N | Garantee Type | Combo box | Y | - | N | Select the recipient to grant the file permissions.(***If connection is GoogleDrive, the below options are shown) User - grants permission to a single user. Group - grants permission to a group.Domain - grants permission to a domain. Anyone - grants permission to anyone with access to the company domain. (***If Connection is OneDrive the below options are shown) Anyone, PeopleInOrganization, and SpecificPeople. |
N | Recipient | String | ① (connection is GoogleDrive and GuaranteeType value is user or group ) or ② (connection is OneDrive and GaranteeType is SpecificPeople), In case of ①, ②, Y, else N | - | N | Enter the email address of specific recipients to recieve access. (In the case of ① and ②, the properties are displayed.) |
N | Domain | String | If connection is GoogleDrive and GuaranteeType value is Domain, Y else N | - | N | Enter the domain to grant file permission. (***If connection is GoogleDrive and GuaranteeType value is Domain, this property is displayed.) |
N | GaranteePermission | Select Box | Y | - | N | Select the file permissison role to grant the recipient. (***If connection is GoogleDrive, the below options are shown) Reader - the entity can read and download the file. Writer - the entity can edit the file. Owner - the entity owns the file. View and Edit. |
Y | - | - | - | - | Common property of Drive library. | |
Y | - | - | - | - | Common property of Drive library. |
Example of utilization
Connect to drive using the connect drive card, upload the file in drive, and share the drive.
Sample file
Menu > Help > Samples > Sample > Drive > P_ShareDriveItem_Test
Used variables
this.itemPermission = grants the permission of file or folder
this.connection = Variable to store connection information
this.itemId = Variable to copy the file
Used properties
[Output] ItemPermission = this.itemPermission
[Input] Connection = this.connection
ServiceDrive = Google Drive
ItemId = this.itemId
GaranteeType = anyone
GaranteePermission = writer
Related/Similar activities