TIBCO Scribe® Online Connector For Files

Use the TIBCO Scribe® Online Connector for Files to read/write the content of files including text or binary or read/write from folders. Pair this Connector with Text or XML Connectors to easily process multiple files in the same Map. In addition, you can process binary or attachment data, which also works with Salesforce, Microsoft Dynamics, Microsoft SQL Server, or Tools (Base64 Encode/Decode Binary) Connectors.

Connector Specifications

  Supported
Agent Types
On Premise X
Cloud  
Replication Services
Source  
Target  
Integration Services
Source X
Target X
Migration Services
Source X
Target X
Maps
Integration X
Request-Reply X
Message  

This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.

Supported Entities

The Files Connector supports the following entities. Click a linked entity name for additional information when using that entity in TIBCO Scribe® Online. For a list of additional operations by entity see Special Operations.

Standard Operations

Entity Query Create Update Delete Upsert

AppendText

 

 

 

 

 

CreateFolder

 

 

 

 

 

DeleteFolder

 

 

 

 

 

FileBytes

X

 

 

 

 

FileLines

X

 

 

 

 

FileText

X

 

 

 

 

Files

X

 

 

 

 

MoveOrRename

 

 

 

 

 

WriteBytes

 

X

 

 

 

WriteText

 

X

 

 

 

Special Operations

Entity Operations

  AppendText

  CreateFolder

  DeleteFolder

  MoveOrRename

- Execute

Setup Considerations

Accessing Local Directories

  • If you choose to store files and folders on your own computer or a server on your network, you must edit the FoldersAccess.txt file installed with the Connector. When files and folders are stored locally, TIBCO Scribe® Online uses the FolderAccess.txt file to maintain the list of directories it is permitted to access. The TIBCO Scribe® Online Files Connector is limited to the directories in this list. Add directories to the default list as needed.
    1. Navigate to the FolderAccess.txt file in the ..\Scribe Software\TIBCO Scribe® Online Agent\Connectors\Scribe.Connector.Files\ folder on the computer where the TIBCO Scribe® Online On-Premise Agent is installed.
    2. Open the FolderAccess.txt file in a text editor, such as Notepad.
    3. Add a line in the FolderAccess.txt file for each directory path that contains text files. Directory paths can be absolute, relative to the folder where the Agent is installed, or a network directory. List each folder on its own line, for example:

      C:\folder2
      \\myserver\archive
      .\dataexchange

      Note: Microsoft does not support mapped drive names with Windows services. However, UNC path names are supported. For more information, see Services and Redirected Drives (Microsoft MSDN Library)

    4. Save and close the file before you configure any files or folders. If you have not added the locations, TIBCO Scribe® Online generates errors when you try to preview data or test Connections.

    Note: The Files Connector can access all sub-directories under any listed directories.

    Selecting An Agent Type For Files

    Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

    Connecting To Files

    1. Select More > Connections from the menu.
    2. From the Connections page select Add to open the Add a New Connection dialog.
    3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:
      • Name — This can be any meaningful name, up to 25 characters.
      • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
    4. Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
    5. Select OK to save the Connection.

    Files Connector As IS Source

    Consider the following when using the Files Connector as an Integration Solution source.

    Filtering

    Filtering is case-insensitive.

    Use the following fields and values when filtering for files or directories: 

    Files Connector As IS Target

    Consider the following when using the Files Connector as an Integration Solution target.

    Notes On Standard Entities

    AppendText

    Opens a file and appends the specified string to that file. If the file does not exists, a file is created and the text is added to the new file. To append text to a file, configure the following on the Execute Block Fields tab: 

    CreateFolder

    Creates a new folder in the designated directory. Enter the path and the new folder name in the SearchPath field on the Execute Block Fields tab.

    DeleteFolder

    Deletes the designated folder. To delete a folder, configure the following on the Execute Block Fields tab: 

    FileBytes

    Reads the byte array (binary file data) of a file. To return file data, configure the Query Block Filter tab or the Lookup Block Lookup Criteria tab. See Filtering for filter Field and Value options.

    FileLines

    Reads a file one line at a time. To return file data, configure the Query Block Filter tab or the Lookup Block Lookup Criteria tab. See Filtering for filter Field and Value options.

    FileText

    Reads all lines in a file at one time. To return file data, configure the Query Block Filter tab or the Lookup Block Lookup Criteria tab. See Filtering for filter Field and Value options.

    Filter Options for FileBytes, FileLines, and FileText

    Files

    Reads one or more files in a directory. To return files, configure the following on the Query Block Filter tab or the Lookup Block Lookup Criteria tab.

    MoveOrRename

    Moves or renames a file. To move or rename a file, configure the following on the Execute Block Fields tab: 

    WriteBytes

    Creates a new file and writes the specified byte array to the file. To create a new file and write a byte array to it, configure the following on the Create Block Fields tab: 

    WriteText

    Creates a new file and writes the specified string to the file. To create a new file and write a string to it, configure the following on the Create Block Fields tab: 

    Sample Maps

    Note: To download the Sample Maps go to the Files Sample Maps Knowledge Base article in the TIBCO Community

    In TIBCO Scribe® Online, you can use the Text Connector to process information in text files. However, in cases where multiple text files exist in the same folder, the Map processes a single file and then ends. The next file is not processed until the Map is executed again either manually or on based on the Solution schedule. This can cause a delay when there are many inbound files to be processed. Using the Files Connector resolves this issue by allowing you to Query a folder with multiple files, and move and rename files as they are processed without exiting the Map. These Maps are very simple and do not get into details about mapping data to other systems. They only demonstrate what can be done with files and folders. Each Block in the Maps has a brief description that explains the purpose of that Block.

    The Files Connector Sample Maps Setup (Run once) Map demonstrates the following: 

    The Pre/Post Processing Sample Map demonstrates the following: 

    The Reading And Writing Entire Files Map demonstrates the following: 

    TIBCO Scribe® Online API Considerations

    To create connections with the TIBCO Scribe® Online API, the Files Connector requires the following information:

    Connector Name

    Files

    Connector ID

    08246B02-9AFA-4C5C-BABD-27A9534132B9

    License Agreement

    The TIBCO Scribe® Online End User License Agreement for the Files Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.

    More Information

    For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.