2 Designing Artifacts: Transfers, Sources, and Targets

You can design file delivery structures consisting of sources, targets, and transfers using Oracle Managed File Transfer.

This chapter includes the following sections:

2.1 About Designing Transfers

Before designing a file transfer using the Design page in the Oracle Managed File Transfer console, you should design the transfer on paper or a whiteboard.

2.1.1 Getting Ready to Create a Transfer

Transfers are an artifact that links a single source to one or more targets. Transfers can include content filters and other actions that affect the transfer. Before you create a transfer, you should determine the details of what the transfer should do. Consider these specifications:

  • The origin location, from which files are transferred, called the source

  • The destination locations, to which files are transferred, called the target

  • Whether the origin and destinations are file system directories or web service endpoint URLs. The origin and destinations can also be in other applications such as B2B or Healthcare.

  • If the file is large, you might want to pass a reference to the web service destination rather than the file.

  • Access parameters for the origin and destinations: usernames, passwords, security certificates, and file system permissions

  • The file format: binary, XML, or text

  • Whether some files must be included or excluded based on format or name

  • Whether files must be compressed or decompressed

  • Whether files must be encrypted or decrypted

  • Whether files must be renamed, moved, archived, or deleted

  • Whether files must be scheduled for delivery at specific times or time ranges

Note:

You can use the Artifacts Search tab to see if a source, target, or transfer exists that you can reuse or recreate with modifications. For more information, see "Artifacts Search" in the Oracle Fusion Middleware MFT Online Help.

2.1.2 Designing End-to-End Flows

Sources and targets can be reused in multiple transfers. When more than one transfer uses the same source, this is called transfer fan-out. When a transfer uses more than one target, this is called target fan-out. A source and all associated transfers and targets are collectively called a flow.

You cannot use a source as a target or a target as a source. However, a target and a source can reference the same location. This allows the target of one transfer to be the source of another, creating a transfer chain.

In addition to determining the specifications of each transfer, you should map out any fan-outs and chains needed in the overall file delivery structure. For examples, see Oracle Managed File Transfer Functional Use Case Patterns.

2.2 Configuring a Transfer

You can create a transfer before or after you create the source and targets. However, you cannot deploy a transfer without a source and at least one target.

The steps to configure a transfer are:

  1. Create a transfer in one of these ways:
    • Click Transfers in the left pane navigator.

    • Select Transfers in the left pane navigator and click the Create icon.

    • Right-click Transfers in the left pane navigator and select the Create command.

    The Transfers dialog opens.

  2. Type a Name for the transfer.

    The name can include letters, numbers, dashes, and underscores.

  3. Type a Description for the transfer.

    The description is optional.

  4. Click the OK button.

    A tab for the transfer opens.

    To avoid creating a transfer, click Cancel.

  5. Add a source and one or more targets.
  6. Add content filters.

    This is optional. See Setting Up Content Filters.

  7. Add users, groups, and roles who can access the transfer payload.

    This is optional and applies only to web service pass by reference transfers. See Granting Payload Access.

  8. Configure target-specific transfer settings.
  9. Add a schedule.

    This is optional. See Setting Up Schedules.

  10. Add preprocessing and postprocessing actions such as compression and encryption.

    This is optional and applies only to targets. Source actions are added directly in the source artifact. See Setting Up Transfer Preprocessing and Postprocessing Actions.

  11. Click the Save button.

    To undo all changes since the last save, click Revert.

  12. Click the Deploy button after saving.

    You can add an optional comment.

    If the associated source and target have not been previously deployed, deploying the transfer automatically deploys the associated source and target.

If an existing transfer has most of the desired properties, you can duplicate it. See Duplicating an Existing Transfer.

2.2.1 Adding a Source and Targets

The steps for this process are:

  1. Click the arrow to the left of Transfers in the left pane navigator.

    The transfers are listed. Note that this step might have been completed in the previous section when creating the transfer.

  2. Click the transfer name or right-click it and then select the Open menu item.

    The transfer tab opens.

  3. Add a source in one of these ways:
  4. Add targets in one of these ways:
    • Click add target if you already created the target.

      Select the target to add in the left column, then click the single arrow icon to move it to the column on the right. You can add more than one target. To select all targets, click the double arrow icon. Click OK.

    • Click create target to create a new target. Begin at step 2 in Creating a Target.

    • Drag and drop a target from the navigation pane.

      See Dragging and Dropping Sources and Targets into Transfers for more information.

  5. Save and Deploy the transfer.

2.2.2 Setting Up Content Filters

Content filters specify file name and extension pattern criteria for transfer. If no content filters are defined, all files at the source endpoint are transferred.

The steps for this process are:

  1. Click the arrow to the left of Transfers in the left pane navigator.

    The transfers are listed.

  2. Click the transfer name or select it and then click the Open icon.

    The transfer tab opens.

  3. Click the arrow to the left of Content Filters.

    The Content Filters settings are displayed.

  4. Select Wildcard or Regular Expression to determine how the filter string is interpreted.
  5. Type a pattern in the text field for the filter.

    If you selected Wildcard, use * as a wildcard. For example, *.xml specifies that XML files are transferred. To specify text or XML files, you can use *.(xml|XML|txt|TXT). For example, File = "TXT-20100505-XXXX.txt" where XXXX can be any four successive digits. Regexp Filter expression ="XT-20100505-\\d{4}\\.txt".

    For more information about regular expressions, see The Java Tutorials: Regular Expressions.

    The pattern is for file names only. Filtering on directory names is not supported.

  6. Click add filter to add another filter.

    Another text field is created and given a new number.

  7. Repeat steps 5 and 6 for each filter you want to add.

    To delete a filter, click the red X to the right of the filter.

  8. Use the up and down arrows to the right of each filter to change the filter order.

    Lower numbered filters are performed first.

  9. Save and Deploy the transfer.

2.2.3 Configuring Target-Specific Transfer Settings

Depending on the target type, different optional target-specific transfer settings are displayed when you open a transfer tab and click the arrow to the left of a target.

If the target type is File, FTP Remote, or sFTP Remote, the subfolder setting is displayed. This adds a transfer-specific subfolder to the target location.

You can override the folder name that is set at the target setting by setting MBean enableDynamicTargetFoldername as true, then pass the TargetFoldername header via SOAP. A sample SOAP request is shown below:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Header>
		<ns1:MFTHeader xmlns:ns1="http://xmlns.oracle.com/fmw/mft/soap">
			<ns1:TargetFilename>Order.xml</ns1:TargetFilename>
			<ns1:TargetFoldername>/scratch/testD</ns1:TargetFoldername>
	 	<ns1:ContentIdentifier>Order.xml</ns1:ContentIdentifier>
		</ns1:MFTHeader>
	 </soap:Header>
	<soap:Body> 
	<ns1:MFTServiceInput xmlns:ns1="http://xmlns.oracle.com/fmw/mft/soap"> 
			<ns1:InlinePayload> 
 				<PurchaseOrder> 
				</PurchaseOrder> 
			</ns1:InlinePayload> 
		</ns1:MFTServiceInput> 
	</soap:Body></soap:Envelope>

Target pre-callout can also be used to add TargetFoldername header property:

context.getCustomPropertyMap().put("TargetFoldername" , newFolder);

Note:

If the Source types that support subfolder option such as File, Embedded FTP/sFTP, Remote FTP/sFTP, OSCS, and WebCenter has Include Content in Subfolder option enabled and Target has the Propagate Source SubFolders option enabled, the subfolder structure is replicated to the target during the transfer. For example, if there is a file in/tmp/src/folder/test.txt, the file gets copied to /tmp/tgt/folder/test.txt, the subfolder structure is maintained.

If the target type is an HTTP SOA-based web service type (B2B, Healthcare, SOAP, SOA, Service Bus, or ODI), the following Delivery Preferences are displayed:

  • Delivery Method: Specifies the delivery method: Inline or Reference (default). If Inline, the actual file is sent in the SOA message payload. If Reference, a link to the file is sent.

  • Reference Type: Specifies the reference type: FTP (default), File, or sFTP. Note that internal and external port numbers can be set in the Advanced Delivery Properties area of the Administration Server Properties page.

  • Max Inline Size: Specifies the maximum size in bytes for inline deliveries.

2.2.4 Setting Up Transfer Preprocessing and Postprocessing Actions

After you add a target to a transfer, you can edit the transfer to add preprocessing actions such as compression, decompression (file type only), encryption or decryption, find and replace or new line conversion action. You can also add decompression as a postprocessing action for a target of type File.

You can configure preprocessing for the source; see Setting Up Source Processing Actions.

You can also create custom preprocessing and postprocessing actions; see Processing Transfers with Custom Callouts.

Note:

Postprocessing occurs after file delivery. Therefore, the Active Deliveries and File Finder views in the Dashboard tab on the Monitoring page show different statuses if file delivery succeeds but postprocessing fails. Specifically, the Active Deliveries view displays a Completed status but the File Finder view displays a Failed status.

Note:

If you add the same processing action to a source and a target that uses the source, the action is performed twice. For example, if you add compression to the source and the target, the transferred file is compressed twice.

Decompress action is supported as a pre-processing action for source and target. Multiple file pre-processing decompression is only supported for SOAP, SOA, Service Bus, and ODI target types and delivery preference File /FTP/sFTP. For other target types, a pre-processing decompression error occurs, if a compressed file has multiple entries. Decompression is also supported as post-processing action for File type target which supports multifile decompression.

If you have multiple file decompression, you can workaround by having 2 transfers:
  • Transfer 1 : Actual Source -> File target with decompress post-processing
  • Transfer 2 : File Source (file in subfolder checked and same folder where transfer 1 file) -> Actual target

Note:

If you copy a binary file to the source location using an FTP client external to Oracle Managed File Transfer, be sure to configure it for binary transfer. Otherwise the file might become corrupted. Processing actions such as compression and encryption might not work properly.

2.2.4.1 Compression and Decompression Preprocessing Actions

You can compress or decompress a file prior to a transfer delivering it to a target. You can specify either action in the transfer configuration.

Multi-file decompression preprocessing is supported only for SOAP, SOA, Service Bus, and ODI type targets in which the Delivery Method is set to Reference. In this case, the files inside the ZIP file are extracted to a unique random directory, and only a reference to this directory is sent to the target. This directory is listed in the Target Pre-Processing section of the target report. See Target Reports for more information.

Note:

Any processing function added after the multi-file decompression is ignored. If the decompression preprocessing of other types of targets results in multiple files, the decompression action generates an error.

