Versions Compared

Key

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

Perform the following steps after creating the FTP connection to receive files from the FTP server using Sigma Studio:

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

    Refer FTP – Connectors 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 client, refer Creating Corporate Customers.


    Image Added

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

  4. Select the Get File option in Request Type to receive the requested file from the FTP server.

    Note

    You cannot make use of the FTP data source, configured with the Get File Request Type, to create a report in Sigma Studio.


    Image RemovedImage Added

  5. Provide the appropriate file path on the FTP server to which the files need to be transferred obtained from the server in Relative Path on Server field.

    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


  6. Provide the appropriate local file path from which the files need to be transferred obtained from your local drive in Local File Path field.
  7. Provide the file name that needs to be obtained in File Name field.

    Note

    You can receive the files of the following formats from the FTP server:

    • CSV
    • XLS
    • PDF
    • DOCX
    • TXT
    • HTML
    • XML

    Image RemovedImage Added

  8. 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:

    • 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 RemovedImage Added

    A success message for creating the data source appears, as shown in the following screenshot:



  9. 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_DS");  // Here, FTP_DS refers to the Datasource ID.
	ec.setInitialRequestData(inputParams1);
	try {
		CT.ftp(ec);
	}
	catch(Exception e){	
	}


...