Filesystem Resource¶

A Filesystem connection is a set of connection parameters needed to perform download/upload operations using a remote file location.

This connection can be stored in two ways:

related to the object which is going to use it (Custom source option)
as a Rulex Platform Resource of Filesystem type (Saved source option), which can be used at any time and in any operation.

If this connection is stored as a Filesystem resource, the user can define a set of permissions linked to this resource (as explained in the permissions page) to limit/control the access other users can have on the inserted connection.

To use a Filesystem resource in any panel, a filesystem connection is required, and the user must have view permissions set to allow on the resource itself, while modify permissions are required to see its internal parameters.

Tip

By creating a Filesystem resource with view permissions for all users and modify permission only for the administrator, you are exposing a connection without sharing username and password used in the authentication procedure.

Filesystem connection configuration¶

Rulex Platform supports the following remote locations:

The configuration interface and its parameters vary for every filesystem type. Further details are listed in the paragraphs below.

Note

The Local Filesystem file location is considered as a filesystem, and it corresponds to the client machine disk. As this filesystem doesn’t require any connection parameter, it is available only as a Custom connection. To use the Local Filesystem in Rulex Platform Cloud/server version, you can find more information in this note.

Warning

Rulex’s technical documentation does not and cannot provide comprehensive guidelines on the use, limitations and constraints of third-party software programs, beyond how Rulex integrates with this software.

Please read the technical documentation of the third-party software itself for up-to-date information.

Sharedrive File System

This connection allows Rulex Platform to connect to Samba or NFS share drive, reachable from the hosting machine or from the cloud/server.

The connection parameters needed for this connection are listed in the following table (parameters in bold are mandatory). To define a Custom connection to a Sharedrive Filesystem in Rulex Platform API calls, the user must specify the value sharedrive in the uri field.

Name	Description	API param key	Default
Protocol	The ShareDrive protocol. The possible values are: Samba (SMB2/3) protocol, Network File System (NFS3/4) protocol.	auth
Host	The server host of the chosen share drive location. Available only if Samba (SMB2/3) protocol has been chosen.	host
Port	The server port of the chosen share drive location. Available only if Samba (SMB2/3) protocol has been chosen.	port	445
Server	The server of the chosen share drive location. Available only if Network File System (NFS3/4) protocol has been chosen.	url
Username	If an authentication is required, enter the username exchanged with the share drive server.	username
Password	If an authentication is required, enter the password exchanged with the share drive server.	password
Path	The path of the share drive location. Available only if Network File System (NFS3/4) protocol has been chosen.	path
Domain	The domain the share drive location owns, if available.	domain
Share	In Samba Share drive any server can contain more than one exposed share drive. The user must specify which server Rulex Platform must connect to.	share

Http/s Server

This connection allows Rulex Platform to perform primarily Web/SOAP/REST API calls towards any HTTP/S Server, reachable from the hosting machine or from the cloud/server.

The connection parameters needed for this connection are reported in the following table (parameters in bold are mandatory). To define a Custom connection towards an HTTP/S Server in Rulex Platform API calls the user must specify the value http in uri field.

