Merge pull request #122 from yabwon/main

SAS Packages Framework, version 20251221

README.md

@@ -17,7 +17,7 @@ Don't forget to give the repository a **STAR** and become [stargazer](https://gi
 
 ### Current version:
 
-**The latest version** of the **SAS Packages Framework** is **`20251122`**.
+**The latest version** of the **SAS Packages Framework** is **`20251221`**.
 
 ---
 
@@ -190,6 +190,7 @@ The SAS Packages Framework [(short) documentation](https://github.com/yabwon/SAS
 ---
 
 ### Updates worth mentioning:
+**Update**\[December 21st, 2025\]**:** `%relocatePackage()`, `%SasPackagesFrameworkNotes()`, and `%isPackagesFilerefOK()` **utility macros are available. (see [here](https://github.com/yabwon/SAS_PACKAGES/releases/tag/20241221 "splitCodeForPackage"))**.
 
 **Update**\[October 27th, 2024\]**:** `%splitCodeForPackage()` **utility macro is available. (see [here](https://github.com/yabwon/SAS_PACKAGES/releases/tag/20241027 "splitCodeForPackage"))**.
 

SPF/Macros/extendpackagesfileref.sas

@@ -6,7 +6,7 @@
              when empty the "packages" value is used */
 )/secure
 /*** HELP END ***/
-des = 'Macro to list directories pointed by "packages" fileref, version 20251122. Run %extendPackagesFileref(HELP) for help info.'
+des = 'Macro to list directories pointed by "packages" fileref, version 20251221. Run %extendPackagesFileref(HELP) for help info.'
 ;
 
 %if %QUPCASE(&packages.) = HELP %then
@@ -22,7 +22,7 @@ des = 'Macro to list directories pointed by "packages" fileref, version 20251122
     %put ###       This is short help information for the `extendPackagesFileref` macro            #;
     %put #-----------------------------------------------------------------------------------------#;;
     %put #                                                                                         #;
-    %put # Macro to list directories pointed by 'packages' fileref, version `20251122`             #;
+    %put # Macro to list directories pointed by 'packages' fileref, version `20251221`             #;
     %put #                                                                                         #;
     %put # A SAS package is a zip file containing a group                                          #;
     %put # of SAS codes (macros, functions, data steps generating                                  #;

SPF/Macros/generatepackage.sas

@@ -3,7 +3,7 @@
 
    Macro to generate SAS packages.
 
-   Version 20251122
+   Version 20251221
 
    A SAS package is a zip file containing a group 
    of SAS codes (macros, functions, data steps generating 
@@ -49,7 +49,7 @@
                          file name be created */
 )/ secure minoperator
 /*** HELP END ***/
-des = 'Macro to generate SAS packages, version 20251122. Run %generatePackage() for help info.'
+des = 'Macro to generate SAS packages, version 20251221. Run %generatePackage() for help info.'
 ;
 %if (%superq(filesLocation) = ) OR (%qupcase(&filesLocation.) = HELP) %then
   %do;
@@ -64,7 +64,7 @@ des = 'Macro to generate SAS packages, version 20251122. Run %generatePackage()
     %put ###      This is short help information for the `generatePackage` macro              #;
     %put #------------------------------------------------------------------------------------#;
     %put #                                                                                    #;
-    %put # Macro to generate SAS packages, version `20251122`                                 #;
+    %put # Macro to generate SAS packages, version `20251221`                                 #;
     %put #                                                                                    #;
     %put # A SAS package is a zip file containing a group                                     #;
     %put # of SAS codes (macros, functions, data steps generating                             #;
@@ -891,7 +891,7 @@ title6 "MD5 hashed fileref of package lowcase name: &_PackageFileref_.";
     title8 "Required SAS packages: %qsysfunc(compress(%superq(packageReqPackages),%str(%'%")))" ;   /* " */
   %end;
 
-footnote1 "SAS Packages Framework, version 20251122";
+footnote1 "SAS Packages Framework, version 20251221";
 
 proc print 
   data = &filesWithCodes.(drop=base folderRef fileRef rc folderid _abort_ fileId additionalContent)
@@ -1715,7 +1715,7 @@ data _null_;
             %end; 
       put +(-1) '`.;''' /
       ' !! ''      %put The macro generated: '' !! put(dtCASLudf, E8601DT19.-L) !! ";"' /
-      ' !! ''      %put with the SAS Packages Framework version 20251122.;''' / 
+      ' !! ''      %put with the SAS Packages Framework version 20251221.;''' / 
       ' !! ''      %put ****************************************************************************;''' /
       ' !! ''    %GOTO theEndOfTheMacro;''' / 
       ' !! ''    %end;''' ;
@@ -1880,7 +1880,7 @@ data _null_;
             %end; 
       put +(-1) '`.; '' !!' /
           '''      %put The macro generated: ''' " !! put(dtIML, E8601DT19.-L) !! " ''';                    '' !!' / 
-          '''      %put with the SAS Packages Framework version 20251122.;                                  '' !! ' / 
+          '''      %put with the SAS Packages Framework version 20251221.;                                  '' !! ' / 
           '''      %put ****************************************************************************;       '' !! ' /
           '''    %GOTO theEndOfTheMacro;                                                                    '' !! ' / 
           '''    %end;                                                                                      '' !! ' / 
@@ -2687,7 +2687,7 @@ data _null_;
   %end;
 
   put 'put " " / @3 "---------------------------------------------------------------------" / " ";' 
-    /       'put @3 "*SAS package generated by SAS Package Framework, version `20251122`*";' 
+    /       'put @3 "*SAS package generated by SAS Package Framework, version `20251221`*";' 
     /       "put @3 '*under `&sysscp.`(`&sysscpl.`) operating system,*';"
     /       "put @3 '*using SAS release: `&sysvlong4.`.*';"
     / 'put " " / @3 "---------------------------------------------------------------------";';
@@ -3803,7 +3803,7 @@ data &filesWithCodes.markdown;
   %end;
 
   put " " / "---------------------------------------------------------------------" / " " 
-          / "*SAS package generated by SAS Package Framework, version `20251122`,*"
+          / "*SAS package generated by SAS Package Framework, version `20251221`,*"
           / "*under `&sysscp.`(`&sysscpl.`) operating system,*" 
           / "*using SAS release: `&sysvlong4.`.*" 
     / " " / "---------------------------------------------------------------------" / " ";
@@ -3819,7 +3819,7 @@ data &filesWithCodes.markdown;
     /*
       To exclude file from being added to the documentation 
       insert the "excluding" text(see below) as a comment 
-      in the FIRST line of the file. 
+      in the FIRST or SECOND line of the file! 
       Do not add spaces.
       
       For each file the first line is read in and checked.
@@ -3833,7 +3833,15 @@ data &filesWithCodes.markdown;
         '/*##ExcludeFromDocumentation##*/'
         '/*##ExcludeFromMarkdownDoc##*/'
       )
-    then continue; /* exclude file from documentation */
+    then continue; /* exclude file from documentation after FIRST line */
+    input;
+    if strip(_infile_) IN (
+        '/*##DoNotUse4Documentation##*/'
+        '/*##ExcludeFromDocumentation##*/'
+        '/*##ExcludeFromMarkdownDoc##*/'
+      )
+    then continue; /* exclude file from documentation after SECOND line */
+                   /* this is because %splitCodeForPackage() macro adds one extra line */ 
     
     type2=type;
     length link $ 256;

SPF/Macros/helppackage.sas

@@ -28,7 +28,7 @@
                                         */
 )/secure
 /*** HELP END ***/
-des = 'Macro to get help about SAS package, version 20251122. Run %helpPackage() for help info.'
+des = 'Macro to get help about SAS package, version 20251221. Run %helpPackage() for help info.'
 ;
 %if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
   %do;
@@ -43,7 +43,7 @@ des = 'Macro to get help about SAS package, version 20251122. Run %helpPackage()
     %put ###       This is short help information for the `helpPackage` macro            #;
     %put #-------------------------------------------------------------------------------#;
     %put #                                                                               #;
-    %put # Macro to get help about SAS packages, version `20251122`                      #;
+    %put # Macro to get help about SAS packages, version `20251221`                      #;
     %put #                                                                               #;
     %put # A SAS package is a zip file containing a group                                #;
     %put # of SAS codes (macros, functions, data steps generating                        #;

SPF/Macros/installpackage.sas

@@ -1,5 +1,5 @@
 /*+installPackage+*/
-/* Macros to install SAS packages, version 20251122  */
+/* Macros to install SAS packages, version 20251221  */
 /* A SAS package is a zip file containing a group of files
    with SAS code (macros, functions, data steps generating 
    data, etc.) wrapped up together and %INCLUDEed by
@@ -26,7 +26,7 @@
 /secure
 minoperator 
 /*** HELP END ***/
-des = 'Macro to install SAS package, version 20251122. Run %%installPackage() for help info.'
+des = 'Macro to install SAS package, version 20251221. Run %%installPackage() for help info.'
 ;
 %if (%superq(packagesNames) = ) OR (%qupcase(&packagesNames.) = HELP) %then
   %do;
@@ -41,7 +41,7 @@ des = 'Macro to install SAS package, version 20251122. Run %%installPackage() fo
     %put ###       This is short help information for the `installPackage` macro                      #;
     %put #--------------------------------------------------------------------------------------------#;;
     %put #                                                                                            #;
-    %put # Macro to install SAS packages, version `20251122`                                          #;
+    %put # Macro to install SAS packages, version `20251221`                                          #;
     %put #                                                                                            #;
     %put # A SAS package is a zip file containing a group                                             #;
     %put # of SAS codes (macros, functions, data steps generating                                     #;

SPF/Macros/ispackagesfilerefok.sas

