Use this guide to create BASIC pipelines for supported cloud storage providers and APIs.
A pipeline controls how Yarken retrieves and processes data from an existing source. The setup differs depending on whether you use cloud storage or an API.
For an overview of pipeline types, BASIC and ADVANCED behavior, and the overall ingestion lifecycle, see Pipelines.
Before you begin
Before you create a pipeline:
-
Confirm that you have access to create and manage pipelines.
-
Configure the required source connection, or create the connection during pipeline setup where supported. For connection setup, see Connections.
-
For file-based pipelines, prepare a supported source file. Supported formats include CSV, GZ, and Parquet.
-
For file-based pipelines, prepare the required Data Mapping Template. For mapping guidance, see Data Mapping Templates.
-
Confirm the source folder, API data type, and schedule you want to use.
New BASIC pipelines are inactive by default. Activate the pipeline after you review the configuration and before you expect scheduled ingestion to begin.
Choose the pipeline type
|
Pipeline type |
Use it when |
Supported sources |
|---|---|---|
|
Cloud storage |
Your source data is stored as files in supported cloud object storage. |
Azure Blob Storage, AWS S3, and Google Cloud Storage. |
|
API |
You want Yarken to retrieve supported structured data directly from an API. |
Microsoft Graph API, Power BI API, and Google Cloud API. |
Create a cloud storage pipeline
Cloud storage pipelines retrieve files from supported cloud storage providers and load them into Yarken on a recurring schedule.
Before you create a pipeline, review the requirements for your storage provider. Then follow the common setup workflow.
Cloud storage pipelines use a connection, source directory, Data Mapping Template, and schedule to process recurring files.
Provider-specific requirements
Review the requirements for your cloud storage provider before you start the pipeline setup. The connection details, source location, and authentication requirements vary by provider.
|
Provider |
Authentication / connection |
Source location |
Key requirement |
|---|---|---|---|
|
Azure Blob Storage |
Account Key or Service Principal |
Container and directory |
Access to the Azure Storage account and source files |
|
AWS S3 |
Access Key and Secret Key |
Bucket and directory |
Access to the S3 bucket containing the source files |
|
Google Cloud Storage |
Access Key and Secret Key |
Bucket and directory |
Access to the GCS bucket containing the source files |
Azure Blob Storage
AWS S3
Google Cloud Storage
Common setup workflow
Step 1: Open Pipelines
-
Go to Admin > Pipelines > Pipelines.
-
Select the BASIC tab.
-
Select + NEW PIPELINE.
Available Cloud Storage and API pipelines
Step 2: Select the storage provider
Select one of the supported storage integrations:
-
Azure Blob
-
AWS S3
-
Google Cloud Storage
Step 3: Select the connection
Select an existing connection for the provider.
If the required connection does not exist, create one during setup where available. Use Create BASIC connections for provider-specific authentication fields and permissions.
Step 4: Enter the source directory
Enter the Directory Name that contains the files Yarken should retrieve.
Keep unrelated or differently structured files out of the configured directory. Yarken processes files from the source path using the pipeline's selected mapping.
Step 5: Select the Data Mapping Template
Select the template that maps the source file fields to the required Yarken destination fields.
-
Review the template before using it for a new source format.
-
For Expenses (spend) ingestion, review the Delete before load option when it is available for the source setup.
Delete before load removes existing Expenses data for the target period before Yarken imports the replacement file. Confirm the period and source file before you use this option.
Step 6: Select the Date Format for Cloud Consumption mapping template
The Date Format step does not appear for non-cloud consumption Data Mapping Templates.
When you select a Cloud Consumption Data Mapping Template, Yarken adds a Date Format step.
Select the date format used in the FOCUS source file. Yarken saves the selected format with the Data Mapping Template and uses it when processing files with that template.
Select the format that matches the source file. An incorrect date format can cause parsing or validation errors during the pipeline run.
Cloud Spend publishing
When you select a Cloud Consumption Data Mapping Template, Yarken reminds you to configure Upload Rules for Accounts, Cost Centers, and Vendors.
This requirement applies when you publish Cloud Consumption data to the Spend model. It does not prevent the pipeline from ingesting Cloud Consumption data.
Step 7: Configure the schedule
On the Schedule tab, select the required frequency:
-
Hourly — Configure the required hourly interval.
-
Daily — Runs every day starting at 12:00 AM.
-
Monthly — Select the day of the month and month interval.
Step 8: Enter the pipeline details
-
On the Details tab, enter a clear Pipeline Name.
-
Select SAVE.
Yarken creates the pipeline in an inactive state.
Step 9: Activate and validate the pipeline
-
Review the pipeline configuration.
-
Use the activation toggle to activate the pipeline.
-
Confirm the activation.
-
Use Run Once if you want to test the pipeline immediately.
-
Use View Run History to confirm that the first run completed successfully.
After the first successful run, verify the loaded data in the destination Yarken feature and refresh the affected cube if you need immediate reporting results.
Set up an API pipeline using consent
For supported APIs, the consent workflow is the recommended setup path.
When the tenant administrator grants consent and the option to create the pipeline is selected, Yarken can create the connection and corresponding API pipeline automatically.
The consent workflow can:
-
Authorize the required API access.
-
Create the supported connection.
-
Configure the predefined API mapping.
-
Create the associated pipeline.
API pipelines use predefined mappings. You do not create or select a custom Data Mapping Template for these pipelines.
For consent-based connection setup, see Create an API connection using consent.
Recommended schedules for API pipelines
Some supported integrations have a recommended pipeline schedule. Use the recommended cadence unless your implementation requires a different configuration.
|
Pipeline |
Recommended schedule |
Notes |
|---|---|---|
|
Microsoft Graph API |
Monthly — 7th of every month |
One pipeline retrieves License Details, Product Usage Details, Entra ID Activity Details, Teams Activity Details, and Defender Enrolled Device Details. |
|
Power BI Usage Details |
Daily |
Create a separate usage pipeline. |
|
Power BI Workspace Details |
Monthly — 7th of every month |
Uses the same Power BI connection as the Usage Details pipeline. |
When you use the supported consent flow, Yarken can create the Microsoft Graph and Power BI pipelines automatically. The initial ingestion runs as part of the setup, and the pipelines then follow their configured recurring schedules.
Create an API pipeline manually
Create an API pipeline manually only when the required connection already exists and the pipeline was not created through the consent workflow.
Google API connections use the supported consent flow. Follow the connection guidance before you attempt to create the related pipeline.
Common manual setup workflow
Step 1: Open Pipelines
-
Go to Admin > Pipelines > Pipelines.
-
Select the BASIC tab.
-
Select + NEW PIPELINE.
Step 2: Select the API integration
Select the required API:
-
Microsoft Graph API
-
Power BI API
-
Google Cloud API
Step 3: Select the connection
Select the existing API connection for the integration.
Step 4: Select the API data
Select the data set that Yarken should retrieve. The available options depend on the selected API.
Step 5: Configure the schedule
Select the required schedule for that API data set.
Step 6: Enter the pipeline details
-
Enter a clear Pipeline Name.
-
Select SAVE.
Step 7: Activate and validate the pipeline
-
Activate the new pipeline.
-
Use Run Once when you want an immediate test run.
-
Use View Run History to verify the execution.
API-specific data to sync
Microsoft Graph API
Power BI API
Google Cloud API
After you create a pipeline
After you save and activate the pipeline:
-
Use Run Once when you want to validate the configuration immediately.
-
Use View Run History to confirm successful execution.
-
For file-based pipelines, confirm that Yarken processed the expected file.
-
Open the Yarken feature associated with the destination data type.
-
Refresh the affected cube when you need immediate reporting results.
For ongoing changes and lifecycle actions, see Manage BASIC pipelines.
For execution monitoring, see Monitor pipeline runs.
Related content