The steps for this process are:

  1. Click the arrow to the left of Transfers in the left pane navigator.

    The transfers are listed.

  2. Click the transfer name or right-click it and then select the Open menu item.

    The transfer tab opens.

  3. Click the arrow to the left of the target.

    The target settings are displayed.

  4. Click add pre-processing actions.

    The Pre-Processing Actions dialog opens.

  5. Select Compress or Decompress from the All Actions drop-down list.
  6. Click Add to List.

    To remove an action from the list, click the Delete icon to the right of the action.

  7. If you selected Compress, select the compression level from the Level drop-down list: Best Compression, Default Compression, or Best Speed. For more information, see the java.util.zip package, especially the Deflater class and the referenced specifications.
  8. Click OK.

    To cancel adding actions, click Cancel.

  9. Save and Deploy the transfer.
2.2.4.2 Find and Replace Preprocessing Action

Use the Find and Replace action to replace a specified text with another text in a file before sending the data to the target. You can perform multiple find and replace actions on a file.

If you are using the Find and Replace action on a specific target, then you may set the processing action at the specific target level. If you are setting the action on multiple targets with the same source, then add the action at the source level. See section Find and Replace at the Source.

To Find and replace action:

  1. Click the arrow to the left of Transfers in the left pane navigator.

    The transfers are listed.

  2. Click the transfer name or right-click it and then select the Open menu item.

    The transfer tab opens displaying the General Information and Transfer Definitions.

  3. Click the Target Definitions tab.
  4. Click Pre-Processing Actions for Targets.

    The Pre-Processing Actions dialog opens.

  5. Select Find and Replace from the All Actions drop-down list.
  6. Click Add to List. The Find and Replace Processing action is added in the Selected Actions list.

    To remove an action from the list, click the Delete icon to the right of the action.

  7. In the Find field, add the text that you want to find and in the Replace with field, enter replacement text. The find and replace action is case-sensitive. You can add multiple Find and Replace text in a single Find and Replace Action by clicking the Add + icon.
  8. To add another replacement text, click the Add + icon.
  9. You can add multiple Find and Replace preprocessing actions for each target. To add another Add and Replace action, click Find and Replace from the All Action list.
    Find text is a mandatory field. Hence cannot be left empty. If the fields are empty, you get an error.
  10. Click OK. Or click Cancel to cancel the action.
    After the successful transfer, the report can be seen in the Monitor Dashboard. For more information see Monitoring Deployed Sources, Targets, and Transfers.
2.2.4.3 Encryption and Decryption Preprocessing Actions

You can encrypt or decrypt a file prior to transfer. You can specify only one encryption or decryption algorithm in the transfer configuration. Along with PGP algorithm, MFT supports PGP signatures. You can generate a signed and encrypted payload and validate the signature when decrypting, this can be done at the artifact level.

Note:

PGP keystores must be configured and certificates must be imported before you add an encryption or decryption action.

If a payload is encrypted by a PGP tool outside of MFT using a key length or algorithm that is restricted, MFT decryption fails. These restrictions are mostly specified at the JRE level in the JAVA_HOME\jre7\lib\security directory.

The steps for this process are:

  1. Click the arrow to the left of Transfers in the left pane navigator.

    The transfers are listed.

  2. Click the transfer name or right-click it and then select the Open menu item.

    The General Information and Target Definitions tab opens.

  3. Click the arrow to the left of the Target Definition tab.

    The target settings are displayed.

  4. On the Target details, click Pre-processing actions.

    The Pre-Processing Actions dialog opens.

  5. Select PGP Encryption or PGP Decryption from the All Actions drop-down list.
  6. Click Add to List. The selected action appears in the Selected Actions list.
    To remove an action from the list, click the Delete icon to the right of the action.
  7. If you selected PGP Encryption, select values from the Encryption Alias, Armored, Encryption Algorithm, and Signing key alias drop-down lists:
    • Encryption Alias: the public key alias for encryption. For more information about key aliases, see Configuring the PGP Keystore.

    • Armored: Binary or ASCII. Use ASCII if non-printing characters might be stripped in transit.

    • Encryption Algorithm: Select from the following supported algorithms:

      Note:

      If no algorithm is selected, global algorithm settings apply.
      • Default

      • Triple-DES

      • CAST5 – set as default algorithm

      • Blowfish

      • DES

      • AES-128

      • AES-192

      • AES-256 – set as default algorithm if FIPS mode is enabled

      • Twofish

    • Signing key alias: Select from the list of imported private signing keys.
  8. If you selected PGP Decryption, select the Decryption Alias from the drop-down list. This is the private key alias for decryption. For decrypting, the signature must be imported in the PGP keystore.
    For more information about key aliases, see Configuring the PGP Keystore.
  9. Click OK.

    To cancel adding actions, click Cancel.

  10. Save and Deploy the transfer.
    After successful transfer, you can monitor the result in the Monitor dashboard. See Monitoring Deployed Sources, Targets, and Transfers and Transfer Reports.
2.2.4.3.1 Changing Encryption Algorithm for PGP

To change encryption algorithm for PGP, follow these steps:

  1. Step A
    1. Log in to Oracle Enterprise Manager Fusion Middleware Control.
    2. Expand the SOA node and select the soa-infra node.
    3. From the SOA Infrastructure menu, choose Administration > System MBean Browser . The System MBean Browser page is displayed.
    4. Under Application Defined MBeans, expand the server - oracle.as.soainfra.config node. For example, oracle.as.mftinfra.config node.
    5. Expand the Server: soa_server1 node For example, mft_server1 node.
    6. Expand the MFTConfig node.
    7. Click the MFT MBean. The properties of the MBean are displayed in the right pane.
    8. Click the Operations tab.
    9. Click addProperty operation in the list. Enter values for the key, value, and optional comments.
      i. Set Key value to "pgpEncryptionAlgorithm"
      ii. Set value. For example, set value as “2” for Triple DES, and click Invoke.
  2. Step B
    1. In MFT, to change the encryption algorithm for PGP, set the "pgpEncryptionAlgorithm" MBean for MFT. This Mbean accepts int value and different values for the supported algorithms are listed below:

      i. Triple DES = 2;

      ii. CAST5 = 3;

      iii. Blowfish = 4;

      iv. DES = 6;

      v. AES 128 = 7;

      vi. AES 192 = 8;

      vii. AES 256 = 9;

      viii. Twofish = 10;

    2. In FIPS mode, when MBean property PGPEncryptionAlgorithm is not defined, then the default algorithm is AES 256. Supported algorithms are:

      i.AES 128

      ii.AES 192

      iii.AES 256

    3. In non-FIPS mode, when MBean property PGPEncryptionAlgorithm is not defined, then the default algorithm is CAST5. Supported algorithms are:

      i. Triple DES

      ii. Blowfish

      iii. DES

      iv. AES 192

      v. AES 128

      vi. AES 256

      vii.Twofish

2.2.4.4 New Line Conversion Processing Action

Use the New Line Conversion preprocessing action to convert new line characters for different operating systems. The New line conversion action converts the new line character to the specified operating system specific new line character. New line conversion action can be added at source processing action or target preprocessing action.

The steps for this process are:
  1. Click the arrow to the left of Transfers in the left pane navigator.
    The transfers are listed.
  2. Click the transfer name or right-click it and then select the Open menu item.
    The General Information and Target Definitions tab opens.
  3. Click the arrow to the left of the Target Definition tab.
    The target settings are displayed.
  4. On the Target details, click Pre-processing actions.
    The Processing Actions dialog opens.
  5. Select New line conversion from the drop-down list.
    New line conversion is displayed in Selected Actions.
  6. In the Type field, select from the list:
    • DOS to Unix
    • Unix to DOS
    To delete the New line conversion, click the Delete icon to the left of the action.
  7. Click OK.
    To cancel, click Cancel.
2.2.4.5 Run Script Preprocessing Action

Use the Run Script preprocessing action for sources and targets to execute any script or command like shell commands, perl commands or bat files on a file before delivering it to the target. You can execute any custom commands such as Virus Scan, external encryption file processing, add new endpoints, enable REST, notify or validate inside the script. You may run the script to modify the payload by replacing certain words or add or validate signature information during encryption and decryption.

Example of a script adding a header:
#bin/sh
echo "file generated by script copy"
while read line; do
echo ${line}
done
]

Example of a script for compression:
#bin/sh
gzip -c

Example of a error script :
#bin/sh
regexA="*.bak"
regexB="*.BAK"
if [[ "$fileName" == $regexA || "$fileName:" == $regexB ]]; then
		echo "Processing backup file"
else
		echo "Input file[$fileName] is not valid backup file!" 1>&2  
		exit 1
fi

In the error script example, considering transfer is created to move backup (*.bak) files from source to target, if transfer file is not a backup (*.bak) file, transfer will fail with error “Input file[f2] is not valid backup file.”

There are pre-defined variables which can be used in the script, for example fileName is a pre-defined variable.

To add Run Script pre-processing action:
  1. Click the arrow to the left of Transfers in the left pane navigator.
    The transfers are listed.
  2. Click the transfer name or right-click it and then select the Open menu item.
    The General Information and Target Definitions tab opens.
  3. In Target Definitions tab, on the Target details, click Pre-Processing Actions.
    The Pre-Processing Actions dialog opens.
  4. Select Run Script action from the All Actions drop-down list and click Add to list.
    It appears in the Selected Actions list.
  5. Enter the following details:
    • Command: enter the path of the script you want to execute. The script needs to be an executable file. For example, /home/user/echo.sh
    • Timeout: Specify the timeout value, if the execution of the script takes more than specified time it will stop the execution of the script. If there is an error in the transfer, the error is reflected in the MFT monitoring dashboard, after diagnosis it can be resubmitted.
    • Read Input Payload: select the checkbox if you want the script (provided in Command field) to read the input payload before transfer. By default, the checkbox is selected.

    • Use Script Generated Payload: select the checkbox if you want to modify the existing payload with the output generated by the script. When unchecked, the script is executed without modifying the payload.

    • New File Extension: Specifies the extension that is added to the new file after processing is done. For example, when using compression action, you may want to modify the name to <filename>.zip, then you will set 'zip' as the new file extension.

  6. Click Add or Update Script Variable if you want to update, add or modify any parameter or variable in the script. There are pre-configured runtime parameters (filename, payload directory, filesize, targetname, sourcename, useGeneratedFileFromScript) which are updated and passed to script.
    1. To add a variable to the script, click the Add row icon +.
    2. Enter the Name of the variable and the Value.
    3. If the variable value must be encrypted, check the box against ls Credential
    4. To delete a variable, click the Delete icon next to the Value field.
    5. Click OK.
  7. Click OK to save the action or Cancel to cancel the action.
2.2.4.6 ODIInvoke Post-Processing Actions

