Skip to content
This repository was archived by the owner on Jun 13, 2025. It is now read-only.

User Settings #Banner #TheBay

Jump to bottom
Shizhong Yu edited this page Dec 31, 2020 · 15 revisions

TheBay Settings

Table of Contents

Overview:

General walkthrough of the entire thebay settings and what they are meant to do.

TheBay Banner Settings:

Output Directory

This is the directory where output files will be copied to after the automation finished executing.

Default path is current user's Desktop as two separate output files in the respective template's file format. If the folder directory is a network location, the user will be required to be connected for automation to run correctly.

When changing this address manually, please make sure the path address is formatted with double back slash.

Example: 

"WipOutputDirectory": "C:\\Users\\Middle\\Desktop",
"FinalOutputDirectory": "C:\\Users\\Middle\\Desktop",

DefaulOutputFilename

This is the prefix filename that appear on the output files.

The default value is "TheBay_Daily_Workflow", it can be changed into any alphanumeric value.

OutputDate

This is the date appear after "DefaulOutputFilename" in the output file name.

This date format is in UTC format, the date will be reflected directly in the summary chart date cell(Default to be N1).

Banner

TheBay is represented by 0, do not change this number.

InputFilename

Default value is empty, these fields expect valid file locations. The following inputs also expect fixed file format:

"InputFilenameWorkflow": ".csv"
"InputFilenameInactiveUpc": ".csv"
"InputFilenameBitReport": ".csv", ".xlsx"
"InputFilenameNosCombined": ".csv"

If the folder directory is a network location, the user will be required to be connected for automation to run correctly.

When changing this address manually, please make sure the path address is formatted with double back slash.

TemplateFullname

Template support ".xlsx" and ".xlsm" formats.

If the folder directory is a network location, the user will be required to be connected for automation to run correctly.

When changing this address manually, please make sure the path address is formatted with double back slash.

BannerPassword

This is the password that protects edit privileges on the "Final" output file, "WIP" output file is not affected by this.

WipWbValuesOnly

"true" - When set to true, WIP output file will only include values, all formulas will be converted to values. This is the default behavior.
"false" - When set to false, WIP output file will include formulas instead of values. Useful for testing and validation.

TheBay Worksheet Settings:

Summary Chart

  • "ReportSettings" correspond to the summary worksheet in WIP template.
  • "DateAddress" is the cell where date value updates to the user's choice at the start of script execution.
  • "ReadingAddress" is the area located on Summary Chart (WIP) being copied into Summary Chart (Final).
  • "WritingAddress" is the upper left corner of the area being copied to Summary Chart (Final).
Example:

"SummarySettings": {
      "ReportSettings": {
        "WorksheetName": "WF Summary Chart",
        "DateAddress": "N5",
        "ReadingAddress": "E1:BO118"
      },
      "FinalSettings": {
        "WorksheetName": "Summary Chart",
        "WritingAddress": "E1"
      }
    }

Workflow Details Product

This operation is a Data Source Type Operation, thus it follows all the rules of such operation.

  • "ReadingAddress" in "WipSettings" and "WritingAddress" in "FinalSettings" are the settings that modify the locations of being read and copied in the WIP to Final output transition. "ReadingAddress" requires a valid excel address, if the address left to be columns only like the example below, the rows copied will start at "WritingRow" in the "WipSettings".
  • "WorksheetName" in "DataSourceSettings" will be used as the worksheet name to match the column names in the "ReferenceRow".
Example:

"WorkflowSettings": {
      "WipSettings": {
        "FormulaRow": 3,
        "ReferenceRow": 4,
        "WorksheetName": "Details_Products",
        "HeaderRow": 7,
        "WritingRow": 8,
        "ReadingAddress": "A:BT"
      },
      "FinalSettings": {
        "WorksheetName": "Workflow Details",
        "WritingAddress": "A4"
      },
      "DataSourceSettings": {
        "HeaderRow": 1,
        "WritingRow": 1,
        "WorksheetName": "Looker_Data"
      }
    }

Inactive UPC

This operation is a Data Source Type Operation, thus it follows all the rules of such operation.

  • "ReadingAddress" in "WipSettings" and "WritingAddress" in "FinalSettings" are the settings that modify the locations of being read and copied in the WIP to Final output transition. "ReadingAddress" requires a valid excel address, if the address left to be columns only like the example below, the rows copied will start at "WritingRow" in the "WipSettings".
  • "WorksheetName" in "DataSourceSettings" will be used as the worksheet name to match the column names in the "ReferenceRow".
Example:

"InactiveUpcSettings": {
      "WipSettings": {
        "FormulaRow": 3,
        "ReferenceRow": 4,
        "WorksheetName": "Inactive_UPC",
        "HeaderRow": 7,
        "WritingRow": 8,
        "ReadingAddress": "A:AS"
      },
      "FinalSettings": {
        "WorksheetName": "Additional Color Sizes Report",
        "WritingAddress": "A4"
      },
      "DataSourceSettings": {
        "HeaderRow": 1,
        "WritingRow": 1,
        "WorksheetName": "UPC_Looker"
      }
    }

Inventory Value

  • The "ReadingAddress" is the default area of original table, this format of inventory value is hard coded, therefore its columns can not be moved around.
Example: 

"BitreportSettings": {
      "WipSettings": {
        "WorksheetName": "Ttl_Inv",
        "HeaderRow": 1,
        "WritingRow": 1,
        "ReadingAddress": "A:E"
      }
    }

NOS Combined

This operation is a Data Source Type Operation, thus it follows all the rules of such operation.

  • "ReadingAddress" in "WipSettings" and "WritingAddress" in "FinalSettings" are the settings that modify the locations of being read and copied in the WIP to Final output transition. "ReadingAddress" requires a valid excel address, if the address left to be columns only like the example below, the rows copied will start at "WritingRow" in the "WipSettings".
  • "WorksheetName" in "DataSourceSettings" will be used as the worksheet name to match the column names in the "ReferenceRow".
  • When "WorksheetName" in both "WipSettings" and "DataSourceSettings" are the same, it is assumed there is no independent data hosting worksheet, and column data matching is not performed.
Example: 

"NosCombinedSettings": {
      "WipSettings": {
        "FormulaRow": 1,
        "ReferenceRow": 2,
        "WorksheetName": "NOS_Colour_Combined",
        "HeaderRow": 2,
        "WritingRow": 3,
        "ReadingAddress": "A:CE"
      },
      "FinalSettings": {
        "WorksheetName": "NOS_Colour_Combined",
        "WritingAddress": "A2"
      },
      "DataSourceSettings": {
        "HeaderRow": 2,
        "WritingRow": 3,
        "WorksheetName": "NOS_Colour_Combined"
      }
    }

For Common Components refer to:

Clone this wiki locally