Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Perform the following steps after creating the FTP connection to transfer files to the FTP server using Canvas Sigma Studio:

  1. Right-click the created FTP server connection and select Create Data SourceClick the Data Source Image Added icon on an existing FTP connection, e.g. NEW FTP CONNECTION.

    Refer Connectors - FTP for more information on creating a an FTP connection.
    Image Removed
    Image Added

    The
    Create Request page appears.
    Image RemovedNew Data Source page appears.

    Image Added

  2. Select the appropriate corporate client or customer from the Client lookup field, e.g. HIGHSCORE.

    Note

    The All Clients option appears as the default one in the Client lookup field. For detailed information on creating corporate customers or clients, refer Creating Corporate Customers.


    Image Added

  3. Enter a unique data source name in the Data Source Name field, e.g. FTP PF DS.
    Image Removed
    Image Added

  4. Select the Put File option in Request Type to send the requested file to the FTP server.

    Note

    Refer Receiving Files from FTP Server for more information on receiving files from the FTP server.

    Image Removed


    Image Added

  5. Provide the appropriate file path on the FTP server to which the files need to be transferred to the server in the Relative Path on Server field, e.
    Provide the appropriate local file path from which the files need to be transferred from your local in Local File Path field.
    Provide the file name that needs to be sent in File Name field.

    NoteYou can receive files of following formats from

    g. Newfolder.

    Note

    On providing an incorrect FTP server path in the Relative Path on Server field, an error message appears, indicating that the provided FTP server path is invalid, as shown in the following screen shot:

    Image Added


    Note

    The Local File Path and File Name are optional fields. Both the Local File Path and File Name fields are not required to create an FTP DS, with the Put File Request Type. It is sufficient only if you provide the appropriate server path in the Relative Path on Server field. You can send the files of following formats to the FTP server:

    • CSV
    • XLS
    • XLSX

    Image Removed

    Click Save.
    • PDF
    • DOCX
    • TXT
    • HTML
    • XML

    Image Added

  6. Click Save to save the FTP data source.

    Note

    You can even proceed to save the FTP data source without having to customize the configured FTP connection. On saving the FTP data source without customizing the client for the configured FTP connection, the following pop-up message, appears, as shown in the following screen shot:
    Image Added

    • Click Yes, to create the FTP data source.


    Warning

    When you try to exit the Data Source screen, before saving the configured FTP data source, a warning pop-up message appears, as shown in the following screen shot:
    Image Added

    • Click Cancel, if you do not want to exit the Data Source screen.
    • Click Ok, if you want to exit the Data Source screen.


    Image Added

    A success message for creating the

    datasource

    data source appears, as shown in the following screenshot:

    Image Removed


    Image Added

  7. Click Ok.

    Note

    In order to trigger the FTP service connection, the CT platform's server-side API, CT.ftp must be used while passing the ExecutionContext action in a Java Handler class. Refer the following sample code snippet for better understanding on the triggering process:

    Here, on the following sample code snippet a new ExecutionContext action is created within which a map (HashMap) is built. The FTP datasource ID is passed as the input to activate the connection request within which the CT.ftp API is passed to trigger the process.

    Code Block
    languagejs
    ExecutionContext ec = new ExecutionContext();
    	Map inputParams1 = new HashMap();
    	inputParams1.put("DATA_SRC_ID","FTP_PF_DS");  // FTP_PF_DS refers to the Datasource ID.
    	ec.setInitialRequestData(inputParams1);
    	try {
    		CT.ftp(ec);
    	}
    	catch(Exception e){	
    	}


    Once the FTP data source is created, you can proceed to configure a report based on your needs and requirements. For configuring reports that need to be sent to the FTP server, refer Configuring FTP Server for Reports.