pycatia.dnb_sor_interfaces.order_generator

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.dnb_sor_interfaces.order_generator.OrderGenerator(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

OrderGenerator

Interface representing Create Shop Order APIs which generates Shop Order

Instance(SOI), against user-given option(s).

Following gvies the major-steps encountered in a single SOI generation 1) Logs

in and secures connection with DPE. 2) Loads the specified job Node. 3) Reslves

the Work Instrucitons. 4) Captures Images for activities 5) Generates JobXML

and Precedence XML 6) Generates PackNGo data ( Lite or Full) 7) Zips the SOI

contents. 8) FTPs the zipped file to FTP server 9) Updates the Release table.

10) Disconnects from DPE.

Role: Component that implement DNBIAOrderCreation is

“OrderGenerator”

Do not extend this interface

Example : Refer to CreateShopOrder.CATScript or CreateSOI CATScript at intel_a/VBScript/DPM_SOR

create_shop_order() → int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func CreateShopOrder() As short

Create Shop Order method

Returns:

SOI response, which in-turn can be obtained using

OrderGenerator.GetErrorDescription

Return type:

int

create_shop_order2(i_xml_input: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub CreateShopOrder2(CATBSTR iXMLInput)

Create Shop Order using XML as SOI input.

Parameters:

iXMLInput

XML input file path Sample schema: Refer

intel_a/resources/xsd/DPM_SOR/CreateSOI.xsd Sample XML input: Refer

intel_a/resources/xml/DPM_SOR/CreateSOI.xml

Parameters:

i_xml_input (str) –

Return type:

None

get_error_description(error_code: int) → str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Func GetErrorDescription(short ErrorCode) As CATBSTR

Get Error Description. It deciphers return ERROR code of Create Shop Order

API.

Parameters:

iErrorCode

Create Shop Order API return code

Returns:

oErrDescription Create Shop Order API return code description

Parameters:

error_code (int) –

Return type:

str

set_dpe_login_info(i_dpe_login_id: str, i_dpe_password: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_DPELoginInfo(CATBSTR iDPELoginId,

CATBSTR iDPEPassword)

Set DPE Login Information.

Parameters:

iDPELoginId

E5 Login ID for authentication

iDPEPassword

E5 Password for authentication

Parameters:

• i_dpe_login_id (str) –

• i_dpe_password (str) –

Return type:

None

set_export_3dxml(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_Export3DXML(boolean iRequired)

Set Export 3D XML Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_export_image_capture(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_ExportImageCapture(boolean iRequired)

Set Export Image Capture Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_export_job_xml(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_ExportJobXML(boolean iRequired)

Set Export Job XML Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_export_prec_xml(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_ExportPrecXML(boolean iRequired)

Set Export Precedence XML Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_filter_input_string(ifilter_input_string: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_FilterInputString(CATBSTR ifilterInputString)

Specifies the filters to be applied while loading the project. The filters

can be specified either in the new way (V5R18 onwards) or the old

way.

New Way of Filtering:

In the new way of filtering different filters can be set for

P,P,R

by specifiying different filter sets for each area and also a global

filter set.

Old way of Filtering:

In case of P,P,R filters, either

(a) A Filter string can be supplied OR

(b) A Calculation Model ID can be supplied

Note: Calculation Model filters MUST only be supplied through their IDs.

In case of extended filters, either

(a) A Filter string can be supplied OR

(b) A Calculation Model ID can be supplied OR

(c) Both string AND Model ID can be supplied (Combined effectivity

case)

Note: Calculation Model filters MUST only be supplied through their IDs.

In case of effectivity filter mode, one of the following rules can be

supplied

(a) Give the objects whose begin & end dates contains the begin & end

date filters values.

The rule value is 1.

(b) Give the object whose begin & end dates are with in the begin & end

dates filter values.

The rule value is 2.

(c) Give the object whose begin date value is lesser than the begin date

filter value &

the end date value on the object is contained with in the begin & end

date filter values.

The rule value is 4.

(d) Give the object whose begin date value is contained with in the begin

& end date filter values &

the end date value on the object is greater than the end date filter

value.

The rule value is 8.

(e) Give the object whose begin & end dates exactly match with that of

the begin & end date filter values

The rule value is 16.

Note: Combination of the above said rules can also be

used.

For example: If the user wants the combination of rule a & c, then

the value of 5 should be passed

Note: If the user has not specified any value for this filter, then a

default value of 31 (combination of all rules) will be

used.

Parameters:

iFilters

[in]

The filters to be set.

This is a list of values separated by XML type tags. User Should

specify tags only from one of the below

set of tags applicable for new and old

filtering.

The following tags are supported for New way of

Filtering:

<GlobalFilterSetName>Global Filter

Name</GlobalFilterSetName>

<ProductFilterSetName>Product Filter

Name</ProductFilterSetName>

<ProcessFilterSetName>Process Filter

Name</ProcessFilterSetName>

<ResourceFilterSetName>Process Filter

Name</ResourceFilterSetName>

<ModStatementFilterID>Filter

Value</ModStatementFilterID>

<ProductFilterByCO>Filter

Value</ProductFilterByCO>

<PreFilter>Filter Value</PreFilter>

<PostFilter>Filter Value</PostFilter>

<PrePostFilter>Filter Value</PrePostFilter>

<PlanningStateOwnerFilterID>ID of Planning

State</PlanningStateOwnerFilterID>

<PlanningStateOtherFilterID>ID of Planning

State</PlanningStateOtherFilterID>

<ApplyImplicitFilter>TRUE or

FALSE</ApplyImplicitFilter>

The following tags are supported for Old way of

Filtering:

<ProcessFilter>Filter Value</ProcessFilter>

<ProcessFilterCalcModelID>ID of Calculation Model

Filter</ProcessFilterCalcModelID>

<ProductFilter>Filter Value</ProductFilter>

<ProductFilterCalcModelID>ID of Calculation Model

Filter</ProductFilterCalcModelID>

<ResourceFilter>Filter Value</ResourceFilter>

<ResourceFilterCalcModelID>ID of Calculation Model

Filter</ResourceFilterCalcModelID>

<StartDateEffectivityFilter>Filter

Value</StartDateEffectivityFilter>

<EndDateEffectivityFilter>Filter

Value</EndDateEffectivityFilter>

<EffectivityFilterMode>Filter

Value</EffectivityFilterMode>

<LineNumberFilter>Filter

Value</LineNumberFilter>

<LabelFilter>Filter Value</LabelFilter>

<ModStatementFilterID>Filter

Value</ModStatementFilterID>

<PlanningStateOwnerFilterID>ID of Planning

State</PlanningStateOwnerFilterID>

<PlanningStateOtherFilterID>ID of Planning

State</PlanningStateOtherFilterID>

<ApplyImplicitFilter>TRUE or

FALSE</ApplyImplicitFilter>

<ProcessExtendedEffectivityFilter>Filter

Value</ProcessExtendedEffectivityFilter>

<ProcessExtendedEffectivityFilterCalcModelID>ID of Calculation

ModelFilter</ProcessExtendedEffectivityFilterCalcModelID>

<ProductExtendedEffectivityFilter>Filter

Value</ProductExtendedEffectivityFilter>

<ProductExtendedEffectivityFilterCalcModelID>ID of Calculation

ModelFilter</ProductExtendedEffectivityFilterCalcModelID>

<ResourceExtendedEffectivityFilter>Filter

Value</ResourceExtendedEffectivityFilter>

<ResourceExtendedEffectivityFilterCalcModelID>ID of

Calculation ModelFilter</ResourceExtendedEffectivityFilterCalcModelID>

Attribute filters can be supplied using the following

tags

<AttributeFilters>

<ProcessAttributeFilters>

<AttributeFilter>

<PlanTypeName>Name of the

Plantype</PlanTypeName>

<AttributeName>Name of the

Attribute</AttributeName>

<Operator>Type of Operator. See list of legal values

below</Operator>

<AttributeValue>Value of the

Attribute</AttributeValue>

Add more <AttributeValue>…</AttributeValue> if more

attribute values need to be specified

</AttributeFilter>

Add more <AttributeFilter>…</AttributeFilter> if more

attribute filters need to be specified

</ProcessAttributeFilters>

<ProductAttributeFilters>

Add <AttributeFilter>…</AttributeFilter> as specified

above

</ProductAttributeFilters>

<ResourceAttributeFilters>

Add <AttributeFilter>…</AttributeFilter> as specified

above

</ResourceAttributeFilters>

</AttributeFilters>

Note: Instead of specifying plantype name, the object typename

(e.g., “ergocompprocessdefault, “ergocomporgprocess”, etc) can also be supplied

if filter is to be applicable to all plantypes

Note: For the <Operator> tag, the following are the legal

values

=

!=

<

>

<=

>=

LIKE

NOT LIKE

Example:

In new way of filtering:

iFilters = “<ProcessFilterSetName>Name</ProcessFilterSetName><ProductFilterSetName>Name</ProductFilterSetName><ResourceFilterSetName>Name</ResourceFilterSetName>”

The order is NOT important. e.g.,

“<ResourceFilterSetName>…</ResourceFilterSetName>” can come before

“<ProcessFilterSetName>…</ProcessFilterSetName>”

Example:

In old way of filtering:

iFilters = “<ProcessFilter>Process Type A</ProcessFilter><LabelFilter>Label B</LabelFilter><LineNumberFilter>10</LineNumberFilter>”

The order is NOT important. e.g., “<LabelFilter>…</LabelFilter>” can

come before “<ProcessFilter>…</ProcessFilter>”

Example:

In old way of filtering:

Example with attribute filers. Assuming user wishes to filter on

Line Number 10 and load only those Workplans that are labelled “Workplan A” and

“Workplan C”

iFilters = “<LineNumberFilter>10</LineNumberFilter><AttributeFilters><ProcessAttributeFilters><AttributeFilter>

<PlanTypeName>Workplan</PlanTypeName>

<AttributeName>name</AttributeName>

<Operator>=</Operator>

<AttributeValue>Workplan A</AttributeValue>

<AttributeValue>Workplan C</AttributeValue>

</AttributeFilter></ProcessAttributeFilters></AttributeFilters>”

Returns:

S_OK if all OK E_INVALIDARG if incorrect input format Refer

DNBMHIInterfaces/PublicInterfaces/DNBIAMHILoadParameters.idl :: SetFilters

method for additional information

Parameters:

ifilter_input_string (str) –

Return type:

None

set_ftp(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_FTP(boolean iRequired)

Set FTP Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_ftp_server_information(iftp_host_name: str, iftp_login_name: str, iftp_password: str, iftp_outputlocation: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_FTPServerInformation(CATBSTR iftpHostName,

CATBSTR iftpLoginName,

CATBSTR iftpPassword,

CATBSTR iftpOutputlocation)

Set FTP Information.

Parameters:

iftpHostName

Service Host Name for transferering the data

iftpLoginName

Login Name for authentication to the Service Host Machine for

transfering the data

iftpPassword

Password for the above login

iftpOutputlocation

Output Dir where to tranfer the data in the

Machine

Parameters:

• iftp_host_name (str) –

• iftp_login_name (str) –

• iftp_password (str) –

• iftp_outputlocation (str) –

Return type:

None

set_generate_pack_n_go(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_GeneratePackNGo(boolean iRequired)

Set Generate PackNGo Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_generate_smg_mapping_xml(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_GenerateSMGMappingXML(boolean iRequired)

Set Generate SMG Mapping XML Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_generate_smg_xml(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_GenerateSMGXML(boolean iRequired)

Set Generate SMG XML Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_generate_smg_xml_exe_path(i_required: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_GenerateSMGXmlExePath(CATBSTR iRequired)

Set Generate SMG XML EXE Path.

Parameters:

iRequired

Path to the SMG Generator EXE

Parameters:

i_required (str) –

Return type:

None

set_lite_pack_n_go(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_LitePackNGo(boolean iRequired)

Set Lite PackNGo Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_load_context(i_required: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_LoadContext(CATBSTR iRequired)

Set Load Context Type.

Parameters:

iRequestType

Type Of Request

Manufacturing

Volumetric

User

Parameters:

i_required (str) –

Return type:

None

set_load_positions(i_required: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_LoadPositions(CATBSTR iRequired)

Set Load Positions Type.

Parameters:

iRequestType

Type Of Request

3DStates

PublishedSimulation

Parameters:

i_required (str) –

Return type:

None

set_manufacturing_context(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_ManufacturingContext(boolean iRequired)

Set Manufacturing Context Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_process_name(iprocess_name: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_ProcessName(CATBSTR iprocessName)

Set Process Name.

Parameters:

iprocessName

Process Name to be set for PackNGo CATProcess

Parameters:

iprocess_name (str) –

Return type:

None

set_request_type(i_requset_type: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_RequestType(CATBSTR iRequsetType)

Set Request Type.

Parameters:

iRequestType

Type Of Request

DPMSingleSOIGeneration

DPMMultiSOIGeneration

DPMMultiSOIGenerationAtCS

Parameters:

i_requset_type (str) –

Return type:

None

set_requested_node_details(i_proj_id: str, i_requested_node_id: str, i_effectivity: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_RequestedNodeDetails(CATBSTR iProjID,

CATBSTR iRequestedNodeID,

CATBSTR iEffectivity)

Set Requested Node Details.

Parameters:

iProjID

Object ID of the PPR Based Project

iRequestedNodeID

Object ID of the node selected from PPR Based Project

iEffectivity

THIS PARAMETER HAS BEEN DEPRICATED FROM R17SP1 USE

OrderGenerator.set_FilterInputString method to set your filters

Parameters:

• i_proj_id (str) –

• i_requested_node_id (str) –

• i_effectivity (str) –

Return type:

None

set_set_encryption_mode(i_encryptmode: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_SetEncryptionMode(boolean iEncryptmode)

Set Encryption Mode.

Parameters:

iEncryptmode

Encryption to be done?(True/False) for encrypting the SOR Package

data

Parameters:

i_encryptmode (bool) –

Return type:

None

set_transaction_id(i_transaction_id: str) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_TransactionID(CATBSTR iTransactionID)

Set Transaction Type.

Parameters:

iTransactionID

Transaction ID

Parameters:

i_transaction_id (str) –

Return type:

None

set_update_release_table(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_UpdatereleaseTable(boolean iRequired)

Set Update Release Table Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None

set_zip(i_required: bool) → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))

o Sub set_Zip(boolean iRequired)

Set Zip Flag.

Parameters:

iRequired

Legal values: TRUE/FALSE

Parameters:

i_required (bool) –

Return type:

None