Versions Compared

Key

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

Once you establish a connection to the Amazon S3 storage service, you can proceed to configure the data source in Sigma Studio for transferring the files to the listed Amazon S3 cloud-based storage service. 

For transferring the files to the S3 cloud-based storage service using Sigma Studio, perform the following steps:

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

    Refer Connectors - Amazon S3 for more information on creating an Amazon S3 connection.

    Image RemovedImage Added

    The
    Create New Data Source page appears.



  2. Enter a unique data source name in the Data Source Name field, e.g. AMAZON S3 DS.



  3. If you want to fetch a particular file from the S3 cloud-based storage service, specify the relevant file path and the accurate file name in the In the Bucket Name field, provide the bucket name present in the connected S3 storage service, e.g. sigmareports.

    Note

    The File Path and File Name are optional fields

    respectively

    .


    Note

    For transferring the files to the S3 cloud-based storage service, there is no need to specify the file path and the file name. Only to receive or fetch files from the S3 Currently, Sigma Studio supports only the transfer of files to the S3 bucket cloud-based storage service, you must specify the relevant file path and the accurate file name.

    Image Removed

    In the Bucket Name field, provide the bucket name present in the connected S3 storage service, e.g. barathbucket23456.

    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 files of following formats from the FTP server. For the transferring of files to the S3 cloud based storage service, the supported formats are listed as follows:

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

    Image RemovedImage Added

  4. Click Save to save the FTP S3 data source.

    Warning

    When you try to exit the Data Source screen, before saving the configured FTP S3 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:




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

Client Customization

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

  1. Right-click the newly created FTP Hover the mouse on the created Amazon S3 data source (e.g. FTP_AMAZON S3 DS) and click the Image Added icon. Proceed to select the Customize DS for Client option to configure a customized client data source.
    Image Removed
    Image Added

    The Edit Datasource page appears.
    Image Removed
    Image Added

  2.  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 RemovedImage Added icon is used to export the FTP S3 data source in the SQL format, while Image RemovedImage Added is used to delete the FTP S3 data source.


    Image RemovedImage Added

  3.  Provide a unique data source name in the Data Source Name field, e.g. HIGHSCORE FTP S3 DS.
  4. Select the Put File option in Request Type to send the requested file to the FTP server.
  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
    Image Added

  6. In the Bucket Name field, provide the accurate bucket name, which exists in the S3 storage service, e.g. sigmareports.

    Note

    The

    Local

    File Path and File Name are optional fields. Both the

    Local

    File Path and File Name fields are not required if you want to transfer files to

    create a FTP DS, with the Put File Request Type

    a specific bucket in the S3 storage service. It is sufficient only if you provide the

    appropriate server path

    relevant bucket name, specific to the selected corporate client or customer, in the

    Relative Path on Server field

    Bucket Name field.

    Image Removed

    Image Added

  7. Click Save to save the customized FTP S3 data source for the selected HIGHSCORE client.
    Image Removed
    Image Added

    A confirmation message, indicating a successful save of the customized FTP S3 bucket data source, appears.



  8. Click Ok.

    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.

    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

    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 RemovedOnce the S3 data source with the client customization is created, you can proceed to configure a report based on your needs and requirements. To configure reports for the S3 cloud-based storage service, refer Configuring S3 Storage Service for Reports.