Name	Description	API param key	Default
Authentication	The authentication type to use in contacting the HTTP/S Server. The possible values are: Basic Authentication (basic): the user performs a Basic Authentication by inserting the required username and password. NTLM Authentication (ntlm): the user performs a NTLM Negotiation to the server by inserting the required username and password. Digest Authentication (digest): the user performs a Digest Negotiation to the server by inserting the required username and password. Bearer Authentication (bearer): the user adds the Bearer Token provided to the Authentication header in the current call. OAuth2 Authentication (oauth2): the user performs a client-credential or password OAuth2 authentication flow by gathering a bearer token from the OAuth2 authentication endpoint. AWS Signature Authentication (awsv4): the user performs an AWS Signature authentication to the server by inserting the required access key and secret key. Insecure (insecure): no authentication is performed.	auth	basic
Username	If an authentication is required, enter the username linked to the share drive server.	username
Password	If an authentication is required, enter the password linked to the share drive server.	password
Bearer Token	The Bearer Token to insert in the Authentication header (Mandatory if the Authentication is set to Bearer Authentication).	password
Authentication Url	The OAuth2 authentication endpoint used for OAuth2 authentication client-credential or password flows. (Mandatory if the Authentication is set to OAuth2 Authentication).	authurl
OAuth2 type	The OAuth2 grant type which selects the type of OAuth2 authentication flow. (Mandatory if the Authentication is set to OAuth2 Authentication). Possible values are: Client Credential with Basic Auth (ccba): client-credential authentication flow with client authentication performed using Basic Authentication. Client Credential with Body Auth (ccbd): client-credential authentication flow with client authentication performed by sharing in the body client id and client secret. Client Credential with JWT Token (ccjwt): client-credential authentication flow with client authentication performed by using a signed JWT procedure. Password Auth (password): password authentication flow.	granttype	ccba
Client ID	The application client identifier used in OAuth2 client credential flow to identify the client. (Mandatory if the Authentication set to OAuth2 Authentication and the OAuth2 type is set to Client Credential with Basic Auth, Client Credential with Body Auth or Client Credential with signed JWT)	username
Client Secret	The application client secret passphrase used in OAuth2 client credential flow to authenticate the client. (Mandatory if the Authentication is set to OAuth2 Authentication and the OAuth2 type is set to Client Credential with Basic Auth or Client Credential with Body Auth)	password
JWT Token	The JWT Token used in OAuth2 client credential flow to authenticate the client. (Mandatory if the Authentication is set to OAuth2 Authentication and OAuth2 type is set to Client Credential with signed JWT)	password
Scope	The application authentication scope requested in OAuth2 authentication. (Mandatory if the Authentication is set to OAuth2 Authentication). The RFC8707 resource claim is supported in the HTTP/S connector, for more information check the corresponding page.	share
Access Key	The username used to authenticate to the Amazon AWS Signature Authentication service.	username
Secret Key	The password used to authenticate to the Amazon AWS Signature Authentication service.	password
Region	The region endpoint used to make requests in Amazon AWS Signature Authentication service.	authurl
Service Name	The AWS service name which will be used in Amazon AWS Signature Authentication service.	scope
Proxy Settings	A dictionary containing Proxy settings information if a Proxy needs to be used. For more information see Proxy Panel.	proxy
Headers	A list of strings written using the syntax Label:Value containing additional Headers to be added to the HTTP/S call.	headers

FTP/S Server

This connection allows Rulex Platform to connect to an FTP/FTPS server, reachable from the hosting machine or from the cloud/server.

The connection parameters required for this connection are reported in the following table (parameters in bold are mandatory.). To define a Custom connection to an FTP/FTPS server in Rulex Platform API calls the user must specify the value ftp in uri field.

Name	Description	API param key	Default
Host	The server host of the chosen ftp location.	host
Port	The server port of the chosen ftp location.	port	21
Username	If an authentication is required, enter the username linked to the ftp server.	username
Password	If an authentication is required, enter the password linked to the ftp server.	password
Proxy Settings	A dictionary containing Proxy settings information, if a Proxy needs to be used. For more information see Proxy Panel.	proxy

Amazon AWS S3

This connection allows Rulex Platform to connect to an Amazon AWS S3 bucket reachable from the hosting machine or from the cloud/server.

The connection parameters required for this connection are reported in the following table (parameters in bold are mandatory.). To define a Custom connection to an Amazon AWS S3 filesystem in Rulex Platform API calls, the user must specify the value s3 in uri field.

Name	Description	API param key
Bucket	The Amazon AWS S3 Bucket used in the connection.	bucket
Username/Access Key ID	The username used to authenticate to the Amazon AWS S3 service.	username
Password/Secret Access Key	The password used to authenticate to the Amazon AWS S3 service.	password
Authentication	The type of authentication method used: one of Standard or Short-term credential. As Standard, the IAM authentication is intended.	auth
Encryption	The server-side encryption eventually enforced: one of AES256 (default), SSE-KMS (aws:kms), DSSE-KMS (aws:dsse:kms).	granttype
Bucket Region	The regional endpoint used to make requests.	path
Session token	If Authentication is Short-term credential it contains the session token used to authenticate.	connstring
Key ID	When SSE-KMS or DSSE-KMS are used, it stores the Storage key used in the encryption.	domain
Proxy Settings	A dictionary containing Proxy settings information, if a Proxy needs to be used. For more information see Proxy Panel.	proxy

