Skip to content

[PowerShell] Fix upload logs name #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VismaAlbertoInfante merged 3 commits into from
Mar 26, 2024
Merged

[PowerShell] Fix upload logs name #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c3d90e
[PowerShell] Fix upload log name
VismaAlbertoInfante Mar 26, 2024
575f920
[PowerShell] Increase version
VismaAlbertoInfante Mar 26, 2024
53d94aa
[PowerShell] Update Release-Notes.md
VismaAlbertoInfante Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 24 additions & 19 deletions powershell/Release-Notes/Release-Notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# PowerShell update 2024-03 version 1.24

Fix an issue where the upload examples were creating the log files with a wrong name.

# PowerShell update 2024-03 version 1.23
1. Include the monitor file in the Upload examples (it was already in place in the Download examples).

1. Include the monitor file in the upload examples (it was already in place in the download examples).
2. Ensure the removal of all the temporary files created by the examples.
3. Fix a bug where the amount of files to upload was shown incorrectly when only one file was available to upload.
3. Fix an issue where the amount of files to upload was shown incorrectly when only one file was available to upload.

The monitor file is a single file that will contain the minimum of records needed to determine if the script runs successfully and errors can be easily detected.
This file is suitable for checking regularly by an automated error checking process.
Expand All @@ -19,14 +24,14 @@ Fix an issue when the logger configuration is invalid, the script finishes the e

# PowerShell update 2023-08

New functionality and improvements in Powershell Examples
New functionality and improvements in PowerShell Examples.

1. Support for logfiles
2. Upload by chunks extends upload filesize limit from 100MB to 10GB
3. Download by chunks extends download filesize limit from 2GB to 10GB
4. Improved reliability
5. Added default Proxy settings detection
6. Added comments
1. Support for logfiles.
2. Upload by chunks extends upload file size limit from 100 MB to 10 GB.
3. Download by chunks extends download file size limit from 2 GB to 10 GB.
4. Improved reliability.
5. Added default Proxy settings detection.
6. Added comments.


## Configure logs in upload and download examples
Expand All @@ -37,8 +42,8 @@ A new section has been added in the configuration of the examples to configure t

Please follow the steps below to activate the logs:

1. Download the latest version of Powershell examples [here](https://github.com/VR-API-Integration/file-api-integration-examples)
2. Edit the configuration settings: **'Logs'** - **'Enabled'** with the value **'true'**
1. Download the latest version of Powershell examples [here](https://github.com/VR-API-Integration/file-api-integration-examples).
2. Edit the configuration settings: **'Logs'** - **'Enabled'** with the value **'true'**.
3. Edit the configuration settings: **'Logs'** - **'Path'** with the local folder where to store the detailed logs.
4. Edit the configuration settings: **'Logs'** - **'MonitorFile'** with the filename where you want to store the monitor logs. The MonitorFile is stored along the detailed logs.

Expand All @@ -60,27 +65,27 @@ Recommended chunk size for uploads is 4MB.

Please follow the steps below to upload files by chunks:

1. Download the last version of PowerShell examples [here](https://github.com/VR-API-Integration/file-api-integration-examples)
2. Edit the configuration settings: **'Upload'** - **'ChunkSize'** with the value **'4'**
1. Download the last version of PowerShell examples [here](https://github.com/VR-API-Integration/file-api-integration-examples).
2. Edit the configuration settings: **'Upload'** - **'ChunkSize'** with the value **'4'**.

![Upload ChunkSize](images/imageChunks.png)

See additional details in the [Readme](https://github.com/VR-API-Integration/file-api-integration-examples/blob/main/powershell/upload/README.md) of powershell upload example
See additional details in the [Readme](https://github.com/VR-API-Integration/file-api-integration-examples/blob/main/powershell/upload/README.md) of powershell upload example.


## Improve the download example to download files by chunks

Improvements have been made in the download example to download files by chunks.
With this new functionality, the file size limit for downloading files has been extended from 2GB to 10GB.
With this new functionality, the file size limit for downloading files has been extended from 2 GB to 10 GB.
A new field (`<ChunkSize>`) has been added in the configuration of the example to define the chunk size (MB).
Recommended chunk size for downloads is 100MB
Recommended chunk size for downloads is 100 MB

Please follow the below steps to download the files by chunks:

1. Download the last version of PowerShell examples [here](https://github.com/VR-API-Integration/file-api-integration-examples)
2. Edit the configuration settings: **'Download'** - **'ChunkSize'** with the value **'100'**
1. Download the last version of PowerShell examples [here](https://github.com/VR-API-Integration/file-api-integration-examples) .
2. Edit the configuration settings: **'Download'** - **'ChunkSize'** with the value **'100'**.

See additional details in the [Readme](https://github.com/VR-API-Integration/file-api-integration-examples/blob/main/powershell/download/README.md) of the powershell example
See additional details in the [Readme](https://github.com/VR-API-Integration/file-api-integration-examples/blob/main/powershell/download/README.md) of the powershell example.

## Reliability

Expand Down
2 changes: 1 addition & 1 deletion powershell/download/DownloadFiles.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Param(

$ErrorActionPreference = "Stop"
$scriptMajorVersion = 1
$scriptMinorVersion = 23
$scriptMinorVersion = 24

# The default value of this parameter is set here because $PSScriptRoot is empty if used directly in Param() through PowerShell ISE.
if (-not $_configPath) {
Expand Down
4 changes: 2 additions & 2 deletions powershell/upload/UploadFile.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Param(

$ErrorActionPreference = "Stop"
$scriptMajorVersion = 1
$scriptMinorVersion = 23
$scriptMinorVersion = 24

# The default value of this parameter is set here because $PSScriptRoot is empty if used directly in Param() through PowerShell ISE.
if (-not $_configPath) {
Expand Down Expand Up @@ -710,7 +710,7 @@ Logger([bool] $storeLogs, [string] $logsDirectory, [string] $monFile, [string] $

if ($this._storeLogs) {
# detailed log file created per day
$this._logPath = Join-Path $logsDirectory "download log - $(Get-Date -Format "yyyy-MM-dd").txt"
$this._logPath = Join-Path $logsDirectory "upload log - $(Get-Date -Format "yyyy-MM-dd").txt"
# only 1 monitor file created
$this._monPath = Join-Path $logsDirectory $monFile
# signals a download or upload record (easy if you use the same the Monitor File for both upload and download)
Expand Down