This post processing function is used to configure the ODIInvoke web service and is invoked after delivering the payload to the JCA bindings configured at the ODI target. The ODIInvoke service triggers an ODI flow to retrieve the payload from the JCA binding target type configured at the ODI target. The MFT message is marked as complete once payload delivery is completed and the odiInvoke service is invoked.

The MFT ODI target configures the JCA binding types along with the existing SOAP method of message delivery. You can configure the following binding types in the ODI target:

  • File- Transfer file via File

  • FTP Remote- Transfer file via FTP

  • sFTP Remote- Transfer file via sFTP

  • SOAP- Transfer file via ODI SOAP DataService

After selecting one of the JCA binding types,  you must configure the required parameters for the JCA targets. Once a binding type is selected for an ODI target, you can’t change the binding type, but you can continue modifying the parameters of the current JCA target binding.

When you add an ODI target with JCA binding to a transfer, a post processing function, OdiInvokeWebService, must be configured at the target. You need to configure the OdiInvoke service URL, action, and other required parameters in this post processing function.

In the OdiInvoke post processing function, fields are exposed to configure the odiInvoke service URL, port, operation, and other parameters exposed below:

  • Request ScenarioRequestType

  • ScenarioName string 

  • ScenarioVersion string 

  • Context string

  • Synchronous boolean

  • SessionName string

  • Keywords string

  • Variables VariableTypeArray Size

  • Variables VariableType Name and Value string 

  • Debug DebugType

    For Debug to work correctly, explicitly select the Debug checkbox. If you check any other option (under Debug such as BreakOnError) without selecting the Debug checkbox, it may not work correctly.

During MFT message processing for an ODI target of a binding type JCA, the payload is moved to the JCA location configured at the target. The message is constructed in the format expected by the odiInvoke service by reading all the configuration parameters. Then the URL configured at the ODI target is invoked and the request message is constructed. Once MFT is able to invoke the ODI target successfully, MFT's message is marked as COMPLETED.

2.2.4.7 Decompression Postprocessing

You can decompress a file after transfer only if the target type is File. You can specify this action in the transfer configuration.

Multi-file decompression postprocessing is supported. In this case, the decompressed files are extracted to a directory under the target location having the name of the ZIP file without the extension. For example, if the target location is /tmp/mft and the transferred file with multiple entries is order.zip, decompressed files are extracted to /tmp/mft/order.

Note:

Any processing function added after the multi-file decompression is ignored.

The steps for this process are:

  1. Click the arrow to the left of Transfers in the left pane navigator.

    The transfers are listed.

  2. Click the transfer name or right-click it and then select the Open menu item.

    The transfer tab opens.

  3. Click the arrow to the left of the target.

    The target settings are displayed.

  4. Click add post-processing actions.

    The Post-Processing Actions dialog opens.

  5. Select Decompress from the All Actions drop-down list.
  6. Click Add to List.

    To remove an action from the list, click the Delete icon to the right of the action.

  7. Click OK.

    To cancel adding actions, click Cancel.

  8. Save and Deploy the transfer.
2.2.4.8 Transfer Notification Postprocessing Action

The Transfer Notification postprocessing action is used to notify users on successful payload transfer. You can specify which channel—email or SMS— to use for sending the notification. You can configure the format of the email/message, file name pattern, and minimum file size to notify.

Note:

MFT supports plain text in successful transfer notification template.
Ensure that the driver properties usermessagingdriver-email (mft_server1) in User Messaging Service (UMS) are set. For more information, refer Oracle User Messaging Service Drivers
To add Transfer Notification as a postprocessing action:
  1. Click the arrow to the left of Transfers in the left pane navigator.

    The transfers are listed.

  2. Click the transfer name or right-click it and then select the Open menu item.

    The transfer tab opens.

  3. Click the arrow to the left of the Target Definition.

    The target settings for Source and Targets are displayed.

  4. Click add post-processing actions.

    The Post-Processing Actions dialog opens.

  5. Select Transfer Notification from the All Actions drop-down list.
  6. Click Add to List.

    To remove an action from the list, click the Delete icon to the right of the action.

  7. Provide the following details on the Transfer Notification fields:
    • Template File: (Optional) Specifies an e-mail template file location to be sent as part of transfer notification. For example: /u01/data/mft/notify.eml

      When a variable is specified in the Template File field, for example %%FILENAME%% , Oracle MFT takes the File name from the run-time session. The pre-seeded variables you can use to create a template are FILENAME, DATE, TRANSFERURL, SOURCENAME, USER, FILESIZE, TARGETFILENAME, TARGETNAME, TRANSFERNAME, TARGETENDPOINTREF, TARGETFILESIZE.

      Note that To, CC and BCC fields are optional parameters, however Subject and body are mandatory parameters. If the Template File field is blank, following default template file is used:

      CC= abc.xyz@oracle.com; user@oracle.com; test.user@oracle.com

      BCC= test@oracle.com; new.user@oracle.com

      Subject= File %%FILENAME%% Successfully Processed

      Body= The file %%FILENAME%% uploaded by %%USER%% of size %%FILESIZE%% from the source %%SOURCENAME%% was successfully processed on %%DATE%% by Oracle MFT. You can optionally view the %%TRANSFERURL%% details of the transfer from the console.

    • Minimum File Size: Specifies the minimum file size in MB for sending notification.

    • Pattern Type: Specifies how the filter string is interpreted: Wildcard (the default) or Regular Expression.

      If you selected Wildcard, use * as a wildcard. For example, *.xml specifies that XML files are transferred. To specify text or XML files, you can use *.(xml|XML|txt|TXT).

      For example, File = "TXT-20100505-XXXX.txt" where XXXX can be any four successive digits.

      Regular Expression = "XT-20100505-\\d{4}\\.txt"

    • File Name Pattern: (Optional) Specifies the file name pattern for sending notification.

    • Add or Update Contacts to Notify: Select this option if you want to add user contacts to notify. When clicked, Search Contacts dialog opens.

    • Search Contacts:You can search and add contacts by type - User, External, or Group.

      Before you add users in the Add or Update Contact Users to Notify, you have to create and configure new contact users using the WLST command. You can create new users or you can use existing WebLogic users and User groups.

      Note:

      You can configure only internal contacts using the WLS console, which uses the LDAP user settings. You can use the WLST commands to configure both internal and external contacts.

      To create new external users, use the WLST command, createContact. To use existing Weblogic users or user groups, use the WLST command, createUserContact or create UserGroupContact. These users are internal and the email address and phone number come from the LDAP user setting. For more information, refer Enable Event Notification.

      Before you can run WLST commands, you must start WLST and connect to the Oracle WebLogic Server managed server dedicated to Oracle MFT. For more information, refer Running WLST Commands.

      To create user contacts:

      1. To create User contact, (Internal user) use the WLST command: createUserContact('weblogic','Email')

        Attributes Description Syntax Example
        wls:/soainfra/serverConfig/> help('createUserContact') Create a new user contact, which can be used for event notification. Shortcut for this command is 'crtUCont'. createUserContact(<userName>,<deliveryChannel>)

        userName: user namedeliveryChannel (optional): possible values Email/SMS. If not specified, it will use the user preferred delivery channel configured in the WebLogic user store.

        wls:/mydomain/serverConfig> createUserContact('user1')wls:/soainfra/serverConfig/>
        To create a Group user, (Internal user) use the WLST command: createUserGroupContact(‘usergroup’)
        Attributes Description Syntax Example
        wls:/soainfra/serverConfig/> help('createUserGroupContact') Create a new user group contact, which can be used for event notification. Shortcut for this command is 'crtUGCont'. createUserGroupContact(<userGroupName>, <deliveryChannel>)

        userGroupName: user group name deliveryChannel (optional): possible values Email/SMS. If not specified, it will use the user preferred delivery channel configured in the weblogic user store.

        wls:/mydomain/serverConfig> createUserGroupContact('userGroup1')

        To create a new External contact, use the WLST command: createContact('Email','abcd@efgh.com')

        Attributes Description Syntax Example
        wls:/soainfra/serverConfig/> help('createContact') Create a new contact, which can be used for event notification. Shortcut for this command is 'crtCont'. createContact(<CType>,<Value>)

        ContactType: Email / SMS Value: Value for the contact type, ex. Email id or phone no.

        wls:/mydomain/serverConfig> createContact('Email','abcd@efgh.com')
      2. Go to WLS Admin console and add the email/contact number for the user.

        In the WLS Admin console, go to Home >Summary of Security Realms >myrealm >Users and Groups ><user> and update the channel of communication. Enter the email address and the phone number for SMS.

      3. Search for users in Transfer Notification dialog and associate with the notification action.

        The search result is corresponding to the user type. For example, if you search for External users, only external users are listed, User and Group users are not listed.

  8. Click Add after adding or modifying the contacts. The added contacts are listed in the Selected Contacts for Notification text box.
  9. Click OK to continue.

2.2.5 Duplicating an Existing Transfer

You can create a new file transfer by copying an existing one. The new transfer references the same source and targets as the copied transfer.

The steps for this process are:

  1. Duplicate a transfer in one of these ways:
    • Select the transfer to copy and then the Duplicate icon in the left pane navigator.

    • Right-click the transfer to copy in the left pane navigator and select the Duplicate command from the pop-up menu.

    The Duplicate Transfer dialog appears.

  2. Type a Name for the transfer.

    The name can include letters, numbers, dashes, and underscores.

  3. Click the Create button.

    A tab for the transfer opens, providing additional settings you can edit. For more information about these settings, see these sections:

    To avoid creating a transfer, click Cancel.

  4. Click the Save button after editing.

    To undo all changes since the last save, click Revert.

  5. Click the Deploy button after saving.

    Deploying a transfer deploys the associated source and target automatically.

2.3 Creating a Source

You can create a source with a minimum number of settings. After you create it, you can edit to add more settings to it.

The steps for creating a source are:

  1. Create a source in one of these ways:
    • Click create source in the transfer tab.

    • Double click Sources in the left pane navigator.

    • Select Sources in the left pane navigator and click the Create icon.

    • Right-click Sources in the left pane navigator and select the Create command.

    • Duplicate an existing source.

    The Sources dialog opens.

  2. Type a Name for the source.
    The name can include letters, numbers, dashes, and underscores.

    Note:

    In case of SOA/SOAP source, file names must not have spaces.
  3. Type a Description for the source.

    The description is optional.

  4. Select the source Type.

    This setting determines the other settings that appear. For more information about source types and their settings, see Source Types.

  5. Type a value for the source location. For most source types, this is either:
    • The Folder setting, which specifies a file system directory. Ensure that the folder name does not exceed 60 characters.

    • The URL setting, which specifies a web service endpoint.

    The B2B and Healthcare source types have no source location setting in the Sources dialog. You must provide the source location after creating the source.

  6. Type values for the required settings, which have blue asterisks next to them.

    The only source types with required settings in addition to the source location are the FTP Remote Source Type and sFTP Remote Source Type. Some of these settings have defaults that you can accept and edit later.

  7. Click the OK button.

    A tab for the source opens, providing additional settings you can edit. For more information about these settings, see the source type under Source Types, Setting Up Schedules, Setting Up Source Processing Actions, and Archiving and Deleting Files Before Delivery.

    To avoid creating a source, click Cancel.

  8. Click the Save button after editing.

    To undo all changes since the last save, click Revert.

  9. Click the Deploy button after saving.

    You can add an optional comment.

    This step is optional. Deploying a transfer deploys the associated source and target automatically.