Microsoft SharePoint

This connection allows Rulex Platform to connect to Microsoft SharePoint sites reachable from the hosting machine or from the cloud/server.

The connection parameters required for this connection are reported in the following table (parameters in bold are mandatory.). To define a Custom connection to a Microsoft SharePoint filesystem in Rulex Platform API calls, the user must specify the value sharepoint in uri field.

Note

If the App ID and the Tenant ID fields are left empty, Rulex Platform automatically uses the default registered multi tenant application called Rulex Platform Entra ID connector. More information on this app is available here.

Name	Description	API param key	Default
Base Url	The Microsoft SharePoint site Url location.	host
Authentication	The type of authentication used to connect to Microsoft SharePoint service; the possible values are: Legacy Sharepoint Authentication (direct): to connect directly to Microsoft Sharepoint service using the Username and Password combination. Azure Authentication (azure): to authenticate using an Only-App Azure AD Authentication towards Microsoft Graph API and redirect it to Microsoft Sharepoint service. For more information about this type of authentication see this section. Refresh token (refreshtoken): to connect to Microsoft Sharepoint service using a refresh token. For more information on this mechanism, go to the corresponding section.	auth	direct
Refresh Token	The Refresh Token obtained by a client credential OAuth2 flow which can be used to obtain a new access token at any run. (Mandatory if the Authentication type is Refresh Token)	connstring
Username	The username used to authenticate. (Mandatory if the Legacy Sharepoint Authentication is selected)	username
Password	The password used to authenticate. (Mandatory if the Legacy Sharepoint Authentication is selected)	password
App ID	The application identifier of the SharePoint service principal app registered on the Azure tenant. (Mandatory if the Azure Authentication is selected)	username
Tenant ID	The Azure tenant identifier. (Mandatory if the Azure Authentication is selected)	domain
JWT Auth Token	The signed JWT token associated to the Sharepoint service principal, generated as explained here. (Mandatory if the Legacy Sharepoint Authentication is selected)	password
Proxy Settings	A dictionary containing Proxy settings information if a Proxy needs to be used. For more information see Proxy Panel.	proxy

Hadoop HDFS File System

This connection allows Rulex Platform to connect to Hadoop File System (HDFS) reachable from the hosting machine or from the cloud/server.

The connection parameters needed for this connection are reported in the following table (parameters in bold are mandatory.). To define a Custom connection to an HDFS filesystem in Rulex Platform API calls, the user must specify the value hdfs in the uri field.

Name	Description	API param key
Filesystem url	The url location of your Hadoop filesystem.	url
Port	The port used by your Hadoop filesystem, if any.	port
Username	The username linked to the Hadoop filesystem during the authentication procedure.	username
Password	The password linked to the Hadoop filesystem during the authentication procedure.	password

Azure Blob Storage

This connection allows Rulex Platform to connect to an Azure Storage Account (Blob service) reachable from the hosting machine or from the cloud/server.

Warning

This connector works only for Azure Storage Account Blob service (1st or 2nd generation).

For Azure Storage Account Files use the Import from Azure Table task and the Export to Azure Table task.

Warning

If the SAS key type is container, so it has limited permissions on the filesystem, read the dedicated section in the import page.

The connection parameters needed for this connection are reported in the table below (parameters in bold are mandatory.). To define a Custom connection to an Azure Blob Storage filesystem in Rulex Platform API call use the value astorage in uri field.

Note

If the Tenant ID field is left empty, Rulex Platform automatically uses the default registered multi tenant application called Rulex Platform Entra ID connector. More information on this app is available here.

