Fetch Media

This post is referring to Vahana 2 (beta version). To check the document for production, please go to vDesigner-v1.0

This task fetches media from a specified file path or DMS (Document Management Server) and stores it in a specific location. When you configure this task, you also define an output location. After it fetches the media, it stores it in the output location.

Steps to Configure

  1. On the <<task group’s name>> page, find the Task panel.
  2. In the Task panel, search and find the Fetch Media task.
  3. Drag the Fetch Media task from the Task panel to the Execution panel.
  4. Under Fetch Media, a group of boxes comes into view.
  5. In boxes, configure related properties as follows:
Property
Name
DescriptionMandatory
Reference NameThe reference name specifies the name of the task. In the Reference Name box, enter a name of the task. The reference name works as a name identifier, and you can use it to search and find the current task from the list of multiple tasks.Yes
MediaThis property allows you to define the source location. The Fetch Media task fetches media from the source location. You can define the source location by selecting one of the following options:

a. Identifier
In the Media list, when you select this option, it means you are defining DMS (Document Management Server) as the source location. In this case, the Fetch Media task fetches media from DMS.

You can define the source location by configuring several identifiers, such as Doc ID, Doc Bundle ID, Primary Key1, and others.

When you select Identifier in the Media list, the property panel displays the following boxes or fields:
1. Fetch Type
2. Doc ID (If you select Doc ID or Both in the Fetch Type list)
3. Doc Bundle ID (If you select Doc Bundle ID or Both in the Fetch Type list)
4. Primary Key1
5. Primary Key2
6. Primary Key3


b. Path:- In the Media list, when you select this option, it means that you are defining a file path as the source location. The Fetch Media task fetches media from the file path.

When you select Path in the Fetch Type list, the property panel displays the Path box. In the Path box, you define the file path.
Yes
Fetch TypeThis property allows you to configure Doc ID and/or Doc Bundle ID identifiers to fetch the data from DMS. You can configure these identifiers as follows:
a. Doc ID:- Select this option to define the Doc ID as the identifier. Thus, the Fetch Media task fetches media from DMS based on the Doc ID identifier.

b. Doc Bundle ID:- Select this option to define the Doc Bundle ID as the identifier. Thus, the Fetch Media task fetches media from DMS based on the Doc Bundle ID identifier.

c. Both:- Select this option to define the Doc ID and Doc Bundle ID as identifiers. Thus, the Fetch Media task fetches media from DMS based on the Doc ID and Doc Bundle ID.
Doc IDIn this box, define a unique identifier (for example, file_image_01file_all_format). This unique identifier serves as the Doc ID. This Doc ID is used to manage the file on DMS (Document Management System).

Later, application fetches the file based on the unique Doc ID. You can define the Doc ID as follows:

a. STATIC function:- Use the STATIC function and then manually define the Doc ID in the STATIC function.

b. Attribute:- Create an entity in the Data Modeler module. Thus, define an attribute in the entity. Define a unique Doc ID (an alphabetic, an alphanumeric, or a numeric value) as the value of the attribute.

To know more about how to create an entity or attribute, click here.

Click in the Doc ID box, enter the attribute’s name, and then select it.

c. Element:- Select an element that contains the Doc ID.

d. Entity:- Create an entity in the Data Modeler module. After you create the entity, store the Doc ID in the entity by using Copy Data task or by other methods.

When the application executes Copy Data task, it dynamically creates an attribute to store the Doc ID in the entity.

In the Doc ID box, enter the entity’s name, and then select it.

e. Functions:- You can use the vDesigner function, such as the STATIC function or other functions, to store the value of the Doc ID identifier.
Yes
Doc Bundle IDIn this box, define a key. This key is referred to as the Doc Bundle ID. The Doc Bundle ID groups multiple documents to manage them on the Document Management Server.

You can define the doc bundle ID by using the following ways:
a. Static Function
b. Attribute
c. Element
d. Entity
e. Function


To know more about how to define the Doc Bundle ID, see the description of the Doc ID property in this table.
Yes
Primary Key1In this box, define a unique key that is called the Primary Identification Key. The File Picker task uses the primary key1 as a unique identifier when it uploads a file to the document management system. On the basis of the primary key, it manages a file or a group of files on DMS.

To know more about how to define Primary Key1, see the description of the Doc ID property in this table.
No
Primary Key2Read the description of Primary Key1.No
Primary Key3Read the description of Primary Key1.No
Expiry Time<<To be discussed>>
Output LocationThis property allows you to define a location where the Fetch Media task will store the media.

You can define the storage location as follows:
a. Attribute:- Create an entity in the Data Modeler module. Thus, define an attribute in the entity.

Click in the Output Location box, and then enter the attribute’s name to find it. Select the attribute to define it as the media’s storage location.

To know more about how to create an entity or attribute, click here.

b. Element:- Click in the Output Location box, and then enter the element’s reference name to find it. Select the element’s reference name to define the element as the media’s storage location.

c. Entity:- Create an entity in the Data Modeler module. Click in the Output Location box, and then enter the entity’s name to find it. Select the entity to define it as the media’s storage location.

At runtime, the entity dynamically creates an attribute to store the media in it.
No
Business RuleIn this box, you can configure a business rule to determine the execution of the Fetch Media task.  If the user’s action satisfies the condition in the business rule, the Fetch media task is executed.

To configure the business rule:
–> In the Business Rule box, click the application tree icon (), and the Business Rule panel opens.
–> In the Business Rule panel, click Create New to configure a new business rule.
No
  1. After you configure the related properties, click Save to configure the Fetch Media task.

Was this article helpful?
YesNo