If an existing source has most of the desired properties, you can duplicate it. See Duplicating an Existing Source.

2.3.1 Source Types

Oracle Managed File Transfer provides the following source types:

2.3.1.1 FTP Embedded Source Type

Using the FTP Embedded source type means uploading files to the FTP server embedded by Oracle Managed File Transfer, which transfers the files. The only required setting is Folder, which specifies the embedded FTP server directory from which to transfer files.

Note:

Files present in the embedded FTP source directory before the source is deployed or enabled are ignored. Only files uploaded to the directory after deployment or enabling are picked and transferred.

For more information about other settings you can edit after you create the source, see "Source—FTP Embedded" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.3.1.2 sFTP Embedded Source Type

Using the sFTP Embedded source type means uploading files to the sFTP server embedded by Oracle Managed File Transfer, which transfers the files. The only required setting is Folder, which specifies the embedded sFTP server directory from which to transfer files.

Note:

Files present in the embedded sFTP source directory before the source is deployed or enabled are ignored. Only files uploaded to the directory after deployment or enabling are picked and transferred.

For more information about other settings you can edit after you create the source, see "Source—sFTP Embedded" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.3.1.3 FTP Remote Source Type

Using the FTP Remote source type means transferring files from an FTP server outside of Oracle Managed File Transfer. Table 2-1 lists the settings in the Sources dialog specific to the FTP Remote type.

Table 2-1 Sources Dialog Settings for the FTP Remote Source Type

Setting Description

Host Name

Specifies the host name.

Folder

Specifies the directory from which files are transferred.

User

Specifies the user accessing the source.

Password

Specifies the user password.

Confirm Password

Confirms the user password.

Control Port

Specifies the port for the source.

SSL

Specifies the use of SSL if checked. This is optional.

Implicit SSL

Specifies the use of implicit SSL if checked. This is optional.

Note:

If you choose List Parser Key as Windows, the recent date and default date format is automatically changed to MM-dd-yyyy HH:mm which is the only supported format in Windows. However, for connecting to Windows (s)FTP Servers, you need to change the List Parser Key to Windows, and have the recent date and default date format configured to MM-dd-yyyy HH:mm format.

For more information about other settings you can edit after you create the source, see "Source—FTP Remote" in the Oracle Fusion Middleware MFT Composer Help Online Help.
2.3.1.3.1 FTP Remote Source Advance Properties for MVS Transfers

When creating a FTP Remote source type for MVS Mainframe systems, you need to select MVS as List Parser Key in advance properties.

For MVS FTP response formats, MVS can be configured to use HFS (Unix style) response or MVS native response formats.

FTP Remote Source Settings for MVS Transfers

Configure the FTP Remote source type as shown in figure below:

Note:

The following properties must be selected in the format listed below:
  • Change Directory=”true”

  • Content Folder is a mandatary and must be in the format: ”'FOLDER.'”

  • FTP Path Separator = ””

  • Absolute Path Begin = ””

  • List Parser Key = MVS

2.3.1.4 sFTP Remote Source Type

Using the sFTP Remote source type means transferring files from an sFTP server outside of Oracle Managed File Transfer. Table 2-2 lists the settings in the Sources dialog specific to the sFTP Remote type.

Table 2-2 Sources Dialog Settings for the sFTP Remote Source Type

Setting Description

Host Name

Specifies the host name.

Folder

Specifies the directory from which files are transferred.

User

Specifies the user accessing the source.

MFT treats properties beginning with $ as parameters. Add a backslash before the $ for user names that start with $. This is only for a leading $. If there are other $s in the password, do not add more backslashes. Example: for $xyz$123, enter the password as \$xyz$123.

Password

Specifies the user password.

MFT treats properties beginning with $ as parameters. Add a backslash before the $ for sFTP passwords that start with $. This is only for a leading $. If there are other $s in the password, do not add more backslashes. Example: for $xyz$123, enter the password as \$xyz$123.

Confirm Password

Confirms the user password.

Control Port

Specifies the port for the source.

Authentication Type

Specifies the authentication type: Password or Public Key.

Note:

If you choose List Parser Key as Windows, the recent date and default date format is automatically changed to MM-dd-yyyy HH:mm which is the only supported format in Windows. However, for connecting to Windows (s)FTP Servers, you need to change the List Parser Key to Windows, and have the recent date and default date format configured to MM-dd-yyyy HH:mm format.

For more information about other settings you can edit after you create the source, see "Source—sFTP Remote" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.3.1.5 File Source Type

Using the File source type means transferring files from the local file system or from a network-attached system. The only required setting is Folder, which specifies the directory from which to transfer files. This directory must be accessible from Oracle Managed File Transfer.

Oracle Managed File Transfer uses the same file adapter used by Oracle SOA Suite.

For more information about other settings you can edit after you create the source, see "Source—File" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.3.1.6 SOAP Web Service Source Type

Using a SOAP web service type means transferring files from a web service endpoint. The only required setting is URL, which specifies the web service endpoint from which to transfer files.

To capture the filename or store the target filename in source, you need to pass the filename for inline payloads, as shown in the SOAP request below:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> 
		 <soap:Header>
			<ns1:MFTHeader xmlns:ns1="http://xmlns.oracle.com/fmw/mft/soap"> 
						<ns1:TargetFilename>Order.xml</ns1:TargetFilename> 
						<ns1:ContentIdentifier>Order.xml</ns1:ContentIdentifier> 
						<ns1:file.name>OrderIn.xml</ns1:file.name> 
				</ns1:MFTHeader> 
		</soap:Header>  
		<soap:Body> 
			 <ns1:MFTServiceInput  xmlns:ns1="http://xmlns.oracle.com/fmw/mft/soap"> 
 					<ns1:InlinePayload>  
 						<PurchaseOrder>  
  					      </PurchaseOrder> 
  			 </ns1:InlinePayload>  
 		 </ns1:MFTServiceInput> 
	</soap:Body> 
</soap:Envelope>

MFT supports the SwaRef type of attachments that can be sent as part of the SOAP request by using JAVA API based clients or Third party user interface clients.

Example of sFTP Reference:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://xmlns.oracle.com/fmw/mft/soap">
   <soapenv:Header>
      <soap:MFTHeader>
         <soap:TargetFilename>USD_VK_VKV_Rep_16_2.zip</soap:TargetFilename>
         <soap:ContentIdentifier>USD_VK_VKV_Rep_16_2.zip</soap:ContentIdentifier>
      </soap:MFTHeader>
   </soapenv:Header>
   <soapenv:Body>
      <soap:MFTServiceInput PayloadType="FtpRefFile">
         <soap:FTPReference>
            <soap:URL>ftp://localhost:7522/int/soap/USD_VK_VKV_Rep_16_2.zip</soap:URL>
         </soap:FTPReference>
      </soap:MFTServiceInput>
   </soapenv:Body>
</soapenv:Envelope>
Example of SwaRef (SOAP with Attachments) type:
POST /mftapp/services/transfer/mySource HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: multipart/related; type="text/xml"; start="<rootpart@soapui.org>"; boundary="----=_Part_6_72190877.1547746700867"
SOAPAction: "http://xmlns.oracle.com/fmw/mft/soap/mftSubmit"
MIME-Version: 1.0
Content-Length: 1410
Host: localhost:7003
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

------=_Part_6_72190877.1547746700867
Content-Type: text/xml; charset=UTF-8
Content-Transfer-Encoding: 8bit
Content-ID: <rootpart@soapui.org>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://xmlns.oracle.com/fmw/mft/soap">
   <soapenv:Header>
      <soap:MFTHeader>
         <soap:TargetFilename>?</soap:TargetFilename>
         <soap:ContentIdentifier>?</soap:ContentIdentifier>
         <soap:DeliveryOnly>
            <soap:TargetFilesize>?</soap:TargetFilesize>
            <soap:SourceUser>?</soap:SourceUser>
            <soap:TransferURL>?</soap:TransferURL>
            <soap:SourceName>?</soap:SourceName>
            <soap:TargetName>?</soap:TargetName>
            <soap:TransferName>?</soap:TransferName>
         </soap:DeliveryOnly>
      </soap:MFTHeader>
   </soapenv:Header>
</soapenv:Envelope>
------=_Part_6_72190877.1547746700867
Content-Type: text/xml; charset=us-ascii; name=test.xml
Content-Transfer-Encoding: 7bit
Content-ID: <test.xml>
Content-Disposition: attachment; name="test.xml"; filename="test.xml"
Example of binary payload:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
                <soap:Header>
                                <ns1:MFTHeader xmlns:ns1="http://xmlns.oracle.com/fmw/mft/soap">
                                                <ns1:TargetFilename>Order.xml</ns1:TargetFilename>
                                                <ns1:ContentIdentifier>Order.xml</ns1:ContentIdentifier>
                                                  <ns1:file.name>OrderIn.xml</ns1:file.name>
                                </ns1:MFTHeader>
                </soap:Header>
                <soap:Body>
                                <ns1:MFTServiceInput xmlns:ns1="http://xmlns.oracle.com/fmw/mft/soap">
                                                <ns1:BinaryPayload>