Name	Description	API param key	Default
Storage Account Name	The Azure Storage Account name.	username
Authentication	The authentication type. Possible authentications are: Account Key (sharedkey), SAS Token (signkey), Client Credentials (clientcredentials), Refresh Token (refreshtoken).	auth	sharedkey
Account Key/SAS Token	The Key or the SAS Token used to authenticate to the Azure Storage Account: it is the Access Key if the Account Key type value is Key, while it is the full SAS token if SAS key is selected.	password
Client ID	The application client identifier used in OAuth2 client credential flow (Client Credentials and Refresh Token) to identify the client.	asusr
Tenant ID	The identifier of the Azure tenant. (Mandatory if Client Credentials or Refresh Token have been chosen as the authentication type.)	asdomain
Client Assertion	The JWT associated with the Client ID and the Tenant ID. (Mandatory if Client Credentials has been chosen as the authentication type.)	aspassword
Refresh Token	Refresh Token obtained by a client credential OAuth2 flow which can be used to obtain a new access token at any run. (Mandatory if Refresh Token has been chosen as the authentication type.)	aspwd
Proxy Settings	A dictionary containing the Proxy settings information if a Proxy needs to be used. For more information see Proxy Panel.	proxy

SFTP Server

This connection allows Rulex Platform to connect to a SFTP Server reachable from the hosting machine or from the cloud/server/server/server.

The connection parameters needed for this connection are reported in the following table (parameters in bold are mandatory.). To define a Custom connection to a SFTP server in Rulex Platform API calls the user must specify the value sftp in the uri field.

Name	Description	API param key	Default
Host	The server host of the chosen SFTP location.	host
Port	The server port of the chosen SFTP location.	port	22
Username	The username exchanged with the SFTP server during the authentication process.	username
Password	The password exchanged with the SFTP server during the authentication process.	password

Google Drive

This connection allows Rulex Platform to connect to Google drive, reachable from the hosting machine or from the cloud/server.

The connection parameters needed for this connection are reported in the following table (parameters in bold are mandatory.). To define a Custom connection to a Google Drive filesystem in Rulex Platform API calls the user must specify the value google in the uri field.

Name	Description	API param key
Api key	API key endpoint pointing to the chosen Google Drive filesystem.	host
Client ID	Client identifier of the registered application on Google domain.	username
Client Secret	Client secret passphrase of the registered application on Google domain.	password
Refresh Token	Refresh Token obtained by a client credential OAuth2 flow which can be used to obtain a new access token at any run.	connstring

Microsoft Outlook

This connection allows Rulex Platform to connect to a Microsoft Outlook account through Microsoft Graph API, reachable from the hosting machine or from the cloud/server.

The connection parameters needed for this connection are reported in the following table (parameters in bold are mandatory.). To define a Custom connection to a Microsoft Outlook filesystem in Rulex Platform API calls the user must specify the value outlook in the uri field.

Note

Name	Description	API param key
Mail Address	The mail address account to connect.	url
Client ID	The client identifier of the delegated application registered on Azure tenant for Microsoft Graph API access (see this section).	username
Authentication	The method to use for the authentication. For more information on this mechanism, go to the corresponding section.	auth
Refresh Token	The Refresh Token obtained by a client credential OAuth2 flow which can be used to obtain a new access token at any run.	connstring
Tenant ID	The identifier of the Azure tenant.	domain
Get only emails received from	Define the start date from which the emails will be imported.	startdate
until	Define the end date from which stop importing emails.	enddate
Get only emails by	Specify the email addresses from which emails will be imported.	scope
Get only emails with attachments	Select from this drop-down list if you want to import emails with attachments. The possible values are: Yes, No, All.	share

Creating a Filesystem Resource¶

To create a Filesystem resource, you need to open the Explorer panel (for more information refer to the corresponding page) and follow the procedure below:

Procedure

Click the Explore Resources icon to open the Explorer panel.
Deactivate the primary resource filter by toggling off on the Primary filter on the upper right side of the Explorer panel to add general resources.
Hover the mouse over the Plus button.
Select Add new Filesystem and a dedicated window will appear on the screen.
Select the Filesystem type you want to connect to (see supported types).
Configure the connection parameters following the provided guide. A test connection will be performed; if unsuccessful, an error message is displayed, offering also the opportunity to continue working anyway.
Type a unique name for the new resource.
Click Create: the new Filesystem resource is now added to the list.

Once the Filesystem resource is defined, it can be referred as a Saved source in any location where a remote connection can be used.