@@ -0,0 +1,149 @@
+/*+isPackagesFilerefOK+*/
+/*** HELP START ***/
+%macro isPackagesFilerefOK(
+vERRb /* indicates if macro should be verbose and report errors */
+)
+/ minoperator PARMBUFF
+des = 'Macro to check if the PACKAGES fileref is "correct", type %isPackagesFilerefOK(HELP) for help, version 20251221.'
+;
+/*** HELP END ***/
+%if %QUPCASE(&SYSPBUFF.) = %str(%(HELP%)) %then
+  %do;
+    %local options_tmp ;
+    %let options_tmp = ls=%sysfunc(getoption(ls))ps=%sysfunc(getoption(ps))
+     %sysfunc(getoption(notes)) %sysfunc(getoption(source))
+     msglevel=%sysfunc(getoption(msglevel))
+    ;
+    options NOnotes NOsource ls=MAX ps=MAX msglevel=N;
+    %put ;
+    %put ###########################################################################################;
+    %put ###       This is short help information for the `isPackagesFilerefOK` macro              #;
+    %put #-----------------------------------------------------------------------------------------#;;
+    %put #                                                                                         #;
+    %put # Macro to check if the `packages` fileref is "correct", version `20251221`               #;
+    %put #                                                                                         #;
+    %put # A SAS package is a zip file containing a group                                          #;
+    %put # of SAS codes (macros, functions, data steps generating                                  #;
+    %put # data, etc.) wrapped up together and embedded inside the zip.                            #;
+    %put #                                                                                         #;
+    %put # The `%nrstr(%%isPackagesFilerefOK())` macro checks if the `packages` fileref                     #;
+    %put # is correct, i.e. all listed directories exist, are accessible (can be open), and        #;
+    %put # are assigned with the DISK device.                                                      #;
+    %put #                                                                                         #;
+    %put # The Macro works as a macro function. It returns `1` wher everything is ok, and          #;
+    %put # it returns `0` if at least one issue exists.                                            #;
+    %put #                                                                                         #;
+    %put #### Parameters:                                                                          #;
+    %put #                                                                                         #;
+    %put # 1. `vERRb`  - *Optional* Indicates if the macro should return value AND be verbose      #;
+    %put #               (e.g., print errors and notes) or just return value.                      #;
+    %put #                                                                                         #;
+    %put # When used as: `%nrstr(%%isPackagesFilerefOK(HELP))` it displays this help information.           #;
+    %put #                                                                                         #;
+    %put #-----------------------------------------------------------------------------------------#;
+    %put #                                                                                         #;
+    %put # Visit: `https://github.com/yabwon/SAS_PACKAGES/tree/main/SPF/Documentation`             #;
+    %put # to learn more.                                                                          #;
+    %put # Tutorials available at: `https://github.com/yabwon/HoW-SASPackages`                     #;
+    %put #                                                                                         #;
+    %put #### Example ##############################################################################;
+    %put #                                                                                         #;
+    %put #   Enabling the SAS Package Framework from the local                                     #;
+    %put #   directory, expanding PACKAGES fileref, and checking                                   #;
+    %put #   if the new one is still correct for installing new package.                           #;
+    %put #                                                                                         #;
+    %put #   Assume that the `SPFinit.sas` file                                                    #;
+    %put #   is located in the "/sas/PACKAGES/" directory.                                         #;
+    %put #                                                                                         #;
+    %put #   Run the following code in your SAS session:                                           #;
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas;
+    %put  %nrstr( filename packages "/sas/PACKAGES";                        %%* set packages filename;);
+    %put  %nrstr( %%include packages(SPFinit.sas);                           %%* enable the framework;);
+    %put  ;
+    %put  %nrstr( filename packages ("~/myPCKGs" %%extendPackagesFileref()); %%* add new directory;   );
+    %put  ;
+    %put  %nrstr( %if %%IsPackagesFilerefOK() %%then                          %%* check fileref;      );
+    %put  %nrstr(   %%do; %%InstallPackage(SQLinDS) %%end;                     %%* install SQLinDS;   );
+    %put  ;
+    %put  %nrstr( %%listPackages()                                           %%* list packages;       );
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~;
+    %put ###########################################################################################;
+    %put ;
+    options &options_tmp.;
+    %GOTO ENDofIsPackagesFilerefOK;
+  %end;
+
+%if NOT (%superq(vERRb) in (0 1)) %then %let vERRb = 0;
+
+%local isPackagesFilerefOK;
+%let isPackagesFilerefOK=1;
+
+%local dsid rc nobs i XENGINE XPATH dirid _F_;
+%let dsid = %sysfunc(OPEN(sashelp.vextfl(where=(fileref="PACKAGES"))));
+%let nobs = %sysfunc(ATTRN(&dsid., nlobsf));
+/*%put &=dsid. &=nobs.;*/
+
+%if &nobs. AND 1=&vERRb. %then %put INFO: PACKAGES fileref is: %sysfunc(pathname(PACKAGES));
+
+%let isPackagesFilerefOK=%sysevalf(&nobs. AND 1, boolean);           
+
+%do i = 1 %to &nobs.;
+    %let rc=%sysfunc(FETCHOBS(&dsid., &i.));
+    %let XENGINE=%sysfunc(GETVARC(&dsid., %sysfunc(VARNUM(&dsid., XENGINE))));
+    %let XPATH=%sysfunc(GETVARC(&dsid., %sysfunc(VARNUM(&dsid., XPATH))));
+
+    %put %superq(XENGINE) %superq(XPATH);
+    %if DISK ne %superq(XENGINE) %then 
+      %do;
+        %let isPackagesFilerefOK=0;
+        %if 1=&vERRb. %then
+          %do;
+            %if %superq(XENGINE) = SASFSVAM %then %let XENGINE= FILESRVC (SASFSVAM);
+            %put ERROR: The %superq(XENGINE) is illegal! Only the DISK device is correct.;
+          %end;
+      %end;
+    %else %if 0=%sysfunc(fileexist(%superq(XPATH))) %then 
+      %do;
+        %let isPackagesFilerefOK=0;
+        %if 1=&vERRb. %then
+          %do;
+            %put ERROR: Path: %superq(XPATH) does NOT exist!;
+          %end;
+      %end;
+    %else
+      %do;
+        %let rc = %sysfunc(FILENAME(_F_, %superq(XPATH)));
+        %let dirid = %sysfunc(DOPEN(&_F_.));
+        %let isPackagesFilerefOK=%sysevalf(&dirid. AND 1, boolean);
+        %let dirid = %sysfunc(DCLOSE(&dirid.));
+        %let rc = %sysfunc(FILENAME(_F_));
+        %if 1=&vERRb. AND 0=&isPackagesFilerefOK. %then
+          %do;
+            %put ERROR: Path: %superq(XPATH) cannot be open!;
+            %put ERROR- It may not be a directory or your access rights are insuficient.;
+          %end;
+      %end;
+%end;
+
+%let dsid = %sysfunc(CLOSE(&dsid.));
+
+%if 1=&vERRb. %then
+  %do;
+    %if &isPackagesFilerefOK.=1 %then
+      %do;
+        %put %str( );
+        %put INFO: The PACKAGES fileref is OK. Enjoy!;
+        %put %str( );
+      %end;
+    %else
+      %do;
+        %put %str( );
+        %put ERROR: The PACKAGES fileref is incorrect!;
+        %put %str( );
+      %end;
+  %end;
+/* result */
+%do;&isPackagesFilerefOK.%return;%end;
+%ENDofIsPackagesFilerefOK:
+%mend isPackagesFilerefOK;
+

SPF/Macros/listpackages.sas

@@ -3,7 +3,7 @@
 
   Macro to list SAS packages in packages folder. 
 
-  Version 20251122 
+  Version 20251221 
 
   A SAS package is a zip file containing a group 
   of SAS codes (macros, functions, data steps generating 
@@ -23,7 +23,7 @@
 
 %macro listPackages()
 /secure PARMBUFF
-des = 'Macro to list SAS packages from `packages` fileref, type %listPackages(HELP) for help, version 20251122.'
+des = 'Macro to list SAS packages from `packages` fileref, type %listPackages(HELP) for help, version 20251221.'
 ;
 %if %QUPCASE(&SYSPBUFF.) = %str(%(HELP%)) %then
   %do;
@@ -38,7 +38,7 @@ des = 'Macro to list SAS packages from `packages` fileref, type %listPackages(HE
     %put ###       This is short help information for the `listPackages` macro                     #;
     %put #-----------------------------------------------------------------------------------------#;;
     %put #                                                                                         #;
-    %put # Macro to list available SAS packages, version `20251122`                                #;
+    %put # Macro to list available SAS packages, version `20251221`                                #;
     %put #                                                                                         #;
     %put # A SAS package is a zip file containing a group                                          #;
     %put # of SAS codes (macros, functions, data steps generating                                  #;

SPF/Macros/loadpackage.sas

@@ -36,7 +36,7 @@
                                        */
 )/secure
 /*** HELP END ***/
-des = 'Macro to load SAS package, version 20251122. Run %loadPackage() for help info.'
+des = 'Macro to load SAS package, version 20251221. Run %loadPackage() for help info.'
 minoperator
 ;
 %if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
@@ -52,7 +52,7 @@ minoperator
     %put ###      This is short help information for the `loadPackage` macro             #;
     %put #-------------------------------------------------------------------------------#;
     %put #                                                                               #;
-    %put # Macro to *load* SAS packages, version `20251122`                              #;
+    %put # Macro to *load* SAS packages, version `20251221`                              #;
     %put #                                                                               #;
     %put # A SAS package is a zip file containing a group                                #;
     %put # of SAS codes (macros, functions, data steps generating                        #;

SPF/Macros/loadpackageaddcnt.sas

@@ -19,7 +19,7 @@
                                          is provided in required version */
 )/secure 
 /*** HELP END ***/
-des = 'Macro to load additional content for a SAS package, version 20251122. Run %loadPackageAddCnt() for help info.'
+des = 'Macro to load additional content for a SAS package, version 20251221. Run %loadPackageAddCnt() for help info.'
 minoperator
 ;
 %if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