CQkJCTxQdXJjaGFzZU9yZGVyPg0KCQkJCQk8Y3VzdElEPjE8L2N1c3RJRD4NCgkJCQkJPElEPjEwNTwvSUQ+DQoJCQkJCTxwYXlPcHRpb24+Y3Jl
ZGl0PC9wYXlPcHRpb24+DQoJCQkJCTxzaGlwQ2hvaWNlPnR3b19kYXk8L3NoaXBDaG9pY2U+DQoJCQkJCTxzdGF0dXM+aW5pdGlhbDwvc3RhdHVz
Pg0KCQkJCQk8Y2NUeXBlPkFNRVg8L2NjVHlwZT4NCgkJCQkJPGNjTnVtYmVyPjU2NzgtNTY3OC01Njc4LTU2Nzg8L2NjTnVtYmVyPg0KCQkJCQk8
aXRlbXM+DQoJCQkJCQk8aXRlbT4NCgkJCQkJCQk8cHJvZHVjdElkPlNLVTIwMDwvcHJvZHVjdElkPg0KCQkJCQkJCTxwcm9kdWN0TmFtZT5Wb3gg
MjAwMCBaWFA8L3Byb2R1Y3ROYW1lPg0KCQkJCQkJCTxwcmljZT4xMTAwPC9wcmljZT4NCgkJCQkJCQk8cXVhbnRpdHk+MjwvcXVhbnRpdHk+DQoJ
CQkJCQk8L2l0ZW0+DQoJCQkJCQk8aXRlbT4NCgkJCQkJCQk8cHJvZHVjdElkPlNLVTEwNjwvcHJvZHVjdElkPg0KCQkJCQkJCTxwcm9kdWN0TmFt
ZT5HaWJzb24gTGVzIFBhdWw8L3Byb2R1Y3ROYW1lPg0KCQkJCQkJCTxwcmljZT4zMDAwPC9wcmljZT4NCgkJCQkJCQk8cXVhbnRpdHk+MTwvcXVh
bnRpdHk+DQoJCQkJCQk8L2l0ZW0+DQoJCQkJCTwvaXRlbXM+DQoJCQkJPC9QdXJjaGFzZU9yZGVyPg==
                                                </ns1:BinaryPayload>
                                </ns1:MFTServiceInput>
                </soap:Body>
</soap:Envelope>

For more information about integrating with Oracle Managed File Transfer as a web service, see Integrating with Web Services.

For more information about other settings you can edit after you create the source, see "Source—SOAP" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.3.1.7 SOA Source Type

Using the SOA source type means transferring files from the web service interface of a SOA application. The only required setting is the Location URL, which specifies the suffix portion of the web service endpoint that SOA uses.

For example: http://<HOST:PORT/mftapp/services/transfer/<URL>?WSDL

To capture the filename or store the target filename in source, you need to pass the filename for inline payloads, as shown in the SOAP request below:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> 
		 <soap:Header>
			<ns1:MFTHeader xmlns:ns1="http://xmlns.oracle.com/fmw/mft/soap"> 
						<ns1:TargetFilename>Order.xml</ns1:TargetFilename> 
						<ns1:ContentIdentifier>Order.xml</ns1:ContentIdentifier> 
						<ns1:file.name>OrderIn.xml</ns1:file.name> 
				</ns1:MFTHeader> 
		</soap:Header>  
		<soap:Body> 
			 <ns1:MFTServiceInput  xmlns:ns1="http://xmlns.oracle.com/fmw/mft/soap"> 
 					<ns1:InlinePayload>  
 						<PurchaseOrder>  
  						</PurchaseOrder> 
  			 </ns1:InlinePayload>  
 		 </ns1:MFTServiceInput> 
	</soap:Body> 
</soap:Envelope>

For more information about integrating Oracle Managed File Transfer with Oracle SOA Suite, see Integrating with Oracle SOA Suite.

For more information about other settings you can edit after you create the source, see "Source—SOA" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.3.1.8 Service Bus Source Type

Using the Service Bus source type means transferring files from the web service interface of an Oracle Service Bus application. The only required setting is URL, which specifies the web service endpoint from which to transfer files.

For more information about integrating Oracle Managed File Transfer with Oracle Service Bus, see Integrating with Oracle Service Bus.

For more information about other settings you can edit after you create the source, see "Source—Service Bus" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.3.1.9 B2B Source Type

Using the B2B source type means transferring files from an Oracle B2B trading partner. No settings are required if B2B is collocated. The most important settings are Trading Partner Name, which specifies the endpoint from which to transfer files, and Domain Alias, which specifies the domain from which to transfer files.

To define a trading partner in Oracle Managed File Transfer, see Integrating with B2B and Managing Domains.

For more information about other settings you can edit after you create the source, see "Source—B2B" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.3.1.10 Healthcare Source Type

Using the Healthcare source type means transferring files from an Oracle B2B for Healthcare domain. The only required setting is Endpoint Name, which specifies the endpoint from which to transfer files. Another important setting is Domain Alias, which specifies the domain from which to retrieve files.

To define a Healthcare domain in Oracle Managed File Transfer, see Integrating with Healthcare and Managing Domains.

For more information about other settings you can edit after you create the source, see "Source—Healthcare" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.3.1.11 Oracle WebCenter Content Server Source Type

Using the Oracle Content Server source type, you can download data from WebCenter Content Server. You can create, save, deploy, and associate the source to any transfer.

Both the GET_FILE and GET_SEARCH_RESULTS service parameters are exposed as part of the trigger. The GET_SEARCH_RESULTS service in the UCM gets the list of payloads. Using the trigger, you can also specify the specific payload that needs to be downloaded. The GET_FILE service is used to get the payload.

Configurable retry options via MBean are provided for the source. When all the retries are exhausted, there will be an entry in the source message table for the files that were not downloaded.

A schedule can be attached with the Content Server source. As part of schedule MFT calls the GET_SEARCH_RESULTS service with the provided queryString param in the source configuration.

For details about the configurable parameters for the WebCenter Content source, see “Source- WebCenter” in Oracle Fusion Middleware MFT Composer Help Online Help.

For details about working with WebCenter Content, see Developing with Oracle WebCenter Content.

2.3.1.12 Oracle Storage Cloud Source Type

You can use Oracle MFT to download and upload the data from an Oracle Storage Cloud Service source. Using the Oracle Cloud Storage (OCS) source type you can create, save, deploy, and associate the source to any transfer. Trigger and polling is available for the OCS endpoints. Duplicate handling is controlled by MFT. If the trigger is invoked multiple times for the same directory, a file in the directory is processed only once by MFT. MFT keeps track of already processed files.

Oracle Storage Cloud has a limitation of 5GB as the maximum file size that can be uploaded to OCS. The actual file size can be larger than 5GB but when the large file is split into segments, the maximum segment size can be 5GB or less. In MFT target setting, a user can configure the segment size. For the outbound, a large file is split into segments that are uploaded first. A segment suffix is added to each segment, for example, a.txt-segment-001, a.txt-segment-002 and so on. After uploading all the segments, the actual object manifest file (a.txt) is uploaded. Segment files and actual files can be uploaded in different containers. When downloading, OCS automatically merges the segments after the download.

For details about the configurable parameters for the Oracle Storage Cloud source, see “Source- Storage Cloud” in Oracle Fusion Middleware MFT Composer Help Online Help.

2.3.1.13 ODI Source Type

The MFT ODI integration supports two different Source interfaces, a file Event pattern and a WebService ODI.

For more information about other settings you can edit after you create the source, see "Source—ODI" in the Oracle Fusion Middleware MFT Composer Help Online Help.

To define an ODI domain in Oracle Managed File Transfer, see Integrating with Oracle Data Integrator and Managing Domains.

A file Event pattern (which can be scheduled) on top of the binding endpoint type (File, FTP, sFTP) retrieves files from wherever ODI has put them. You can configure JCA source types as bindings in the ODI source along with the existing SOAP binding. You can configure the following as binding types when creating the target:

  • File- Transfer file via File

  • FTP Remote- Transfer file via FTP

  • sFTP Remote- Transfer file via sFTP

  • SOAP- Transfer file via ODI SOAP DataService

Once you have chosen one of the JCA source types, you must configure the JCA parameters as you do regular JCA sources. Once the binding type is chosen for an ODI source, you can’t change the binding type but you can modify the properties for the selected binding type.

A WebService ODI source type accepts the MFT SOAP payload from the ODI application. Just like the SOAP or SOA Sources, the only required setting is URL, which specifies the web service endpoint from which to transfer files either inline or as a reference.

2.3.2 Setting Up Source Processing Actions

After you create a source, you can edit it to add processing actions such as compression, decompression, encryption or decryption, find and replace specific text, or new line character conversion to specified operating system.

You can configure processing actions for the transfer; see Setting Up Transfer Preprocessing and Postprocessing Actions.

You can also create custom preprocessing and postprocessing actions; see Processing Transfers with Custom Callouts.

Note:

If you add the same processing action to a source and a transfer that uses the source, the action is performed twice. For example, if you add compression to the source and the transfer, the transferred file is compressed twice.

A preprocessing decompression error occurs if a compressed file has multiple entries.

Note:

If you copy a binary file to the source location using an FTP client external to Oracle Managed File Transfer, be sure to configure it for binary transfer. Otherwise the file might become corrupted. Processing actions such as compression and encryption might not work properly.

2.3.2.1 Compression and Decompression at the Source

You can compress or decompress a file prior to transfer. You can specify either action in the source configuration.

Note:

Multi-file decompression is not supported for sources. It is supported only for SOAP, SOA, Service Bus, or ODI type targets as a preprocessing action or for File type targets as a postprocessing action.

The steps for this process are:

  1. Click the arrow to the left of Sources in the left pane navigator.

    The sources are listed.

  2. Click the source name or right-click it and then select the Open menu item.

    The source tab opens.

  3. Click the arrow to the left of Actions.

    The Actions section opens.

  4. Click add processing actions.

    The Processing Actions dialog opens.

  5. Select Compress or Decompress from the All Actions drop-down list.
  6. Click Add to List.

    To remove an action from the list, click the Delete icon to the right of the action.

  7. If you selected Compress, select the compression level from the Level drop-down list: Best Compression, Default Compression, or Best Speed. For more information, see the java.util.zip package, especially the Deflater class and the referenced specifications.
  8. Click OK.

    To cancel adding actions, click Cancel.

  9. Save and optionally Deploy the source.
2.3.2.2 Encryption and Decryption at the Source

You can encrypt or decrypt a file prior to transfer. You can add a single encryption or decryption algorithm to the source configuration. Along with PGP algorithm, MFT supports PGP signatures. You can generate a signed and encrypted payload and validate the signature when decrypting, this can be done at the artifact level.

Note:

PGP keystores must be configured and certificates must be imported before you add an encryption or decryption action.

If a payload is encrypted by a PGP tool outside of MFT using a key length or algorithm that is restricted, MFT decryption will fail. These restrictions are mostly specified at the JRE level in the JAVA_HOME\jdk8\lib\security directory.