As an example, you’ll find below the most important Filesystem saved connection applications:

In any of the applications listed above, it is still possible to define the connection while performing the operation itself, by inserting a Custom connection in the parameters of the section above.

Proxy panel¶

Sometimes, for standalone installation, the used network needs to be protected with proxy firewall or by using a security VPN. Usually, the Rulex Platform software inherits proxy configuration directly from the system but when this does not occur (for example with some VPNs which enforce the proxy directly on the connection and not on the entire operating system), the proxy configuration needs to be imposed on the external connection itself. This can be done by using the Proxy panel which is contained in any filesystem remote connection configuration pane.

To open the Proxy panel you can click on the Change settings button located at the bottom of any remote connection configuration pane.

The Proxy panel is composed by four different entries:

Host: the IP host of the proxy.
Port: the IP port of the proxy.
Username: for secured proxy the username to be used in the proxy bypass.
Password: for secured proxy the password to be used in the proxy bypass.

Refresh Token Mechanism¶

Every time a Refresh Token is specified as the Authentication type, a button appears next to the Authentication drop-down list.

This button, called Generate Token, allows users to open an additional window, where they can complete their MFA authentication to the provider or, if they are already logged in, they can generate the refresh token and visualize the corresponding window.

It is possible to use also the Rulex Platform Entra ID Connector, a Microsoft Verified Rulex multi tenant application.

Warning

If your tenant doesn’t allow the access to all the Microsoft Verified applications, your administrator should approve the delegated permission for this application on Azure portal, in the Enterprise application section. Once there, the administrator selects the desired application and updates the permissions in the Review permissions section. This operation must be performed once, and it will be valid for the Rulex application.

The Refresh Token window is made of a main area, where the refresh token is visualized, and of a series of button located in the bottom part of the window. The following buttons can be found:

Save your refresh token in vault: select the vault where the refresh token will be stored.
Secret name: type the secret name which will be used to store the refresh token.
Save to vault: click this button to save the refresh token in the previously specified vault.
Copy to clipboard: click this button to copy the refresh token.

Warning

Tokens generated in the Standalone version are valid for 90 days, while those generated in the Server version are valid 24 hours only. If, in the Server version, users need a token which lasts more, they need to generate it from the Standalone version, then they can copy it in the Server version.

Note

To generate a refresh token, it is required an application with delegated access scope. As explained here, the permission to be set on the delegated application should be the most general possible (we suggest for Sharepoint Sites.ReadWrite.All for example), since they then will be limited by user permission. To know more about these procedures, check out the Sharepoint and the Outlook app creation dedicated pages.

Authentication application mediated¶

Rulex Platform connectors need to be executed without the physical presence of the user for the majority of the computation time. Moreover, if an interactive authentication is required, this should be asked once even if used for several connections.

The general approach of the majority of the identity providers available now on the market is to use a client credential authentication flow which exploits a constructed application to manage a machine to machine connection.

This definition of these client applications has to be executed on the identity provider portal (Azure, Google for example) towards you want to connect to.

Note

The Rulex Platform filesystem remote connections which now require a client application definition are:

Sharepoint connector with Azure authentication
Outlook connector
Google connector

Please refer to the official documentation of these providers for the complete step-by-step guide of this client creation. Here and in the correlated pages the attention is concentrated about most critical configuration steps or about the use of the already created application within the Rulex Platform filesystem configuration.

Sharepoint Azure authentication connection requires an Azure authentication app with on behalf of the user rights. Step-by-step guide to create this type of application with the correct rights to access the desired Sharepoint sites and the way to obtain the necessary signed JWT to be used in Rulex Platform is described in this side page.

Outlook connection requires an Azure authentication app with delegated permission on the desired user. The application needs the following permissions on Microsoft Graph service:

User.Read - Sign in and read user profile
Mail.Read - Read user mail
Mail.ReadWrite - Read and write access to user mail (only used in export operations)
Mail.Send - Send mail as a user (only used in export operations)

A step-by-step guide to create this type of application with the correct rights and the way to obtain the necessary information to configure the corresponding panel in Rulex Platform is available in this dedicated page.

