Step Five


New Workspace from Import using Release 12.5

This topic walks you through creating a new workspace from import using Release 12.5.

A workspace is comprised of several components including resource library and user information.

Oracle Documaker Studio 12.5 stores library resources and users in a true Database Management System (DBMS) structure by default when creating a new workspace.

Prerequisites

  • Oracle Documaker Studio version 12.5
  • Copy of the MRL being used as the basis of the new workspace

Steps

  • Start Oracle Documaker Studio
  • Click on the Oracle Documaker Studio application button in the upper left corner to display the File menu
    This image shows the File menu when the Application Button is clicked in Documaker Studio.
    Figure 3.5.1 - Figure 1: Application button and File menu.


  • Select New Workspace. The Workspace dialog is displayed
    This image shows the Workspace dialog.
    Figure 3.5.2 - Figure 2: Workspace dialog.
  • Create New Workspace is enabled by default, provide the Name and Location, click Next or press Alt+N to move to the next dialog

    OptionDescription
    NameEnter the name of your new workspace.
    The name cannot begin with a space or any of these characters: \ / : * ? “ < > |
    LocationDefaults to your FAP\DLL directory.
    Enter the desired location for the workspace if other than FAP\DLL.
    If the specified path does not exist, the subdirectories you specify will be created (if possible).
    Note : Do not specify the same location/path of the MRL being used to create the new workspace.

  • The Import Resources dialog displays. Select the option “Import resources from an existing location”
    This image shows the Import Resources dialog.
    Figure 3.5.3 - Figure 3: Import Resources dialog.
  • The Directory and INI file fields are displayed.
    This image shows the Workspace Creation Options dialog with the Directory and INI file fields.
    Figure 3.5.4 - Figure 4: Workspace Creation Options dialog with the Directory and INI file fields.

    OptionDescription
    Enable Project ManagementCheck on if you will be using Documaker Studios Project Management.
    If you do not enable the option during workspace creation, it can be enabled later via Studio’s options if needed.
    Projects manager allows you to group library resources together into projects and manage their progress through a defined workflow. Users will be given roles and tasks within the project. A discrete set of actions that the user can perform on the resource is associated with these roles. These actions affect the resource's status and position in the workflow.
    DirectoryBrowse to the location of the MRL being used to create the workspace.
    INI filePopulated with the INI file, typically FSIUSER.INI that identifies the components of the resources you want to import, when you tab out of the Directory field.

    Modify as needed.

    In some setups, the working directory and the location of the INI file may be different. If the INI file uses relative paths, the working directory must be set correctly or the components of the library may not be found.

    It is important to set the working directory correctly if you use these types of relative path settings in the INI file.

    Once the Directory and INI values have been set, click the Next button or press Alt + N to move to the next dialog.

  • The Select Resource dialog displays.
    This image shows the Select Resource dialog.
    Figure 3.5.5 - Figure 5: Select Resource dialog.

    Information on this dialog comes from the <Configurations> INI group:
    < CONFIGURATIONS >
    CONFIG = psampco

    Click the Next button or press Alt + N to move to the next dialog.

  • The Important Files dialog is displayed.
    This image shows the Important Files dialog.
    Figure 3.5.6 - Figure 6: Important Files dialog.

    INI optionFile location
    FormDefThe location of your form.dat file.
    Used to create the Application Definition Business (*.BDF) file, Group files (*.GRP) and Form files (*.FOR) and recipients.
    SetRcpTbThe location of your setrctb.dat file.
    Used to create triggers.
    AfgJobFileThe location of your afgjob.jdt file (used by Documaker Server).
    This file is copied to the \DEFLIB directory in your workspace.
    FntFileThe location of the *.FNT file (if used).
    The FNT file is used for downloading fonts to a PCL or PostScript printer.
    This file is copied to the \DEFLIB directory in your workspace.
    XrfFileThe location and name of your cross reference (FXR) file.
    The font cross-reference file lets you organize the fonts you use for display and printing.
    The FXR file is copied to the \DEFLIB directory in your workspace.
    FormFileThe location and name of your resource library file (*.lby) (if used)
    Userinfo FileThe location of the userinfo.dbf and userinfo.mdx files.
    These files store Documaker Desktop user information such as Report To, Level, etc.
    FDB FileThe location of the FDB.dbf and FDB.mdx files (if used).
    These files are used by Common Field Dictionary.

    These paths are stored in the <CONFIG> group in your INI file, typically the fsiuser.ini file
    [CONFIG:Sampco]
      ARCPath 	= d:\mstrres\sampco\ARC\
      CARPath	= d:\mstrres\sampco\ARC\
      CompLib	=
      DefLib	= d:\mstrres\sampco\DEFLIB\
      FntFile      = rel102sm.fnt
      FontLib	= d:\mstrres\FMRES\deflib\
      FormDef	= FORM.DAT
      FormFile	= 
      FormLib	= d:\mstrres\sampco\FORMS\
      HelpLib	= d:\mstrres\sampco\HELP\
      LbyLib       = 
      LogoFile	= 
      TableLib	= d:\mstrres\sampco\TABLE\
      WIPPath	= d:\mstrres\sampco\WIP\
      XrfFile	= rel102sm
    
    

    Depending on your particular MRL and the software you use, some fields may be empty. For example, you may not be using DAP Development Systems Common Field Dictionary and therefore do not have it defined in your INI file.

    To modify a path, click on the line containing the INI Option and File Location, then click the Change button then browse to the desired file and path.
    This image shows the Important Files dialog.
    Figure 3.5.7 - Figure 7: Important Files dialog.

    Click the Next button or press Alt + N to move to the next dialog.

  • The Specify Library Information dialog displays.
    This image shows the Specify Library Information dialog.
    Figure 3.5.8 - Figure 8: Specify Library Information dialog.

    General Information

    OptionDescription
    Library TypeDefault: Enterprise Edition
    Using this field, you can select either Standard Edition or Enterprise Edition. Selecting Standard Edition creates an ODSE (Oracle Documaker Standard Edition) structured library whereas selecting Enterprise Edition creates an ODEE (Oracle Documaker Enterprise Edition) structured library.
    Based on your selection, Studio will create the appropriate table structures and other settings that differ between these two configurations. This will include creation or modification of the appropriate DFD (Data File Definition) files and ensuring that the DDL created or executed generates the proper structures.
    Studio sets the default library type to Enterprise Edition for functions that create libraries such as creating a new workspace. Keep this option if you are using Enterprise Edition or plan to promote this library to an Enterprise Edition implementation.
    Select Standard Edition if you are using Documaker Desktop or PPCS or plan to promote this library to a Documaker Desktop or PPCS implementation.
    Effective DateDefault: 1/1/1980
    The effective date field is used to specify the default date for resources that can be import or created for this new workspace. Remember that transactions are assumed to have a date-of-record, sometimes referred to as the run date, effective date or policy date.
    Library management uses this transaction date to locate the proper resource version/revision that was effective on that date.
    When creating a new workspace, it is important to set the date back far enough to cover the transaction date range you expect to process.

    Database Information

    OptionDescription
    Connection TypeDefault: JDBC
    The technology used for connecting to the database. Choices are JDBC (Java Database Connectivity) and ODBC (Open Database Connectivity).
    Browse ODBCUse the Browse ODBC button to select a Data Source name. You are then prompted to enter Oracle ODBC Driver Connect information.
    Note: Browse ODBC option is available only if the Connection Type selected is ODBC.
    Database TypeSelect the database type from the dropdown list to open the JDBC connections dialog. You can select from the following options available:

    • DB2 for Linux, Unix and Windows
    • DB2 for z/OS
    • Microsoft SQL Server
    • Oracle
    • Other

    Note: Database Type option is only available if the Connection Type selected is JDBC.
    Database NameThe name of the database that is being connected to.
    Note: The Database name field does not display when the Database Type is selected as Other.
    Database SchemaThe name of the Database Schema
    JDBC HostThe name or TCP/IP address of the server machine where the database server is running
    JDBC Port NumberThe port number on the server machine that the database server is listening to for connections
    JDBC Driver ClassThe Java class name of the JDBC driver being used (for example oracle.jdbc.OracleDriver). The wizard provides defaults for supported database types.
    JDBC URLThe connection string used by the users’ JDBC driver. When the database type is one that is known, the wizard will supply a default URL based on the information provided by the user.
    Enable JNDIWhen this option is checked, the confirmation information is stored in a JNDI bindings file instead of the INI file. If checked, specify the JNDI Name and JNDI Context.
    JNDI NameThe connection name for storing connection information in the JNDI bindings file.
    JNDI ContextThe folder containing the JNDI.bindings file.
    Enable TracingSelect to enable tracing. Tracing can help in monitoring and analyzing the Documaker application as it is running against the database.
    Selecting this option enables the Debug INI setting in the DBHandler group, for example:

    < DBHandler:DB0715B7 >
    AlwaysSQLPrepare = Yes
    Class = ODBC
    Debug = Yes


    When the Debug setting is enabled, activity and status information is written to a trace file located in the workspace folder. This file can grow to be quite large in size.

    If you later determine that tracing needs to be enabled to troubleshoot an issue, you can always set the DBHandler Debug INI setting to Yes via Studio Settings.
    User IDThe Data Source user ID
    PasswordThe Data Source Password. The password is updated when you enter the password on the ODBC Driver Connect dialog password field. The password is displayed as asterisks (*****)
    Verify PasswordThe Data Source Password. Used as verification of data entered in password setting. The password is updated when you enter the password on the ODBC Driver Connect dialog password field. The password is displayed as asterisks (*****)
    Install the JDBC DriverSelect to install the JDBC driver.


    Library Details

    Note: If your workspace name begins with a number, the create workspace automatically inserts an "L" in front of the library table names.

    OptionDescription
    Library NameDefaults to the workspace name when creating a new workspace
    DescriptionAn optional description of the workspace library
    Index TableFor Standard Edition library types, defaults as your workspace name, plus the suffix qualifier of _DEV.
    The index portion of the library contains attributes for each version/revision combination of a resource that is stored in the library.
    Data TableFor Standard Edition library types, defaults as your workspace name, plus the suffix qualifier of _DEV_LBYD.
    The data portion of the library contains the resources themselves.
    Catalog TableFor Standard Edition library types, defaults as your workspace name, plus the suffix qualifier of _DEV_LBYC.
    Library Log TableFor Standard Edition library types, defaults as your workspace name, plus the suffix qualifier of _DEV_LBYL.
    The library log contains information about resources added to, deleted from, or updated in the library
    User TableFor Standard Edition library types, defaults as your workspace name, plus the suffix qualifier of _DEV_DMUSER.
    For Enterprise Edition library types, defaults as your workspace name, plus the suffix qualifier of _DMUSER.
    The user table contains information about the workspace users such as their User ID, Workstation Rights, Report To, etc.
    Common Fields TableFor Standard Edition library types, defaults as your workspace name, plus the suffix qualifier of _DEV_FLDB.
    The Common fields table contains common fields and their properties.
    Generate DDLsSelect to generate DDL (Data Definition Language) syntax based on the specified Database Name.
    Generate DDLs opens a separate window with the SQL commands used to create the tables. If your Database Administrator has restricted the creation of tables, highlight the text and press Ctrl+C to copy it to your clipboard. You can then paste the information into an email or a text file to give to your DBA.
    Note: You will not be able to proceed past this page if the tables are not created.


    The Processing dialog lists the tasks to be performed as part of the workspace creation process. A red X indicates the task has not yet been performed. A green checkmark indicates the task is complete.
    This image shows the Processing dialog.
    Figure 3.5.9 - Figure 9: Processing dialog.

    Click the Finish button to initiate the workspace creation process.

  • The Output Area records the task details as they are executed. Messages which may be generated during the workspace process are also listed in the Output Area.

    The Output Area is located in the lower half of the Workspace dialog.

    This image shows the Output Area in the lower half of the Workspace.
    Figure 3.5.10 - Figure 10: Output Area in the lower half of the Workspace.


    [10:59:57AM] Started import at 10:59:57 AM
    [11:00:00AM] Now loading d:\mstrres\sampco\DEFLIB\FORM.DAT. This may take a few minutes. [11:00:00AM] Created file C:\fap125\DLL\Sampco1\FORLib\DEC PAGE.FOR.
    [11:00:03AM] C:\fap125\DLL\Sampco1\FORLib\DEC PAGE.FOR
    [11:00:03AM] Created file C:\fap125\DLL\Sampco1\FORLib\FIL 1010 04 92.FOR.
    [11:00:05AM] C:\fap125\DLL\Sampco1\FORLib\FIL 1010 04 92.FOR
    [11:00:05AM] Created file C:\fap125\DLL\Sampco1\FORLib\test normalize.FOR.
    [11:00:06AM] C:\fap125\DLL\Sampco1\FORLib\test normalize.FOR
    [11:00:06AM] Created file C:\fap125\DLL\Sampco1\FORLib\spell check.FOR.
    [11:00:08AM] C:\fap125\DLL\Sampco1\FORLib\spell check.FOR
    [11:00:08AM] Created file C:\fap125\DLL\Sampco1\FORLib\CG DEC.FOR.
    [11:00:10AM] C:\fap125\DLL\Sampco1\FORLib\CG DEC.FOR

    ...

    [11:10:38AM] Finished import at 11:10:38
    [11:10:38AM] Elapsed time 00:10:41
    [11:10:38AM] Setting JDOE as System and User Administrator.
    [11:10:49AM] Regenerating RULES.LST file. Current file is older than RULW32.DLL and/or CUSW32.DLL

    Contents in the Output area can be saved to a file or printed. These and other options are available from the right click menu. The right click menu can be accessed by pressing the right mouse button or pressing Shift + F10.

    This image shows the Output Area contents and the right-click menu.
    Figure 3.5.11 - Figure 11: Output Area contents and the Right-Click menu.

Your new workspace will open upon completion of the import process.