@@ -35,7 +35,7 @@ minoperator
     %put ###      This is short help information for the `loadPackageAddCnt` macro       #;
     %put #-------------------------------------------------------------------------------#;
     %put #                                                                               #;
-    %put # Macro to *load* additional content for a SAS package, version `20251122`      #;
+    %put # Macro to *load* additional content for a SAS package, version `20251221`      #;
     %put #                                                                               #;
     %put # A SAS package is a zip file containing a group                                #;
     %put # of SAS codes (macros, functions, data steps generating                        #;
@@ -288,7 +288,7 @@ minoperator
                           run;
 
                           data _null_; 
-                          	set WORK.__&_TargetFileref_._zip___ end = EOF;
+                            set WORK.__&_TargetFileref_._zip___ end = EOF;
                             wc = countw(file,"/\");
                           
                             put wc= file=;

SPF/Macros/loadpackages.sas

@@ -11,7 +11,7 @@
                  */
 )/secure 
 /*** HELP END ***/
-des = 'Macro to load multiple SAS packages at one run, version 20251122. Run %loadPackages() for help info.'
+des = 'Macro to load multiple SAS packages at one run, version 20251221. Run %loadPackages() for help info.'
 parmbuff
 ;
 %if (%superq(packagesNames) = ) OR (%qupcase(&packagesNames.) = HELP) %then
@@ -27,7 +27,7 @@ parmbuff
     %put ###      This is short help information for the `loadPackageS` macro            #;
     %put #-------------------------------------------------------------------------------#;
     %put #                                                                               #;
-    %put # Macro wrapper for the loadPackage macro, version `20251122`                   #;
+    %put # Macro wrapper for the loadPackage macro, version `20251221`                   #;
     %put #                                                                               #;
     %put # A SAS package is a zip file containing a group                                #;
     %put # of SAS codes (macros, functions, data steps generating                        #;

SPF/Macros/previewpackage.sas

@@ -23,7 +23,7 @@
                                        */
 )/secure
 /*** HELP END ***/
-des = 'Macro to preview content of a SAS package, version 20251122. Run %previewPackage() for help info.'
+des = 'Macro to preview content of a SAS package, version 20251221. Run %previewPackage() for help info.'
 ;
 %if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
   %do;
@@ -38,7 +38,7 @@ des = 'Macro to preview content of a SAS package, version 20251122. Run %preview
     %put ###    This is short help information for the `previewPackage` macro            #;
     %put #-------------------------------------------------------------------------------#;
     %put #                                                                               #;
-    %put # Macro to get preview of a SAS packages, version `20251122`                    #;
+    %put # Macro to get preview of a SAS packages, version `20251221`                    #;
     %put #                                                                               #;
     %put # A SAS package is a zip file containing a group                                #;
     %put # of SAS codes (macros, functions, data steps generating                        #;

SPF/Macros/relocatepackage.sas