Google connection requires a Google authentication app acting with delegated permission on the desired drive user storage. Please refer to this link, for a general guide about Oauth2 app authentication in the Google framework.

Filesystem GOLD Reference¶

Files in GOLD are mediated through the File class:

class base.dir.File(path='', lockwait=5)

Base GOLD class for files

Property path:: the path of the file
Property lockwait:: the sleep time to manage lock on file

absPath()

Function to obtain the absolute path

Parameters:: path (text) – the path (possible relative) to be expanded
Returns:: the absolute version of the provided path
Return type:: text

copy(path)

Function to copy a file in a new path

Parameters:: path (text) – the path where create the copy

copyFolder(dest_path, extensions=None, incl=True, alsoroot=False)

Copy the content of a folder into a destination path

Parameters:

path (text) – source path of the original folder
dest_path (text) – destination path of the copied folder
extensions (vector of text) – vector of extensions to be considered during the copy (the rest of the files is not copied), defaults to None
incl (binary) – if True files with provided extensions are included else are excluded, defaults to True
alsoroot (binary) – if also the root folder needs to be copied (the destination path is considered in this case as the parent folder), defaults to False

countLine()

Function to count the line of a file

Returns:: the number of lines
Return type:: integer

create(): Function to create a file

createFolder()

Function to create a folder

Parameters:: path (text) – path of the folder to create

delete(): Function to delete the file

deleteFolder()

Function to delete a folder

Parameters:: path (text) – path of the folder to delete

existFolder()

Function to test if a folder exists

Parameters:: path (text) – path of the folder to test
Returns:: True if the folder exists, False otherwise
Return type:: binary

exists()

Function to test if a file exists

Returns:: True if the file exists, False otherwise
Return type:: binary

extractFileName()

Function to extract the basename from a path

Parameters:: filepath (text) – the path of the considered file or folder
Returns:: the basename of the considered file or folder
Return type:: text

getParentFolder()

Function to get only the parent folder

Parameters:: fullpath (text) – the path to test
Returns:: the parent folder
Return type:: text

jsonRead(skipbadlines=False)

Function to read json from or File or text

Parameters:

source (text or File instance) – the source to read, it could be a text or a class of type File to read from an opened file stream
skipbadlines (binary) – if True eventual wrong formatted lines are skipped, defaults to False

Returns:

a dictionary representing the JSON object

Return type:

dict

jsonWrite(tofile=None)

Function to write a json starting from a GOLD dictionary

Parameters:

source (dict) – a GOLD dictionary
tofile (a File instance) – the eventual File instance to write not on a returned text but directly on a opened file stream, defaults to None

Returns:

in case tofile not defined or not of File class, the json text written.

Return type:

text

read(binary=False)

Function to read the content of the file

Parameters:: binary (binary) – FIXME, defaults to False
Returns:: the read data
Return type:: text

rename(newname, overwrite=False)

Function to rename a file

Parameters:: newname (text) – the new name

setLockWait(lockwait)

Function to set a new lock sleep time (in seconds)

Parameters:: lockwait (integer) – the new lock sleep time

setPath(path)

Function to set a new path

Parameters:: path (text) – the new path

splitFileString()

Function to split a path into folder, basename and extension

Parameters:: filepath (text) – the path to test
Returns:: a list of three elements: the parent folder, the basename and the extension in this order
Return type:: list

tempPath()

Function to obtain the temporary folder of your operating system

Returns:: the absolute path of your temporary folder
Return type:: text

unzipfolder(dest_path=None)

Function to unzip an archive into a destination folder

Parameters:

path (text) – path of the archive
dest_path (text) – the path of the destination folder, None for the parent folder of the archive, defaults to None

userPath()

Function to obtain the user folder of your operating system

Returns:: the absolute path of your user folder
Return type:: text

write(string='%', vars=None, binary=False, append=False)

Function to write a format string into the open file

Parameters:

string (text) – the format string; vars will substitute % character in this string.
vars (list) – a list of variables to be used into the format string
binary (binary) – FIXME, defaults to False
append (binary) – if True append at the end of file, defaults to False

zipfolder(extension, removeorig=True, dest_path=None)