The steps for this process are:

  1. Click the arrow to the left of Sources in the left pane navigator.

    The sources are listed.

  2. Click the source name or right-click it and then select the Open menu item.

    The source tab opens.

  3. Click the arrow to the left of Actions.

    The Actions section opens.

  4. Click add processing actions.

    The Processing Actions dialog opens.

  5. Select PGP Encryption or PGP Decryption from the All Actions drop-down list.
  6. Click Add to List.

    Alternatively, to remove an action from the list, click the Delete icon to the right of the action.

  7. If you selected PGP Encryption, select values from the Encryption Alias, Armored, Encryption algorithm, and Signing key alias drop-down lists:
    • Encryption Alias: the public key alias for encryption. For more information about key aliases, see Configuring the PGP Keystore.

    • Armored: Binary or ASCII. Use ASCII if non-printing characters might be stripped in transit.

    • Encryption algorithm: Select from the following supported algorithms:

      Note:

      If no algorithm is selected, global algorithm settings will apply.
      • Default

      • Triple-DES

      • CAST5 – set as default algorithm

      • Blowfish

      • DES

      • AES-128

      • AES-192

      • AES-256 – set as default algorithm, if FIPS mode is enabled

      • Twofish

    • Signing key alias: Select from the list of imported private signing keys.

  8. If you selected PGP Decryption, select the Decryption Alias from the drop-down list. This is the private key alias for decryption. For decrypting, the signature must be imported in the PGP keystore.
    For more information about key aliases, see Configuring the PGP Keystore.
  9. Click OK.

    To cancel adding actions, click Cancel.

  10. Save and optionally Deploy the source.
    After successful transfer, you can monitor the result in the Monitor dashboard. See Monitoring Deployed Sources, Targets, and Transfers and Transfer Reports.
2.3.2.3 Find and Replace at the Source

Use the Find and Replace action to replace a specified text with another text in a file prior to transfer. You can perform multiple find and replace actions on a file.

For more on find and replace actions for transfers, see Find and Replace Preprocessing Action.

To Find and replace action:

  1. Click the arrow to the left of Source in the left pane navigator.

    The sources are listed.

  2. Click the source name or right-click it and then select the Open menu item.

    The source settings opens.

  3. Click the arrow to the left of the Actions option.
  4. Click add processing actions.

    The Processing Actions dialog opens.

  5. Select Find and Replace from the All Actions drop-down list.
  6. Click Add to List. The Find and Replace Processing action is added to the Selected Actions list.

    To remove an action from the list, click the Delete icon to the right of the action.

  7. In the Find field, add the text that you want to find in the source file and in the Replace with field, enter the replacement text. The Find and Replacement action is case–sensitive.
    You can add multiple Find and Replace text in a single Find and Replace action by clicking the Add + icon.
  8. To add another replacement text, click the Add + icon.
  9. You can add multiple Find and Replace processing action for each source. To add another Add and Replace action, click Find and Replace from the All Action list.
    Find text is a mandatory field. If the field is blank, you will get an error.
  10. Click OK.
    To cancel the action, click Cancel.
    After the successful transfer, the report can be seen in the Monitor Dashboard. For more information see Monitoring Deployed Sources, Targets, and Transfers.
2.3.2.4 New Line Conversion at the Source

Use the New Line Conversion processing action to convert new line characters for different operating systems. The New line conversion action converts the new line character to the specified operating system specific new line character.

The steps for this process are:
  1. Click the arrow to the left of Sources in the left pane navigator.
    The sources are listed.
  2. Click the source name or right-click it and then select the Open menu item.
    The source settings opens.
  3. Click the arrow to the left of the Actions option.
    The target settings are displayed.
  4. On the Target details, click Pre-processing actions.
    The Processing Actions dialog opens.
  5. Select New line conversion from the All Actions drop-down list and click Add to List.
    New line conversion is displayed in Selected Actions.
  6. In the Type field, select from the list:
    • DOS to Unix
    • Unix to DOS
    To delete the New line conversion, click the Delete icon to the left of the action.
  7. Click OK.
    To cancel, click Cancel.
2.3.2.5 Run Script Processing at the Source

Use the Run Script processing action for source to execute any script or command like shell commands, perl commands or bat files on a file before delivering it to the target. You can execute external commands such as Virus Scan, external encryption file processing, add new endpoints, enable REST, notify or validate. You may run the script to modify the payload by replacing certain words or add or validate signature information during encryption and decryption.

Example of a script adding a header:
#bin/sh
echo "file generated by script copy"
while read line; do
echo ${line}
done
]

Example of a script for compression:
#bin/sh
gzip -c

Example of a error script :
#bin/sh
regexA="*.bak"
regexB="*.BAK"
if [[ "$fileName" == $regexA || "$fileName:" == $regexB ]]; then
		echo "Processing backup file"
else
		echo "Input file[$fileName] is not valid backup file!" 1>&2  
		exit 1
fi

In the error script example, considering transfer is created to move backup (*.bak) files from source to target, if transfer file is not a backup (*.bak) file, transfer will fail with error “Input file[f2] is not valid backup file.”

There are pre-defined variables which can be used in the script, for example fileName is a pre-defined variable.

To add Run Script processing action:
  1. Click the arrow to the left of Sources in the left pane navigator.
    The sources are listed.
  2. Click the source name or right-click it and then select the Open menu item.
    The source tab opens.
  3. Click the arrow to the left of Actions.
    The Actions section opens.
  4. Click add processing actions.
    The Processing Actions dialog opens.
  5. Select Run Script action and click Add to list.
    The selected action appears in the Selected Actions list.
  6. Enter the following details:
    • Command: enter the path of the script you want to execute. The script needs to be an executable file. For example, /home/user/echo.sh
    • Timeout: Specify the timeout value, if the execution of the script takes more than specified time it will stop the execution of the script. If there is an error in the transfer, the error is reflected in the MFT monitoring dashboard, after diagnosis it can be resubmitted.
    • Read Input Payload: select the checkbox if you want the script (provided in Command field) to read the input payload before transfer. By default, the checkbox is selected.
    • Use Script Generated Payload: select the checkbox if you want to modify the existing payload with the output generated by the script. When unchecked, the script is executed without modifying the payload.

    • New File Extension: Specifies the extension that is added to the new file after processing is done. For example, when using compression action, you may want to modify the name to <filename>.zip, then you will set 'zip' as the new file extension.

  7. Click the Add or Update Script Variable if you want to update, add or modify any parameter or variable in the script. There are pre-configured runtime parameters (filename, payload directory, filesize, targetname, sourcename, useGeneratedFileFromScript) which are updated and passed to script.
    1. To add a variable to the script, click the Add row icon +.
    2. Enter the Name of the variable and the Value.
    3. If the variable value must be encrypted, select the checkbox against ls Credential
    4. To delete a variable, click the Delete icon next to the Value field.
    5. Click OK.
  8. Click OK to save the action or Cancel to cancel the action.

2.3.3 Archiving and Deleting Files Before Delivery

After you create a source, you can edit it to add file operations: archiving and deleting. If a file is configured to be archived, it is copied to given physical target directory. If the file is configured for deletion, it is deleted. Note that the archive or delete action applies to the target system copy of the file, not the Oracle Managed File Transfer copy of the file.

The steps for this process are:

  1. Click the arrow to the left of Sources in the left pane navigator.

    The sources are listed.

  2. Click the source name or right-click it and then select the Open menu item.

    The source tab opens.

  3. Click the arrow to the left of Advanced Properties.

    The Advanced properties section opens.

  4. Click the Operation subtab.

    The Operation subtab opens.

  5. Select Archive, Delete, or Archive and Delete from the Action Type drop-down list.
  6. If you selected Archive or Archive and Delete, type a path in the Physical Target Directory field.
  7. Save and optionally Deploy the source.

2.3.4 Duplicating an Existing Source

You can create a new source for file transfers by copying an existing one.

The steps for this process are:

  1. Duplicate a source in one of these ways:
    • Select the source to copy and then the Duplicate icon in the left pane navigator.

    • Right-click the source to copy in the left pane navigator and select the Duplicate command from the pop-up menu.

    The Duplicate Source dialog appears.

  2. Type a Name for the source.

    The name can include letters, numbers, dashes, and underscores.

  3. Type values for the required non-duplicated settings, which have blue asterisks next to them:
    • Content Folder is required for sources of type File, FTP Remote, sFTP Remote, FTP Embedded, or sFTP Embedded.

      URL is required for sources of type SOAP, SOA, Service Bus, or ODI.

      Sources of type B2B or Healthcare have no required non-duplicated settings.

  4. Click the Create button.

    A tab for the source opens, providing additional settings you can edit. For more information about these settings, see the source type under Source Types, Setting Up Source Processing Actions, and Archiving and Deleting Files Before Delivery.

    To avoid creating a source, click Cancel.

  5. Click the Save button after editing.

    To undo all changes since the last save, click Revert.

  6. Click the Deploy button after saving.

    This step is optional. Deploying a transfer deploys the associated source and target automatically.

2.4 Creating a Target

You can create a target with a minimum number of settings. After you create it, you can edit it to add more settings.

The steps for creating a target are:

  1. Create a target in one of these ways:
    • Click create target in the transfer tab.

    • Double click Targets in the left pane navigator.

    • Select Targets in the left pane navigator and click the Create icon.

    • Right-click Targets in the left pane navigator and select the Create command.

    The Targets dialog opens.

  2. Type a Name for the target.

    The name can include letters, numbers, dashes, and underscores.

  3. Type a Description for the target.

    The description is optional.

  4. Select the target Type.

    This setting determines the other settings that appear. For more information about target types and their settings, see Target Types.

  5. Type a value for the target location. For most target types, this is either:
    • The Folder setting, which specifies a file system directory. Ensure that the folder name does not exceed 60 characters.

    • The URL setting, which specifies a web service endpoint.

      Note:

      In case of SOA/SOAP target, file names must not have spaces.

    The B2B and Healthcare target types have no target location setting in the Targets dialog. You must provide the target location after creating the target.

  6. Type values for the required settings, which have blue asterisks next to them.

    The only target types with required settings in addition to the target location are FTP Remote Target Type and sFTP Remote Target Type. Some of these settings have defaults that you can accept and edit later.

  7. Click the OK button.

    A tab for the target opens, providing additional settings you can edit. For more information about these settings, see the target type under Target Types and Moving and Renaming Files After Delivery.

    To avoid creating a target, click Cancel.

  8. Click the Save button after editing.

    To undo all changes since the last save, click Revert.

  9. Click the Deploy button after saving.

    You can add an optional comment.

    This step is optional. Deploying a transfer deploys the associated source and target automatically.

If an existing target has most of the desired properties, you can duplicate it. See Duplicating an Existing Target.

2.4.1 Target Types

Oracle Managed File Transfer provides the following target types:

Oracle Managed File Transfer does not support embedded FTP or sFTP server targets.

2.4.1.1 FTP Remote Target Type

