vlocity dataraptor documentationvlocity dataraptor documentation

Run packUpdateSettings or add autoUpdateSettings: true to your job file. To install puppeteer into a build machine or locally run: If your system has Chrome installed VBT will automatically start a headless chrome session, authenticate to the deployment org, and use a page in the Vlocity Managed Package to compile and deploy the OmniScript or Card.

Some errors are related to conflicting data.

packGetDiffsAndDeploy will first find all files that are different locally than in the target Org, and then will deploy only the DataPacks that have changed or are new.

The data comes in as a JavaScript object notation (JSON) and contains extraneous information (1). This predefined syntax is defined in lib/querydefinitions.yaml and will load the following explicit queries: The WHERE clauses show that these Queries will Export all DataRaptors that are not internal Vlocity Configuration Data and all Active OmniScripts.

packExportSingle will export a single DataPack and all its dependencies.

Send only the necessary input and return only the outputs you need.

The projectPath can be the absolute path to a folder or the relative path from where you run the vlocity command. Without this Matching Key you will receive the following error during deployment: To workaround this issue it is most simple to disable temporarily disable the listed Pricebook.

Records with the same Display Sequence can be found via the SOQL query: Select Id, Name from %vlocity_namespace%__AttributeCategory__c This generally means that there is a mismatch between the Configuration Data in the target org compared to the Source Org.

Most objects being deployed have a field or set of fields used to find unique records like an External Id in Salesforce. Queries support full SOQL to get an Id . vlocity -job packExport -key VlocityUITemplate/cpq-theme-variables. Use DataRaptor Transforms for the following situations.

SOQL Queries can use %vlocity_namespace%__ to be namespace independent or the namespace of your Vlocity Package can be used.

packDeploy -key Product2/00527b2d-08a6-c069-33cf-88de9d25a2de. Fields used to create the File Names for an SObject.

That DataRaptor is passed an input orderId with the value .

Used in CLI API applications, JSON of VlocityDataPackKeys to be processed.

This query will export a DataRaptor Vlocity DataPack by querying the SObject table for DataRaptor DRBundle__c and even supports the LIMIT 1 and LIKE syntax. Before a Deploy, each JSON Object will be a small amount of information about the Object.

The Matching Key for a CatalogProductRelationship__c object is %vlocity_namespace%__CatalogId__c, %vlocity_namespace%__Product2Id__c (See Current Matching Keys). Flex cards means the interface.

Remove the colors from console output.

Qualifications: Bachelor's degree in Computer Science or a related field.

While it is possible to use the CURRENT_DATA_PACKS_CONTEXT_DATA described above, for large projects it will be over the 32000 character limit for Anonymous Apex.

Queries support full SOQL to get an Id for each DataPackType. vlocity -job packExport -key VlocityUITemplate/cpq-theme-variables.

Formula Tab Define a formula, you map its output to the output JSON (for extracts and transforms) or Salesforce object field (for loads).

Additionally there is support for OAuth style information sent through the command line or property file: If you are using this method also include oauthConnection: true in your Job File. Unfortunately it does not always provide the actual Id. Custom Setting -> General Setting -> Name = VBTRequiredVersion, From then on, any user on a version that is not the same as this required version will get the error:

Fields used to build the readable key for a single SObject when it is a Matching Key node.

By Default, all DataPack Types will be Exported when running packExport, so to override the Export data, it is possible to use predefined queries, or write your own.

Definition of an Order in Industries Order Management.

LEARN MORE ABOUT DATARAPTOR Empower agents with contextual information at a glance.

Use Git or checkout with SVN using the web URL.

Export by Predefined Queries is the recommended approach for defining your Project and you can mix the predefined and explicit queries as shown above. npm install @omnistudio/omniscript-lwc-compiler. For Attribute Category Display Sequence you will receive the following: Error >> AttributeCategory/Product_Attributes --- Product Attributes --- duplicate value found: duplicates value on record with id: .

The Vlocity Build tool primarily relies on unique data in fields across the different objects to prevent duplicate data being uploaded.

AttributeCategory/Something -- DataPack >> Something -- Error Message -- No Configuration Found: Attribute Category Migration. Post Job Apex runs after the Job completes successfully.

Here are some common mistake for Data Raptors.

packExport: Export from a Salesforce org into a DataPack Directory

This query will export a DataRaptor Vlocity DataPack by querying the SObject table for DataRaptor DRBundle__c and even supports the LIMIT 1 and LIKE syntax.

Work fast with our official CLI.

About Press Copyright Contact us Creators Advertise Developers Terms Privacy Policy & Safety How YouTube works Test new features NFL Sunday Ticket Press Copyright . Product2/4e5828c2-4832-10c8-c343-88934cc2cb1c DataPack >> Amount Discount Product Error Message Incorrect Import Data. installVlocityInitial: Deploy and Activate the Base Vlocity DataPacks and Configuration DataPacks included in the Managed Package The projectPath can be the absolute path to a folder or the relative path from where you run the vlocity command.

When SASS Fails to compile the issue is generally related to the export not including VlocityUITemplates that are referenced as part of the SASS compilation.

As long as the same Matching Keys are used in each Org, then there will be no issues with using Custom Matching Keys. runJavaScript: Rebuild all DataPacks running JavaScript on each or run a Node.js Script From the OmniStudio app (or in legacy installs, the Vlocity app), open the OmniStudio DataRaptor tab. It is written as a Node.js Command Line Tool.

.

Vlocity Build Recent Features

Another way to see any very clear potential issues is to see if recently deployed data matches exactly what was just exported.

For a VlocityUILayout it would be: In the DeactivateTemplatesAndLayouts.cls this Name is used to Deactivate the Layouts that are pending for Deploy.

.

The BaseUtilities.cls file includes an additional feature that will send the data as a JSON to your Anonymous Apex. Updating Managed Package Global Value Sets is not possible without using the UI. Three log files are generated for every command run.

.

Unlike a standard DataRaptor Extract (which we describe next), a DataRaptor Turbo Extract doesnt support formulas or complex output mappings.

Vlocity (Salesforce Industries) offers pre-built solutions on the Salesforce platform that solve the needs of particular industries that require CRMs to be heavily customized beyond Salesforce in its out-of-the-box state.

One-to-One Decomposition. OmniStudio Settings.

cleanOrgData will find and fix issues in the Org Data.

When an OmniScript must fill fields in a PDF document.

Not all types will support using a manifest as many types are only unique by their Id. Makes metadata changes across orgs for Vlocity Managed Package fields automatically propagate and eliminates errors due to this missing metadata. See Advanced Anonymous Apex for more details.

Vlocity Digital experience uses lwc for fast and smooth experience. DataRaptor Extract, the second type of DataRaptor that pulls data from Salesforce, reads Salesforce data and returns results in JSON, XML, or custom formats via complex field mappings. EPCProductJSONUpdate.cls is recommended to be run when Deploying Products.

The Duplicates must be removed from the Source Org and Re-Exported. This can be a Scratch Org, or one Authorized through sfdx force:auth:web:login. Best when combined with the maximumDeployCount of 1. postStepApex can be used to run any compilation steps in Apex that are not automatically run inside triggers.

Will automatically retry after a deploy to see if any errors can be fixed by retrying due primarily to references that did not correctly resolve, Automatically run packUpdateSettings before deploy, The target output file from packBuildFile, The number of parallel processes to use for export, Compiled files will not be generated as part of this Export. What is present in OmniScript designer highlights?

JsonFields is a list of fields on the SObject which should be written as formatted JSON as opposed to a String when writing to a file. As there are various rules across the Vlocity Data Model, sometimes errors will occur due to attempts to create what is considered "bad data". A DataRaptor is a mapping tool that enables you to read, transform, and write Salesforce data. With this default setting, the Apex Code in DeativateTemplatesAndLayouts.cls will run before the deploy to the org.

For example, when a user running a case-handling OmniScript finishes entering data and clicksSave, the script calls a DataRaptor Load to record the data entered. cleanOrgData: Run Scripts to Clean Data in the Org and Add Global Keys to SObjects missing them The datapacks will be deployed, however a manual activation of the latest OmniScript after deployment is required. you set advanced options such as whether to check the users access permissions for the fields before executing the DataRaptor.

OmniStudio-First Side-by-Side Package Installation Results. GPS .

There are four types of DataRaptor: Turbo Extract, Extract, Transform, and Load. In this post we will talk about what is OmniStudio DataRaptor and Type of DataRaptor.

In the following example, an insurance company implemented DataRaptor Transform so that its labels make more sense to the user. Ensure that all filtering and sorting (ORDER BY) operations are on indexed fields.

Recommended to set to false. Login Failed >> Must Use Vlocity Build Tool version: 1.11.19 - Use npm install -g vlocity@1.11.19. To narrow the exported data, you can define any Salesforce SOQL query that returns the Id of records you would like to export. Available types are Import, Export, Deploy, BuildFile, and ExpandFile. This may be too much data for Anonymous Apex for large deploys. Pre Job Apex can run Anonymous Apex before the DataPack Job starts.

Good for potentially fixing circular reference issues, Specify the maximum number of DataPacks which should be Exported in a single transaction.

To Export All DataRaptors and OmniScripts from the Org use: By default, all data will be exported from the org when running the packExport command. Run command without specifying a Job File.

You signed in with another tab or window. Its primary goal is to enable Continuous Integration for Vlocity Metadata through source control. Which includes Vlocity DataPacks in vlocity_components folder and a Salesforce DX Project in the salesforce_sfdx folder. Good for potentially fixing circular reference issues, Specify the maximum number of DataPacks which should be Exported in a single transaction. You can run the following command to check the current local data against the data that exists in the org you deployed to: This will provide a list of files that are different locally than in the org.

Orchestration Dependency Definition - In the Managed Package this Object does not have a Matching Key and creates duplicate records. You use the properties of the action element (2) to trim the JSON and send only the node that is needed to a DataRaptor Transform Action (3). Organization API.

Create a Dataraptor - DRGetAccounts Create a flexcard - DisplayAccountChild. DataRaptor Extracts read Salesforce data and return results in JSON, XML, or custom formats. This should show a list of all available commands confirming that the project has been installed or updated successfully.

vlocity -propertyfile -job runJavaScript -js lwcOmniOutRetrieve.js, You can lock the version in any org by adding the following Custom Setting value:

Determines whether or not to store the _AllRelations.json file which may not generate consistently enough for Version Control.

When to use the Integration procedure in Vlocity?

Running packExport with no queries defined in your Job File will export all the predefined queries for each type.

Youve got the DataRaptor basics down! The DataRaptor Not Found means that likely someone deleted or changed the name of the DataRaptor being referenced without updating the OmniScript using it. To narrow the exported data, you can define any Salesforce SOQL query that returns the Id of records you would like to export. There was a problem preparing your codespace, please try again. Like Pre and Post Job Apex you can also run JavaScript against the project with the preJobJavaScript, postJobJavaScript in your Job File. To export the Vlocity Product Catalog, use the following Platform.yaml file: Ensure High Data Quality in the Source Org by running: If you encounter any Errors during Export please evaluate their importance.

Vlocity Build is meant to fit seamlessly into an Automated Salesforce Build.

If a Deploy finds 1 object matching the Global Key then it will overwrite that object during deploy. Recommended to set to false. Instead, each developer should keep track of the major items that they are working on and extract those items as needed to commit to Version Control. Decomposition Relationships. Set the Platform Cache Type to Session Cache for data related to users and their login sessions, or Org Cache for all other types of data. OmniStudio Naming Conventions.

cleanOrgData: Run Scripts to Clean Data in the Org and Add Global Keys to SObjects missing them

Vlocity has defined full queries for all Supported DataPack Types which will export all currently Active Vlocity Metadata. This means the other Product must also be deployed.

More info at DataPack Key Based Export.

Without this Matching Key you will receive the following error during deployment: Use node -v to find out which version you are on. Recommended only if you are on the latest Major version of the Vlocity Managed Package This is the most simple way to define your own Job File queries. Create Dataraptor to extract information Step 2.

Its primary goal is to enable Continuous Integration for Vlocity Metadata through source control.

This command should only be run if the Org was not previously used for Vlocity Development. Otherwise, create your own property files for your Source and Target Salesforce Orgs with the following: Commands using this would be in the form of: When you (or your CI/CD server) is behind a proxy you can specify the proxy URL with a Username and password by adding the following line to your property file: It is best to not rely on a single build.properties file and instead use named properties files for each org like build_source.properties and build_target.properties. This is meant to ensure that you will see any missing reference errors before your deployment.

DataPacks uses a Custom Metadata Object called a Vlocity Matching Key to define the uniqnueness of any SObject.

Example: 900.469, Overrides the npm repository where the LWC compiler is hosted, Your customer NPM auth key used to install the LWC compiler package, Apex Class to run with the runApex command, Path to folder containing Apex Files when using the runApex command, Path to javascript file to run when using the runJavaScript command, Output the result of the Job as JSON Only. Duplicate Global Keys must be fixed in the Org. As long as the same Matching Keys are used in each Org, then there will be no issues with using Custom Matching Keys.

Therefore, this error means that there are two references to the same product inside the same Catalog, which is not allowed. For Product2 DataPacks, the VlocityDataPackKey is built using the vlocity_namespace__GlobalKey__c. Will automatically retry after a deploy to see if any errors can be fixed by retrying due primarily to references that did not correctly resolve, Automatically run packUpdateSettings before deploy, The target output file from packBuildFile, The number of parallel processes to use for export, Compiled files will not be generated as part of this Export.

Click the "New" button to create a new DataRaptor.

Now lets look at what each DataRaptor does. To set up the three tabs (in Chrome), select the first tab and open the OmniStudio Console. Errors occurring during Export will likely result in Errors during deploy.

This gives an indication that the datapacks have been configured correctly, however the missing Matching Key causes VBT to create new records. The Job file additionally supports some Vlocity Build based options and the options available to the DataPacks API.

Salesforce additionally provides a Trailhead for Travis CI. However, the Default settings should only be modified to account for unique issues in your Org. Please Error: Product2/00527b2d-08a6-c069-33cf-88de9d25a2de -- Datapack >> Mobile Service -- Error Message -- No Data without Parent Dependencies

Fixed in v1.9 OmniScripts that are embedded in many other OmniScripts cannot be activated due to SOQL Query limits.

Q&A for Salesforce administrators, implementation experts, developers and anybody in-between Dataraptor Functions : Change the data you are working with in more complex ways than with mapping inputs and outputs, use functions, Output Tab map data from the extract step JSON to the output JSON. Add gitCheck: true to your job file to enable checking what the latest git hash was before deploying to the target org.

Vlocity Build is a command line tool to export and deploy Vlocity DataPacks in a source control friendly format through a YAML Manifest describing your project. When the user changes that data or enters new data, it must be saved too. packGetDiffs: Find all Diffs in Org Compared to Local Files Skip expanding the DataPack into Multiple Files.

This allows deploying only a specific set of local folders to the Org, as the VlocityDataPackKeys are the Folder Paths of the DataPacks.

The manifest defines the Data used to export.

The first step of setting up Jenkins for this project is adding the JWT Bindings: The Vlocity Build Tool will now automatically compile and deploy OmniScript and Cards LWCs after Activation through Puppeteer or Chrome installed on your local machine.

packDeploy will deploy all contents in the projectPath of the Job File to the Salesforce Org. Also known as the DataPack Directory # in this Documentation.

Turn on / off parallel processing when Deploying the DataPack Type.

In most cases the Folder Name is the Global / Unique Key for the Object such that it should never change no matter what else changes in the object. OmniStudio Release Summary for Installation and Upgrade. So what exactly is a DataRaptor?

If nothing happens, download Xcode and try again.

Therefore, it is best to create a second job file for Deploy. It is best to use the Export by Queries syntax. Updating Managed Package Global Value Sets is not possible without using the UI. validateLocalData will find and can fix issues in the local data files. using the command npm install -global vlocity on your terminal/command prompt and it has been mentioned on this documentation https .

Fields used to build the readable key for a single SObject when it is a Matching Key node.

In the future more features will be added to view the actual diffs.

The Vlocity Build tool primarily relies on unique data in fields across the different objects to prevent duplicate data being uploaded.

Here are some code capabilities of DataRaptor (DR) in Salesforce: Let understand the different type of OmniStudio DataRaptors. There is a large amount of post processing to make the results from Salesforce as Version Control friendly as possible.

In this case it will Deactivate the Vlocity Templates and Vlocity UI Layouts (Cards) associated with the Deploy.

Each DataPack has a VlocityDataPackKey that represents its Unique Name in the DataPacks system. Allocate space only to Org Cache.

By default it is the Name of the Object.

refreshProject: Refresh the Project's Data to the latest format for this tool Do not clone the repo!

Fields used to create the Folder Name for an SObject.

These errors mean there are duplicates in the data.

Orchestration Dependency Definition - In the Managed Package this Object does not have a Matching Key and creates duplicate records. This query will export a DataRaptor Vlocity DataPack by querying the SObject table for DataRaptor DRBundle__c and even supports the LIMIT 1 and LIKE syntax. DataRaptor Turbo Extract retrieves and filters data from a single Salesforce object type with support for fields from related objects.

Export.

Vlocity Matching Keys contain the following fields: Create these keys if you want to support connections between SObject Id fields that are not already supported by DataPacks, or if you would like to change the Vlocity Default for any SObject.

It is not necessary to change these settings unless you want to change the default behavior. refreshProject will rebuild the folders for the Data at the projectPath. You can install or update this package like any other Node Package! Extracts typically provide OmniScripts, Integration Procedures, and Cards with the data they require.

All Options can also be passed in as Command Line Options with -optionName or --optionName for Boolean values. The following would be used to change the Matching Key of a Product2 to its ProductCode instead of using Vlocity's GlobalKey field.

OmniStudio sObject Descriptions. SOQL Queries can use %vlocity_namespace%__ to be namespace independent or the namespace of your Vlocity Package can be used.

Describe the capabilities of each DataRaptor type. To disable this feature add to your Job File: In cases where there is a specific executable path for Chrome, or there is no interest in the use of its headless feature, it is possible to do as follows: This is only supported for Package Versions Spring '22+. Queries support full SOQL to get an Id for each DataPackType.

This is meant to ensure that you will see any missing reference errors before your deployment.

It is written as a Node.js Command Line Tool. You typically use DataRaptor Extracts to provide OmniScripts and FlexCards with any internal Salesforce data they need to display. As these are Salesforce Metadata, they can be added to the version controlled project as well.

This specifies a File to create from the DataPack Directory. Think of it this way: for every digital customer interaction or business process, your system needs to extract data to display it.

The manifest section of the Job File can be used to create a collection of DataPacks to be exported or deployed.

This should show a list of all available commands confirming that the project has been installed or updated successfully. Once you have your build_source.properties file setup, you can get started with migration with the following: Example.yaml shows the most Simple Job File that can be used to setup a project: After creating the Example.yaml file, run the following command to export with this Job File: This has exported data from the org specified in your build_source.properties file and written it to the folder example_vlocity_build specified in the Example.yaml file found at dataPacksJobs/Example.yaml.

Potentially large DataPacks like Matrix or Attachments could be set to 1 if necessary.

Streamline and optimize business processes by displaying only the data you need, right when you need it.

Here is the iPhone 6s Plus Product2 DataPack in its folder with the same VlocityDataPackKey as shown above: This VlocityDataPackKey can be added to the manifest of the Job File to drive Export of this Product along with all its dependencies. It will default to build.properties if no file is specified. All releases for this Project can be found at:

These types are what would be specified when creating a Query or Manifest for the Job.

See Creating Custom Matching Keys for more information on Matching Keys. These errors mean there are duplicates in the data.

Additionally, an Export Build File can be created as part of an Export. This job file only needs projectPath as it will deploy the entire contents of the project by default.

Think of it this way: for every digital customer interaction or business process, your system needs to extract data to display it. packExport: Export from a Salesforce org into a DataPack Directory

Next, we break down the capabilities of each type of DataRaptor. Use OOTB functionality where possible before creating a custom Formula.

Where each record contains the VlocityDataPackKey that was Exported / Deployed, and the Export / Deploy will be limited to only VlocityDataPackKeys passed in as part of the manifest if it is supplied. A DataRaptor Load updates records with changed data and also creates new records at the same time.

Add gitCheck: true to your job file to enable checking what the latest git hash was before deploying to the target org.

packGetAllAvailableExports: Get list of all DataPacks that can be exported

This is the Global Key of the Product2 being referenced by the field ChildProductId__c on the SObject ProductChildItem__c.

This error means that during the Deploy some of the Records that exist as part of the DataPack Data were not upserted into Salesforce.

Fields to remove before writing to files.