### Start All Job Schedulers Results (JSON) Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750603/CLI%2BJob%2BSchedulers Example JSON output indicating the total count of job schedulers started. ```json [ { "total_count": "3" } ] ``` -------------------------------- ### Install DryvIQ .NET New Template Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391815718 Installs the custom DryvIQ dotnet new template package. Use this command to get started with creating new extensions. ```bash dotnet new --install PortalArchitects.CustomExtension.Templates ``` -------------------------------- ### Start All Job Schedulers Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750603/CLI%2BJob%2BSchedulers Starts all available job schedulers. Authentication parameters must be configured. ```bash skysync-cli schedulers start --all ``` -------------------------------- ### Example Transfer Configuration with Metadata Mapping Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3394764871/Metadata%2BMapping%2BUsing%2BREST%2BAPI A complete JSON example demonstrating a transfer configuration including metadata mapping. ```json { "name": "Box -> Sharepoint (Metadata)", "kind":"transfer", "transfer":{ "transfer_type": "copy", "source": { "connection": { "id": "36405b306fe84df69d55e007ed27967e" }, "target": { "path": "/Source" } }, "destination": { "connection": { "id": "92edba5e132645dda035580bfb14a063" }, "target": { "path": "/Metadata Test/Destination" } }, "audit_level": "trace", "performance": { "parallel_writes": { "requested": 2 } }, "metadata_map": { "schemas": [ { "mappings": [ { "source": { "property": { "name": "Text" } }, "destination": { "property": { "name": "Caption" } } }] }] } }, "schedule":{ "mode":"manual" } } ``` -------------------------------- ### Start All Jobs Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3394764978/Starting%2Band%2BPause%2BMultiple%2BJobs%2BUsing%2BREST%2BAPI Use this endpoint to start all available jobs. Ensure the base URL is correctly configured. ```HTTP PATCH {{url}}v1/jobs?start ``` -------------------------------- ### Activate New License Key with Sample Value (CLI) Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750649/CLI%2BLicensing Example of activating a license key using a sample value. Ensure authentication parameters are configured. ```bash skysync-cli license activate 123 ``` -------------------------------- ### Create Solution and Add Projects Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391815718 Creates a new .NET solution file and adds the generated extension and test projects to it. This workaround addresses a tooling limitation. ```bash cd MyCustomExtension dotnet new solution dotnet sln add src\MyCustomExtension\MyCustomExtension.csproj dotnet sln add test\MyCustomExtension.Tests\MyCustomExtension.Tests.csproj ``` -------------------------------- ### Start Date Option Example Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3394764946/Scheduling%2Ba%2BJob%2BUsing%2BREST%2BAPI Example of setting the 'start_date' option using a Unix/Epoch timestamp. ```json "start_date": "1523025357", ``` -------------------------------- ### Setting Configuration via Command-Line Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3389816833 Demonstrates how to set configuration variables using the command-line interface with the --settingname=value format. ```bash --settingname=value ``` -------------------------------- ### Show Connection Details (with example ID) Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750411/CLI%2BConnections An example of showing connection details using a specific connection ID. This command retrieves and displays all information associated with the provided ID. ```bash skysync-cli connections show 5dc531df34554edd96c31272262ad950 ``` -------------------------------- ### Start Filtered Job Schedulers Results (JSON) Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750603/CLI%2BJob%2BSchedulers Example JSON output showing the count of job schedulers started after filtering. ```json [ { "total_count": "1" } ] ``` -------------------------------- ### Start Window Option Example Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3394764946/Scheduling%2Ba%2BJob%2BUsing%2BREST%2BAPI Example of setting the 'start_window' option with hour, minute, second, and millisecond values. This option cannot be used with 'run_at'. ```json "start_window": { "hr": 8, "min": 0, "sec": 0, "ms": 0 } ``` -------------------------------- ### Show Connection Example Results (Text) Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750411/CLI%2BConnections This is the expected text output when successfully showing the details of a connection. It includes ID, Name, Platform, Account, and Enabled status. ```text ID 5dc531df34554edd96c31272262ad950 Name My Computer Platform My Computer Account Enabled true ``` -------------------------------- ### Show Platform Details (with example ID) Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750411/CLI%2BConnections An example of showing platform details using a specific platform ID, 'nfs'. This command retrieves and displays information about the Network File System platform. ```bash skysync-cli connections platforms nfs ``` -------------------------------- ### Example 1: Defined Days with Start and End Windows Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3394764946/Scheduling%2Ba%2BJob%2BUsing%2BREST%2BAPI Schedules a job to run on weekends, ending on a specific date, with defined start and end time windows for execution. ```json "schedule": { "mode": "auto", "days": "weekends", "end_date": "1523025357", "start_window": { "hr": 8, "min": 0, "sec": 0, "ms": 0 }, "end_window": { "hr": 20, "min": 0, "sec": 0, "ms": 0 } } ``` -------------------------------- ### Create a Profile with Description, Instructions, and Templates Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750712/CLI%2BProfiles Creates a profile including optional description, instructions, and associated job templates. Ensure job template IDs and kinds are correctly specified. ```bash skysync-cli profiles add {{name}} --description {{profile description}} --instructions {{profile instructions}} --templates {{profile templates}} ``` ```bash skysync-cli profiles add "Example Profile 1" --description "An example pofile" --instructions "Example profiles instructions...do things" --templates 382d78ab17784b6bb14844ba1ea819bc ``` -------------------------------- ### GET System Information Response Example Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3394765835/Performance%2BCounter%2BMetrics%2BUsing%2BREST%2BAPI This JSON object represents a typical response from the GET {{url}}v1/diagnostics/system API endpoint, providing details about the application, system, processes, and job/connection statistics. ```json { "status": 200, "item": { "app_product_version": "4.6.5.0", "app_build_version": "4.6.5 Commit Hash: 897208b845f02ad2a17bb04581f95d950c84e5c8", "system_platform": "linux", "system_time_zone": "UTC", "system_runtime_description": ".NET Core 4.6.26725.06", "system_os_architecture": "x64", "system_os_description": "Linux 4.14.62-70.117.amzn2.x86_64 #1 SMP Fri Aug 10 20:14:53 UTC 2018", "system_os_version": "4.14.62.70", "system_cpu_count": 2, "system_cpu_architecture": "x64", "process_memory_size": 529461248, "process_dot_net_gen_size": 237947768, "bytes_under_management": 36983021614, "bytes_under_management_by_job": [ { "job_id": 6, "bytes": 367364 }, { "job_id": 7, "bytes": 4610 }, ........ ........... ............. "jobs_count": 80, "jobs": [ { "source_platform": "box", "destination_platform": "box", "transfer_type": "copy", "count": 3 }, { "source_platform": "box", "destination_platform": "dfb", "transfer_type": "copy", "count": 1 }, ......... ............ ............... "nodes_count": 1, "connections_count": 11, "connections": [ { "platform": "box", "count": 2 }, { "platform": "dfb", "count": 3 }, ......... ............ ............... "license_key": "bbbbbbb-0000-0000-0000-cc9a375813ea", "license_uuid_activation": "BBBD5A0FFFFA4B10A2FCBAB0CCCCCCC" } } ``` -------------------------------- ### Schedule a Job to Run on a Specific Date and Time Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/history/3394764946 Use 'start_date' and 'start_window' to define a specific start point for a scheduled job. This example sets the start date to April 6, 2018, at 2:35 PM GMT. ```json "schedule": { "mode": "auto", "start_date": "1523025357", "start_window": { "hr": 8, "min": 0, "sec": 0, "ms": 0 } } ``` -------------------------------- ### Full appSettings.json Example with Multiple Options Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/history/3389816833 This example shows the 'performance:concurrent_transfers' setting within a more comprehensive appSettings.json file. Ensure DryvIQ services are restarted after modifications. ```json { "data": { "provider": "sqlserver", "connection": "Server=server_location;Database=database_name;User ID=sa;Password=passW@rd!;", ``` ```json "embedded": "false", "native_encryption": "false" }, "performance": { "parallel_writes": {"requested" : 6}, "concurrent_transfers": 10 } } ``` -------------------------------- ### Export URL with Limit and Offset Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3972628486/Exporting%2BLarge%2BData%2BSets%2Bin%2BChunks Example of an export URL modified to include limit and offset parameters for exporting a specific number of records starting from a certain point. ```URL https://app.dryviq.io/v1/transfers/items.csv?job_categories=9&simulation_mode=0&active=1&Limit=900000&offset=0 ``` -------------------------------- ### Full Job Creation Block with All Schedule Options Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/history/3394764946 This comprehensive example demonstrates a complete job creation JSON block, including all available schedule options for maximum flexibility. ```json { "name":"Simple Scheduled Job", "kind": "transfer", "transfer": { "audit_level": "trace", "transfer_type": "copy", "source": { "connection": { "id": "{{nfs_connection}}" } , "target": {"path":"/sourceFolder"} }, "destination": { "connection": { "id": "{{cloud_connection}}" }, "target": { "path": "/destinationFolder" } } }, "schedule": { "mode": "auto", "days": "everyday", "repeat_count": 0, "repeat_interval": { "value": 900000, "unit": "ms" }, "end_date": "1523025357", "end_window": { "hr": 0, "min": 0, "ms": 0, "sec": 0 }, "max_execution": { "unit": "d", "value": 0 }, "run_at": { "hr": 0, "min": 0, "ms": 0, "sec": 0 }, "start_date": "1523025357", "start_window": { "hr": 0, "min": 0, "ms": 0, "sec": 0 } } } ``` -------------------------------- ### Retrieve File Metadata via REST API Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3394764920/Mapping%2BMicrosoft%2BSharePoint%2BManaged%2BMetadata%2BREST%2BAPI Send a GET request to retrieve metadata for a specific file. The path should include the library name and file name. Note the managed metadata column name and value GUID for mapping. ```HTTP GET {{url}}v1/connections/{connectionID}/files/metadata?path=path ``` -------------------------------- ### Specify Configuration File Using Absolute Path Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750377/CLI%2BConfiguration Use this example to specify the configuration file location using an absolute path. ```bash skysync-cli connections list --config=c:/config/testConfig.json ``` -------------------------------- ### Schedule a Job for a Specific Date Range, Daily, Hourly, Within a Time Frame Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/history/3394764946 This example sets up a job to run daily every hour within a specified time window, for a defined start and end date. It includes 'start_date', 'end_date', 'start_window', and 'end_window'. ```json "schedule": { "mode": "auto", "days": "everyday", "repeat_interval": { "value": 3600000, "unit": "ms" }, "start_date": "1566345600", "start_window": { "hr": 6, "min": 0, "ms": 0, "sec": 0 }, "end_date": "1597968000", "end_window": { "hr": 21, "min": 0, "ms": 0, "sec": 0 } } ``` -------------------------------- ### Specify Configuration File Using Relative Path Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750377/CLI%2BConfiguration Use this example to specify the configuration file location using a relative path from the current directory. ```bash skysync-cli connections list --config=config/testConfig.json ``` -------------------------------- ### Install skysync-cli Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/history/3391750178 Installs the skysync-cli tool globally along with TypeScript. Ensure Node.js version 14 or later is installed. ```bash npm install -g typescript skysync-cli ``` -------------------------------- ### Download Cluster Node Installation Package (Specified Directory) Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750309/CLI%2BCluster Use this command to download the cluster node installation package to a specific directory. Replace {{targetDirectory}} with the desired path. The installation package can include the installer if configured on the server. ```bash skysync-cli cluster download --targetDirectory={{targetDirectory}} ``` ```bash skysync-cli cluster download --targetDirectory=C:\S4\Test ``` -------------------------------- ### Show Platform Example Results (Text) Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3391750411/CLI%2BConnections This is the expected text output when showing the details of a specific platform. It includes the ID, Name, and Enabled status. ```text ID nfs Name Network File System Enabled Y ``` -------------------------------- ### Days Option Example Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3394764946/Scheduling%2Ba%2BJob%2BUsing%2BREST%2BAPI Example of setting the 'days' option to run a job on weekends. ```json "days": "weekends", ``` -------------------------------- ### Example Transfer Configuration Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/history/3394764871 A comprehensive JSON example demonstrating a file transfer configuration, including source and destination details, metadata mapping, and performance settings. ```json { "name": "Box -> Sharepoint (Metadata)", "kind":"transfer", "transfer":{ "transfer_type": "copy", "source": { "connection": { "id": "36405b306fe84df69d55e007ed27967e", }, "target": { "path": "/Source" } }, "destination": { "connection": { "id": "92edba5e132645dda035580bfb14a063", }, "target": { "path": "/Metadata Test/Destination" } }, "audit_level": "trace", "performance": { "parallel_writes": { "requested": 2 } }, "metadata_map": { "schemas": [ { "mappings": [ { "source": { "property": { "name": "Text" } }, "destination": { "property": { "name": "Caption" } } }] }] } }, "schedule":{ "mode":"manual" } } ``` -------------------------------- ### Repeat Count Option Example Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3394764946/Scheduling%2Ba%2BJob%2BUsing%2BREST%2BAPI Example of setting the 'repeat_count' option. This option cannot be used with 'run_at'. ```json "repeat_count": 0, ``` -------------------------------- ### Full appSettings.json Example Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3389816833 This example shows the 'performance:concurrent_transfers' setting within a complete appSettings.json file, including other configuration options. Remember to restart DryvIQ services for changes to take effect. ```json { "data": { "provider": "sqlserver", "connection": "Server=server_location;Database=database_name;User ID=sa;Password=passW@rd!", "embedded": "false", "native_encryption": "false" }, "performance": { "parallel_writes": {"requested" : 6}, "concurrent_transfers": 10 } } ``` -------------------------------- ### End Date Option Example Source: https://dryviq.atlassian.net/wiki/spaces/DryvIQ/pages/3394764946/Scheduling%2Ba%2BJob%2BUsing%2BREST%2BAPI Example of setting the 'end_date' option using a Unix/Epoch timestamp. ```json "end": "1567123200", ```