Using the FTP Remote target type means transferring files to an FTP server outside of Oracle Managed File Transfer. Table 2-3 lists the settings in the Targets dialog specific to the FTP Remote type.

Table 2-3 Targets Dialog Settings for the FTP Remote Target Type

Setting Description

Host Name

Specifies the host name.

Folder

Specifies the directory to which files are transferred.

User

Specifies the user as whom to access the target.

Password

Specifies the user password.

Confirm Password

Confirms the user password.

Control Port

Specifies the port for the target.

SSL

Specifies the use of SSL if checked. This is optional.

Implicit SSL

Specifies the use of implicit SSL if checked. This is optional.

Note:

If you choose List Parser Key as Windows, the recent date and default date format is automatically changed to MM-dd-yyyy HH:mm which is the only supported format in Windows. However, for connecting to Windows (s)FTP Servers, you need to change the List Parser Key to Windows, and have the recent date and default date format configured to MM-dd-yyyy HH:mm format.

For more information about other settings you can edit after you create the target, see "Target—FTP Remote" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.4.1.1.1 FTP Remote Target settings for MVS Transfers

When creating a FTP Remote target type for MVS Mainframe systems, you need to select MVS as List Parser Key in advance properties.

For MVS FTP response formats, MVS can be configured to use HFS (Unix style) response or MVS native response formats. If the target type uses MVS HFS (Unix style), you can configure the advanced Properties as you do with any other Unix system. For example, using ”/” as the path separator. However, if the MVS system uses a MVS native response format only, then you must configure the FTP Remote target type with following mandatory properties:

  • The ”Content Folder” field is not used, however it is a mandatory field. You must enter some text as a placeholder and cannot be left as blank filed. For example, Content Folder =”'FOLDER.'”

  • The FTP Path Separator field must be left blank/empty. For example, FTP Path Separator =””

  • The ”File Naming Convention” field specifies the absolute path to the file. You must include the filename in the path, and enclose it in single quotes. This field must be in the format, File Naming Convention=”MFTOUT.MFT%SEQ%.CSV”'. For example, 'QA.TEST.FILE '.

  • Change the Default Date Format. For example, yyyy/mm/dd:

  • Absolute Path Begin = ””

  • List Parser Key = MVS

You can configure the advance properties as shown in the figure listed below:

2.4.1.2 sFTP Remote Target Type

Using the sFTP Remote target type means transferring files to an sFTP server outside of Oracle Managed File Transfer. Table 2-4 lists the settings in the Targets dialog specific to the sFTP Remote type.

Table 2-4 Targets Dialog Settings for the sFTP Remote Target Type

Setting Description

Host Name

Specifies the host name.

Folder

Specifies the directory to which files are transferred.

User

Specifies the user as whom to access the target.

Password

Specifies the user password.

Confirm Password

Confirms the user password.

Control Port

Specifies the port for the target.

Authentication Type

Specifies the authentication type: Password or Public Key.

For more information about other settings you can edit after you create the target, see "Target—sFTP Remote" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.4.1.3 File Target Type

Using the File target type means transferring files to the local file system or to a network-attached system. The only required setting is Folder, which specifies the directory to which to transfer files. This directory must be accessible from Oracle Managed File Transfer.

Oracle Managed File Transfer uses the same file adapter used by Oracle SOA Suite.

For more information about other settings you can edit after you create the target, see "Target—File" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.4.1.4 SOAP Web Service Target Type

Using a SOAP web service type means transferring files to a web service. The only required setting is URL, which specifies the web service endpoint to which to transfer files.

For more information about integrating with Oracle Managed File Transfer as a web service, see Integrating with Web Services.

For more information about other settings you can edit after you create the target, see "Target—SOAP" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.4.1.5 SOA Target Type

Using the SOA target type means transferring files to the web service interface of a SOA application. The only required setting is URL, which specifies the web service endpoint to which to transfer files.

For more information about integrating Oracle Managed File Transfer with Oracle SOA Suite, see Integrating with Oracle SOA Suite.

For more information about other settings you can edit after you create the target, see "Target—SOA" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.4.1.6 Service Bus Target Type

Using the Service Bus target type means transferring files to the web service interface of an Oracle Service Bus application. The only required setting is URL, which specifies the web service endpoint to which to transfer files.

For more information about integrating Oracle Managed File Transfer with Oracle Service Bus, see Integrating with Oracle Service Bus.

For more information about other settings you can edit after you create the target, see "Target—Service Bus" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.4.1.7 B2B Target Type

Using the B2B target type means transferring files to an Oracle B2B trading partner. No settings are required if B2B is collocated. The most important settings are Trading Partner Name, which specifies the endpoint to which to transfer files, and Domain Alias, which specifies the domain to which to transfer files.

To define a trading partner in Oracle Managed File Transfer, see Integrating with B2B and Managing Domains.

For more information about other settings you can edit after you create the target, see "Target—B2B" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.4.1.8 Healthcare Target Type

Using the Healthcare target type means transferring files to an Oracle B2B for Healthcare domain. The only required setting is Endpoint Name, which specifies the endpoint to which to transfer files. Another important setting is Domain Alias, which specifies the domain to which to transfer files.

To define a Healthcare domain in Oracle Managed File Transfer, see Integrating with Healthcare and Managing Domains.

For more information about other settings you can edit after you create the target, see "Target—Healthcare" in the Oracle Fusion Middleware MFT Composer Help Online Help.

2.4.1.9 WebCenter Target Type

Using the Oracle Content Server source type, you can upload data to Webcenter Content Server. You can create, save, deploy, and associate the source to any transfer.

For details about the configurable parameters for the WebCenter Content source, see “Target- WebCenter” in Oracle Fusion Middleware MFT Composer Help Online Help.

2.4.1.10 Oracle Storage Cloud Target Type

Using the Oracle Storage Cloud target type you can create, save, deploy, and associate source to any transfer. Scheduling is supported for the OCS target.

For details about the configurable parameters for the Storage Cloud target, see “Target- Storage Cloud” in Oracle Fusion Middleware MFT Composer Help Online Help.

Oracle Storage Cloud has a limitation of 5GB as the maximum file size that can be uploaded to OCS. MFT segments the files for you so you can easily upload a file larger than 5GB.

For more information about file segmentation, see “Uploading Files Larger than 5 GB” in Using Oracle Storage Cloud Service.

2.4.1.11 ODI Target Type

The MFT ODI integration supports two different Target interfaces, .a file deliver and notify pattern and a WebService interface.

For more information about other settings you can edit after you create the target, see "Target—ODI" in the Oracle Fusion Middleware MFT Composer Help Online Help.

To define an ODI domain in Oracle Managed File Transfer, see Integrating with Oracle Data Integrator and Managing Domains.

Using a file deliver and notify pattern, MFT delivers the file to one of the binding types listed below then invokes the OdiInvokeWebService tool to process the file. Neither a inline file nor a reference is provided as part of the OdiInvokeWebService invocation. After selecting one of the binding types,  you must configure the required parameters for the targets. Once a binding type is selected for an ODI target, you can’t change the binding type, but you can continue modifying the parameters of the current target binding. For the File, FTP Remote and sFTP Remote bindings, optionally, an ODI Invoke Post Processing Action can be configured to invoke an ODI scenario to then process the file.

  • File- Transfer file via File

  • FTP Remote- Transfer file via FTP

  • sFTP Remote- Transfer file via sFTP

For more information about the OdiInvoke WebService, see ODIInvoke Post-Processing Actions

Using the WebService interface MFT invokes the ODI SOAP Data Services interface. This is typically used to update a single table and not suited for file delivery.

For more information about other settings you can edit after you create the target, see "Target—ODI" in the Oracle Fusion Middleware MFT Composer Help Online Help.

To define an ODI domain in Oracle Managed File Transfer, see Integrating with Oracle Data Integrator and Managing Domains.

2.4.2 Moving and Renaming Files After Delivery

After you create a File, FTP Remote, or sFTP Remote target, you can edit it to add file operations: moving and renaming.

The steps for this process are:

  1. Click the arrow to the left of Targets in the left pane navigator.

    The targets are listed.

  2. Click the target name or right-click it and then select the Open menu item.

    The target tab opens.

  3. Click the arrow to the left of Advanced Properties.

    The Advanced properties section opens.

  4. Click the Operation subtab.

    The Operation subtab opens.

  5. Select Move, Rename, or Move and Rename from the Action Type drop-down list.
  6. If you selected Move or Move and Rename, type a path in the Physical Target Directory field.
  7. If you selected Rename or Move and Rename, type a file name pattern in the File Naming Convention field.

    You can use variables in the file name such as %yyMMddHHmmssSSS% for the timestamp or %SEQ% for an incrementing integer. For example, File%SEQ%.txt numbers files File1.txt, File2.txt, and so on. See "Specifying the Outbound File Naming Convention" in Understanding Technology Adapters for more information.

  8. Save and optionally Deploy the target.

2.4.3 Duplicating an Existing Target

You can create a new target for file transfers by copying an existing one.

The steps for this process are:

  1. Duplicate a target in one of these ways:
    • Select the target to copy and then the Duplicate icon in the left pane navigator.

    • Right-click the target to copy in the left pane navigator and select the Duplicate command from the pop-up menu.

    The Duplicate Target dialog appears.

  2. Type a Name for the target.

    The name can include letters, numbers, dashes, and underscores.

  3. Click the Create button.

    A tab for the target opens, providing additional settings you can edit. For more information about these settings, see the target type under Target Types and Moving and Renaming Files After Delivery.

    To avoid creating a target, click Cancel.

  4. Click the Save button after editing.

    To undo all changes since the last save, click Revert.

  5. Click the Deploy button after saving.

    This step is optional. Deploying a transfer deploys the associated source and target automatically.

2.5 Setting Up Schedules

You can schedule file deliveries so they occur only at specific times or time ranges. If no schedule is configured, the file is delivered as soon as it is processed by Oracle Managed File Transfer. You can configure a source schedule as part of source configuration or a target schedule as part of transfer configuration.

If a schedule is defined for a listening source, the file is picked only when the schedule expires. For a non-listening source, the file is picked as soon as it arrives at the source location but remains with a status of Scheduled. When the schedule expires, the file is processed further and delivered. All transfers that reference the source happen only when the source schedule expires.

If a schedule is defined for a target, the file is delivered only when the schedule expires. Before that it remains at the source location with a status of Scheduled. Targets referenced by the same transfer do not share schedules.

Note:

Before adding a schedule, test the transfer without one to ensure that it works properly. See Deploying and Testing Transfers.

Note:

Oracle Managed File Transfer interacts with Oracle Enterprise Scheduler Service through the OracleSystemUser. Do not delete this user. If you do, clicking add schedule will result in an OracleSystemUser does not exist message, and Schedule Details may be blank in monitoring reports. For more information about users, see Configuring Users.