@@ -0,0 +1,683 @@
+/*+relocatePackage+*/
+/*** HELP START ***/
+
+%macro relocatePackage(
+ packageName   /* list of packages (space-separated!) */ 
+,source=       /* place to take packages from (local location) */
+,target=       /* the "packages" fileref by default */
+,sDevice=DISK  /* also: ZIP, FILESRVC (SASFSVAM)*/
+,tDevice=DISK  /* also: ZIP, FILESRVC */
+,checksum=0    /* if 1, copies data only if the source (from file) checksum is different than the target (to file) */
+,move=0        /* packages are copied by default */
+,try=3         /* integer between 1 and 9 */
+,debug=0       /* debugging indicator */
+,ignorePackagesFilerefCheck=0
+)
+/ des = 'Utility macro that locally Copies or Moves Packages, version 20251221. Run %relocatePackage() for help info.'
+  secure
+  minoperator
+;
+/*** HELP END ***/
+%if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
+  %do;
+    %local options_tmp ;
+    %let options_tmp = ls=%sysfunc(getoption(ls))ps=%sysfunc(getoption(ps))
+     %sysfunc(getoption(notes)) %sysfunc(getoption(source))
+     msglevel=%sysfunc(getoption(msglevel))
+    ;
+    options NOnotes NOsource ls=MAX ps=MAX msglevel=N;
+    %put ;
+    %put #################################################################################;
+    %put ###      This is short help information for the `relocatePackage` macro         #;
+    %put #-------------------------------------------------------------------------------#;
+    %put #                                                                               #;
+    %put # Macro to *locally copy or move* (relocate) SAS packages, version `20251221`   #;
+    %put #                                                                               #;
+    %put # A SAS package is a zip file containing a group                                #;
+    %put # of SAS codes (macros, functions, data steps generating                        #;
+    %put # data, etc.) wrapped up together and included by                               #;
+    %put # a single `load.sas` file (also embedded inside the zip).                      #;
+    %put #                                                                               #;
+    %put # The `%nrstr(%%relocatePackage())` is a utility macro for local copying or moving       #;
+    %put # SAS packages. The macro transfers packages located in the `PACKAGES`          #;
+    %put # fileref to a selected directory (`DISK` device), folderpath (`FILESRVC`       #;
+    %put # device), or a zip file (`ZIP` device).                                        #;
+    %put #                                                                               #;
+    %put # The macro allows for a bidirectional transfer of packages, i.e., from the     #;
+    %put # `PACKAGES` fileref to the selected *target*, or from the selected *source*    #;
+    %put # to the `PACKAGES` fileref.                                                    #;
+    %put #                                                                               #;
+    %put #-------------------------------------------------------------------------------#;
+    %put #### Parameters:                                                                #;
+    %put #                                                                               #;
+    %put # 1. `packageName`      *Required.* Name of a package, e.g. myPackage.          #;
+    %put #                       A space-separated(!) list of packages to transfer is    #;
+    %put #                       also accepted. If empty displays this help information. #;
+    %put #                                                                               #;
+    %put # - `source=`           *Required/Optional.* Source location for packages.      #;
+    %put #                       When used, indicates a directory (`DISK` device),       #;
+    %put #                       a folderpath (`FILESRVC` device), or a zip file (`ZIP`  #;
+    %put #                       device) *from* where packages will be copied.           #;
+    %put #                       In this case `PACKAGES` fileref is target location.     #;
+    %put #                       Cannot be used together with `target=` parameter.       #;
+    %put #                                                                               #;
+    %put # - `target=`           *Required/Optional.* Target location for packages.      #;
+    %put #                       When used, indicates a directory (`DISK` device),       #;
+    %put #                       a folderpath (`FILESRVC` device), or a zip file (`ZIP`  #;
+    %put #                       device) *to* where packages will be copied.             #;
+    %put #                       In this case `PACKAGES` fileref is source location.     #;
+    %put #                       Cannot be used together with `source=` parameter.       #;
+    %put #                                                                               #;
+    %put # - `sDevice=`          *Required/Optional.* When `source=` is used this        #;
+    %put #                       parameter provides which type of device to be use.      #;
+    %put #                       Default value is `DISK`, values `ZIP` and `FILESRVC`    #;
+    %put #                       are allowed. For `FILESRVC` the `folderpath=` is used.  #;
+    %put #                                                                               #;
+    %put # - `tDevice=`          *Required/Optional.* When `target=` is used this        #;
+    %put #                       parameter provides which type of device to be use.      #;
+    %put #                       Default value is `DISK`, values `ZIP` and `FILESRVC`    #;
+    %put #                       are allowed. For `FILESRVC` the `folderpath=` is used.  #;
+    %put #                                                                               #;
+    %put # - `checksum=`         *Optional.* Indicates if packages should be copied only #;
+    %put #                       if the source (from file) checksum is different than    #;
+    %put #                       the target (to file). Default value is 0 (always copy). #;
+    %put #                                                                               #;
+    %put # - `move=`             *Optional.* Indicates if packages should be moved from  #;
+    %put #                       source to target, default value is `0`,                 #;
+    %put #                       when set to `1`: after *successful* copying packages    #;
+    %put #                       in the source are *deleted*. Use carefully!             #;
+    %put #                                                                               #;
+    %put # - `debug=`            *Optional.* Indicates if debug notes should be printed, #;
+    %put #                       default value is `0`, when set to `1`: debug info       #;
+    %put #                       is printed.                                             #;
+    %put #                                                                               #;
+    %put # - `try=`              *Optional.* Number of tries when copy is unsuccessful,  #;
+    %put #                       default value is `3`, allowed values are integers       #;
+    %put #                       from 1 to 9. Time between tries is quarter of a second. #;
+    %put #                                                                               #;
+    %put #-------------------------------------------------------------------------------#;
+    %put #                                                                               #;
+    %put # Visit: `https://github.com/yabwon/SAS_PACKAGES/tree/main/SPF/Documentation`   #;
+    %put # to learn more.                                                                #;
+    %put # Tutorials available at: `https://github.com/yabwon/HoW-SASPackages`           #;
+    %put #                                                                               #;
+    %put ### Example 1 ###################################################################;
+    %put #                                                                               #;
+    %put #   Enabling the SAS Package Framework from the local                           #;
+    %put #   directory, copying SQLinDS package from Viya Files                          #;
+    %put #   service, and loading the package to the SAS session.                        #;
+    %put #                                                                               #;
+    %put #   Assume that the `SPFinit.sas` file is located in the "/home/user/PCKG"      #;
+    %put #   directory and Viya Files service location is "/files/packages/"             #;
+    %put #                                                                               #;
+    %put #   Run the following code in your SAS session:                                 #;
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas;
+    %put  %nrstr( filename packages "/home/user/PCKG"; %%* setup a directory for packages;     );
+    %put  %nrstr( %%include packages(SPFinit.sas);      %%* enable the framework;              );
+    %put  ;
+    %put  %nrstr( %%relocatePackage%(SQLinDS  %%* copy the package from Viya Files service;    );
+    %put  %nrstr(                 ,source=/files/packages/                                     );
+    %put  %nrstr(                 ,sDevice=FILESRVC%)                                          );
+    %put  %nrstr( %%loadPackage(SQLinDS)   %%* load the package content into the SAS session;  );
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~;
+    %put #                                                                               #;
+    %put ### Example 2 ###################################################################;
+    %put #                                                                               #;
+    %put #   Enabling the SAS Package Framework from the local directory                 #;
+    %put #   and creating a "bundle" file by moving 3 packages: the BasePlus,            #;
+    %put #   the SQLinDS, and the MacroArray package into the target file.               #;
+    %put #                                                                               #;
+    %put #   Assume that the `SPFinit.sas` file                                          #;
+    %put #   is located in the "C:/SAS_PACKAGES/" folder.                                #;
+    %put #                                                                               #;
+    %put #   Run the following code in your SAS session:                                 #;
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas;
+    %put  %nrstr( filename packages "C:/SAS_PACKAGES"; %%* setup a directory for packages;       );
+    %put  %nrstr( %%include packages(SPFinit.sas);      %%* enable the framework;                );
+    %put  ;
+    %put  %nrstr( %%relocatePackage%(BasePlus SQLinDS MacroArray %%* create a bundle of packages;);
+    %put  %nrstr(                 ,target=D:/archive/bundle_2025_12_15.zip                       );
+    %put  %nrstr(                 ,tDevice=ZIP, move=1%)                                         );
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~;
+    %put #                                                                               #;
+    %put #################################################################################;
+    %put ;
+    options &options_tmp.;
+    %GOTO ENDofrelocatePackage;
+  %end;
+  /* local variables for options */
+  %local ls_tmp ps_tmp notes_tmp source_tmp stimer_tmp fullstimer_tmp msglevel_tmp mautocomploc_tmp;
+  %let ls_tmp         = %sysfunc(getoption(ls));
+  %let ps_tmp         = %sysfunc(getoption(ps));
+  %let notes_tmp      = %sysfunc(getoption(notes));
+  %let source_tmp     = %sysfunc(getoption(source));
+  %let stimer_tmp     = %sysfunc(getoption(stimer));
+  %let fullstimer_tmp = %sysfunc(getoption(fullstimer));
+  %let msglevel_tmp   = %sysfunc(getoption(msglevel));
+  %let mautocomploc_tmp = %sysfunc(getoption(mautocomploc));
+
+  options NOnotes NOsource ls=MAX ps=MAX NOfullstimer NOstimer msglevel=N NOmautocomploc;
+
+  %if NOT(%superq(debug) in (0 1))                      %then %let debug=0;
+  %if NOT(%superq(move) in (0 1))                       %then %let move=0;
+  %if NOT(%superq(try) in (1 2 3 4 5 6 7 8 9))          %then %let try=3;
+  %if NOT(%superq(checksum) in (0 1))                   %then %let checksum=0;
+  %if NOT(%superq(ignorePackagesFilerefCheck) in (0 1)) %then %let ignorePackagesFilerefCheck=0;
+  
+  options nonotes msglevel=N;
+
+  %local HASHING_FILE_exist;
+  %let HASHING_FILE_exist = 0;
+
+  %if %sysfunc(exist(sashelp.vfunc, VIEW)) %then
+    %do;
+      data _null_;
+        set sashelp.vfunc(keep=fncname);
+        where fncname = "HASHING_FILE";
+        call symputX('HASHING_FILE_exist', 1, "L");
+        stop;
+      run;
+    %end;
+  %if &checksum. AND NOT &HASHING_FILE_exist. %then
+    %do;
+      %put WARNING: Checksum verification impossible! Minimum SAS version required for the process is 9.4M6. ;
+    %end;
+
+  data _null_;
+    putlog 32*"*" 24*"=" 32*"*";
+    length packages source target $ 32767 sDevice tDevice $ 32;
+    packages = lowcase(compress(symget('packageName'),"_ ","KAD"));
+
+    if " " = packages then 
+      do;
+        putlog "INFO: No packages to move or copy. Exiting.";
+        LINK stopProcessing;
+      end;
+    else putlog "INFO: List of packages: " packages;
+
+    debug = sum(symgetn('debug'),0);
+
+    /* grab macro variables values */
+    array mvar source target sDevice tDevice;
+    do over mvar;
+      mvar=symget(vname(mvar));
+    end;
+
+    if source NE ' ' AND target NE " " then
+      do;
+        putlog "WARNING: The SOURCE= and the TARGET= parameters cannot be used simultaneously. Exiting!";
+        LINK stopProcessing;
+      end;
+
+    if source EQ ' ' AND target EQ " " then
+      do;
+        putlog "INFO: The SOURCE= and the TARGET= parameters were not used, nothing to do. Exiting!";
+        LINK stopProcessing;
+      end;
+
+    /* verify that PACKAGES is valid location for source or target */
+    /*=========================================================================================================*/
+    %if 0 = &ignorePackagesFilerefCheck. %then
+      %do;
+        if NOT (input(resolve('%isPackagesFilerefOK(&debug.)'), best.)=1) then /* if debug=1 the isPackagesFilerefOK in verbose mode */
+          do;
+            putlog "WARNING: The PACKAGES fileres is not OK! Exiting!";
+            LINK stopProcessing;
+          end;
+      %end;
+    /*=========================================================================================================*/
+
+    /* prepare source and target */
+    /*=========================================================================================================*/
+    %local i ST_list st stDev stFr stH stI stEx stAsg leave;
+    %let ST_list=target source; /* repeat the same structure twice with different prefix */
+    %do i=1 %to 2;
+      %let st=%scan(&ST_list., &i.);
+      %let stDev=%substr(&st.,1,1)Device;
+      %let stFr =%substr(&st.,1,1)FileRef;
+      %let stH  =%substr(&st.,1,1)Hash;
+      %let stI  =%substr(&st.,1,1)Iter;
+      %let stEx =%substr(&st.,1,1)Exists;
+      %let stAsg=%substr(&st.,1,1)Assigned;
+      %let stFp =%substr(&st.,1,1)FromPackages;
+
+      retain &stFp. 0 move 0;
+      move = sum(symgetn('move'),0);
+      /* validate source and target */
+      &stDev. = upcase(compress(&stDev.,"_","KAD"));
+      if NOT (&stDev. in ("DISK" "BASE" "ZIP" "FILESRVC" "SASFSVAM")) then
+        do;
+          putlog "WARNING: The &stDev. parameter value: " &stDev. "is not allowed."
+               / "WARNING- Only: DISK, ZIP, and FILESRVC devices are supported as &st. device. Exiting!";
+          LINK stopProcessing;
+        end;
+
+      if &st.=" " then 
+        do;
+          if 0 then set SASHELP.VEXTFL;
+          DECLARE HASH &stH.(dataset:'SASHELP.VEXTFL(where=(fileref="PACKAGES"))', ordered: "A");
+          &stH..DefineKey("level");
+          &stH..DefineData("xpath","xengine");
+          &stH..DefineDone();
+          DECLARE HITER &stI.("&stH.");
+
+          if &stH..NUM_ITEMS=0 then
+            do;
+              putlog "INFO: Packages fileref not found. Using WORK instead.";
+              level = 0;
+              xpath = pathname("WORK","L");
+              xengine = 'DISK';
+              &stI..REPLACE();
+            end;
+
+          &stI..FIRST();
+          &st. = strip(xpath); /* get the first packages path */
+          &stDev. = strip(xengine);
+          
+          /* Just to make it easier to debug since FILESRVC will show up in Google */
+          if &stDev. = 'SASFSVAM' then _stDev_ = 'FILESRVC';
+                                  else _stDev_ = strip(xengine);
+          putlog "INFO: The &st. location is: " / @7 _stDev_ +(-1) ": " &st.;
+          %if &st.=source %then 
+            %do;
+              do while(&stI..next()=0);
+                 if xengine = 'SASFSVAM' then _engine_ = 'FILESRVC';
+                                         else _engine_ = xengine;
+                 putlog @7 _engine_ +(-1) ": " xpath;
+              end;
+            %end;
+          &stFp. = 1;
+        end; 
+      else
+        do;
+          length &stFr. $ 8; 
+
+          if " "=getoption("SERVICESBASEURL") AND (&stDev. in ("FILESRVC" "SASFSVAM")) then 
+            do;
+              putlog "WARNING: The SERVICESBASEURL option must be specified for the FILESRVC device. Exiting!";
+              LINK stopProcessing; 
+            end;
+
+          length &stAsg.Txt &stEx.Txt $ 256;
+
+
+          if (&stDev. in ("FILESRVC" "SASFSVAM")) then
+            &stAsg. = filename(&stFr., ,strip(&stDev.), "recfm=n lrecl=1 " !! "folderpath=" !! quote(strip(&st.))); /* assign FILESRVC */
+          else 
+            &stAsg. = filename(&stFr.,strip(&st.), strip(&stDev.), "recfm=n lrecl=1"); /* assign DISK or ZIP*/
+          &stAsg.Txt = sysmsg();
+
+          &stEx. = FEXIST(&stFr.);
+          &stEx.Txt = sysmsg();
+
+          if debug then putlog (&stFr. &st. &stDev. &stAsg. &stAsg.Txt &stEx. &stEx.Txt) (=/);
+          _rc_ = filename(&stFr.); /*clear*/
+        end;
+    %end;
+    /*=========================================================================================================*/
+
+    if source=target and sDevice=tDevice then 
+      do;
+        putlog / "INFO: Nothing to move or copy. Exiting.";
+        LINK stopProcessing;
+      end;
+
+    if move then 
+      do;
+        putlog / "INFO: Files will be moved, i.e., after successful copying to the target location" 
+               / "      the source will be deleted.";
+      end;
+
+    /* 4096 for host options for Viya FS */
+    length sHostoptions tHostOptions $ 4096  tFilename sFilename  $ 2048;
+
+    do i = 1 to countw(packages, " ");
+      package = scan(packages, i, " ");
+
+      putlog 32*"*" package $24.-C 32*"*";
+
+      select;
+        /* copy from PACKAGES to some location */
+        /*=========================================================================================================*/
+        when(1=sFromPackages AND 0=tFromPackages AND 0=tAssigned) 
+          do;
+            select;
+              /* disk */
+              when (tDevice in ("DISK" "BASE"))
+                do;
+                  if NOT tExists then GOTO stopForThisPackage1;
+                  tAssigned = filename(tFileRef
+                                      ,cats(target, "/", package, ".zip")
+                                      ,strip(tDevice)
+                                      ,"recfm=n lrecl=1");
+                end;
+              /* zip */
+              when (tDevice in ("ZIP"))
+                do;
+                  if tExists then putlog "INFO: Overwriting member: " package +(-1) ".zip inside: " target;
+                  tAssigned = filename(tFileRef
+                                      ,cats(target)
+                                      ,strip(tDevice)
+                                      ,"recfm=n lrecl=1 member=" !! quote(cats(package, ".zip")) );
+                end;
+              /* filesrvc */
+              when (tDevice in ("FILESRVC" "SASFSVAM"))
+                do;
+                  tAssigned = filename(tFileRef
+                                      ,/*blank*/ ,strip(tDevice)
+                                      ,"recfm=n lrecl=1" 
+                                       !! " folderpath=" !! quote(cats(target))
+                                       !! " filename="   !! quote(cats(package, ".zip"))
+                                      );
+                end;
+              /* other */
+              otherwise 
+                do;
+                  putlog "ERROR: Unsupported device: " tDevice +(-1) ". Exiting!";
+                  GOTO stopForThisPackage1;
+                end;
+            end;
+
+            if debug then putlog tAssigned= tFileRef= / tDevice=;
+
+            _rc_ = sIter.first(); 
+            _rc_ = sIter.prev();
+            do while(sIter.next()=0);
+
+              /* If Viya File Service, we need to use:
+                 filename('fileref', ,'FILEFSVAM', "<host options>") */
+              if xengine = 'SASFSVAM' then do;
+                  sFilename = ' ';
+                  sHostOptions = "recfm=n lrecl=1"
+                                  !! " folderpath=" !! quote(strip(xpath))
+                                  !! " filename="   !! quote(cats(package, ".zip"))
+                  ;
+              end;
+                else do;
+                    sFilename = cats(strip(xpath), "/", package, ".zip");
+                    sHostOptions = "recfm=n lrecl=1";
+                end;
+
+              sAssigned = filename(sFileref
+                                  ,sFilename
+                                  ,xengine
+                                  ,sHostOptions);
+
+              if debug then putlog sAssigned= sFileRef= / xengine=;
+              leave=0;
+              LINK LoopTryCopyFile; /* LINK 1 */
+              if leave then leave;
+            end;
+            sAssigned = filename(sFileRef);
+            tAssigned = filename(tFileRef); 
+
+            stopForThisPackage1:
+            if 0=leave then putlog "ERROR: Fail to process " package;
+          end;
+        /*=========================================================================================================*/
+
+        /* copy from some location to PACKAGES */
+        /*=========================================================================================================*/
+        when(0=sFromPackages AND 1=tFromPackages AND 0=sAssigned) 
+          do;
+            select;
+              /* disk */
+              when (sDevice in ("DISK" "BASE"))
+                do;
+                  if NOT sExists then GOTO stopForThisPackage2;
+                  sAssigned = filename(sFileRef
+                                      ,cats(source, "/", package, ".zip")
+                                      ,strip(sDevice)
+                                      ,"recfm=n lrecl=1");
+                end;
+              /* zip */
+              when (sDevice in ("ZIP"))
+                do;
+                  sAssigned = filename(sFileRef
+                                      ,cats(source)
+                                      ,strip(sDevice)
+                                      ,"recfm=n lrecl=1 member=" !! quote(cats(package, ".zip")) );
+                end;
+              /* filesrvc */
+              when (sDevice in ("FILESRVC" "SASFSVAM"))
+                do;
+                  sAssigned = filename(sFileRef
+                                      ,/*blank*/ ,strip(sDevice)
+                                      ,"recfm=n lrecl=1" 
+                                       !! " folderpath=" !! quote(cats(source))
+                                       !! " filename="   !! quote(cats(package, ".zip"))
+                                      );
+                end;
+              /* other */
+              otherwise 
+                do;
+                  putlog "ERROR: Unsupported device: " sDevice +(-1) ". Exiting!";
+                  GOTO stopForThisPackage2;
+                end;
+            end;
+
+            if debug then putlog sAssigned= sFileRef= / sDevice=;
+
+            if NOT fexist(sFileRef) then 
+              do;
+                putlog "WARNING: File: " package +(-1) ".zip does NOT exist inside: " source;
+              end;
+            else
+              do;
+                _rc_ = tIter.first(); 
+                _rc_ = tIter.prev();
+                do while(tIter.next()=0);
+
+                    /* If Viya File Service, we need to use:
+                        filename('fileref', ,'FILEFSVAM', "<host options>") */
+                    if xengine = 'SASFSVAM' then do;
+                        tFilename = ' ';
+                        tHostOptions = "recfm=n lrecl=1"
+                                        !! " folderpath=" !! quote(strip(xpath))
+                                        !! " filename="   !! quote(cats(package, ".zip"))
+                        ;
+                    end;
+                        else do;
+                            tFilename = cats(strip(xpath), "/", package, ".zip");
+                            tHostOptions = "recfm=n lrecl=1";
+                        end;
+
+                    tAssigned = filename(tFileRef
+                                        ,tFilename
+                                        ,xengine
+                                        ,tHostOptions);
+                                      
+                  if debug then putlog tAssigned= tFileRef= / xengine=;
+                  leave=0;
+                  LINK LoopTryCopyFile; /* LINK 1 */
+                  if leave then leave;
+                end;
+                tAssigned = filename(tFileRef); 
+              end;
+
+            sAssigned = filename(sFileRef);
+            stopForThisPackage2:
+            if 0=leave then putlog "ERROR: Fail to process " package;
+          end;
+        /*=========================================================================================================*/
+        /**
+          when(0) do; put "future cases"; end; 
+        **/
+        otherwise putlog "WARNING: Unknown combination.";
+      end; 
+    end;
+
+  LINK stopProcessing;
+  /** the end **/
+  STOP;
+
+  /* LINK 1 */
+  loopTryCopyFile:
+    do try = 1 to &try. while(leave=0);
+
+    length s_HASHING t_HASHING $ 128;
+
+    %if &checksum. AND &HASHING_FILE_exist. %then
+      %do;
+        if try = 1 AND fexist(tFileRef) then /* check SHA256 only for first try */
+          do;
+            LINK GETSHA256DIGEST; /* LINK 2 */
+
+            if s_HASHING=t_HASHING then 
+              do;
+                putlog "INFO: The SHA256 hash digest for source and target are identical."
+                     / @7 "Checksum: " t_HASHING
+                     / @7 "Package will not be copied.";
+                _rc_ = 0;
+              end;
+            else
+              do; /* message only for the first time */
+                putlog "INFO: The SHA256 hash digest for source and target are different."
+                     / @7 "Target checksum: " t_HASHING
+                     / @7 "Source checksum: " s_HASHING
+                     / @7 "Copying package.";
+                _rc_    = fcopy(sFileRef, tFileRef);
+                _rcTxt_ = sysmsg();
+              end;
+          end; 
+        else /* keep this ELSE unclosed for... */
+      %end;
+      
+      do; /* ... this DO-END block  */
+        _rc_    = fcopy(sFileRef, tFileRef);
+        _rcTxt_ = sysmsg();
+      end;
+
+      if debug then putlog _rc_= / _rcTxt_=;
+      leave + (_rc_=0)*fexist(tFileRef);
+
+      %if &HASHING_FILE_exist. = 1 %then
+        %do;
+          if leave then /* compare SHA256 after copy */
+            do;
+              LINK GETSHA256DIGEST; /* LINK 2 */
+
+              if NOT (s_HASHING=t_HASHING) then 
+                putlog "WARNING: The SHA256 hash digest is different for source and target!" 
+                     / "WARNING- Source is: " s_HASHING 
+                     / "WARNING- Target is: " t_HASHING
+                     / "WARNING- There could be errors during copying. Check your files.";
+            end;
+        %end;
+
+      if (leave AND move) then 
+        do;
+          _rc_ = fdelete(sFileRef);
+          if _rc_ then putlog "WARNING: Target successfully copied, but cannot delete source file while moving.";
+        end;
+      if not leave then _rc_ = sleep(1,0.25);
+    end;
+  return;
+
+  /* LINK 2 */
+  GETSHA256DIGEST:
+    %let ST_list=t s; /* for source(s) and for target(t), repeat the same structure twice with different prefix */
+    %do i=1 %to 2;
+      %let st=%scan(&ST_list., &i.);
+      select;
+        when (&st.Device in ("ZIP")) &st._HASHING=HASHING_FILE("SHA256", &st.FileRef, 4);
+        when (&st.Device in ("DISK" "BASE")) &st._HASHING=HASHING_FILE("SHA256", pathname(&st.FileRef,'F'), 0);
+        otherwise /* for FILESRVC and SASFSVAM*/
+          do;
+             &st._sha256 = hashing_init("SHA256");  
+             &st._FID = fopen(&st.FileRef, "i", 1, "B"); /* read only in binary format */
+             if &st._FID then do while(fread(&st._FID)=0);
+               length &st.c $ 1;
+               _rc_ = fget(&st._FID, &st.c, 1);
+               _rc_ = hashing_part(&st._sha256, &st.c);
+             end;
+             &st._FID = fclose(&st._FID);
+             &st._HASHING = hashing_term(&st._sha256);
+          end;
+      end;
+    %end;
+  return;
+
+  /* LINK 3 */
+  stopProcessing:
+    putlog 32*"*" 24*"=" 32*"*";
+    stop;
+  return;
+
+  run;
+
+  /* restore optionos */
+  options ls = &ls_tmp. ps = &ps_tmp. 
+          &notes_tmp. &source_tmp. 
+          &stimer_tmp. &fullstimer_tmp.
+          msglevel=&msglevel_tmp. &mautocomploc_tmp.;
+
+%ENDofrelocatePackage:
+%mend relocatePackage;
+
+/* tests on Viya:
+
+filename PACKAGES list; 
+
+%let user= <...>; 
+
+filename backup filesrvc
+  folderpath="/Users/&user./My Folder/SASPACKAGES";
+filename backup list;
+
+%put %sysfunc(pathname(backup));
+
+data _null_;
+  x=getoption("SERVICESBASEURL");
+  put x=;
+run;
+
+options ls = 90;
+%* move from PACKAGES to a FILESRVC location*;
+%relocatePackage(baseplus SQLinDS macroarray
+,target=/Users/&user./My Folder/SASPACKAGES
+,tDevice=FILESRVC
+,move=1) 
+
+%* move back to PACKAGES from a FILESRVC location*;
+%relocatePackage(baseplus SQLinDS macroarray
+,source=/Users/&user./My Folder/SASPACKAGES
+,sDevice=FILESRVC
+,move=1) 
+
+%* create a ZIP bundle with packages in HOME *;
+%relocatePackage(baseplus SQLinDS macroarray
+,target=~/SASPACKAGESbundle.zip
+,tDevice=ZIP) 
+*/
+/* SERVICESBASEURL */
+
+/* Tests on SAS:
+
+options mprint msglevel=N;
+
+filename PACKAGES ("R:\" "C:\SAS_WORK\SAS_PACKAGES");
+
+%relocatePackage(myPackage)
+
+options nomprint msglevel=N;
+%relocatePackage(baseplus SQLinDS macroarray, target=R:\abc, debug=1)
+%relocatePackage(baseplus SQLinDS macroarray, target=R:\noDir)
+%relocatePackage(baseplus SQLinDS macroarray, target=R:\bundle.zip, tDevice=zip)
+%relocatePackage(baseplus SQLinDS macroarray, target=R:\, tDevice=FILESRVC) 
+
+filename PACKAGES ("R:\testPackages1_NOT_EXIST" "R:\testPackages2_NOT_EXIST");
+%relocatePackage(baseplus SQLinDS macroarray abc, source=R:\abc, debug=1, move=1)
+
+filename PACKAGES ("R:\testPackages1" "R:\testPackages2");
+%relocatePackage(baseplus SQLinDS macroarray abc, source=R:\abc, debug=1, move=1)
+%relocatePackage(baseplus SQLinDS macroarray, source=R:\noDir, debug=1)
+
+filename PACKAGES ("R:\testPackages2" "R:\testPackages1");
+%relocatePackage(baseplus SQLinDS macroarray, source=R:\bundle.zip, sDevice=zip, move=1)
+%relocatePackage(baseplus SQLinDS macroarray, source=R:\, sDevice=FILESRVC) 
+%relocatePackage(baseplus SQLinDS macroarray, source=R:\bundle.zip, sDevice=zip, target=R:\bundle)
+*/
+/*%macro _();%mend _;*/
+/**/
+

