sas-studio-custom-steps icon indicating copy to clipboard operation
sas-studio-custom-steps copied to clipboard

Add FTP Directory Listing and FTP Download Files steps

Open x7rtfgj4 opened this issue 1 year ago • 2 comments
trafficstars

Please include answers to these questions as part of your pull request

In the GitHub webUI, use the Write tab to modify the Markdown text that is part of the pull request. For each question simply place an X inside the square brackets, [X], that represents your answer. Make sure there are no blanks inside the brackets, otherwise MarkDown doesn't render properly. Using the Preview tab while editing this form, you can see the formatted/rendered version of the message.

  • Q1: Confirm that you have the right to submit the code that is being contributed. Please consider the origin of your code and confirm you have the appropriate rights to make the submission subject to the Apache 2.0 license that applies to everything in this repository of custom steps. If so, follow the instructions for the Contributor Agreement (which is based on the industry-standard Developer Certificate of Origin (DCO)).
    • [X] Yes, I have the right to submit the contributed code on behalf of myself, my company, or any other owner of the code. I have also attached my signed copy of the DCO to this message.
    • [ ] No
  • Q2: Confirm that your contribution does not include any personally identifiable information (PII), for example, in any examples used in your README file.
    • [X] My contribution does NOT include PII data
    • [ ] My contribution includes PII data
  • Q3: Confirm your contribution does not include any encryption or other export-controlled technology.
    • [X] My contribution does NOT contain encryption or other export-controlled technology
    • [ ] My contribution includes encryption or other export-controlled technology

x7rtfgj4 avatar Aug 12 '24 08:08 x7rtfgj4

@x7rtfgj4 , thanks for adding these useful steps. Have some feedback regarding using best practices for capitalization in folder names, step names, and labels used in the step UI. Hopefully quick and easy to resolve.

  • Please rename folders to FTP Directory Listing and FTP Download Files
  • Same for step names. Note that you should rename in SAS Content in Explorer panel inside SAS Studio as this updates the related attributes inside the json
  • Update names in README.md and About tab accordingly
  • Add colons at end of labels for UI controls of all controls, including input and output table controls. See https://github.com/sassoftware/sas-studio-custom-steps/blob/main/docs/UI-guidelines.md for details.

Also noticed that you use ~= in your SAS code. Could you change this to use the mnemonic NE instead? Makes the code easier to read.

It is also good practice to cleanup any intermediate items at the end of your step, this includes filerefs.

When you create intermediate tables in work we have an (undocumented) best practice to have those table names prefixed as follows: "underscore followed by the first letter of each word in the name of the stepm followed by another underscore" as long as that does not generate unsuitable words. So in your case that would be _fdl_ and _fdl_. Btw. if there are only a couple of intermediate tables and they are all very small and are often needed for debugging, then it is okay to leave them in the work directory. Note that when the intermediate tables are expected to be large and often needed for debugging, then it might be better to add a checkbox "Run in Debug mode" in the UI . But don't think that applies here.

snlwih avatar Aug 13 '24 10:08 snlwih

SAS Internal Due Diligence Review - COMPLETED on 06AUG2024

snlwih avatar Aug 16 '24 11:08 snlwih