The steps for this process are:

  1. Click the arrow to the left of Sources or Transfers in the left pane navigator.

    The sources or transfers are listed.

  2. Click the source or transfer name or right-click it and then select the Open menu item.

    The source or transfer tab opens.

  3. If you don't see the add schedule option, you can display it. In the source tab, click the arrow to the left of Source Schedule. In the transfer tab, click the arrow to the left of the target.
  4. Click add schedule.

    The Scheduler dialog opens.

  5. Type a Name for the schedule.
  6. Select a value from the Frequency drop-down list: Once, Hourly/Minute, Daily, Weekly, Monthly, Yearly, or Custom.
    • If you selected Once, enter a date and time in the Start Date field.

    • If you selected Hourly/Minute, specify the interval in hours and minutes. Enter a Start Date and optionally an End Date.

    • If you selected Daily, specify the interval in days. Enter a Start Date and optionally an End Date.

    • If you selected Weekly, specify the interval in weeks. Enter a Start Date and optionally an End Date.

    • If you selected Monthly, select a Repeat option:

      • By day: Select a Week of the Month and a Day of the Week. For the Week of the Month, you can select Last.

      • By date: Select a day of the month or Last day of month.

      Enter a Start Date and optionally an End Date.

    • If you selected Yearly, select a Month and a Repeat option:

      • By day: Select a Week of the Month and a Day of the Week. For the Week of the Month, you can select Last.

      • By date: Select a day of the month or Last day of month.

      Enter a Start Date and optionally an End Date.

    Click the Date/Time icon to select a date and time instead of typing them or to select a different time zone. Click Customize Times to edit individual delivery times.

  7. If you selected Custom from the Frequency drop-down list or clicked Customize Times, the Scheduler dialog expands and displays a table of times.

    To add a time, click Add Time, specify a date and time in the Add Time dialog, and click OK. Repeat for each time you want to add.

    To remove a time, click Remove Time. To restore a removed time, click Add Back.

    If you clicked Customize Times, you can cancel adding custom times by clicking Change Frequency.

  8. To specify a time range in which file deliveries can occur, check Use Duration. Specify the duration in hours and minutes. The duration must be more than the Frequency.

    The duration is the range of time in which transfers occur. For example, if the Frequency is Weekly, the Start Date is a Monday at noon, and the Duration is one hour, then polling or transfers occur only on Mondays between noon and 1 pm.

  9. Click OK.

    To cancel adding a schedule, click Cancel.

  10. Save and Deploy the source or transfer.

2.5.1 Schedules with Polling Frequency and Minimum Age

The minimum age applies to the listening source types listed below:

  • Remote sFTP

  • Remote FTP

  • File

  • Storage Cloud Service

  • Webcenter

If a schedule is defined for any of these source types, polling frequency and minimum age applies only to the schedule duration. If the schedule ends before the expiration of polling frequency, then the listening source types will not be polled.

Upon each polling occurrence or schedule expiration, MFT downloads only the files that have a last modified time to a value that is larger than minimum age.

Note:

When using the same file name for multiple transfers, some times the release of the lock is delayed and cause issues with the file processing, as the filename is the key on the lock table. The files are not picked after every polling interval due to lock. To resolve this issue, add a MFT MBean property releaseLockCycle and set its value to 1 and redeploy the source. This fix applies to File, FTP remote, SFTP remote sources.

2.6 Setting Up Events

The Events service enables you to trigger a file transfer on demand. You can trigger file transfers for sources such as File, FTP Remote, sFTP Remote, WebCenter, and Oracle Storage Cloud Service. If the Events service is enabled for a source, it triggers an immediate retrieval of files on external invocation. By default, the trigger service is protected by username token policy.

You can invoke Events using the following methods:

Enabling Events for a source

The Events service can be enabled by choosing the Source Schedule type as Event. To secure the service, select the Security checkbox.
To enable Events using the MFT console:
  1. Click the arrow to the left of Sources in the left pane navigator. The sources are listed.
  2. Click the source name or right-click it and then select the Open menu item.
    (Optional) The source or transfer tab opens and source details are displayed.
  3. Click the Source Schedule option. Polling and Events options are visible.
  4. Enable the Events for the selected source by selecting the Events checkbox.
    Events cannot be enabled if Polling is enabled. If you need Polling and Events service to be enabled, add a schedule. Else, disable Polling and enable Events.

    If the same source is configured for Polling and Events, then if polling is in process, Events request is not accepted. If an Event is in process, then Polling is paused until the Event is completed.

  5. Click the Security checkbox to secure the events. By securing the events, only Administrators and configured MFT users can trigger an event. For information on configuring users and roles, see Configuring Users.
  6. Click Save to save the changes.
To invoke the Events service:
  1. From the Monitoring tab, click the arrow to the left of Source Instances in the left pane navigator.

  2. Click the source name or right click it and then select the Open menu item.

  3. On the Instances tab, select the source and click Invoke Event.

After you trigger an event, you get an Event session ID which is used to view the Event details and status in the Web Service client.

2.6.1 Trigger Events using REST and SOAP Services

Once you have set up Events, you can trigger it on demand using REST or SOAP operations.

For SOAP Services, URL is http://<host>:<port>/mftapp/services/MFTEventService

For REST services, refer REST API for Oracle Managed File Transfer

Supported SOAP Operations

The supported SOAP operations for trigger Events are:

  • submitEvent - To submit an Event which will trigger the transfer, you need to supply the source name as a mandatory parameter along with additional optional parameters. On successful invoke of Event, an eventSessionId is returned which can be used to query the Event status and instances.

    Supported parameters for JCA sources: PatternType - wildcard or regular expression, IncludePattern - any wildcard or regular expression filter string, ExcludePattern - any wildcard or regular expression filter string. PatternType is a mandatory input parameter if you are passing pattern. These properties override values defined at the source level.

    Example: curl -s -u username:password -H Content-Type:application/json -X POST -d @ '{"sourceName": "Wile SFTP Remote Source","properties":{"entry":[{"key":"PatternType","value":"wildcard"},{"key" :"ExcludePattern","value":"*sh"}]}}' http://localhost:7003/mftapp/rest/v1/events

    Supported parameters for Oracle Cloud Storage sources: PayloadKey, Path, Delimiter

    Supported parameters for WebCenter Sources: DocName, DocId, RevisionSelectionMethod, Rendition, Querytext, QueryFormat, SecurityGroup, DocumentAccount

  • getInstanceDetails - Get the details of instances created by the Event. It requires eventSessionId as mandatory input parameter. The response contains the details of each instance (one instance per file). By default only minimal info is provided, to get the full details you need to set the inDetail attribute to true.

  • getEventStatus - To get the overall Event status about counts of how many files are processed successfully or failed or in progress along with the Event status (for example Done or errored). It requires eventSessionId as mandatory input parameter. The response contains the count of instances in different states and status of the Event.

All the operations of the Event SOAP service are protected by user name token policy, to invoke MFT Event Service in SOAP, you must provide the user name token client policy.

2.7 Setting Up Priorities

You can define priorities for transfers so that the messages of High priority are processed first.

You can control the order message processing and transfer of the payload based on the priority of the associated transfer where messages of HIGH priority are processed first, followed by MEDIUM, then LOW. If the priority of more than one transfer is the same, then the messages are picked and processed in order of submission. Priority is an attribute added to the MFT meta model and the priority defined on the Transfer page is persisted in the MDS.

The message priority is shown in the reports for source/transfer/target modules. The priority at source is inherited from the transfer. If there is more than one transfer then the highest priority of all transfers is considered for the source level message processing and is shown in the reports.

You can view the priority in artifact specific instances in the Monitoring dashboard. The Monitoring dashboard also provides a filter so that you can search the messages based on priority.

2.8 Deploying and Testing Transfers

After you create a transfer and its associated source and targets, you deploy the transfer to activate it, then test it to ensure it works as designed.

Note:

Before adding a schedule, test the transfer without one to ensure that it works properly. See Setting Up Schedules.

2.8.1 Deploying a Source, Target, or Transfer

Every artifact tab has a Deploy button. Before a transfer can deliver files, it must be deployed. You can deploy sources and targets separately to make them available for use in multiple transfers.

The deployment process has three steps:

  1. The deployment user interface displays the list of files to be deployed.

  2. The files are validated.

  3. If the validation is successful, the artifact is deployed.

Deploying a transfer for the first time automatically deploys the associated source and targets if they have been saved but not deployed. However, after the initial deployment, each artifact must be separately redeployed after any modifications.

Oracle Managed File Transfer maintains the version of the artifact. When an artifact is deployed, the current version of the artifact is deployed. The Oracle Managed File Transfer runtime engine operates only on the deployed version.

You can monitor, disable, and undeploy artifacts that have been deployed; see Monitoring Deployed Sources_ Targets_ and Transfers.

2.8.2 How to Tell If a Transfer Is Successful

To test a deployed transfer, copy to the source location a test file of the type the transfer is designed to deliver.

If you applied a content filter, you can also verify that a file of the wrong type is not transferred. See Setting Up Content Filters.

Note:

If you copy a binary file to the source location using an FTP client external to Oracle Managed File Transfer, be sure to configure it for binary transfer. Otherwise the file might become corrupted. Processing actions such as compression and encryption might not work properly.

2.8.2.1 Locating Received Files

You can verify that the transfer worked by verifying that the test file arrived at the target location.

If you applied preprocessing or postprocessing actions such as compression or encryption, you can examine the delivered file to verify that these actions occurred. See Setting Up Source Processing Actions and Setting Up Transfer Preprocessing and Postprocessing Actions.

You can also verify that actions such as moving and renaming occurred. See Archiving and Deleting Files Before Delivery and Moving and Renaming Files After Delivery.

Watching Active Deliveries

If your test file is large, you can watch its progress on the Dashboard tab of the Monitoring page. See Monitoring Active Deliveries.

2.9 Importing and Exporting Transfers

Exporting a transfer saves the transfer configuration and its associated source and target configurations to a ZIP file. Sources and targets cannot be exported separately.

To export a transfer, open the transfer and click the Export button. You can download the transfer with or without a config plan.

You can import a transfer you have previously exported. The steps for this process are:

  1. Open the Import/Export tab on the Administration page.
  2. Click Browse.

    An operating system file uploading dialog box opens.

  3. Select the directory from which to upload the file.
  4. Select the ZIP file to upload.
  5. Click Open.

    The full path to the file appears in the Import text box next to the Browse button.

  6. Click Import.

This overwrites a transfer artifact with the same name, and overwrites any associated source and targets with the same names.