SPF/Macros/saspackagesframeworknotes.sas

@@ -0,0 +1,165 @@
+/*+SasPackagesFrameworkNotes+*/
+%macro SasPackagesFrameworkNotes(
+SPFmacroName /* space separated list of names */
+)
+/
+minoperator 
+secure
+des = 'Macro to provide help notes about SAS Packages Framework macros, version 20251221. Run %SasPackagesFrameworkNotes(HELP) for help info.'
+;
+%local list N i element;
+%let list=
+installPackage
+listPackages
+/**/
+verifyPackage
+previewPackage
+helpPackage
+/**/
+loadPackage
+loadPackageS
+loadPackageAddCnt
+/**/
+unloadPackage
+/**/
+generatePackage
+splitCodeForPackage
+/**/
+extendPackagesFileref
+relocatePackage
+isPackagesFilerefOK
+/**/
+SasPackagesFrameworkNotes
+;
+%let N = %sysfunc(countw(&list.));
+
+%let SPFmacroName = %sysfunc(compress(%superq(SPFmacroName),_ *,KAD));
+
+%if (%qupcase(&SPFmacroName.) = HELP) %then
+  %do;
+    %local options_tmp ;
+    %let options_tmp = ls=%sysfunc(getoption(ls))ps=%sysfunc(getoption(ps))
+     %sysfunc(getoption(notes)) %sysfunc(getoption(source))
+     msglevel=%sysfunc(getoption(msglevel)) 
+     %sysfunc(getoption(mprint)) %sysfunc(getoption(mlogic)) %sysfunc(getoption(symbolgen))
+    ;
+    options NOnotes NOsource ls=MAX ps=MAX msglevel=N NOmprint NOmlogic NOsymbolgen;
+    %put ;
+    %put #################################################################################;
+    %put ###   This is short help information for the `SasPackagesFrameworkNotes` macro  #;
+    %put #-------------------------------------------------------------------------------#;
+    %put #                                                                               #;
+    %put # Macro prints help notes for SAS Packages Framework macros, version `20251221` #;
+    %put #                                                                               #;
+    %put # A SAS package is a zip file containing a group                                #;
+    %put # of SAS codes (macros, functions, data steps generating                        #;
+    %put # data, etc.) wrapped up together and included by                               #;
+    %put # a single `load.sas` file (also embedded inside the zip).                      #;
+    %put #                                                                               #;
+    %put # The `%nrstr(%%SasPackagesFrameworkNotes())` macro provides help notes about          #;
+    %put # components of the SAS Packages Framework.                                     #;
+    %put #                                                                               #;
+    %put #-------------------------------------------------------------------------------#;
+    %put #### Parameters:                                                                #;
+    %put #                                                                               #;
+    %put # 1. `SPFmacroName`     *Required.* Names of a SPF components.                  #;
+    %put #                       Names should be space separated, asterisk(*) is         #;
+    %put #                       allowed too. In such case ALL help notes are printed    #;
+    %put #                       If equal `HELP` displays this help information.         #;
+    %put #                       If empty displays list of SPF macros.                   #;
+    %put #                                                                               #;
+    %put #-------------------------------------------------------------------------------#;
+    %put #                                                                               #;
+    %put # Visit: `https://github.com/yabwon/SAS_PACKAGES/tree/main/SPF/Documentation`   #;
+    %put # to learn more.                                                                #;
+    %put # Tutorials available at: `https://github.com/yabwon/HoW-SASPackages`           #;
+    %put #                                                                               #;
+    %put ### Example 1 ###################################################################;
+    %put #                                                                               #;
+    %put #   Run the following code to print all SPF help notes:                         #;
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas;
+    %put  %nrstr( %%SasPackagesFrameworkNotes(*)       %%* print ALL notes;               );
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~;
+    %put #                                                                               #;
+    %put ### Example 2 ###################################################################;
+    %put #                                                                               #;
+    %put #   Run the following code to list all SPF macros:                              #;
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas;
+    %put  %nrstr( %%SasPackagesFrameworkNotes()        %%* list all macro names;          );
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~;
+    %put #                                                                               #;
+    %put ### Example 3 ###################################################################;
+    %put #                                                                               #;
+    %put #   Run the following code to print help notes:                                 #;
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas;
+    %put  %nrstr( %%SasPackagesFrameworkNotes(generatePackage helpPackage)                );
+    %put ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~;
+    %put #                                                                               #;
+    %put #################################################################################;
+    %put ;
+    options &options_tmp.;
+    %GOTO ENDofSPFNotes;
+  %end;
+
+%if %sysevalf(%superq(SPFmacroName)=,boolean) %then
+  %do;
+    %put ================================================================;
+    %put %str( ) SAS Packages Framework provides the following macros:;
+    %put ================================================================;
+    %do i = 1 %to &N.;
+      %let element = %scan(&list., &i.);
+      %if &i. IN (3 6 9 10 12) %then %put %str( );
+      %if &i. > 9 %then %put %str( )&i.. %NRSTR(%%)&element.();
+                  %else %put %str(  )&i.. %NRSTR(%%)&element.();
+    %end;
+    %put =================================================================;
+  %end;
+%else %if %str(*) IN (%superq(SPFmacroName)) %then
+  %do;
+    %do i = 1 %to &N.;
+      %let element = %scan(&list., &i.);
+      %put %str( );
+      %put ======;
+      %&element.(HELP)
+      %put ======;
+    %end;
+  %end;
+%else
+  %do;
+    %let N = %sysfunc(countw(%superq(SPFmacroName)));
+    %do i = 1 %to &N.;
+      %let element = %qupcase(%scan(%superq(SPFmacroName), &i.));
+      %if %superq(element) in (%upcase(&LIST.)) %then
+        %do;
+          %let element = %unquote(&element.);
+          %put %str( );
+          %put ======;
+          %&element.(HELP);
+          %put ======;
+        %end;
+      %else 
+        %do;
+          %put %str( );
+          %put ***!***!***!***!***!***!***!***!***!***!***!***!***!***!***!***!***!***!***!***;
+          %put WARNING: Cannot recognise name: %superq(element).;
+          %put WARNING- Valid values are: %superq(list);
+          %put ***!***!***!***!***!***!***!***!***!***!***!***!***!***!***!***!***!***!***!***;
+        %end;
+    %end;
+  %end;
+
+%ENDofSPFNotes:
+%mend SasPackagesFrameworkNotes;
+
+/*
+%SasPackagesFrameworkNotes()
+%SasPackagesFrameworkNotes(HELP)
+options mlogic symbolgen;
+%SasPackagesFrameworkNotes(generatePackage)
+%SasPackagesFrameworkNotes(generatePackage helpPackage)
+%SasPackagesFrameworkNotes(generatePackage helpPackages SasPackagesFrameworkNotes isPackagesFilerefOK)
+%SasPackagesFrameworkNotes(*)
+*/
+
+
+/* end of SPFinit.sas file */ 

SPF/Macros/splitcodeforpackage.sas

@@ -7,10 +7,9 @@
 ,debug=0           /* technical parameter  */
 ,nobs=0            /* technical parameter  */
 )
-/*** HELP START ***/
-/ des = 'Utility macro to split "one big" code into multiple files for a SAS package, version 20251122. Run %splitCodeForPackage() for help info.'
+/*** HELP END ***/
+/ des = 'Utility macro to split "one big" code into multiple files for a SAS package, version 20251221. Run %splitCodeForPackage() for help info.'
 ;
-/*%macro _();%mend _;*/
 %if (%superq(codeFile) = ) OR (%qupcase(&codeFile.) = HELP) %then
   %do;
     %local options_tmp ;
@@ -25,7 +24,7 @@
     %put #-------------------------------------------------------------------------------#;
     %put #                                                                               #;
     %put # Utility macro to *split* single file with SAS package code into multiple      #;
-    %put # files with separate snippets, version `20251122`                              #;
+    %put # files with separate snippets, version `20251221`                              #;
     %put #                                                                               #;
     %put # A SAS package is a zip file containing a group                                #;
     %put # of SAS codes (macros, functions, data steps generating                        #;
@@ -49,7 +48,7 @@
     %put #                                                                               #;
     %put # - `packagePath=`      *Required.* Location for package files after            #;
     %put #                        splitting into separate files and directories.         #;
-    %put #                        If missing or not exist then `WORK` is uded.           #;
+    %put #                        If missing or not exist then `WORK` is used.           #;
     %put #                                                                               #;
     %put # - `debug=`            *Optional.* Turns on code printing for debugging.       #;
     %put #                                                                               #;
@@ -401,7 +400,7 @@ options nomprint nosymbolgen nomlogic notes source ls=MAX ps=MAX msglevel=N ;
             */
             if firstLine[j] then
               do;
-                put '/* File generated with help of SAS Packages Framework, version 20251122. */';
+                put '/* File generated with help of SAS Packages Framework, version 20251221. */';
                 firstLine[j]=0;
               end; 
             put _infile_;
@@ -417,4 +416,3 @@ options &options_tmp2.;
 %ENDofsplitCodeForPackage:
 %mend splitCodeForPackage;
 
-/**/

SPF/Macros/unloadpackage.sas

@@ -20,7 +20,7 @@
                                        */
 )/secure
 /*** HELP END ***/
-des = 'Macro to unload SAS package, version 20251122. Run %unloadPackage() for help info.'
+des = 'Macro to unload SAS package, version 20251221. Run %unloadPackage() for help info.'
 ;
 %if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
   %do;
@@ -35,7 +35,7 @@ des = 'Macro to unload SAS package, version 20251122. Run %unloadPackage() for h
     %put ###      This is short help information for the `unloadPackage` macro           #;
     %put #-------------------------------------------------------------------------------#;
     %put #                                                                               #;
-    %put # Macro to unload SAS packages, version `20251122`                              #;
+    %put # Macro to unload SAS packages, version `20251221`                              #;
     %put #                                                                               #;
     %put # A SAS package is a zip file containing a group                                #;
     %put # of SAS codes (macros, functions, data steps generating                        #;

SPF/Macros/verifypackage.sas

@@ -13,7 +13,7 @@
                                          hashing_file() function, SAS 9.4M6 */
 )/secure 
 /*** HELP END ***/
-des = 'Macro to verify SAS package with the hash digest, version 20251122. Run %verifyPackage() for help info.'
+des = 'Macro to verify SAS package with the hash digest, version 20251221. Run %verifyPackage() for help info.'
 ;
 %if (%superq(packageName) = ) OR (%qupcase(&packageName.) = HELP) %then
   %do;
@@ -28,7 +28,7 @@ des = 'Macro to verify SAS package with the hash digest, version 20251122. Run %
     %put ###      This is short help information for the `verifyPackage` macro           #;
     %put #-------------------------------------------------------------------------------#;
     %put #                                                                               #;
-    %put # Macro to verify SAS package with it hash digest, version `20251122`           #;
+    %put # Macro to verify SAS package with it hash digest, version `20251221`           #;
     %put #                                                                               #;
     %put # A SAS package is a zip file containing a group                                #;
     %put # of SAS codes (macros, functions, data steps generating                        #;

SPF/SPFinit.md

@@ -1,7 +1,7 @@
 
 ---
 
-# SAS Packages Framework, version `20251122`
+# SAS Packages Framework, version `20251221`
 
 ---
 
