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 Sigma Studio:

  1. Right-click the created FTP server connection and select the Create Data Source option.

    Refer Connectors – FTP for more information on creating a FTP connection.



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

    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 a 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 receive send the files of following formats from to the FTP server:

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

    Image RemovedImage Added

  6. Click Save to save 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:



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

...



Report Configuration

To customize a configure the reports with the FTP data source for a specific corporate client or customer, perform the following steps in Sigma Studio:

...

 Click the Client lookup field and select the Corporate Client or Customer of your choice, e.g. HIGHSCORE.

Note

The Parent Data Source Id and Connection Name are non-editable fields. Image Removed icon is used to export the FTP data source in the SQL format, while Image Removed is used to delete the FTP data source.

...

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.

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 a FTP DS, with the Put File Request Type. It is sufficient only if you provide the appropriate server path, specific to the selected corporate client or customer, in the Relative Path on Server field.

...

  1. Access the Information Report screen and configure the report with the relevant and appropriate configurations, as shown in the following screen shot:

    Note

    For detailed information on creating reports, refer Configuring Reports.




  2. Click the Additional Info tab.



  3. Click the Publishers drop-down list and select the FTP option.



  4. Click the Publisher Data Source lookup field and select the relevant FTP data source, e.g. FTP_DS

    Note

    For making use of the the customized data source for a specific client, it is essential that the Parent FTP data source for the customized client data source should be aptly selected. The customized client FTP data source is HIGHSCORE FTP DS, whereas the Parent Data Source Id is FTP_DS. So, it is essential that the FTP_DS Parent Data Source is selected in the Publisher Data Source lookup field, while configuring a report in Sigma Studio.




  5. Once the report is configured with essential attributes, click Save to save the report.

     

  6. Access the relevant report, e.g. HIGHSCORE REPORT in the Sigma Application and click Run to generate the report.

    Note

    For detailed information on generating the reports in Sigma Application, refer Generating a Report. Once the report gets generated, the generated report can be found in the relevant server path, which was specified as the relative server path, while configuring the FTP data source in Sigma Studio.

     



    The HIGHSCORE REPORT XLS file can be found in the provided FTP server path or the Relative Server Path (e.g. /workfolder/files/), as shown in the following screen shot:



    The fetched data of the HIGHSCORE REPORT displayed in the XLS file, as shown in the following screen shot: