Versions Compared

Version Old Version 8 New Version Current
Changes made by

Lakshminarayanan1 S CTOO (Unlicensed)

Lakshminarayanan1 S CTOO (Unlicensed)

Saved on

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

    • CSV
    • XLS
    • XLSX
    Image Removed
    • PDF
    • DOCX
    • TXT
    • HTML
    • XML

    Image Added

  6. Click Save to save the FTP data source.

    Image Removed
    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 data source appears, as shown in the following screenshot:

    Image Modified

  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){	
	}

Client Customization

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


    2. Right-click the newly created FTP data source (e.g. FTP_DS) and select the Customize DS for Client option.
    Image Removed
    The Edit Datasource page appears.
    Image Removed

     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.

    Image Removed
     Provide a unique data source name in the Data Source Name field, e.g. HIGHSCORE FTP DS.
  2. Select the Put File option in Request Type to send the requested file to the FTP server.

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

    Image Removed
    Click Save to save the customized FTP data source for the selected HIGHSCORE client.
    Image Removed
    A confirmation message, indicating a successful save of the customized FTP data source, appears.
    Image Removed
  3. Click Ok.

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

    Image Removed
    Click the Additional Info tab.
    Image Removed

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

    Note

    By default, the Archival option has already been selected from the Publishers drop-down list. Do not deselect the Archival option from the Publishers drop-down list, as the Archival option facilitates the generation of the report in the Sigma Application. 

    Image Removed

    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.

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

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

     
    Image Removed
    When the report generation status is displayed as Success, click the Download icon Image Removed to download the generated report.
    Image Removed
    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:
    Image Removed
    The fetched data of the HIGHSCORE REPORT displayed in the XLS file, as shown in the following screen shot:
    Image Removed

    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.