Function to zip a folder

Parameters:

path (text) – the path of the folder to zip
extension (text) – extension to be used for the zipped file
removeorig (binary) – if True the original folder is erased at the end of the zip compression, defaults to True
dest_path (text) – the path of the destination folder, None for the parent folder of the folder, defaults to None

Filesystem connections in GOLD are mediated through the Connectors class:

class filesystem.filesystem.Connector(type='local', url=None, username=None, password=None, port=None, auth=None, domain=None, share=None, path='', connstring=None, infiniteretry=False, proxy=None, granttype=None, scope=None, authurl=None, startdate=None, enddate=None, alsoundo=True, nretry_sleeptime=-1, sessionlike=False, insecure=False, httpmethod=None, resource=None, emptyfoldercontinue=False)

Base GOLD class for external connection to filesystem origin. It supports at the moment:

Sharepoint (type sharepoint)
AWS S3 (type s3)
Samba/NFS Sharedrive (type sharedrive)
FTP/S Server (type ftp)
SFTP Server (type sftp)
Google Drive Storage (type gdrive)
HTTP/S Server (type http)
Outlook Mail Server (type outlook)
Azure Blob Storage Service (type astorage)

Connections are performed through a C library contained in the field libcon of the class.

Property conn:: the actual connector pointer
Property type:: the type of connection
Property url:: the url/host/server of the connection
Property username:: the username/uid/client_id of the connection
Property password:: the password/token/jwt/client_secret of the connection
Property libcon:: the C library used internally for the connection
Property status:: the status of the connection (used to track down errors during C function evaluation)
Property port:: the port of the connection
Property auth:: the type of authentication used by the connection
Property domain:: the domain/tenant of the connection
Property share:: the share of the connection
Property path:: the path of the connection
Property connstring:: the connection string of the connection
Property granttype:: the grant type of the OAuth2 authentication
Property proxy:: the proxy settings of the connection
Property scope:: the scope of the OAuth2 authentication
Property authurl:: the authentication url of the OAuth2 authentication
Property startdate:: the starting date for the Outlook Mail inspection
Property enddate:: the ending date for the Outlook Mail inspection
Property httpmethod:: the HTTP Method (GET/POST/PATCH/DELETE/UPDATE/PUT) used in the connection
Property resource:: the resource of the OAuth2 authentication
Property undo:: an Undo instance to allow undo/redo operation
Property sessionlike:: if True all dataset operation are connected to an Undo structure to record them and allow undo-redo operations.
Property tree:: a dictionary taking into memory the folder/file tree (used in File Manager Task)

authenticate(): Function to perform the authentication

connect(): Function to test the connection

copy(oldpath, newpath, overwrite=0)

Function to copy a remote path

Parameters:

oldpath (text) – the old path of a file/folder
newpath (text) – the new path of the file/folder
overwrite (integer) – if 1 the file is overwritten is already present, defaults to 0

Returns:

the upadeted tree in case sessionlike

Return type:

list

createFile(fpath)

Function to create a file in a remote path

Parameters:: fpath (text) – the new path of the file/folder
Returns:: the upadeted tree in case sessionlike
Return type:: list

delete(path, error=True)

Function to delete a path

Parameters:

path (text) – the path of the file/folder to delete
error (binary) – if True error is returned in case file/folder does not exist

Returns:

the upadeted tree in case sessionlike

Return type:

list

download(file, destination, urlencode=False, extensions=None, recursive=False, httpheaders=None, nextlink=None, checkkey=None, checkoperator=None, checkvalue=None, addheadertoresponse=False, mode=0)

Function to download a file/folder from a remote connector

Parameters:

file (text) – the path of the file/folder to download
destination (text) – the destination folder where download the file
urlencode (text) – if True the file name is urlencoded in the destination folder, defaults to False
extensions (vector of text type) – in case of folder download, the vector of extension to consider inside the folder, None for all, defaults to None
recursive (binary) – if True in case of folder download, every subfolder is downloaded too, defaults to False
httpheaders (text) – a text in the form <name>:<value>;... to define custom headers of your GET HTTP call, defaults to None
nextlink (text) – claim to control link iteration in HTTP call, defaults to None
checkkey (text) – key of the REST API to check to continue the retry, defaults to None
checkoperator (text) – operator to check to continue the retry, defaults to None
checkvalue (text) – value to check to continue the retry, defaults to None
addheadertoresponse (binary) – if True GET HTTP call is modified to add header response, defaults to False

Returns:

the status of the operation is not sessionlike otherwise the tree obtained

Return type:

integer or dict

getFileExists(file)

Function to test if a file exists

Parameters:: file (text) – the path file to test
Returns:: a binary if exists
Return type:: binary

getFolderExists(folder)

Function to test if a folder exists

Parameters:: folder (text) – the path folder to test
Returns:: a binary if exists
Return type:: binary

getLastModified(file)

Function to get the last modified date of a file

Parameters:: file (text) – the path file to test
Returns:: the last modified date
Return type:: text

move(oldpath, newpath, overwrite=0)

Function to move a remote path

Parameters:

oldpath (text) – the old path of a file/folder
newpath (text) – the new path of the file/folder
overwrite (integer) – if 1 the file is overwritten is already present, defaults to 0

Returns:

the upadeted tree in case sessionlike

Return type:

list

rename(oldpath, newname, overwrite=0, warning=False)

Function to rename a remote path

Parameters:

oldpath (text) – the old path of a file/folder
newname (text) – the new name of the file/folder
overwrite (integer) – if 1 the file is overwritten is already present, defaults to 0
warning (binary) – if True a warning is given if the file/folder does not exist, error otherwise, defaults to False

Returns:

the updated tree in case sessionlike

Return type:

list

reset(setssl=True, sethttps=True, setproxy=True)

Function to reset the preceeding connection

Parameters:

setssl (binary) – if True the ssl backend is re-initiated, defaults to True
sethttps (binary) – if True the minimum required version TLS 1.2 is set again, defaults to True
setproxy (binary) – if True the new connection will own the same proxy settings of the previous one, defaults to True

setProxy(host=None, port=-1, username=None, password=None)

Function to set a proxy for the present connection

Parameters:

host (text) – the host name or IP address of the proxy, defaults to None
port (integer) – the port number of the proxy, defaults to -1
username (text) – if needed, the username to authenticate against the proxy, defaults to None
password (text) – if needed, the password to authenticate against the proxy, defaults to None

stat(paths, fields, recursive=False, alsofolder=False)

Function to get statistics about a set of paths

Parameters:

paths (vector of text type) – the remote paths to test
fields (vector of text type) – additional fields to add to the result
recursive (binary) – if True in case of folder download, every subfolder is downloaded too, defaults to False
alsofolder (binary) – if True information about folder is add to the result, defaults to False

Returns:

dictionary with fields selected as keys

Return type:

dict

upload(url, file, cleanpath=0, responsefile=None, responseheader=False, httpheaders=None, recursive=False, nextlink=None, checkkey=None, checkoperator=None, checkvalue=None, debugfile=None, addheadertoresponse=False)

Function to upload a file/folder to a remote connector

Parameters:

url (text) – the destination folder where upload the file
file (text) – the path of the file/folder to upload
httpheaders (text) – a text in the form <name>:<value>;... to define custom headers of your GET HTTP call, defaults to None
cleanpath (integer) – remove local files after they are uploaded, defaults to 0
responsefile (text) – path location of the response file in HTTP POST call case, defaults to None
responseheader (binary) – if True also the response header is saved, defaults to False
recursive (binary) – if True in case of folder download, every subfolder is downloaded too, defaults to False
httpheaders – a text in the form <name>:<value>;... to define custom headers of your GET HTTP call, defaults to None
nextlink (text) – claim to control link iteration in HTTP call, defaults to None
checkkey (text) – key of the REST API to check to continue the retry, defaults to None
checkoperator (text) – operator to check to continue the retry, defaults to None
checkvalue (text) – value to check to continue the retry, defaults to None
addheadertoresponse (binary) – if True GET HTTP call is modified to add header response, defaults to False
debugfile (text) – path location of the debug file in HTTP POST call case, defaults to None

Returns:

the path or the tree uploaded

Return type:

list