Skip to main content
Skip table of contents

Server Document Bursting and Folder Mapping

This feature automates the distribution of documents generated in Cognos into specific customer folders, making them accessible through the CAW (Customer Access Web).

Use Cases

1. Bursting Documents from Cognos

The system can automatically burst documents in a designated shared folder. This eliminates the need for manual file handling and ensures documents are ready for further processing.

2. Distributing Documents to Customer Folders for CAW Access

Once the documents are in the shared folder, the system distributes them to specific customer folders. This organization allows customers to access their documents through the CAW, enhancing accessibility and user experience.

3. Parsing Filenames and Moving Documents Based on User-Defined Cross-Reference

Using a user-defined cross-reference, the system parses filenames and moves documents to the appropriate directories. This mapping ensures that documents are placed in the correct folders based on predefined naming conventions and folder structures.

Initial Setup

1. Create a CAW User

  1. Navigate to the User Management section of your application.

  2. Click on "Add New User."

  3. Fill in the user details, ensuring the user role is set to CAW User.

  4. Save the new user

2. Assign CAW User to Business Associate

  1. Navigate to the Business Associate section.

  2. Select the appropriate Business Associate.

  3. Go to the Shipper tab.

  4. Set the CAW User by selecting from the list of users.

  5. Save the changes.

3. Add Document Folders

  1. Navigate to the Global Setup / Document Folders section.

  2. Click on "Add New Folder."

  3. Define the folder structure according to requirements.

  4. Save the new folder.

4. List Folders on CAW Content Tab

  1. In the Business Associate section, select the relevant Business Associate.

  2. Navigate to the CAW Content tab.

  3. Add the necessary folders that should be accessible via CAW.

  4. Save the changes.

Functional Design and Setup

Customer Folder Mapping Screen

This screen allows users to define the relationship between file names and their corresponding folders on the CAW.

Screen Features:

  • Inline Edit Grid: Supports locking, copy, and delete functions.

  • Columns:

    • Business Associate Number: Select from the standard BA picklist.

    • Business Associate Name: Select from the standard BA picklist.

    • Asset Number: Select from the Asset picklist.

    • Asset Name: Select from the Asset picklist.

    • File Name Format: Edit field to define the file name format.

      • Formatting options below

    • Folder Mapping: Edit field to define the folder mapping.

    • Document Folder: Select from the Document Folder picklist.

Required Fields and Validation:

  1. File Name Format: Must be populated for Customer Folder mapping. An error is generated if this field is empty.

  2. Folder Mapping or Document Folder: Either field must be populated. An error is generated if both are empty.

  3. Non-conflicting Models per Asset: Only one type of mapping (Dynamic or User Defined) can be used per Asset. An error is generated if both are used.

    1. Error Message: "Mapping per Asset must either be Dynamic or User Defined but not both to ensure proper document handling. Either Folder Mapping or Document Folder fields can be used per Asset."

Mapping Types

Dynamic Mapping

Dynamic mapping generates folders automatically using a predefined naming convention.

Pre-Defined Variables:
  • <BA_NUMBER>: Business Associate number

  • <BA_NAME>: Business Associate name

  • <CONTRACT_NUMBER>: Contract number

  • <CONTRACT_NAME>: Contract name

  • <ASSET_NUMBER>: Asset number

  • <ASSET_NAME>: Asset name

  • <DAY>: Report day

  • <MONTH>: Report month

  • <YEAR>: Report year

  • %: Wildcard for additional characters in file names

These variables can be used in both file and folder name formats (except % in folder names).

Example Setup:
  1. File Name: COCH_200006_Invoices_052020_FINAL

  2. File Name Format: <ASSET_NUMBER>_<BA_NUMBER>_Invoices_<MONTH><YEAR>%

  3. Constituent Parts:

    • Asset Number: COCH

    • BA Number: 200006

    • Month: 05

    • Year: 2020

  4. Folder Mapping: <ASSET_NUMBER>_<BA_NUMBER>_Invoices_<YEAR>

  5. Document Folder: COCH_200006_Invoices_2020

User Defined Mapping

User defined mapping requires users to specify and pre-create folders.

Example Setup:
  1. File Name: 200006_Invoices_2020_05222020

  2. File Name Format: 200006_Invoices_2020%

  3. The system matches the file name to the format and places it in the specified folder.

Staging Folder Configuration

The staging folder is a temporary location for all incoming documents before they are moved to their final destinations.

Setup:

  1. Define the staging folder in the application configuration settings.

  2. Configuration Setting: CAW_staging_folder: “/srv/www/apps/files/report_bursts”

Using the Feature

Document Bursting Process

  1. Place Documents in Staging Folder:

    • Documents generated by Cognos or automatically placed or manually added to the staging folder defined in the configuration.

  2. File Scanning and Parsing:

    • The system scans the staging folder. (Runs every 5 minutes)

    • Files are parsed using the File Name Format defined by the user.

    • The system breaks down the file name into its constituent parts.

  3. Folder Mapping and Creation:

    • Based on the parsed data, the system determines or creates the appropriate Document Folder.

    • If the folder does not exist, it is created following the mapping guidelines.

  4. Document Movement and Record Creation:

    • Documents are moved to the correct Document Folder.

    • A new record is generated in the documents table for each moved document.

    • If a file already exists, it is replaced, and the existing record is updated.

Managing Documents

  1. Access Document Folders:

    • Navigate to the Document Folders section to view and manage the folders and documents.

  2. Editing Mappings:

    • Use the Customer Document Mapping screen to edit existing mappings or add new ones.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.