@@ -18,6 +18,9 @@
   * [the `extendPackagesFileref` macro](#extendpackagesfileref)
   * [the `loadPackageAddCnt` macro](#loadpackageaddcnt)
   * [the `splitCodeForPackage` macro](#splitcodeforpackage)
+  * [the `relocatePackage` macro](#relocatepackage)
+  * [the `isPackagesFilerefOK` macro](#ispackagesfilerefok)
+  * [the `SasPackagesFrameworkNotes` macro](#saspackagesframeworknotes)
   * [Some more examples](#some-more-examples)
 
 --------------------------------------------------------------------------------------------
@@ -29,7 +32,7 @@ A **SAS package** is an automatically generated, single, stand alone *zip* file
 
 The *purpose of a package* is to be a simple, and easy to access, code sharing medium, which will allow: on the one hand, to separate the code complex dependencies created by the developer from the user experience with the final product and, on the other hand, reduce developer's and user's unnecessary frustration related to a remote deployment process.
 
-In this repository we are presenting the **SAS Packages Framework** which allows to develop and use SAS packages. The latest version of SPF is **`20251122`**.
+In this repository we are presenting the **SAS Packages Framework** which allows to develop and use SAS packages. The latest version of SPF is **`20251221`**.
 
 **To get started with SAS Packages** try this [**`Introduction to SAS Packages`**](https://youtube.com/playlist?list=PLeMzGEImIT5eV13IGXQIgWmTFCJt_cLZG&si=ElQm0_ifq76mvUbq "Introduction to SAS Packages video series") video series or [**`Getting Started with SAS Packages`**](https://github.com/yabwon/SAS_PACKAGES/blob/main/SPF/Documentation/Getting_Started_with_SAS_Packages.pdf "Getting Started with SAS Packages") presentation (see the `./SPF/Documentation` directory).
 
@@ -52,7 +55,7 @@ them using the SPF can be found [**HERE**](https://github.com/yabwon/HoW-SASPack
 ##       This is short help information for the `installPackage` macro <a name="installpackage"></a>
 --------------------------------------------------------------------------------------------
 
- Macro to install SAS packages, version `20251122`
+ Macro to install SAS packages, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
@@ -180,7 +183,7 @@ filename packages "C:/SAS_PACKAGES";
 ##       This is short help information for the `helpPackage` macro <a name="helppackage"></a>
 -------------------------------------------------------------------------------
 
- Macro to get help about SAS packages, version `20251122`
+ Macro to get help about SAS packages, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
@@ -258,7 +261,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
 ##      This is short help information for the `loadPackage` macro <a name="loadpackage"></a>
 -------------------------------------------------------------------------------
 
- Macro to *load* SAS packages, version `20251122`
+ Macro to *load* SAS packages, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
@@ -416,7 +419,7 @@ If created, those macros are automatically deleted when the `%unloadPackage()` m
 ##      This is short help information for the `loadPackageS` macro <a name="loadpackages"></a>
 -------------------------------------------------------------------------------
 
- Macro wrapper for the loadPackage macro, version `20251122`
+ Macro wrapper for the loadPackage macro, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
@@ -459,7 +462,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
 %include packages(SPFinit.sas);      %* enable the framework;
 
 %installPackage(SQLinDS DFA)   %* install packages from the Internet;
-%loadPackageS(SQLinDS, DFA)    %* load packags content into the SAS session;
+%loadPackageS(SQLinDS, DFA)    %* load packages content into the SAS session;
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
@@ -467,7 +470,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
 ##      This is short help information for the `unloadPackage` macro <a name="unloadpackage"></a>
 -------------------------------------------------------------------------------
 
- Macro to unload SAS packages, version `20251122`
+ Macro to unload SAS packages, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
@@ -534,14 +537,14 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
 ##       This is short help information for the `listPackages` macro <a name="listpackages"></a>
 -----------------------------------------------------------------------------------------
 
- Macro to list available SAS packages, version `20251122`
+ Macro to list available SAS packages, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
  data, etc.) wrapped up together and embedded inside the zip.
 
  The `%listPackages()` macro lists packages available
- in the packages folder. List is printed inthe SAS Log.
+ in the packages folder. List is printed in the SAS Log.
 
 ### Parameters:
 
@@ -577,7 +580,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
 ##      This is short help information for the `verifyPackage` macro <a name="verifypackage"></a>
 -------------------------------------------------------------------------------
 
- Macro to verify SAS package with it hash digest, version `20251122`
+ Macro to verify SAS package with it hash digest, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
@@ -631,7 +634,7 @@ filename packages "C:/SAS_PACKAGES"; %* set-up a directory for packages;
 ##    This is short help information for the `previewPackage` macro <a name="previewpackage"></a>
 -------------------------------------------------------------------------------
 
- Macro to get preview of a SAS packages, version `20251122`
+ Macro to get preview of a SAS packages, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
@@ -700,7 +703,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
 ##      This is short help information for the `generatePackage` macro <a name="generatepackage"></a>
 -------------------------------------------------------------------------------
 
- Macro to generate SAS packages, version `20251122`
+ Macro to generate SAS packages, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
@@ -927,14 +930,14 @@ All files have to have `.sas` extension. Other files are ignored.
 ##      This is short help information for the `extendPackagesFileref` macro <a name="extendpackagesfileref"></a>
 -----------------------------------------------------------------------------------------
 
- Macro to list directories pointed by 'packages' fileref, version `20251122`
+ Macro to list directories pointed by 'packages' fileref, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
  data, etc.) wrapped up together and embedded inside the zip.
 
  The `%extendPackagesFileref()` macro lists directories pointed by
- the packages fileref. It allows to add new dierctories to packages folder list.
+ the packages fileref. It allows to add new directories to packages folder list.
 
 ### Parameters:
 
@@ -969,7 +972,7 @@ filename packages ("D:/NEW_DIR" %extendPackagesFileref()); %* add new directory;
 ##      This is short help information for the `loadPackageAddCnt` macro <a name="loadpackageaddcnt"></a>
 -------------------------------------------------------------------------------
 
- Macro to load *additional content* for a SAS package, version `20251122`
+ Macro to load *additional content* for a SAS package, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
@@ -1063,7 +1066,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
 -------------------------------------------------------------------------------
 
  Utility macro to *split* single file with SAS package code into multiple
- files with separate snippets, version `20251122`
+ files with separate snippets, version `20251221`
 
  A SAS package is a zip file containing a group
  of SAS codes (macros, functions, data steps generating
@@ -1087,7 +1090,7 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
 
  - `packagePath=`      *Required.* Location for package files after
                         splitting into separate files and directories.
-                        If missing or not exist then `WORK` is uded.
+                        If missing or not exist then `WORK` is used.
 
  - `debug=`            *Optional.* Turns on code printing for debugging.
 
@@ -1141,6 +1144,220 @@ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
   ,packagePath=C:/split/ )
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+##      This is short help information for the `relocatePackage` macro <a name="relocatepackage"></a>
+-------------------------------------------------------------------------------
+
+ Macro to *locally copy or move* (relocate) SAS packages, version `20251221`
+
+ A SAS package is a zip file containing a group
+ of SAS codes (macros, functions, data steps generating
+ data, etc.) wrapped up together and included by
+ a single `load.sas` file (also embedded inside the zip).
+
+ The `%relocatePackage()` is a utility macro for local copying or moving
+ SAS packages. The macro transfers packages located in the `PACKAGES`
+ fileref to a selected directory (`DISK` device), folderpath (`FILESRVC`
+ device), or a zip file (`ZIP` device).
+
+ The macro allows for a bidirectional transfer of packages, i.e., from the
+ `PACKAGES` fileref to the selected *target*, or from the selected *source*
+ to the `PACKAGES` fileref.
+
+-------------------------------------------------------------------------------
+### Parameters:
+
+ 1. `packageName`      *Required.* Name of a package, e.g. myPackage.
+                       A space-separated(!) list of packages to transfer is
+                       also accepted. If empty displays this help information.
+
+ - `source=`           *Required/Optional.* Source location for packages.
+                       When used, indicates a directory (`DISK` device),
+                       a folderpath (`FILESRVC` device), or a zip file (`ZIP`
+                       device) *from* where packages will be copied.
+                       In this case `PACKAGES` fileref is target location.
+                       Cannot be used together with `target=` parameter.
+
+ - `target=`           *Required/Optional.* Target location for packages.
+                       When used, indicates a directory (`DISK` device),
+                       a folderpath (`FILESRVC` device), or a zip file (`ZIP`
+                       device) *to* where packages will be copied.
+                       In this case `PACKAGES` fileref is source location.
+                       Cannot be used together with `source=` parameter.
+
+ - `sDevice=`          *Required/Optional.* When `source=` is used this
+                       parameter provides which type of device to be use.
+                       Default value is `DISK`, values `ZIP` and `FILESRVC`
+                       are allowed. For `FILESRVC` the `folderpath=` is used.
+
+ - `tDevice=`          *Required/Optional.* When `target=` is used this
+                       parameter provides which type of device to be use.
+                       Default value is `DISK`, values `ZIP` and `FILESRVC`
+                       are allowed. For `FILESRVC` the `folderpath=` is used.
+
+ - `checksum=`         *Optional.* Indicates if packages should be copied only
+                       if the source (from file) checksum is different than
+                       the target (to file). Default value is 0 (always copy).
+
+ - `move=`             *Optional.* Indicates if packages should be moved from
+                       source to target, default value is `0`,
+                       when set to `1`: after *successful* copying packages
+                       in the source are *deleted*. Use carefully!
+
+ - `debug=`            *Optional.* Indicates if debug notes should be printed,
+                       default value is `0`, when set to `1`: debug info
+                       is printed.
+
+ - `try=`              *Optional.* Number of tries when copy is unsuccessful,
+                       default value is `3`, allowed values are integers
+                       from 1 to 9. Time between tries is quarter of a second.
+
+-------------------------------------------------------------------------------
+
+ Visit: `https://github.com/yabwon/SAS_PACKAGES/tree/main/SPF/Documentation`
+ to learn more.
+ Tutorials available at: `https://github.com/yabwon/HoW-SASPackages`
+
+### Example 1 ##################################################################
+
+   Enabling the SAS Package Framework from the local
+   directory, copying SQLinDS package from Viya Files
+   service, and loading the package to the SAS session.
+
+   Assume that the `SPFinit.sas` file is located in the "/home/user/PCKG"
+   directory and Viya Files service location is "/files/packages/"
+
+   Run the following code in your SAS session:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+ filename packages "/home/user/PCKG"; %* setup a directory for packages;
+ %include packages(SPFinit.sas);      %* enable the framework;
+
+ %relocatePackage(SQLinDS  %* copy the package from Viya Files service;
+                 ,source=/files/packages/
+                 ,sDevice=FILESRVC)
+ %loadPackage(SQLinDS)   %* load the package content into the SAS session;
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+### Example 2 ##################################################################
+
+   Enabling the SAS Package Framework from the local directory
+   and creating a "bundle" file by moving 3 packages: the BasePlus,
+   the SQLinDS, and the MacroArray package into the target file.
+
+   Assume that the `SPFinit.sas` file
+   is located in the "C:/SAS_PACKAGES/" folder.
+
+   Run the following code in your SAS session:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+ filename packages "C:/SAS_PACKAGES"; %* setup a directory for packages;
+ %include packages(SPFinit.sas);      %* enable the framework;
+
+ %relocatePackage(BasePlus SQLinDS MacroArray %* create a bundle of packages;
+                 ,target=D:/archive/bundle_2025_12_15.zip
+                 ,tDevice=ZIP, move=1)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+##       This is short help information for the `isPackagesFilerefOK` macro <a name="ispackagesfilerefok"></a>
+-----------------------------------------------------------------------------------------
+
+ Macro to check if the `packages` fileref is "correct", version `20251221`
+
+ A SAS package is a zip file containing a group
+ of SAS codes (macros, functions, data steps generating
+ data, etc.) wrapped up together and embedded inside the zip.
+
+ The `%isPackagesFilerefOK()` macro checks if the `packages` fileref
+ is correct, i.e. all listed directories exist, are accessible (can be open), and
+ are assigned with the DISK device.
+
+ The Macro works as a macro function. It returns `1` when everything is OK, and
+ it returns `0` if at least one issue exists.
+
+### Parameters:
+
+ 1. `vERRb`  - *Optional* Indicates if the macro should return value AND be verbose
+               (e.g., print errors and notes) or just return value.
+
+ When used as: `%isPackagesFilerefOK(HELP)` it displays this help information.
+
+-----------------------------------------------------------------------------------------
+
+ Visit: `https://github.com/yabwon/SAS_PACKAGES/tree/main/SPF/Documentation`
+ to learn more.
+ Tutorials available at: `https://github.com/yabwon/HoW-SASPackages`
+
+### Example #############################################################################
+
+   Enabling the SAS Package Framework from the local
+   directory, expanding PACKAGES fileref, and checking
+   if the new one is still correct for installing new package.
+
+   Assume that the `SPFinit.sas` file
+   is located in the "/sas/PACKAGES/" directory.
+
+   Run the following code in your SAS session:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+ filename packages "/sas/PACKAGES";                        %* set packages filename;
+ %include packages(SPFinit.sas);                           %* enable the framework;
+
+ filename packages ("~/myPCKGs" %extendPackagesFileref()); %* add new directory;
+
+ %if %IsPackagesFilerefOK() %then                          %* check fileref;
+   %do; %InstallPackage(SQLinDS) %end;                     %* install SQLinDS;
+
+ %listPackages()                                           %* list packages;
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+##   This is short help information for the `SasPackagesFrameworkNotes` macro <a name="saspackagesframeworknotes"></a>
+-------------------------------------------------------------------------------
+
+ Macro prints help notes for SAS Packages Framework macros, version `20251221`
+
+ A SAS package is a zip file containing a group
+ of SAS codes (macros, functions, data steps generating
+ data, etc.) wrapped up together and included by
+ a single `load.sas` file (also embedded inside the zip).
+
+ The `%SasPackagesFrameworkNotes()` macro provides help notes about
+ components of the SAS Packages Framework.
+
+-------------------------------------------------------------------------------
+### Parameters:
+
+ 1. `SPFmacroName`     *Required.* Names of a SPF components.
+                       Names should be space separated, asterisk(*) is
+                       allowed too. In such case ALL help notes are printed
+                       If equal `HELP` displays this help information.
+                       If empty displays list of SPF macros.
+
+-------------------------------------------------------------------------------
+
+ Visit: `https://github.com/yabwon/SAS_PACKAGES/tree/main/SPF/Documentation`
+ to learn more.
+ Tutorials available at: `https://github.com/yabwon/HoW-SASPackages`
+
+### Example 1 ##################################################################
+
+   Run the following code to print all SPF help notes:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+ %SasPackagesFrameworkNotes(*)       %* print ALL notes;
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+### Example 2 ##################################################################
+
+   Run the following code to list all SPF macros:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+ %SasPackagesFrameworkNotes()        %* list all macro names;
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+### Example 3 ##################################################################
+
+   Run the following code to print help notes:
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~sas
+ %SasPackagesFrameworkNotes(generatePackage helpPackage)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+
 
 -------------------------------------------------------------------------------
 -------------------------------------------------------------------------------

SPF/license.sas

@@ -1,4 +1,4 @@
-Copyright (c) 2019 - 2025 Bartosz Jablonski 
+Copyright (c) 2019 - 2026 Bartosz Jablonski 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal