IPS Data Upload Utility for Migration - Part 3

Configuration File

Configuration file should have configuration options. As already mentioned in Part2 blog, configuration file is optional as configuration options can be placed within input data file before the header line. Below is the format,

OPTION NAME = <value>
Where <value> is user value like object type or predefined keywords such as ON or OFF

We also have option to include config file within another config file. Eg. a global_config file to set general settings like DATE FORMAT and other config files specific to object type.

Commonly used configuration option

SET BYPASS

ON or OFF to control if bypass privilege is available for DBA users only.

DATE FORMAT

To describe the format date field.

For example:

%d-%b-%Y %H:%M = 20-Jul-2021 09:00

%d/%m/%Y = 20/07/2021

%y%m%d = 20/07/21

LOG FILE

To override the default log file name.

CREATE ITEMS

ON or OFF to control creation of items

UPDATE ITEMS

ON or OFF to control updating items

CREATE REVS

ON or OFF to control creation of revisions

UPDATE REVS

ON or OFF to control updating revisions

ITEM TYPE

Item type to create new items

DEFAULT OWNER

Default owner for new objects created

DEFAULT GROUP

Default owner group for new objects created

RELEASE ITEM

Name of default release status to use

VIEW TYPE

BOMViewRevision revision type to create in BOM Mode

CREATE BOM

ON or OFF to control creation of BVRs

UPDATE BOM

ON or OFF to control update of BVRs

BOM REV RULE

Revision rule to set for loading a BOM

RELATION NAME

Name of the relation to create in relations mode

RELATION PARENT TYPE

Type of parent object either ITEM or REV

RELATION CHILD TYPE

Type of child object either ITEM or REV

CUT RELATIONS

ON or OFF to turn on and off cutting of relations

CREATE DATASET

ON or OFF to control creation of datasets in datasets mode

UPDATE DATASET

ON or OFF to control update of datasets in datasets mode

DATASET TYPE

Dataset type for new datasets in datasets mode

Example

To create or update item, setting owner, group, creation date.

Config File
-------------------------------
CREATE ITEMS = ON
UPDATE ITEMS = ON
CREATE REVS = ON
UPDATE REV S = ON
DATE FORMAT = %d/%m/%Y
DEFAULT REV = A
ITEM TYPE = Item
DATE FORMAT = %d/%m/%Y

Data File
-------------------------------
!~ItemID~RevID~Owner~Group~CreateDate
Item1~A~user1~designers~16/07/2021
Item2~A~user1~designers~19/07/2021

To create a simple bom with quantity, owner and group

Config File
-------------------------------
MODE = bom
BOM FORMAT = parent_child
DATE FORMAT = %d/%m/%y
DEFAULT REV = A
SET BOMS PRECISE = OFF

Data File
-------------------------------
ITEM TYPE = Item
VIEW TYPE = Design
DATE FORMAT = %d/%m/%Y
BOM FORMAT = parent_child
!~ItemID~ChildID~Qty~Owner~Group~CreateDate
Item1~Item2~2~user1~designers~17/07/2021
Item1~item3~user2~designers~19/06/2021
Item1~item4~5~user2~designers~20/05/2021

To attach existing child form to a parent item rev using relation mode

Config File
-------------------------------
RELATION NAME = Ref
RELATION PARENT TYPE = REV

Data File
-------------------------------
!~ItemID~ParentRev~FormName~RelationName
Item1~A~Item1-A-txt~Spec

To create a new dataset using dataset mode and attached to item rev

Config File
-------------------------------
CREATE ITEMS = ON
UPDATE ITEMS = OFF
CREATE REVS = ON
UPDATE REVS = ON
UPDATE REV ATTACHMENTS = ON
UPDATE ITEM ATTACHMENTS = OFF
CREATE DATASET = ON
UPDATE DATASET = ON

Data File
-------------------------------
!~ItemID~RevID~DsetName~DsetType
Item0001~A~Item_0001~Text