File naming conventions

Follow

Shared naming convention

  • Provide a code (as a prefix) to identify the project.
    • If you are operating a server with multiple projects on the same MC, an operation error can make you upload your robot to a wrong project. In this situation, an existing file with the same name would be rewritten unintentionally, affecting the operating robot of that other project.

      (For example) c999_Robotname.robot  …   c{code}_{filename}.{robot/snippet/type/xls/csv etc}

  • File names should be alphanumeric, not multi-byte characters.
    • This is because garbled characters would otherwise appear when storing the file in MC.

 

Naming convention (by type)

  • Project
    • Pick a name that clearly describes what the project does.
  • Robot
    • (File name) Pick a name that clearly states the robot execution content and its target site.
    • (File name) Add the "DBG_ " prefix for test robots and temporarily-used robots that will not be uploaded to the production environment.
    • (Step name) Name the "Assign/Convert Variable" steps according to the following rules to make their process content understandable at a glance.
      • Init Variable/attribute name … Initialization ( initial value setting such as 0 clear, a blank, etc.).
      • Set Variable/attribute name … Insert value after initialization.
      • Update Variable/attribute name … Overwrite/complement a variable/attribute that already contains a value.
  • Type
    • (File name) Pick a name that clearly states the stored data.
    • (Variable name) Add the "in_" prefix to attributes that will be the robot parameters.
    • (Variable name) Add the "out_" prefix to attributes that will be the robot output.
    • (Attribute name) simple type ・・・  Pick a name starting with a small letter.
    • (Variable name) complex type ・・・ Pick a name starting with a capital letter.
  • Snippet
    • Pick a name that clearly states the content and role of the started project.
  • DB config
    • Use the project name.
  • Resources
    • Add an identifier that matches the execution environment.

      example:) c999_config_linux.xlsx … configuration files for a Linux environment

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.